Specifying object fields to update
The fields that you can update in each object type and the new values that you can provide are described here:
Updating operation status (CP_OPER_EVENT)
You can update these fields in a current plan operation:
| Field | Type | Size | Description |
|---|---|---|---|
| STATUS | CHAR | 1 | New status (C, E, I, Q, S, T, or X) |
| ERROR_CODE | CHAR | 4 | Error code (for new status E) |
| ACT_DUR | CHAR | 4 | Actual duration HHMM (for new status C or E) |
| ACT_END_TIME | CHAR | 4 | Actual end time HHMM (for new status C or E) |
| EV_CREATION_DATE | CHAR | 4 | Event creation date (01YYDDDF) |
| EV_CREATION_TIME | BIN | 31 | Event creation time (100 * seconds) |
| JOB_NUMBER | CHAR | 5 | Job number |
- STATUS
- Is the new status of the operation. These values are valid:
- C
- Set the status of the operation to complete.
- E
- Set the status of the operation to ended-in-error.
- I
- Set the status of the operation to interrupted.
- Q
- Set the extended status of a started operation to Q to indicate that the operation is queued awaiting execution.
- S
- Set the status of the operation to started.
- T
- Set the extended status of a started operation to S to indicate that the operation is executing.
- X
- Reset the current status for this operation.
- ERROR_CODE
- Is the error code for an operation that is reported as ended-in-error.
- ACT_DUR
- Is the duration, in hours and minutes, of an operation that is reported as complete or ended-in-error.
- ACT_END_TIME
- Is the time the operation is reported as complete or ended-in-error.
- EV_CREATION_DATE
- Contains the date of the event that is being reported. If the field contains all binary zeros (X'00'), Tivoli Workload Scheduler for z/OS uses the current date.
- EV_CREATION_TIME
- Contains the time of the event that is being reported. If the field contains all binary zeros (X'00'), Tivoli Workload Scheduler for z/OS uses the current time.
- JOB_NUMBER
- Is a number that you can provide for the job. JOB_NUMBER is valid only for operations at general automatic workstations and workstations that have a user-defined destination. Do not specify JOB_NUMBER for operations that are submitted through a tracker.
Note:
You must specify at least STATUS. The remaining field
names are optional.
Updating a special resource (CP_SR_EVENT)
You can update these fields in a current plan special resource:
| Field | Type | Size | Description |
|---|---|---|---|
| AVAILABLE | CHAR | 1 | Availability (Y|N|K|R) |
| QUANTITY | BIN | 31 | Number available (1 to 999 999) |
| QUANTITY_OPTION | CHAR | 8 | Quantity option (KEEP|RESET) |
| DEVIATION | BIN | 31 | Number to deviate (-999 999 to 999 999) |
| DEVIATION_OPTION | CHAR | 8 | Deviation option (KEEP|RESET) |
| CREATE | CHAR | 1 | Create resource if undefined (Y|N) |
- AVAILABLE
- Is the availability status of the special resource. Y indicates that the availability status of the resource should be set to YES; N indicates that the status should be NO. R (RESET) sets the status to the planned availability status in the current plan. K (KEEP), the default, does not change the status.
- QUANTITY
- Is a numeric value (1–999 999) that updates the Quantity field in the special resource, which overrides interval and default values. QUANTITY and QUANTITY_OPTION fields are mutually exclusive. If you specify both fields, the event is ignored.
- QUANTITY_OPTION
- Is either KEEP or RESET. Specify RESET to set the amount to the scheduled value in the current plan or KEEP, the default, to leave the quantity unchanged. If you specify QUANTITY and QUANTITY_OPTION, the event is ignored.
- DEVIATION
- Is a numeric value, -999 999 to 999 999, which lets you make a temporary change to the quantity. Deviation is an amount to be added to (positive number) or subtracted from (negative number) the current quantity. For example, if you specify -2 and the current quantity is 10, the total amount that operations can allocate reduces to 8. DEVIATION and DEVIATION_OPTION fields are mutually exclusive. If you specify both fields, the event is ignored.
- DEVIATION_OPTION
- Is either KEEP or RESET. Specify RESET to set the deviation to zero. KEEP, the default, does not alter the deviation. If you specify DEVIATION and DEVIATION_OPTION, the event is ignored.
- CREATE
- Specifies if Tivoli Workload Scheduler for z/OS should create a resource in the current
plan if the resource does not exist. NO indicates that the resource
should not be added to the resource definitions of the receiving Tivoli Workload Scheduler for z/OS subsystem.
If the resource is already defined in the receiving subsystem, NO
has no effect. You can specify NO if the resource is being used only
as a means to generate an event for ETT: the event is generated even
if the resource does not exist.
If YES is specified and the DYNAMICADD keyword of the RESOPTS initialization statement is set to YES or EVENT, a resource definition is created in the receiving Tivoli Workload Scheduler for z/OS subsystem if the resource is not already defined.
Note:
When you set the quantity or availability of a resource
through EQQUSIN (or other interfaces such as the SRSTAT TSO command
or the MCP dialog), the specified value lasts over interval boundaries,
even though the next interval can specify a different value. Specify
RESET to restore the planned value.
Updating an operation user-data (CP_OPINFO_EVENT)
You can update this field in a current plan operation with user-data information:
| Field | Type | Size | Description |
|---|---|---|---|
| USERDATA | CHAR | 16 | User data (free form text) |
- USERDATA
- Is the 16-character user-data information that is to be updated for the specified operation.
Updating a workstation (CP_WS_EVENT)
You can update these fields in a current plan workstation:
| Field | Type | Size | Description |
|---|---|---|---|
| WS_STATUS | CHAR | 1 | Workstation status |
| STARTED_FAIL_OPT | CHAR | 1 | Failure option for started operations (R, L, or E) |
| REROUTE_OPT | CHAR | 1 | Reroute option (Y or N) |
| ALT_WS | CHAR | 4 | Alternate workstation name |
- WS_STATUS
- Is the status you want reported for the workstation:
- A
- Active
- O
- Offline
- F
- Failed.
- STARTED_FAIL_OPT
- When the workstation status is set to offline or failed, you
can specify what Tivoli Workload Scheduler for z/OS should do with operations that are currently
in started status at this destination (workstation):
- R
- Restart operations automatically on the alternate workstation
- L
- Leave the operations in started status
- E
- Set all started operations to ended-in-error.
- REROUTE_OPT
- When the workstation status is set to offline or failed, you can specify Y for operations to be rerouted to the alternate workstation, or N for no rerouting if you want to leave the operations at the inactive workstation.
- ALT_WS
- When the workstation status is set to offline or failed, you can specify an alternate workstation where rerouted operations should be started.
Notes:
- You must specify at least WS_STATUS.
- If the value provided for WS_STATUS is equal to the current status, the event is ignored.