Part 3: Customized Installation

• Performing Tasks Common to All Product Installations

• Installing IOA

• Installing Control-M

• Installing Control-M/Restart

• Installing Control-D

• Installing Control-V

• Installing Control-O

• Installing Control-M/Tape

• Installing Control-M/Analyzer

• Installing Control-M JCL Verify

Performing Tasks Common to All Product Installations

Tasks common to all product installations are described in the following topics:

• Introduction

• Navigating within ICE

• Post-installation Customization

• Infrastructure Activities Performed by ICE

• Terminology

Introduction

When you enter ICE, the INCONTROL Installation Options screen is displayed, as shown in Installing with ICE.

1. If you currently have more than one environment managed by ICE, make sure that the environment that you want to use as a target for the installation process is selected as the current one. To do this:

   1. Select Installation.

   2. Select Environment Details.

   3. Select the environment, by entering S (Select Environment for Processing) next to the environment in the list.

      If you want to examine the values of an environment, enter B (Browse Environment Details) next to the environment and view the details in the IOA Installation - Environment Definition Screen, as follows:

      Figure 5 IOA Installation – Environment Definition Screen, with Values

      Copy

      -------------- IOA Installation - Environment definition --------------(DI.1.0)
                                      COMMAND ===>                                                                   
      
                                      Environment                                                                    
                                       Environment Name ==> R900XX         Will be used also as the IOA QNAME        
                                       Description      ==>                                                          
      
                                      Installation Libraries                                                         
                                       Prefix (ILPREFA) ==> IOAE.R900                                                
                                       Unit             ==> 3390                                                     
                                       Vol ser          ==> IOAZ06                                                   
                                       SMS Classes:     Data:          Management:          Storage:                 
      
                                      LOAD library DSNAME        ==> IOAE.R90XXX.LOAD                                
                                      Reference Libraries Prefix ==> IOAE.R900PRD                                    
                                      Insert reference into current values ==> N        (Y or N)                     
                                                                                                                     
                                      Product Status  IOA: I      CTB:       CTD:        CTM: I      CTO:            
                                                  CTR: I      CTV:       CTT:                                    

      If you are planning to clone the installed environment in the future, it is important that you understand the requirements and limitations of the cloning process before you begin the installation process. For more information, see Limitations.

      The following table describes the environment values to define on the IOA Installation — Environment Definition Screen.

      Table 1 Environment Values in the Environment Definition Screen

      Value	Description
      ID	Name of the environment, for example, TEST1, PROD9. Valid values: A string of alphanumeric characters and special characters ($, #, and @). Must begin with a letter. Maximum length: 8 characters.
      Description	Free text description of the environment. Maximum length: 35 characters.
      Prefix (ILPREFA)	High level qualifiers (prefix) of the environment‑specific installation libraries. For example, for the IOA.TEST1.INSTALL installation library, specify IOA.TEST1. Maximum length: 35 characters The value specified for this parameter must be different from the values specified for ILPREFx parameters of other products.
      Unit (ILUNITA)	Disk unit on which the environment‑specific libraries are allocated. Specify a generic unit, such as 3390. You must either define both the Unit and Volser fields, or leave both of them blank. Do not enter a value for only one of them.
      Vol ser (ILVOLA)	Volume serial number on which the environment‑specific libraries are to be allocated. You must either define both the Unit and Volser fields, or leave both of them blank. Do not enter a value for only one of them.
      SMS Classes	One of following classes: Data Management Storage
      LOAD Library DSNAME	The data set name of the IOA LOAD library loaded from the installation media.
      Reference Libraries Prefix	High level data set name qualifiers (prefix) of the installation libraries to be used as reference libraries.
      Insert reference into current values	One of following values: Y - get reference values and insert into current values N - get reference values but do not insert into current values
      Product Status	This field indicates if the IOA installation or INCONTROL product installation is complete.

2. Select Customized installation in the IOA Installation Window, as follows:

   Figure 6 IOA Installation Window

   Copy

    --------------------- INCONTROL Installation Options ---------------------(0.0)
                            COMMAND ===>                                                                   
                                                                                                           
                                                   IIIIII      CCCCCCCCC    EEEEEEEEE                      
                                   +-------------------------------------------------------------+         
                                   | --------------------- IOA Installation -------------------- |         
                                   |                                                             |         
                                   |         Please choose the required installation type        |         
                                   |                                                             |         
                                   | _ Express installation                                      |         
                                   |                                                             |         
                                 - | S Customized installation                                   | ----    
                                 B |                                                             |         
                                 - | _ Environment Details                                       | ----    
                                   |                                                             |         
                               Log | PF3: Return to previous screen                              |         
                                   |                                                             |         
                            S  - I | COMMAND ===>                                                | d)      
                            _  - C +-------------------------------------------------------------+         
                            _  - Uninstallation                  Removes IOA and INCONTROL products        
                            _  - Maintain your Environment       Maintenance, ad hoc fixes & ICE refresh   
                            _  - Clone, Deploy IOA Environment   Clone new IOA environment or deploy changes
                            _  - Express Upgrade                 Upgrade using original DB and OPR libraries
                        _  - Exit                            EXIT, Leave the Installation Process      

   The IOA Installation – Main Menu screen is displayed in the following format:

   Figure 7 IOA Customized Installation - Main Menu Screen

   Copy

    ------------------- IOA Customized Installation - Main Menu ------------------
                             OPTION  ===>                                                                   
                                                                                                           
                            Environment ID:  DOC900D                                                       
                            Product ID ===>  IOA        Enforce Step Order ===> NO  (Yes/No)               
                                                                                                           
                               Reference Libraries Prefix: IOAP.V900                                       
                                                                                                           
                             1  INSTALL IOA  - Install and Customize IOA                                   
                             2  INSTALL CTx  - Install and Customize an INCONTROL Product                  
                             X  EXIT         - Leave the Installation Process                              
                                                                                                       

IOA Installation – Main Menu

Each activity in the installation menu is invoked by selecting a product ID and an option number. Before selecting an activity, type the product ID value of the product you want to install in the Product ID field in the Main Menu screen. Valid values for the Product ID field are shown in the following table:

Table 2 Product ID Field – Valid Values

Type a number in the OPTION field to indicate the required activity, and press Enter to display the menu for the selected activity.

The following activities are available from the Main Menu:

Table 3 Main Menu Activities

ICE Step Sequences

ICE requires that you perform all steps sequentially within an activity, except in the following cases:

• When an optional step is marked as excluded, it can be bypassed.

• When steps are browsed, they can be browsed in any order.

• When a CUSTOMIZE activity step is selected, the "Enforce Step Order" attribute is not activated between the major steps. For details about major steps, see Navigating within ICE. Any major step in the CUSTOMIZE activity can be selected without requiring a previous step to be completed.

• When the value of the Enforce Step Order field is set to NO, steps can be taken in any order.

  This value should only be set to NO if you are advised to do so by BMC Customer Support.

  Type YES in the Enforce Step Order field in the Main Menu before you proceed with the IOA installation process.

ICE Activities

Installation activities that are performed online in ICE are organized hierarchically and are displayed in the IOA Installation—Main menu. Each activity is a key task related to installing and maintaining IOA and INCONTROL products:

• The "INSTALL IOA" activity installs IOA.

• The "INSTALL CTx" activity installs each INCONTROL product.

• The "EXIT" activity enables you to leave the installation process.

Each activity is organized as a list of major steps. Each major step consists of one or more minor steps.

Each minor step performs tasks such as parameter specification, submission of jobs or other installation processes.

Reference Values

Values from a previous installation can be used in the current installation. Using the Reference Libraries Prefix field in ICE, you can retrieve parameter values from a previous installation. For each parameter, you can select the default provided by ICE, select the reference value, or specify a new value.

For instructions for performing upgrades from previous versions and converting a test installation to a production installation, see the INCONTROL for z/OS Upgrade Guide for the relevant version.

Navigating within ICE

Once a major installation activity is selected from the Main Menu, secondary screens are displayed, listing all major and minor steps associated with the selected activity. The paragraphs below describe how to navigate within the various ICE screens.

Major Steps

Once the environment is selected, you can begin IOA installation. IOA must be installed before any INCONTROL product can be installed.

Select option 1, INSTALL IOA, from the Main Menu. The Major Steps Selection screen is displayed:

Figure 9 Major Steps Selection Screen

 ---------------------------- Major Steps Selection ---------------------------
                 COMMAND ===>                                                  SCROLL ===> CSR  
                 Environment: DOC900D   Product: IOA                                            
                 Sel values: S Select step     C Mark step as completed    R Reset status       
                             B Browse Step     X Mark step as excluded     ? Help               
                 PF7/PF8  To scroll through all Steps                                           
                 -------------------------------------------------------------------------------
                       Sel Step Status      Opt Description                                     
                       === ==== ======      === ===========                                     
                        .    1                  Planning                                        
                        .    2                  Parameters for File Allocation                  
                        .    3                  Load IOA Libraries                              
                        .    4                  Specify IOA Parameters                          
                        .    5                  Specify Target Configuration Parameters         
                        .    6                  Customization Process                           
                        .    7                  Set Global Variables Database                   
                        .    8              Y   Install ISPF Support                            
                        .    9                  Install IOA Subsystem                           
                        .   10              Y   Install IOA Online Monitor                      
                        .   11                  Adjustments                                     
                    .   12              Y   IOA Customization                               

All major steps for IOA installation are displayed in the Major Steps Selection screen. Optional steps are indicated by the value Y in the Optional (Opt) column.

Steps that contain the letter R in the Opt column must be performed once. Afterwards, they become optional steps. Once this type of step is performed, the value in the Opt column changes from R to Y. This indicates that the step is no longer mandatory.

The Status column in this screen indicates whether a step was previously selected (indicated by an asterisk sign), completed (indicated by COMPLETE), or excluded (indicated by an X).

The following actions can be applied to major and minor steps:

Table 4 Actions for Major and Minor Steps

Minor Steps

Once a major step is selected, by typing S in the Sel – Selection – column and pressing Enter, a list of associated minor steps is displayed. A Minor Steps Selection screen is displayed:

Figure 10 Minor Steps Selection Screen

---------------------------- Minor Steps Selection ---------------------------
                COMMAND ===>                                                  SCROLL ===> CSR 
                Environment: INCPRD    Product: IOA                                           
                Major Step: 2   Parameters for File Allocation                                
                Sel values: S Select step     C Mark step as completed    R Reset status      
                            B Browse Step     X Mark step as excluded     ? Help              
                PF7/PF8  To scroll through all Steps                                          
                ------------------------------------------------------------------------------
                Sel  Step Status   Type    Opt Description                                    
                ===  ==== ======   ====    === ===========                                    
                 .     1           Data        Workunit                                       
                 .     2           Data        Jobcard Parameters                             
                 .     3           Data        Operation and Maintenance Libraries            
                 .     4           Process     SMP CSI Configuration                          
                 .     5           Data        SMP Datasets                                   
                 .     6           Data        Define IOA LOADE (PDSE) lib. parameters        
            ------------------------------> End of Minor Steps <--------------------------

Certain minor steps are not mandatory. Minor steps that are optional (indicated by a Y in the Opt column) do not require an indication that they are completed steps.

The Major or Minor Steps Selection screens sometimes change dynamically, depending on the values specified for certain parameters.

All actions described above for major steps also apply to minor steps. The result of a minor step selection or browsing action differs according to the type of step chosen. The types of minor steps are

• Data

• Data(*)

• Edit

• Process

• External

• Job

• View

Each step type is described in Data Steps.

Data Steps

When a minor step is selected, a Parameter Data Entry screen is displayed as follows:

Figure 11 Parameter Data Entry Screen

---------------------------- Parameter Data Entry ------------ Row 1 of 1
                Product: IOA          Major Step: 2   Parameters for File Allocation
                Environment: INCPRD   Minor Step: 1   Workunit

                Codes in the VALUE field:           Function keys and Commands:
                  = Insert from Reference             PF7/8   Scroll through all parameters
                  / Insert from Default               PF3/End Exit and Save
                  ? Display Help                      Cancel  Exit without Save
                -------------------------------------------------------------------------------
                Variable  Value         Reference     Description
                ========= ============= ============= ===========

                WORKUNIT  SYSALLDA                    Unit for temporary files
                ------------------------------> End of Parameters <----------------------------

            COMMAND ===>                                                    SCROLL==> CSR

In this screen, a value can be specified for each parameter. In addition, each of the following symbols (when followed by a blank) can be used to specify values:

Table 5 Symbols for Specifying Values

Certain parameters are not mandatory. If, however, a value is not found for a parameter that requires a value, a message is displayed. The error message lists all the mandatory parameters for which values are missing.

Certain parameters, such as job card parameters, require values that are longer than the maximum number of characters that can be entered in the first type of parameter data entry screen. Therefore, another type of data entry screen is displayed for these parameters, as follows:

Figure 12 Parameters Data Entry Screen

---------------------------- Parameter Data Entry ------------ Row 1 to 3 of 4
                Product: IOA          Major Step: 2   Parameters for File Allocation          
                Environment: INCPRD   Minor Step: 2   Jobcard Parameters                      
                                                                                              
                Codes in the VALUE field:           Function keys and Commands:               
                  = Insert from Reference             PF7/8   Scroll through all parameters   
                  / Insert from Default               PF3/End Exit and Save                   
                  ? Display Help                      Cancel  Exit without Save               
                ------------------------------------------------------------------------------
                 Variable  --> JOBNAME    Job name                                            
                 Value     >>> I700IN                                                         
                 Reference -->                                                                
                                                                                              
                 Variable  --> JOBPOS     Position of JOB keyword in job statement            
                 Value     >>> 12                                                             
                 Reference -->                                                                
                                                                                              
                 Variable  --> JOBCARD    Jobcard data                                        
                 Value     >>> ,IOA700,MSGCLASS=X,CLASS=A                                     
                 Reference -->                                                                
                                                                                              
                 Variable  --> JCL1       First additional JCL                                
                 Value     >>> //*                                                            
                 Reference -->                                                                
            COMMAND ===>                                                    SCROLL==> CSR 

Edit Steps

Edit steps are used to edit certain IOA installation members. A standard ISPF EDIT screen is displayed.

Special Edit Steps: DATA(*)

A Data(*) minor step is used to specify values for installation parameters and macros that can extend beyond a single line, and therefore cannot be specified in the parameter data entry screens.

This type of step displays a special screen that enables you to edit the specific lines associated with the parameter. When you exit this screen, the lines are saved into the target member in the selected environment.

This type of step is useful, for example, when you want to use attributes specified in a previous installation. In this case, you must edit the reference member after specifying the appropriate names in the Reference Library and Reference member fields. When the required lines are edited and the member is saved by pressing the PF03/PF15 key, the edited lines are saved in the target member in the selected environment.

When parameters extend beyond a single line, specify an asterisk (*) in column 72, and continue specifying the parameters on the second line in column 16.

Multiple macro invocations should not be separated by an asterisk in column 72.

Process Steps

Process steps perform an internal ICE process. Once successfully completed, these steps are indicated as complete. Non-process steps must be explicitly marked complete by the installer.

External Steps

External steps are performed manually and not through ICE. Each external step provides detailed instructions about how to complete the step. Once an external step is completed, the installer should mark it complete.

View Steps

View steps are used to display explanatory text for the step being performed or for subsequent steps.

Job Steps

Job steps require the installer to submit installation jobs. The jobs are usually ready to run, but some jobs require modifications before submission. Necessary changes are indicated by specific comments in the job.

For a Job type step, do one of the following:

• Enter S in the Sel column to rebuild the job from the skeleton, starting from scratch

• Enter U in the Sel column to update the previously saved job (if it exists)

After making the changes, submit the job using the SUBMIT command, or the equivalent standard at your site.

After running the job, check the job output. If the job was successful, the job step must be marked complete, using the "C" option described above, in order to proceed with the next step of the installation procedure.

Post-installation Customization

Once a basic installation is completed, certain modifications to the operational parameters may be required. Other post‑installation activities may also be required. For more information about customization, see INCONTROL for z/OS Installation Guide: Customizing.

Infrastructure Activities Performed by ICE

This section discusses the activities ICE performs while building its infrastructure.

Location of Procedures

Procedures are located in the following libraries (low-level qualifiers):

Table 6 Procedure Libraries

PROCLIB Library

Because most procedures are not copied to the PROCLIB library of a site , the following JCL statements are included in the jobs in various JCL libraries:

// JCLLIB ORDER=ilprefa.PROCLIB
            // INCLUDE MEMBER=IOASET

The IOASET member of the IOA PROCLIB library is built by ICE and contains the values for all the parameters used in procedures and jobs.

IOAENV is another important member built by ICE in the IOA PROCLIB library. This member specifies the libraries in DD statements STEPLIB and DAPARM. Using this member, you can concatenate additional libraries in a site to both DD statements.

During the installation process, a small set of procedures from the PROCLIB library can be copied (and optionally renamed) to a procedure library of the site, by entering a data set name into the SITEPROC ICE variable, so that it can be used in the jobs at the site without the need to add JCLLIB and INCLUDE statements. It is therefore not necessary to change the jobs of an existing site that were used in earlier versions of IOA.

//ABNLIGNR DD DUMMY

PROCJCL Library

Do one of the following:

• Concatenate the PROCJCL library to the IEFJOBS DDstatement in the MSTJCLxx member of the SYS1.PARMLIB library.

• Copy the started tasks, renaming if necessary, to an existing site library, concatenated to the IEFJOBS DDstatement.

Propagation

Propagation is the process of copying from base libraries, tailoring, and resolving members. Only the following libraries require propagation as part of applying maintenance:

• The PROCJCL library.

• The ilprefx.JCL library (where x is the product letter).

IOA.PARM Library

The DAPARM DD statement in the IOAENV member of the IOA PROCLIB library points to the following libraries.

Table 7 Parameter Libraries

The IOAENV library contains the following members:

• Global profile variables in member $PROFILE

• IOA WISH – in source format, located in the IOADFLT member

