# Customizing CICS Interface

To install the CICS components for Substation ES, you have to customize the CICS interface by editing the data sets and selected members listed in the following steps. Also, you must select the correct version of the CICS load library that was included with your Substation ES installation.

## Procedure

1. Update CICS with the CICS Interface resource definitions.
   This member updates the CICS System Definition (CSD) file with the resource definitions necessary for Substation ES to operate. This JCL includes:
   - Definitions for Substation ES CICS components.
   - Definitions for the 3270 Bridge facility.
   Note: If you are updating definitions for the 3270 Bridge facility, you must first update `DSNAME(TIBCO.DFHBRNSF)` in `USERHLQ.CNTL(CSD3270A)` and `USERHLQ.CNTL(CSD3270U)` to match your site. You must install the 3270 Bridge if you want to execute `SHOW`,`CICS`,`SXTH`, and other commands for the console or WebUI.

   Data Set: `USERHLQ.JCL`

   Member: `SXCCSDUP`

2. Optional: Update the CICS Interface SIP member.
   The file-tailoring process has updated the Substation ES interface SIP member for CICS. If you are not sure whether the correct CICS generic APPLID value has been supplied, edit and correct the member accordingly.

   Data Set: `USERHLQ.PARM`

   Member: `SXCICTS1`

3. Activate CICS interface.
   Activate the interface by uncommenting the appropriate `INTF-MEMBER` keyword in the SIP member.

   Data Set: `USERHLQ.PARM`

   Member: `SXSSIP$1`

4. Optional: Suppress all or some CICS (signon/signoff) messages.
   The `DFHSN1100`, `DFHSN1200`, `DFHSN1400`, and `DFHSN1500` messages can be suppressed:
   - `DFHSN1100` `date time applid Signon at {netname | console |terminal }portname by user userid in group groupid is complete.`
   - `DFHSN1200` `date time applid Signoff at {netname | console |terminal }portname by user userid is complete. tt transactions entered with nn errors.`
   - `DFHSN1400` `date time applid Session signon for session session by user userid is complete.`
   - `DFHSN1500` `date time applid Session signoff for session session is complete. tt transactions entered with nn errors.`

   In a Substation ES environment using EXCI, a lot of these messages are displayed. To suppress them, see Suppressing CICS Signon or Signoff Messages.

   If the exit XMEOUT is installed, the `DFHSN1100`, `DFHSN1200`, `DFHSN1400`, and `DFHSN1500` messages are not produced.

   Before executing the JCL, update the LOAD library suffix to the correct version in LOADSFX:
   - `LOAD.CICS4X` for CICS V4.x
   - `LOAD.CICS5X` for CICS V5.x

   Data Set: `USERHLQ.ASM`

   Member: `SXCAXMEO` and `DFHPLTXI`

   Data set: `USERHLQ.JCL`

   Member: `SXCASMEO`

5. Assemble and link the Substation ES CICS PLT entries.
   Substation ES uses the `XD` and `XI` suffixes for its program list table (PLT) entries. If your CICS region already uses these suffixes, change the suffixes in the `DFHPLTXD` and `DFHPLTXI` members in the `USERHLQ.ASM` data set before executing the assembly.
   To view the current suffixes in the CICS region, type either of these two commands:
   - `CEMT I PROG CLASS(XD)`
   - `CEMT I PROG CLASS(XI)`
   Before executing the JCL, update the LOAD library suffix to the correct version in LOADSFX:
   - `LOAD.CICS4X` for CICS V4.x
   - `LOAD.CICS5X` for CICS V5.x

   Data Set: `USERHLQ.JCL`

   Member: `SXCASMLK`

6. Optional: Assemble and link the CICS DFHXCOPT module.
   To turn off surrogate user checking for Substation ES, a sample `DFHXCOPT` source module is provided, which you can tailor to your requirements. The source is located in the `USERHLQ.ASM` library.
   Before executing the JCL, update the LOAD library suffix to the correct version in LOADSFX:
   - `LOAD.CICS4X` for CICS V4.x
   - `LOAD.CICS5X` for CICS V5.x
   Note: The load module is in the Substation ES `USERHLQ.AUTH` library because this module must be in the concatenated `STEPLIB` library for the Substation ES startup procedure.

   Data Set: `USERHLQ.JCL`

   Member: `SXCASMLK`

7. Update the Substation ES startup.
   1. Add the `CICSHLQ.SDFHEXCI` library to the Substation ES `STEPLIB` concatenation.
   2. Remove the comment for the `CICSHLQ SET` statement. Ensure that the `CICSHLQ.SDFHEXCI` library is also APF-authorized because it is part of the `STEPLIB` concatenation.
   Data Set: `USERHLQ.JCL`

   Member: `TIBSSES`

8. Set the SYSIN values.
   Ensure that the CICS `GRPLIST` definition includes the TIBCO defined list `TIBLIST`. `TIBLIST` is the default name and for ease of maintenance it is recommended that this value not be changed.

   For example, `GRPLIST=(DFHLIST,TIBLIST),`

9. Optional: Set up requirements for the 3270 Bridge facility.
   To use Substation ES to communicate with the 3270 Bridge facility, ensure that the CICS `GRPLIST` definition includes either:
   - All three groups: `DFHBR`, `DFHTERM`, `DFHTYPE`.
   - The group `DFHLIST`.

   For example, `GRPLIST=(DFHLIST,TIBLIST)` or `GRPLIST=(DFHBR,DFHTERM,DFHTYPE,TIBLIST)`

   Note: It is assumed that you have a working installation of the IBM 3270 Bridge facility. If not, ensure that the following IBM CICS groups are installed in all CICS regions using the 3270 Bridge facility:
   - `DFHTYPE`
   - `DFHTERM`
   - `DFHBR`

   Substation ES provides a definition of the DFHBRNSF file. For details, see Step 1.

   If your installation wants another configuration, you have to review the following IBM CICS groups, which outline other ways of implementing the DFHBRNSF file:
   - `DFHBRCF`
   - `DFHBRUT`
   - `DFHBRVR`
   - `DFHBRVSL`
   - `DFHBRVSR`
   Note: If the CICS 3270 Bridge facility is not installed and set up, the Substation ES Console Command feature does not work correctly. For example, if the setup is correct, when you submit the `SHOW,CICS,"SXTH"` command through the Substation admin interface, the Substation CICS information is sent back.
10. Optional: Update AOR CICS with the CICS Interface resource definitions.
    This member updates the CSD file with the resource definitions necessary for Substation ES to operate in an AOR region.

    Data Set: `USERHLQ.CNTL`

    Member: `CSDAORDA` and `CSDAORDU`

11. Optional: Using Customized HUB for TIBCO System Logger
    By default, the CICS region uses the system default HUB. The default value is the SMF ID of the LPAR. To use a different HUB, add a DDName statement to the CICS region startup PROC in the following format:

    `//HUBxxxx DD DUMMY`

    where, xxxx is the HUB name that you want to be used for this CICS region.

    For more information about the Mainframe Logger usages, refer to the TIBCO Substation ES Mainframe Logger User's Guide.

Copyright © TIBCO Software Inc. All rights reserved.