chapter 2: data dictionary services - peoplestrategy standard template chapter 2: data dictionary...
TRANSCRIPT
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 1
Chapter 2: Data Dictionary Services
CHAPTER 2: DATA DICTIONARY SERVICES .................................................................................................................... 1
DATA DICTIONARY SERVICES OVERVIEW ..................................................................................................................................... 2 DATA DICTIONARY SERVICES MENU .......................................................................................................................................... 2 CREATING A NEW DATA ELEMENT (UDF) .................................................................................................................................. 3
Advanced Options ......................................................................................................................................................... 6 Diagnostic Addresses .................................................................................................................................................... 7
CREATING NEW DATA ELEMENTS FOR SQL SYSTEMS .................................................................................................................... 7 System Support Tables .................................................................................................................................................. 7 Application Data Tables ................................................................................................................................................ 8 System Support Table Descriptions ............................................................................................................................... 9 Data Element Descriptions............................................................................................................................................ 9 Integrated Data Dictionary Table (INTEGRATD_DAT_DICT) ....................................................................................... 10 Table Information Table (TABLE_INFO) ...................................................................................................................... 15 Column Information Table (COLUMN_INFO) .............................................................................................................. 18 Application Information Table (APPLICATION_INFO) ................................................................................................. 21 Group Alternate Tables Table (GROUP_ALTRNT_TBLS) .............................................................................................. 22 Alternate Key IDD Table (ALTERNATE_KEY_IDD) ........................................................................................................ 23 PRGMDDT DBMS Table Definition Maintenance ........................................................................................................ 25 PRGMDDT Output ....................................................................................................................................................... 29
CREATING AN ALIAS DATA ELEMENT........................................................................................................................................ 29 CREATING AN UMBRELLA DATA ELEMENT................................................................................................................................. 30 MODIFYING A DATA ELEMENT OR UDF / DELETING A UDF ......................................................................................................... 30 CREATING AN ALTERNATE INDEX ............................................................................................................................................. 31
Activating the Alternate Index .................................................................................................................................... 31 SELECTED DATA ELEMENTS FEATURE (CHANGE SWITCHES) .......................................................................................................... 32
Setting Up Change Switches ....................................................................................................................................... 32 DEFERRED DATA DICTIONARY MAINTENANCE ........................................................................................................................... 34
Program GENIDDM Maintenance Considerations ...................................................................................................... 34 GENIDDM CONTROL RECORD REFERENCE .............................................................................................................................. 35 TRANSACTION FORMATS TO UPDATE DATA ELEMENT RECORDS .................................................................................................... 36
Maintaining a Data Element ....................................................................................................................................... 37 UDF LISTING AND UDF BLUEPRINT REPORTS ............................................................................................................................ 38 WHERE DATA ELEMENTS ARE USED ........................................................................................................................................ 39 DATA DICTIONARY RESYNCHRONIZATION ................................................................................................................................. 39
Programs ASBIDMN .................................................................................................................................................... 39 ASBIDMN .................................................................................................................................................................... 39
2 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
Data Dictionary Services Overview Data elements are the building blocks for all of your HRMS processing. You can use data elements to define
the information that you need to store, report, or against which you need to run calculations.
For example, you can take three data elements -- Employee name, Annual salary, and Hourly pay rate -- and
quickly determine the financial impact of various salary adjustments.
The functions in Data Dictionary Services give you access to your data elements, and allow you to work with
them in your HRMS applications.
You can add new data elements that meet specific needs in your organization.
You can re-name existing data elements to match your company's terminology, and
You can modify data elements.
Data Dictionary Services gives you access to the Integrated Data Dictionary (IDD), which stores the field
descriptions, edits, and addresses for all data elements, whether they are Genesys-supplied or ones you've
created.
The IDD is a single file that combines all the data elements for all of your Genesys HRMS applications.
You can use Data Dictionary Services to:
Create new data elements, called user-defined fields (UDFs) that meet your specific data
processing needs. Although Genesys-supplied data elements may be excellent for most of your
requirements, they are generic. You can create your own data elements for situations specific to
your organization, and customize your application(s).
Create alias data elements. You can rename a Genesys data element with a name that is
meaningful to your organization. Alias data elements take on all of the characteristics of their
matching, Genesys-supplied data element, and you can use either the Genesys name or your own
alias name.
Create umbrella data elements that group together several User Defined Fields for easy access
to the data stored in a group of related UDFs. For example, with an umbrella data element, a
single transaction can change multiple contiguous fields.
Modify Genesys-supplied data elements. You can modify Genesys-supplied data elements, but
you cannot delete them.
Browse through the data dictionary.
Create alternate index paths for SearchAll and Data Inquiry.
Data Dictionary Services Menu To display the Data Dictionary Services Menu select Data Dictionary Services from the GenTools Menu.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 3
To use the menu, follow these steps:
1. In the Name field, type the name of an existing data element that you want to display, modify, or
delete (UDFs only).
You can also enter the name of a new data element (UDF) you want to add.
If you attempt to browse from a data element that is not stored in the IDD, the system begins the
browse from the next data element.
Note that the field is eight positions long. Prior to Version 6.1 of the Genesys system, the
maximum length for data elements was four positions.
Note also that numeric Transaction Masks (TRAN Mask) use six positions.
Naming Conventions for UDFs: You may choose any name that does not duplicate the name of
an existing data element (Genesys-supplied or UDF), and has at least two alpha characters. Note
that if Genesys later delivers a new data element that has the same name as a UDF you've created,
must change the name of your UDF.
If you are adding an earning or a deduction, Genesys strongly recommends that new data fields
that you create as part of your new earning or deduction conform to the standards described in
GenTools, Chapter 15, Step 1 -- Establishing New Data Fields.
2. In the Application ID field, select a Genesys application from the drop-down list.
3. Choose an action. You can:
Add a new or alias data element. These are user-defined fields (UDFs).
Browse - in alphabetical order from a specific data element.
Change the information for an existing data element.
Delete a user-defined field. Note: You cannot delete a Genesys-delivered system data element.
To return to the GenTools menu, select Cancel.
Creating a New Data Element (UDF) You can add data elements to your system to meet specific information management or processing needs. For
example, you may want to keep track of individual beeper numbers in your organization. To accomplish this,
you could create a data element (or UDF) called BEEP. Once you've created a user-defined field, it functions
like any Genesys-supplied data element or UDF. It's available immediately for use with data entry and inquiry
screens, and SearchAll
4 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
Creating New Data Elements for TONI (Canadian Taxation) In order to implement TONI (Tax ON Income) for Canadian taxation, you must create three data elements. The
data element names are TK3P, TTCP, and TTD1. These data elements represent the Provincial values for three
fields currently used in the Federal Tax Calculation.
TK3P -- Other annual provincial non-refundable tax credits, such as medical expenses or
charitable donations, authorized by a tax services office or tax center.
TTCP -- The total of personal non-refundable tax credit amounts shown on the employee's or
pensioner's Provincial Form TD1.
TTD1-- The amount of $309.00 multiplied by the number of disabled dependents as indicated on
Form TD1 or the Provincial version of this form.
Special Note: It is the user's responsibility to implement and maintain the TONI fields for all employees. If
the system finds that these fields are not on the IDD or that they contain non-numeric data, then ZERO is used
in calculations that involve these fields. Once created, they are available immediately for use with data entry
and inquiry screens, and SearchAll.
To create a new data element, follow these steps:
1. Type PPNU in a screen navigation field and select Enter, or select Data Dictionary Services from
the GenTools Menu to display the Data Dictionary Services Menu.
2. On that menu, type a name for your new data element, select an application, choose "Add a New
Data Element," and click OK. If you are adding a TONI data element, choose TK3P, TTCP, or
TTD1 as the name.
Click Yes on the message screen (User Defined?). The system displays the screen shown below.
When you first see this screen, the system displays the data element name you typed and the defaults shown.
The remaining fields are left blank for you to complete, as explained below.
3. In the Description field, type a description for the data element. Although the field is 48
characters long, the system displays only the first 25 in field-level help.
4. In the Location field, if you are adding a new data field in the expanded area available with
Version 6.1 of the Genesys system, enter one of the following:
#DDF if you are creating a numeric field
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 5
+DDF if you are creating an alphanumeric field
If you are not creating a data field in the expanded area, type a value that specifies the
miscellaneous field location where your new data element (UDF) should begin. Although fields
EM01 through NM99 are usually designated as miscellaneous fields at the time of system
generation, each application uses these fields for various processing functions (such as storing data
for History Stacks). Because of this, you should check your User-Defined Field Blueprint Report
to determine which fields are available for your application(s). Note: If you create an Alias Data
Element, leave this field blank.
The number of miscellaneous fields your system contains depends on your system variables. All
miscellaneous fields are eight positions long, and a single UDF can contain up to 48 characters.
When you lay out an area within the miscellaneous fields for a UDF, the UDF can span more than
one miscellaneous field. In addition, the UDF does not have to start in the first position of the
miscellaneous field.
5. In the Start Position field, enter a value to indicate where your new data element should begin in
its miscellaneous field. Note: If you're creating an Alias Data Element, leave this field blank.
6. In the Length field, type the field length of your new data element. You can type a value from 1
through 48. Note: If you're creating an Alias Data Element, leave this field blank.
7. Leave the Alias Field blank unless you're creating an alias data element name. For instructions on
creating an Alias Data Element, see the section later in this chapter.
8. The system defaults to yes (a checkmark ) in the Modifiable field. To change this to no, click on
the checkmark to delete it. This field indicates whether or not you want a Change Transaction (49,
71, 72, or 73) to modify the data element.
9. The system defaults to yes in the Mass Changeable field. To change this to no, click on the
checkmark to delete it. This field indicates whether or not you want a Mass Change Transaction
(41, 43, or 44) to modify the data element. If the value in this data element is unique to each
individual, delete the X to prevent changing every record.
10. In the Format field, click on the arrow to display the format options, and select one. If you are
adding a TONI data element, select N (numeric).
* Capable of Group Reference (not available for UDFs)
A Alphanumeric
C Currency (nnnnn.nn)
D US Date (MM-DD-YYYY)
E International Date (DD-MM-YYYY)
N Numeric
11. In the Modifier field, specify the number of decimal places to display when the format is N or *
(numeric fields). You may choose between 0 and 8. If you are adding a TONI data element,
choose 2.
12. In the Security field, if you want to limit access to this data element, type a code to define the online security level.
If you leave the field blank, the system defaults to 00, which indicates unlimited access. For further information on
security, see your security administrator.
13. In the Update field (RealTime users), click on the arrow to display the Update options, and select one. This option
determines when the system should apply any changes made to the data element. Your options are:
I = Immediate
D = Deferred (Edit & Update)
You cannot specify or modify the S option, which is delivered with some system fields. For non-RealTime users,
this field is an extract indicator.
6 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
14. In the Table field, if you want to use a specific table as a default for look-up in data inquiry, type the table's name.
If you indicate a table, the system displays the table's value on data inquiry screens, rather than the value in the
individual record.
15. In the GenCalc field, you may type a GenCalc name, which is a number between 0001 and 9999. If you specify a
GenCalc, the system invokes that GenCalc whenever it displays the data element on a screen. At this point you have
these options:
Edit and Accept to edit the screen and return to the menu.
Edit Only to check for errors on the screen but not process the input.
Browse Next to display the next data element in the Data Dictionary. When you select this option, you may
press Enter to continue browsing.
Change to edit the screen and return to the menu.
Delete to delete the data element you're displaying (UDFs only).
End Browse to stop browsing. When you choose this option, Enter returns you to the menu instead of to the
next data element.
Retrieve Next Data Element. Type the name and select Enter.
Note: You may choose options by pressing ALT plus the underlined letter of the option you want. For example, to
select Edit Only, you may type ALT + e.
Advanced Options
To specify certain advanced options, select Advanced Options and click OK (or select Enter) to display the following
screen.
In the Online User Edit field, you may type an edit code to specify the editing routine the system should
use when it updates the data element. The system defaults to 000. You create these editing routines in
Program UE.
In the Message Number field, if you want to assign a system message to the data element, type the number
that corresponds to the message on the Error File.
In the Online System Edit field, you may type an edit code to specify the editing routine the system
should use when it updates the data element. The system defaults to 000. For more information on system
edits, or how to write user edits, refer to the Genesys System Manual.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 7
In the Deferred Edit field, you may type an edit code to specify the deferred edit routine the system should
use in the Edit & Update Phase. The system defaults to 000.
In the Alternate Search Paths fields, if you want to use the data element as an Alternate Index, type the
required information in these fields. For further information, see Creating an Alternate Index later in this
chapter.
Diagnostic Addresses
If you need to retrieve diagnostic information to resolve errors that may occur in your processing, click the
Diagnostic button on the Advanced screen. The system displays the following:
You cannot change this information.
P010 and P210 - Displays the address of the data element on the Master Database used by Programs 010
and 210 in deferred processing.
P010 Edit - Displays information used by Program 010 in deferred processing.
Record - Displays the record's location on the online Master Database.
Disp - Indicates the displacement of the data element starting from position 1 on the Master record.
TRAN - Displays the system-defined transaction code for a transaction mask.
Subcode - Displays the system-defined sub code for a transaction mask.
Start - Displays the start position of data for a transaction mask.
Creating New Data Elements for SQL Systems The DBMS tables used by the Genesys product line are defined in the Genesys Integrated Data Dictionary
(IDD). There are two types of Genesys DBMS tables:
System Support Tables
Application Data Tables
System Support Tables
System Support Tables are used by GenTools.
This includes:
8 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
GenCalcs
Report Writer
Screen Development
Integrated Data Dictionary (IDD)
Online System
SearchAll
Genesys Security
The System Support Tables store Genesys delivered and user-customized definitions and processing
requirements. Included are the tables that contain the IDD Definitions, Screen Definitions, GenCalcs, Error
Messages and others.
Application Data Tables
Application Data Tables contain user data for customized user application(s). These tables contain company
data, such as an individual's earnings information, the qualifications of an incumbent for a position, or
information about a plan in the Flexible Benefits system.
All DBMS tables defined on the IDD are identified by an 18-character Table Name and a 4-digit Table Number.
Table Numbers are used internally by the Genesys programs to reduce storage requirements. They are also used
when unique 8-character names are required (for example, in copybook, tablespace, and index names). In order
to maintain unique table numbers, ranges of table numbers have been designated as either Genesys-defined or
user-defined.
The following tables identify the range of table numbers for both the System Support Tables and the
Application Data Tables.
Number Ranges for System Support Tables
Number Range System Support Tables
0000 - 0999 Genesys use only (System Tables)
1000 - 1999 Payroll/Human Resources Tables
2000 - 2999 Defined Contribution
3000 - 3999 Human Resource Planning Tables
4000 - 4999 Defined Benefits Tables
5000 - 5999 Flexible Benefits Tables
6000 - 6999 Benefit Payments
7000-7999 HealthCare HRMS
Number Ranges for Application Data Tables
Number Range Application Data Tables
n000 - n099 Group Data Tables delivered from Genesys
n100 - n599 Individual Data Tables delivered from Genesys
n600 - n999 Individual Data Tables created by Users
For example, 1000-1099 is the range for Group Data Tables for Payroll/Human Resources, and 1100-1599 is
the range for Individual Data Tables.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 9
System Support Table Descriptions
This section provides layouts for the System Support Tables. All System Support Tables have copybooks
created by a DCLGEN. These copybooks are named GEN00nnn (where nnn is the table's number). System
Support Tables must be entered in capital letters and with underscores, as shown in the Table Name column
below. There is a 30-character limit on all table names.
Table Number Table Name Table Description
1 INTEGRATD_DAT_DICT Integrated Data Dictionary Table
2 TABLE_INFO Table Information Table
3 COLUMN_INFO Column Information Table
4 GROUP_ALTNRT_TBLS Group Alternate Tables Table
5 ALTERNATE_KEY_IDD Alternate Key IDD Table
21 ERROR_MESSAGE Error Message Table
25 USER_TABLES User Tables Table
51 IMM_UPD_AUDIT_TRAN Immediate Update Audit Transaction
Table
52 GROUP_UPD_CONTROL Group Update Control Table
100 APPLICATN_KEY_DATA Application Key Data Table
Data Element Descriptions
The parts of information describing each data element are presented in the following format in this document.
Name
The 30-character DBMS column name that identifies the column on the system table. Use only numeric and
alpha characters in the name; do not use special characters.
Data Type
The code that represents the type of data contained in a column.
Data Type Represents
C Character column (alphanumeric) == PIC X(NN)
D date column (CCYY-MM-DD) == PIC X(10)
actual format based on DBMS install
I integer column == PIC S9(09) COMP
N decimal column == PIC S9(X)v(Y)
S small integer column == PIC S9(04) COMP
T time column (HH.MM.SS) == IC X(08)
U VARCHAR column (variable-character column). This is an alphanumeric column of variable length.
Length
The length of the column as represented in the DBMS table.
Decimal columns in table layouts are shown as (X, Y), where:
X = Total number of digits
Y = Number of digits to the right of the decimal point
10 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
Variable-character columns show a maximum number of characters.
Description
A description of the column.
Integrated Data Dictionary Table (INTEGRATD_DAT_DICT)
The Integrated Data Dictionary (IDD) Table defines data elements. The definition includes the identification of
the System Support or Application Data Table where the data is stored. The IDD Table contains rows and
columns. Each row is the definition of a data element. Each column (field) is an attribute of the data elements.
The IDD Table is primarily accessed using a unique key on the Application Identifier (APPL.ID) and Field
Name (DD_F_NAME). The IDD Table uses copybook GEN00001. Internally, programs that existed prior to
DBMS use copybook HRMSMNE. There is a one-to-one correspondence between fields in HRMSMNE and
GEN00001.
Once GENIDDM creates the record, ASOPPNU in CICS assumes the maintenance function. The screen series
PPNU performs maintenance for the IDD Table.
CICS system control fields and system information are duplicated on each record. The differentiation of the
fields is based on current and future information. Future information is applicable to the next reorganization of
the IDD Table (ASBIDMN). Applicable special values are listed.
The IDD Table row is structured as displayed in the following table.
Integrated Data Dictionary Table Column Definitions
Name Data Type
Length Description
DD_APPL_ID C 1 Application Identifier:
DD_F_NAME C 6 This column is a four-character column identifier or a six-
character transaction mask.
The data element identifier is the six-character key column
used to access the data element record. A four-character data
element is left-justified, followed by two blanks, and can
contain any unique combination of characters. The six-
character data element is a numeric column with the following definition:
1-2 - Transaction code
3-4 - Subcode (00 where none present)
5-6 - Start column of field
DD_F_BASE S 2 This column is the System base identifier.
DD_F_BASE_LNGTH S 2 This column defines the data element length in terms of the
number of base fields.
DD_F_BASE_STRT S 02 This column defines the starting position within the base in
terms of multiples of base fields for bases 7, 10, or 17.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 11
DD_F_BASE_FLDDSP N (1, 0) This column defines the starting position within the base field,
or if a user-defined data element (UDF), the start within the
EM field.
DD_F_USER_EDIT S 02 This column is the user edit routine number.
DD_F_CLASS C 01 This column identifies how data is stored:
b Labor Cost data element (not stored in Application
Database)
1 Alphanumeric
2 Asterisk Reference
3 Signed Computational
4 Alphanumeric
5 Alphanumeric
DD_F_TYPE C 01 This column identifies the type of database table the data
element is in:
B Labor Cost and Transaction data element (not stored in
Database)
0, 1 Working Storage and Benefit Interface Tables
2 Group Tables
3 Individual Tables
DD_F_INPT_LNGTH S 02 This column defines the length of the transaction input.
DD_F_CHANGE_SW C 01 The valid Change Switch values are:
B Not applicable to Labor Cost and Transaction data elements
1 Disallow
2 Allow with warning
3 Allow
9 Allow
DD_F_MASS_CHANGE C 01 The valid Mass Change Switch values are:
b Not applicable
12 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
0 Allow
1 Disallow
2 Allow 43 and 44 TRANS codes only
DD_F_EDIT_CODE S 02 The System Edit Code is blank if a user edit is present.
DD_F_MASTER_LNGTH S 02 This column contains the length of the data element on the
table.
DD_F_START_POS S 02 This column defines the starting position of the data element
from the beginning of the record. It is used internally by Deferred processing programs.
DD_F_RECORD_TYPE C 01 This column indicates whether a data element is used in
applicant processing or not.
b Not applicable to Labor Cost and Transaction data elements
A Applicant
B Both applicant and individual
E Individual or Group (but not Applicant)
DD_F_DESCRIPTION C 48 The Field Description is the long name description of the data
element. It is comprised of any character combination and it is
displayed on the CRT and the IDD list produced by ASBIDMN.
DD_F_UDM_EM_FIELD C 04 This column identifies the first Individual Miscellaneous data
element where a UDF starts.
DD_F_UDM_EM_START N (1, 0) For UDFs, a value of 1 to 8 is a start position within a
Miscellaneous data element. All other types have a value of
zero.
DD_F_ALIAS C 04 When this column contains a system or user-defined data
element name, the data element being defined (named) on this
IDD Table row is identified as an alias. The data element
named in DD_F_NAME is an alias of the data element named in DD_F_ALIAS.
DD_F_ALIAS_START S 02 This column defines the starting position of an alias within that
alias data element. Refer to the Genesys DBMS IDD chapter and the Alias User Defined Fields section.
DD_F_HRMS_TYPE C 01 This column indicates the type of data element and its
availability to CICS. It also indicates whether it is a four- or six-character data element. Data element types are:
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 13
L Labor Cost data element (four-character)
S System data element (four-character)
T Transaction data element (six-character)
U User-defined data element or UDF (four-character)
DD_F_HRMS_SECURITY S 02 The Security-level range for Online System access to the data
element is from 01 to 24.
DD_F_HRMS_CLASS C 01 This column defines the class used by the Online System. It
can be changed on-line.
0 Alphanumeric
1 Numeric
2 Asterisk Reference
6 Signed Computational
DD_F_HRMS_FORMAT N (1,0) This column contains the number of decimal positions allowed
for numeric data elements or the display format for date data elements.
For date data elements, the format is:
4 MM/YY
6 MM-DD-YY
8 MM-DD-CCYY
DD_F_HRMS_EDIT S 02 This column identifies the Edit code that the Online System
uses. It can be changed on-line.
DD_F_ERROR_
MESSAGE
S 02 This column contains the error message number that is
associated with the edit.
DD_F_TRAN_DESC I 04 This column contains the transaction mask of the ADD
transaction for the data element.
DD_F_INDX1_INFO I 04 This column contains the first index definitions.
DD_F_INDX2_INFO I 04 This column contains the second index definitions.
DD_F_INDX3_INFO I 04 This column contains the third index definitions.
DD_F_INDX4_INFO I 04 This column contains the fourth index definitions.
14 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
DD_F_TABLE_NAME C 03 This column contains the table name for the data element. It is
used in table lookup.
DD_F_SORT_IDENT C 04 This column contains the data element name for sorting during
the process of matching IDD Table rows to column definitions.
DD_F_TABLE_NMBR S 04 This column identifies the number of the table in which the
data element is stored.
Number
Range
Tables Used For
0000 -0999 Genesys use only (System Tables)
1000 -1999 Payroll/Human Resources Tables
2000 - 2999 Defined Contribution
3000 - 3999 Human Resources Planning Tables
4000 - 4999 Defined Benefits Tables
5000 - 5999 Flexible Benefit Tables
6000 - 6999 Benefit Payments Tables
7000 - 7999 HealthCare HRMS Tables
DD_F_COLUMN_ NMBR S 02 This column identifies the number of the column in the table in
which the data element is stored.
DD_F_PKID_VALUE C 04 This column contains the Prime Key Identifier. This value is
used to identify a specific row of a table when the data element
is one of many that are defined to the same column. The value
is used for repeating data elements such as earnings,
deductions, and pushdown stacks.
DD_F_REVISE_INDIC C 02 This value is set by ASOPPNU to indicate a change to an
attribute of the data element.
DD_F_UPDATE_IND C 01 This column indicates when updates will be done.
I Immediate update
D Deferred update
S System deferred updates
DD_F_OLD_CLASS C 01 This column is the value before a change was made to
DD_F_HRMS_CLASS.
DD_F_OLD_FORMAT S 02 This column is the value before a change was made to
DD_F_HRMS_FORMAT.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 15
DD_F_OLD_START S 02 This column is the value before a change was made to
DD_F_UDM_EM_START.
DD_F_OLD_LNGTH S 02 This column is the value before a change was made to
DD_F_MASTER_LNGTH.
DD_F_OLD_TABLE C 03 This column is the value before a change was made to
DD_F_TABLE_NAME.
DD_F_OLD_EDIT S 02 This column is the value before a change was made to
DD_F_HRMS_EDIT.
DD_F_OLD_ERROR S 02 This column is the value before a change was made to
DD_F_ERROR_MESSAGE.
DD_F_OLD_TBL_NMBR S 02 This column is the value before a change was made to
DD_F_TABLE_NMBR.
DD_F_OLD_COL_NMBR S 02 This column is the value before a change was made to
DD_F_COLUMN_NMBR.
DD_F_OLD_PKID C 04 This column is the value before a change was made to DD_F_PKID_VALUE.
DD_F_OLD_SECURITY S 02 This column is the value before a change was made to
DD_F_HRMS_
SECURITY.
DD_F_OLD_INPT_LNG S 02 This column is the value before a change was made to
DD_F_INPT_LNGTH.
DD_F_OLD_SYS_EDIT S 02 This column is the value before a change was made to
DD_F_EDIT_CODE.
DD_F_OLD_UPD_IND C 01 This column is the value before a change was made to
DD_F_UPDATE_IND.
Table Information Table (TABLE_INFO)
The Table Information Table uses copybook GEN00002. It contains information to define the DBMS tables
within the Genesys System. The primary key is the Table Number.
The Table Information Table is maintained via PRGMDDT, the DBMS Object Maintenance program.
PRGMDDT adds, updates, and deletes information from the Table Information through type 10 transactions.
The Table Information Table row is structured as displayed in the following table.
16 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
Table Information Table Column Definitions
Name Data Type
Length Description
TI_APPL_ID C 01 A one-character Application Identifier. This column contains
one of the following application identifiers:
TI_TABLE_NMBR S 04 The table number is the unique number within the Genesys
System which identifies each table. It is manually assigned to each defined System and Application Table.
Number Range
Tables Used For
0000 - 0999 Genesys use only (System Tables)
1000 - 1999 Payroll/Human Resources Tables
2000 - 2999 Defined Contribution
3000 - 3999 Human Resource Planning Tables
4000 - 4999 Defined Benefits Tables
5000 - 5999 Flexible Benefits Tables
6000 - 6999 Benefit Payments Tables
7000 - 7999 HealthCare HRMS Tables
TI_TABLE_NAME C 30 The Table Name is the 18-character name used by DBMS to
identify a table.
TI_TABLE_TYPE C 01 The Table Type column is the code that identifies the format of
the data stored in the table:
G Group Data
I Individual Data
H History Data (History Stacks)
TI_PRIME_KEY_ORDER C 01 Reserved for future use by Genesys.
TI_UDF_MULTI_DFNTN C 01 The user-defined Field Multiple Definition Indicator identifies
tables which map to an area in the Miscellaneous Area that has more than one definition. The valid values include:
N = No redefinition exists; this is the only table for the defined
miscellaneous area.
D = Default; this is the default table for a multi-defined
miscellaneous area.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 17
S = Special; this is an alternate table for a special definition of
the miscellaneous area.
TI_CREATOR_NAME C 08 The table creator's name is used in SQL statements to qualify a
table name if necessary. Reserved for future use of Dynamic
SQL.
TI_DATABASE_NAME C 08 The database name is used in SQL statements to qualify a table
name if necessary. Reserved for future use of Dynamic SQL.
TI_MULTI_RCD_IND C 01 This indicator identifies tables that can contain FLAG1 data.
This field is maintained by Genesys based on column definitions for the table. The valid values include:
Y -Table can contain FLAG1 data.
N - No FLAG1 data is stored on table.
If a table can contain FLAG1 data, the primary key includes a
sequence number FLAG_SEQ_NMBR. This number equals
zero for FLAG0 rows , 99 for the first FLAG1 row, and 98 for
the second FLAG1 row, etc. The FLAG_SEQ_NMBR column is ordered in descending order.
TI_APPLICANT_IND C 01 This indicator identifies tables that can contain Applicant data.
This field is maintained by Genesys based on column definitions for the table. The valid values include:
A- Table can contain Applicant data only.
N - No Applicant data is stored on table.
B - Table contains both Applicant and Individual Data.
TI_PKID_COLUMN_IND C 01 This indicator identifies tables that can contain PKID columns.
This field is maintained by Genesys based on column
definitions for the table. The valid values include:
N - Table does not contain a PKID column.
S - Table contains a PKID column defined as a DBMS type
Small Integer, or a Date if a History Table.
D – Table contains a PKID column defined as a date.
C - Table contains a PKID column defined as characters.
TI_TABLE_LENGTH S 02 Defines the total length of a row in the table as actually stored
on the database. This field is maintained internally by the
Genesys System based on the Column Definitions for the Table.
18 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
TI_NO_OF_ROWS I 04 Estimated number of rows on the table. Used in calculations
for space requirements.
TI_STOGROUP_NAME C 08 Name of the storage group in which the application's database
is stored. This mutually exclusive with TI_VCAT_NAME.
One or the other may be non-blank but not both.
TI_VCAT_NAME C 08 The name of the catalog in which DBMS will attempt to locate
the DBMS tablespace dataset names. This means the user is
managing the physical datasets for the tablespaces.
TI_INSERT_TS time
stamp
26 The date and time in which this row was inserted into the table.
TI_INSERT_ID C 08 The TSO Userid of the person who ran PRGMDDT to insert
this row into the table.
TI_UPDATE_TS time
stamp
26 The date and time on which this row was updated.
TI_UPDATE_ID C 08 The TSO Userid of the person who ran PRGMDDDT to update
this row.
Column Information Table (COLUMN_INFO)
The Column Information Table uses copybook GEN00003. It contains information to define columns within
the DBMS tables for the Genesys System. The primary key to this table consists of the Table Number and
Column Number.
The Column Information Table is maintained via PRGMDDT, the DBMS Object Maintenance program.
PRGMDDT adds, updates, and deletes information from the Column Information Table through type 20
transactions.
The Column Information Table row is structured as displayed in the following table.
Column Information Table Column Definitions
Name Data Type
Length Description
CI_TABLE_NMBR S 02 The Table Number is the identifier for the table where this
column is defined.
Number
Range
Tables Used For
0000 - 0999 Genesys use only (System Tables)
1000 - 1999 Payroll/Human Resources Tables
2000 - 2999 Defined Contribution
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 19
3000 - 3999 Human Resource Planning Tables
4000 - 4999 Defined Benefits Tables
5000 - 5999 Flexible Benefits Tables
5000 - 5999 Benefit Payments Tables
5000 - 5999 HealthCare HRMS Tables
CI_COLUMN_NMBR S 02 The Column Number uniquely identifies each column within a
table. When a table is created, the columns are defined in column number order.
CI_COLUMN_NAME C 30 The Column Name is the 30-character name used by DBMS to
identify a column within a table.
CI_PRIME_KEY_IND C 01 The Prime Key Indicator identifies columns that are part of the
primary key to the table. The valid values include:
Blank - Not a key column.
A - Key column used in ascending order.
D - Key column used in descending order.
Columns defined as primary key columns are used to create a
unique index to the table.
CI_ASTER_REF_IND
C 01 The Asterisk Reference Indicator is used to identify columns
that have an Integrated Data Dictionary (IDD) format of * and
can store a reference to a CM_ _ (CM01-CM99) data element. The valid values include:
Blank - Column is not an asterisk reference data element.
* - Column is an asterisk reference data element.
The Asterisk Reference Indicator equal to * causes an
additional column to be added to the Individual Application
Data Table, over and beyond the corresponding Numeric
Column defined by the user. These asterisk reference columns
are defined as one-character, not null, and with default. They
have a DBMS column name derived from the original column
name with _AST appended. Column names for asterisk
reference data elements can have only 14 characters, to allow the) AST to be appended to the Asterisk Reference Column.
C 01 Example:
Data element SALY can contain an Asterisk Reference. The
DBMS columns for the Application Data Table that contained SALY would be generated as:
20 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
EMP_SALARY
DECIMAL NOT NULL,
WITH DEFAULT (9,2)
EMP_SALARY_AST
CHAR (1)
NOT NULL, WITH
DEFAULT
When a valid salary is entered, it is stored in EMP_SALARY
and the _AST column is a space. When an *05 is entered as
data, the * is stored in EMP_SALARY_AST and 05 in EMP_SALARY.
CI_DBMS_DATA_TYPE C 01 The DBMS Data Type is a code for the data type definition of
the column.
Using defaults makes the data consistent with existing
programs that expect initialized values.
I = teger
S = all integer
N= Numeric (Decimal)
C = Character
V = Variable-length character
D = ate
T = Time
All non-key application data columns are defined as NOT
NULL, WITH DEFAULT except date and time columns. A
date cannot be set to a default, since DBMS itself defaults to the current date. The default is:
CCYY - 0001
MM - 01
DD - 01
CI_FLD_LENGTH S 02 The Field Length is the number of characters allowed for
columns with CHAR, VARCHAR, and NUMERIC data types.
It is the precision (total number of digits) for columns with
DECIMAL data types. The Field Length is generated for
internal use by Genesys for DBMS Data Types other than CHAR or VARCHAR:
2 = SMALLINT
4 = INTERGER
8= IME
10 = E
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 21
CI_NMBR_OF_DCML S 02 The Number of Decimals is the scale (number of digits to the
right of the decimal point) for DECIMAL data elements it is zero for all other Data Types.
CI_PRM_KEY_IDD_
NAM
C 04 The Primary Key IDD Name is the four-character data element
name (DD_F_NAME) found on the IDD. If the Column
represents a range of fields on the Data Dictionary, this field is
the first data element in the range. It is used to update the IDD with Table Column and PKID.
(CI_PRM_KEY_IDD_NAME) CTRN or TRAN for
Transaction Key Column. **** for a PKID Column (such as
Earning number). FLAG for the FLAG_SEQ_NMBR Column.
CI_FGN_KEY_IDD_
NAM
C 04 If the Column represents a range of fields on the Data
Dictionary, this field is the last data element in the range.
CI_OTHER_KEY_IND C 01 For data elements that are used in an index, this column
indicates which index should include the data element. The
valid values are:
B ot in an index
1 = the Unique (Primary) index
2 = the 2nd index
9 = the 9th index
CI_INDEX_SEQ_NMBR C 01 Sequence within an index. The valid values are 1 through 5.
CI_APPL_ID C 1 A one-character Application Identifier. This column contains
one of the following application identifiers:
CI_INSERT_TS time
stamp
26 The date and time in which this row was inserted into the table.
CI_INSERT_ID C 08 The TSO Userid of the person who ran PRGMDDT to insert
this row into the table.
CI_UPDATE_TS time
stamp
26 The date and time on which this row was updated.
CI_UPDATE_ID C 08 The TSO Userid of the person who ran PRGMDDT to update
this row.
Application Information Table (APPLICATION_INFO)
The Application Information Table uses copybook GEN00006. It contains information to describe an
application within the Genesys System. The primary key is the application ID. The data in this table is
22 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
optional. A valid and operational Genesys application will generate without it. However, the data in this table
is used to tailor the DBMS DDL generated by PRGMDDT.
The Application Information Table is maintained via PRGMDDT, the DBMS Object Maintenance program.
PRGMDDT adds, updates, and deletes information from the Application Information Table through type 00
transactions.
The application Information Table row is structured as displayed in the following table.
Application Information Table Column Definitions
Name Data Type
Length Description
AI_APPL_ID C 1 A one-character Application Identifier. This column contains
one of the following application identifiers:
AI_STOGROUP_NAME C 08 Name of the storage group in which the application's database
is stored. This is mutually exclusive with AI_VCAT_NAME One or the other may be non-blank but not both.
AI_CREATOR_NAME C 08 The TSO Userid of the person creating the application tables.
AI_DATABASE_NAME C 08 The name of the database in which the applications' tables are
defined.
AI_VCAT_NAME C 08 The name of the catalog in which DBMS will attempt to
locate the DBMS tablespace dataset names. This means the user is managing the physical datasets for the tablespaces.
AI_GRP_NO_OF_ROWS S 02 The number of groups in the application. Used for space
requirement calculations.
AI_IND_NO_OF_ROWS I 04 The number of participants in the application. Used for space
requirement calculations.
Group Alternate Tables Table (GROUP_ALTRNT_TBLS)
The Group Alternate Tables Table uses copybook GEN00004. It contains information about groups that do not
use all the default tables. For a group that does not use one or more default tables, an entry is made into the
Alternate Tables Table listing all the default tables that are excluded from use by the group. For a group that
uses specially-defined tables that are not default tables, an entry is made into this table listing all the special
tables that are used by the group.
The key to this table consists of the Application ID, Group Number, Table Use Indicator, and Sequence
Number.
The Group Alternate Tables Table is maintained via PRGMDDT, the Table Definition Maintenance program.
PRGMDDT adds, updates, and deletes information from the Group Alternate Tables Table through type 30
transactions.
Also, for more information on this table, refer to the Multiple UDF Definitions in the Miscellaneous Used Data
Area section of the Genesys DBMS Integrated Data Dictionary chapter.
The Group Alternate Tables Table row is structured as displayed in the following table.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 23
Group Alternate Tables Table Column Definitions
Name Data Type
Length Description
GAT_APPL_ID C 01 This column is the Application Identifier for the listed group.
Application identification is necessary because a group number is only unique within an application.
GAT_GROUP_NMBR C 06 This column contains the group number of a group that excludes
default tables or uses special tables.
GAT_TABLE_USE_IND C 01 The Table Use Indicator identifies the listed tables as being
excluded default tables or special tables used by the group. Valid values are:
X - Exclude default tables
U - Use special tables
GAT_SEQ_NMBR S 02 A Sequence Number is necessary to maintain a unique index to the
table for groups that have more than 10 excluded tables or more than 10 special tables.
GAT_TABLE_NMBR1 S 05 This column contains the first Table Number in the list of tables to
be excluded or used. There must be at least one table listed, as this column cannot be null.
GAT_TABLE_NMBR_2 S 05 This column contains the second Table Number in the list of tables
to be excluded or used. This column can be null.
GAT_TABLE_NMBR3-10 S 05 This column contains the third through tenth Table Numbers in the
list of tables to be excluded or used. All remaining table number
columns can be NULL. They are defined and used in the same way as GAT_TABLE_NMBR2.
Note: All table numbers listed in this table must have a
TI_UDF_MULTI_DFNTN code of D or S. The Group Alternate
Tables Table is checked to see if a group can use a particular
application table only when the application table is defined as a
Default or Special table of a multi-definition area.
If the application table has a TI_UDF_MULTI_DFNTN code of N,
the application table is used by all the groups and the Group Alternate Tables Table is not referenced.
Alternate Key IDD Table (ALTERNATE_KEY_IDD)
The Alternate Key IDD Table uses copybook GEN00005. The rows of the Alternate Key IDD Table contain
information from each of the data elements that are used to access the data by the alternate search paths. These
rows are built and maintained by program ASBIDMN during the re-sync process.
The Alternate Key IDD Table is structured as displayed in the following table.
24 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
Alternate Key IDD Table Column Definitions
Name Data Type
Length Description
ALTERNATE_KEY-IDD C 177 This table contains secondary/alternate index data definition
records.
This Table uses copybook GEN00005 which corresponds to
HRMSALD.
ALT_KEY_IDENT C 07 The first position is blank, indicating this a system-level data
dictionary entry.
Positions 2 through 6 are:
XALT1* for KEY1
XALT2* for KEY 2
XALT3* for KEY 3
XALT4* for KEY 4
Where X = application-ID:
ALT_KEY_FLD_DEF1 C 21 The first of seven data element definition entries, each 21
characters, that contains the definition of a data element used in the Alternate Key Definition.
The Alternate Key Field Definition includes:
The six-character IDD data element identifier.
A five-digit offset of the column on the employee row.
A one-character data element class.
A two-digit Master Database length.
A two-digit start position within the key.
A two-digit start position within the data element.
A two-digit number of characters for the data element in the key.
One character reserved for Genesys use.
ALT_KEY_FLD_DEF2 C 21 This definition contains the same structure and derivation as
ALT_KEY_FLD_DEF1.
ALT_KEY_FLD_DEF3 C 21 This definition contains the same structure and derivation as
ALT_KEY_FLD_DEF1.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 25
ALT_KEY_FLD_DEF4 C 21 This definition contains the same structure and derivation as
ALT_KEY_FLD_DEF1.
ALT_KEY_FLD_DEF5 C 21 This definition contains the same structure and derivation as
ALT_KEY_FLD_DEF1.
ALT_KEY_FLD_DEF7 C 21 This definition contains the same structure and derivation as
ALT_KEY_FLD_DEF1.
PRGMDDT DBMS Table Definition Maintenance
PRGMDDT adds, updates, and deletes information from the following:
Table Information
Column Information
Alternate Tables Information
And produces the DDL needed to create Application Data Tables.
PRGMDDT Input
PRGMDDT receives input data from either the delivered Integrated Data Dictionary (IDD) or from input
created manually. All input is an 80-character file (DBMS) or 120-character file (Enterprise Systems).
When the input is received into the program, the first two bytes are checked to see which type of record is to be
processed. The three valid record types are 10, 20, and 30.
Type 10 records contain information for tables (the Table Information COLTAB File).
Type 20 records contain information for columns (the Column Information COLTAB File).
Type 30 records contain information for Group Alternate Info (the Group Alternate Tables GAT
File).
Type 00 Records
The type 00 transaction format is displayed in the table below.
Type 00 Transaction Format
Position Field Valid Values
01-02 Tran Type 10
04-06 Function DEL - Delete
INS - Insert
TRN - Generate DDT transaction for entire application
UPD - Update
08 Appl ID
10-17 Creator Name TSO Userid or valid DBMS authorization ID.
18-25 Database Name Valid DBMS database name.
26-33 Stogroup Name Valid DBMS stogroup name.
34-41 Vcat Name Valid MVS catalog name.
42-48 Number of Groups Numeric value (zero-filled) of number of expected groups.
26 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
49-55 Number of
Individuals
Numeric value (zero-filled) of number of expected individuals.
Type 10 Records
If a type 10 record is read, the record function is checked for a valid value of ADD, UPD, DEL, PRT, or DRP.
If the function is invalid, the record is written to the DBMS Object Maintenance Error Report.
If the function is ADD or UPD, the add or update is applied to the COLTAB File for Enterprise Systems or
TABLE_INFO for DBMS Systems. Before any table processing is done, a number of edits take place. The
edits include these checks:
The table number must be numeric.
A table name must be present.
The table type must be G, H, I, or S.
The FLAG1 indicator must be Y or N.
The Multi Def code must be D, N, or S.
If any records are in error, they are written to the DBMS Object Maintenance Error Report. If no errors are
detected, the SQL is executed to insert or update that row in the COLTAB File.
If the PRT function is read, the COLTAB File is read to print the information on the Print Report.
If the DEL or DRP function is read, information on the COLTAB File is deleted for Enterprise Systems.
(DBMS Systems - TABLE_INFO COLUMN_INFO). A DRP function also causes the program to create the
DDL to drop all the tables indicated.
Type 10 Transaction Format
Position Field Valid Values
01-02 Tran Type 10
04-06 Function DDL - Generate SQL DDL for table
DEL - Delete
INS - Insert
PRT - Print
UPD - Update
08 Appl ID
10-14 Table Number Unique table number (zero-filled) valid range within each application.
16-45 Table Name Valid DBMS table name.
46 Table Type G - Group
I - Individual
H - History
47 Multi-definition ind N
D
S
48-55 Creator Name Valid TSO Userid (DBMS) or DBMS authorization ID.
56-63 Database Name Valid DBMS database name.
64-66 Number of Columns Numeric value (zero-filled) of number of columns in table.
67-73 Number of Rows Numeric value (zero-filled) of number of expected rows in table.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 27
Type 20 Records
If a type 20 record is read, the record function is checked for ADD, UPD, or DEL. If the function is invalid, the
record is written to the DBMS Object Maintenance Error Report.
If the function is ADD or UPD, the add or update is applied to the COLTAB File. Before any table processing
is done, a number of edits take place. The edits include these checks:
A TABLE_INFO row must be present for the Table Number.
The Table Number must be numeric.
The Column Number must be numeric.
A Column Name must be present.
If the column contains an asterisk reference, the Column Name cannot be longer than 11
characters.
An asterisk reference must be * or spaces.
The DBMS data type must be C, D, I, N, S, T, or V if an IDD data element is not entered in
positions 45-48.
For a data type of C, N, or V, decimals must be numeric.
The Nulls Use indicator must be NA, ND, NN, or spaces.
A Data Field entered in positions 45-48 must be on the IDD.
A Data Field entered in positions 49-52 must be on the IDD and must represent a valid Data Field
for the end of a range formed by the Data Field in positions 45-48.
If any records are in error, they are written to the DBMS Object Maintenance Error Report. If no errors are
detected, the SQL is executed to insert or update that row in COLUMN_INFO.
If an IDD field name or range of field names is entered, Asterisk Reference Column, DBMS Data Type, Field
Length, and Decimal Places should not be entered as they are generated from the information on the IDD. The
Data Field Table and Column are also updated on the IDD if a Data Field(s) is provided.
After all the records for a single table are read and processed, the system checks to see if any errors were
detected. If there are errors, no DDL is created for that particular table. If no errors are detected, the DDL is
produced to create the tablespace, table and indexes. If the DEL function is read, information on
COLUMN_INFO is deleted.
Type 20 Transaction Format
Position Field Valid Values
01-02 Tran Type 20
04-06 Function DEL-Delete
INS-Insert
UPD-Update
08 Appl ID
10-14 Table Number Unique table number (leading zero filled).
16-18 Column Number Unique column number (leading zero filled).
20-49 Column Name Valid DBMS column name.
50 Key Indicator A - ascending
D - descending
51 Asterisk Reference * or space
28 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
52 Data Type C - character
D - date
I - integer
N - numeric
S - smallint
T - time
V - varchar
53-54 Data Length Leading zero filled, required only for data types C, N, and V.
55-56 Decimals Number of digits to the right of the decimal point, required only for data
type N.
57-60 Prime IDD Field
Name
Four-character IDD field name
61-64 End IDD Field Name Four-character IDD field name.
65 Index Number Index of which this column is a part of. Valid values are 1-9.
66 Index Seq Number Sequence within the index. Valid values are 1-5.
67-70 PKID Value 0001 through 9999.
Type 30 Records
If a type 30 record is read, the record function is checked for ADD, UPD, or DEL. If the function is invalid, the
record is written to the DBMS Object Maintenance Error Report.
If the function is ADD or UPD, the add or update is applied to GROUP_ALTRNT_TBLS. Before any table
processing is done, a number of edits take place. The edits include these checks:
The Group Number must be numeric.
The Table Use indicator must be D or S.
The Sequence Number must be numeric.
The Table Numbers 1-10 must be numeric.
The Table Numbers 1-10 must exist on the TABLE_INFO Table.
If any records are in error, they are written to the DBMS Object Maintenance Error Report. If no errors are
detected, the SQL is executed to insert or update that row in GROUP_ALTRNT_TBLS (DBMS). If the DEL
function is read, information on GROUP_ALTRNT_TBLS (DBMS).
The type 30 transaction format is displayed in the table below.
Type 30 Transaction Format
Position Field Valid Values
01-02 Tran Type 30
04-06 Function DEL - Delete
INS - Insert
UPD - Update
08 Appl ID
10-15 Group Number Group number (left justified and
padded with spaces).
17 Table Use Indicator U - Use the table numbers
specified for this group number.
X - Exclude the table numbers
specified for this group number.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 29
19-20 Sequence Number 01 through 99, to group Group
Number and Table Use Indicator together.
22-26 Table Number 1 Must be greater than zero; a valid
table number.
28-32 Table Number 2 Spaces or a valid table number.
34-38 Table Number 3 Spaces or a valid table number.
40-44 Table Number 4 Spaces or a valid table number.
46-50 Table Number 5 Spaces or a valid table number.
52-56 Table Number 6 Spaces or a valid table number.
58-62 Table Number 7 Spaces or a valid table number.
64-68 Table Number 8 Spaces or a valid table number.
70-74 Table Number 9 Spaces or a valid table number.
76-80 Table Number 10 Spaces or a valid table number.
PRGMDDT Output
Output from the program consists of 133-byte Error Reports, 133-byte Print Reports, and a 120 character DDL
file used to create new tables.
File Designation: PRGMDDT
These are input/output files, listed by device type, with suggested physical device allocations. You can change
the listed device types without affecting system logic.
Type Device DDNAME/SYS# File Label/ID
Disposition/Description
Input Disk TRANDDT Transactions to define tables and columns
Output Disk TRANDDL SQL DDL DDL to create tables
Output Disk TRANOUT Transactions to define tables and columns
Output Disk TRANPRT report Listing of all executed transactions
Output Disk TABLPRT report Listing of tables, generated by PRT or ADD
Output Disk TRANERR report Any transactions errors or warnings
Table(s) Accessed = TABLE_INFO
For DBMS Systems = COLUMN_INFO and GROUP_ALTRNT_TBLS
Creating an Alias Data Element
You can specify an alias name for a Genesys-supplied system data element. This may be useful if your
organization uses the function of a delivered data element, but calls it a different name. Alias data elements
take on all of the characteristics of their matching Genesys system data element.
To create an alias data element, follow these steps:
1. Display the Data Dictionary Services Menu.
2. In the Data Element Name field, type the 4-character alias name you want to assign to an existing
data element.
3. In the Application ID field, select an application from the drop-down list.
4. Choose "Add a New Data Element," and click OK.
30 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
5. Click Yes on the message screen (User Defined?) to display the Add screen.
6. Tab to the Alias Field and type the name of the data element you want your alias to match.
7. Select Enter to process your action. Your new alias data element will have all of the attributes of
the original data element.
Creating an Umbrella Data Element You can specify an umbrella data element that groups together several UDFs for easier access to the data in
those UDFs. For example, you may want to group telephone area codes with telephone numbers, or employee
first names with last names.
When you create an umbrella data element, you specify a miscellaneous field range that includes the
miscellaneous fields of two or more UDFs. Because of this, the UDFs that make up the umbrella data element
must occupy consecutive miscellaneous fields.
To create an umbrella data element, follow these steps:
1. Display the Data Dictionary Services Menu.
2. In the Data Element Name field, type the 4-character umbrella name you want to create.
3. In the Application field, select an HRMS application by typing the appropriate letter. You can
choose only the applications available on your system.
4. Choose "Add a New Data Element," and click OK.
5. Click Yes on the message screen (User Defined?) to display the Add screen.
6. Complete the screen to specify your umbrella data element. Before you can specify a range in the
Miscellaneous field, you must:
Determine the location and length (maximum of 48 positions) within the miscellaneous fields
where you want to store the data for the UDFs and the umbrella data element.
Enter any change transactions necessary to relocate UDFs within the miscellaneous fields.
Select Enter to process your action.
Modifying a Data Element or UDF / Deleting a UDF You can modify Genesys-supplied data elements and UDFs, and you can also delete them.
To modify a data element or UDF, or delete a UDF, follow these steps:
1. Display the Data Dictionary Services Menu.
2. In the Data Element Name field, type the 4-character name of the data element or UDF that you
want to modify, or the UDF you want to delete.
3. In the Application ID field, select an HRMS application by typing the appropriate letter or
clicking on the arrow and highlighting an application from the list. You can choose only the
applications available on your system.
4. To modify information, click on Change Data Element Information, select OK, and make your
changes on the next screen.
5. To delete a UDF, click on Delete and select OK. Click Yes to the message "Are You Sure?" and
on the next screen that shows the UDF you want to delete, click on Delete and select OK. The
system displays a final message -- Field Delete Pend at Extract -- which means that the next time
the re-synchronization process (program ASBIDMN) is run, the field will be deleted.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 31
Creating an Alternate Index When you use SearchAll and Data Inquiry, F1 uses the TRAN key to tell the system which access path to use
for locating data from an individual record in the Master Database. (The TRAN key identifies an individual
record.) It may be more efficient, however, to create an Alternate Index, which enables you to use a data
element as the access path rather than the TRAN key. For example, you may want to use an individual's name
for accessing their record.
You can create an Alternate Index by using the Data Dictionary Maintenance screen to assign a data element to
a function key. After you create the Alternate Index and activate it, you can run it by using the function key on
a SearchAll or Data Inquiry screen that corresponds to the key you assigned. For example, F2 on a SearchAll
screen would activate an Alternate Index entered in the Key 2 field on the Data Dictionary Maintenance screen.
Note: To use the search features in the Find field on Inquiry screens, you must define alternate keys. For
example, to search on partial names, you may define alternate key 1 (ALT1) as F2 Name. ALT2, ALT3, and
ALT4 may be defined as F3, F4, and F5. The primary key, F1, is used for TRAN.
You can create different Alternate Indexes for each application on your system. Once you define them, they are
the same for inquiry screens and SearchAll reports used by an application.
To create an alternate index, follow these steps:
1. Display the Data Dictionary Services Menu.
2. In the Data Element Name field, type the 4-character name of a Genesys-supplied data element,
or a new or existing data element (UDF) that you want to use for your Alternate Index.
3. In the Application ID field, select an HRMS application by typing the appropriate letter or
clicking on the arrow and highlighting an application from the list. You can choose only the
applications available on your system.
4. Click on Add New Data Element (if you're adding a new data element) or Change Date Element
Information (if you're using an existing one) and select OK.
5. Click on Advanced in the lower right portion of the screen and select OK to display the Advanced
Options screen.
6. Tab to the Alternate Search Paths portion of the screen. The numbers -- #2, #3, #4, and #5 --
represent F-keys you use to run your alternate index.
7. Under each F-key number the Begin field specifies where this data element fits in the search path.
The search path can include several data elements and up to 48 positions. For example, you might
want to create an Alternate Index using the five-position data element DEPT, which is the
department where a person works, and a 24-position data element NAME, which is the person's
name. For the data element DEPT, you would type 01 in the Begin field as the location for the
first data element. In the Begin field for NAME, you would type 06, since DEPT takes up the first
5 positions.
8. The Offset field specifies the position within a data element to start a search. For example, you
may want to search on the person's last name, so you would type 05 in the Offset field because
Genesys delivers the NAME data element with the last name beginning in the fifth position. The
first and middle initials are in the first four positions. If you want to search on the entire field,
type 01 as the offset.
9. Click on OK to save your Alternate Index.
Activating the Alternate Index
1. To activate the Alternate Index for SearchAll and Data Inquiry, you must define the appropriate
Alt key by creating a UDF. For example, ALT1=F2, ALT2=F3, ALT3=F4, and ALT4=F5.
If you're defining F2 as an alternate index, you would create a data element named ALT1, assign it
32 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
to any miscellaneous field, and in the description field you would type the description for F2 that
you want displayed. If the purpose of ALT1is to retrieve names, you would create it as an Alias
for the data element NAME. To search on the last name, you would specify the fifth position (05),
Last Name, in the Offset field for the NAME data element.
2. Exit from the Genesys Online System.
3. Close the IDD (MNEMFLE), Screen File (SCRNFLE), and the GenCalc File (CALCFLE).
[OS/390 systems only]
4. Run Program ASBIDMN to define the alternate key records on the IDD.
5. Rebuild your Master Database Key Files as follows:
Run Program 910 to upload the Sequential Master Database to indexed format and rebuild Key
Files.
[For OS/390 systems, run P910. For Windows Server systems, run P910 P.]
6. Open the IDD (MNEMFLE), Screen File (SCRNFLE), and the GenCalc File (CALCFLE).
[OS/390 systems only]
Selected Data Elements Feature (Change Switches) The Selected Data Elements feature uses change switches that allow you to set internal flags to indicate when a
change is made to selected data elements. The names of the selected data elements and their switches are stored
in the Selected Data Element Table, located in Program UDM.
The purpose of this feature is to allow you to produce reports based on information that has changed in your
database. When the system processes a change transaction during Edit and Update -- a 41, 43, 44, 49, 71, 72, or
73 -- against one of your selected data elements, it changes the change switch from 0 to 1. At the beginning of
each Edit & Update Phase, the system resets all the change switches to zero.
You can use the indicators to extract data for reports. For example, you could use the Report Writer to produce
a Flexible Benefits confirmation statement when a participant changes his enrollment elections.
Setting Up Change Switches
Note: Change Switches cannot be set up through GenTools. To set up the switches, work with the technical
personnel in your organization responsible for maintaining your Genesys system.
Change Switches
Each individual record contains 32 change indicator switches. These change indicator switches are located in
four contiguous miscellaneous fields. The location of the first of the four miscellaneous fields is identified on
the Group Record in the CN18 field.
When you set up the Selected Data Element Table, you must enter the name of the miscellaneous field where
the change indicator switches are located in CN18. You also should set up 32 UDFs in the four miscellaneous
fields for the change indicator switches. These UDFs should be named CH01, CH02, CH03 . . . CH31, and
CH32. CH01 is the UDF set up in the first position of the first of the four miscellaneous fields. CH02 is the
UDF set up in the second position of the first miscellaneous field, and CH32 is the UDF set up in the last
position of the fourth miscellaneous field. After you create the UDFs CH01 through CH32, each individual
Record contains the 32 change indicator switches that match the change indicators in the Selected Data Element
Table.
Selected Data Element Table
The Selected Data Element Table is located in Program UDM for each application you have. Each table entry
consists of a data element and the designated change indicator switch. To define the Selected Data Elements
Table, you need to code one entry for every data element that you want. All entries must be located between
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 33
the 01 level data name SELECTED-MNEMONIC and the 05 FILLER entry. The FILLER entry is formatted as
follows:
05 FILLER
PIC X(36)
VALUE 'ENDTAB'
The Selected Data Elements Table is located between program sequence numbers 218000 and 218500.
Note: The data elements entered in the Selected Data Elements Table must occur in alphanumeric sequence
and be defined in the Integrated Data Dictionary.
When you enter a data element in the Selected Data Element Table, you must code the entry in this format:
05 FILLER
PICTURE X(36)
VALUE 'MMMMCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC'
Where:
MMMM is the data element affected by the change.
CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC are the 32 switches
Example:
If you want the system to turn on CH01 and CH03 when RATE is changed, the entry in the Selected Data
Element Table is as follows:
RATE10100000000000000000000000000000
As shown the first and third positions are 1 instead of 0, indicating that a change is being made to CH01 and
CH03.
Similarly, the Selected Data Element Table entries for ADR1, ADR2, and ADR3 shows a 1 (indicating a change
to an individual's address) for CH10, CH11, and CH12:
ADR100000000010000000000000000000000
ADR200000000001000000000000000000000
ADR300000000000100000000000000000000
Putting it all together, the following change indicator switches reflect the change to RATE, and the changes to
ADR1, ADR2, and ADR3.
10100000011100000000000000000000
In addition to setting up the Selected Data Element Table in PRGMUDM, you must specify the number of
entries in the Selected Data Element Table. At COBOL sequence number 220800, the 01 level data name
NUMBERS appears. Following it, at the COBOL sequence number 220900, is the 05 level data name
NUMBER-SELECTED-MNEMONICS.
22080001 NUMBERS COMPUTATIONAL *
22090005 NUMBER-SELECTED-MNEMONICS VALUE PIC9(4)
You must modify the VALUE clause for this data item to reflect the number of data elements entered in the
Selected Data Element Table. If there are 8 entries in the Selected Data Element Table, the VALUE clause
would read as follows:
22090005 NUMBER-SELECTED-MNEMONICS VALUE 8 PIC9(4)
You must modify the OCCURS clause to reflect the number of data elements entered in the Selected Data
Elements Table plus 1.
Example:
34 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
If you have eight data elements in the Selected Data Elements table you would enter nine in the program as
follows:
22010005 SEL-MNEMS OCCURS 9 TIMES.
Note: Multiple data elements can update one change switch.
Setting Up Selected Data Elements
Follow these steps to set up a Selected Data Element.
1. Determine which data elements you want to enter in the Selected Data Elements Table.
2. Use your system editor to enter the source code for Program UDM.
3. Add the entries for the Selected Data Element Table in sequential order after the 01 level data
name SELECTED-MNEMONIC and before ENDTAB.
4. Change the VALUE clause to reflect the number of data elements entered in the Selected Data
Element Table.
5. Change the OCCURS clause to reflect the number of data elements in the Selected Data Element
Table, plus one.
6. Recompile Program UDM as a subprogram. For further information on recompiling programs,
refer to the Genesys System Manual.
7. Recompile Program 010.
8. Enter the Online System and access the Data Element File Maintenance Menu to add the UDFs
CH01 through CH32 to the Dictionary.
9. Update CN18 in the affected Group Records to indicate the first of four miscellaneous fields that
store the change switches.
Deferred Data Dictionary Maintenance GENIDDM is the program used for installing and maintaining the IDD in the deferred environment. If your
system includes the Online System, you can maintain the IDD directly online. Genesys supplies a JCL or BAT
file to execute GENIDDM. To execute GENIDDM, submit the JCL or BAT file with one or more GENIDDM
control transactions. The mode in positions 10-17 of the GENIDDM control transaction determines the
function(s) performed by GENIDDM during execution. Refer to the control transaction layout detailed later in
this chapter. (Some procedures require multiple executions of GENIDDM.)
By submitting the Genesys-supplied JCL or BAT file with appropriate GENIDDM control transactions, you can
create and maintain User-Defined Fields (UDFs), and alias data elements, or extract sets of data element records
to a sequential output file to produce an IDD file backup. When converting to a new version of your Genesys
System, you may also use GENIDDM to save UDFs and alias data elements to be merged with new Genesys-
supplied data elements. GENIDDM is then used to first optionally delete the Genesys-supplied UDFs and alias
data elements, and then reload the saved UDFs and alias data elements to be merged with the Genesys-supplied
system data elements.
Note 1: If your system includes the Online System, you also can create UDFs and maintain the IDD online.
Note 2: GENIDDM also has a MNPRINT function to print UDF and Employee Miscellaneous Field Cross-
Reference Reports. A PRINT function is available to print cross-reference reports on all IDD fields.
Program GENIDDM Maintenance Considerations
The following considerations should be addressed when installing Program GENIDDM and when applying IDD
maintenance.
Program GENIDDM Maintenance Considerations, including the Compile Time Option.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 35
IDD Maintenance Considerations.
Compiling Program GENIDDM requires loading copybooks from every application delivered. Although an
identical Program GENIDDM is delivered on every applicationthat Genesys delivers, multiple copies of
GENIDDM modules are not required for IDD maintenance.
For systems with Feature 174, Direct Deposit , GENIDDM contains a Compile Time Option (CTO) that lets
you relocate Direct Deposit fields within the Miscellaneous Field area. You must relocate Direct Deposit fields
if your system has fewer than 521 Employee Miscellaneous Fields. As delivered, Direct Deposit fields start in
miscellaneous field JM01.
In addition to supplying GENIDDM for creating and maintaining your IDD file in the deferred environment,
Genesys provides the Online System customers with a program for online IDD maintenance. However, users
electing to alternate between deferred and online IDD maintenance must monitor UDF updates closely, since
GENIDDM execution can override UDF changes made in the Online System, and vice versa.
To alleviate this problem, Genesys advises Online System users to perform UDF maintenance exclusively
through the Online System, using GENIDDM only for installing, printing, backing up, and restoring the IDD
file.
The following GENIDDM flowchart illustrates the IDD deferred maintenance cycle.
GENIDDM Processing Flowchart
GENIDDM Control Record Reference To execute GENIDDM, submit one or more user-generated control transactions specifying a GENIDDM
program mode. Note: Record length = 80.
The following TXN samples are delivered with V6.1 systems that run on a Windows platform:
xGENEARN.cp1
xGENDEDN.cp1
xGENTXBL.cp1
The table below illustrates the format of the GENIDDM control records.
GENIDDM Control Transaction Format
Position Value Description
1-7 Program name constant, GENIDDM, to identify record.
36 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
10-17 ADD Add records to initialized or non-empty file.
DELETE Delete set of records.
EXTRACT Copy set of records to sequential output.
INIT Add records to empty file.
MNPRINT UDF listing and miscellaneous field Blue Print reports (see samples that follow).
PRINT All data dictionary fields listing report.
RELOAD Reload (and recalculate addressing for) UDFs/alias data elements after regeneration.
UPDATE Add, change, delete, UDFs or alias data elements.
20 I (immediate)
D (deferred)
S (system)
Blank (deferred)
(Real-time only)
Default Online System Update Indicator. If the Update Indicator is blank or not otherwise provided for a data element being processed, the default is D.
22-23 00-24 INIT and ADD only.
Blank Online System security code.
Applied to all fields if extract = Y (non-RealTime Plus)
Ignored if extract switch = N (non-RealTime Plus)
Default: 00
25 Application ID to specify set of records to be processed: Not applicable to UPDATE.
B Defined Contribution
D Defined Benefits
E Benefit Payments
F Flexible Benefits
H Human Resources Planning
M HealthCare HRMS
P Payroll/Human Resources
blank All applications
27 Record type to specify set of records processed by EXTRACT, DELETE, and PRINT
functions. (Multiple control records permitted.)
S System data elements only.
U UDFs and Alias data elements.
blank All record types.
28 Sequencing indicator for MNPRINT and PRINT cross-reference reports.
A Generate UDF/miscellaneous fields cross-reference reports (position 10-17 must be =
MNPRINT).
D Generate Data Dictionary field reports sorted by data element description (position 10-17
must be = PRINT).
29-80 blank
Transaction Formats to Update Data Element Records This section describes the transaction formats to add, change, or delete data element records, using the deferred
maintenance program.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 37
Note: The security and format for UDFs and aliases can be modified, however class fields can be modified
only for UDFs.
Maintaining a Data Element
Position Description Format Value Notation
01-03 Transaction
Type
XXX ADD To add a new UDF to the IDD.
CHG To change an existing UDF on the IDD.
DEL To delete an existing UDF from the IDD.
06 Application
ID
X B Defined Contribution
D Defined Benefits
E Benefit Payments
F Flexible Benefits
H Human Resource Planning
M HealthCare HRMS
P Payroll/Human Resources
blank All applications
08-11 Data Element XXXX User-defined data element. (May not duplicate any system
data element.)
Or
08-13 Tran Mask
or #DDF or +DDF
NNNN
NN
Transaction Mask identifier. Only the Update Indicator
and Online System control information can be changed for the transaction mask.
13-16 Location
(UDF)
XXNN Employee miscellaneous field where new field begins.
Location
(alias)
Genesys system data element for which this is an alias.
18-19 Position
or
Blank for
#DDF and
+DDF
NN Starting position in miscellaneous field where new field
begins.
21-22 Size
or
Blank for
#DDF and
+DDF
NN Total number of characters in the new field (Max. 48).
24-26 User Edit
Code
NNN 000-
499
Deferred user validation (EDIT) routine used, or Human
Resource Edit.
000,
blank
No editing required.
28 Change X N Field cannot be changed.
Y,
blank
Field can be changed directly.
29 Mass Change X N Field cannot be mass changed.
Y Field can be mass changed.
38 Chapter 2: Data Dictionary Services Doc-To-Help Standard Template
blank Defaults to Y if field size is 1 thru 8 positions, to N if size
is greater than 8 positions.
Note: Y is invalid if field length exceeds eight positions.
30 Update
Indicator
I Immediate update to Master database.
D Deferred update to Master database.
S Permanent deferred - cannot be changed to immediate.
blank Default to the Update indicator on the UPDATE control
transaction if the indicator is I, D, or S, otherwise default
to D.
31 Data Element
Type
X E,
blank
Field in employee/individual records only.
A Field in applicant records only.
B Field in both applicant and employee records.
Online System Control Information:
32-34 System Edit
Code
NNN 001-
499, or blank
Use Genesys-supplied edit routine. Default: 000
35-36 Security NN 00-24 Security level.
blank Default to the security code on the Update control
transaction.
37 Format Type When one of the letter codes listed below is entered into
the field, you indicate how the data will be displayed on the screen.
A Alpha/numeric (as is).
D Dates (standard)
E Dates (European)
N Signed numeric (no asterisk reference displayed).
38 Format
Modifier
N 0-8 Enter the number of decimal places (0-8) to display when
the Format Type equals N (numeric fields); or the size of a date field without dashes when Format Type equals D.
4 Date MMYY displayed as MM-YY.
6 Date MMDDYY displayed as MM-DD-YY when format
type is D, or as DD-MM-CCYY when format type is E.
8 Date CCYYMMDD displayed as MM-DD-CCYY when
format type is D, or as DD-MM-CCYY when format type is E.
39-80 Description X(42) Optional.
UDF Listing and UDF Blueprint Reports The MNPRINT mode of program GENIDDM produces the UDF Listing and UDF Blueprint reports. The
listing report shows the miscellaneous fields from EM01-NM99 in ascending order. The Blueprint report shows
how fields are defined in the miscellaneous fields for a specified application. The asterisks indicate the start
and stop positions of the fields.
Doc-To-Help Standard Template Chapter 2: Data Dictionary Services 39
Where Data Elements Are Used By running program ASBMREP , you can produce a report that shows where data elements are used throughout
your application. The report identifies the screens on which data elements appear, the online and deferred
GenCalcs, and SearchAll reports in which they are referenced, and basic information about the data elements
from the IDD.
Data Dictionary Resynchronization Run the program ADBIDMN whenever you make additions, deletions, or changes to the IDD. This program
updates the screen field definers. Programs 910 and ASOPPLS use these records to extract and store data in the
Master Database secondary indexes. Program ASBIDMN resynchronizes the screen IDD and GenCalc File.
Programs ASBIDMN
The ASBIDMN dataset used and the types are:
Dataset Type
Print File Output
Integrated Data Dictionary Input/Output
Screen File Input/Output
Work File Internal
Online GenCalc File Input/Output
Sort Files Internal
Report File Output
ASBIDMN
Run Program ASBIDMN when you install the Data Dictionary and Screen Files, and when you add, change, or
update data elements (UDFs and Alternate Index definitions).
ADBIDMN performs four major functions:
1. Updates screen field definers with new definitions when any change to a UDF definition edit code,
error message, or security level has been made to a data element.
2. Creates secondary index data element definition segments by checking each data element entry for
secondary index indicators.
3. Produces a list of data elements and the secondary index data element definitions. When you
install the Online System, you must execute ASBIDMN after all the Data Dictionaries have been
loaded to the IDD, the GenCalc file has been loaded, and the Screen File has been loaded by
Program ASBPPRP.
4. Reads the Online GenCalc database for GenCalcs in the application being processed. Performs
address adjustment for each data element found in the GenCalc statements and does an automatic
adjustment of screen format, decimal place format, and security. If a print option is selected, the
report contains a listing of each GenCalc processed. A total of processed GenCalcs appears at the
end of the report.