Customization

Customization

This appendix contains the following topics:

This section contains the following topics:

Introduction

Installation Parameters

Message Severity

Entity Exclusion Table

Manipulation of the Extract File

Introduction

CA IDMS Dictionary Migrator can be customized in the following general areas:

Installation Parameters

Note: For more information about these parameters, see the CA IDMS installation guides.

Message Severity

This section contains information about message severity.

Customization Instructions

Dictionary Migrator provides a facility where the severity level of messages can be changed.

Note: You do not need to use this facility for the proper execution of CA IDMS Dictionary Migrator. The facility is provided for users whose shop standards mandate some deviation from the basic migration strategy. This option is not used in default execution mode of CA IDMS Dictionary Migrator. Therefore, no load module is provided as part of the standard installation process.

General

This facility allows the CA IDMS Dictionary Migrator user to generate a table of specific messages along with their required severity levels.

Message Severity Level Table Generation Steps

The following are Message Severity Level Table Generation Steps:

1. Customize the source member USMSGSVT from the SRCLIB library.
2. Assemble and link edit this member into your CA IDMS Dictionary Migrator Loadlib.

Message Severity Level Table Customization

Edit the source member USMSGSVT as follows:

First Line:

#EXCLTAB TBLNAME=USMSGSVT

For each Message that has a severity level that needs to be changed, add a line that invokes the #MSGSEV macro with the required parameters.

#MSGSEV MSG=messageid,SEV=severitylevel

where:

messageid - is a 7 Character Message ID whose first four characters correspond to one of the following:

• EXTR
• ES00
• ES11
• VALD

The messages with the first four characters that do not correspond to one of the above may not have their severity levels altered.

severitylevel - is a single character either:

• X
• W
• E
• C

These characters may be interpreted as:

• X - NO PRINT - Occurrences of this message do not generate a printed message on any report.
• W - WARNING - Warning Message printed.
• E - ERROR - Error Message printed.
• C - CRITICAL - Critical Error printed. This error type causes CA IDMS Dictionary Migrator to terminate processing at the end of the current processing stage.

Last Lines:

#EXCLEND
END

Sample Table:

#EXCLTAB TBLNAME=USMSGSVT
#MSGSEV  MSG=ES00515,SEV=X
#MSGSEV  MSG=VALD219,SEV=C
#EXCLEND

Assembly and Linkage

Any level of IBM assembler and linkage editor can be used to create the Message Severity Level table.

1. MACLIB of the assembler step: Add the SRCLIB from installation to the files named in MACLIB.
2. SYSLMOD of the link edit step: Use the same LOADLIB from which CA IDMS Dictionary Migrator is executed.

Note: No default Message Severity Level table is provided. If you wish to generate this table see the SRCLIB member USMSGVT.

Entity Exclusion Table

The following instructions explain how to make use of the entity exclusion facility and detail what entity types may be excluded.

Customization Instructions

CA IDMS Dictionary Migrator provides a facility where specific entity occurrences can be excluded from the migration process.

Note: You do not need to use this facility for the proper execution of CA IDMS Dictionary Migrator. The facility is provided for users whose shop standards mandate some deviation from the basic migration strategy. A default version of this module with no entities excluded is provided in load module form as part of the standard installation process.

General

This facility allows the CA IDMS Dictionary Migrator user to generate a table of specific entities that are to be excluded from the migration process.

Entity Exclusion Table Generation Steps

1. Customize the source member USMEXCLD from the SRCLIB library.
2. Assemble and link edit this member into your CA IDMS Dictionary Migrator Loadlib.
3. At Execution time, define the Entity Exclusion Table to be used to CA IDMS Dictionary Migrator through the EXCLTAB parameter. This step is only necessary if a table name other than the default USMEXCLT is to be used.

Entity Exclusion Table Customization:

Edit the source member USMEXCLD as follows :

First Line:

#EXCLTAB TBLNAME=yourname.
Use any name up to 8 characters following standard naming rules.
Default name=USMEXCLT.

For each entity occurrence to be excluded, add a source line that invokes the #EXCLENT macro with the required parameters:

