DATA DICTIONARY REPORT

The Data Dictionary (DD) consists of a set of tables in the Costpoint database that describes database information for both client/server and web schemas, including table descriptions, how the tables are used, their life cycles and business rules, as well as detailed information at the column level.

The Data Dictionary tables hold data for all of the following schemas, as applicable:

You can access all the information contained in the Data Dictionary, including the Web’s meta and administrative schemas, even if your company is not licensed for Costpoint Web.

Use this report to query or print selected Data Dictionary (DD) information, as desired.

You can select Data Dictionary information for the query or report by module, column, and/or by table, and can choose from 3 different sort options.  Additional criteria allow you to specify page breaks, exclude Web System tables, and to show table and/or column information on the report.

[In previous versions of Costpoint, the Data Dictionary information was available for viewing only via a .PDF format from the User Manuals CD.  The two DD files contained on that CD were static and listed the data in alphabetic module order by table within each module and in alphabetic order by table, crossing modules. There was no ability to choose selection parameters, sorts, or other report formats.]

You can view or print the report from this screen at any time.

Select Module

Use the fields in this group box to select records from one, a range of, or all modules for the report.

Select modules codes as follows:

Range

The default value for this field is “All.”  You can accept the displayed default range option, enter a different valid range option, or select one from the drop-down box.  Range options include “All,” “One,” “Range,” “From Beginning,” and “To End.”

If you save the print parameters for this report, the system will store your selected Range Option selection in the Module Range column of the Query table.

From

Enter, or use Lookup to select, up to five alphanumeric characters to specify the beginning module, as applicable.  

Although Lookup is available as a user convenience, you can enter any value in this field because the system performs no field validation against existing module codes.

The following system restrictions are enforced:

If you save the print parameters for this report, the system will store your selected From value, as applicable, in the Module Code From column of the Query table.

To

Enter, or use Lookup to select, up to five alphanumeric characters to specify the ending module, as applicable.

Although Lookup is available as a user convenience, you can enter any value in this field because the system performs no field validation against existing module codes.

The following system restrictions are enforced:

If you save the print parameters for this report, the system will store your selected To value, as applicable, in the Module Code To column of the Query table.

Select Column

Use the fields in this group box to select records for one column name, beginning with specific characters for a column name, containing specific characters within a column name, or from all columns names for the report.

[You can choose to exclude column data from printing on the report, even if you have included column data in your selection criteria, by clearing the Column Information checkbox in the Show group box.].

Range

The default value for this field is “All.”  You can accept the displayed default range option, enter a different valid range option, or select one from the drop-down box.  Range options include “All,” “One,” “Begins With,” and “Contains.”

If you save the print parameters for this report, the system will store your selected Range selection in the Columns Range column of the Query table.

Value

Enter up to 30 alphanumeric characters to specify the specific parameter for the selected range option, as applicable.

The following system restrictions are enforced:

If you save the print parameters for this report, the system will store your selected Value data, as applicable, in the Column From column of the Query table.

Select Table

Use the fields in this group box to select records for one table, beginning with specific characters for a table, containing specific characters within a table name, or from all table names for the report.

[You can choose to exclude table data from printing on the report, even if you have included column data in your selection criteria, by clearing the Table Information checkbox in the Show group box.].

Range

The default value for this field is “All.”  You can accept the displayed default range option, enter a different valid range option, or select one from the drop-down box.  Range options include “All,” “One,” “Begins With,” and “Contains.”

If you save the print parameters for this report, the system will store your Range selection in the Table Range column of the Query table.

Value

Enter, or use Lookup to select, up to 30 alphanumeric characters to specify the specific parameter for the selected range option, as applicable.  

Although Lookup is available as a user convenience, you can enter any value in this field because the system performs no field validation against existing tables.

The following system restrictions are enforced:

If you save the print parameters for this report, the system will store your selected Value data, as applicable, in the Table From column of the Query table.

Exclude Web System Tables

