TSS Customer Key Manager Reference Manual

Trillium Software System™

CUSTOMER KEY MANAGERReference Manual

Series 7

This manual, as well as the software described in it, are furnished underlicense and may be used only in accordance with the terms of such license.The content of this manual is furnished for informational purposes only, issubject to change without notice, and should not be construed as acommitment by Trillium Software. Trillium Software assumes noresponsibility or liability for any errors or inaccuracies that may appear inthis manual.

The customer shall not disclose, copy, reproduce, distribute, or display anyportion of the Trillium Software System or this manual in any form to anythird person without the prior written consent of Trillium Software, nor allowthird parties to do the same. The customer shall keep the Trillium SoftwareSystem and all confidential information in the strictest confidence.

Customer Key Manager Reference Manual 53017

Trillium Software, Inc. owns all rights in and to the marks "TRILLIUMSOFTWARE" and "TRILLIUM SOFTWARE SYSTEM," which marks areregistered in various countries throughout the world (including, withoutlimitation, the United States Patent and Trademark Office).

All other trademarks are the property of their respective owners.

© 2008-2017 Trillium Software, Inc.

Table of Contents

Trillium Software System® CKM

CHAPTER 1 Introduction............................. 1-1

Memory Requirements ....................................... 1-1Customer Support.............................................. 1-2

CHAPTER 2 Customer Key Manager Installation Instructions ............................. 2-1

Installing Customer Key Manager on IBM Mainframe.......................................................... 2-2

Starting the IBM Mainframe Installation .......... 2-2Completing the IBM Mainframe Installation ..... 2-3Testing the IBM Mainframe Installation ........... 2-3

Installing Customer Key Manager on Windows ... 2-4Starting the Windows Installation.................... 2-4Testing the Windows Installation..................... 2-5

Installing Customer Key Manager on UNIX......... 2-6Installation Package ........................................ 2-6Starting the UNIX Installation ......................... 2-6Setting the Customer Key Manager Environment ................................................... 2-6Testing the UNIX Installation........................... 2-6

Using Standard Label Processing........................ 2-7

CHAPTER 3 Getting Started ........................ 3-1

Introduction to Customer Key Manager.............. 3-2Requirements for Customer Key Manager ....... 3-2Questions to Answer Prior to Beginning........... 3-2Creating the Customer Key Manager Master Parameter File................................................. 3-4Creating Customer Key Manager’s Master File DDL .......................................................... 3-6

Customer Key Manager Reference Guide iii

Table of Contents

Additions to the DDL ....................................... 3-6Creating Other DDLs Used by Customer Key Manager.......................................................... 3-6Batch Reference Match for Customer Key Manager.......................................................... 3-7Creation Process ............................................. 3-7Update Process ............................................... 3-7

CHAPTER 4 Customer Key Manager Overview 4-1

Customer Key Manager System Functions.......... 4-2Customer Key Manager Flow Chart (Creation).... 4-3Customer Key Manager Flow Chart (Update)...... 4-4Customer Key Manager Step Definitions ............ 4-5Change Process (CP).......................................... 4-6

CRCRTINI........................................................ 4-6CRCKCHNG ..................................................... 4-6Sort................................................................. 4-6Sort................................................................. 4-6CRMATMST...................................................... 4-6CRMSTUP1 ...................................................... 4-6Sort................................................................. 4-7CRPRCHNG...................................................... 4-7Sort................................................................. 4-7CRMSTUP2 ...................................................... 4-7

Key Management Process (KP)........................... 4-8Sort................................................................. 4-8CRCLSGRD...................................................... 4-8Sort................................................................. 4-8CRKEYGRD...................................................... 4-9Sort................................................................. 4-9Sort................................................................. 4-9Level Key Continuity ....................................... 4-9Super-Set Link ................................................ 4-9

iv Customer Key Manager Reference Guide

Table of Contents

CHAPTER 5 Parameter Files for Customer Key Manager Modules...................... 5-1

Master Parameter File ..................................... 5-1CRCRTINI........................................................ 5-1CRCKCHNG ..................................................... 5-1CRMATMST...................................................... 5-2CRMSTUP1 ...................................................... 5-2CRPRCHNG...................................................... 5-2CRMSTUP2 ...................................................... 5-2CRCLSGRD...................................................... 5-2CRKEYGRD...................................................... 5-2Parameters ..................................................... 5-2

Notes ................................................................5-14Note A............................................................5-14Note B............................................................5-14Note C............................................................5-14Note D ...........................................................5-15Note E............................................................5-15Note F ............................................................5-15Note G ...........................................................5-15Note H ...........................................................5-16Note I ............................................................5-16Note J ............................................................5-16Note K............................................................5-16Note L ............................................................5-16Note M ...........................................................5-17Note N ...........................................................5-17Note O ...........................................................5-18Note P ............................................................5-18Note Q ...........................................................5-18Note R............................................................5-19Note S............................................................5-19

Rules ................................................................5-20Sample Master Parameter File........................5-21

Functional Overview of Customer Key Manager Modules ............................................................5-24

CRCRTINI (Create Initialization File) ..............5-24

Customer Key Manager Reference Guide v

Table of Contents

CRCKCHNG (Check for Changes)....................5-24CRMATMST (Create Matching Master File) ......5-25CRCLSGRD (Closed Record Processing) - Optional Module ...........................................................5-25CRKEYGRD (Key Continuity, Key Persistency) 5-25CRMSTUP1 (Master Update 1) ........................5-25CRPRCHNG (Process Set Changes) - Optional Mod-ule .................................................................5-26CRMSTUP2 (Master Update 2) ........................5-26

CHAPTER 6 The Change Process (CP) ........... 6-1

CRCRTINI .......................................................... 6-2Purpose........................................................... 6-2Program.......................................................... 6-2Parameters ..................................................... 6-3Program Execution .......................................... 6-3Sample Parameter File for CRCRTINI............... 6-4

CRCKCHNG ........................................................ 6-6Purpose........................................................... 6-6Program.......................................................... 6-6Input/Output Data Files................................... 6-9FLD Output File ..............................................6-10Customer Initialization File .............................6-11Parameters ....................................................6-12Program Execution .........................................6-15Sample Parameter File for CRCKCHNG - Creation Mode..............................................................6-16Sample Parameter File for CRCKCHNG - Update Mode..............................................................6-17Sample JCL for CRCKCHNG - Creation Mode...6-18Sample JCL for CRCKCHNG - Update Mode.....6-20

CRMATMST .......................................................6-22Purpose..........................................................6-22Program.........................................................6-22Input/Output Data Files..................................6-23Parameters ....................................................6-24Program Execution .........................................6-26

vi Customer Key Manager Reference Guide

Table of Contents

Sample Parameter File for CRMATMST ...........6-26Sample JCL File for CRMATMST ......................6-27

CRMSTUP1........................................................6-29Purpose..........................................................6-29Program.........................................................6-29Input/Output Data Files..................................6-32Parameters ....................................................6-33Program Execution .........................................6-35Sample Parameter File for CRMSTUP1 - Creation Mode..............................................................6-35Sample JCL for CRMSTUP1 - Creation Mode ...6-36Sample JCL for CRMSTUP1 - Update Mode .....6-38

CRRCHNG .........................................................6-41Purpose..........................................................6-41Program.........................................................6-41Input/Output Data Files..................................6-42Parameters ....................................................6-42Program Execution .........................................6-43Sample Parameter File for CRPRCHNG ...........6-44Sample JCL for CRPRCHNG.............................6-44

CRMSTUP2........................................................6-47Purpose..........................................................6-47Program.........................................................6-47Input/Output Data Files..................................6-49Parameters ....................................................6-49Program Execution .........................................6-51Sample Parameter File for CRMSTUP2 - Creation Mode..............................................................6-51Sample Parameter File for CRMSTUP2 - Update Mode..............................................................6-52Sample JCL for CRMSTUP2 - Creation Mode ...6-52Sample JCL for CRMSTUP2 - Update Mode .....6-54

CHAPTER 7 The Key Management Process (KP). 7-1

CRCRTINI .......................................................... 7-2Purpose........................................................... 7-2Program.......................................................... 7-2

Customer Key Manager Reference Guide vii

Table of Contents

Parameters ..................................................... 7-3Program Execution .......................................... 7-3Sample Parameter File for CRCRTINI............... 7-4

CRCKCHNG ........................................................ 7-6Purpose........................................................... 7-6Program.......................................................... 7-6Input/Output Data Files................................... 7-9FLD Output File ..............................................7-10Customer Initialization File .............................7-11Parameters ....................................................7-12Program Execution .........................................7-15Sample Parameter File for CRCKCHNG - Creation Mode..............................................................7-16Sample Parameter File for CRCKCHNG - Update Mode..............................................................7-17Sample JCL for CRCKCHNG - Creation Mode...7-18Sample JCL for CRCKCHNG - Update Mode.....7-20

CRMATMST .......................................................7-22Purpose..........................................................7-22Program.........................................................7-22Input/Output Data Files..................................7-23Parameters ....................................................7-24Program Execution .........................................7-26Sample Parameter File for CRMATMST ...........7-26Sample JCL File for CRMATMST ......................7-27

CRMSTUP1........................................................7-29Purpose..........................................................7-29Program.........................................................7-29Input/Output Data Files..................................7-32Parameters ....................................................7-33Program Execution .........................................7-35Sample Parameter File for CRMSTUP1 - Creation Mode..............................................................7-35Sample JCL for CRMSTUP1 - Creation Mode ...7-36Sample JCL for CRMSTUP1 - Update Mode .....7-38

CRRCHNG .........................................................7-41Purpose..........................................................7-41Program.........................................................7-41

viii Customer Key Manager Reference Guide

Table of Contents

Input/Output Data Files..................................7-42Parameters ....................................................7-42Program Execution .........................................7-43Sample Parameter File for CRPRCHNG ...........7-44Sample JCL for CRPRCHNG.............................7-44

CRMSTUP2........................................................7-47Purpose..........................................................7-47Program.........................................................7-47Input/Output Data Files..................................7-49Parameters ....................................................7-49Program Execution .........................................7-51Sample Parameter File for CRMSTUP2 - Creation Mode..............................................................7-51Sample Parameter File for CRMSTUP2 - Update Mode..............................................................7-52Sample JCL for CRMSTUP2 - Creation Mode ...7-52Sample JCL for CRMSTUP2 - Update Mode .....7-54

CHAPTER 8 Error Codes.............................. 8-1

Customer Key Manager Reference Guide ix

CHAPTER 1 Introduction

This section provides the requirements and instructions for installing Customer Key Manager. Customer Key Manager is designed to run on the following platforms:

IBM Mainframe UNIX Windows

Memory RequirementsCustomer Key Manager requires a minimum of 32 megabytes of memory. There should be a minimum10 megabytes of disk storage available to store all of the directories and executables of Customer.

Introduction

1-2 Customer Support

Customer SupportCustomer Support is available Monday through Friday, 24 hours a day, to help you with any questions you may have about Trillium Software System. This service is available to all customers who have active maintenance plans.

E-mail: [email protected] Telephone: 978-901-0000 (Worldwide Headquarters)

+44 (0) 118 940 7676 (European Headquarters)

Customer Key Manager Reference Guide

CHAPTER 2 Customer Key Manager Installation Instructions

This chapter contains Customer Key Manager installation instructions for:

IBM Mainframe Windows UNIX

Customer Key Manager Installation Instructions

2-2 Installing Customer Key Manager on IBM Mainframe

Installing Customer Key Manager on IBM MainframeThe installation package for IBM Mainframe consists of one 3490 cartridge containing:

Installation JCL IBM Mainframe version JCL parms loadlibs

Starting the IBM Mainframe InstallationTo start the installation:

1. Load the first file from cart to disk using IEBGENER as shown in the sample JCL setup below.//BOOT JOB//IEBGENER EXEC PGM=IEBGENER//SYSPRINT DD SYSOUT=A//SYSUT1 DD DISP=OLD,UNIT=3490// VOL=SER=MTvvvv,// LABEL=1,// DSN=HHDT.CART.&CKMxVx.INSTJCL//SYSUT2 DD DISP=(NEW,CATLG,DELETE),UNIT=DISK,// SPACE=(TRK,(5,5)),// VOL=SER=vvvvvv,// DSN=&PREFIX.&CKMxVx.US.INSTJCL//SYSIN DD DUMMY/*

