HCL Workload Automation, Version 9.4

Specifying generic runtime options for the agent

This section describes the TWSOPTS initialization statement.

This statement defines runtime options for the agent for z/OS.

TWSOPTS

Read syntax diagramSkip visual syntax diagram
>>-TWSOPTS--+-----------------------------+--------------------->
            |              .-REBUILD-.    |   
            '-BUILDSSX--(--+-MERGE---+--)-'   

                .-IBM-037--------------.      
>--CODEPAGE--(--+-host system codepage-+--)--------------------->

>--+---------------------------------------------------+-------->
   |              .-EELSSCMN----.     .-PERMANENT-.    |   
   '-SSCMNAME--(--+-module name-+--,--+-TEMPORARY-+--)-'   

>--+------------------------+--+--------------------------+----->
   |            .-NO---.    |  '-VARFAIL--(----& % ?----)-'   
   '-VARSUB--(--+-SCAN-+--)-'                                 
                '-YES--'                                      

>--+------------------------+----------------------------------><
   |             .-NO--.    |   
   '-VARPROC--(--+-YES-+--)-'   

Parameters

BUILDSSX = (MERGE|REBUILD)
Defines if the subsystem communication vector table (CVT) extension for the agent for z/OS, the SSX, should be rebuilt at a new level when the address space is started. The SSX is created at subsystem initialization by the EELINITN module. If the EELINITN module has since been updated, by maintenance or because you are installing a new release or modification level of the agent for z/OS, use the BUILDSSX keyword to avoid a z/OS® IPL.

Specify MERGE when operational data, such as the event writer queue, should be copied to the new SSX. This ensures that the new event writer queue is primed with events queued to the old SSX block. Use this option when starting an agent for z/OS address space after installing maintenance updates.

Specify REBUILD when you are migrating to a new release or modification level of the agent for z/OS. The event writer queue from the old SSX will not be referenced in the new SSX. Ensure you also identify the new subsystem communication module name by using the SSCMNAME keyword.

The default is REBUILD.

Important:
  • The PTF coverletter ++HOLD section identifies the service updates that require the SSX be rebuilt.
  • MERGE cannot be used when the old and new SSX blocks are built for different FMIDs. Do not use MERGE when migrating to, or falling back from, a new release or modification level of the agent for z/OS.
  • If you specify BUILDSSX(REBUILD) to migrate to a new release or modification level of the agent for z/OS, ensure you also specify the SSCMNAME keyword.
  • The BUILDSSX parameter should be removed after the next IPL of the z/OS system as it is no longer required.
CODEPAGE = (host system codepage|IBM–037)
The name of the host code page. This value is required because it is used by the monitoring task to convert the monitoring data to be sent to the monitoring agent. Provide a codepage from the following list of IBM–nnn values, where nnn is the EBCDIC code page used for your z/OS system:
IBM–037
US, Portugal, Canada (French). This is the default.
IBM–273
Germany
IBM–274
Belgium
IBM–277
Denmark - Norway
IBM–278
Sweden - Finland
IBM–280
Italy
IBM–284
Spain - Latin America
IBM–285
UK
IBM–297
France
IBM–424
Israel
IBM–500
International
IBM–838
Thai
IBM–933
Korea
IBM–935
China
IBM–937
Taiwan
IBM–939
Japan Extended
IBM–970
Latin 2
IBM–971
Iceland
IBM–975
Greece
IBM–1025
Cyrillic
IBM–1026
Latin 5 (Turkey)
IBM–1047
Open Systems
IBM–1112
Baltic
IBM–1122
Estonia
IBM–1388
China
The following is a list of the EBCDIC code pages for EURO support:
IBM–1140
Finland, Sweden
IBM–1141
Austria, Germany
IBM–1142
Denmark, Norway
IBM–1143
USA
IBM–1144
Italy
IBM–1145
Spain, spanish-speaking Latin America
IBM–1146
UK
IBM–1147
France
IBM–1148
Belgium, Switzerland
IBM–1149
Iceland
SSCMNAME = (module name|EELSSCMN,PERMANENT|TEMPORARY)
The first keyword value defines the name of the subsystem communication module to be used instead of EELSSCMN that was loaded at IPL. The second keyword value specifies how long the module should replace the one loaded at IPL. Use this keyword to load an updated version of the module before a scheduled IPL. The module you specify must reside in an APF-authorized library defined by either the STEPLIB ddname or LNKLSTnn concatenation. If SSCMNAME is not specified or specifies a module that cannot be located in an authorized library, the agent for z/OS events will continue to be generated by the EELSSCMN module loaded at IPL.

Specify PERMANENT as the second keyword value to replace the subsystem communication module loaded at IPL with the module identified in the first keyword value. In this case the module specified must reside in an APF-authorized library defined by the STEPLIB ddname. This is the default.

When TEMPORARY is specified or defaulted as the second keyword value, the module you specify will generate job tracking events only while the agent for z/OS address space is active. When the address space is stopped, events will continue to be generated by the EELSSCMN module loaded at IPL.

Important:
  • The PTF cover letter ++HOLD section identifies service updates that require a new subsystem communication module to be loaded.
  • Ensure you specify this keyword when the BUILDSSX(REBUILD) option is used to migrate to, or fallback from, a new release or modification level of the agent for z/OS.
  • The SSCMNAME keyword should be removed after the next IPL as it is no longer required.
VARSUB(YES|NO|SCAN)
This keyword specifies whether JCL variable substitution should be performed. YES means that variable scanning will be performed for all jobs. NO means that variable scanning will not occur. SCAN instructs the agent to search the JCL for variables only if the //*%OPC SCAN directive is found in the JCL.
VARFAIL(&, %, ?)
This keyword specifies whether or not unresolved variables in the JCL would cause a JCL error. You can use from one to three of the following characters, in any order, to bypass substitution failure (&, %, ?).

If, for example, VARFAIL(&) is specified, the agent will not consider the failure of a substitution of variables beginning with an & to be an error. Any combination of the three types is allowed, for example, VARFAIL(&, %) or VARFAIL(?), but at least one value must be specified while any repetition of characters will be rejected.

If VARFAIL is not specified, then all the lack of substitution of variables will be treated as errors, as previously.

VARPROC(YES|NO)
This keyword specifies whether or not online procedures should consider variable substitution. If VARPROC(YES) is specified, variables in online procedures will be resolved.

The default is NO.