Use the single checkbox in this group box to exclude web system tables from the data selection for the report.

Exclude Web System Tables

The default for this checkbox is unchecked.

Leave this checkbox unchecked under these circumstances:

  1. If you are NOT licensed for Costpoint Web and therefore have no use for the Metadata and Administrative schemas that apply exclusively to the web

  2. If you ARE licensed for Costpoint Web but wish to print data only for the Transactional schema business data related to the Costpoint screens and processes

If you save the print parameters for this report, the system will store your checkbox selection as “Y” or “N” in the Exclude Web System Tables column of the Query table.

Sort

Use the selections in this group box to select the primary and secondary sorts for the report and to initiate a page break.

For the primary sort selection, you can choose to sort by module or by table name.

For the secondary sort selection, you can choose to sort by primary key or by column name.

Primary Sort

The default drop-down selection for the primary sort is by table name.

For the primary sort selection, you can choose to sort by module abbreviation or by table name.

You can accept the default primary sort or select a different sort option, as desired.

If you save the print parameters for this report, the system will store your drop-down box selection to sort by module as “M” and by table as “T” in the Primary Sort Code column of the Query table.

Secondary Sort

The default drop-down selection for the secondary sort is by primary key in the table.

For the secondary sort selection, you can choose to sort by primary key or by column number order.

You can accept the default secondary sort or select a different sort option, as desired.

If you save the print parameters for this report, the system will store your drop-down box selection of the secondary sort by primary key as “P” and by column as “C” in the Secondary Sort Code column of the Query table.

Page Break

Select this checkbox if you want a page break in the report each time the selected primary sort parameter changes.  

For example, if you selected the primary sort as “Table,” you should select this checkbox if you want data for each different table to begin printing on a separate report page.

If you save the print parameters for this report, the system will store your checkbox selection as “Y” or “N” in the Page Break Flag column of the Query table.

Show

Use the checkboxes in this group box to indicate whether you want the table information and column information, as applicable, to print on the report.

Table Information

The default for this checkbox is checked.

If you selected “All” as the Range in the Select Table group box, the system will enable this checkbox..  

Column Information

The default for this checkbox is checked.

Report Examples

Example 1:  No Table or Column Information

If you selected no table or column information to print on the report, a typical report format will include the table, table name, and module, as follows:

Table

Name

Module

ABC_CLASSIF

ABC Classification

PR

ACCT

Account

 GL

ACCT_ENTR_GRP

Account Entry Group

 GL

ACCT_ENTRY_RULES

Account Entry Rules

 GL

 

 Example 2:  Table Information, No Column Information

If you selected table information with no column information to print on the report, a typical report format will include the table, table name, and module, along with the table definition, life cycle, and CP version (as available), as follows:

Table

Name

Module

ABC_CLASSIF

ABC Classification

PR

 

Definition: Stores unique codes for the reasons for which a worker's compensation claim may be filed.

Life Cycle: Populated by Deltek. Remains in the table for the life of the software.

CP Version:

ACCT

Account

GL

 

  Definition: Stores specific account information, including account name, active flag, and FY/PD of activity.

Life Cycle: Entries are manually added, changed and deleted through the Maintain Accounts screen by the user.

CP Version:

ACCT_ENTR_GRP

Account Entry Group

GL

 

Definition: Stores the account entry group codes and their descriptions.

Life Cycle: Entries are manually added, changed and deleted through the Account Entry Groups screen by the user.

CP Version:

Example 3:  Column Information, No Table Information

If you selected column information with no table information to print on the report, a typical report format will include the table, table name, and module, as well as the column details (including the column, column number, name, primary key indicator, foreign key indicator, whether nulls are permitted, and type) as follows:

Table

Name

Module

ABC_CLASSIF

ABC Classification

PR

Column

Col No

Name

PK

FK

Nulls

Type

ABC_CLASSIF_CD

1

ABC Classification

1

 

N

VARCHAR(1)

