The Data Dictionary lists all of the tables available for retrieving information. Information on these tables are used when developing SQL statements to generate the desired reports.
The Data Dictionary can be navigated to from several places. Clicking on any of these links will open the Data Dictionary DB Menu page.
- e-Services Home Page. The Data Dictionary link is located under the Technical e-Services heading located on left side of the e-Services Home page towards the bottom.
- Report Engine Home Page. The Data Dictionary link is located on the left side of the page at the bottom.
- SQL Builder Editor. The Data Dictionary link is located across the top of the lower section of the page.
This menu page allows you to select which database schema to use.
Note: Upgraded e-Services data is stored in XXDPU.
This menu page allows you to choose a table from the selected database.
Note: Upgraded e-Services tables have a prefix that indicates the applicable engine or area. For example, CIS stands for the Client Information Services Engine.
The Data Dictionary Columns page lists all of the columns within the selected table.
- Table Name. The Table Name will be used in the SQL statement to select which table to retrieve the information (example: xxad_personmaster_v).
- Column Name. The Column Name lists all the information that may be available for each record stored in the table. Column Name will be used to select what information is to be retrieved from the table. It will also be used to determine what information is to be used when determining the criteria for the data (example: person_id).
- Data Type. This will list the type of data that this field holds.
- Data Length. This is the maximum character length for the field (example: 22).
- Data Precision. This is the number of digits following the decimal point in a numeric field.
- Nullable. When "N" is in this field, this entry in the Column Name is a requirement. This information will always be available for each record. If "Y" is in the field, then the information is optional. The record may or may not have information in the field.
- Description. This will be a brief description of the information contained in this column.