#EXCLENT TYPE=entitytype,
NAME=entityname,
VERS=version,  (if applicable)
QUAL=qualifier (if applicable)

where :

entitytype (Required)—One of the following entity types that must be specified in uppercase and can be abbreviated to the first two characters.

AT(TRIBUTE)
CL(ASS)
DI(ALOG)
EL(EMENT)
FI(LE)
MA(P)
MO(DULE)
PR(OGRAM)
RE(CORD)
SC(HEMA)
SU(BSCHEMA)
SY(STEM)
US(ER)

entityname (Required)—Entity Occurrence Name in uppercase.

version (Optional)—Defaults to version number 1. Version number or ALL (for all versions). Version numbers apply to all entity types except from Attribute, Class, and User.

qualifier—Applies to the following entity types (must be in uppercase):

• Attribute -- qualifier is class name (required).
• Module -- qualifier is language name (optional). Language name should be specified if the module is stored in the Data Dictionary with a LANG-067 field other than spaces. See Note below.
• Subschema -- qualifier is schema name (required).

Note: ADS process modules are stored in the Data Dictionary with a language name = PROCESS. If you want to exclude an ADS module from the migration, you should specify QUAL=PROCESS on the #EXCLENT line entry for the module to be excluded.

Last Lines:

#EXCLEND
END

Sample Table:

#EXCLTAB TBLNAME=EXCLTAB
#EXCLENT TYPE=RECORD,NAME=TESTREC,VERS=100
#EXCLENT TYPE=ATTRIBUTE,NAME=WORK,QUAL=STATUS
#EXCLEND
END

Assembly and Linkage

Any level of IBM assembler and linkage editor can be used to create the Entity Exclusion Table. As indicated above, the default Entity Exclusion Table name is USMEXCLT. If you want to utilize a table with a different name, remember to indicate the named table on the EXCLTAB CA IDMS Dictionary Migrator parameter. For example, EXCLTAB=mytable.

1. MACLIB of the assembler step: Add the product installation MACLIB to the files named in MACLIB.
2. SYSLMOD of the link edit step: Use the same LOADLIB from which CA IDMS Dictionary Migrator is executed.

Default Entity Exclusion Table (table name USMEXCLT)

#EXCLTAB
#EXCLEND




END

Manipulation of the Extract File

The extract file is a set of extract records that can be manipulated.

Extract Record

The following is a COBOL definition of the extract record. A description of the various fields follows the definition.

 01     MIGRATOR-EXTRACT
        05     EXTR-CO-LOC.
               10      EXTR-CHANGEONLY              PIC    X(01).
               10      EXTR-EXTRACT-LEVEL           PIC    X(01).
        05     EXTR-VSAMEXT-KEY.
               10      EXTR-ENTITY-TYPE             PIC    S(4) USAGE IS COMP.
               10      EXTR-ENTITY-NAME             PIC    X(40).
               10      EXTR-SELECT-VERSION          PIC    S9(4) USAGE IS COMP.
               10      EXTR-ALT-ENTITY-NAME         PIC    X(40).
        05     EXTR-ENTITY-LEVEL                    PIC    X(2).
        05     EXTR-ENTITY-UTILITY                  PIC    X(2).
        05     EXTR-SELECT-DICTIONARY               PIC    X(8).
        05     EXTR-SELECT-NODE                     PIC    X(8).
        05     EXTR-SOURCE-USER                     PIC    X(32).
        05     EXTR-SOURCE-PASSWORD                 PIC    X(8).
        05     EXTR-COBOL-FORMAT                    PIC    X(01).
        05     EXTR-MOVESTAMP                       PIC    X(01).
        05     EXTR-SELECT-COMMENT-SOURCE           PIC    X(01).
        05     EXTR-SELECT-DEFINITION-SOURCE        PIC    X(01).
        05     EXTR-GENERATE                        PIC    X(01).
        05     EXTR-RESERVED-1                      PIC    X(14).
        05     EXTR-LOAD-TYPE                       PIC    S9(4) USAGE IS COMP.
        05     EXTR-RESP-OVERRIDE                   PIC    X(01).
        05     EXTR-COMPARE-DATE.
               10      EXTR-COMPARE-MN              PIC    X(02).
               10      FILLER                       PIC    X(01).
               10      EXTR-COMPARE-DD              PIC    X(02).
               10      FILLER                       PIC    X(01).
               10      EXTR-COMPARE-YY              PIC    X(02).
        05     EXTR-COMPARE-TIME.
               10      EXTR-COMPARE-TIME-6.
                       15     EXTR-COMPARE-HH       PIC    X(02).
                       15     EXTR-COMPARE-MN       PIC    X(02).
                       15     EXTR-COMPARE-SS       PIC    X(02).
               10      EXTR-COMPARE-HN              PIC    X(02).