• IOADSN – contains the list of all data sets and their DD statements that will be dynamically allocated

The PARM library contains few members when supplied. It is populated during ICE with parameter members, such as IOAPARM, CTMPARM, and so on. These parameter members are in source format.

The following members, populated during installation, are important for making local changes at your site. These members are not overwritten when maintenance is applied; instead, their contents override the supplied defaults.

• Use the IOADSNL member to make local changes to the list of data sets that are supplied in the IOADSN member.

• Use the IOADFLTL member to make local changes to defaults in the IOADFLT member.

• Use the $PROFMOD member to make local changes to profile variables in the $PROFILE member.

Source Parameters

All parameter members are supplied in source format. The parameter members are built and placed in the IOA.PARM library by ICE and have the following structure.

All installation parameters for which no explicit default values are mentioned are mandatory and must be supplied during the ICE definition process.

BLK1   BLK1_PARM1=xxx,
                            BLK1_PARM2=xxx,
                            BLK1_PARM3=xxx
                BLK2   BLK2_PARM1=xxx,
                            BLK2_PARM2=xxx,
                            BLK2_PARM3=xxx,
                        BLK2_PARM3=xxx

The parameter members must follow these rules:

1. A source parameter member is divided into blocks. Each block begins at position one (for example, BLK1).

   This step must be performed if CMEM is to be installed at your site. Add the SCHED00 sample member from the INSTCTO library to the SCHEDnn member in the SYS1.PARMLIB library. To protect CMEM control blocks, the PPT entries listed below must be added to the SCHEDnn member, where nn is the number specified in the IEASYSnn member in the SYS1 PARMLIB library, or defaults to 00 if not specified in IEASYS.

   To activate the new PPT definitions without performing an IPL, issue the following command:

   T SCH=(nn,L)

   where nn is the suffix of member SCHEDnn

2. Each block has its own unique parameter. The parameter names are unique and there are no duplicate names in the source parameter member.

3. At least one blank space is required before the parameter name.

4. The comma (',') character is a continuation character that is used when a block spans more than one line.

5. The block ends after the parameter with a value that does not contain the comma (",") character.

6. A Comment line starts with an asterisk ('*') at position one.

   BMC recommends you use ICE to update the source parameters to maintain the integrity of the parameter members.

Operation Libraries

The operation libraries, which are those libraries with high-level qualifiers of OLPREFx, are site libraries. This means that these libraries are populated once during installation, and are not affected by the maintenance process.

INSTxxx Libraries

These libraries, used in the installation process, are considered base libraries and are not resolved. Each job submitted during the installation process is tailored as needed. The tailored member is saved in a new library, ilprefa.INSTWORK. A job can be tailored again, reflecting the updated parameter values, by selecting the ICE step, or by using the TAILOR JOB option in the INCONTROL Installation and Customization Engine (ICE), available by selecting Maintain your Environment => ICE refresh.

Because all jobs submitted during the installation process are tailored as needed, all members referenced in the installation process are located in the ilprefa.INSTWORK library unless specified otherwise.

Customization Activities Affecting All Products

The customization activity from the ICE main menu includes a wide range of activities. The following IOA customization activities affect all INCONTROL products:

Table 8 Customization Activities Affecting all INCONTROL Products

Terminology

Whenever the terms volume serial number or serial number of volume are used in this manual, the maximum number of characters in this field is 6.

Unless otherwise specified, whenever the terms unit name or disk unit are used in this manual, the maximum number of characters in this field is 8.

Installing IOA

The following topics describe the steps required to install IOA. The installation procedure contains step‑by‑step detailed instructions that correspond to the Major and Minor steps in the INCONTROL Installation and Customization Engine (ICE).

• Before You Begin

• IOA Installation Step Checklist

• Installation Steps

If you are not familiar with ICE, review Performing Tasks Common to All Product Installations before proceeding with the IOA installation below.

Before You Begin

Before you start to install IOA, verify that the following hardware and software prerequisites are met.

Supported Hardware

• Processors

  INCONTROL products operate on any OS/390 or zX processors (and other fully-compatible processors) that are supported by the z/OS versions listed in Supported Software.

• Disk storage

  The database of the INCONTROL products can reside on any disk that is supported by z/OS. For example, the following IBM disk types are supported: 3390, 3380, and so on.

  Fully-compatible disks are also supported. This support is transparent.

• EPD or CD installation

  You can download this installation from the BMC Electronic Product Distribution (EPD) site.

• Tape drives

  From version 7.0.00, the IOA installation process does not require a cartridge or tape drive since the IOA installation is performed only from EPD or CD.

Supported Software

• Operating System

  The Job Entry Subsystem can be either JES2 or JES3. MVS version z/OS 1.12 or later is required.

• Required Programs

  The following products (or any functionally equivalent products) are usually required:

  • ACF/VTAM—to support the various environments under which the IOA Online facility can be invoked.

  • TSO/E version 2—to support TSO CLISTs and REXX execs.

  • ISPF and ISPF/PDF version 3 and above are required for installation using ICE, and for product use if the IOA ISPF Online facility will be used.

  • Assembler H or High Level Assembler to support Assembler exit code.

  • DF/SORT—required for some INCONTROL product reports.

  • SMP/E version 31.30 or above.

ICE Application

Verify that you have installed and entered the ICE application, and defined the IOA environment, as describe in Performing Tasks Common to All Product Installations.

Prepare to Install IOA

This procedure describes how to prepare for the IOA installation.

Begin

1. If you currently have more than one environment managed by ICE, make sure that the environment that you want to use as a target for the customization process is selected as the current one. To do this:

2. Enter ICE and select Installation.

3. Select Environment Details.

4. Select the environment.

5. Select Customized installation. The IOA Customized Installation—Main Menu is displayed.

6. Type IOA in the ProductID field.

7. Type 1 in the OPTION field to select option 1, "INSTALL IOA", and press Enter.

8. The Major Steps Selection screen for IOA is displayed, as shown in the following figure. You are now ready to install IOA using ICE.

   Figure 13 Major Steps Selection Screen

   Copy

    ---------------------------- Major Steps Selection ---------------------------
                            COMMAND ===>                                                  SCROLL ===> CSR  
                            Environment: DOC700D   Product: IOA                                            
                            Sel values: S Select step     C Mark step as completed    R Reset status       
                                        B Browse Step     X Mark step as excluded     ? Help               
                            PF7/PF8  To scroll through all Steps                                           
                            -------------------------------------------------------------------------------
                                  Sel Step Status      Opt Description                                     
                                  === ==== ======      === ===========                                     
                                   .    1                  Planning                                        
                                   .    2  *               Parameters for File Allocation                  
                                   .    3                  Load IOA Libraries                              
                                   .    4                  Specify IOA Parameters                          
                                   .    5                  Specify Target Configuration Parameters         
                                   .    6                  Customization Process                           
                                   .    7                  Set Global Variables Database                   
                                   .    8              Y   Install ISPF Support                            
                                   .    9                  Install IOA Subsystem                           
                                   .   10              Y   Install IOA Online Monitor                      
                                   .   11                  Adjustments                                     
                               .   12              Y   IOA Customization                               

IOA Installation Step Checklist

The following list is a summary of the steps required to install IOA. Detailed step‑by‑step instructions follow.

• Step 1 – Planning

• Step 2 – Parameters for File Allocation

• Step 3 – Load IOA Libraries

• Step 4 – Specify IOA Parameters

• Step 5 – Specify Target Configuration Parameters

• Step 6 – Customization Process

• Step 7 – Set Global Variables Database

• Step 8 – Install ISPF Support (Optional)

• Step 9 – Install IOA Subsystem

• Step 10 – Install IOA Online Monitor (Optional)

• Step 11 – Adjustments

• Step 12 – IOA Customization (Optional)

• Step 13 – Setting up Functional Monitors (Optional)

• Step 14 – Install IOA CICS Support (Optional)

• Step 15 – Install IOA IMS/DC Support (Optional)

• Step 16 – Install IOA VTAM Support (Optional)

• Step 17 – Install IOA COM-PLETE Support (Optional)

• Step 18 – Install IOA IDMS/DC Support (Optional)

• Step 19 – Install IOA ROSCOE Support (Optional)

• Step 20 – Install IOAGATE (Optional)

• Step 21 – Install Control-M Application Server

• Step 22 – Install KOA and IOA Routes (Optional)

• Step 23 – Support for Other Products (Optional)

• Step 24 - Java and z/OS Unix Components Configuration

• Step 25 - Installation Conclusion

Installation Steps

Follow the major and minor steps below to install IOA using ICE.

Because all jobs submitted during the installation process are tailored as needed, all members referenced in the installation process are located in the ilprefa.INSTWORK library unless specified otherwise.

Step 1 – Planning

Follow these general planning steps.

Plan the installation process carefully. The IOA Installation Sheet will help you determine the items you should consider before installing IOA.

Determine whether you will require assistance from system programmers, security administrators. or other personnel at your site. Check if any system changes are necessary, as special authorizations and processing may be required. Verify that the necessary configurations are known and planned for in advance.

Proceed to Step 2 – Parameters for File Allocation only when you have completed reviewing the planning sheet.

Step 1.1 – Is the Planning Sheet Complete?

This step verifies that you have filled in the IOA planning sheet.

When you have done so,

1. press PF03/PF15 to exit this screen

2. type C in the Sel field

3. press Enter

The step will be marked as completed.

Step 2 – Parameters for File Allocation

Select major step 2 in the Major Steps Selection screen and follow these steps to specify values for the loading parameters.

Step 2.1 – Workunit

Select minor step 1 in the Minor Steps Selection screen and insert values for the IOA work unit parameters, as shown in the following table:

Table 9 IOA Workunit Parameters

Step 2.2 – Jobcard Parameters

Select minor step 2 in the Minor Steps Selection screen and insert values for the IOA jobcard parameters, as shown in the following table:

Table 10 IOA Jobcard Parameters

JOBNAME=IOAINS01
                                    JOBPOS=15
                                JOBCARD=,IOAINST,CLASS=A,MSGCLASS=X

//IOAINS01    JOB ,IOAINST,CLASS=A,MSGCLASS=X

Step 2.3 – Operation and Maintenance Libraries

Select minor step 3 in the Minor Steps Selection screen and insert values for the IOA operation libraries parameters, as shown in the following table:

When specifying values for parameters or subparameters that include both unit and volume (volser) fields, you must either define both fields, or leave both of them blank. Do not enter a value for only one of them.

Table 11 Operation and Maintenance Libraries

Step 2.4 – SMP CSI Configuration

Select minor step 4 in the Minor Steps Selection screen to display the SMP CSI configuration screens.

Figure 14 SMP CSI Configuration Screen

 ---------------------------- SMP CSI Configuration ------------------------- 
                 COMMAND ===>                                                               
                   Select the desired configuration number ==> 1                             
                                                                                             
                   1. A new CSI:                                                             
                      - Create a CSI containing Global, Target and Distribution              
                        Zones for IOA.                                                       
                                                                                             
                   2. An existing CSI:                                                       
                       - Add IOA definitions to an existing Global Zone.                     
                       - Define new Target and Distribution Zones for IOA in                 
                         this existing CSI.                                                  
                                                                                             
                   3. Separate CSIs for each zone:                                           
                       - Add IOA definitions to an existing Global Zone                      
                   - Create new CSIs for the IOA Target and Distribution Zones           

Create a New CSI

This step specifies the creation of a CSI with global, target, and distribution zones for IOA.

Select 1 to display the SMP CSI Parameters screen for a new CSI:

Figure 15 SMP CSI Parameters Screen 1 (New CSI)

------------------------------ SMP CSI Parameters ----------------------------
                   COMMAND ===>                                                               
                   Selected configuration:                                                    
                                                                                              
                     A new CSI:                                                               
                     - Create a CSI containing Global, Target and Distribution                
                       Zones for IOA.                                                         
                                                                                              
                      PF3/END: Save and exit                 Cancel: Exit without Save        
                ------------------------------------------------------------------------------
                      Specify IOA CSI DSNAME Prefix (e.g for A.B.CSI enter A.B) and Volume    
                                                                                              
                          Prefix (SPCPREF) ==> IOAP.V900                                      
                          Volume (SPCVOL)  ==> NDS901                                         
                                                                                              
                      Specify IOA Target Zone Name       ==> IOA7TZN                          
                  Specify IOA Distribution Zone Name ==> IOA7DZN                          

Insert values for the required parameters and press Enter.

Add IOA Definitions to an Existing CSI

This step specifies adding IOA definitions to an existing global zone, and the definition of new target and distribution zones for IOA in the CSI.

Select 2 to display the SMP CSI Parameters screen for an existing CSI:

Figure 16 SMP CSI Parameters Screen 2 (Existing CSI)

 ------------------------------ SMP CSI Parameters ---------------------------
                 COMMAND ===>                                                                
                 Selected configuration:                                                     
                                                                                             
                    An existing CSI:                                                         
                     - Add IOA definitions to an existing Global Zone.                       
                     - Define new Target and Distribution Zones for IOA in                   
                       this existing CSI.                                                    
                                                                                             
                    PF3/END: Save and exit                 Cancel: Exit without Save         
                 -----------------------------------------------------------------------------
                                                                                             
                    Specify Existing CSI DSNAME Prefix (e.g for A.B.CSI enter A.B)           
                        Prefix (SPCPREF) ==> IOAP.V900                                       
                                                                                             
                    Specify IOA Target Zone Name       ==> IOA9TZN                           
                Specify IOA Distribution Zone Name ==> IOA9DZN                           

Insert values for the required parameters and press Enter.

Add and Create Separate CSIs for Each Zone

This step specifies adding IOA definitions to an existing Global Zone, and the creation of new CSIs for the IOA Target and Distribution Zones.

Select 3 to display the SMP CSI Parameters screen for an existing CSI and create separate CSIs for each zone:

Figure 17 SMP CSI Parameters Screen 3 (Separate CSIs)

 ------------------------------ SMP CSI Parameters ----------------------------
                 COMMAND ===>                                                                
                 Selected configuration:                                                     
                                                                                             
                    Separate CSIs for each zone:                                             
                     - Add IOA definitions to an existing Global Zone                        
                     - Create new CSIs for the IOA Target and Distribution Zones             
                                                                                             
                    PF3/END: Save and exit                 Cancel: Exit without Save         
                 -----------------------------------------------------------------------------
                    Specify Existing CSI DSNAME Prefix (e.g for A.B.CSI enter A.B)           
                        Prefix (SPCPREF) ==> IOAP.V900                                       
                                                                                             
                    IOA Target CSI                                                           
                        Prefix (SPCPREFT) ==> IOAP.V900T                                     
                        Volume (SPCVOLT)  ==>                                                
                                                                                             
                    IOA Distribution CSI                                                     
                        Prefix (SPCPREFD) ==> IOAP.V900D                                     
                        Volume (SPCVOLD)  ==>                                                
                 ------------------------------ SMP CSI Parameters ----------------------------
             COMMAND ===>                                                                

Insert values for the required parameters and press Enter.

Step 2.5 – SMP Data Sets

Select minor step 5 in the Minor Steps Selection screen and insert values for the SMP data sets parameters, as shown in the following table:

Table 12 SMP Data Sets Parameters

Step 2.6 – Define IOA LOADE (PDSE) Library Parameters

Select minor step 6 in the Minor Steps Selection screen and insert values for the IOA LOADE (PDSE) parameters, as shown in the following table:

Table 13 IOA LOADE (PDSE) Library Parameters

Step 3 – Load IOA Libraries

Follow these steps to build IOA libraries.

Step 3.1 – Save Specified Parameters

This step saves all the parameters specified in ICE. Wait until processing completes. The step is automatically marked complete.

This step customizes the DEFPARM member in the IOA.PARM library of the current IOA environment.

Step 3.2 – Allocate IOA Libraries

This step builds the ALLOCIOA job in the IOA INSTWORK library. This job allocates all the IOA libraries.

Submit the job and verify that all steps ended with a completion code of 0.

Step 3.3 – Load IOA Libraries

This step builds the INSTALLI job in the IOA INSTWORK library. This job populates the IOA libraries allocated in the previous step.

Submit the job and verify that all steps ended with a completion code of 0.

Step 4 – Specify IOA Parameters

Follow these steps to insert values for the IOA parameters.

Step 4.1 – Site Software Environment

Modify the values for parameters related to the software at the site.

Table 14 Site Software Environment Parameters

Step 4.2 – IOA Operational Parameters

Insert values for the following IOA operational parameters:

Table 15 IOA Operational Parameters

Step 4.3 – IOA Compatibility Mode

This step defines the compatibility mode for each product.

Valid values are:

• 630 – IOA version 6.3.xx mode.

• 700 – IOA version 7.0.xx mode.

• 800 – IOA version 8.0.xx mode.

• 900 – IOA version 9.0.xx mode.

• 918 – IOA version 9.0.18.xxx mode.

• 919 – IOA version 9.0.19.xxx mode.

• 920 – IOA version 9.0.20.xxx mode.

• 921 - IOA version 9.0.21.xxx mode. Default.

Each product has its own parameter.

Table 16 IOA Compatibility Modes

Step 4.4 – Parameters for "MAIL" and "SNMP" Options

This step enables you to specify values for IOA Shout facility parameters. The modified values are saved in the IOAPARM member in the IOA PARM library.

For more information about the IOA Shout facility parameters, see the chapter about IOA administration in the INCONTROL for z/OS Administrator Guide.

Step 5 – Specify Target Configuration Parameters

Insert values for the following parameters by performing the following steps.

Step 5.1 – IOA Datasets Characteristics

Familiarize yourself with the following data set characteristics to determine the appropriate space calculation for each data set.

IOA Conditions File

The IOA Conditions file consists of:

• 1 physical record for synchronization purposes

• 32 logical records for prerequisite conditions, consisting of:

  • 31 logical records; one for each day of the month

  • 1 logical record for STAT conditions

Each prerequisite condition requires 24 bytes. Therefore, the number of prerequisite conditions that can be stored for each day of a month is 1/24th of the value specified for the record size in the IOA Conditions file, which is 32 KB.

