Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
outlinetrue
stylenone

...

About the Data Dictionary

...

Each Table Definition lists the:

  • Column Names: Field name within the Database Table for accessing the values.

  • Expected Data Type for each Column: Only compatible values to the data type list will be allowed to be saved here. The Application enforces this with validation rules on forms and in the API.

  • Default Values: The default value the Application writes to the Databases every time a new record is created. 'NULL' or '0' are often set as default to indicate no User input was made.

  • Required Field Indicator: Indicates if a value is expected to be in this field. This corresponds with required fields within Application Forms.

  • Field Label: Shorthand reference for verbally communicating values.

  • Field Description: This indicates the use of this field within the Application.

  • Foreign Key Table Reference: This indicates what table the data found in this field comes from. The Application uses this constraint to prevent someone from removing information other records depend on.

By using the Data Dictionary, a User can quickly identify related tables and the information stored within them to assist in the writing and updating of custom data queries using AdHoc Grids, the API and Custom Logic. For ease of use, the Data Dictionary is sorted Alphabetically, and a set of quick jump navigation links are available for quickly locating Table Definitions.

...

Here are some usual details to keep in mind when going through the Schema:

  1. Within the Data Dictionary are multiple Database Views. These Views are searchable objects that do not store data on their own, but reference data found else where within the Database Schema. Views can be thought of as Virtual Database Tables, and can assist a User in getting related data without having to go digging through multiple tables individually.

  2. Record Identification Numbers (RECIDs) are unique IDs for records within the table. When one table references a specific record from another table the Table Name is usually also part of the RECID the other table is referencing.

    1. IE: SERVICES_RECID in any given table is referencing the RECID value from the SERVICES Table

    2. Some table names are very long, and need to be abbreviated to meet the 30 character limit imposed by Oracle Databases.

Using the Data Dictionary

...

For more information on Custom Logic, please see the Custom Logic "Getting Started" page .

Child pages (Children Display)
styleh6
sorttitle