05     EXTR-RESERVED-2                      PIC    X(44).

Field Definitions and Values

• EXTR-CHANGEONLY—CHANGEONLY Status of extract record. See ADDONLY, CHANGEONLY process parameters and USMTPARM DELADDS option.
• 'D'—Entity is dropped
• 'Y'—Entity is selected for modify to object dictionary
• 'N'—Entity is selected for ADD to object dictionary
• EXTR-EXTRACT-LEVEL — Extract Level of migration. See LEVEL process and extract parameters.
  • 'S'—"Dialog" Level
  • 'E'—"Entity" Level
  • 'O'—"Only" Level
• EXTR-VSAMEXT-KEY—An 84 byte key used to create the VSAM work file that contains extracted entities for dictionary comparisons.
• EXTR-ENTITY-TYPE—2 byte numeric field. Encoded type of entity. See entity type definitions table.
• EXTR-ENTITY-NAME—40 byte field name. It contains the entity occurrence name.
• EXTR-SELECT-VERSION—2 byte numeric version number of extracted entity. If the entity type does not have version number, set to 0. If null, new version processing is used it contains -2.
• EXTR-ALT-ENTITY-NAME—40 byte field used to qualify certain entity types. Contains the following:
  • Class name for Attributes
  • Schema name for Subschema
  • Language name (if any) for Modules
  • Element details for Element definitions
• EXTR-ENTITY-LEVEL—2 byte character field. Relative level number for entities that have nest relationships. Used to ensure that correct ordering of entity levels, for example elements, are maintained.
• EXTR-ENTITY-UTILITY—2 byte character field. Indicates which CA IDMS utility is used to process the extracted entity. See utility type definitions table below.
• EXTR-SELECT-DICTIONARY—8 byte character field specifying the source dictionary name. See DICTIONARY extract or process parameter.
• EXTR-SELECT-NODE—8 byte character field specifying the source database node name. See NODE extract or process parameter.
• EXTR-SELECT-USER—32 byte character source dictionary user name. See IDSOURCE, EXTRACT, or PROCESS parameter.
• EXTR-SELECT-PASSWORD—8 byte character source dictionary password. See IDSOURCE extract or process parameter.
• EXTR-COBOL-FORMAT—1 byte character field. See COBOLFORMAT process parameter. Valid only for Record type.
  • 'Y'—Generate COBOL like syntax
  • 'N'—Do not generate COBOL like syntax
• EXTR-MOVESTAMP—1 byte character field. See MOVESTAMP process parameter. Valid only for Map type.
  • 'Y'—Decompile map with DATETIME=YES
  • 'N'—Do not decompile with DATETIME=YES
• EXTR-SELECT-COMMENT-SOURCE—1 byte character field. See: EXSOURCE=COMMENT PROCESS, EXTRACT parameter
• EXTR-SELECT-DEFINITION-SOURCE—Determines whether or not definitions are extracted.
  • "Y"—Definitions are extracted
  • "N"—Definitions are not extracted
• EXTR-GENERATE—Determines whether or not the entity needs to be generated.
  • "Y"—Entity needs to be generated
  • "N"—Entity does not need to be generated
• EXTR-RESERVED-1—Reserved for future use.
• EXTR-LOAD-TYPE—2 byte numeric field. The source type of entity that the load module represents. See entity type definitions table.
• EXTR-RESP-OVERRIDE—determines whether or not a registration override statement should be used.
  • "Y"—Override should be used
  • "N"—Override should not be used

Values for Utility Types

Value for Entity Type Codes