Customizing File-AID for IMS/CICS

Perform the following tasks to customize the File-AID for IMS/CICS:

Task 1 Linkedit BMS mapsets for File-AID for IMS/CICS (XIXCMAP)

1. Modify sample JCL (member XIXCMAP in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
2. Submit the job.

Task 2 Linkedit File-AID for IMS/CICS (XIXCLINK) (optional)

1. This step is optional unless you elect to use a program name prefix of your own choosing. If so, modify the sample JCL (member XIXCLINK in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
2. Submit the job.

Task 3 make load modules available to CICS

Whenever you have linked or relinked the File-AID for IMS/CICS load modules with XIXCLINK and XIXCMAP using the default program name prefix of IXC, the following CICS load modules are written to the hlq.CXVJLOAD library:

IXCEDTF
IXCEDTI
IXCEDTL
IXCEDTS
IXCEDTU
IXCEND
IXCKEY
IXCMAIN
IXCMP1
IXCMP2
IXCMP3
IXCMP4
XVJPARM

If you have changed the default program names, the load modules will be written to the hlq.CXVJLOAD library.

You must make these load modules available to CICS, using DFHCSDUP, in order to access File-AID for IMS/CICS.If you have changed the default program names, the load modules will be written to the hlq.CXVJLOAD library.

Task 4 Generate customized objects

This task provides instructions on what jobs need to be run to generate required and optional customized objects. For more information, see File-AID for IMS Exits on security exits.

Task 4.1 Assemble and Link IMS Modules (Required)

The following JCL members are provided in the File-AID sample library hlq.SXVJSAMP:

• XIXCDBD - Assemble and Link an IMS DBD

  Follow the instructions in Modify DBD Source Code and Generate DBD Control Blocks.

• XIXCPSB - Assemble and Link an IMS PSB

  Follow the instructions in Modify PSBs and Generate PSB Control Blocks .

• XIXCACB - Assemble and Link an IMS ACB

  Follow the instructions in Generate ACB Control Blocks .

Modify DBD Source Code

Before you submit the JCL to assemble and link IMS modules, you should modify the DBD source code for File-AID’s control databases to conform to your installation’s specifications. Each member, IXCLTM, IXCCLT, and IXCAUD, should be updated identically except where noted. The members are found in the Sample Library hlq.SXVJSAMP.

If necessary, modify these names to meet your installation’s DBD naming conventions.

It is recommended that the control databases be organized as VSAM data sets because of their large segment sizes. However, if your installation wants to allocate them as OSAM data sets, change the second parameter to OSAM. Do not change the access method (first parameter).

Substitute the RBNs calculated in DBD Tailoring for the third parameters. Substitute the RMNAME BYTES calculated earlier for the fourth parameters. The RMNAME BYTES parameter must be the same for the LTM and CLT databases. Do not change the randomizer name (first parameter) or the RAPs per CI (second parameter).

If necessary, modify these names to meet your installation’s DDNAME conventions.

Change the device to the type used at your installation.

Find the row that corresponds to your installation’s Maximum User DB Segment Length (for the LTM and CLT databases) or Maximum User DB Segment Plus Concat Key Length (for the AUD database) in the tables shown in DBD Tailoring. Substitute the appropriate number from the CI/BLOCK column for the Size parameter.

Find the row that corresponds to your installation’s Maximum User DB Segment Length (for the LTM and CLT databases), or Maximum User DB Segment Plus Concat Key Length (for the AUD database) in the tables shown in DBD Tailoring. Substitute the appropriate number from the Segm Bytes column for the corresponding BYTE operand. Substitute this same number in all the SEGM statements in the appropriate control database DBDs. Each control database DBD must have the same maximum segment size on all its SEGM statements. Do not change the NAME=, PARENT=, PTR=, or the segment minimum size parameters.

Generate DBD Control Blocks

In this task, DBD control blocks are generated for the three control databases and the four sample databases.

1. Submit DBDGENs for the databases using JCL already in place at your installation, or modify the sample JCL (member XIXCDBD in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
2. Submit the job.

Modify PSBs

Modify the PSBs as required by your installation’s configuration. The first five PCBs in the PSB (including the optional Audit Trail PCB) are for File-AID’ use. PCBs 6 thru 500 are for your user databases. It is recommended that you include the four sample database PCBs in your PSB for the initial installation. Member IXCIXC in hlq.SXVJSAMP contains these sample databases’ PCBs.

For more information, see PSB Tailoring.

Generate PSB Control Blocks

In this step, PSB control blocks are generated for the PSBs needed for your installation configuration and the PSBs in members IXCDLET, IXCLOAD, and IXCUPLD in hlq.SXVJSAMP.

1. Submit PSBGENs for these PSBs using JCL already in place at your installation, or modify the sample JCL (member XIXCPSB in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
2. Submit the job.

Generate ACB Control Blocks

In this step, ACB control blocks are generated for the PSBs needed for your installation configuration and the PSB in member IXCUPLD in hlq.SXVJSAMP.

1. Submit ACBGENs for these PSBs using JCL already in place at your installation, or modify the sample JCL (member XIXCACB in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member.
2. Submit the job.

Task 4.2 ALLOCATE LTM, CLT and Audit Trail Database Data sets (Required)

The control databases require one data set each. It is recommended that these databases be allocated as VSAM files because of their segment sizes. If your installation does not want to use VSAM, they can be allocated as OSAM files, but the ACCESS parameter of the DBD macro within the DBD source must be modified to reflect this.

The following JCL members are provided in the File-AID sample library hlq.SXVJSAMP:

• 
  
  • XIXCALCO - Allocate Data sets using OSAM
  • XIXCALCV - Allocate Data sets using VSAM

1. Modify the sample JCL to your site’s requirements by following the instructions in the member.
2. Submit the job.

Use the following formulas to calculate the space needed by the control databases:

• LTM data set size:
  bytes = RBN calculated earlier * CI size * 14
• CLT data set size:
  bytes = RBN calculated earlier * CI size
• AUD data set size:
  bytes = RBN calculated earlier * CI size

These formulas assume a stable user base. If you anticipate that the user base will grow, you should factor this growth into the formulas before allocating the data sets.

Convert the number of bytes required to the number of cylinders required.

Task 4.3 Security Exit (Optional)

File-AID for IMS provides one exit type to the security exit. Its primary intent is to limit database access and to control whether a user’s database updates are captured by the Audit Trail feature. The default security exit routine provided with File-AID does no processing and returns control immediately to File-AID.

The following JCL members are provided in the File-AID sample library hlq.SXVJSAMP:

• 
  
  • XIXCSCXD - Compile and Dynamically Link a COBOL Exit
  • XIXCSCXS - Compile and Statically Link a COBOL Exit
  • XIXCSCXA - Compile and Link an ASSEMBLER Exit

1. Modify the appropriate sample JCL to your site’s requirements by following the instructions in the member.
2. Submit the job.

You have the following options when installing a security exit:

1. XIXCSCXD - Compile and Dynamically Link a COBOL Exit
2. XIXCSCXS - Compile and Statically Link a COBOL Exit
3. XIXCSCXA - Compile and Link an ASSEMBLER Exit

For more information, see File-AID for IMS/CICS and File-AID for IMS/DC Security Exit.

Task 4.4 Static Link of XVJSFX (Optional to support multiple XVJSFX modules)

Use these sample JCL members in hlq.SXVJSAMP to define multiple sets of transactions and XVJSFX modules and statically link them into your program library.

• 
  
  • XVJSFXA - Create an XVJSFX load module
  • XIXCSTAT - Statically link XVJSFX

1. Modify the sample JCL (member XVJSFXA in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member. This will create an XVJSFX load module.
2. Submit the job.
3. Modify the sample JCL (member XIXCSTAT in hlq.SXVJSAMP) to your site’s requirements by following the instructions in the member. This will statically link XVJSFX.
4. Submit the job.

Multiple Transaction Configuration

If you want to support transactions that use different configurations of File-AID for IMS/CICS within the same CICS region, further steps are required. First, create as many FAIXnnnn PARMLIB members as you require. You will need to create separate versions of the XVJSFX load module for each of them and link them into separate load libraries. Use the XVJSFXA PROC found in the hlq.SXVJSAMP library to create a suffix load module for each of the PARMLIB members you wish to define to the product.

Each version must then be statically linked along with the yyyMAIN load module into a uniquely named load module for each transaction that is to use that configuration.

When you are done, use the XIXCSTAT PROC found in the hlq.SXVJSAMP library to perform the link edit required to create a load module that has a particular version of XVJSFX linked into it.

Any transaction that is not associated with a load module that does not contain a statically linked version of XVJSFX will use the default 00 suffix version found in the CICS load library if one exists. The statically linked load module(s) must be made available to CICS.

When maintenance is applied to the XIXCMAIN load module in hlq.SXVJLOAD, you will have to run the XIXCSTAT PROC for each transaction load module that contains a unique version of the XVJSFX module. Remember, the statically linked load module(s) must be made available to CICS.