ABC_PCT_RT

2

ABC Percentage

 

 

N

DECIMAL(10,8)

UNIT_CST_AMT

3

Unit Cost Amount

 

 

N

DECIMAL(14,4)

COUNT_TOL_PCT_RT

4

Count Tolerance Percentage        

 

 

N

DECIMAL(10,8)

COUNT_FREQ_NO

5

Count Frequency

 

 

N

SMALLINT

MODIFIED_BY

6

ID of the user who last created or modified row

 

 

N

N VARCHAR(20)

TIME_STAMP

7

Date and time of row creation or last modification

 

 

N

DATETIME

COMPANY_ID

8

Company ID

2

 

N

VARCHAR(10)

ROWVERSION

9

System-assigned number to handle row concurrency

 

 

Y

INT

ACCT

Account

GL

 

Column

Col No

Name

PK

FK

Nulls

Type

ACCT_ID

1

Account ID

1

 

N

VARCHAR(15)

ACTIVE_FL

2

Active Flag(Y/N)

 

 

N

VARCHAR(1)

FY_CD_FR

3

From Fiscal Year

 

1

Y

VARCHAR(6)

PD_NO_FR

4

Period Number From

 

2

Y

SMALLINT

FY_CD_TO

5

To Fiscal Year

 

1

Y

VARCHAR(6)

PD_NO_TO

6

Period Number To

 

2

Y

SMALLINT

ACCT_ENTR_GRP_CD  

7

Account Entry Group Code  

 

 

Y

VARCHAR(6)

Example 4:  Column Information and Table Information

If you selected column information and table information to print on the report, a typical report format will include the table, table name, module, table description, life cycle, and CP version (as available), as well as the column details (including the column, column number, name, primary key indicator, foreign key indicator, whether nulls are permitted, and type) as follows:

Table

Name

Module

ABC_CLASSIF

ABC Classification

PR

 

Definition: Stores unique codes for the reasons for which a worker's compensation claim may be filed.

Life Cycle: Populated by Deltek. Remains in the table for the life of the software.

CP Version:

Column

Col No

Name

PK

FK

Nulls

Type

ABC_CLASSIF_CD

1

ABC Classification

1

 

N

VARCHAR(1)

ABC_PCT_RT

2

ABC Percentage

 

 

N

DECIMAL(10,8)

UNIT_CST_AMT

3

Unit Cost Amount

 

 

N

DECIMAL(14,4)

COUNT_TOL_PCT_RT

4

Count Tolerance Percentage        

 

 

N

DECIMAL(10,8)

COUNT_FREQ_NO

5

Count Frequency

 

 

N

SMALLINT

MODIFIED_BY

6

ID of the user who last created or modified row

 

 

N

N VARCHAR(20)

TIME_STAMP

7

Date and time of row creation or last modification

 

 

N

DATETIME

COMPANY_ID

8

Company ID

2

 

N

VARCHAR(10)

ROWVERSION

9

System-assigned number to handle row concurrency

 

 

Y

INT

ACCT

Account

GL

 

Definition: Stores specific account information, including account name, active flag, and FY/PD of activity.

Life Cycle: Entries are manually added, changed and deleted through the Maintain Accounts screen by the user.

CP Version:

Column

Col No

Name

PK

FK

Nulls

Type

ACCT_ID

1

Account ID

1

 

N

VARCHAR(15)

ACTIVE_FL

2

Active Flag(Y/N)

 

 

N

VARCHAR(1)

FY_CD_FR

3

From Fiscal Year

 

1

Y

VARCHAR(6)

PD_NO_FR

4

Period Number From

 

2

Y

SMALLINT

FY_CD_TO

5

To Fiscal Year

 

1

Y

VARCHAR(6)

PD_NO_TO

6

Period Number To

 

2

Y

SMALLINT

ACCT_ENTR_GRP_CD  

7

Account Entry Group Code  

 

 

Y

VARCHAR(6)