RODMOPTS

Purpose

RODMOPTS statements are used by a controller to monitor special resources through the Resource Object Data Manager (RODM). You can use RODM to track the status of real resources used by HCL Workload Automation for Z operations. You specify RODMOPTS statements in the member of the EQQPARM library specified on the RODMPARM keyword of OPCOPTS. A RODMOPTS statement is required for each field in every resource that you want to monitor.

Note:

The names of RODM classes, objects, and fields are case-sensitive. Ensure you preserve the case when specifying RODMOPTS statements in the parameter library. Also, if a name contains anything other than alphanumeric or national characters, you must enclose the name in double quotation marks.
If HCL Workload Automation for Z subscribes to RODM for a resource that does not exist in the current plan and the DYNAMICADD keyword of RESOPTS has the value YES or EVENT, the event created from the data returned by RODM causes a dynamic add of the resource. DYNAMICADD is described in the list of RESOPTSParameters.

Format

Parameters

DESTINATION(tracker destination ID)

Specifies the destination ID of a tracker that is started on the same z/OS image as the RODM subsystem. This is the same name that you specify on the ROUTOPTS statement.

Do not specify DESTINATION if the tracker and controller are started in the same address space.

OPCFIELD(AVAILABLE|DEVIATION|QUANTITY)

Specify the field name in the special resource that you want to monitor through RODM. When RODM notifies a change, HCL Workload Automation for Z updates:

AVAILABLE: The Available field in the resource. This value overrides the default and interval values.
QUANTITY: The Quantity field in the resource. This value overrides the default and interval values.
DEVIATION: The Deviation field. You use this field to make a temporary adjustment to quantity. HCL Workload Automation for Z adds quantity and deviation together to decide the amount that operations can allocate. For example, if quantity is 10 and deviation is -3, operations can allocate up to 7 of the resource.

OPCRESOURCE(Special resource name)

Specify the name of the special resource that you want to monitor through RODM.

RODMCLASS(RODM class name)

HCL Workload Automation for Z can subscribe to a RODM class field or a RODM object field to monitor a special resource. Specify the name of a RODM class field that is used to monitor the special resource. Or specify the name of the class that the object is in, if you monitor the resource through an object field.

RODMFIELD(RODM field name)

Specify the field name in the RODM class or RODM object that is used to monitor the field in the special resource.

RODMLOST(RESET|field value|LAST)

This keyword determines the value that HCL Workload Automation for Z sets for the special resource field when no communication is possible with the RODM subsystem. If the controller cannot communicate with a RODM subsystem either because a tracker does not respond or RODM does not respond, it issues a warning message. The controller updates all special resources that subscribe to the lost RODM subsystem, according to the value of RODMLOST.

Specify RESET if HCL Workload Automation for Z uses the value produced by daily planning for the current time.

Specify LAST if HCL Workload Automation for Z uses the last known value.

If you want HCL Workload Automation for Z to set a specific value, specify that value for RODMLOST. The value you can specify depends on the field name in the OPCFIELD keyword. You can specify:

AVAILABLE: A character value Y or N
QUANTITY: An integer value 1–999999
DEVIATION: An integer value -999999–999999.

RODMOBJECT(RODM object name)

Specify the name of a RODM object if you use an object field to monitor the special resource. The object name must exist in the class that you specified in RODMCLASS.

RODMRM2XE(NO|YES)

Use this keyword to send a special WTO message EQQRM2XE to the z/OS console when the connection to an RODM object fails. This message is displayed with one of the following messages issued to EQQMLOG: EQQRM24, EQQRM2, EQQRM26, or EQQRM27. YES is the default. Specify NO to prevent the message from being sent.

RODMSYSTEM(RODM subsystem name)

Identifies the RODM subsystem that HCL Workload Automation for Z sends subscription requests to. This is the name of the RODM address space that you want HCL Workload Automation for Z to connect to. You can specify it in the &NAME parameter in the RODM startup procedure. If the &NAME parameter is omitted, the default name is the RODM started task name.

RODMUSER (user ID)

Defines the user ID used by HCL Workload Automation for Z to connect to the RODM system. Specify it when the RODM parameter SEC_CLASS is set to *TSTRODM. The default is blank.

TRANSLATE(from value:to value,......,from value:to value)

Specify this keyword if values for the RODM field are different to those for the special resource field. For example, an HCL Workload Automation for Z value Y might be represented in RODM by a value 1. Special resource fields have these values:

AVAILABLE: A character value Y or N
QUANTITY: An integer value 1–999999
DEVIATION: An integer value -999999–999999.

Specify a RODM field value that is translated to an HCL Workload Automation for Z field value when HCL Workload Automation for Z receives notification of a change from RODM. Translation values are in pairs separated by a colon. Value pairs are separated by a comma. Specify:

C'value': For character values.
N'value': For numeric values.
X'value': For hexadecimal values.
G'*': For a generic match. A value received from RODM that is not specified in a from value is translated to the to value. Specify the generic match if you do not know, or have not specified, all values that the RODM field can contain. If HCL Workload Automation for Z receives a RODM value that is not a valid HCL Workload Automation for Z field value, a message is written to the controller message log, and the field is not changed.

If you do not specify TRANSLATE, no RODM values are translated.

 RODMOPTS RODMSYSTEM(RODB)                          1
          DESTINATION(SYSBTRK)                      2
          OPCRESOURCE(SYSB.TAPE.UNITS)              3
          OPCFIELD(AVAILABLE)                       4
          RODMCLASS(z/OSSYSB_TAPE_UNITS)            5
          RODMFIELD(TAPES_ONLINE)                   6
          TRANSLATE(N'0':C'N',                      7
                    N'1':C'Y',
                    G'*':C'N')
          RODMLOST(Y)                               8
          RODMRM2XE(NO)                             9
          RODMUSER(USERID)                         10

In this example of a RODMOPTS statement, RODM is used to monitor the availability of tape units used by HCL Workload Automation for Z operations:

1: HCL Workload Automation for Z sends this request to a RODM subsystem, RODB.
2: The tracker on the same system as RODB has destination ID SYSBTRK. The controller sends the request to the tracker, which communicates with RODB through the subsystem interface. RODMTASK(YES) is specified for the tracker.
3: SYSB.TAPE.UNITS is the name of the HCL Workload Automation for Z special resource. It represents all tape units on SYSB.
4: RODM monitoring is required for the available field in the SYSB.TAPE.UNITS special resource.
5: In RODM, the tape units on SYSB are represented by the class name z/OSSYSB_TAPE_UNITS.
6: HCL Workload Automation for Z subscribes to class field TAPES_ONLINE of z/OSSYSB_TAPE_UNITS. If the value subfield of TAPES_ONLINE changes, all subscribers are notified.
7: The translate keyword is specified because this example assumes that the value subfield contains only numeric values. In HCL Workload Automation for Z only values Y and N are permitted for the available field. HCL Workload Automation for Z translates 0 to N (N'0':C'N'), 1 to Y (N'1':C'Y'), and all other values to N (G'*':C'N') when RODM reports the subfield value.
8: If communication with RODM is lost, the available field of the special resource is set to Y.
9: You do not want message EQQRM2XE to appear.
10: The scheduler uses USR1 to connect to the RODM system.