Due to MVS access method limitations, a maximum of 32 KB can be specified for the record size, subject to any disk block size limitation. This default allows a maximum of 1365 prerequisite conditions to be stored in each physical record of the IOA Conditions file.

The CNDREC# parameter, described in Parameters specifies the number of physical records in a logical record.

If your site uses a large number of prerequisite conditions, such as OUT conditions created by Control-M, and you require more than the maximum 32 KB for each record in the IOA Conditions file, additional space can be provided by increasing the value of the CNDREC# parameter.

Use the following formula to calculate the region size needed for the IOA Conditions file:

32760 * ((32 * CNDREC#) + 2 + INT((CNDREC# - 1) / 255) )

Parameters

Table 17 IOA Conditions File Space Calculation

IOA Manual Conditions File

The following parameter is relevant to calculating the space for the IOA Manual Conditions file:

Table 18 Calculating the Size of the Manual Conditions File

Mirror File for IOA Conditions

Specify whether mirror files are to be created and maintained.

Table 19 Additional Parameters

Step 5.2 – IOA Core

Enter values for the IOA Core configuration parameters shown in the following table.

Table 20 IOA Core Configuration Parameters

Step 5.3 – MVS Procedures

Insert values for the following MVS procedure library configuration parameters.

Table 21 MVS Procedure Parameters

Step 5.4 – MVS classes

Specify the following parameters for MVS class configuration.

Table 22 MVS Class Configuration Parameters

Step 5.5 – IOA Log File Space Calculation

The IOA LOG File Space Calculation screen (shown in the following figure) enables you to specify values to calculate the required space allocation.

Figure 18 IOA LOG File Space Calculation Screen

 ------------------------ IOA LOG File space calculation -----------------------
                 COMMAND ===>                                                                   
                 Enter or change values and press Enter.                                        
                 Examine the resulting space requirements.                                      
                 Use this space allocation in subsequent installation steps ? ==>      (Y/N)    
                 Numbers specified must conform to your sites's peak work load.                 
                 -------------------------------------------------------------------------------
                              Number of days to retain LOG records  ==> 7                       
                  CTM/CTR     Maximum Number of jobs per day        ==> 10000                   
                  CTD         Maximum Number of jobs per day        ==> 1000                    
                  CTO/CMEM    Number of rules ORDERED per day       ==> 1000                    
                  CTB         Number of rules invoked per day       ==> 20                      
                 -------------------------------------------------------------------------------
                                                                                                
                 Enter the Block Size to be used for the IOA LOG file, Valid values are:        
                        6200  The standard block size prior to version 6.2.00                   
                       23400  The optimum block size for 3380 DASD devices                      
                       27800  The optimum block size for 3390 DASD devices                      
                 Allocation : Number of blocks  =  130000        (ILBLKNO)                      
                              Number of records =  224200        (LOGSIZE)                      
                              Block Size        =  27800         (ILBLKSZ)                      
                          3380 Tracks       =  130000      3390 Tracks       =  65000       

If you are going to install Control-M, Control-M/Restart or Control‑D, specify the maximum number of jobs to be submitted each day.

If you are going to install Control-M/Analyzer, Control‑O or the CMEM facility of Control-M, specify the maximum number of Control-M/Analyzer, Control‑O or CMEM rules to be processed each day.

The following parameters are calculated by ICE using the numbers specified:

Table 23 IOA LOG File Space Calculation Procedure

Step 6 – Customization Process

The following steps let you customize your IOA installation.

Step 6.1 – Parameter Verification

In addition to the validation checks that are performed during the data entry phase, this step runs a program to verify that various installation parameters do not contain conflicting values. For example, the prefix of the IOA Installation libraries is checked to verify that it is not the same as other INCONTROL product prefixes.

If the step completes successfully, it is automatically marked complete.

If conflicts are identified, a list of warning messages is displayed. The list displays the current values of the conflicting parameters and required corrective actions.

Step 6.2 – Save parameters into IOA Libraries

This step saves all the parameters specified in ICE. Wait until processing completes. The step is automatically marked complete.

This step customizes the DEFPARM and IOAPARM members in the IOA.PARM library of the current IOA environment.

Step 6.3 – Specify IOA Computers (Optional)

This step is used to list, define and characterize the IOA computers. This step must be performed if either Control-O or Control-M are to be installed.

For detailed information about the parameters you can set, see the following table.

Table 24 IOA Computer Parameters

Step 6.4 – Before You Proceed

You have just finished entering values for ICE parameters. The next step submits a job that allocates data sets and tailors members in several libraries. After this job completes, changes to parameters defined in previous steps may require extensive manual modifications or may require restarting the installation process.

Step 6.5 – Resolve IOA Libraries

The IOARSLV job resolves symbolic parameters with the installation values entered.

Submit the job and verify that the step completes with a condition code of 0.

Step 6.6 – Format IOA Data Sets

The FORMIOA job formats the IOA Core.

The following data sets are created and formatted:

Table 25 IOA Data Sets Created and Formatted

Submit the job. All steps must complete with a condition code of 0.

Step 6.7 – Copy IOA Started Tasks Into Site Library

The COPYIOAP job copies IOA started tasks from IOA PROCJCL library into the site library according to values specified earlier.

Submit the job and verify that the step completes with a condition code of 0.

Step 6.8 – Copy Several Procedures to Site Library

This step customizes and copies a small set of selected procedures to the procedure library at the site, that is, the library that was specified in the SITEPROC IOA parameter. This prevents having to add the JCLLIB statement to existing jobs at the site.

Step 7 – Set Global Variables Database

Perform this step to set up the Global Variables database.

WARNING: If this is the first time you are calculating the space for the Databases file, or if you do not have the necessary information available, perform these steps using the default values. Otherwise, review the guidelines for calculating the disk space required for the IOA Variable Database facility in the INCONTROL for z/OS Administrator Guide.

Step 7.1 – Space Calculation for databases File

Specify the values shown in Step 7.2 – Space Calculation for Columns File to calculate the required space allocation for the Variable Database Definition file.

The space requirements are calculated based on the values you specify.

To apply the allocation that has just been calculated, type Y in the Use this space allocation in subsequent installation steps ? field, and press Enter.

Step 7.2 – Space Calculation for Columns File

Insert values for the parameters shown in the following table.

Table 26 Calculating the Space Allocation for the Variable Database Columns File

The space requirements are calculated based on the values you specify.

To apply the allocation that has just been calculated, type Y in the Use this space allocation in subsequent installation steps ? field, and press Enter.

Step 7.3 – Space Calculation for Variables File

Insert values for the parameters shown in the following table.

When specifying values for parameters or subparameters that include both unit and volser fields, you must either define both the Unit and Volser fields, or leave both of them blank. Do not enter a value for only one of them.

Table 27 Calculating the Space Allocation for the Variable Database Variables File

The space requirements are calculated based on the values you specify.

To apply the allocation that has just been calculated, type Y in the Use this space allocation in subsequent installation steps ? field, and press Enter.

Step 7.4 – Format the Global Variables Database

The IOADBGLV job defines the IOA Variables Database file, Columns file and Variables file. Submit the job and verify that all steps complete with a condition code of 0.

Step 7.5 – Load Sample Database

The IOADEMOD job reformats the IOA access method files (DBS, COL, VAR), including the indexes. After formatting, the job loads a few databases for demonstration purposes. Submit the job. All steps of this job must complete with a condition code of 0.

Step 7.6 – IOAPLEX Considerations (Optional)

The XES AutoEdit facility (XAE) allows you to resolve AutoEdit expressions on a Sysplex‑wide level, based on the utilization of Coupling Facility structures. These structures provide the required data sharing mechanisms among the different monitors participating in the Sysplex. These facilities together are called IOAPLEX.

When the XAE facility is active and running, IOAPLEX communicates and validates shared Variable Database variables (in E/CSA memory) registered as such during Control‑O or CTMCMEM monitor startup.

When deciding whether to utilize IOAPLEX or not, it is important to consider the IOA variable database, IOAVAR, and how it is going to be used. If IOAVAR is shared between more than one LPAR, it must be defined as XAE Type 2, and therefore IOAPLEX must be implemented.

Before implementing the XAE facility, do the following:

1. Understand the different types of AutoEdit XAE databases in order to be able to plan for the size of the required Coupling Facility structures.

   For details, see Types of XAE Databases.

2. Plan for the size of the required Coupling Facility structures.

   Use the default values for the first (test) installation. This is described in Step 7.7 – Structure Size Calculation (Optional).

3. Set up the parameters that enable XES processing and XAE processing.

   This is described in Step 7.8 – IOAPLEX parameters (Optional).

4. Add the appropriate CMEM or Control-O (or both) structures to your Coupling Facility resource manager (CFRM) policy.

   This is described in Step 7.10 – Adding IOA Structures to the CFRM (Optional).

   All monitors that will share Variable Databases must be of the same INCONTROL version.

Types of XAE Databases

There are two types of XAE databases, named Type 1 and Type 2:

Table 28 XAE Database Types

Step 7.7 – Structure Size Calculation (Optional)

Familiarize yourself with the following description of structures, and then insert values for the parameters described in the following section:

• Structures

• List Structure

• Cache Structure and Lock Structures

• Reserving Additional Space for LOADGLOBAL Operations

• Parameters

Structures

To keep the CMEM and Control‑O shared variables and perform Sysplex-wide variable processing, CMEM and Control‑O require a list, a cache, and a lock structure.

During space calculations and settings, note that different XES components use different units of allocation for calculation, For example, the STRSIZE parameter of the MVS macro IXLCONN specifies the size of the structure in units of 4 KB (4096 bytes) blocks while the INITSIZE(initsize) or SIZE(isize) used by the Administrative utility of the CFRM specifies the size of the structure in 1 KB (1024 bytes) blocks.

Therefore a structure allocated by the IXLCONN service that specifies STRSIZE=256 requires 1 MB (256 x 4 KB) of Coupling facility storage while the same structure space can be allocated with an INITSIZE of 1024 (1024 x 1 KB).

List Structure

The list structure stores the actual shared variables across the Sysplex environment. The list structure requires from 0 through 4096 bytes per database row, depending on row contents. Each non-null column in a row requires 24 bytes of control information plus n bytes for the value itself. The maximum row length (the larger record in the Coupling Facility) is 4096 bytes.

The following formulas illustrate how to calculate the space requirements for the List structure:

• total_bytes = total-number-of-variables x 32 x 2

  Where

  total-number-of-variables = rows1 x cols1 x LPARs x db1 + rows2 x cols2 x db2

  and the values of rows, cols, and db are according to the number of rows, columns, and databases of Type 1 and Type 2.

  The required storage for each Type 1 list structure database is directly proportional to the number of LPARs (because there is a separate Type 1 database for each LPAR) and to the number of rows and columns.

  The required storage for each Type 2 list structure database is directly proportional only to the number of rows and columns.

  The number of variables in a database is equal to the number of columns times the number of rows.

  The total number of variables in all databases is equal to the sum of the variables in all Type 1 databases, plus the variables in all Type 2 databases.

  The total number of variables in all databases is multiplied by 32 because it is assumed that the average size of a variable is 32 bytes.

  The result is multiplied by 2 because each database needs temporary space for holding the entire database when a LOADGLOBAL operation is performed. See explanation below.

• blocks = total_bytes/1024 (rounded up to a multiple of 4)

  The result is divided by 1024 and then rounded up to next multiple of 4, since the space requested by CFRM policy is in units of 1 Kbytes, while the space required by Control-O/CMEM on startup is in units of 4Kbytes.

  The definition of the maximum number of rows can be changed in the IOA ON-LINE PRIMARY OPTION MENU via the IV screen in ADMIN mode, with the U option for the database. The number of columns can be seen in the IV screen in ADMIN mode when selecting the database (pool).

Cache Structure and Lock Structures

The cache structure together with the lock structure are used to implement a directory-only caching mechanism at the row level, to allow IOA to speed up the resolution of shared Type 2 database variables directly from the ECSA, without the need to get the last value from the Coupling Facility.

The following formulas illustrate how to calculate the space requirements for the Cache structure:

• total_bytes = total-number-of-variables x 64 x 2

  Where

  total-number-of-variables = rows2 x db2

  and the values for rows and db are according to the number of rows and databases of Type 2.

  Type 1 databases do not require cache or lock storage, because there is no need to validate records.

  Type 2 databases require cache and lock storage that are directly proportional to the number of rows in the database.

  The result is multiplied by 64 because it is assumed that on the average 64 bytes are required per row.

  The result is multiplied by 2 because each database needs temporary space for holding the entire database when a LOADGLOBAL operation is performed. See explanation below.

• blocks = total_bytes/1024 (rounded up to a multiple of 4)

  The result is divided by 1024 and then rounded up to next multiple of 4, since the space requested by CFRM policy is in units of 1 Kbytes and the space required by Control-O/CMEM on startup is in units of 4Kbytes.

The Lock structure exists for Type 2 databases only and the space calculations are the same as for the Cache structure.

Reserving Additional Space for LOADGLOBAL Operations

When IOA executes an F CONTROLO,LOADGLOBAL=XAEdatabase command, or an F CTMCMEM,LOADGLOBAL=XAEdatabase command, it starts loading a fresh copy of the database contents. However, the old variable database contents apply up to the moment the database has been completely loaded, when it is possible to switch from the old variables to the new ones. This increases the space requirements, which means that during a LOADGLOBAL, twice the amount of space is required per loaded database. If you set LOADGLOBAL to ALL, twice the total space used is required.

Parameters

Insert values for the following parameters to calculate the size of the IOAPLEX structures. Then press Enter to calculate the space needed for the IOAPLEX structures, and press PF03/PF15 to exit from this screen.

Table 29 Parameters for IOAPLEX Structure Size

Step 7.8 – IOAPLEX parameters (Optional)

Modify the IOAPLEX parameters according to the descriptions below:

Insert values for the following IOAPLEX parameters:

Table 30 IOAPLEX Parameters

Step 7.9 – Build the IOAPLEX Member (Optional)

This step saves the IOAPLEX parameters in the IOAPLEX member in the IOA.PARM library. Wait until processing completes. The step is automatically marked complete.

Step 7.10 – Adding IOA Structures to the CFRM (Optional)

To maintain shared variables and perform Sysplex-wide AutoEdit processing, IOA requires list, cache, and lock structure entries in the CFRM policy couple data set. These entries define IOA structure information to the Coupling Facility.

After preparing the space requirements for the list, cache and lock structures, you can add IOA structures to the CFRM policy. To do so, perform the following:

1. Ensure slots are available for adding IOA structures to the policy.

2. Verify that the available Coupling Facility storage space is large enough to contain the maximum size for the structure data.

3. Create and run the JCL to add the IOA structures to the policy, meaning, to update the policy data set.

These steps are described in the following topics.

Ensuring Policy Slot Availability for IOA Structures

To add the three IOA structure entries, three structure slots must be available in the CFRM policy couple data set. To determine the availability of the structure slots, check the ITEM NAME(STR) NUMBER(xx) parameter, which is used to initialize the CFRM couple data set. This parameter defines the total number of structure slots you can include in your CFRM policy.

To check this structure slot parameter, review the control cards you submitted when you ran the format utility for CFRM couple data sets. If those control cards are unavailable, run the report utility to display the contents of the CFRM couple data set. For the names of these utilities, see the IBM document z/OS V1Rx MVS Setting up a Sysplex. Compare the structure slot parameter number to the number of structures you included in the CFRM couple data set. If you have three additional structure slots, you can continue with Checking Coupling Facility space usage, in the next section.

If you have fewer than three structure slots, use one of the following methods to create additional slots in the policy for IOA structures:

• Delete the required number of unused, existing structure entries from the policy.

• Using the format utility for CFRM couple data sets, create a new couple data set with a larger structure slot parameter, and activate it.

Checking Coupling Facility Space Usage

In addition to the structure slot availability requirement, you must have enough storage space in your Coupling Facility to support the maximum size you specify for the IOA structures. Total the planned size for the list, cache, and lock structures. If your coupling facility does not have enough storage space available, try specifying structures with a smaller maximum size.

To check available Coupling Facility storage space, enter the following command from the MVS console:

DISPLAY CF

An example of the display output is shown below. The FREE SPACE statistic shows the current storage available in each partition of the Coupling Facility.

Figure 19 Checking Coupling Facility Storage Space

D CF
                IXL150I  10.35.43  DISPLAY CF 906 
                COUPLING FACILITY 009674.IBM.02.000000040087 
                                  PARTITION: 2  CPCID: 00 
                                  Control UNIT ID: FFF9 
                NAMED CFPART02 
                COUPLING FACILITY SPACE UTILIZATION 
                 ALLOCATED SPACE                 DUMP SPACE UTILIZATION 
                  STRUCTURES:     602368 K        STRUCTURE DUMP TABLES:        0 K 
                  DUMP SPACE:       2048 K                  TABLE COUNT:        0 
                 FREE SPACE:      411648 K       FREE DUMP SPACE:            2048 K 
                TOTAL SPACE:     1016064 K      TOTAL DUMP SPACE:            2048 K 
                                               MAX REQUESTED DUMP SPACE:        0 K 
                   VOLATILE:         YES         STORAGE INCREMENT SIZE:      256 K 
                    CFLEVEL:           3 
                 
                COUPLING FACILITY SPACE CONFIGURATION 
                                          IN USE          FREE         TOTAL 
                Control SPACE:          604416 K      411648 K     1016064 K 
                NON-Control SPACE:           0 K           0 K           0 K 
                 
                SENDER PATH        PHYSICAL     LOGICAL     STATUS 
                        68         ONLINE       ONLINE      VALID 
                        69         OFFLINE      ONLINE      NOT OPERATIONAL 
                 
                COUPLING FACILITY DEVICE     SUBCHANNEL     STATUS 
                                   FFF0         0DE0        OPERATIONAL/NOT IN USE 
                                   FFF1         0DE1        OPERATIONAL/NOT IN USE 
                                   FFF2         0DE2        OPERATIONAL/IN USE 
                                   FFF3         0DE3        OPERATIONAL/IN USE 
                 
                COUPLING FACILITY 009674.IBM.02.000000040087 
                                  PARTITION: 1  CPCID: 00 
                                  Control UNIT ID: FFFE 
                D CF 
            IXL150I  10.35.43  DISPLAY CF 906 

Updating the Policy Data Set

To add the IOA structure entries to your CFRM policy, submit JCL that runs the administrative data utility that updates your policy data set. Include the syntax for the IOA entries in this JCL. A sample of these IOA entries follows. A copy of it can be found in the IOAXAESD member in the INSTWORK library.

Figure 20 Adding IOA Structure Entries to a CFRM Policy

STRUCTURE NAME(ioaqname_XAELIST)
                       SIZE(size1)               
                       INITSIZE(initsize1)       
                       PREFLIST(cf01,cf02,cf03)  
                       DUPLEX(DISABLED)          
                STRUCTURE NAME(ioaqname_XAECACH) 
                       SIZE(size2)               
                       INITSIZE(initsize2)       
                       PREFLIST(cf02,cf03,cf01)  
                       EXCLLIST(ioaqname_XAELIST)
                       DUPLEX(DISABLED)          
                STRUCTURE NAME(ioaqname_XAELOCK) 
                       SIZE(size3)               
                       INITSIZE(initsize3)       
                       PREFLIST(cf03,cf02,cf01)  
                       EXCLLIST(ioaqname_XAECACH, ioaqname_XAELIST)
                   DUPLEX(DISABLED) 

ioaqname is the value of the IOA QNAME parameter specified during IOA installation.

You specify this name through ICE panels. If you want to use a name for a structure different from the default name, you will need to change the XAELSNM, XAECANM, and XAELKNM parameters in the IOAPLEX member.

For detailed information about the syntax of policy entries and the procedure to use when submitting JCL for policy updates, see the IBM document z/OS V1Rx MVS Setting Up a Sysplex. Your site may have specification conventions different from those shown above.

Consider the following when specifying your policy:

• To change structure size, you must first stop all CONTROLO and CTMCMEM monitors in the IOA installation. Make the appropriate policy change and then restart Control-O or CMEM on each IOA computer in the Sysplex belonging to this IOA installation.

• It is worthwhile to put the structures in different Coupling Facility units. This allows for a maximum degree of request parallelism among the different tasks and avoids overloading structures.

Control-O/CMEM Support of Coupling Facility Structure Rebuild

Control-O/CMEM supports only System-Managed Rebuild and System-Managed Duplexing Rebuild. The original coupling facility must be available for the system to be able make a copy using the System-Managed Rebuild or the Duplexing Rebuild method. The system maintains a hot copy of a Duplex structure in real time on another coupling facility after the Rebuild.

In System-Managed Duplexing Rebuild the Rebuild takes place immediately after the initial creation of the structures and enabling for smooth recovery. The failover of the structures to the alternate copy occurs without any disruption of work for the connectors that are on the non-failed systems.

User-Managed Rebuild and Duplexing Rebuild enables recreating a new copy of the structure on an alternate coupling facility without the availability of the original coupling facility. This is accomplished by making use of the data available to the connectors and requires the implementation of a synchronization protocol between the connectors. This Rebuild process takes place after the failure and causes an interruption to the normal work during the rebuild processing.

Control-O/CMEM does not support User-Managed Rebuild and Duplexing Rebuild, since the User-Managed Rebuild and Duplexing Rebuild require more complex support by the connectors (Control-O/CMEM Monitors), and provide less availability than the System-Managed Duplexing Rebuild.

To provide for smooth recovery and failover of the structures used by Control‑O/CMEM in case of a coupling facility failure, Control-O/CMEM structures must be defined as Duplex and not as Simplex.

Step 7.11 – Calculation of Required ECSA (Optional)

For information on calculating the amount of ECSA needed to store the IOA variables, see the discussion of that topic in the IOA chapter in the INCONTROL for z/OS Administrator Guide.

Step 8 – Install ISPF Support (Optional)

Perform this step if you want to install the IOA ISPF interface support.

To prepare a new IOA Main Menu for ISPF, perform the following actions:

1. Go to the IOA.*.CLIST library.

2. Create a new member in a site library (outside of the IOA.*.CLIST library) and copy the contents of the IOASTART member into it.

3. In the new member, replace ILPREFA() with ILPREFA(your.new current.ILPREFA).

4. Save the new member, and exit from it.

5. Execute the new member.

After completing these actions, mark this step as complete.

After installing ISPF support, perform the following actions:

• Modify the ISPF Menu with IOA options:

  • Add IOA as an option in the screen. This option activates the CLIST IOAISPF.

    Without such a definition, the user must type the TSO command IOAISPF to enter the IOA ISPF Online interface.

  • Add IOAUTIL as an additional option in the screen. This enables the user to enter the IOA ISPF Utilities screen directly, in addition to option 6 of the IOA ISPF Online interface.

• Verify that the following is true:

  • The libraries containing the IOA panels, ISPF tables, skeletons, and TSO CLISTs are concatenated to the appropriate DD statements of the TSO Logon procedures.

  • The CTMUCMDS and CTMCMDS members are copied from the IOA PANEL library to a library that is allocated to DD statement ISPTLIB of the TSO Logon procedure.

  • Sample members CTMPROF and CTMUPROF reside in the IOA PANEL library. These members should be copied to the ISPPROF file of every intended user of IOA under ISPF.

After installing all the required products, you will find that there are only two ISPF skeletons shipped:

• The CTMPSIMS member in the CONTROL-M JCL library

• The CTDCHNAM member in the CONTROL-D JCL library.

Depending on the product installed, concatenate its JCL library to the ISPSLIB DD statement.

If a previous IOA version is installed, the CTMPROF and CTMUPROF members were copied as part of the last IOA installation procedure. Since these members have not changed, only new IOA users need to copy these members.

Step 9 – Install IOA Subsystem

This step installs the IOA subsystem. When completed, mark this step complete.

For details on installing subsystems, see Defining Subsystems.

Step 10 – Install IOA Online Monitor (Optional)

The IOA Online monitor must be installed if the IOA Online facility is activated from CICS, IMS/DC, VMON (an IOA VTAM monitor application), IDMS/DC, COM‑PLETE, TSO (through cross‑memory) or ROSCOE (through cross‑memory).

Step 10.1 – Set IOA Online Monitor Parameters

This step specifies parameters for IOA Online monitors and for routing user transactions to monitors. The parameters are saved in the IOAXPRM member in the IOA.PARM library.

Parameters are displayed on the screen and described below according to category:

Figure 21 The Update IOA Online Monitor Parameters Screen

 ------------------- Update IOA Online Monitor Parameters --------- Row 1 of 2
                 COMMAND ===>                                             SCROLL ==> CSR      
                                                                                              
                  Codes in the Sel field:           Command and Keys:                         
                     D Delete Monitor                  ADD     Add Monitor                    
                     A Add Monitor                     CANCEL  Exit without Save              
                                                       PF3/End Exit and Save                  
                                                                                              
                 Subsystem name      ==>             Dynamic definition    ==>      (Y/N)     
                 VTAM Application    ==>             VTAM generic resource ==>                
                 Default transaction ==>                                                      
                 Balance             ==> Y    (Y/N)  Session timeout     ==>                  
                                                                                              
                 Sel  MONITOR    Max.Ses  Transactions  Timeout                               
                 ===  =======    =======  ===========   =======                               
                      D902MON*   50       DOLV                                                
                 -----------------------------------------------------------------------------
                      A902MON*   10       *             1                                     
                 -----------------------------------------------------------------------------
             ******************************* Bottom of data ******************************

Global Parameters Section

The following parameters relate globally to all online monitors you are defining.

Table 31 Global Parameters

Monitor Parameters Section

The following parameters relate to the online monitors you are defining. If required, you can specify several monitor definitions.

Table 32 Monitor Parameters

Considerations

Consider the following when defining IOA online monitors:

• The monitor name and the transactions can be specified literally, that is, as a complete name, or can include mask characters. The asterisk (*) represents any number (including 0) of characters. The question mark (?) represents a single character.

• Transactions are associated with a given monitor or a group of monitors as follows:

  • The transaction name specified by the user is matched against the values in all existing monitor definitions until a match is found. The transaction is routed to one of the active monitors that matches the monitor name, based on the method specified in the BALANCE parameter.

  • The pattern matching is done according to the order of the monitor definitions and the order of the transaction names.

Step 11 – Adjustments

Follow the steps below to perform adjustments to the IOA installation.

Step 11.1 – IOA LOAD Library

Add the IOA LOAD, IOA LOADE and CTRANS libraries to the authorized Libraries list. To permanently define them as authorized, edit the IEAAPFxx member or the PROGxx member in SYS1.PARMLIB (where xx is the number specified in the IEASYSxx member in SYS1.PARMLIB).

Add the IOA LOAD, the IOA LOADE, and CTRANS libraries and their volumes to the list. The libraries will be authorized after the next IPL.

Dynamically add the APF libraries using the following MVS commands:

SETPROG APF,ADD,DSN=IOA steplib library,VOLUME=volume
                SETPROG APF,ADD,DSN=IOA LOADE library,VOLUME=volume
            SETPROG APF,ADD,DSN=ilprefa.CTRANS,VOLUME=volume

If you have a product that can dynamically add libraries to the authorized Libraries list, such as RESOLVE, you can add a library to the list online and not wait for an IPL. However, the library remains authorized only until the next IPL.

Step 11.2 – Site’s Multiple Access Control (Optional)

When working in a multiple computer installation, adjust any multiple computer access control products, such as GRS, MIM, SDSI, or SUPER‑MSI, that are in use at your site. For more information, see "QNAME" and "CTTQNAM" in Step 4.2 – IOA Operational Parameters.

If the SHRQNAM parameter is specified, it should also be defined to the multiple computer access control product in use at your site.

Step 11.3 – Linklist Considerations (Optional)

If you choose to place the IOA LOAD, IOA LOADE, or CTRANS libraries in the LINKLIST, add their names to the LNKLSTxx member or the PROGxx member in SYS1.PARMLIB.

If you have a product that can dynamically add libraries to the Linklist, such as RESOLVE, you can add them to the list online and not wait for an IPL. However, the library remains in the LINKLIST only until the next IPL.

For information about adding IOA LOAD libraries to the LINKLIST, see the IOA Planning Sheet in Installation Guide Planning Sheets.

Step 11.4 – TSO Logon Procedure (Optional)

The IOA LOAD, IOA LOADE, and CTRANS libraries must be added to the STEPLIB DD statement of the TSO logon procedure of users who should be allowed to use the IOA Online facility.

Step 11.5 – Prepare to Start IOAOMON after IPL (Optional)

If you plan to start the IOA Online monitor after IPL, add the following command to the COMMNDxx member in SYS1.PARMLIB:

S IOAOMON1

Step 12 – IOA Customization (Optional)

After the IOA environment is installed, some customization may be required. Exclude any customization step that does not apply to your site.

Step 12.1 – Extended Color Support (Optional)

When IOA Online facilities are activated from a screen with extended 7‑color support, the INCONTROL products make extensive use of the color attributes of the screen. For information about how to customize colors in IOA, see the INCONTROL for z/OS Administrator Guide.

Step 12.2 – Underscore Suppression (Optional)

Most PC 3270 emulators do not support underscoring (underlining). When a field contains an underscore attribute, it may appear as reverse video on the screen. In some screens, this results in a cluttered appearance.

The USCORE IOA Profile variable controls whether underscoring is used.

• If USCORE is set to NO, underscore is suppressed where specified. Default.

• If USCORE is set to YES, underscore is applied where specified.

You can change the setting of this parameter as follows:

1. In the ICE main window, select Customization.

2. Set the product ID to IOA.

3. Select Product Customization, and press Enter.

4. Select option 3, Profile Variables, and press Enter.

5. Select option 6, Miscellaneous, and press Enter.

Reset the value of USCORE, then press PF03/PF15 repeatedly to exit these menus.

Step 12.3 – Modify INCONTROL Product Defaults (Optional)

After one or more INCONTROL products are installed and running for a period of time, certain defaults can be modified within the product. For example, you can increase the number of Control-M attempts to read a job sysout.

The IOADFLTS documentation member in the IOA DOC library describes the defaults that can be modified for IOA.

For the procedure for changing these defaults, see "Customize IOA defaults" in INCONTROL for z/OS Installation Guide: Customizing.

Step 12.4 – Security (Optional)

This step is relevant if you plan to implement the IOA security interfaces, and your site is using RACF, CA‑ACF2, or CA TOP SECRET.

This procedure activates the security option under ICE.

Begin

1. Select Customization from the Main ICE menu.

2. Select Product: IOA or CTx.

3. Select Security Customization.

4. Step 12.5 – Exits (Optional)

5. There are various User Exits that can be used to modify IOA operations to your needs. For more information, see the Exits chapter in the INCONTROL for z/OS Administrator Guide.

Step 12.6 – National Language Support (Optional)

If you plan to implement the IOA National Language Support (NLS) for French, German, or Japanese, do the following:

1. In the ICE main window, select Customization.

2. Set the product ID to IOA and press Enter.

3. Select Major Step 19, Install National Language Support.

For further information see National Language Support Facility.

Step 13 – Setting up Functional Monitors (Optional)

Perform this step if you want to set up functional monitors.

Step 13.1 – Functional Monitor Considerations

The functional monitor is used for

• communication between Control-M/Tape and other INCONTROL products that use IOA conditions and AutoEdit variables

  This communication is achieved using the DO parameters that call IOA functions, such as DO COND, DO FORCEJOB, DO RESOURCE and DO SET.

• the user notification facility (DO SHOUT)

• communication between Control-M/Tape and

  • automated tape libraries

  • virtual tape servers

Multi-computer and Multi-IOA Considerations

Functional monitors can be configured for a variety of combinations of IOA environments and Control-M/Tape installations, as follows:

• Single IOA Environment

  Only one functional monitor is activated regardless of the number of computers where Control-M/Tape is running in a single IOA environment. The functional monitor must be activated on the computer that has access to all the required files, libraries, and automated tape library interface.

• MultiIOA Environment

  • A functional monitor must be activated in each IOA environment that communicates with Control-M/Tape.

  • If Control-M/Tape is installed in each IOA environment, follow the procedure for a single IOA environment.

  • If you have only one Control-M/Tape installation and you have multiple IOA environments, certain members need to be manually updated in each environment in which you set up a functional monitor. For details, see Adjust Related Members to Other IOA Environments.

  • Each functional monitor distributes IOA functions, such as DO SHOUT, DO CONDITION, DO FORCEJOB, DO RESOURCE, and DO COND to the IOA environment in which it is defined. The monitor is also used to communicate with automatic tape libraries (ATLs).

  • Exit IOAX038 can be used to specify the monitor to be used for each IOA function. This exit is particularly relevant for sites that include a single installation of Control-M/Tape and multiple IOA environments.

For more information about Exit IOAX038, see the Exits chapter in the INCONTROL for z/OS Administrator Guide.

Adjust Related Members to Other IOA Environments

If your site has multiple IOA environments and only one Control-M/Tape installation, perform the following steps for each functional monitor that is not in the environment in which Control-M/Tape is installed:

1. Edit the IOAFMON procedure to the relevant environment. Modify the IOAFMON procedure to point to the IOA files and libraries for this environment.

   In the STEPLIB DDstatement, verify that the IOA LOAD library for the environment in which you set up a functional monitor is specified before the IOA LOAD library for the environment in which Control-M/Tape is installed.

2. Edit the ALCFMON member in the IOA.PARM library, and modify it to point to appropriate files and libraries.

3. Use the INSTFMON job to allocate a different checkpoint file for each functional monitor. For further instructions, see Step 14.3 – Copy Load Modules to DFHRPL.

Determining the Execution Environment

By default, each functional monitor can perform IOA events triggered, for example, by Control-M/Tape DO statements. However, you can use Exit IOAX038 to control which monitor performs specific events. For more information, see the sample exit in the IOAX038A member in the IOA SAMPEXIT library. This exit allows each functional monitor to handle only requests that were created on the computer in which it is running.

IOA Dynamic Destination Table

One of the facilities that uses the functional monitor is the Shout facility. It allows the user to specify messages to be sent to various destinations upon occurrence of various execution events.

Destinations in a production environment are not necessarily fixed. For example, the TSO user ID of the Shift Manager might be different in every shift. The Dynamic Destination table allows the user to specify a group name destination and the final destinations indicated by the name. A group destination name can also be defined to distribute information to multiple destinations.

Before using the IOA Shout facility services, you must build and define the parameters in the IOADEST sample member in the IOA PARM library. For more information about the Dynamic Destination table and its parameters, see the Dynamic Destination Table section in the INCONTROL for z/OS Administrator Guide.

Step 13.2 – Allocate Functional Monitor Checkpoint File

The INSTFMON job creates the functional monitor checkpoint file. Do not modify the space definitions.

Submit the job. The job step must end with a condition code of 0.

Step 13.3 – Start the Functional Monitor

Start the functional monitor using the S IOAFMON operator command. This command must be issued for each monitor defined in the above steps.

To start the IOA functional monitor after each IPL, specify the S IOAFMON operator command in the COMMNDxx member in SYS1.PARMLIB.

Step 14 – Install IOA CICS Support (Optional)

Follow the steps below if you want to install IOA CICS support. This provides an interface to the IOA Online monitor.

When completed, mark each step complete.

Step 14.1 – IOACICS Source Customization

Review the IOACICS module in the IOA CICSSAMP library. Verify that the following IOACICS customization options meet site requirements:

1. Exit program using the Clear key.

2. Suppress "end" message CTM013I.

3. Bypass the READPARTITIONQUERY command.

4. Bypass COLOR support.

5. Use NATURAL/CICS or the user menu to invoke IOACICS from other CICS applications.

6. Check SYSLIB, SYSLIBA, and other libraries to ensure that they match the specifications for your site.

Step 14.2 – Compile and Link CICS Program

The IOACICSJ job assembles and links the IOACICS module. This module performs all the CICS‑related functions under the CICS interface. Due to CICS version dependencies, which are changes in CICS basic commands, the IOACICS module must be assembled using the DFHEITAL procedure or equivalent. This procedure executes the CICS pre‑processor and assembles and linkedits the module. The IOACICS module resides in the IOA CICSSAMP library. Customization instructions are provided in the module.

While in ICE, modify any necessary JCL statements, as instructed in the jobs, and submit the job. Verify that the preprocess, assembly and link‑edit steps complete successfully.

Step 14.3 – Copy Load Modules to DFHRPL

Check the DFHRPL DD statement of the CICS procedure used at your installation. The following load modules must be copied from the IOA LOAD library to one of the libraries allocated to the DFHRPL DD statement in the CICS procedure:

• IOACICS

• IOAX037

• IOAX009

• IOASE09

• CTMSUSIE

• IOACICNV

• IOAJPED

• CTMCINT

• IOAENV

For information about Exit IOAX009, see the Exits chapter in the INCONTROL for z/OS Administrator Guide. For information about the IOASE09 security module, see the INCONTROL for z/OS Security Guide.

Step 14.4 – Add Resource Definitions

Add a TRANSACTION entry for each transaction type.

Figure 22 Adding Resource Definitions Example - TRANSACTION

      DEFINE TRANSACTION (transaction_name)
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA TRANSACTION) 
                               PROGRAM      (IOACICS) 
                               SPURGE       (YES) 
                               TPURGE       (YES) 
                               TWASIZE      (0) 
                               TASKDATALOC  (ANY) 
                               TASKDATAKEY  (CICS) 
                           ISOLATE      (NO) 

MRO is supported in the following way: The defined transaction is pseudoconversational. The first transaction of the defined name that a user issues (transaction_name above) can be routed to any AOR. In this AOR a session is established with a specific IOAOMON, and the user must be routed back to the same IOAOMON. Therefore, all subsequent instances of transaction_name after the first one in a specific session must be routed back to the same AOR. Such support is possible when transaction_name is defined in CICS as an AFFINITY GROUP with relation of LUNAME and lifetime of PCONV.

The following predefined transactions are available in IOA, and they can be found in the IOA IOAENV library: BMAN, DFTR, DMAN, DOLV, TMAN, TMNO, and TMNT. If you need to make changes in any transaction, copy the member to the IOA PARM library and make your changes there.

Add the following program definitions:

Figure 23 Adding Resource Definitions Example - Program Definitions

      DEFINE PROGRAM        (IOACICS)
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                               EXECKEY      (CICS) 
                 
                      DEFINE PROGRAM        (IOACICNV) 
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                               EXECKEY      (CICS) 
                 
                      DEFINE PROGRAM        (IOAX009) 
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                               EXECKEY      (USER) 
                 
                      DEFINE PROGRAM        (IOASE09) 
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                               EXECKEY      (USER) 
                 
                      DEFINE PROGRAM        (IOAX037) 
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                               EXECKEY      (USER) 
                 
                      DEFINE PROGRAM        (CTMSUSIE) 
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                               EXECKEY      (USER) 
                 
                      DEFINE PROGRAM        (IOAJPED) 
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (BELOW) 
                           EXECKEY      (USER) 

The program definition (CTMSUSIE) is mandatory. If you intend to install French, German, or Japanese language support, you must also add one or more of the following program definitions:

• French language support

      DEFINE PROGRAM        (CTMSUSIF)
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                           EXECKEY      (USER) 

• German language support

      DEFINE PROGRAM        (CTMSUSIG)
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                           EXECKEY      (USER) 

• Japanese language support

      DEFINE PROGRAM        (CTMSUSIJ) 
                               GROUP        (IOA) 
                               DESCRIPTION  (IOA PROGRAM) 
                               LANGUAGE     (ASSEMBLER) 
                               DATALOCATION (ANY) 
                           EXECKEY      (USER) 

In some versions of CICS, you may need to shut down CICS to update the PPT and PCT. In later versions, the update can be performed online using CEDA if they are new. If they are old, a NEWCOPY is enough.

If security for CICS system programmer commands is in use, add the IOACICNV load module to the CICS PLT table.

Step 14.5 – Required IOA Libraries

Add the following DAPARM DDstatement to the CICS procedure:

//DAPARM  DD DISP=SHR,DSN=ilprefa.PARM
                    //        DD DISP=SHR,DSN=ilprefa.IOAENV

In this statement ilprefa is the IOA installation libraries prefix.

Step 15 – Install IOA IMS/DC Support (Optional)

Follow the steps below if you want to install IOA IMS/DC support. This provides an interface to the IOA Online monitor.

When completed, mark each step complete.

Step 15.1 – Link IMS/DC Routine

The LINKIMS job links IMS/DC code.

Modify the IMS RESLIB library name, and submit the job. All job steps must complete with a condition code of 0.

As a result, linkage for IMS/DC version‑dependent routines is performed.

Step 15.2 – Define Transaction Codes and PSB

Define a special PSB for IOA IMS/DC support. The PSB must contain only one IOPCB.

The following is an example of PSB parameters:

//S1       EXEC PSBGEN,MBR=IOAIMS//C.SYSIN  DD * 
                           PSBGEN LANG=ASSEM,PSBNAME=IOAIMS,CMPAT=YES
                           END
            //

Define the IOA transaction codes using the following parameters:

APPLCTN PSB=IOAIMS,PGMTYPE=TP
                TRANSACT CODE=transaction-name,
                MSGTYPE=(SNGLSEG,RESPONSE,2),
                INQUIRY=(YES,RECOVER),
                MODE=SNGL,
            SPA=(32000,DASD,FIXED)

For a valid transaction_name, see the description of the TRANID parameter in the INCONTROL for z/OS Administrator Guide.

Step 15.3 – Required IOA Libraries

1. Add the following DAPARM DDstatement to the IMS/DC procedure:

   Copy

   //DAPARM     DD DISP=SHR,DSN=ilprefa.PARM
                       //           DD DISP=SHR,DSN=ilprefa.IOAENV

   In this statement ilprefa is the IOA installation libraries prefix.

2. If the IOA LOAD library is not included in the linklist, add it to the list of STEPLIB libraries.

Step 16 – Install IOA VTAM Support (Optional)

Follow the steps below to install the IOA VTAM support. When completed, mark each step complete.

Step 16.1 – Define a VTAM Application

The IOA VTAM Online facility must be defined in the VTAM definition library (SYS1.VTAMLST). It requires only one VTAM application ID, and can be defined as an independent MAJOR NODE or as a MINOR NODE. The VTAM application name should be the same as the value of the ACBNAME, which is defined in the IOAXPRM member. For details, see Step 10 – Install IOA Online Monitor (Optional).

The following is an example of a MAJOR NODE definition:

IOAAPPL     VBUILD     TYPE=APPL
            CTMS        APPL       EAS=200,ACBNAME=CTMS,AUTH=(SPO,ACQ)

In this example 200 is the number of buffers.

Define the application to VTAM by creating a member named IOAAPPL in the SYS1.VTAMLST library based on the above example.

Step 16.2 – Activate the VTAM Application Definition

The VTAM application should always be active; therefore, it should be defined in the ATCCONxx member in the VTAM definition library.

To activate the VTAM application manually, use the following VTAM command:

VARY NET,ACT,ID=IOAAPPL

Step 16.3 – Start the IOA VTAM Monitor

To start and test the IOA VTAM monitor, at least one INCONTROL product, such as Control-M or Control‑D, must be installed. After an INCONTROL product is installed, start the IOA VTAM monitor by using the following system command:

S IOAVMON

To test the facility, specify the following LOGON command:

LOGON APPLID(CTMS) DATA(xxxx)

APPLID should have the same value that is specified in the ACBNAME parameter in the IOAXPRM member. The DATA parameter represents the transaction name.

If the DATA parameter is not specified, it defaults to the application ID assigned to the DEFTRAN parameter in the IOAXPRM member.

To access the IOA VTAM facility from the main VTAM menu, modify the standard USS table, or create a special USS table.

The USS table should contain command entry codes, such as DMAN, TMND, and DOLV. Define each new command in the USS table as follows:

Figure 24 New Commands in the USS Table

trans-name  USSCMD CMD=command-name,REP=LOGON 
                            USSPARM PARM=P1,REP=APPLID,DEFAULT=acb-name
                        USSPARM PARM=P2,REP=LOGMODE 

The default for REP=APPLID should have the same value that is specified in the ACBNAME parameter in the IOAXPRM member. For details, see Step 10 – Install IOA Online Monitor (Optional).

The entry command names should conform to the standards and conventions used. Duplicate the four lines shown above for each transaction code used at your site.

To accept the modified USS table, the VTAM VARY command can inactivate (INACT) and then activate (ACT) the local node.

Step 16.4 – Modify the USS Table

To access the IOA VTAM facility from the main VTAM menu, modify the standard USS table or create a special USS table.

The USS table should contain command entry codes, such as IALL and DOLV. Define each new command in the USS table as shown in Step 16.3 – Start the IOA VTAM Monitor.

The default for REP=APPLID should have the same value as specified in the ACBNAME parameter in IOAXPRM. For details, see Step 10 – Install IOA Online Monitor (Optional). The default parameter for DATA represents the transaction name.

The entry command names should conform to the standards and conventions used at your site. Duplicate the four lines shown in Step 16.3 – Start the IOA VTAM Monitor for each transaction code used at your site. To accept the modified USS table, the VTAM VARY command can inactivate (INACT) and then activate (ACT) the local node.

Step 17 – Install IOA COM-PLETE Support (Optional)

Follow the steps below to install IOA COM‑PLETE support. When completed, mark each step complete.

Step 17.1 – Compile and Link COM-PLETE Program

The IOACPLJ job assembles and links the IOACPL module. This module performs all the COM‑PLETE related functions under the COM‑PLETE interface. Due to COM‑PLETE version dependencies (that is, changes in COM‑PLETE basic commands), the IOACPL module must be assembled and linkedited.

While in Edit, modify any necessary JCL statements, and submit the job. All steps must complete with a condition code of 0.

For users who use SMP/E:

• Step CPLSMP will RECEIVE and APPLY a USERMOD CPL0001 to implement COMPLETE support.

• Program IOACPL has several aliases. For details, see Step 17.2 – Catalog the IOA Programs.

Step 17.2 – Catalog the IOA Programs

Catalog the programs in COM‑PLETE as privileged programs. Specify a region size of at least 100 KB for IOACPL.

Verify that the following modules can be accessed from the COM‑PLETE address space:

• IOACPL

• IOAX009

• IOASE09

• IOAX037

• CTMSUSIE

• IOACICNV

• IOAJPED

For information about Exits IOAX009 and IOAX037, see the Exits chapter in the INCONTROL for z/OS Administrator Guide. For details about the IOASE09 security module, see the INCONTROL for z/OS Security Guide.

Step 17.3 – Required IOA Libraries

1. Add the DAPARM DDstatement to the COM-PLETE procedure:

   Copy

   //DAPARMDD DISP=SHR,DSN=ilprefa.PARM
                       //DD DISP=SHR,DSN=ilprefa.IOAENV

   In this statement ilprefa is the IOA installation libraries prefix.

2. If the IOA LOAD library is not included in the linklist, add it to the list of STEPLIB libraries.

Step 18 – Install IOA IDMS/DC Support (Optional)

Follow the steps below to install IOA IDMS/DC support. When completed, mark each step complete.

Step 18.1 – Compile and Link IDMS/DC Program

The IOAIDMSJ job assembles and links the IOAIDMS program. This module performs all the IDMS/DC‑related functions under the IDMS/DC interface. Due to IDMS/DC version dependencies (that is, changes in IDMS/DC basic commands), the IOAIDMS module must be assembled and linkedited.

While in Edit, modify any necessary JCL statements, and submit the job. All steps must complete with a condition code of 0.

SMP/E Users:

Step IDMSSMP will RECEIVE and APPLY a USERMOD IDMS001 to implement the IDMS/DC support.

This step should be repeated whenever the IDMS/DC version is changed.

Step 18.2 – Modify IDMS/DC SYSGEN

1. Add a task to the IDMS/DC SYSGEN for each task type.

   ADD TASK taskname INVOKES IOAIDMS INPUT

2. Add the following programs, using the specified SYSGEN definition statements:

   Table 33 Programs to Add to Modify IDMS/DC SYSGEN

   Program	Description
   ADD PROGRAM IOAIDMS	ISA SIZE 512 LANGUAGE ASSEMBLER
   ADD PROGRAM IOAPARM	ISA SIZE 512 LANGUAGE ASSEMBLER
   ADD PROGRAM IOAX009	ISA SIZE 512 LANGUAGE ASSEMBLER
   ADD PROGRAM IOAX037	ISA SIZE 512 LANGUAGE ASSEMBLER
   ADD PROGRAM IOASE09	ISA SIZE 512 LANGUAGE ASSEMBLER

Step 18.3 – Required IOA Libraries

1. Add the following DAPARM DDstatement to the IDMS/DC procedure:

   Copy

   //DAPARMDD DISP=SHR,DSN=ilprefa.PARM
                       //DD DISP=SHR,DSN=ilprefa.IOAENV

   In this statement ilprefa is the IOA installation libraries prefix.

2. If the IOA LOAD library is not included in the linklist, add it to the list of STEPLIB libraries.

   Turn off storage protection for the IOAIDMS module. This is necessary due to the method by which the IDMS/DC address space (through the IOAIDMS module) interacts with the IOA Online Server.

Step 19 – Install IOA ROSCOE Support (Optional)

Follow the steps below to operate the IOA Online facility under ROSCOE.

When completed, mark each step complete.

Step 19.1 – Copy ROSCOE RPFs

The ROSLB library contains ROSCOE RPFs and panels.

1. Copy the ROSLB library to a work library and resolve the symbolic parameters with the IOAINSJ job in the IOA JCL library.

2. Copy the resolved members to the appropriate ROSCOE libraries.

Step 19.2 – Verify that ROSCOE/ETSO is installed

Verify that the ROSCOE/ETSO feature is installed and active. Define the IOA LOAD library in the ETSOLIB DD statement in the ROSCOE JCL.

Step 19.3 – Define IOA programs in eligible program list

Define the following IOA online programs in the eligible list of the ROSCOE/ETSO:

• CTDBRQ

• CTMJOB

• CTMTJRQ

• CTDPRQ

• CTMCTSO

• CTDRRQ

• IOASE09

• CTDSRQ

• IOATBMN

• CTMAES

• IOAX037

• CTMCND

• IOAX009

• IOALOC

• IOALLOC

• IOAENV

This list usually resides in the RO.ETSOPGMS member and must be sorted by program name in ascending order.

Define these programs with at least 1 MB of memory, although they usually require much less. Do not define these programs as Command Processor (CP).

Set the maximum number of allocations of an ETSO program to at least 50, using the ETSALLOC global ROSCOE parameter. For example, type ETSALLOC=50

Step 19.4 – Set up IOA SHOUT facility

If IOA Shout messages (notifications) are used for ROSCOE users, verify that the ROSCOE initialization deck contains the NOTIFY=xxxx statement (or ROSID=xxxx in newer versions). xxxx usually defaults to ROSC.

Regular IOA SHOUTs can then be defined to the destination TSO xxxxpp. In that destination

• xxxx is the name that is specified as NOTIFY=xxxx (or ROSID=xxxx) in the ROSCOE initialization deck.

• pp is the ROSCOE user’s prefix (not key). The prefix consists of two or three characters.

Step 19.5 – Required IOA Libraries

Add the following DAPARM DD statement to the COM-PLETE procedure:

//DAPARM  DD DISP=SHR,DSN=ilprefa.PARM
            //        DD DISP=SHR,DSN=ilprefa.IOAENV

In this statement ilprefa is the IOA installation libraries prefix.

Step 20 – Install IOAGATE (Optional)

This major step consists of a series of minor steps that install the IOA Gateway. Perform the steps below. As you complete each step, mark it complete.

Step 20.1 – Installation Considerations

Read IOAGATE Installation and Configuration Considerations for a complete explanation of IOAGATE, its components and its configuration. This section also includes information on all aspects of IOAGATE installation and configuration.

For information about installing the Control-M Configuration Manager Application Server (CTMCAS), see Step 21 – Install Control-M Application Server.

The following is a general overview of the components of IOAGATE.

IOAGATE is a mainframe software communications gateway (middleware) that enables IOA mainframe applications to communicate with other mainframe and non-mainframe applications over the network.

The Application Server is a separate address space distinct from the IOAGATE address space. It is started by IOAGATE according to IOAGATE parameters. The responsibility of the Application Server is to handle the application logic, while IOAGATE performs the actual communications and passes the messages between the clients and the Application Servers.

Client applications access INCONTROL products through an IOAGATE Application Server. Each Application Server address space communicates with its corresponding INCONTROL product either directly or by means of files.

IOAGATE does not support access to INCONTROL products from 3270-mode terminals or 3270-mode terminal emulation.

Figure 25 IOAGATE as Middleware for INCONTROL Products

The following INCONTROL products are supported:

Table 34 INCONTROL Products Supported by IOAGATE

IOAGATE supports multiple concurrent application servers of different applications and their clients. A single IOAGATE can support all the Application Servers shown above.

When you have read IOAGATE Installation and Configuration Considerations mark this step complete.

Step 20.2 – Configure IOAGATE Parameters

Multiple IOAGATEs can be started concurrently.

The parameters of each IOAGATE are defined in the ECAPARMx member of each IOAGATE in the IOA.PARM library, where x is a unique 1‑character suffix to the member name. The specific ECAPARM member to be loaded and used by a specific IOAGATE is specified by the PSFX parameter at IOAGATE startup. For example, PSFX=X is used with the ECAPARMX member.

When this option is selected, the IOAGATE Parameters Menu is displayed:

Figure 26 IOAGATE Parameters Menu

 --------------------------- IOAGATE Parameters Menu -------------------------
                 OPTION  ===>                                                                
                 Parameter Member:                                                           
                                                                                             
                  0  ECAPARMx     - Select the ECAPARMx (x=suffix)                           
                  1  Application  - Define/Update Application Server                         
                  2  Channel      - Define/Update Channel                                    
                  3  Global       - Global IOAGATE Parameters (Optional)                     
              4  Build        - Build the Parameter Member                               

1. Select option0, ECAPARMx, to specify the name of the ECAPARMx member you want to edit. Type the name and press Enter. The parameter member name you specified is displayed at the top of the IOAGATE Parameters Menu screen.

2. Select option1, Application, to create or update application servers. This is where you specify the application servers in use at your site, meaning, Control-D/Page On Demand and Control-D File Transfer option, Control-M, Control-O, Control-M JCL Verify, or any of these. The Create/Update Application Server screen is displayed:

Figure 27 Create/Update Application Server Screen

 --------------------- Create/Update Application Server ----------------------
                 COMMAND ===>                                              SCROLL ==> CSR     
                                                                                              
                  Codes in the Sel field:            Command and Keys:                        
                     D Delete Application Server        Add     To Add an application server  
                     A Advanced Parameters              PF3/End Exit                          
                                                                                              
                 Sel  Appl          Channel  Procname                                         
                 ===  ============  ======   ========                                         
             ******************************* Bottom of data ******************************

From this screen you can add a new application, by typing Add in the COMMAND field and pressing Enter.

You can also type the options shown in the following table to perform the actions shown in the table.

Table 35 Options in the Create/Update Application Server Screen

Add a New Application Server

When you type Add in the COMMAND field, the Add New Application Server screen is displayed:

Figure 28 Add New Application Server Screen

------------------------- Add New Application Server ------------------
                COMMAND ===>                                                                   
                                                                                               
                 Type Application Server details and press Enter to Save                       
                 Press PF3 to exit                                                             
                                                                                               
                    Application. ==>     D Control-D/POD    M Control-M     O Control-O 
                                         F Control-D/FTO    C Control-M/CM             
                                                                                               
                    Channel..... ==>                                                           
                                                                                               
                                                                                               
                    Procedure... ==>    Defaults: IOAAS  - for Application D/F         
                                                  CTMAS  - for Application M           
                                                  CTOAS  - for Application O           
                                                  CTMCAS - for Application C           
                                              CTJAS  - for Application J           

For each application server you want to add, insert values for the parameters shown in the following table and press Enter.

The Control‑D/Page On Demand (D) application supports multiple Application Server address spaces for the same application.

For a large number of concurrent connections (100 or more), it is recommended that at least 4 application servers be defined.

Table 36 Parameters for the Add New Application Server Screen

Delete an Application Server

Type D in the Sel field of any row containing an Application Server, and press Enter. The Application Server definition is deleted.

Advanced Parameters

To insert values for advanced parameters, type A in the Sel field of any row containing an Application Server. The following screen is displayed:

Figure 29 Application Server Advanced Parameters Screen

 ------------------- Application Server Advanced Parameters ------------------
                 COMMAND ===>                                                                 
                                                                                              
                  Fill the following fields and press Enter to Save                           
                  Press PF3 to exit                                                           
                                                                                              
                  Application name: M             Channel: O1      Procname: CTMAS            
                                                                                              
                 Non-Swappable............(NONSWAP)  ==>           (YES/NO)                   
                 Compression..............(COMPRESS) ==>           (YES/NO)                   
                 No. of server tasks......(NUMSRV)   ==>           (1-200 For Appl=D,F only)  
                 Automatic recoveries.....(MAXRECOV) ==>           (0-99)                     
                 Encryption     ..........(ENCRYPT)  ==>           (NO,YES)for Appl=D         
                 Enable/Disable...........(SERVER)   ==>           (Enable/Disable)           
                                                                                              
                 Time intervals                                                               
                 --------------                                                               
                 Server wait interval.....(SLEEPINT) ==>           (3-30   sec)               
                 Server timeout...........(TIMEOUT)  ==>           (1-7200 sec)               
                 Service duration.........(SERVDUR)  ==>           (0-3600 sec)               
                 Warning repeater.........(NWARNING) ==>           (0-99 SERVDUR interval)    
                 Startup duration.........(STRTDUR)  ==>           (30-999 sec)               
                 Abnormal status duration.(STATDUR)  ==>           (0-7200 sec)               
             Busy duration threshold..(BUSYDUR)  ==>           (0-999  min)               

The parameters in this screen have defaults that generally need not be changed. First-time installers should refrain from changing them.

Table 37 Application Server Advanced Parameters

When you have finished inserting values for advanced parameters, press Enter to save these values, and then press End to return to the Create/Update Application Server screen.

Creating/Updating Channels

1. Select option 2, Channel, to create and/or update channels.

2. The Create/Update Channel screen displays.

   Figure 30 Create/Update Channel Screen

 ---------------------------- Create/Update Channel --------------------------
                  COMMAND ===>                                              SCROLL ==> CSR    
                                                                                              
                   Codes in the Sel field:           Command and Keys:                        
                      D Delete Channel                  Add     To Add a Channel              
                      A Advanced Parameters             PF3/End Exit                          
                                                                                              
                                                                                              
                  Sel  Id  Model     Protocol  Port   APPLID                                  
                  ===  ==  ========  ========  =====  ========                                
              ****************************** Bottom of data ******************************

From this screen you can add a new channel, as described in the following section, Adding Channels.

You can also type the options shown in the following table to perform the actions shown in the table.

Table 38 Options in the Create/Update Channel Screen

Adding Channels

Type Add in the COMMAND field in the Create/Update Channel screen, and press Enter.

The Add New Channel screen is displayed.

Figure 31 Add New Channel Screen

------------------------------- Add New Channel ------------------------------
                 COMMAND ===>                                                                   
                                                                                               
                 Type Channel details and press Enter to Save                                  
                 Press PF3 to exit                                                             
                                                                                               
                   Channel ID........................... ==>                                   
                                                                                               
                   Communication Model.................. ==>                       (MC/DC)     
                                                                                               
                   Communication Protocol............... ==>                       (TCP/SNA)   
                                                                                               
                   TCP/IP port number................... ==>                       (1024-65534)
                                                                                               
                   VTAM LU6.2 APPLID.................... ==>                                   
                                                                                               
                   IP Addresses Validation.............. ==> NO                    (Yes/No)    
                   ECAIPLS Member Name suffix........... ==>                                   
                                                                                               
                --------------------------------------------------------                       
                PORT specification:                                                            
                The following default IOAGATE ports are defined on the desktop side:           
                2370 for CTMAS communications with CTM/EM                                      
                2369 for CTMCAS communications with CTM/CM
            If you want to use the desktop defaults then specify these ports accordingly here.

For each channel you want to add, do the following:

• Insert values for the parameters shown in the following table.

• When you have finished entering values for the parameters of that channel, press Enter.

Table 39 Parameters for Adding a New Channel

When you have finished adding new channels, press PF03/PF15. The channels will be displayed on the Create/Update Channel screen.

Deleting an Existing Channel

Type D in the Sel field of any row containing a channel and press Enter. The channel defined in that row is deleted.

Specifying Advanced Channel Parameters

To specify advanced parameters, do the following:

1. Type A in the Sel field of any row containing a channel.

2. Insert values for the advanced parameters you want to specify.

3. Press Enter to save these values.

4. Press End to return to the Create/Update Channel screen.

Different advanced parameters are displayed according to the type of channel you are updating. The following table contains an inclusive list of all the advanced parameters that can be specified:

Table 40 Advanced Parameters for Creating/Updating Channels

Global IOAGATE Parameters

In the IOAGATE Parameters Menu screen, option 3, Global, updates global IOAGATE parameters. This step is optional.

Type 3 in the OPTION field and press Enter. The Parameter Data Entry screen is displayed.

The parameters of the Parameter Data Entry screen have defaults that generally need not be changed. First-time installers should refrain from changing them.

Table 41 Parameter Data Entry Screen Parameters

If errors occur while building ECAPARM, the errors are displayed. Correct the errors and select this option again.

When you are satisfied with the values that are displayed, press PF03/PF15. This will save the parameters and exit this screen to the IOAGATE Parameters Menu.

This step will automatically be marked complete.

Build the Parameter Member

In the IOAGATE Parameters Menu screen, option 4, Build, build the IOAGATE parameters member, ECAPARMx, specified in option 0, based on the values specified in steps 1 (Application), 2 (Channel) and 3 (Global).

Special Global IOAGATE Parameters

Certain IOAGATE parameters cannot be set by means of ICE. You can only set these special IOAGATE parameters by adding them manually to the GATEWAY section of ECAPARM.

Table 42 Special CCM Parameters

Step 20.3 – Set up IOAGATE Procedure(s)

A default IOAGATE procedure is provided in the PROCJCL library. This IOAGATE procedure is configured to use the ECAPARM member in the IOA.PARM library. This ECAPARM member does not exist until it is built with a blank suffix. The ECAPARM member that is to be loaded and used by an individual IOAGATE is identified by the value x specified in PSFX=x in the procedure used for IOAGATE startup.

For example, the expression PSFX= (with no value), is associated with the ECAPARM member and the expression PSFX=X is associated with the ECAPARMX member.

If more than one IOAGATE will be started, corresponding, unique ECAPARM members must be created, each differentiated by a unique 1‑character suffix in the member name. An individual procedure must be created for each IOAGATE, by duplicating and renaming the provided default procedure. Each procedure must specify its corresponding ECAPARMn suffix in the PSFX parameter.

After you have set up the IOAGATE procedures, mark this step complete.

Step 20.4 – Specify TCPDATA (TCP/IP Only) (Optional)

Defining the TCP/IP Data File

From the MVS TCP/IP perspective, IOAGATE is one of its client applications. As such, IOAGATE needs a client profile data set, hlq.TCPIP.DATA, which is specified using the //SYSTCPD DD statement.

This is the main resolver configuration data set that contains information on the host name, domain origin, and so on. In addition, this data set also contains the TCPIPJOBNAME parameter that identifies the TCP/IP stack to use.

For more information on this data set, see the z/OS V1Rx Communications Server IP Configuration Reference.

When the //SYSTCPD DD statement is not specified, the standard client searches for hlq.TCPIP.DATA in the following sequence:

1. jobname.TCPIP.DATA for batch jobs and started tasks

2. SYS1.TCPPARMS(TCPDATA)

3. TCPIP.TCPIP.DATA

   The default hlq distributed with TCP/IP is the string TCPIP. When found, the data set is dynamically allocated.

If the client profile data set name does not conform to the conventions described above, and as a result cannot be found using the standard search order, the data set should be allocated by the //SYSTCPD DD statement. Otherwise, the DD statement can be omitted.

The issue should be discussed and agreed upon with the local MVS/TCP system network staff.

To assign the proper SYSTCPD data set, use the TCPDATA parameter in the IOAGATE member of the PROCJCL library.

When you have specified the TCPDATA, mark this step complete.

Step 20.5 – Specify RACF Authorizations

1. To connect using TCP/IP, you must define a proper OMVS RACF segment for the userID and GroupID associated with the IOAGATE started task.

   For details on defining an OMVS RACF segment, see the appropriate IBM documentation for this topic.

   Users of TOP/SECRET or ACF/2 should refer to their specific product documentation for details about the equivalent definitions in their environment.

2. If IPv6 is enabled on the system, provide RACF (or other security product) authorization for the IOAGATE user ID to read the following files:

   • /etc/ipnodes

   • Any other files mentioned in the RESOLVER address space SETUP file statements GLOBALIPNODES and DEFAULTIPNODES.

   File access authorization is not required if ESOCKAPI=SAS is defined in the CHANNEL statement of the ECAPARM member. However, this option is not recommended. Refer to Table 40 - Advanced parameters for creating/updating channels in Specifying Advanced Channel Parameters.

   The specific security product authorization requirements (if any), can be determined by starting IOAGATE and looking for security product error messages (ICH408I for RACF).

   Access authorization can be given by enabling read access to the file using the chmod command.

   For example (to allow read access for others):

   chmod o+r /etc/ipnodes

   The following alternative methods for giving access authorization can be used:

   • In the RACF OMVS segment for IOAGATE, set the User Identifier (UID) to the same UID as the owner of the file as displayed by the 'ls –l' command.

   • Connect the IOAGATE UID to the same group as the file's group using the RACF CONNECT command.

Step 20.6 – Set up IOAGATE to Support TCPAccess (Optional)

You only need to do the actions described in the following paragraphs if you use TCPAccess at your site.

How you set up IOAGATE to support TCPAccess depends on whether TCPAccess is set up to run with OMVS(OE).

When TCPAccess Has Been Set Up to Run with OMVS(OE)

1. Before setting up IOAGATE, ensure that CA Service Pack SP0112 (or later) for TCPAccess has been applied.

2. For security purposes, define a valid OMVS RACF segment for the userID and GroupID associated with the IOAGATE started task.

3. Configure IOAGATE as follows:

   1. Use the CTRANS parameter in the IOAGATE PROCJCL to define the CTRANS library provided by BMC with INCONTROL version 6.1.xx and above. Do not use SASLINK provided by the manufacturers of TCPAccess in IOAGATE.

      The default CTRANS value is the same as that used by IOAGATE when working with IBM TCP/IP.

   2. Use the TCPDATA parameter to define the appropriate SYSTCPD file in the IOAGATE PROCJCL. The SYSTCPD must include a valid definition for TCPIPJOBNAME.

   3. In each channel definition in ECAPARM, define SOCKIMP=OE.

When TCPAccess Has Not Been Set Up to Run with OMVS(OE)

Use the CTRANS provided by BMC. Do not use SASLINK provided by the manufacturers of TCPAccess in IOAGATE.

Use the LSCNCOM member provided by the manufacturers of TCPAccess in the SASLINK library.

You can do this, by the following steps:

1. Allocate a PDS library.

2. Ensure that the new PDS library is APF-authorized.

3. Copy into the new library the LSCNCOM member provided by the manufacturers of TCPAccess.

4. Concatenate this library in front of the CTRANS library.

Step 20.7 – Specify VTAM definitions for SNA multiple connection channels (Optional)

Multiple connection channels can only be specified for the Control‑O and Control‑D/Page On Demand application servers.

For an explanation of how to specify the channel connections, see Multiple Connection Channels Using SNA Session Support.

When you have specified VTAM Definitions for SNA, mark this step complete.

Step 21 – Install Control-M Application Server

This step installs the Control-M Application Server. When completed, mark each step complete.

Before proceeding with this step, consider the following:

• Control-M Application Server can only run if Control-M is installed. If you have no intention of installing Control-M, skip this step.

• Information relevant to the administration and customization of Control-M Application Server is described in the Control-M chapter in the INCONTROL for z/OS Administrator Guide.

Step 21.1 – Installation Considerations

Relationship between Control-M and Control-M/Enterprise Manager

Control-M/Enterprise Manager (Control-M/EM) is a software product that runs on UNIX and Microsoft Windows workstations to provide centralized control of the job scheduling production environment for the entire enterprise. Control-M/EM advanced graphical user interface provides enhanced perception of production flows throughout the entire active environment.

Control-M/EM works in conjunction with Control-M Production Control Systems and the Control-M/Restart Automated Job Restart System.

One Control-M/EM network has the ability to control multiple Control-M installations on various types of platforms. The following example illustrates communication between Control-M on a z/OS platform with Control-M/EM (using IOAGATE and CTMAS).

Figure 32 Communication between Control-M on a z/OS Platform with Control-M/Enterprise Manager (Using IOAGATE and CTMAS)

Relationship between Control-M JCL Verify and Control-M/Enterprise Manager

When Control-M JCL Verify is installed, JCL verification requests can be initiated from Control-M/Enterprise Manager. In this case the Control-M Application Server (CTMAS) passes the verification request to the local Control-M JCL Verify monitor (CTJMON), which belongs to the same IOA environment, on the same z/OS system. Remote verification (requests to CTJMONs on other systems) is not supported from Control-M/Enterprise Manager.

Configuring Control-M/CM Application Server (CTMCAS) (Optional)

The Control-M Configuration Manager application server (CTMCAS) is an optional feature which supports Control-M Configuration Manager on Windows.

Control-M Configuration Manager (CCM) enables you to manage all of the administrative tasks of Control-M from one focal location. Using Control-M Configuration Manager you can perform various tasks and configure elements within Control-M.

One of the elements that you can configure is Control-M for z/OS, including the Control-M application server (CTMAS).

CTMCAS together with IOAGATE functions as the Control-M administration agent on z/OS.

It is possible to either dedicate one IOAGATE for CTMCAS and another IOAGATE for CTMAS, or include them both in the same IOAGATE (possibly with other applications).

When a Control-M for z/OS datacenter is defined in Control-M Configuration Manager, the user can specify either discovery mode or direct mode.

• Discovery mode means that CCM will discover the existence of CTMAS by establishing a connection with CTMCAS via IOAGATE and retrieving configuration parameters from it. The port configured in CCM in this case is the port on which IOAGATE listens for CCM connections to CTMCAS. The main configuration parameter retrieved from CTMCAS by discovery mode is the port on which IOAGATE listens for the Control-M/EM connection to CTMAS. Please note that these ports are not the same.

• Direct mode means that the port configured in CCM, in this case, is the port on which IOAGATE listens for CONTOL-M/EM connections to CTMAS. Control-M/EM will directly connect to this port for communications with CTMAS.

The Control-M Configuration Manager application server reports the status of the following Control-M components:

• IOAGATE

• Control-M application server

• Control-M monitors (global and locals)

• Control-O or CMEM monitors.

The Control-M Configuration Manager application server can also be configured to change the status of the Control-M monitor that it controls according to the Desired State set in the CCM.

The Control-M Configuration Manager application server can either issue a message whenever the actual status of the monitor is different from the desired status, or it can issue an MVS START or STOP command to start or stop the Control-M monitor whenever it needs to be started or stopped.

Software Requirements and Compatibility

To use Control-M Application Server (CTMAS), Control-M/Enterprise Manager must be from the same version and release, or later, as Control-M for z/OS. The version and release are indicated by the v.r.mm format (in earlier versions) or the v.v.rr.mmm format (in more recent versions) in the product description. In this numbering format, v is version, r is release, and m is maintenance level.

In case there is a need to work with an earlier release of Control-M/Enterprise Manager, such as during a testing period, the parameters MODECTM and MODEASM in IOAPARM member must be set to the version of the Control-M/Enterprise Manager. For example, if the Control-M/Enterprise Manager is in V8 and the IOA is in V9, the setting of MODECTM=800 and MODEASM=800 must be used. Setting the value would restrict the functionality of the Control-M for z/OS to the features and parameter values that were in effect in the specified version. See the section on the parameters MODECTM/MODEASM for more detailed explanation on the values and the accompanied restrictions.

Note that BMC does not recommend that this mode be used for a long period of time, but should be limited to only upgrading and testing periods.

If you have any questions, please contact BMC Customer Support.

Step 21.2 – Shout to Control-M/EM Parameters

When a Shout message from Control-M is destined for Control-M/EM, the Shout message is written to the M2G file and distributed to Control-M/EM by the Control-M Application Server. To achieve this, you must insert values for the parameters in the following table:

Table 43 Shout to Control-M/EM Parameters

Step 21.3 – Remote Force Job Control-M/EM Parameters

When a DO REMFORCE request from Control-M is destined for Control-M/EM, the request is written to the M2F file and distributed to Control-M/EM by the Control-M Application Server.

When a DO REMFORCE request is sent from a remote CONTROL-M via CONTROL-M/EM, the request ID is written to the REQFRC file for tracking purposes.

To achieve this, you must insert values for the parameters in the following table.

Table 44 Remote Force Job Control-M/EM Parameters

Step 21.4 – Set ECS to Y in IOAPARM

This step changes the value of the ECS installation parameter to Y. This indicates that the Control-M Application Server is installed. When the process completes, this step is automatically marked complete.

Step 21.5 – Format the Shout Data Set

The FORMM2G job formats the data sets that communicate with the ESCGATE and transfer Shout messages.

Submit the job and verify that all job steps end with a condition code of 0.

Step 21.6 – Minimum Security Authorizations

1. Control-M Application Server can be installed without setting up special security requirements, except as noted below for RACF, CA-ACF2 and CA-TOP SECRET.

   If you are using RACF, ACF2 or TOP SECRET, define the started task Control-M/EM as a valid started task under the relevant security system.

2. All Control-M functions that the user specifies by Control-M Application Server are performed in Control-M by Control-M Application Server

   To enable Control-M Application Server to perform these functions as required, provide Control-M Application Server with READ and UPDATE authority for all data sets for which the Control-M monitor is authorized.

3. When authorized, users of Control-M Application Server have the option of performing the Edit JCL function. This function is executed by Control-M Application Server. Accordingly, Control-M Application Server should have UPDATE authority for all JCL libraries for which any Control-M Application Server user has EDIT authority.

4. Control-M Application Server performs actions on jobs that are contained in the Active Jobs file and that are displayed in the Active Environment screen (Screen 3). The CTMSE08 Control-M security module verifies a user’s authorization to perform actions on these jobs.

   If security for Control-M is enabled, you must authorize Control-M Application Server to perform all operations in Control-M Screen 3.

   For more information about the CTMSE08 module, see the Control-M chapter in the INCONTROL for z/OS Security Guide.

5. The following special users must be authorized:

   • User GCSERV: When global conditions are added from the Control-M/EM Global Conditions Server, they are added under userID GCSERV. The GCSERV user therefore must be defined in security.

     The GCSERV user is the userID of the Control-M/EM Global Conditions Server that distributes global condition transactions from any data center to another. This user should have the authorization to access IOA Condition file facilities. This userID must be GCSERV, specified with uppercase letters.

   • User CTMAS: The userID that was assigned to the CTMAS monitor that actually performs all Control-M/EM requests in the mainframe data center. This user ID is not necessarily CTMAS, but whatever user ID the system assigns to the CTMAS monitor. This value can be changed.

   • User CTMSYNC: The user ID through which Control-M/EM requests automatic synchronization between the folder libraries in Control-M (specified by SYNCLIBS for synchronization) and the Control-M/EM database. This user must have dataset access authorization to all the libraries specified in the SYNCLIBS parameter member, and to the calendar libraries pointed to by DD names DACAL and DARBC. In addition, in Extended Definition mode, CTMSYNC must have authorization to the $$ECSVWF facility. Note that CTMSYNC is the default user name which is customizable in Control-M/EM, so if it changed the new user name must be authorized in this step.

   • User BIMUSER: BMC Batch Impact Manager requires a user name to connect to Control-M/EM. In Control-M for z/OS, you must add a user that will be used by BMC Batch Impact Manager. By default, BMC Batch Impact Manager uses the BIMUSER user name.

     Verify that the BIMUSER user name has the following privileges:

     • Order

     • Force

     • Rerun

     • Hold

     • Log

     • Zoom-and-Save

     • Kill job

     For information on setting the privileges for the user name, see the INCONTROL for z/OS Security Guide.

Step 22 – Install KOA and IOA Routes (Optional)

This step is intended for users who need to install the IOA KeyStroke OpenAccess (KOA) facility that allows logon to VTAM applications.

Step 22.1 – Set Logical Terminals and Routes

Select this step to start a process that defines (or updates) the Logical Terminals and Routes for KOA.

The Logical Terminals and IOA Routes Menu screen is displayed:

Figure 33 Logical Terminals and IOA Routes Menu Screen

-------------------- Logical Terminals and IOA Routes Menu -------------------
                 OPTION  ===>                                                                 
                                                                                              
                 Parameter Member: IOAKPRM                                                    
                                                                                              
                  1  Global       - Global Parameters                                         
                  2  Terminals    - Define/Update Logical Terminals                           
                  3  Routes       - Define/Update IOA Routes                                  
                  4  Build        - Build the Parameter Member                                
              X  Exit         - Leave the Process             

Global Parameters

Select option 1, Global, and the Parameter Data Entry screen is displayed:

Figure 34 Parameter Data Entry Screen

---------------------------- Parameter Data Entry ----------------- Row 1 of 9
                COMMAND ===>                                                    SCROLL==> CSR 
                                                                                              
                Product: IOA          Major Step: 22  Install KOA and IOA Routes              
                Environment: DOC700   Minor Step: 1   Set Logical Terminals and Routes        
                                                                                              
                Codes in the VALUE field:           Function keys and Commands:               
                  = Insert from Reference             PF7/8   Scroll through all parameters   
                  / Insert from Default               PF3/End Exit and Save                   
                  ? Display Help                      Cancel  Exit without Save               
                ------------------------------------------------------------------------------
                   Variable    Value      Reference   Description                             
                   =========== ========== =========== ===========                             
                   KOATIME     60                     Global timeout                          
                   LTYP2       D4A32782               LOGMODE for model 2 SNA terminals       
                   LTYP2XT     SNX32702               LOGMODE for model 2 SNA term. (extended)
                   LTYP3       D4A32783               LOGMODE for model 3 SNA terminals       
                   LTYP3XT     SNX32703               LOGMODE for model 3 SNA term. (extended)
                   LTYP4       D4A32784               LOGMODE for model 4 SNA terminals       
                   LTYP4XT     SNX32704               LOGMODE for model 4 SNA term. (extended)
                   LTYP5       D4A32785               LOGMODE for model 5 SNA terminals       
                   LTYP5XT     SNX32705               LOGMODE for model 5 SNA term. (extended)
            ------------------------------> End of Parameters <---------------------------

Insert values for the parameters described in the following table. All but the first are Logon Mode parameters.

Table 45 Global KOA and IOA Routes Parameters

When you are satisfied with the values you have entered, press PF03/PF15 to exit this screen. The Logical Terminals and IOA Routes Menu screen is displayed again.

Define/Update Logical Terminals

Select option 2, Terminals, and the Update IOA Logical Terminals (KOA) screen is displayed:

Figure 35 Update IOA Logical Terminals (KOA) Screen

--------------------- Update IOA Logical Terminals (KOA) ---------- Row 1 of 6
                COMMAND ===>                                              SCROLL ==> CSR      
                                                                                              
                 Codes in the Sel field:            Command and Keys:                         
                    D Delete KOA                       ADD     Add KOA                        
                    A Add KOA                          CANCEL  Exit without Save              
                                                       PF3/End Exit and Save                  
                                                                                              
                Sel    SMFID       PREFIX  TERM#                                              
                ===    ========    ======  =====                                              
                       SMF1         KOA1    10                                                
                       SMF2         KSL2    10                                                
            ******************************* Bottom of data *******************************

From this screen you can add a new logical terminal to KOA, by typing Add in the COMMAND field and pressing Enter.

You can also using the options shown in the following table to perform the actions shown in the table.

Table 46 Options in the Update IOA Logical Terminals (KOA) Screen

Add a Logical Terminal

When you type Add in the COMMAND field, or A in the Sel field, the Add Logical Terminal (KOA) screen is displayed:

Figure 36 Add Logical Terminal (KOA) Screen

------------------------- Add Logical Terminal (KOA) -------------------------
                COMMAND ===>                                                                  
                                                                                              
                 Type KOA details and press Enter                                             
                 Press PF3 to exit                                                            
                                                                                              
                     SMFID/System ===>                                                        
                                                                                              
                     Prefix       ===>                                                        
                                                                                              
                     Term#        ===>                                                        
                                                                                          

For each logical terminal that you want to add, insert values for the parameters shown in the following table:

Table 47 Parameters in the Add Logical Terminal (KOA) Screen

When you are satisfied with the parameter values, press Enter to return to the Update IOA Logical Terminals (KOA) screen, from which you can repeat this procedure to add another logical terminal.

When you are satisfied with the values you have entered, you can do one of the following:

• type Cancel in the COMMAND field and press Enter, to exit the Update IOA Logical Terminals (KOA) screen without saving

• press PF03/PF15 to save the defined logical terminals and exit this screen

The Logical Terminals and IOA Routes Menu screen is redisplayed.

Delete a Logical Terminal

Type the letter D in the Sel field of any row containing a logical terminal, then press Enter. The logical terminal definition is deleted.

When you have deleted the logical terminals you wished to delete, press PF03/PF15 to exit this screen.

Define/Update IOA Routes

Select Option 3, Routes, and the Update IOA Routes screen is displayed:

Figure 37 Update IOA Routes Screen

------------------------------ Update IOA Routes -----------------------------
                COMMAND ===>                                              SCROLL ==> CSR      
                                                                                              
                 Codes in the Sel field:            Command and Keys:                         
                    D Delete Route                     ADD     Add Route                      
                    A Add Route                        CANCEL  Exit without Save              
                                                       PF3/End Exit and Save                  
                                                                                              
                Sel    SMFID       APPL        NODE                                           
                ===    ========    ====        ====                                           
            ******************************* Bottom of data *******************************

From this screen you can add a new route for KOA, by typing Add in the COMMAND field and pressing Enter.

You can also using the options shown in the following table to perform the actions shown in the table.

Table 48 Options in the Update IOA Routes Screen

Add Route

When you type Add in the COMMAND field, or A in the Sel field, the Add IOA Route screen is displayed:

Figure 38 Add IOA Route Screen

-------------------------------- Add IOA Route -------------------------------
                COMMAND ===>                                                                  
                                                                                              
                 Type IOA Route details and press Enter                                       
                 Press PF3 to exit                                                            
                                                                                              
                     SMFID/System ===>                                                        
                                                                                              
                     Application  ===>                                                        
                                                                                              
                     Node         ===>                                                        
                                                                                          

For each IOA route that you want to add, insert values for the parameters shown in the following table:

Table 49 Parameters in the Add IOA Routes Screen

When you are satisfied with the parameter values, press Enter to return to the Update IOA Routes screen, from which you can repeat this procedure to add another IOA route.

When you are satisfied with the values you have entered, press PF03/PF15 to save the defined IOA routes and exit this screen. The Logical Terminals and IOA Routes Menu screen is redisplayed.

Delete an IOA Route

In the Update IOA Routes screen, type the letter D in the Sel field of any row containing an IOA route, then press Enter. The IOA route definition is deleted.

When you have deleted the IOA routes you wished to delete, press PF03/PF15 to exit this screen. The Logical Terminals and IOA Routes Menu screen is redisplayed.

Build the Parameter Member

In the IOAGATE Parameters Menu screen, option 4, Build, build the IOAGATE parameters member, ECAPARMx, specified in option 0, based on the values specified in steps 1 (Application), 2 (Channel) and 3 (Global).

Step 22.2 – Define KOA logical "Terminals" in VTAM

KOA runs as a VTAM application that simulates a terminal. KOA terminals, which are actually VTAM applications, are defined in VTAM in the same way as other logical units in the SNA network. A pool of KOA terminals must be defined for each computer in which KOA scripts can run.

The number of KOA logical terminals defined in VTAM should be greater than the maximum number of KOA scripts that can run in parallel. For example, if 19 KOA scripts are to be run in parallel, you must define at least 20 KOA logical terminals.

MAJOR NODES member in the VTAM definition library, which is usually called SYS1.VTAMLST. In the MAJOR NODES member, there is a separate library definition for each computer.

Within the terminal pool, each terminal name must consist of a prefix comprised of 1 through 4 characters, followed by a 4‑digit index.

KOAAPLX VBUILD TYPE=APPL
                    KOAX0001 APPL EAS=1,ACBNAME=KOAX0001
                    KOAX0002 APPL EAS=1,ACBNAME=KOAX0002
                    .
                    .
                    .
                KOAX0050 APPL EAS=1,ACBNAME=KOAX0050

KOAAPLY VBUILD TYPE=APPL
                    KOAY0001 APPL EAS=1,ACBNAME=KOAY0001
                    KOAY0002 APPL EAS=1,ACBNAME=KOAY0002
                    .
                    .
                    .
                KOAY0020 APPL EAS=1,ACBNAME=KOAY0020

Step 22.3 – Select LOGMODE Tables

A Logon Mode, or LOGMODE, is a set of session parameters that identifies the characteristics of the terminal, such as screen size and the ability to display extended data stream, and the protocol it uses to communicate with other VTAM applications. LOGMODEs are grouped in a Logon Mode table, which is called MODETAB.

KOA simulates a SNA LUTYPE2 and supports all models of terminals, models 2, 3, 4, 5, both with and without extended data stream capabilities. Corresponding LOGMODEs must therefore be defined to VTAM. The SYS1.VTAMLST library, which is supplied when installing VTAM, contains (in the MODETAB ISTINCLM) standard required LOGMODEs. However, if other LOGMODEs are used, specify in each terminal definition the MODETAB name where the corresponding LOGMODEs are defined.

The MTABKOA member in the INSTWORK library contains a sample MODETAB definition.

The following IBM LOGMODEs are available in the default ISTINCLM table supplied with VTAM:

Table 50 IBM LOGMODEs Supplied with VTAM

Step 22.4 – Activate VTAM Definitions

VTAM definitions must be active before a KOA script can be used.

To activate the definitions manually, use the following VTAM command:

V NET,ACT,ID=major_node_name

Issue this command in each computer where the definitions should be active. For example, in SYSX:

V NET,ACT,ID=KOAAPLX

To activate the definitions permanently, modify the ATCCONxx member (used when VTAM is initialized) in the VTAM definition library of each computer. For example, the ATCCONxx member in SYSX contains the MAJOR NODE name KOAAPLX.

Step 22.5 – CICS Considerations (Optional)

CICS requires that each terminal or terminal type that communicates with it must be defined to CICS before a connection can be established. From the CICS point of view, there is no difference between a real LUTYPE2 terminal and a KOA terminal. Therefore, the KOA terminals must be defined in the same way as all the other terminals are defined. There are several methods for defining a terminal to CICS:

• Auto-Install program

• RDO – Resource Definition Online

• TCT

The best method for defining KOA terminals is Auto-Install. This is the most flexible method, since there is no need to define each individual terminal and the characteristics of the terminal, such as screen size, can be different in each session. A corresponding TYPETERM and terminal MODEL should exist to reflect all different KOA terminals, LUTYPE2 models 2, 3, 4, and 5, with or without extended data stream. At logon, the CICS Auto-Install program chooses a corresponding terminal model according to the LOGMODE supplied by KOA.

Other methods, such as RDO and TCT, can be used, but they are not as flexible. Each KOA terminal should be defined and the characteristics of the terminal should be specified. The LOGMODE parameters that were supplied during session initiation are ignored. This means that KOA is not able to specify the characteristics of the terminal according to script commands such as SCREENSIZE and COLOR.

Step 22.6 – IMS/DC Considerations (Optional)

IMS/DC requires that each terminal used to communicate with it must be defined to IMS/DC before a connection can be established. From the IMS/DC point of view, there is no difference between a real SNA LUTYPE2 terminal and a KOA terminal. Therefore, each KOA terminal must be defined as part of the IMS/DC GEN. This fixes the characteristics of the terminal, and KOA is not able to specify the characteristics of the terminal according to script commands such as SCREENSIZE and COLOR.

Step 22.7 – Other VTAM Applications (Optional)

Most VTAM applications, such as OMEGAMON, TSO, and NETVIEW, can communicate with any terminal that initiates a session with them. This means that there is no need for additional specifications to communicate between KOA and these applications.

Step 23 – Support for Other Products (Optional)

Perform the following steps to support other products that are installed at your site.

Step 23.1 – Support for LIBRARIAN (Optional)

Control-M can submit jobs from members in LIBRARIAN libraries.

LIBRARIAN libraries with any DSORG except PO are supported. To include LIBRARIAN support in Control-M, select this step and edit member LINKLIBR in the INSTWORK library.

Change the library referenced by the SYSLIB DD statement to the LIBRARIAN load modules library, submit the job, and save the member.

All steps must complete with a condition code of 0.

Sample Exit CTMX014L must be installed.

All appropriate LIBRARIAN files should be added to the ISPxLIB DD statements in the IOA TSO logon procedures.

When Control-M is installed, LIBRARIAN option "‑INC" is not resolved during job submission.

To support the LIBRARIAN‑INC command, apply Wish WI0880, located in the IOADFLT member in the IOA IOAENV library.

Step 23.2 – Support for PANVALET (Optional)

Control-M may submit jobs from members in PANVALET libraries. To include PANVALET support in Control-M, select this step and edit the LINKPANV member in the INSTWORK library.

Change the library defined by the SYSLIB DD statement to the PANVALET load modules library, submit the job, and save the member.

All steps must complete with a condition code of 0.

BMC recommends that PANVALET support be tested under the AutoEdit submission simulation before attempting it under the Control-M monitor. An error in the above‑mentioned linkage procedures may cause serious errors in the Control-M monitor.

For PANVALET versions 14 and later, certain modules are fetched dynamically during execution. For this reason, the PANVALET Load library must be referenced in either the STEPLIB DD statement of the Control-M monitor procedure or the MVS Linklist library.

The PANVALET LOAD library must also be APF-authorized.

Step 24 - Java and z/OS Unix Components Configuration

Follow these steps to install z/OS UNIX components support in IOA, which is required for the Control-M API Gateway.

Step 24.1 – Installation Considerations

The following steps define the zFS filesystem- related parameters, create the filesystem VSAM data set, format the filesystem, and mount it.

The zFS VSAM data set and the zFS filesystem are created and maintained by this ICE only and cannot be shared between, or swapped with, filesystems from other IOA environments.

The TSO user who performs the installation must have ALTER authority to the IOA zFS VSAM LDS and must be UID 0 or have read authority to the SUPERUSER.FILESYS.PFSCTL profile in the z/OS UNIXPRIV class.

After installation of z/OS UNIX support is completed, it is highly recommended that you add automount definitions for this zFS filesystem to the SYS1.PARMLIB(BPXPRMxx) member, so that you do not forget to mount the filesystem. Control-M API Gateway will not start if the filesystem is unmounted.

Step 24.2 – Provide z/OS Unix-related Parameters

This step defines and validates the parameters required to allocate, format, and mount the zFS filesystem .

Table 50a zFS Filesystem Parameters

Step 24.3 – Allocate and Format zFS VSAM Data Set

This step allocates a zFS VSAM data set and creates a zFS filesystem within the data set. It then mounts the filesystem, so that it is ready for the propagation process.

The TSO User who performs this step must have ALTER authority to the IOA zFS VSAM LDS and must be UID 0 or have readauthority to the SUPERUSER.FILESYS.PFSCTL profile in the z/OS UNIXPRIV class.

It is highly recommended to add automount definitions for this zFS filesystem to the SYS1.PARMLIB(BPXPRMxx) member, so that you do not forget to mount the filesystem.

The zFS VSAM data set and the zFS filesystem are created and maintained by this ICE only, and can not be shared between, or swapped with, filesystems from other IOA environments.

Step 24.4 – Indicate zFS Support is Installed

This step indicates that zFS Support is installed and the filesystem is ready for use. This step must be performed to make it possible to propagate INCONTROL elements to the zFS filesystem.

Step 25 - Installation Conclusion

This step is used to indicate that IOA installation is complete.

After installation of the products is complete, JCL procedures, User Exits, and other components of the product can be customized to further meet your site requirements. BMC recommends that you log all such changes in a readily available customization log. This log can then be used in future installations of the product, or when copying the product into additional environments.

BMC recommends that you include the following details for each entry in the customization log:

• the serial number and identifier

• the date of the change

• the function and purpose of the change

• a description of the change

Step 25.1 – Indicate Installation Concluded

This step updates the Status field in the Environment Table to indicate that IOA is installed.

Step 25.2 – Back up the Installed Environment

BMC recommends that you create a current backup of the IOA libraries.

When backing up the installed environment, verify that the base libraries, installation libraries, operations libraries, and SMP‑related data sets are backed up. This backup can help you to restore the original IOA environment when required, so that IOA or an INCONTROL product can be reinstalled if a significant number of changes are made to the parameters, or when an unrecoverable failure occurs during installation.

Installing Control-M

The following topics describe the steps required to install Control-M. The installation procedure contains step-by-step instructions that correspond to the major and minor steps in the INCONTROL Installation and Customization Engine (ICE).

• Before You Begin

• Control-M Step Checklist

• Installation Steps

• Installation Considerations

If you are not familiar with ICE, review Performing Tasks Common to All Product Installations before proceeding with the Control-M installation below.

Before You Begin

For a full list of Control-M libraries, INCONTROL Product Data Sets.

To prepare for the ICE installation, do the following:

1. Open the IOA Installation—Main menu.

2. Type 3 in the OPTION field to select option 3, "INSTALL CTx", and press Enter.

3. Type CTM in the ProductID field.

The Major Steps Selection screen for Control-M is displayed.

You are now ready to install Control-M using ICE.

Control-M Step Checklist

The following list is a summary of the steps required to install Control-M. Detailed step-by-step instructions follow.

• Step 1 – Planning

• Step 2 – Specify Control-M Parameters

• Step 3 – Specify CTM Target Configuration Parameters

• Step 4 – Control-M Installation Jobs

• Step 5 – Control-M Customization Process

• Step 6 – Install Control-M ISPF Support (Optional)

• Step 7 – Install Event Manager (CMEM)/Control-O Interface

• Step 8 – JES Considerations

• Step 9 – Control-M Amendments

• Step 10 – Control-M Customization

• Step 11 – Control-M VM Support (Optional)

• Step 12 – Install Control-M API Gateway

• Step 13 - Control-M Installation Conclusion

Installation Steps

Follow the major and minor steps below to install Control-M using ICE.

Step 1 – Planning

Plan the installation process carefully. The Control-M Installation Sheet will help you determine the items you should consider before installing Control-M.

Find out if you require input from system programmers, security administrators and other personnel at your site. Check whether any system changes that require special authorization and processing are necessary. Before proceeding with Control-M installation verify that all necessary configurations are known and planned in advance.

Step 1.1 – Is the Planning Sheet Complete?

This step verifies that you have filled in the Control-M planning sheet.

When you have done so, do the following:

1. Press PF03/PF15 to exit this screen.

2. Type C in the Sel field.

3. Press Enter.

The step will be marked as completed.

Step 2 – Specify Control-M Parameters

Insert values for the installation parameters, which are described briefly in this section.

Step 2.1 – Control-M Operational Parameters

Table 51 Operational Parameters

Sysout Archive Allocation Attributes

The following parameters control the sysout archive data set allocations. The sysout archive is associated with the DO SYSOUT F command. Whenever the Control-M monitor activates a sysout archiving request, an archive data set is allocated using the following allocation parameters:

UNIT=arcunit,SPACE=(arcspct,(arcpri#,arcsec#),RLSE)

The use of the RLSE parameter causes Control‑M to release unused space at the end of the archiving function.

Table 52 Sysout Archive Allocation Parameters

The archive data set's block size (BLKSIZE) is automatically calculated by Control-M. The logical record length (LRECL) is copied from the input SYSOUT file. The maximum LRECL allowed is 256 characters.

Step 2.2 – Build Control-M Sysplex Member (Optional)

If the CTMPLEX parameter is set to Y in Step 2.1, this step is mandatory.

The CTMPLEX parameter member specifies Control-M Sysplex Installation Parameters. This member contains global parameters for both the entire Control-M Sysplex environment and parameters for each Sysplex member in which the LSM monitor may run.

For more information, see the Control-M chapter in the INCONTROL for z/OS Administrator Guide.

Select this step and press Enter. The Update Control-M Plex (CTMPLEX) screen is displayed.

Figure 39 Update Control-M Plex (CTMPLEX) Screen

Table Header---------------------- Update Control-M Plex (CTMPLEX)  ----------- Row 1 of 1
                COMMAND ===>                                              SCROLL ==> CSR      
                 Codes in the Sel field:            Command and Keys:                         
                    D Delete SYSID                     ADD     Add SYSID                      
                    A Add SYSID                        CANCEL  Exit without Save              
                                                       PF3/End Exit and Save                  
                Structure name ==> STRUCTNAME                                                 
                Work balancing indicator ==> N    (Y/N)                                       
                Max. number of entries in structure ==> 100                                   
                                   ---- Cpacity -----                                         
                Sel    SYSTEMID    Relative   Maximum   PRIORITY                              
                ===    ========    ========   =======   ========                              
                       SYS6                                                                   
            ******************************* Bottom of data *******************************

Global CTMPLEX Parameters

In the following table, the name in parentheses in the Parameters column is the name of the parameter in the CTMPLEX member that is built in this Step.

Table 53 Global CTMPLEX Parameters

System(s) CTMPLEX Parameters

For each computer in a Sysplex in which an LSM monitor may run, there is a corresponding section labeled SYSTEM in the CTMPLEX member. The following parameters should be specified.

Table 54 System(s) CTMPLEX Parameters

Step 2.3 – Control-M/CM App. Server Parameters (Optional)

The following table lists the parameters that you need to specify in CTMPARM to configure the Control-M Configuration Manager application server. These parameters must be specified in the CTMAA section of CTMPARM.

These parameters identify the Control-M components that Control-M Configuration Manager controls, and determines whether the Control-M Configuration Manager application server should attempt to change the status of the Control-M monitor, and if so, using which method.

Table 55 Special CCM Parameters

Step 3 – Specify CTM Target Configuration Parameters

Specify values for the parameters listed below.

Step 3.1 – Control-M Libraries and Repository

Enter values for the parameters shown in the following table:

Table 56 Libraries and Repository Parameters

Step 3.2 – Control-M Repository Characteristics

Table 57 Repository Characteristic Parameters

Step 4 – Control-M Installation Jobs

Before running the installation jobs, perform the following steps.

Step 4.1 – Parameter Verification

In addition to the validation checks that are performed during the data entry phase, this step runs a program to verify that various installation parameters do not contain conflicting values. For example, the prefix of the Control-M installation libraries is checked to verify that it is not the same as other INCONTROL product prefixes.

When the step completes, it is marked complete.

If conflicts are found, a list of warning messages is displayed. The list displays the current values of the conflicting parameters and the required corrective action.

Step 4.2 – Save Parameters into Product Libraries

This step saves all the parameters specified in ICE. Wait until processing completes. When the step ends, it is marked complete.

This step customizes the CTMPARM and DEFPARM members in the IOA.PARM library.

Step 4.3 – Before You Proceed

You have completed the data entry of Control-M installation parameters in ICE. The following step submits a job that allocates data sets and tailors members in several libraries. Verify that all the values you have specified for the parameters are correct; otherwise, any changes in the parameters may require extensive manual modifications.

Step 4.4 – Install Control-M Libraries

The INSTALLM job in the IOA INSTWORK library loads the Control-M libraries. The member contains JCL for

• allocating the Control-M libraries

• loading Control-M libraries

• performing JCL adaptations of certain Control-M members

Submit the job and verify that all steps complete with a condition code of 0.

Step 4.5 – Indicate Control-M Libraries Installed

This step indicates that Control-M libraries were installed. When the process completes, this step is marked complete.

Step 5 – Control-M Customization Process

Perform the steps below to format Control-M data sets. When completed, mark this step complete.

Step 5.1 – Format Control-M Repository

The FORMCTM job creates and formats the following data sets in the Control-M Repository:

Table 58 Data Sets Formatted by the FORMCTM Job

If the appropriate parameter is set to Yes in a previous step, the FORMCTM job also creates and formats the following data sets:

Table 59 Data Sets Formatted by the FORMCTM Job if Parameter Set to Y

If the DUALDB IOA installation parameter is set to Y, the following data set is formatted:

Table 60 Data Set Formatted if the DUALDB Parameter is Set to Y

Submit the job and verify that all job steps complete with a condition code of 0.

Step 5.2 – Copy Control-M Started Tasks to Site Library

The COPYCTMP job copies Control-M started tasks from IOA PROCJCL library into the site library according to values specified earlier.

Submit the job and verify that all steps complete with a condition code of 0.

Step 6 – Install Control-M ISPF Support (Optional)

Follow the steps below to install Control-M ISPF support.

1. Enable the Quick Submit Function

   Control-M supports a "quick submit" function that enables the user to optionally submit jobs through Control-M to the MVS spool. For a detailed description, see the Control-M for z/OS User Guide.

   Each user who replaces the TSO/ISPF SUBMIT command with the quick submit option should perform the following:

   Edit any one member and specify CTMSETSB in the command line. Subsequently, when you specify the SUB or SUBMIT command, the new function becomes active.

   Considerations:

   • The scope of the CTMSETSB is for a SUBMIT command performed under any library with the same project name (meaning, highest qualifier). To work with a different project, you must specify the CTMSETSB command again, one for each project name.

   • To restore the original TSO/ISPF SUBMIT command, ISPF EDIT a member and specify CTMSETSB DELETE.

   • Verify that the IOA LOAD library is available, using MVS LINKLIST or STEPLIB, for any TSO user who requires the quick submit function.

2. Verify that CTMPSIMS is in an ISPF Skeleton library

   Verify that the CTMPSIMS member was copied from the Control-M JCL library to an ISPF Skeleton library.

3. Copy IOA ISPF messages to an ISPF Message library

   Verify that the IOA ISPF messages were copied or concatenated to an ISPF Message library.

4. Copy IOA ISPF panels to an ISPF panel library

   Verify that the IOA ISPF panels were copied or concatenated to an ISPF panel library.

5. Copy IOA CLISTs to an ISPF CLIST library

   Verify that the IOA ISPF CLISTs were copied or concatenated to an ISPF CLIST library.

   Refer to INCONTROL Product Data Sets to determine the specific type of IOA ISPF libraries that must be copied or concatenated.

Step 7 – Install Event Manager (CMEM)/Control-O Interface

Follow the steps below to install the Control-M Event Manager (CMEM) and the Control‑O interface.

Mark the step complete when you have completed all the steps.

Step 7.1 – Define a Subsystem and IOA Computer

The IOA subsystem may be installed before or during the installation of IOA.

Define IOA computers.

Before you proceed with installing CMEM, check and define IOA computers using Installation IOA => Customization Process => Specify IOA computers.

If the IOA subsystem is not installed, the CMEM monitor will define it the first time that CMEM is started.

Step 7.2 – CMEM Communication Options

The Control-M Event Manager (CMEM) communicates with Control-M through communication files. Communication can be implemented using the previously existing method (Step 7.4 – Allocate and/or Format Communication Files (for Non-Sysplex Environments)) in any environment.

In a Sysplex environment, communication can also be implemented by the MVS System Logger Sysplex function (Step 7.5 – CMEM Sysplex Configuration Parameters (Optional)) and Step 7.6 – Build CMMPLEX Parameter Member (Optional)).

However, all active CMEM and Control-M monitors must use the same communication method.

The monitor-to-subsystem communication file CTM2SBS is required in both Sysplex and non-Sysplex environments (Step 7.3 – Allocate Subsystem Communication File).

The MVS System Logger option (Step 7.5 – CMEM Sysplex Configuration Parameters (Optional) and Step 7.6 – Build CMMPLEX Parameter Member (Optional)) forces the Control-M and CMEM monitors to not start or to terminate if a CMEM or Control-M monitor is started in non-Sysplex environment or the MVS System Logger is not available.

For more information, see the Control-M chapter in the INCONTROL for z/OS Administrator Guide, and CMEM Considerations.

Step 7.3 – Allocate Subsystem Communication File

The FORMSUB1 job allocates and formats a file that is used by the Control-M monitor to communicate with all active Control-M Event Manager monitors or Control‑O monitors that are active in the complex.

The disk on which this file is to be allocated must have the following characteristics:

• The Control-M monitor must have WRITE access to it.

• All the CMEM monitors or Control-O monitors in all computers must have READ access to it.

• The disk must not be busy, and should not be reserved for any computer in the complex; otherwise, there may be serious performance degradation in CMEM and in the Control-M monitor.

• Change the VOL and UNIT parameters to define a disk suitable for this file.

Submit the job and check for successful completion. All job steps must end with a condition code of 0.

Step 7.4 – Allocate and/or Format Communication Files (for Non-Sysplex Environments)

Select this step to allocate and format communication files in a non-Sysplex environment where the MVS System Logger will not be used. For more information, see CMEM Considerations.

The FORMSUB2 job allocates and formats a file that enables the Control-M Event Manager or Control‑O monitors to communicate with the Control-M monitor.

The disk on which such a file is to be allocated must have the following characteristics:

• CMEM (or Control-O) in the designated computer must have WRITE access to the file.

• The Control-M monitor must have READ access to the file.

• The disk must not be busy, and should not be reserved from any computer in the complex. Otherwise, there might be serious performance degradation in CMEM and in the Control-M monitor.

For each computer whose SYSID was specified in IOACPRM, take the following steps:

1. Change the SMFID parameter to match the related entry.

2. Change the VOL and UNIT parameters to define a disk suitable for the specified SMFID.

3. Submit the job.

   The job must run in the computer whose file is being formatted during this run.

4. Check for successful completion. All job steps must end with a condition code of 0.

   All communication files should be reformatted whenever a new computer is added to the computer list.

   Verify that the CMEM, Control-O, and the Control-M monitors are down when formatting the subsystem communication file.

Step 7.5 – CMEM Sysplex Configuration Parameters (Optional)

Select this step to define the Sysplex environment when the CMEM communication vehicle at your site is the MVS System Logger and not communication files. For more information, see CMEM Considerations, and the Control-M chapter in the INCONTROL for z/OS Administrator Guide. Otherwise, skip this step, skip Step 7.6 – Build CMMPLEX Parameter Member (Optional), and continue with Step 7.7 – Set Up CMEM Table (Optional).

If the CMEM communication vehicle at your site currently is the Communication file method, and you are now switching to the System Logger method, both the Control-M monitor, and either the Control‑O or CMEM monitor, should be stopped and restarted. For details, see "Use System Logger (SYSTLOGR)" in Step 6.3 – Specify IOA Computers (Optional).

Table 61 Sysplex Configuration Parameters