2. Specify the input cartridge in the VOL=SER=parameter in the SYSUT1 DD statement (in this sample the cartridge volume is MTvvvv.

3. Specify the DASD volume in the VOL=SER=parameter in the SYSUT2 DD statement (in this sample the DASD volume is vvvvvv).


Completing the IBM Mainframe Installation 2-3

4. Specify the unit in the UNIT=parameter in the SYSUT2 DD statement (in this example the UNIT is DISK).

5. Note that because you probably have these directories in a specific project prefix, change the data set name prefix variable, &PREFIX, to your project prefix.

6. Change the dataset name variable, &CKMxVx, to the current version.

The file you unloaded contains a JCL PROC that when executed, unloads the remaining files from the cartridge required for installation.

Completing the IBM Mainframe InstallationTo complete the installation:

1. Select, Edit, and Execute the ‘&PREFIX.&CKMxVx.US.INSTJCL’.

2. Modify the PREFIX, VOL, and UNIT parameters at the end of the install JCL PROC to the values appropriate for your data center.

3. Modify the DSVOL parameter with the volume number of the cartridge from which Customer Key Manager is being installed.

Testing the IBM Mainframe InstallationThe member, TRIALCR8, in the unloaded ‘DSN=&PREFIX.&CKMxVx.US.JCLLIB’ contains a JCL to execute a Customer Key Manager creation job stream. Edit that member for the correct volume name, prefix, and unit type to conform to your organization’s JCL standards. The TRIALCR8 job stream will exercise the Customer Key Manager batch application programs.

The member, TRIALUPD, in the unloaded ‘DSN=&PREFIX.&CKMxVx.US.JCLLIB’ contains a JCL to execute a Customer Key Manager update job stream. Edit that member for the correct volume name, prefix, and unit type to conform to your organization’s JCL standards. The TRIALUPD job stream will exercise the Customer Key Manager batch application programs. Execute this JCLafter successful completion of the TRIALCR8 job stream.


2-4 Installing Customer Key Manager on Windows

Installing Customer Key Manager on Windows

Starting the Windows InstallationTo start the installation:

1. Download the Customer Key Manager software installation package from TSS Download Center (File Portal) FTP site.

2. Double-click the setup file (CKMWin.exe) to begin the installation. The InstallShield Wizard gathers the required information and displays the welcome message.

3. Click Next.The License window opens.

4. Read the license agreement. Select I accept... and click Next. The Destination Folder Window appears.

5. Select a location for the installation. (The default drive is c:\tril7Vnn, where nn is the version number).

Choose the recommended target location by clicking Next. Click Change and enter or select another install location. After you

have selected where you would like the software to be installed, click Next.

6. Click Install to start the installation.

7. When the installation is complete, click Finish.

Testing the Windows InstallationA README file exists in the .\doc subdirectory containing additional information about the install and about testing the installed Customer Key Manager. After the software is installed, run the system test as described in the .\doc\readme.txt.


Installing Customer Key Manager on UNIX 2-5

Installing Customer Key Manager on UNIX

Starting the UNIX InstallationTo start the installation:

1. Download the Customer Key Manager software setup from the TSS Download Center (File Portal) FTP site.

2. Move the TAR file to the directory on the UNIX Server where you will unload the files. We recommend ‘tril7Vnn’ for the installation directory, where nn is the Series 7 version number.

3. Unload Customer Key Manager with the following command at the UNIX prompt:

tar [-]xvf <filename>

This command will unload Customer Key Manager and create the proper directories.

Setting the Customer Key Manager EnvironmentTo set the Customer Key Manager environment, change to the ./bin directory and run setup.exe.

Testing the UNIX InstallationA README file exists in the ./doc subdirectory containing additional information about the install and about testing the installed Customer Key Manager. After the software is installed, run the system test as described in the ./doc/readme.


CHAPTER 3 Getting Started

This section introduces you to how to begin building the necessary components for a Customer Key Manager application. Prior to beginning, specific questions need to be answered in order to set up Customer Key Manager’s master parameter text file. This master parameter text file is used by Customer Key Manager’s software modules to identify the following:

input source files file formats required fields number of matching levels sequence of files optional processes selected (if any)

It is assumed that the Trillium Software System™ is the software of choice that will be used to perform the name and addressing processing within the application.

Getting Started

3-2 Introduction to Customer Key Manager

Introduction to Customer Key ManagerThe main purpose of using Customer Key Manager Software is to provide key continuity/key persistency to multiple relationship level keys over time. These level keys are 19-byte keys that are assigned by the CRKEYGRD module of Customer Key Manager based on group linkages that are assigned by Trillium matching programs. Based on changes in groupings from cycle to cycle, Customer Key Manager applies its pre-defined rules to perform its function of key continuity.

Requirements for Customer Key ManagerThe following requirements are necessary for Customer Key Manager to perform its key continuity/key persistency functionality:

Each input source file must have a constant unique sequence key and it must remain unique throughout the entire application.

The constant unique sequence key identifies the same input record from cycle to cycle.

If multiple levels of matching are being performed, these levels of matching must be hierarchical.

During matching at the highest level, one additional window key is required. This window key is last cycle’s highest level value.

Inputs and outputs must be fixed length, flat files.

Questions to Answer Prior to BeginningAnswers to the following questions will help users prepare resources for the Customer Key Manager application.1. Identify for each input source file the following:

Constant unique sequence key Fields that should be checked for changes from cycle to cycle. Fields with data changes that should cause the record to be processed

by Trillium.


Questions to Answer Prior to Beginning 3-3

Field that contains the file source identifier. This field must be the same field name on all input source files.

DDL that defines the input source file. Number of days to keep “closed” records on the Customer Key Manager

master file. If you are unsure or you want them indefinitely, the answer is 99999.

2. How many levels of matching are being accomplished with Trillium?3. Do you want the Julian date portion of the Customer Key Manager generated

“record_id” to be user-defined date or system run time date?4. Do you want the Julian Date portion of the Customer Key Manager gener-

ated “level keys” to be user-defined date or system run time date?5. Do you want the three Customer Key Manager generated optional date fields

to be the user-defined date or system run time date?We recommend the answers for questions 3, 4, and 5 be the same.

• If the answers to 3, 4, and 5 are user-defined data:set CURR_CYCLE_DATE master parameter to the desired date and change this date before each execution of the application. Set the date option to the three optional date fields, if used, to CYCLE_DATE.

• If the answers to 3, 4, and 5 are system run-time date:Add the optional master parameter, RECID_DATE, and set to RUN_DATE. Set the date option of the three optional date fields, if used, to RUN_DATE. Add the optional local parameter, RUN_CYCLE_DATE, and set it to SYSTEM for the CRKEYGRD module.

6. Are records being generated in the Trillium batch parser program, CFPRS-DRV?

Recommendation is NO.

• If the answer is yes, then consult with Trillium Professional Services.7. Do you want to “re-match” a level1 entity if any record in this entity is being

sent to Trillium for processing by the CRCKCHNG module?Recommendation is YES.

• If the answer is yes, then add the optional local parameter, REMATCH_OUT_DDNAME, and give it a file name for the CRMATMST module.

Getting Started

3-4 Creating the Customer Key Manager Master Parameter File

8. Do you want to “re-parse” and “re-geocode” any level1 entity records that were written to the REMATCH_OUT_DDNAME parameter, if set?

Recommendation is YES.9. During the update processing cycles, will the input source files be a com-

plete replacement or only consist of new/change records?If the input source files will contain only new and change records then it’s recommended not to generate system delete transactions during the execution of CRCKCHNG module. System delete transactions will set the record status to “closed” on the Customer Key Manager master file. To prevent generating system delete transactions, set the optional local parameter, GENERATE_DELETES, to NO for the CRCKCHNG module.

10. Do you want to set the following three optional date fields in Customer Key Manager?

CLOSED_ACCT_DATE_FIELDREOPEN_ACCT_DATE_FIELDMAST_DATE_LAST_TOUCHED_NAMEIf the answer is yes, add them to the master parameter file.

11. It is recommended that the following optional master parameter be set for use.

REPREPROCESS_FIELD_NAME

Creating the Customer Key Manager Master Parameter FileUse the master parameter file that is delivered with the software as your template.The following master parameters will need to be changed based on answers regarding input source files:

VALID_FILES CHECK_FIELDS_nnn SEQ_FIELDS_nnn MAST_FILE_NAME

The following master parameters will need to be changed based on the number of levels of matching being accomplished:

KEY_FIELD_NAMES


Creating the Customer Key Manager Master Parameter File 3-5

MAST_RECD_SEQ_FIELDS MP_TMP_KEY_FIELD_NAMES MP_CHANGE_FIELD_NAMES

The following master parameter will need to be changed based on what fields you need from the Trillium process to be populated on the Customer Key Manager master file:

MP_CHANGE_FIELD_NAMESThis parameter must contain the following fields to be moved onto the Customer Key Manager master file from the Trillium process:

Each level key of matching. All Trillium generated fields to which you want access. All Trillium generated fields used in generating the matching window

keys. All Trillium generated fields used in matching. All Trillium generated fields used in Trillium’s prime record assignments,

if performed. All Trillium generated fields used in Customer Key Manager’s prime

record assignment, if performed. All Trillium generated fields used in Trillium’s data commonization, if

performed. All Trillium generated fields used in Customer Key Manager’s data

commonization, if performed.

Getting Started

3-6 Creating Customer Key Manager’s Master File DDL

Creating Customer Key Manager’s Master File DDLThe fields listed in the following section must be included in Customer Key Manager’s master file DDL. After building Customer Key Manager’s master parameter file, any field name referenced must be part of the DDL. The field name defined by the master parameter SUPER_SET_FIELD_NAME is not needed on the Customer Key Manager master file.

Additions to the DDLThe following fields must be included in the Trillium file DDL, and added to the ORG_RECORD section.

2 19-byte fields for every level of matching (i.e., level1key, tmp_level1key)

1 19-byte field for the record ID assigned by Customer Key Manager (i.e., record _id)

1 1-byte field for the record status value (i.e., record_status) 1 1-byte field for the record source value (i.e., record_source) 1 1-byte field for the new/old indicator value (i.e., new_old) Any field that is defined by the MAST_RECD_SEQ_FIELD master

parameter that is not included in the above fields.The following fields must be included in the Trillium file DDL. Add before the ORG_RECORD section.

1 19-byte field to contain the “super-set link” value 1 19-byte field to contain the “current_level1_match_link” value

Creating Other DDLs Used by Customer Key ManagerCustomer Key Manager has the ability to use other DDLs in the process for efficiency. These additional DDLs will be built with the required fields necessary to execute the module:


Batch Reference Match for Customer Key Manager 3-7

The DDL defined by the master parameter DDL_CHANGED_SETS_RECORD only needs to contain the field(s) defined by the master parameter MAST_SET_SEQ_FIELDS. A DDL named change.ddl is delivered as part of the sample project.

The DDL defined by the local parameter MP_INP_DDL of the CRMATMST module only needs to contain the fields defined by the master parameter MAST_RECD_SEQ_FIELDS. A DDL named mastseq.ddl is delivered as part of the sample project.

Batch Reference Match for Customer Key ManagerCustomer Key Manager applications use a specific batch reference match program. This program, CFMATCH, was written for use in the these applications. This program can perform a multi-window key match in one execution of the program. This program must be used to perform matching atlevel1, the highest entity.If there were separate parameter files used for personal and business field/pattern matching during the initial build of the database, then these parameter files must be combined for use by CFMATCH.

Creation ProcessA sample creation application is delivered with the software. You can use this as a base to build your own creation application.

Update ProcessA sample update application is delivered with the software. You can use this as a base to build your own update application.For matching at the highest entity, level1, an additional window key is required.This window key must be last cycle’s “level1key” and every record with the same value must be a match. The links generated in this match are used to build the “super-set link” which is required for key continuity/key persistency.

Getting Started

CHAPTER 4 Customer Key Manager Overview

Customer Key Manager is the process for maintaining a Master File of customer information. It uses key based sequential file processing methods that are designed for managing high volume record and field changes. It maintains permanent record identifiers which enable it to determine record/field changes for sorted files. These record identifiers also manage multiple views of dynamic hierarchical matched relationships.

Customer Key Manager Overview

4-2 Customer Key Manager System Functions

Customer Key Manager System FunctionsCustomer Key Manager executes the following functions:

Compares the previous cycle’s file keys with the current cycle’s file keys to identify records as new, ongoing, or closed.

Compares designated fields of ongoing records for field changes between previous and current data files.

Assigns a permanent record identifier. Assigns multiple views of dynamic relationship keys. Constructs final Master File in designated format. Uses a Data Dictionary (DDL) to simplify file format and process

changes.


Customer Key Manager Flow Chart (Creation) 4-3

Customer Key Manager Flow Chart (Creation)


4-4 Customer Key Manager Flow Chart (Update)

Customer Key Manager Flow Chart (Update)


Customer Key Manager Step Definitions 4-5

Customer Key Manager Step DefinitionsCustomer Key Manager has two modules: Change Process (CP) and Key Management Process (KP). All Customer Key Manager steps can be configured by the user via parameter files. It may not be necessary to run some steps based on your application requirements.1. Change Process (CP)

Identify Changes Field Continuity Create Master File for matching Master File Updates (Pass 1) Commonizing Data Fields; Selecting Prime Record Master File Update (Pass 2)

2. Key Management Process (KP) Key Assignment Key Management


4-6 Change Process (CP)

Change Process (CP)The Change Process detects changes in fields, identifies new, ongoing, and closed records, and updates the Master File.

CRCRTINICreate the Customer Initialization File (one time creation process only).

CRCKCHNGDetect field changes in ongoing records and to identify new/closed records.

SortThe Field Changes File is sorted in the Master File sequence by means of a system sort utility.

SortThe Record File is sorted in Master File sequence by means of a system sort utility.

CRMATMSTCreate the reference file for matching.

CRMSTUP1Update field changes, add new records, and delete closed records. Detect additions, deletions, or level key changes in the Level1 key set if IP/MP Process was performed.


Sort 4-7

SortThe Changed Set File is sorted in Master File sequence by means of a system sort utility.

CRPRCHNGProcess changed sets, assign prime records for Level1 and optionally create common data for the Level1.

SortThe Processed Changed Set File is sorted in Master File sequence by means of a system sort utility.

CRMSTUP2Merge files from CRMSTUP1 and from CRPRCHNG to create final CKM Master File. This Master File is used for the next cycle’s run of CRCKCHNG.


4-8 Key Management Process (KP)

Key Management Process (KP)The Key Management Process assigns keys and manages continuity of keys at hierarchical matching levels.

SortSort the output file from the IP/MP processing in “super_set” link, current cycle level1 link sequence by means of a system sort utility (see page 25 for the definition of “super_set” link).

CRCLSGRDManages the ability of a Customer Key Manager “closed account” to “follow” a moving open account.

Example of Closed Account Processing

Previous CycleJohn Smith 10 Main St Billerica, MA 01821 Level 1 key=25 openMary Smith 10 Main St Billerica, MA 01821 Level 1 key=25 closed

Current UpdateJohn moves to 17 Elm Rd Billerica, MA 01821

The CRCLSGRD program will have Mary’s “closed” account follow John’s moving account by linking the closed account to the open account. This program will prevent John from receiving a new Level1 key based on the rules of Key Continuity, thus allowing both records to keep the Level1 key of 25.

SortSort the output file from the IP/MP processing or the output file of CRCLSGRD process, if executed in “super_set” link, current cycle level1 link, previous cycle level1 key, current cycle level2 link, previous cycle level2 key, etc., sequence by means of a system sort utility.


CRKEYGRD 4-9

CRKEYGRDManages the continuity of level keys from cycle to cycle. Assigns level keys to sets that need new level keys.

Sort The Output File is sorted in Master File sequence by means of a system sort utility.

SortThe Set Changes File is sorted in Master Set sequence by means of a system sort utility.

Level Key ContinuityWithin the Key Management Process of Customer Key Manager, the functionality exists to keep the level keys consistent over time, based on a set of pre-defined rules. These rules determine which records will be allowed to retain their level keys from the previous cycle.Over time, relationships will combine, move, and split. Having the ability to manage the level keys is critical to the integrity of the database.

Super-Set LinkThis “super-set” link links a record to all records in its current relationship along with all records from its previous relationship.

Rules for Level Key ContinuityThe following pre-defined set of rules determine level key continuity:1. Every record has its entire previous and current relationship in the window.

The “super-set” link is the link that accomplishes this.


4-10 Examples of Level Key Continuity

2. The lowest level key from a “non-change” record will survive for a particular level. A “nonchange” record is defined as a record that has the value of ‘M’ in the field defined by the RECORD_SOURCE_FIELD_NAME parameter. Once assigned to a level, this level key will not be used again.

3. The lowest level key from a “change” record will survive for a particular level. A “change” record is defined as a record that has the value of ‘C’ in the field defined by the RECORD_SOURCE_FIELD_NAME parameter. Once assigned to a level, this level key will not be used again.

4. New level keys are assigned to a level if all previous level keys have been assigned to another record or if all records in the level are new.Level key continuity begins at the highest level key, Level1, and proceeds to the lowest level key until all level keys have been processed within the “super_set” link.

Examples of Level Key ContinuityA sample consumer household illustrates the concept of key continuity.

Example 1

Previous Cycle:John Smith 10 Main St Billerica, MA 01821 Level1 Key = 25Mary Smith 10 Main St Billerica, MA 01821 Level1 Key = 25

Current Update: Mary moves to 17 Elm Rd Billerica, MA 01821 John retains the Level1 key of 25 since the “non-change” record has the

highest priority to keep the key. Mary either receives a new Level1 key if she did not match into an

existing set or receives the Level1 key from the set she matched into.

Example 2

Previous Cycle:John Smith 10 Main St Billerica, MA 01821 Level1 Key = 25Mary Smith 20 Elm Road Billerica, MA 01821 Level1 Key = 116


Examples of Level Key Continuity 4-11

Current Update: Both records move to 30 River St Billerica, MA 01821 The Level1 key of 25 survives since it is the lowest level key from a

“change” record. If John had a previous relationship at 30 River St., then both records

that moved would acquire the Level1 key that existed for John at 30 River St.


CHAPTER 5 Parameter Files for Customer Key Manager Modules

The Customer Key Manager modules use a number of parameter files for efficiency and flexibility. These parameter files include the following.

Master Parameter FileA parameter file used in all phases of Customer Key Manager to identify files, records, fields, and field values. Some parameters are unique to certain phases of the process and others are common to the whole process. This file contains both required and optional parameters.

CRCRTINIA parameter file used only in the Create Initialization phase of the Customer Key Manager, containing parameters unique to this process.

CRCKCHNGA parameter file used only in the Check Change phase of the Customer Key Manager, containing parameters unique to this process.

Parameter Files for Customer Key Manager Modules

5-2 CRMATMST

CRMATMSTA parameter file used only in the Create Matching Master File phase of the Customer Key Manager, containing parameters unique to this process.

CRMSTUP1A parameter file used only in the First Master Update phase of the Customer Key Manager, containing parameters unique to this process.

CRPRCHNGA parameter file used only in the Process Master Change phase of the Customer Key Manager, containing parameters unique to this process.

CRMSTUP2A parameter file used only in the Second Master Update phase of the Customer Key Manager, containing parameters unique to this process.

CRCLSGRDA parameter file used only in the Closed Account Management phase of Customer Key Manager containing parameters unique to this process.

CRKEYGRDA parameter file used only in the Key Management phase of Customer Key Manager containing parameters unique to this process.

ParametersParameters are optional unless otherwise specified. All parameters are case insensitive.


Parameters 5-3

Table 5.1 Master Parameter File for Customer Key Manager Process (CP) and Key Management Process (KP) Modules

Name Parameter Type and Meaning Status

CHECK_FIELDS_NNN Text, list of fields to check for changes in CRCKCHNG program with a Y/N flag to optionally send record to MP file forName/Address processing.See Notes G, H, and R.

Required

CLIENT_MNEMONIC Text, user-defined abbreviation for client

CLIENT_NAME Text, user-defined name of client

CLIENT_NUMBER Text, user-defined client identification number (maximum length of 4 characters)

Required

CLOSED_ACCT_DATE_FIELD Text, field name, to store an 8 byte alphanumeric character value,followed by date option. This field will be updated by CRMSTUP1 whenever a record has been “closed” by the CRCKCHNG program.See Notes E and L.*This field is required if “closed” accounts will be purged from the CKM Master File by the CRMSTUP1 module.

*

COLLATING_SEQUENCE Text, indicates the collating sequence to use ifCREATE_COMMON_DATA and/or SELECT_PRIME_RECORDparameters are set to “Yes.” Valid options are “ASCII” or“EBCDIC.”*Required if CREATE_COMMON_DATA orSELECT_PRIME_RECORD parameter is set to “Yes.”

*


5-4 Parameters

CREATE_COMMON_DATA Text, “Yes” indicates that common data will be created by the CRPRCHNG program. The default is “No.”

CREATE_COMMON_FIELDS Text, field names and rules that are used by the CRPRCHNG program to create common data.See Note K.*Required if CREATE_COMMON_DATA parameter is set to“Yes.”

*

CURR_CYCLE_DATE Text, date value in the format of MM/DD/YYYY orDD/MM/YYYY to be used by the system.See Notes A and C.

Required

DATA_VALIDATION Text, “Yes” will validate data within the CKM System. The data in the field is compared to the field definition in the DDL. If the data is not valid, the program will abort. Default is “No.”

DATE_FORMAT Text, format of date parameters throughout Customer Key Manager.If set to ‘E’, European, CURR_CYCLE_DATE parametermust have date format of DD/MM/YYYY.The default is blank. Date formats must be MM/DD/YYYY.See Note C.

Table 5.1 Master Parameter File for Customer Key Manager Process (CP) and Key Management Process (KP) Modules (Continued)



Parameters 5-5

DDL_CHANGED_SETS_RECORD Text, DDL defining record format and record name of the changed sets file created by CRKEYGRD program and read by CRMSTUP1 program.This DDL only needs to contain fields defined by theMAST_SET_SEQ_FIELDS parameter.*Required if PROCESSING_MP parameter is set to “Yes.”See Note D.

*

DDL_KEYLINKS_RECORD Text, DDL record format and record name of the key links file createdby CRMSTUP2. The fields defined by theMAST_RECID_SEQ_FIELDS parameter must be part of this DDL.See Note D.

DDL_MAST_RECORD Text, DDL defining CKM master record format and record name.See Note D.

Required

DDL_MP_MAST_RECORD Text, DDL defining record format and record name of MP file created by CRCKCHNG program for use in Name/Address processing,CRCLSGRD, CRKEYGRD, and CRMSTUP1 programs.See Notes D, M, and N.*Required if PROCESSING_MP parameters is set to “Yes.”

*

DDL_PREV_CONV_RECORD Text, DDL defining record format and record name of previous cycle’s input file used by CRCKCHNG program.See Note P.

Required




5-6 Parameters

INI_DDNAME Text, file name of the Client Initialization File created by CRCRTINI program. This file is used by most Customer Key Manager programs and should be backed up after each application execution.

Required

KEY_FIELD_NAMES Text, list of field names of level keys and field name of members within that level (level key fields must be 19 bytes).See Note J.

Required

MAST_DATE_LAST_TOUCHED_NAME

Text, field name to store an 8 byte alphanumeric character value, followed by date option. This field will be updated by CRMSTUP1 program whenever any field on a record has been updated.See Notes E and L.

MAST_FILE_NAME Text, field name that contains the file source identifier. The value in this field must be the same for every record in a particular input source file. The value in this field is the first position parameter of the VALID_FILES parameter. The maximum length of this field is 10 bytes.

Required

MAST_RECD_SEQ_FIELDS Text, list of fields that make up the sort order of the CKM Master File.See Note S.

Required

MAST_SET_SEQ_FIELDS Text, list of fields that make up the sort order of the Level1 entity within the CKM Master File. Must be the high order sequence in the MAST_RECD_SEQ_FIELDS parameter.

Required

MAX_OUT_FILE_SIZE Numeric, maximum number of bytes to write to Output Files (UNIX and Windows platforms only)See Note O.




Parameters 5-7

MP_CHANGE_FIELD_NAMES Text, list of fields to update on the CKM Master File from the Name/Address processed file which includes CRCLSGRD and CRKEYGRD processing.This updating is accomplished by the CRMSTUP1 program.See Note R.*Required if the PROCESSING_MP parameter is set to “Yes.”

*

MP_TMP_KEY_FIELD_NAMES Text, list of 19 byte temporary keys to be updated by CRKEYGRD program. These fields contain last cycle’s value of each of the level keys on the CKM Master File.See Note I.*Required if the PROCESSING_MP parameter is set to “Yes.”

*

NEW_OLD_FIELD_NAME Text, field name to store a one byte alphanumeric character value.This field is set by the CRCKCHNG program and used by the CRKEYGRD program.Valid values are “N” and “O” where “N” = new record and “O” = ongoing record.

Required

NON_PRIME_VALUE Text, a one byte alphanumeric character value that is stored inPRIME_FIELD_NAME parameter to identify a non-prime Level1 record.*Required if SELECT_PRIME_RECORD is set to “Yes.”

*




5-8 Parameters

PRIME_FIELD_NAME Text, field name to store a one byte alphanumeric character value, that identifies whether or not a record is flagged as the prime or non-prime record at Level1. This field is populated by CRPRCHNG program with values defined by the PRIME_VALUES and NON_PRIME_VALUE parameters.*Required if SELECT_PRIME_RECORD is set to “Yes.”

*

PRIME_VALUES Text, one byte alphanumeric character that is stored in PRIME_FIELD_NAME parameter to identify a prime Level1record.*Required if SELECT_PRIME_RECORD is set to “Yes.”

*

PROCESSING_MP Text, set to “Yes” if Name/Address processing is to be performed on any new or changed records identified by the CRCKCHNG program.The default is “No.”

Required

PROJECT_NUMBER Text, user-defined project number.

RECID_DATE Text, option to set the YYYYDDD portion of the field defined by the RECID_FIELD_NAME parameter. Valid options areCYCLE_DATE or RUN_DATE. CYCLE_DATE converts the value of the CURR_CYCLE_DATE parameter value toYYYYDDD. RUN_DATE converts the value of the system date toYYYYDDD.The default is CYCLE_DATE.




Parameters 5-9

RECID_FIELD_NAME Text, field name of unique record identifier generated by CRCKCHNG. The field must be 19 bytes.See Notes Q and S.

Required

RECORD_SOURCE_FIELD_NAME Text, field name for storing a one byte alphanumeric character value that is generated by CRCKCHNG, CRMATMST, and CRMSTUP2 programs. This field is used by the CRKEYGRD program.Valid values are “C” and “M” where “C” = changed record and“M” = non-changed record.

Required

REFMAT_FLAG_FIELD_NAME Text, field name for storing a one byte alphanumeric character value that is generated and used in the Name/Address processing stream.Use only if the Trillium program, CFREFMAT, will be used during the update processing application.Valid values are “P” and blank.This field is used in the MP process for sorting purposes in determiningwhich record to keep for further processing.

REOPENED_ACCT_DATE_FIELD Text, field name for storing an 8 byte alphanumeric character value, followed by date option. This field will be updated by the CRMSTUP1 program whenever a record has been “reopened” by the CRCKCHNG program.See Notes E and L.

REPREPROCESS_FIELD_NAME Text, field name for storing a one byte alphanumeric character value to be used by the CRCKCHNG module to force records into the Name/Address processing file.




5-10 Parameters

SELECT_PRIME_FIELDS Text, fields used to select the prime recordSee Note B.*required if SELECT_PRIME_RECORD is set to “Yes.”

*

SELECT_PRIME_RECORD Text, “Yes” indicates that prime record selection at Level1 will be performed by the CRPRCHNG program.The default is “No.”

RECID_FIELD_NAME Text, field name of unique record identifier generated by CRCKCHNG. The field must be 19 bytes.See Notes Q and S.

Required

RECORD_SOURCE_FIELD_NAME Text, field name for storing a one byte alphanumeric character value that is generated by CRCKCHNG, CRMATMST, and CRMSTUP2 programs. This field is used by the CRKEYGRD program.Valid values are “C” and “M” where “C” = changed record and “M” = non-changed record.

Required

REFMAT_FLAG_FIELD_NAME Text, field name for storing a one byte alphanumeric character value that is generated and used in the Name/Address processing stream.Use only if the Trillium program, CFREFMAT, will be used during the update processing application.Valid values are “P” and blank.This field is used in the MP process for sorting purposes in determining which record to keep for further processing.




Parameters 5-11

REOPENED_ACCT_DATE_FIELD Text, field name for storing an 8 byte alphanumeric character value, followed by date option. This field will be updated by the CRMSTUP1 program whenever a record has been “reopened” by the CRCKCHNG program.See Notes E and L.

REPREPROCESS_FIELD_NAME Text, field name for storing a one byte alphanumeric character value to be used by the CRCKCHNG module to force records into the Name/Address processing file.

SELECT_PRIME_FIELDS Text, fields used to select the prime recordSee Note B.*required if SELECT_PRIME_RECORD is set to “Yes.”

*

SELECT_PRIME_RECORD Text, “Yes” indicates that prime record selection at Level1 will be performed by the CRPRCHNG program.The default is “No.”

SEQ_FIELDS_NNN Text, list of fields that determine the sort sequence of the input files to CRCKCHNG.See Note H.

Required

STATUS_FIELD_NAME Text, field name for storing a one byte alphanumeric character value of the record status generated by the CRMSTUP1 program.

Required

STATUS_VALUE_CLOSED Text, value to store in STATUS_FIELD_NAME parameter whenCRMSTUP1 has identified a “closed” record

Required




5-12 Parameters

STATUS_VALUE_NEW Text, value to store in STATUS_FIELD_NAME parameter whenCRMSTUP1 has identified a “new” record.

Required

STATUS_VALUE_OLD Text, value to store in STATUS_FIELD_NAME parameter whenCRMSTUP1 has identified an “ongoing” record.

Required

STATUS_VALUE_REOPENED Text, value to store in STATUS_FIELD_NAME parameter whenCRMSTUP1 has identified a “re-opened” record.

Required

SUPER_SET_FIELD_NAME Text, field name for storing the alphanumeric character value of the“super-set” link identified by the Name/Address processing. Thisfield is used by the CRCLSGRD and CRKEYGRD programs.*Required if MP_PROCESSING parameter is set to “Yes.”

*

USER_FIELD_NAME1USER_FIELD_NAME2USER_FIELD_NAME3USER_FIELD_NAME4USER_FIELD_NAME5

Text, field name to store a one-byte alphanumeric character that is defined by the USER_FIELD_VALUE1-5 parameter. This field is populated by the CRMSTUP2 module and optionally byCRMSTUP1.

USER_FIELD_VALUE1USER_FIELD_VALUE2USER_FIELD_VALUE3USER_FIELD_VALUE4USER_FIELD_VALUE5

Text, one-byte alphanumeric character to store in the field defined by USER_FIELD_NAME1-5 parameter. Required if USER_FIELD_NAME1 is specified.

VALID_FILES Text, list of valid input source files to the CKM system.See Note F

Required




Notes 5-13

Notes

Note AThe date value defined by the CURR_CYCLE_DATE parameter is used by the following:

CRCKCHNG To generate the Julian date portion of the unique record identifier created by this program for all new records.

CRKEYGRD To generate the Julian date portion of the CKM Level keys created by this process for all new level keys.

CRMSTUP1 To generate the value of the following optional fields if the date option of CYCLE_DATE is used for these parameters:

CLOSED_ACCT_DATE_FIELD MAST_DATE_LAST_TOUCHED_NAME REOPENED_ACCT_DATE_FIELD

Note BFormat of this parameter is: field name, rule (see Table 2).ex. - select_prime_fields “primary_type_rank”,“LO”

“balance”,”HI”

For the Japanese version, the fields can only contain data defined by an ASCII data type.

Note CIf DATE_FORMAT parameter is set to ‘E’, the following parameters must be in the format of DD/MM/YYYY:

CURR_CYCLE_DATE CONV_CYCLE_DATE; if used in CRCKCHNG’s local parameter


5-14 Note D

RUN_CYCLE_DATE; if used in CRKEYGRD’s local parameter

Note DFormat of this parameter is: DDL file name, RECORD_NAME in DDL

Note EFormat of this parameter is “FIELD_NAME”, “DATE_OPTION”. The field_name cannot be defined as dates within the DDL. The data in this field is stored in the format: YYYYMMDD. See Note L for date option.ex. - reopened_acct_date_field “reopen_date”,”cycle_date”

Note FFormat of this parameter is:FILE_NAME - maximum of 10 bytes. Value must be in the field defined by theMAST_FILE_NAME parameter.FILE_NUMBER - valid values: 001 - 999path and name of DDLrecord name in DDLnumber of days to retain closed records - valid values: 0 - 99999ex. - valid_files “DDA”,”001”,”../dict/dda.ddl”,”DDACONV”,720

“ILC”,”002”,”../dict/ilc.ddl”,”ILCCONV”,365

Note GFormat of this parameter is: “FIELD_TO_CHECK”, “MP_FLAG”ex. - check_fields_001 “reporting_unit”,”N”

“oraddrl1”,“Y”“oraddrl2”,“Y”


Note H 5-15

Note HNNN refers to the FILE_NUMBER in the VALID_FILES parameter:ex. - seq_fields_001 “account_number”Valid values for NNN are 001 - 999.

Note IFormat of this parameter is: Level Key field, temporary Level key field.ex. - mp_tmp_key_field_names “level1key”,”tmp_level1key”

“level2key”,”tmp_level2key”

Note JFormat of this parameter is: field name of Level key, field name of # of members (Level1 key fieldname must be first entry in the list).ex. - key_field_names “level1key”,“members_level1”

“level2key”,“members_level2”

Note KFormat of this parameter is: “DESTINATION_FIELD”, “SOURCE_FIELD”, rule (see Table 2).ex. - create_common_fields “common_first,pr_first_01,PRIME”

“common_last,pr_last_01,PRIME”The destination field and source field must be the same shape and format.For the Japanese version, the fields can only contain data defined by an ASCII data type.

Note LThe Date option has two valid entries, RUN_DATE or CYCLE_DATE.RUN_DATE = current system date stored in format: YYYYMMDD.CYCLE_DATE = CURR_CYCLE_DATE parameter value stored in format:


5-16 Note M

YYYYMMDD.ex. - reopened_acct_date_field “reopen_date”,”cycle_date”

Note MIMPORTANT:The following fields must be present on the file as defined by the DDL_MP_MAST_RECORD parameter located in the Client Master parameter.1. Fields defined by the following parameters located in the Client Master

parameter: MAST_RECD_SEQ_FIELDS RECID_FIELD_NAME CHECK_FIELD_NNN that have the MP indicator set to “Y” RECORD_SOURCE_FIELD_NAME NEW_OLD_FIELD_NAME SUPER_SET_FIELD_NAME MP_TMP_KEY_FIELD_NAMES STATUS_FIELD_NAME

2. Fields that are populated during Parsing, Geocoding, Window Key Genera-tion, and Matching process.

3. LEVEL1_LINK_THIS_MATCH field, to be used in MP processing. This field should be 19 bytes in length (if using Trillium Software System).

4. Any fields that will be used in matching. Fields used in matching comparison routines, fields used in generating the window keys, or fields used in match-ing commonization, if performed.

Note NIf the Trillium Software System is used to perform the MP processing then the fields defined by the following parameters, in the client master parameter, must be part of the ORG_RECORD definition of the file as defined by the DDL_MP_MAST_RECORD parameter.

MAST_RECD_SEQ_FIELDS


Note O 5-17

STATUS_FIELD_NAME RECID_FIELD_NAME MP_TMP_KEY_FIELD_NAMES RECORD_SOURCE_FIELD_NAME NEW_OLD_FIELD_NAME

Note OWhen this parameter is used, the Output Files will have the extension of .001, .002, .003, etc., with each file containing the number of bytes specified until the total Output File is written.

Note PThe following fields must be present on the file defined by the DDL_PREV_CONV_RECORD parameter located in the Client Master parameter:

MAST_RECD_SEQ_FIELDS STATUS_FIELD_NAME MAST_FILE_NAME SEQ_FIELDS (for all input files) CHECK_FIELDS (for all input files) REPREPROCESS_FIELD_NAME (if used)

Note QThe RECID_FIELD_NAME field is assigned for all new records during the execution of CRCKCHNG. The format is: YYYYDDDFFFNNNNNNNNNwhere:

YYYYDDD is based on CURR_CYCLE_DATE value (default). FFF is the second positional value of the VALID_FILES parameter

(examples 001, 002). NNNNNNNNN is a sequential number, beginning at 1.


5-18 Note R

Note RFields that are listed under the CHECK_FIELDS_NNN parameter cannot be included under the MP_CHANGE_FIELD_NAMES parameter.Fields listed for the MP_CHANGE_FIELD_NAME parameter must be the same shape and same length on the DDLs defined by the parameters DDL_MAST_RECORD and DDL_MP_MAST_RECORD.

Note SThe field defined by RECID_FIELD_NAME parameter must be one of the fields that make up the MAST_RECD_SEQ_FIELDS parameter.


Rules 5-19

RulesThe following rules apply to the formats of the SELECT_PRIME_FIELDS andCREATE_COMMON_FIELDS parameters.

Table 5.2 Master Parameter File for Customer Key Manager Process (CP) and Key Management Process (KP) Modules

Name Parameter Type and Meaning

LO lowest

HI highest

LO_CH lowest character

HI_CH highest character

LS least frequent (for CREATE_COMMON_DATA only)

LS_NB least frequent, ignore blanks (for CREATE_COMMON_DATA only)

LS_NZ least frequent, ignore zeroes (for CREATE_COMMON_DATA only)

LS_NBZ least frequent, ignore blanks and zeros (for CREATE_COMMON_DATA only)

MS most frequent (for CREATE_COMMON_DATA only)

MS_NB most frequent, ignore blanks (for CREATE_COMMON_DATA only)

MS_NZ most frequent, ignore zeroes (for CREATE_COMMON_DATA only)

MS_NBZ most frequent, ignore blanks and zeros (for CREATE_COMMON_DATA only)

PRIME take from prime record (for CREATE_COMMON_DATA only)


5-20 Sample Master Parameter File

Sample Master Parameter File

The following is a sample master parameter file for Customer Key Manager:******************************************************** sample client parm file********************************************************client_name “Trillium”client_mnemonic “TLM”client_number “9999”project_number “00001”curr_cycle_date “01/31/1998”

ini_ddname “../parms/cuini”

processing_mp “yes”

repreprocess_field_name “repreprocess_flag”

recid_field_name “record_id”key_field_names “level1key”, “members_level1”

“level2key”, “members_level2”

status_field_name “record_status”status_value_closed “C”status_value_old “O”status_value_new “N”status_value_reopened “R”

record_source_field_name “record_source”new_old_field_name “new_old”

super_set_field_name “super_set_link”

mast_file_name “primary_type”


Sample Master Parameter File 5-21

collating_sequence “ascii”select_prime_record “yes”select_prime_fields “primary_type_rank”,“LO”

“balance”,”HI”

prime_field_name “prime_flag”prime_values “Y”non_prime_value “N”

create_common_data “YES”create_common_fields “common_first,pr_first_01,PRIME”

“common_last,pr_last_01,PRIME”

closed_acct_date_field “close_date”,”cycle_date”reopened_acct_date_field “reopen_date”,”cycle_date”

mast_date_last_touched_name “last_touched_date”,”run_date”mast_recd_seq_fields “level1key”

“level2key”“record_id”

mast_set_seq_fields “level1key”

valid_files “DDA”,”001”,”../dict/dda.ddl”,”DDACONV”,720“ILC”,”002”,”../dict/ilc.ddl”,”ILCCONV”,365

check_fields_001 “reporting_unit”,”N”“balance”,”N”“oraddrl1”,”Y”“oraddrl2”,”Y”“oraddrl3”,”Y”“oraddrl4”,”Y”“oraddrl5”,”Y”“oraddrl6”,”Y”“oraddrl7”,”Y”

check_fields_002 “reporting_unit”,”N”“balance”,”N”


5-22 Sample Master Parameter File

“oraddrl1”,”Y”“oraddrl2”,”Y”“oraddrl3”,”Y”“oraddrl4”,”Y”“oraddrl5”,”Y”

seq_fields_001 “account_number”

seq_fields_002 “account_number”

mp_tmp_key_field_names “level1key”,”tmp_level1key”“level2key”,”tmp_level2key”

mp_change_field_names “level1key”“level2key”“pr_zip4_sect”“output_US_census_geog”“prepos_section”“pr_name_sect_01”

ddl_mast_record “../dict/kmmaster.ddl”, “MASTREC”

ddl_mp_mast_record “../dict/trillium.ddl”,“MPREC”

ddl_changed_sets_record “../dict/change.ddl”,“CHNGREC”

ddl_prev_conv_record “../dict/kmmaster.ddl”,“MASTREC”


Functional Overview of Customer Key Manager Modules 5-23

Functional Overview of Customer Key Manager ModulesThe following section provides a brief functional overview of each module of Customer Key Manager. Please refer to the modules documentation that follows for more in depth explanation.

CRCRTINI (Create Initialization File)Creates the Client Initialization File used throughout Customer Key Manager.

CRCKCHNG (Check for Changes) Identifies new records and writes these records to the “RCD” file and

the “MP” file. Identifies changes in fields between a current file’s record and a

previous file’s record. Writes any field changes to the “FLD” file and writes the record, if necessary, to the “MP” file.

Identifies “closed” records and writes a system transaction to the “FLD” file.

Identifies “reopened” records and writes a system transaction to the “FLD” file.

Verifies that the input file has a unique key and is sorted by this key. Assigns a permanent record identifier, RECORD_ID, to all new records. Verifies that the input file being processed is defined as a valid file in

the master parameter file. Optionally writes records to the “MP” file even though they are not new

records or field change records that have been defined to generate an “MP” record. This is known as “repreprocess.”


5-24 CRMATMST (Create Matching Master File)

CRMATMST (Create Matching Master File) Identifies records on the “MP” file that exist on the previous cycle’s CKM

Master File and deletes these records when creating the matching Master File.

Optionally identifies Level1 key sets on the previous cycle’s CKM Master File with a record on the “MP” file and writes these Level1 key sets to the “re-match” file instead of the reference file for matching.

Identifies newly “closed” records and changes the status to “closed” on the output files.

CRCLSGRD (Closed Record Processing) - Optional ModulePrevents “closed” record(s) from separating from their Level1 key entity if all non-closed record(s) in the entity no longer have a matching link to the “closed” record(s).

CRKEYGRD (Key Continuity, Key Persistency) Determines key survivorship for each level of matching. Assigns new level keys when necessary.

CRMSTUP1 (Master Update 1) Adds new records to the CKM Master File. Updates field changes to the CKM Master File. Purges expired “closed” records from the CKM Master File as defined

per input source in the Master Parameter File. Sets the record status of each record. Applies field moves from the “MP” file to the CKM Master file. Applies level key changes from the “MP” file to the CKM Master File.


CRPRCHNG (Process Set Changes) - Optional Module 5-25

Determines any changes in the Level1 key set and writes those sets to the set changes file.

Sets CLOSED_ACCT_DATE_FIELD for newly “closed” records. Sets REOPEN_ACCT_DATE_FIELD for newly “reopened” records. Sets MAST_DATE_LAST_TOUCHED_NAME for any record which is new,

had a field change in the “FLD” file, had a system transaction in the “FLD” file, or had its record in the “MP” file as input to this module.

CRPRCHNG (Process Set Changes) - Optional Module

Assigns primary record for Level1 key entity. Assigns common data for Level1 key entity. Calculates the number of records per Level keys.

CRMSTUP2 (Master Update 2) Creates the final CKM Master File for use in next cycle’s process. Initializes fields for next cycle’s process. Creates up to three optional output files for use in subsequent non-CKM

processing.


CHAPTER 6 The Change Process (CP)

The following sections describe the programs used in the Change Process, including the parameters of each program and the commands for invoking them on your platform. Sample parameter files and JCLs are also provided for each program.

The Change Process (CP)

6-2 CRCRTINI

CRCRTINI

PurposeProgram for creating the Customer Initialization File. This program should only be executed during the creation phase.

Programcrcrtini

All entries in the master parameter file are validated and where necessary are cross-checked with other entries.The Customer Initialization File is an important file that is used by every program. After running CRCRTINI, the Customer Initialization File will not require any manual maintenance.Some of the functions of the Customer Initialization File include:

Keeps track of the last value assigned to the unique record identifier field for each input file.

Keeps track of the last Julian date used by CRKEYGRD in assigning the new level keys.

Determines, validates, and stores the length of the sequence fields for the input files and for the Customer Key Manager Master File.

Determines, validates, and stores the logical record length of the field changes file created by CRCKCHNG.


Parameters 6-3

Determines, validates, and stores the logical record length of the cross reference file optionally created by CRMSTUP2.

Validates and stores the length of the longest field on the input file. Stores the current cycle date. Stores the current run date.

ParametersAll parameter values are optional unless otherwise specified.

Program Executioncrcrtini

UNIX and Windows PlatformsTo execute the CRCRTINI on UNIX and Windows platforms, use the command:crcrtini -parmfile parm_file_name -parmecho echo_file_namewhere:crcrtini is the program, parm_file_name is the program parameter file, and echo_file_name is the listing file of the processed program parameter file.The -parmecho echo_file_name is optional.

Table 6.1 Parameters to Control CRCRTINI Program

Error Corrective Action

CLIENT_PARMFILE name of master parameter file Required

CLIENT_PARMECHO name of the listing file of the processed client_parmfile


6-4 Sample Parameter File for CRCRTINI

Sample Parameter File for CRCRTINIBelow is a sample parameter file for running the CRCRTINI program:************************************************************** sample parm file for CRCRTINI*************************************************************client_parmfile “../parms/cumaster”client_parmecho

Sample JCL for CRCRTINIBelow is a sample JCL (Job Control Language) used to run CRCRTINI://*************************************************************//*//* IEB COPY DUMMY INI FILE TO INI FILE//*//*************************************************************//IEBGENER EXEC PGM=IEBGENER//SYSPRINT DD SYSOUT=A//SYSUT1 DD DISP=OLD,// DSN=&PROJPREF.DATA.CUINIDUM//SYSTU2 DD DISP=(NEW,CATLG,KEEP),// SPACE=(TRK,(10,5)),// VOL=SER=&VOL,UNIT=&UNIT,// DSN=&PROJPREF.CUINI//SYSIN DD DUMMY/*//IEBGENER EXEC PGM=IEBGENER//SYSPRINT DD SYSOUT=A//SYSUT1 DD DISP=OLD,// DSN=&PROJPREF.DATA.CUINIDUM//SYSTU2 DD DISP=(NEW,CATLG,KEEP),// SPACE=(TRK,(10,5)),// VOL=SER=&VOL,UNIT=&UNIT,// DSN=&PROJPREF.CUINIO//SYSIN DD DUMMY/*


Sample Parameter File for CRCRTINI 6-5

//************************************************************//* CRCRTINI - CREATE INI FILE//************************************************************//CRCRTINI EXEC PGM=CRCRTINI,PARM= -PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//SYSPRINT DD SYSOUT=*//SYSTERM DD SYSOUT=*//PE DD SYSOUT=*//PF DD ************************************************************** CRCRTINI PARMS************************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHO//*//* CLIENT PARM FILE (SEE TABLE 1)//*//CUMASTER DD DISP=SHR,// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//* INPUT FILE//*//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//*//* OUTPUT FILE//*//CUINIO DD DISP=SHR,// DSN=&PROJPREF.CUINIO


6-6 CRCKCHNG

CRCKCHNG

PurposeTo compare a current cycle input file to the previous cycle’s CKM Master File. When a change is detected, create transactions for Master File updating and optionally for Identification and Matching processing.

Programcrckchng

All entries in the master parameter file are validated and where necessary are cross-checked with other entries:

For each input file, there must be a unique constant sequence key and each input file must be sorted by this key.

For each VALID_FILES entry, there has to be a corresponding CHECK_FIELDS_NNN parameter and SEQ_FIELDS_NNN parameter.

The current cycle input file and the previous cycle’s CKM Master File are compared to each other based upon the fields specified by the SEQ_FIELD_NNN parameter. Both input files must be in sequence by these fields.

If a record exists on the current input file but does not exist on the previous input file, this is considered an CKM “new” record.


Program 6-7

If a record exists on the previous input file but does not exist on the current input file, this is considered an CKM "closed" record.

If a record exists on both input files, this will be considered either an CKM "on-going" record or an CKM "re-opened" record, depending on the record's status on the previous input file.• If the record's status on the previous input file is not CKM "closed",

then the record is considered an CKM "on-going" record.• – If the record's status on the previous input file is CKM "closed",

then the record is considered an CKM "re-opened" record.For new records, CRCKCHNG does the following:

Assigns to the record a permanent record identifier called “RECORD_ID.” This field is defined by the parameter RECID_FIELD_NAME.

The format of the "record_id" is as follows:• YYYYDDD Julian date based on the CURR_CYCLE_DATE parameter.

(default)• FFF Value of the 2nd position of the VALID_FILES parameter for the

input file being processed.• NNNNNNNNN Sequential number beginning at 1. If on subsequent

executions of CRCKCHNG in which the Julian date portion does not change, this sequential number begins from where it left off on the previous execution of CRCKCHNG. This is accomplished by reading the Client Initialization File which contains the last "record_id" assigned for all input files.

The level key fields defined by the parameter KEY_FIELDS_NAMES and the fields defined by the parameter MP_TMP_KEY_FIELD_NAMES are initialized to the "record_id" value of the record.

The input record is written to the "RCD" output file. This output file is defined by the parameter RECORD_CHANGES_DDNAME.

The input record is written to the "MP" output file. This output file is defined by the parameter MP_CHANGES_DDNAME.

Sets the value of the NEW_OLD_FIELD_NAME parameters field to 'N' (new) on the output record written to the "MP" output file. This field is used by the CRKEYGRD module.


6-8 Program

Sets the value of the RECORD_SOURCE_FIELD_NAME parameter field to 'C' (change) on the output record written to the "MP" output file. This field is used by the CRKEYGRD module.

For ongoing & re-opened records, CRCKCHNG does the following: Compares the current and previous records for field changes. The fields

that are "checked for changes" are defined by the parameter CHECK_FIELDS_NNN. If there is a change between

the fields being compared, the following occurs:• A field transaction record is written to the "FLD" output file. This

output file is defined by the parameter FIELD_CHANGES_DDNAME. A field transaction record is written for every field change detected per record.

• The current record is written to the "MP" output file when a field change has occurred and this field has the "Y/N" flag on the

• CHECK_FIELDS_NNN parameter set to "Y." Sets the value of the NEW_OLD_FIELD_NAME parameter field to 'O'

(old) on the output record written to the "MP" output file. This field is used by the CRKEYGRD module.

Sets the value of the RECORD_SOURCE_FIELD_NAME parameter field to 'C' (change) on the output record written to the "MP" output file. This field is used by the CRKEYGRD module.

If the record is considered "re-opened", then a system field transaction of "0002" is written to the "FLD" output file. This system transaction record is read by the CRMSTUP1 program to set the record status to "re-open."

For closed records, CRCKCHNG does the following: A system field transaction of "0001" is written to the FLD output file.

This system transaction record is read by the CRMSTUP1 program to set the record status to "closed." If the previous record already has a "closed" status, then this system field transaction is not generated.

To prevent the generation of these system field transactions of "0001", set the parameter GENERATE_DELETES to "No." This parameter is normally used when the current input file is a partial file and not a full file replacement.


Input/Output Data Files 6-9

Input/Output Data FilesPREV_CONV_DDNAMEInput file that contains the previous cycle’s file source being processed. This file is built from the previous cycle’s CKM Master File.

CURR_CONV_DDNAMEInput file that contains the current input file source being processed.

FIELD_CHANGES_DDNAMEOutput file that contains all field changes that were detected.

RECORD_CHANGES_DDNAMEOutput file that contains new records.

MP_CHANGES_DDNAMEOutput file that contains new records and any record with at least one field that has the field change flag that is set to ‘Y.’

Repreprocess FunctionalityRepreprocessing is the ability to send records to the MP output file even though a field change has not occurred. To "re-preprocess" a record, the REPREPROCESS_FIELD_NAME parameter field must be set to "Y" on the previous input file. During the repreprocess function, the record written tothe "MP" output file is the current input record. Otherwise, the previous input record is written to the "MP" output file.For all previous input records written to the "MP" output file, the STATUS_FIELD_NAME parameter field is set to the CKM "closed" value which is defined by the parameter STATUS_VALUE_CLOSED.

Create Delete FunctionalityThe functionality exists that allows the user to generate a system delete transaction to be written to the FLD output file. Two local parameters, CREATE_DELETE_FIELD_NAME and CREATE_DELETE_VALUE are used to invoke this functionality. Both parameters refer to a field and data content of this field on the current input file. If this functionality is invoked and the criteriais met, no other processing occurs on the incoming record. In other words, no


6-10 FLD Output File

fields are checked for changes and no record will be written to the output MP file or no field change transactions, other than the system delete, will be written to the output FLD file.To generate a system delete transaction, all the following conditions must be met:

the local parameter GENERATE_DELETES, must be set to “NO.” the local parameter CREATE_DELETE_FIELD_NAME defines the field on

the current input file that contains the value that is defined by the local parameter, CREATE_DELETE_VALUE.

the current input record cannot be a new record to the database. It’s record must be on the previous input file.

Note

If an input record meets the criteria for both Create Delete Functionality and Repreprocess Functionality the previous input record, not current input record, will be written to the MP output file.

FLD Output FileThe FLD output file does not have a DDL used by the CKM system to define the record format. The record format of the output file is determined by using some information from the Client Initialization File. The output format is as follows:client number (value in the 4 byte field is taken from the

CLIENT_NUMBER parameter)

field transaction number value in the 4 byte field is as follows:0001 - 0100 - system reserved transaction numbers0101 - 9999 - transaction number associated withDDL_FIELD_NAME in Customer Initialization File

Master File record sequence (MST_SEQ_LEN in Customer Initialization File)

field change (MAX_FIELD_LEN in Customer Initialization File is the length of this field)


Customer Initialization File 6-11

Field transaction numbers of 0001 - 0100 are system reserved.0001 - Record closed.0002 - Record re-opened.0003-0100 - Future use.

Customer Initialization FileThe Customer Initialization (CUINI) File is updated by CRCKCHNG. When a value is changed in this CUINI file by CRCKCHNG, a “warning” message is displayed. There will be no warning message displayed when a RECORD_ID value is incremented.

Note

When CRCKCHNG begins execution, it makes a temporary copy of the CUINI. It uses and updates this temporary copy and before execution ends, it will overwrite the CUINI file with the temporary copy. This is very important if you are executing multiple instances of the CRCKCHNG program at the same time.

For the first execution of CRCKCHNG during the creation phase, the following “warnings” will be displayed:MAST_SEQ_KEY_LEN WAS <0>, NOW IS <XXX>CONV_SEQ_KEY_LEN WAS <0>, NOW IS <XXX>MAX_FIELD_LEN WAS <0>, NOW IS <XXX>FIELD_TRAN_LRECL WAS <0>, NOW IS <XXX>XREF_LRECL WAS <0>, NOW IS <XXX>where “XXX” is a number generated by the system based on customer specific processing.

For each execution of CRCKCHNG where the input source is being processed for the first time, the following “warning” will be displayed:NEW_FILE_ADDED WAS <YYY>where “YYY” is the number associated with this file in the VALID_FILES parameter.When “warnings” are displayed in which the value of “XXX” is not equal to 0,


6-12 Parameters

then action will need to be taken within the application.

ParametersParameters are optional unless otherwise specified.

Table 6.2 Warnings


MAST_SEQ_KEY_LEN Fields that made up the MAT_RECD_SEQ_FIELDS parameter have changed.

CONV_SEQ_KEY_LEN The length of the longest field defined by SEQ_FIELDS_NNN parameter has changed.

MAX_FIELD_LEN The length of the longest field defined by CHECK_FIELDS_NNN parameter has changed.

FIELD_TRAN_LRECL The logical record length of the “FLD” file generated by CRCKCHNG has changed.

XREF_LRECL The logical record length of the optional Cross Reference file generated by CRMSTUP2 has changed.

XREF_MST_KEYS_START

The starting position of the MAST_RECD_SEQ_FIELDS, in the optional Cross Reference File generated by CRMSTUP2, has changed.

Table 6.3 Parameters to Control CRCKCHNG Program

Name Meaning

CLIENT_PARMECHO text, name of listing file of the processed client_parmfile

CLIENT_PARMFILE text, client master parameter file Required

CONV_CYCLE_DATE text, cycle date of transaction file. Use to override the YYYYDDD portion of the field defined by the RECID_FIELD_NAME parameter.Valid formats are MM/DD/YY or DD/MM/YYYY,


Parameters 6-13

CREATE_DELETE_FIELD_NAME

Text, field name, on current input file, that contains the value of theCREATE_DELETE_VALUE parameter value.

CREATE_DELETE_VALUE Text, value to look for in the field defined by the parameter CREATE_DELETE_FIELD_NAME in order to generate a system ‘delete’ transaction.

CURR_CONV_DDNAME text, name of current client file to be processed (can be a list of files)

Required

DROP_DUPLICATE_CONV text, “Yes” indicates keep first duplicate record, drop the rest of the duplicates“No” indicates do not drop duplicate records. Terminate program executionif duplicates exists. Default is “No.”

FIELD_CHANGES_DDNAME

text, Output File name of field changes Required

FORCE_MP_PROCESSING text, “Yes” indicates to generate an MP record for every current cyclerecord regardless if a change has been detected. Default is “No.”

GENERATE_DELETES text, “Yes” indicates to generate a system field transaction for recordsthat exist on the previous cycle’s file but does not exist on the current cycle’s converted file.Set the field transaction number to 0001, closed record.“No” indicates not to generate a system field transaction for records thatexist on the previous cycle’s file but does not exist on the current cycle’sconverted file. The default is “Yes.”

Table 6.3 Parameters to Control CRCKCHNG Program (Continued)

Name Meaning


6-14 Parameters

IGNORE_MP_PROCESSING text, “Yes” indicates not to generate an MP record even though a change has been detected or a new record has been identified. The default is “No.”

MAX_BLKSI numeric, maximum block size of file. IBM Mainframe parameter platform only. Default is 32760.

MAXIN numeric, maximum number records to read. Default is all records.

MAXOUT numeric, maximum number of records to write to output files. (Default is all records.)

MAX_OUT_FSIZE numeric, maximum number of bytes to write. (UNIX and Windows platforms - See Note A)

MP_CHANGES_DDNAME text, Output File name of record changes to IP/MP processing* Required if PROCESSING_MP is set to “Yes” in Master ParameterFile.

*

NO_MP_NEWLY_CLOSED text, “yes” indicates to prevent creating a record to the MP file if it has generated a system delete transaction and the repreprocess functionality would send it to the MP file. Default is “no”.

PREV_CONV_DDNAME text, name of previous cycle file (can be a list of files)

Required

PROCESS_FILE text, name of transaction file to be processed (must be in VALID_FILES parm in the Master Parameter File)

Required

RECORD_CHANGES_DDNAME

text, Output File name of record changes Required

Table 6.3 Parameters to Control CRCKCHNG Program (Continued)

Name Meaning


Program Execution 6-15

Note

When this parameter is used, the output files will have the extension of .001, .002, .003, etc., with each file containing the number of bytes specified, until the total output file is written. If the MAX_OUT_FILE_SIZE is set in the master parameter file, then the MAX_OUT_FSIZE is ignored.

Program Executioncrckchng

UNIX and Windows PlatformsTo execute the CRCKCHNG on UNIX and Windows platforms, use the command:crckchng -parmfile parm_file_name -parmecho echo_file_namewhere:crckchng is the program, parm_file_name is the program parameter file, and echo_file_name is the listing file of the processed program parameter file.The -parmecho echo_file_name is optional.

Sample Parameter File for CRCKCHNG - Creation ModeBelow is a sample parameter file used to run CRCKCHNG in Creation Mode.************************************************************** sample parm file for CRCKCHNG (CREATION MODE)*************************************************************drop_duplicate_conv “N”client_parmfile “../parms/cumaster”client_parmecho

process_file “ilc”


6-16 Sample Parameter File for CRCKCHNG - Creation Mode

prev_conv_ddname “dummy”curr_conv_ddname “../data/clconv.ilc”

field_changes_ddname “../data/check.fld”

record_changes_ddname “../data/check.rcd”

mp_changes_ddname “../data/check.mp”


Sample Parameter File for CRCKCHNG - Update Mode 6-17

Sample Parameter File for CRCKCHNG - Update ModeBelow is a sample parameter file used to run CRCKCHNG in Update Mode.************************************************************** sample parm file for CRCKCHNG (UPDATE MODE)*************************************************************drop_duplicate_conv “N”

client_parmfile “../parms/cumaster”client_parmecho

process_file “ilc”prev_conv_ddname “../data/prev.ilc”curr_conv_ddname “../data/c2conv.ilc”

field_changes_ddname “../data/check.fld”

record_changes_ddname “../data/check.rcd”

mp_changes_ddname “../data/check.mp”


6-18 Sample JCL for CRCKCHNG - Creation Mode

Sample JCL for CRCKCHNG - Creation ModeBelow is a sample JCL (Job Control Language) used to run CRCKCHNG in the Creation Mode://***********************************************************//*//* CRCKCHNG - CHECKING FOR CHANGES IN CREATE MODE//*//***********************************************************//CRCKCHNG EXEC PGM=CRCKCHNG,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR// PE DD SYSOUT=*// PF DD *//***********************************************************//*//* CRCKCHNG PARMS (CREATION MODE)//*//***********************************************************DROP_DUPLICATE_CONV NCLIENT_PARMFILE CUMASTERCLIENT_PARMECHOPROCESS_FILE ILCPREV_CONV_DDNAME DUMMYCURR_CONV_DDNAME CURRFIELD_CHANGES_DDNAME FLDOUTRECORD_CHANGES_DDNAME RCDOUTMP_CHANGES_DDNAME MPOUT//*//CRMSLANG DD DUMMY,DCB=BLKSIZE=133//*//* INPUT FILE//*//CURR DD DISP=SHR,// DSN=&PROJPREF.DATA.CONVILC//*//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI


Sample JCL for CRCKCHNG - Creation Mode 6-19

//*//* OUTPUT FILES//*//MPOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),// SPACE=(TRK,(200,100),RLSE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CHECK.MP//RCDOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),// SPACE=(TRK,(200,100),RLSE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CHECK.RCD//FLDOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),// SPACE=(TRK,(100,10),RLSE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CHECK.FLD// CUINIO DD DISP=SHR,// DSN=&PROJPREF.CUINIO//*//* CLIENT PARM FILE (SEE TABLE 1)//*//CUMASTER DD DSN=SHR,// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//KMMASTER DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(TRILLIUM)//ILCDDL DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(ILC)//SYSTERM DD SYSOUT=*


6-20 Sample JCL for CRCKCHNG - Update Mode

Sample JCL for CRCKCHNG - Update ModeBelow is a sample JCL (Job Control Language) used to run CRCKCHNG in the Update Mode://***********************************************************//*//* CRCKCHNG - CHECKING FOR CHANGES IN UPDATE MODE//*//***********************************************************//CRCKCHNG EXEC PGM=CRCKCHNG,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//PE DD SYSOUT=*//PF DD *//***********************************************************//*//* CRCKCHNG PARMS (UPDATE MODE)//*//***********************************************************DROP_DUPLICATE_CONV N

CLIENT_PARMFILE CUMASTERCLIENT_PARMECHO

CONV_CYCLE_DATE

PROCESS_FILE ILC

PREV_CONV_DDNAME PREVCURR_CONV_DDNAME CURR

FIELD_CHANGES_DDNAME FLDOUT

RECORD_CHANGES_DDNAME RCDOUT

MP_CHANGES_DDNAME MPOUT//*//* CUMASTER - CLIENT PARM FILE (SEE TABLE1)


Sample JCL for CRCKCHNG - Update Mode 6-21

//*//CUMASTER DD DISP=SHR,// DSN=&PROJPREF.PARMLIB (CUMASTER)//*//CUINI DD DISP=SHR,// DSN=&PROJPREF,CUINI//CUINIO DD DISP=SHR,// DSN=&PROJPREF.CUINIO//*//PREV DD,DISP=SHR,// DSN=&PROJPREF.PREVILC//CURR DD,DISP=SHR,// DSN=&PROJPREF.CONVILC//MPOUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,100),RLSE),// DSN=&PROJPREF.CHECK.MP//RCDOUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,10),RLSE),// DSN=&PROJPREF.CHECK.RCD//FLDOUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(100,10),RLSE),// DSN=&PROJPREF.CHECK.FLD//KMMASTER DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF,DDLLIB(TRILLIUM)//ILCDDL DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(ILC)//SYSTERM DD SYSOUT=*/*


6-22 CRMATMST

CRMATMST

PurposeTo create the Reference Matching Master File and to optionally create a file of Level1 set records to re-match.

Programcrmatmst

All entries in the Master Parameter File are validated and where necessary are cross-checked with other entries:

all input files must be sorted by the fields specified by the MAST_RECD_SEQ_FIELDS parameter located in the Master Parameter File

the Current Cycle Field Change File, created by CRCKCHNG, is optional the Re-Match Output File is optional the DDL used in defining the output files and the Current Cycle MP File,

by default, is defined in the Master Parameter File by the DDL_MP_MAST_RECORD parameter

The program performs these functions: Delete from the output Reference Matching Master File any Current

Cycle MP File record that matches the previous Cycle Master File. The match key is the fields defined by the MAST_REC_SEQ_FIELDS parameter.



Optionally, set the field defined by STATUS_FIELD_NAME to the value defined by STATUS_VALUE_CLOSED on output file(s) for any matches between the Current Cycle Field Change File and the Previous Cycle Master File. The only field change records processed are newly closed records defined by a field transaction number of 0001.

NoteThis option should be used if executing the CRCLSGRD program.

Optionally, create the Re-Match output File. This file contains records that match between the Previous Cycle Master File and Current Cycle MP File, using a match key defined by MAST_SET_SEQ_FIELDS. This output file does not contain records that match with MAST_RECD_SEQ_FIELDS. Any records written to this output file are not written to the Reference Matching Master File. The field defined by the RECORD_SOURCE_FIELD_NAME parameter will be set to ‘M’ on all records written to the Re-match output file. These records will be considered “non-changes” as they proceed through the system.

Input/Output Data FilesMAST_INP_DDNAMEInput file that contains the previous cycle’s CKM Master File.

MP_INP_DDNAMEInput file that contains the sorted “MP” outputs of every CRCKCHNG that was executed. The only required fields necessary in this file are fields defined by the master parameter, MAST_RECD_SEQ_FIELDS.

FIELD_INP_DDNAMEOptional input file that contains the sorted “FLD” outputs of every CRCKCHNG that was executed.

MAST_OUT_DDNAMEOutput file that contains every record from the input Master File minus any records in the input MP file. If REMATCH_OUT_DDNAME is used, then matching ‘sets’ to the input MP file is not written to this output file.


6-24 Parameters

REMATCH_OUT_ DDNAMEOptional output file that contains all matching sets between the input Master File and the input MP file.


Table 6.4 Parameters to Control CRMATMST Program

Name Meaning



DELETE_NEWLY_CLOSED text, set to “yes” if you do not want newly closed records to be written to either output file.

Default is “no”.

The parameter DELETE_NEWLY_CLOSED is only valid if all entries in the master parameter VALID_FILES has the fifth entry set to 0. This entry refers to the number of days to keep closedrecords on the CKM Master File.

This parameter is useful when you do not want newly closed records, which will be purged by the CRMSTUP1 module, to be used in matching.

FIELD_INP_DDNAME text, name of input field change file (can be a list of files)

MAST_INP_DDL text, DDL defining shape of input master record

Required


Parameters 6-25

MAST_INP_DDNAME text, name of input Master File (can be a list of files)

Required

MAST_OUT_DDL text, DDL defining shape of output file defined by the MAST_OUT_DDNAME parameter. If present, it will override theDDL_MP_MAST_RECORD parameter in the Master Parameter.

MAST_OUT_DDNAME text, name of output reference matching Master File

Required

MAX_ARRAY_RECORDS numeric, number of records per Level 1 to hold in memory. Any records above this value will be stored on disk, using the file defined by WRK_DDNAME parameter. Default is 10,000.

MAX_OUT_FSIZE numeric maximum number of bytes to write to output files (UNIX and Windows platforms) (See Note A)

MP_INP_DDL text, DDL defining shape of input file defined by the MP_INP_DDNAME parameter. If present, it will override theDDL_MP_MAST_RECORD parameter in the Master Parameter.

MP_INP_DDNAME text, name of input MP file (can be a list of files)

Required

REMATCH_NEWLY_CLOSED text, set to “yes” if you want to write to the REMATCH_OUT_DDNAME all Level1 sets that contain a newly closed account.Default is “no”.

REMATCH_OUT_DDL text, DDL defining shape of rematch output file defined by the REMATCH_OUT_DDNAME parameter. If present, it will override the DDL_MP_MAST_RECORD parameter in the Master Parameter.

Table 6.4 Parameters to Control CRMATMST Program (Continued)

Name Meaning


6-26 Program Execution

Note AWhen this parameter is used, the output files will have the extension of .001, 002, 003, etc., with each file con-taining the number of bytes specified, until the total out-put file is written.

If MAX_OUT_FILE_SIZE is set in the master parameter file, the MAX_OUT_FSIZE is ignored.

Program Executioncrmatmst

UNIX and Windows PlatformsTo execute the CRMATMST on UNIX and Windows platforms, use the command:crmatmst -parmfile parm_file_name -parmecho echo_file_namewhere:crmatmst is the program, parm_file_name is the program parameter file, and echo_file_name is the listing file of the processed program parameter file.The -parmecho echo_file_name is optional.

Sample Parameter File for CRMATMST Below is a sample parameter file used to run CRMATMST. ************************************************************** sample parm file for CRMATMST*

REMATCH_OUT_DDNAME text, name of output re-match file

WRK_DDNAME text, Output File name of work overflow Required

Table 6.4 Parameters to Control CRMATMST Program (Continued)

Name Meaning


Sample JCL File for CRMATMST 6-27

************************************************************client_parmfile “../parms/cumaster”client_parmecho

mast_inp_ddl “../dict/kmmaster.ddl”,”MASTREC”

mast_inp_ddname “../data/crmstup2.mst”

mp_inp_ddname “../data/mp.srt”

mast_out_ddname “../data/crmatmst.out”

wrk_ddname “../data/crmatmst.wrk”*

Sample JCL File for CRMATMST Below is a sample JCL (Job Control Language) used to run CRMATMST://************************************************************//* CRMATMST - CREATE REFERENCE MATCHING MASTER//*//***********************************************************//CRMATMST EXEC PGM=CRMATMST,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//KMMASTER DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF,DDLLIB(TRILLIUM)//PE DD SYSOUT=*// PF DD ************************************************************* CRMATMST PARMS***********************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHOMAST_INP_DDL KMMASTERMAST_INP_DDNAME MASTINPMP_INP_DDNAME MPINP


6-28 Sample JCL File for CRMATMST

MAST_OUT_DDNAME MASTOUTWRK_DDNAME WORK//*//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//SYSPRINT DD SYSOUT=*//SYSTERM DD SYSOUT=*//CRMSLANG DD DUMMY,DCB=BLKSIZE=133//*//* CUMASTER - CLIENT PARMFILE (SEE TABLE 1)//*//CUMASTER DD DISP=SHR,// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//* INPUT FILES//*//MASTINP DD DISP=SHR,// DSN=&PROJPREF.CRMSTUP2.MST//MPINP DD DISP=SHR,// DSN=&PROJPREF.MP.SRT//*//* OUTPUT FILES//*//MASTOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),// SPACE=(TRK,(200,100),RLSE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRMATMST.OUT//WORK DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,DELETE,DELETE),// DCB=(RECFM=FBS,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRMATMST.WRK


CRMSTUP1 6-29

CRMSTUP1

PurposeTo update the Customer Key Manager Master File with new records and field changes identified by the CRCKCHNG module, Level keys from the CRKEYGRD module, and user-defined field updates from IP/MP processing. This program will identify changes to the comparison of Level1 sets or sort sequence changes in these Level1 sets and writes these Level1 sets out for further processing.This program will internally move the MP_TMP_KEY_FIELDS to their corresponding KEY_FIELDS on the MP_CHANGES_DDNAME file after it has been merged with the other input files before moving the fields to the CKM Master File from the IP/MP File.

Programcrmstup1

All entries in the master parm file are validated and where necessary are cross-checked with other entries.Record type transactions are processed first, next, the field type transactions are applied and then the MP transactions (if present) are applied.This program will:1. Add records from the Records file from CRCKCHNG to the output Master File.


6-30 Program

2. Apply field changes from the field changes file from CRCKCHNG to the out-put Master File.

3. Apply field moves from the MP file from IP/MP process to the output Master File. This includes the Level Keys that were generated in the CRKEYGRD program.

4. Purge closed records from the output Master File if the records have been closed longer the number of days defined by the VALID_FILES parameter and the CLOSED_ACCOUNT_DATE_FIELD parameter is defined.

5. Set record status in the field defined by the STATUS_FIELD_NAME parame-ter. The four record statuses are:

• New - New record to the CKM Master File.• Closed - Record is on CKM Master File but was not included on the

current input file in CRCKCHNG.• Reopened - Record is on the CKM Master File with a “closed” status

and was included on the current input file in CRCKCHNG.• Ongoing - Record is on the CKM Master File and is not one of the

above statuses.

The SET_CHANGED_OUT_DDNAME file will be comprised of the following records:1. If MP processing was performed and there were changes to a set, all records

in the set will be written out.2. If MP processing was performed and new sets were created, all records in

the set will be written out.3. If MP processing was performed, any sets identified in the

CHANGED_SETS_DDNAME file will be written out.4. If SELECT_PRIME_RECORD and/or CREATE_COMMON_DATA is performed

and there is a field change to any of the fields that are used to determine the prime record or commonizing data, all records in the set will be written out.

5. Any field changes to any field that makes up the MAST_SET_SEQ_FIELDS will cause all records in the set to be written out.


Program 6-31

CRMSTUP1 will populate the fields defined by the following parameters: CLOSED_ACCT_DATE_FIELD (if defined) REOPEN_ACCT_DATE_FIELD (if defined) MAST_DATE_LAST_TOUCHED (if defined) STATUS_FIELD_NAME MP_CHANGE_FIELD NAMES RECORD_SOURCE_FIELD_NAME (value will be set to ‘M’) NEW_OLD_FIELD_NAME (value will be set to ‘O’) REPREPROCESS_FIELD_NAME (if defined, value will be set to blank) REFMAT_FLAG_FIELD_NAME (value will be set to blank) If local parameter APPLY_USER_FIELDS is set to ‘Yes’

• USER_FIELD_NAME1 (if defined, the value is defined by USER_FIELD_VALUE1)





Records are purged from the Master File as follows:1. The STATUS_FIELD_NAME field must be equal to the STATUS_VALUE_-

CLOSED value after determining the status of the record.2. The CLOSED_ACCT_DATE_FIELD field must be defined and the value of this

field must be greater than or equal to the number of days to keep “closed” records, as defined by the 5th positional parameter of the VALID_FILES parameter.If the CLOSED_ACCT_DATE_FIELD is set by the date option of CYCLE_DATE, then the comparison is done using the value of the CURR_CYCLE_DATE parameter. If CLOSED_ACCT_DATE_FIELD is set by the date option of RUN_DATE, then the comparison is done using the value of the current system date when the


6-32 Input/Output Data Files

program is executing.3. If the number of days to keep closed records is set to zero, all closed

records will be purged from the output files.

Input/Output Data FilesMAST_INP_DDNAMEInput file that contains the previous cycle’s CKM Master File.

FIELD_CHANGED_ DDNAMEInput file that contains the sorted FLD outputs of every CRCKCHNG that was executed.

RECORD_CHANGES_ DDNAMEInput file that contains the sorted RCD outputs of every CRCKCHNG that was executed.

MP_CHANGES_DDNAMEInput file that contains the sorted ‘set’ changes output of CRKEYGRD module.

CHANGED_SETS_ DDNAMEInput file that contains the sorted RCD outputs of every CRCKCHNG that was executed.

MAST_OUT_DDNAMEOutput file that contains all ‘sets’ that have had no level key changes, no records added to the ‘set’ or no records deleted from the ‘set.’

SEQ_CHANGES_OUT_ DDNAMEOutput file that contains all ‘sets’ that had records added to the ‘set’ or records deleted from the ‘set’.

WRK_DDNAMEOutput file that is used for temporary ‘set’ processing.


Parameters 6-33


Table 6.5 Parameters to Control CRMSTUP1 Program

Name Meaning

ABEND_NOMATCH_FLD

text, “NO” will not cause program to abend if an unmatched FLD record is encountered. Default is “YES”.

ABEND_NOMATCH_MP text, “NO” will not cause program to abend if an unmatched MP record is encountered. Default is “YES”.

APPLY_USER_FIELDS text, set to ‘YES’ to populate fields defined by master parameters ofUSER_FIELD_NAME1-5. Default is NO.

CHANGED_SETS_DDNAME

text, input file name of sorted changed set keys from CRKEYGRD(* required if MP processing was performed) (Can be a list of files)

*



FIELD_CHANGES_DDNAME

text, input file name of previous cycle’s Master File (Can be a list of files)

Required

MAST_INP_DDNAME text, input file name of previous cycle’s Master File (Can be a list of files)

Required

MAST_OUT_DDNAME text, name of master Output File Required

MAX_ARRAY_RECORDS

numeric, number of records per Level 1 to hold in memory. Any records above this value will be stored on disk, using the file defined by WRK_DDNAME parameter. Default is 10,000.


6-34 Parameters

MAX_BLKSI numeric, maximum blocksize of file.IBM Mainframe platform parameter only.Default is 32760.

MAX_OUT_FSIZE numeric maximum number of bytes to write to output files (UNIX and Windows platforms)(See Note A)

Required

MAXIN numeric, maximum number records to read. Default is read all records.

MAXOUT numeric, maximum number of records to write. Default is write to all records.

MP_CHANGES_DDNAME

text, input file name of MP changes(* required if MP processing was performed) (Can be a list of files)

*

MP_INP_DDL text, DDL defining shape of input file defined by the MP_CHANGES_DDNAME parameter. If present, will override theDDL_MP_MAST_RECORD parameter in the Master Parameter.

PREV_MAST_RECORD_NAME

DDL defining the shape of the previous Master File (* required if remap_prev_mast is set to “Yes”)

*

RECORD_CHANGES_DDNAME

text, input file name of record changes from CRCKCHNG (Can be a list of files)

Required

REMAP_PREV_MAST text, “Yes” or “blank” indicates if input file of previous Master File has changed format

SEQ_CHANGED_OUT_DDNAME

text, Output File name of set changes Required


Table 6.5 Parameters to Control CRMSTUP1 Program (Continued)

Name Meaning



NoteWhen this parameter is used, the output files will have the extension of .001, 002, 003, etc., with each file con-taining the number of bytes specified, until the total out-put file is written.


Program Executioncrmstup1

UNIX and Windows PlatformsTo execute the crmstup1program on UNIX and Windows platforms, use the command:crmstup1 -parmfile parm_file_name -parmecho echo_file_namewhere:crmstup1 is the program, parm_file_name is the crmstup1 program parameter file, and echo_file_name is the listing file of the processed crmstup1 program parameter file.The -parmecho echo_file_name is optional.

Sample Parameter File for CRMSTUP1 - Creation ModeBelow is a sample parameter file used to run CRMSTUP1 in Creation Mode.************************************************************** sample parm file for CRMSTUP1 (CREATION MODE)*************************************************************client_parmfile “../parms/cumaster”client_parmechomast_inp_ddname “../data/crmstup2.mst”


6-36 Sample JCL for CRMSTUP1 - Creation Mode

field_changes_ddname “../data/checksrt.fld”

record_changes_ddname “../data/checksrt.rcd”

mp_changes_ddname “../data/crkeygrd.srt”

changed_sets_ddname “../data/chngset.srt”

mast_out_ddname “../data/crmstup1.out”

seq_changed_out_ddname “../data/crmstup1.seq”

wrk_ddname “../data/crmstup1.wrk”

Sample JCL for CRMSTUP1 - Creation ModeBelow is a sample JCL (Job Control Language) used to run CRMSTUP1 in Creation Mode://***********************************************************//*//* CRMSTUP1 - MASTER UPDATE ONE IN CREATE MODE//*//***********************************************************//CRMSTUP1 EXEC PGM=CRMSTUP1,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//*//KMMASTER DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF,DDLLIB(TRILLIUM)//CHANGE DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(CHANGE)//ILCDDL DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(ILC)//PE DD SYSOUT=*//PF DD ************************************************************


Sample JCL for CRMSTUP1 - Creation Mode 6-37

** CRMSTUP1 PARMS (CREATION MODE)************************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHOMAST_INP_DDNAME DUMMYFIELD_CHANGES_DNAME DUMMYCHANGED_SETS_DDNAME DUMMYRECORD_CHANGES_DDNAME RCDINMP_CHANGES_DDNAME MPINMAST_OUT_DDNAME MASTOUTSEQ_CHANGED_OUT_DDNAME SEQOUTWRK_DDNAME WORK//*//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//SYSPRINT DD SYSOUT=*//SYSTERM DD SYSOUT=*//CRMSLANG DD DUMMY,DCB=BLKSIZE=133//*//* CUMASTER - CLIENT PARMFILE (SEE TABLE 1)//*//CUMASTER DD DISP=SHR// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//* INPUT FILE//*//RCDIN DD DISP=SHR// DSN=&PROJPREF.CHECKRCD.SRT//MPIN DD DISP=SHR,// DSN=&PROJPREF.CRKEYGRD.SRT//*//* OUTPUT FILE//*//MASTOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),// SPACE=(TRK,(200,100),RLSE),


6-38 Sample JCL for CRMSTUP1 - Update Mode

// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRMSTUP1.OUT//SEQOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),// SPACE=(TRK,(200,100),RLSE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRMSTUP1.SEQ//WORK DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,DELETE,DELETE),// SPACE=(TRK,(200,100),RLSE),// DCB=(RECFM=FBS,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRMSTUP1.WRK

Sample JCL for CRMSTUP1 - Update ModeBelow is a sample JCL (Job Control Language) used to run CRMSTUP1 in Update Mode://***********************************************************//*//* CP PROCESSING - MASTER UPDATE ONE IN UPDATE MODE//*//***********************************************************//CRMSTUP1 EXEC PGM=CRMSTUP1,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//KMMASTER DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF,DDLLIB(TRILLIUM)//CHANGE DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(CHANGE)//ILCDDL DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(ILC)//PE DD SYSOUT=*//PF DD ************************************************************


Sample JCL for CRMSTUP1 - Update Mode 6-39

** CRMSTUP1 PARMS (UPDATE MODE)************************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHO

MAST_INP_DDNAME MASTIN

FIELD_CHANGES_DDNAME FLDIN

RECORD_CHANGES_DDNAME RCDIN

MP_CHANGES_DDNAME MPIN

CHANGED_SETS_DDNAME SETSIN

MAST_OUT_DDNAME MASTOUT

SEQ_CHANGED_OUT_DDNAME SEQOUT

WRK_DDNAME WORK//*//* CUMASTER - CLIENT PARM FILE (SEE TABLE 1)//*//CUMASTER DD DISP=SHR,// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//* INPUT FILE//*//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//MASTIN DD DISP=SHR,// DSN=&PROJPREF.CRMSTUP2.MST//FLDIN DD DISP=SHR,// DSN=&PROJPREF.CHECKFLD.SRT//RCDIN DD DISP=SHR,// DSN=&PROJPREF.CHECKRCD.SRT//MPIN DD DISP=SHR,



// DSN=&PROJPREF.CRKEYGRD.SRT//SETSIN DD DISP=SHR,// DSN=&PROJPREF.SETCHNG.SRT//*//* OUTPUT FILES//*//MASTOUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,100),RLSE),// DSN=&PROJPREF.CRMSTUP1.OUT//SEQOUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,100),RLSE),// DSN=&PROJPREF.CRMSTUP1.SEQ//WORK DD UNIT=&UNIT,DISP=(NEW,DELETE,DELETE),// DCB=(RECFM=FBS,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,100),RLSE),// DSN=&PROJPREF.CRMSTUP1.WRK


CRRCHNG 6-41

CRRCHNG

PurposeThis optional module is executed if any of the following routines are necessary:

Set prime record at Level1 (SELECT_PRIME_RECORD master parameter must be set to “YES”)

Create Common data at Level1 (CREATE_COMMON_DATA Master Parameter must be set to “YES”)

Calculate the number of members per each level of matching.

Programcrprchng

All entries in the master parm file are validated and where necessary are cross-checked with other entries.CRPRCHNG will populate the fields defined by the following parameters:

PRIME_FIELD_NAME CREATE_COMMON_FIELDS KEY_FIELD_NAMES (number of member per level fields)


6-42 Input/Output Data Files

Input/Output Data FilesMAST_INP_DDNAMEInput file that contains the sorted ‘set changes’ file from CRMSTUP1 module.

MAST_OUT_DNAMEOutput file that contains the updated input file.

WRK_DDNAMEOutput file that is used for temporary ‘set’ processing.


Table 6.6 Parameters to Control CRPRCHNG Program

Name Meaning



MAST_INP_DDNAME text, name of input file (Can be a list of files)

Required

MAST_OUT_DDNAME text, name of Output File Required

MAX_ARRAY_RECORDS numeric, number of records per Level 1 to hold in memory. Any records above this value will be stored on disk, using the file defined by WRK_DDNAME parameter. Default is 10,000.

Required

MAX_BLKSI numeric, maximum blocksize of file. IBM Mainframe platform parameter only. Default is 32760.






Program Executioncrprchng

UNIX and Windows PlatformsTo execute the CRPRCHNG program on UNIX and Windows platforms, use the command:crprchng -parmfile parm_file_name -parmecho echo_file_namewhere:crprchng is the program, parm_file_name is the program parameter file, and echo_file_name is the listing file of the processed program parameter file.The -parmecho echo_file_name is optional.

MAXOUT numeric, maximum number of records to write. Default is to write all records.

MAX_OUT_FSIZE numeric maximum number of bytes to write to output files (UNIX and Windows platforms)(See Note A)


Table 6.6 Parameters to Control CRPRCHNG Program (Continued)

Name Meaning


6-44 Sample Parameter File for CRPRCHNG

Sample Parameter File for CRPRCHNGBelow is a sample parameter file used to run CRPRCHNG.************************************************************** sample parm file for CRPRCHNG*************************************************************client_parmfile “../parms/cumaster”client_parmecho

mast_inp_ddname “../data/crmstup1.srt”

mast_out_ddname “../data/crprchng.out”

wrk_ddname “../data/crprchng.wrk”

Sample JCL for CRPRCHNGBelow is a sample JCL (Job Control Language) used to run CRPRCHNG://***********************************************************//*//* CRPRCHNG - PROCESS CHANGES//*//***********************************************************//CRPRCHNG EXEC PGM=CRPRCHNG,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//KMMASTER DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF,DDLLIB(TRILLIUM)//ILCDDL DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(ILC)//PE DD SYSOUT=*// PF DD *************************************************************


Sample JCL for CRPRCHNG 6-45

* CRPRCHNG PARMS************************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHO


MAST_OUT_DDNAME MASTOUTWRK_DDNAME WORK//*//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//SYSPRINT DD SYSOUT=*//SYSTERM DD SYSOUT=*//CRMSLANG DD DUMMY,DCB=BLKSIZE=133//*//* CUMASTER - CLIENT PARMFILE (SEE TABLE 1)//*//CUMASTER DD DISP=SHR// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//* INPUT FILE//*//MASTIN DD DISP=SHR// DSN=&PROJPREF.CRMSTUP1.SRT//*//* OUTPUT FILE//*//MASTOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),// SPACE=(TRK,(200,100),RLSE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRPRCHNG.OUT//WORK DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,DELETE,DELETE),// SPACE=(TRK,(200,100),RLSE),


6-46 Sample JCL for CRPRCHNG

// DCB=(RECFM=FBS,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRPRCHNG.WRK/*


CRMSTUP2 6-47

CRMSTUP2

PurposeTo create the final Customer Key Manager Master File for this cycle by merging the master update files from CRMSTUP1 and CRPRCHNG.

Programcrmstup2

All entries in the master parm file are validated and where necessary are cross-checked with other entries.The program merges the two input files to create the final Master File for this cycle, which is input to the next cycle’s execution of the CRCKCHNG, CRMATMST, and CRMSTUP1 modules.CRMSTUP2 will populate the fields defined by the following parameters:

RECORD_SOURCE_FIELD_NAME (value will be set to ‘M’) NEW_OLD_FIELD_NAME (value will be set to ‘O’) REPREPROCESS_FIELD_NAME (if defined, value will be set to blank) REFMAT_FLAG_FIELD_NAME (if defined, value will be set to blank) USER_FIELD_NAME1 (if defined, the value is defined by

USER_FIELD_VALUE1) USER_FIELD_NAME2 (if defined, the value is defined by




USER_FIELD_VALUE5)CRMSTUP2 can create three optional output files:

Cross Reference File - Defined by XREF_OUT_DDNAME parameter.


6-48 Program

MP Master File - Defined by MP_REFERENCE_FILE_DDNAME parameter. Key File - Defined by KEYLINKS_DDNAME parameter.

The Cross Reference File does not have a DDL. The logical record length of the records in this file is determined by using the Customer Initialization File. The format is as follows:

Client_number Client_number from Customer Initialization File

File_name MAST_FILE_NAME field definition, length of 10 bytes

conversion sequence key CNV_SEQ_LEN from Customer Initialization File is the length of the field. Data is taken from each record using SEQ_FIELD_NNN definition

Master File record sequence MST_SEQ_LEN from Customer Initialization File is the length of this field. Data is taken from each record using MAST_RECD_SEQ_FIELDS definition.



Input/Output Data FilesMAST_INP_DDNAMEInput file that contains the ‘no set changes’ output file from CRMSTUP1 module.

CHANGES_INP_DDNAMEInput file that contains the sorted output file from CRPRCHNG, if executed. If CRPRCHNG is not executed, then this file is sorted ‘set changes’ file from CRMSTUP1 module.

MAST_OUT_DDNAMEOutput file that contains the final CKM Master File for current cycle.

KEYLINKS_DDNAMEOptional output file that contains the CKM Master File in a different DDL format.

MP_REFERENCE_FILE_ DDNAMEOptional output file that contains the CKM Master File in a different DDL format.

XREF_OUT_DDNAMEOptional output file that contains the CKM Master File in a cross reference file format (defined above).


Table 6.7 Parameters to Control CRPRCHNG Program

Name Meaning

CHANGES_INP_DDNAME text, input file name of changed Master File (Can be a list of files)

Required

CLIENT_PARMECHO text, name of listing file of the processed client parmfile


6-50 Parameters


KEYLINKS_DDNAME text, Output File name of a file created as a subset of the Master File.This file is described by the DDL_KEYLINKS_RECORD in the masterparameter file.

MAST_INP_DDNAME text, input file name of unchanged Master File (Can be a list of files)

Required

MAST_OUT_DDNAME text, Output File name of Master File Required

MAX_BLKSI numeric, maximum block size of file. IBM Mainframe parameter platform only. Default is 32760.


MAXOUT numeric, maximum number of records to write. Default is to write all records.

MAX_OUT_FSIZE numeric maximum number of bytes to write to output files (UNIX and Windows platforms). (See Note A)

MP_REFERENCE_FILE_DDNAME

text, Output File name of a file created as a subset of the Master File.This file is described by the DDL_MP_MAST_RECORD in the masterparameter file.

OMIT_FREQ_REPORT text, set to ‘Y’ if you want to omit the frequency of members per level from the output statistical file. Default is blank. Should be set ‘Y’ if CRPRCHNG is not executed.

XREF_OUT_DDNAME text, Output File name of Cross Reference File

Table 6.7 Parameters to Control CRPRCHNG Program (Continued)

Name Meaning





Program Executioncrmstup2

UNIX and Windows PlatformsTo execute the crmstup2 program on UNIX and Windows platforms, use the command:crmstup2 -parmfile parm_file_name -parmecho echo_file_namewhere:crmstup2 is the program, parm_file_name is the crmstup2 program parameter file, and echo_file_name is the listing file of the processed crmstup2 program parameter file. The -parmecho echo_file_name is optional.

Sample Parameter File for CRMSTUP2 - Creation ModeBelow is a sample parameter file used to run CRMSTUP2 in Creation Mode.************************************************************** sample parm file for CRMSTUP2 (CREATION MODE)*************************************************************client_parmfile “../parms/cumaster”

client_parmecho


6-52 Sample Parameter File for CRMSTUP2 - Update Mode

mast_inp_ddname “dummy”

changes_inp_ddname “../data/crprchng.srt”

mast_out_ddname “../data/crmstup2.mst”

Sample Parameter File for CRMSTUP2 - Update ModeBelow is a sample parameter file used to run CRMSTUP2 in Update Mode.************************************************************** sample parm file for CRMSTUP2 (UPDATE MODE)*************************************************************client_parmfile “../parms/cumaster”client_parmecho

mast_inp_ddname “../data/crmstup1.out”

changes_inp_ddname “../data/crprchng.srt

mast_out_ddname “../data/crmstup2.mst”

Sample JCL for CRMSTUP2 - Creation ModeBelow is a sample JCL (Job Control Language) used to run CRMSTUP2 in Creation Mode://***********************************************************//*//* CRMSTUP2 - MASTER UPDATE TWO IN CREATE MODE//*//***********************************************************//CRMSTUP2 EXEC PGM=CRMSTUP2,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//KMMASTER DD DISP=SHR,


Sample JCL for CRMSTUP2 - Creation Mode 6-53

// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF,DDLLIB(TRILLIUM)//ILCDDL DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(ILC)//PE DD SYSOUT=*//PF DD ************************************************************** CRMSTUP2 PARMS (CREATION MODE)************************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHOMAST_INP_DDNAME DUMMYCHANGES_INP_DDNAME CHGSINMAST_OUT_DDNAME MASTOUT//*//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//SYSPRINT DD SYSOUT=*//SYSTERM DD SYSOUT=*//CRMSLANG DD DUMMY,DCB=BLKSIZE=133//*//* CUMASTER - CLIENT PARMFILE (SEE TABLE 1)//*//CUMASTER DD DISP=SHR// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//* INPUT FILE//*//CHGSIN DD DISP=SHR// DSN=&PROJPREF.CRPRCHNG.SRT//*//* OUTPUT FILE//*//MASTOUT DD UNIT=&UNIT,// VOL=SER=&VOL,// DISP=(NEW,CATLG,DELETE),



// SPACE=(TRK,(200,100),RLSE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// DSN=&PROJPREF.CRMSTUP2.MST

Sample JCL for CRMSTUP2 - Update ModeBelow is a sample JCL (Job Control Language) used to run CRMSTUP2 in the Update Mode://***********************************************************//*//* CRMSTUP2 - MASTER UPDATE TWO IN UPDATE MODE//*//***********************************************************//CRMSTUP2 EXEC PGM=CRMSTUP2,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//KMMASTER DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(KMMASTER)//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF,DDLLIB(TRILLIUM)//ILCDDC DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(ILC)//PE DD SYSOUT=*//PF DD *//***********************************************************//*//* CRMSTUP2 PARM (UPDATE MODE)//*//***********************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHO


CHANGES_INP_DDNAME CHGSIN

MAST_OUT_DDNAME MASTOUT


Sample JCL for CRMSTUP2 - Update Mode 6-55

//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//SYSPRINT DD SYSOUT=*//SYSTERM DD SYSOUT=*//CRMSLANG DD DUMMY,DCB=BLKSIZE=133//*//* CUMASTER - CLIENT PARM FILE (SEE TABLE 1)//*//CUMASTER DD DISP=SHR,// DSN=&PROJPREF.PARMLIB(CUMASTER)//*//* INPUT FILES//*//MASTIN DD DISP=SHR,// DSN=&PROJPREF.CRMSTUP1.OUT//CHGSIN DD DISP=SHR,// DSN=&PROJPREF.CRPRCHNG.SRT//*//* OUTPUT FILE//*//MASTOUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,100),RLSE),// DSN=&PROJPREF.CRMSTUP2.MST


CHAPTER 7 The Key Management Process (KP)

The following sections describe the programs used in the Key Management Process, including the parameters of each program and the commands for invoking them on your platform. Sample parameter files and JCLs are also provided for each program.

The Key Management Process (KP)

7-2 CRCLSGRD

CRCLSGRD

PurposeTo allow a Customer Key Manager flagged closed account to “follow” a moving open account, when the closed account no longer has a matching relationship with the open account.This program will change the value of the field defined by the CURR_KEY_FIELD_NAME parameter on the closed account(s) to the value of this field from the first non-closed account under the following conditions:1. The closed account(s) and the non-closed account must have the same

value in the field defined by the PREV_KEY_FIELD_NAME parameter (same prior cycle Level1 key) and,

2. The closed account(s) does not have any non-closed account with the same value in the field defined by CURR_KEY_FIELD_NAME parameter (different current Level1 matching) and,

3. The closed account(s) and non-closed account must have the same value in the field defined by SUPER_SET_FIELD_NAME parameter.

If the value of the field defined by the CURR_KEY_FIELD_NAME parameter is changed on the closed account(s), this will ensure that it remains in the same Level1 set as the non-closed account.


Program 7-3

Programcrclsgrd

The program will perform the closed account functionality within the “super set link”. The “super set link” all records with every other record in which there was a relationship on last cycle’s Master File.This program requires that the following fields be populated:

super_set_field_name Populated by MP process. This field must contain a value that links a record to every record in its current matching relationship and to every record in its previous matching relationship.

current level1 matching field Populated by MP process. This field needs to contain a value that links a record to every record in its current level1 matching relationship.

previous level1 key This field needs to contain the previous cycle’s level1 key.

status_field_name Populated by previous cycle’s run of CRMSTUP1, or optionally by current cycle’s run of CRMATMST

Input/Output Data FilesTRN_INP_DDNAMEInput file that contains the sorted output from applying current cycle matching links and the “super set link”.

OUT_DDNAMEOutput file that contains the updated, if necessary, input file.

WRK_DDNAMEOutput file that is used for temporary group processing.


7-4 Parameters


Table 7.1 Parameters to Control CRCLSGRD Program

Name Meaning



CURR_KEY_FIELD_NAME text, field name that contains the current matching at Level1. The fieldcannot exceed 19 bytes.

Required

MAX_ARRAY_RECORDS numeric, number of records per Level1 to hold in memory. Any records above this value will be stored on disk, using the file defined by WRK_DDNAME parameter. Default is 100,000.


OUT_DDNAME text, output file name Required

PREV_KEY_FIELD_NAME text, field name that contains the previous cycles’ Level1 key. The fieldmust be 19 bytes.

Required

PRINT_NTH_COUNT text, prints the count of every nth record read. If 0 or not specified, no counts will be reported.

TRN_INP_DDL text, DDL defining shape of input file defined by the TRN_INP_DDNAME parameter. If present, will override theDDL_MP_MAST_RECORD parameter in the master parameter.

TRN_INP_DDNAME text, input file name Required



Note A

When this parameter is used, the output files will have the extension of .001, 002, 003, etc., with each file containing the number of bytes specified, until the total output file is written. If MAX_OUT_FILE_SIZE is set in the master parameter file, the MAX_OUT_FSIZE is ignored.

Program Executioncrclsgrd

UNIX and Windows PlatformsTo execute the CRCLSGRD on UNIX and Windows platforms, use the command:crclsgrd -parmfile parm_file_name -parmecho echo_file_namewhere:crclsgrd is the program, parm_file_name is the program parameter file, and echo_file_name is the listing file of the processed program parameter file.The -parmecho echo_file_name is optional.

Sample Parameter File for CRCLSGRDBelow is a sample parameter file used to run CRCLSGRD. ************************************************************** sample parm file for CRCLSGRD*************************************************************client_parmfile “../parms/crmaster”client_parmecho


Table 7.1 Parameters to Control CRCLSGRD Program (Continued)

Name Meaning


7-6 Sample JCL for CRCLSGRD

trn_inp_ddname “../data/crclsgrd.inp”out_ddname “../data/crclsgrd.out”curr_key_field_name “level1_link_this_match”prev_key_field_name “level1key”wrk_ddname “../data/crclsgrd.wrk”

Sample JCL for CRCLSGRDBelow is a sample JCL (Job Control Language) used to run CRCLSGRD.************************************************************** CRCLSGRD - CLOSED ACCOUNT PROCESSING*************************************************************//CRCKCHNG EXEC PGM=CRCKCHNG,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR// PE DD SYSOUT=*// PF DD *//***********************************************************//*//* CRCLSGRD PARMS//*//***********************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHOTRN_INP_DDNAME INPUTOUT_DDNAME OUTPUTCURR_KEY_FIELD_NAME level1_link_this_matchPREV_KEY_FIELD_NAME level1keyWRK_DDNAME WORK//*//* CUMASTER - CLIENT PARM FILE (SEE TABLE1)//*//CUMASTER DD DISP=SHR,// DSN=&PROJPREF.PARMLIB (CUMASTER)//*//INPUT DD DISP=SHR,


Sample JCL for CRCLSGRD 7-7

// DSN=&PROJPREF.CRCLSGRD.INP//OUTPUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,100),RLSE),// DSN=&PROJPREF.CRCLSGRD.OUT//WORK DD UNIT=&UNIT,DISP=(NEW,DELETE,DELETE),// DCB=(RECFM=FBS,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(500,100),RLSE),// DSN=&PROJPREF.CRCLSGRD.WRK//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(TRILLIUM)//SYSTERM DD SYSOUT=*//SYSPRINT DD SYSOUT=*//*


7-8 CRKEYGRD

CRKEYGRD

PurposeKey Continuity/Key Persistence of each matching Level key defined within the Customer Key Manager application. Keep Level keys constant, if possible, over time and to assign new Level keys when necessary. The following are the predefined rules for key continuity:1. Every record has its entire previous and current relationship in the window.

The “super-set” link is the link that accomplishes this.2. The lowest level key from a “non-change” record will survive for a particular

level. A “nonchange” record is defined as a record that has the value of ‘M’ in the field defined by the RECORD_SOURCE_FIELD_NAME parameter. Once assigned to a level, this level key will not be used again.

3. The lowest level key from a “change” record will survive for a particular level. A “change” record is defined as a record that has the value of ‘C’ in the field defined by the RECORD_SOURCE_FIELD_NAME parameter. Once assigned to a level, this level key will not be used again.

4. New level keys are assigned to a level if all previous level keys have been assigned to another record or if all records in the level are new.

Level key continuity begins at the highest level key, Level1, and proceeds to the lowest level key until all level keys have been processed within the “super set” link.


Program 7-9

Programcrkeygrd

This program performs the key continuity functionality by processing each level of matching independently of each other within the group of records with the same “super-set” link This field that contains the “super-set” link is defined by the master parameter, SUPER_SET_FIELD_NAME.This “super-set” link value is a link that combines all records that currently match together at Level1 and all records that previously matched to these records at Level1 last cycle.The Level keys are 19 bytes in length and the format is as follows:

YYYDDD Julian date based on the CURR_CYCLE_DATE parameter (default).

FFF Set to ‘000’. IF PARTITION_NUMB parameter is used, the 3 byte parameter entry value is stored here.

NNNNNNNNN Sequential number beginning at 1.

This program requires that the following fields be populated:

super_set_field_name Populated by MP process. This field needs to contain a value that links a record to every record in its current Level1 matching relationship and to every record in its previous Level1 matching relationship.

current level matching fields Populated by MP process. These fields (1 per Level key) need to contain a value that links a record to every record in its current matching level relationship. There should be one of these fields for every Level key defined. An example field name is level1_link_this_match. These fields are defined by the second positional parameter


7-10 Program

of the level_keys parameter.

previous CKM level keys These fields need to contain the previous cycle level keys. These fields are defined by the first positional parameter of the level_keys parameter.

new_old_field_name Populated by CRCKCHNG. This field will be set to ‘N’ for new records and ‘O’ for existing records.

record_source_field_name Populated by CRCKCHNG, CRMATMST and CRMSTUP2. CRCKCHNG will set the value of this field to ‘C’ for all records going to IP/MP processing.

CRMATMST will set the value of this field to ‘M’ for all records written to the Re-match File, if generated.

CRMSTUP2 will set the value of this field to ‘M’ for all records.

Key management begins at the highest level (Level1) and proceeds down to each lower level (as needed). If a new key needs to be assigned, it will be generated and applied to every record within that particular level.

This program requires that every “super_set” must be read into memory. The program default is 100,000 records in “super set”. Use MAX_ARRAY_RECORDS to adjust this default, if necessary. If there are more records in the “super set”, the program will attempt to allocate more memory.

CRKEYGRD will read the client initialization file (CUINI) to retrieve the Julian date that was used when this module was last executed. A comparison will be done versus this retrieved Julian date and the Julian date that will be used during the current execution. The following table illustrates what happens.



Most common reason for warning message (dates are equal):1. If the CURR_CYCLE_DATE or RUN_CYCLE_DATE parameter is used to gener-

ate the Julian date, and it has not been changed since the last execution.2. Using partition_numb parameter and one partition has completed before all

partitions have begun execution.3. Re-run of current cycle’s execution of CRKEYGRD.

CRKEYGRD reads the Julian date of the incoming record’s level keys and compares it to the Julian date to be used to generate any new level keys. If the incoming record’s Julian date is greater than or equal to the Julian date to be used, then the program will abend. This prevents re-using keys and/or prevents duplication of the level keys.

Input/Output Data FilesTRN_INP_DDNAME

Input file that contains the sorted output file from applying current cycle matching links and “super-set” link. Sorted output file from CRCLSGRD, if executed.

Table 7.2 CUINI Comparison

Comparison Result

Julian Date from CUINI GT Current Julian Date

Abend program.

Julian Date from CUINI EQ Current Julian Date

Continue processing, send warning message to STDERR.

Julian Date from CUINI LT Current Julian Date

Continue processing.


7-12 Parameters

OUT_DDNAME

Output file that contains the necessary records needed to be written out. See Note C on page 116 for records that are written to this output file.SET_CHANGES_DDNAME

Output file that contains the previous ‘set’ field for any input record that has had any level key changes. The previous ‘set’ field record is not written for new records. This ‘set’ field is defined by the MAST_SET_SEQ_FIELDS parameter. These are the only fields necessary in this output file.


Table 7.3 Parameters to Control CRKEYGRD Program

Name Meaning



CREATION_MODE text, “Y” indicates running in Creation Mode. All level keys will be generated and no output will be written to theSET_CHANGES_DDNAME file. Default is “N”.

TRN_INP_DDL text, DDL defining shape of input file defined by the TRN_INP_DDNAME parameter. If present, will override theDDL_MP_MAST_RECORD parameter in the master parameter.


Parameters 7-13

LEVEL_KEYS text, list of field names that contain the previous level key, current matched level key, and will contain the surviving level key.One entry of three field names is required for each level.The 1st and 3rd positional field must be 19 bytes.The 2nd positional field cannot exceed 19 bytes.

Required

MAX_ARRAY_RECORDS numeric, number of records to allocate memory in order to store the “super set”. Default is 100,000.


OUT_DDNAME text, output file name of matched file Required

OUTPUT_ALL_RECORDS text, set to ‘Y’ if you want the entire input file written out. Default is blank (See Note C).

PARTITION_NUMB numeric, 3 byte number to use in order to populate position 8-10 of the generated level keys. This will allow this program to be executed in partitions.

Valid values are 100-999 as long as they are not used to define the file number portion of the VALID_FILES master parameter.

PRINT_NTH_COUNT text, prints the count of every nth record read. If 0 or not specified, no counts will be reported.

RECORD_SEQUENCE_FIELDS

text, list of fields that define the sort required. Sequence of the input file (See Note D).

Required

Table 7.3 Parameters to Control CRKEYGRD Program (Continued)

Name Meaning


7-14 Parameters

Note AWhen this parameter is used, the output files will have the extension of .001, 002, 003, etc., with each file con-taining the number of bytes specified, until the total out-put file is written. If MAX_OUT_FILE_SIZE is set in the master parameter file, the MAX_OUT_FSIZE is ignored.

Note BThe format of the parameter is one of the following:

MM/DD/YYYY

DD/MM/YYYY

System (will use system clock)

Use of this parameter will override the CURR_CYCLE_-DATE parameter in the master parameter.

RUN_CYCLE_DATE text, date to use to generate the YYYYDDD position of the level keys (see Note B).

SET_CHANGES_DDNAME text, output file name of any sets with changes

Required

TRN_INP_DDNAME text, input file name of matched file Required

UNIQUE_SORT_FIELD_NAME

text, the field name that is defined by the master parameter RECID_FIELD_NAME. This field is used by the internal sort to ensure that the records are loaded into the process window in the same sequence on every platform.

Table 7.3 Parameters to Control CRKEYGRD Program (Continued)

Name Meaning



Note CBy default, the output record will consist of the following records:

1. All records with the value of ‘C’ in the field defined by theRECORD_SOURCE_FIELD_NAME parameter.

2. Any record with the value of ‘M’ in the field defined by theRECORD_SOURCE_FIELD_NAME parameter that has had a change in value of any of the level key fields.

Note DThe input sequence must be as follows:

• the field defined by the SUPER_SET_FIELD_NAME • the field defined by the 2nd positioned field of the LEVEL_KEYS parameter for Level1 • the field defined by the 1st positioned field of the LEVEL_KEYS parameter for Level1 • the field defined by the 2nd positioned field of the LEVEL_KEYS parameter for Level2 (if processed)• the field defined by the 1st positioned field of the LEVEL_KEYS parameter for Level2 (if processed)• etc. for Level3 through Level “N”

Program Executioncrkeygrd

UNIX and Windows PlatformsTo execute the CRKEYGRD on UNIX and Windows platforms, use the command:crkeygrd -parmfile parm_file_name -parmecho echo_file_namewhere:crkeygrd is the program, parm_file_name is the program parameter file, and echo_file_name is the listing file of the processed program parameter file.


7-16 Sample Parameter File for CRKEYGRD - Creation Mode

The -parmecho echo_file_name is optional.

Sample Parameter File for CRKEYGRD - Creation Mode Below is a sample parameter file used to run CRKEYGRD in Creation Mode. *************************************************************sample parm file for CRKEYGRD (Creation Mode)*************************************************************client_parmfile “../parms/cumaster”client_parmechotrn_inp_ddname “../data/crkeygrd.inp”out_ddname “../data/crkeygrd.out”set_changes_ddname“../data/crkeygrd.set”level_keys “level1key,level1_link_this_match,tmp_level1key”

“level2key,level2_link_this_match,tmp_level2key”creation_mode “Y”record_sequence_fields “super_set_link”

“level1_link_this_match”“level1key”“level2_link_this_match”“level2key”

run_cycle_date “system”unique_sort_field_name “record_id”

Sample Parameter File for CRKEYGRD - Update Mode Below is a sample parameter file for running CRKEYGRD in Update Mode.://************************************************************** sample parm file for CRKEYGRD (Update Mode)*************************************************************


Sample JCL for CRKEYGRD 7-17

client_parmfile “../parms/crmaster”client_parmechotrn_inp_ddname “../data/crkeygrd.inp”out_ddname “../data/crkeygrd.out”set_changes_ddname “../data/crkeygrd.set”level_keys “level1key,level1_link_this_match,

tmp_level1key”“level2key,level2_link_this_match,tmp_level2key”

record_sequence_fields “super_link_key”“level1_link_this_match”“level1key”“level2_link_this_match”“level2key”

run_cycle_date “system”unique_sort_field_name “record_id”

Sample JCL for CRKEYGRDBelow is a sample JCL (Job Control Language) used to run CRKEYGRD://***********************************************************//*//* CRKEYGRD - KEY MANAGEMENT//*//***********************************************************//CRKEYGRD EXEC PGM=CRKEYGRD,PARM=’-PARMFILE PF -PARMECHO PE’//STEPLIB DD DSN=&PROJPREF.LOADLIB,DISP=SHR// DD DSN=&PROJPREF.LINKLIB,DISP=SHR//PE DD SYSOUT=*//PF DD *//***********************************************************//*//* CRKEYGRD PARMS//*//************************************************************CLIENT_PARMFILE CUMASTERCLIENT_PARMECHOTRN_INP_DDNAME INPUT


7-18 Sample JCL for CRKEYGRD

OUT_DDNAME OUTPUTSET_CHANGES_DDNAME SETOUTLEVEL_KEYS LEVEL1KEY,LEVEL1_LINK_THIS_MATCH,

TMP_LEVEL1KEYLEVEL2KEY,LEVEL2_LINK_THIS_MATCH,TMP_LEVEL2KEY

RECORD_SEQUENCE_FIELDS SUPER_SET_LINKLEVEL1_LINK_THIS_MATCHLEVEL1KEYLEVEL2_LINK_THIS_MATCHLEVEL2KEY

UNIQUE_SORT_FIELD_NAME SUPER_SET_LINK//*//* CUMASTER - CLIENT PARM FILE (SEE TABLE1)//*//CUMASTER DD DISP=SHR,// DSN=&PROJPREF.PARMLIB (CUMASTER)//*//INPUT DD DISP=SHR,// DSN=&PROJPREF.CRKEYGRD.INP//CUINI DD DISP=SHR,// DSN=&PROJPREF.CUINI//CUINIO DD DISP=SHR,// DSN=&PROJPREF.CUINIO//OUTPUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,100),RLSE),// DSN=&PROJPREF.CRKEYGRD.OUT//SETOUT DD UNIT=&UNIT,DISP=(NEW,CATLG,DELETE),// DCB=(RECFM=FB,LRECL=&LRECL,BLKSIZE=&BLKSIZE),// SPACE=(TRK,(5000,10),RLSE),// DSN=&PROJPREF.CRKEYGRD.SET//SYSTMP01 DD UNIT=&UNIT,DISP=(NEW,DELETE,DELETE),// SPACE=(TRK,(500,100),RLSE),// DSN=&&WORK//TRILLIUM DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(TRILLIUM)//CHANGE DD DISP=SHR,// DSN=&PROJPREF.DDLLIB(CHANGE)


Sample JCL for CRKEYGRD 7-19

//SYSTERM DD SYSOUT=*//SYSPRINT DD SYSOUT=*


CHAPTER 8 Error Codes

This chapter lists the error codes and the work-around to avoid the errors.

Error Codes

8-2

Table 8.1 Error Codes


ERROR: COPY FIELD FAILED <-nnn>ERROR: CREATING RECD OUTPUT RECORD <-nnn>where nnn=366 (INVALID PACKED DATA)367 (INVALID EBCDIC TO ASCII)368 (INVALID ASCII TO PACKED)370 (INVALID ASCII DATA)371 (INVALID ASCII NUMERIC DATA)372 (INVALID EBCDIC DATA)373 (INVALID EBCDIC NUMERIC DATA)375 (INVALID ZONED DATA)376 (INVALID INTEGER DATA)381 (INVALID DATE VALUE)382 (INVALID PC DATE VALUE)383 (INVALID AMERICAN DATE VALUE)384 (INVALID EUROPEAN DATE VALUE)385 (INVALID SHORT JULIAN DATE VALUE)386 (INVALID YEAR FIRST DATE VALUE)387 (INVALID LONG JULIAN DATE VALUE)

1. Correct the Data Type Definition of the field in the DDL of the input file or,2. Correct the input field data to reflect the Data Type Definition or,3. Do not set the master parameter,DATA_VALIDATION, to “YES” or,4. Add the following to the input DDL for the offending field, ATTRIBUTES ARE NOVALIDATION

ERROR: INVALID CLIENT PARM CONTENTS <parm_entry>

Error description is given.

ERROR: REQUIRED CLIENT PARM MISSING <parm_entry>

Add missing parameter.

ERROR: REQUIRED LOCAL PARM MISSING <parm_entry>

Add missing parameter.


8-3

ERROR: LOCAL PARM FILE MISSING/INVALID

Look at -pe file to locate error.

ERROR: CLIENT PARM FILE MISSING/INVALID

Look at client_parmecho file to locate error.

ERROR: OPENING FILE <file_name>

File does not exist. File cannot be created.

ERROR: INITIATING PARM FILE Parameter file does not exist.

ERROR: IN LOCAL PARM FILE, FIX & RESUBMIT

Look in -pe file to locate error.

ERROR: WRITING <file_name> No room on device.

ERROR: PARM <parm_name> IS INVALID

Wrong option format entered.

ERROR: MALLOC FAILED FOR...ERROR: MALLOC FAILED

Not enough memory to run process.

ERROR: MASTER RECORD ARRAY MALLOC FAILED

Not enough memory to hold value assigned to MAX_ARRAY_RECORD parameter. Lower value of thisparameter.

ERROR: INI FILE IS CORRUPT Problem with client initialization file.

ERROR: GETEMAIL FOR <FIELD> ON <RECORD>FAILED <parm_entry> <field_name> <MASTREC>

ERROR: GETEDB FOR <FIELD> ON <RECORD> FAILED <field_name> <MASTREC>

<field_name> associated with <parm_entry> does not exist on DDL.

ERROR: CANNOT GET FIELD <XXXX> FROM DDL <YYYY>

field <XXXX> does not exist in the DDL <YYYY>

Table 8.1 Error Codes (Continued)


Error Codes

8-4

ERROR: VALID_FILES PARM LAST ENTRY VALUE GREATER THAN 99999

Change to valid value of 0 - 99999.

ERROR: MAST_FILE_NAME VALUE ON INPUT RECORD NOT EQUAL TO PROCESS_FILE VALUE

PROCESS_FILE value in local parameter does not match data in the field defined by the MAST_FILE_NAME master parameter.

ERROR: XXXX_CYCLE_DATE NOT CORRECT FORMAT

Parameter used to generate RECID and/or LEVEL Keys is not in correct format.

ERROR: CYCLE_DATE <XXXX> LOWER THAN INI JULIAN DATE <XXXX>

Julian Date being generated has already been used to create RECORD_IDs. Change date.

ERROR: NEW JULIAN DATE <XXXX> LOWER THAN INI JULIAN DATE <XXXX>

Julian Date being generated has already been used to create RECORD_IDs. Change date.

ERROR: FIELD <XXXX> IS NOT SAME LENGTH ON <YYYY> AND <ZZZZ>

Field being displayed must be the same length on the DDLs, <YYYY>, and <ZZZZ>.

ERROR: PREVIOUS AND CURRENT SEQUENCE LENGTHS ARE NOT EQUAL

Fields defined as sequence keys cannot change length on files being compared.

ERROR: FILE <XXXX> IS EMPTY Input file exists but is empty, check process that created this file.

ERROR: FILE NAME < > SEARCH FAILED

The value, < >, is on the input data located in the field defined by the MAST_FILE_NAME parameter but thisvalue < > does not exist in the VALID_FILES parameter (file_name entry).




8-5

ERROR: PARM <XXXX>, FIELD <YYYY> NOT ON DDL (ZZZZ)

Field, YYYY, referred in parm, XXXX is not defined in DDL, ZZZZ.

Either add the field to DDL if a valid field or remove the field from parm if the field in no longer valid.

ERROR: JULIAN DATE FOR NEW LEVEL KEYS IS LOWER THAN INI KEY DATE VALUE

Change value of the Julian date to be used to generate level keys.

ERROR: JULIAN DATE FOR NEW KEYS HAS PREVIOUSLYBEEN USED. JULIAN_DATE <YYYYMMM> KEY FIELD <> KEY VALUE<>

Change value of Julian date to be used to generate level keys.

ERROR: RECORD SOURCE NOT <M> OR <C>

Field defined by master parameterRECORD_SOURCE_FIELD_NAME is required to have the value of ‘M’ or ‘C’. Verify that the correct input file and/or input DDL is being used.

ERROR: NEW_OLD FIELD NOT <N> OR <O>

Field defined by master parameterNEW_OLD_FIELD_NAME is required to have the value of ‘N’ or ‘O’. Verify that the correct input file and/or inputDDL is being used.

ERROR: FIELD TRANSACTION NUMBER OF <nnn>DOES NOT REPRESENT A VALID FIELD

(The value in position 5-8 of the field record does not exist inthe client initialization file’s list of fields.)

1. Client initialization file could be corrupt.2. Field changes file could be corrupt.



Error Codes

8-6

ERROR: FIELD TRANSACTION NUMBER OF <nnn>NOT VALID.

(The value in position 5-8 of the field record is greater thanthe value of the client initialization file’s value of theLAST_FIELD_NUMBER parameter.)

1. Client initialization file could be corrupt.2. Field changes file could be corrupt.




Documents

TSS Customer Key Manager Reference Manual