WSSTAT

Format


1 WSSTAT
2?  ALTWS (
3.1 alternate workstation name
2 )
2?  REROUTE (
3.1 R
3.1 L
2 )
2?  STARTOPR (
3.1 R
3.1 L
3.1 E
2 )
1  STATUS (
2.1 A
2.1 O
2.1 F
1 )
3?  SUBSYS (
4.1! OPCA
4.1 subsystem name
4.1 MSTR
3 )
3?  TRACE (
4.1! 0
4.1 trace level
3 )
3  WSNAME (
4.1 workstation name
3 )
Note: These are the only WSSTAT parameters that apply to the HCL Workload Automation Agent workstation. For a complete list of the WSSTAT parameters, see WSSTAT.

Parameters

ALTWS (alternate workstation name)
When the workstation status is set to OFFLINE or FAILED, you can specify the alternate workstation on which to start reroutable operations.

If you omit this parameter, the value defined for the current workstation open interval is used. If the REROUTE parameter specifies L, or if the default specifies no rerouting, the value of ALTWS is ignored.

The parameter is optional.

REROUTE (R | L)
When the workstation status is set to OFFLINE or FAILED, you can specify R for operations to be rerouted to the alternate workstation, or L for no rerouting (to leave the operations on the inactive workstation).

If you omit this parameter, the value defined in either the WSOFFLINE or the WSFAILURE keyword on the JTOPTS initialization statement is used as the default.

The parameter is optional.

STARTOPR (R | E | L)
When the workstation status is set to OFFLINE or FAILED, you can specify what the scheduler must do with operations that are currently in started status at the workstation, where:
R
Restart operations automatically on the alternate workstation.
E
Set all started operations to ended-in-error.
L
Leave the operations in started status.

If you omit this parameter, the value defined in either the WSOFFLINE or the WSFAILURE keyword on the JTOPTS initialization statement is used as the default.

The parameter is optional.

Note: If you select STARTOPR(E), a started job continues to run, because HCL Workload Automation for Z never cancels jobs that have started.
STATUS (A | O | F)
The status you want to report for the workstation:
A
Active
O
Offline
F
Failed

You must specify either STATUS or one of the alternative parameters.

SUBSYS (subsystem name | MSTR | OPCA)
The name of the tracker subsystem that WSSTAT is directed to. This parameter can be up to 4 characters long. The first character must be alphabetic while the remaining characters must be alphanumeric. All lowercase characters are converted to uppercase.

If you specify MSTR, the command is directed to all tracker subsystems on the z/OS® system on which the command is issued.

Note: If the tracker and controller in your configuration run on different subsystems, specify the name of the tracker subsystem in this parameter.
TRACE (level | 0)
The event tracing indicator. When any nonzero positive number is specified, a trace entry is created for each event generated by WSSTAT. The trace record is written to the message log file identified by ddname EQQMLOG. The record identifies the name of each receiving subsystem. The default value 0 does not generate trace records.
WSNAME (workstation name)
The name of the workstation to be updated. You must specify this parameter.

The WSSTAT parameters are checked for validity and consistency. The validity checks are performed on the tracker where the command is run. The validity check processes parameter names, and length and type of parameter values.

If the input is valid, a workstation status event is generated and communicated to the controller. Processing of the event includes a consistency check of the values specified in the parameters. The following consistency checks are made:
  • The workstation name exists.
  • The alternate workstation exists.
  • If the value given in the STATUS parameter is the same as the current status of the workstation, the command is ignored.

Examples

The following two examples show how you can use WSSTAT in TSO, or in a batch job (using the batch program EQQEVPGM).

Example 1 - TSO command 
ALLOC F(EQQMLIB) DA('OPC.MESSAGE.LIBRARY') SHR REUSE
 
WSSTAT SUBSYS(OPCB) WSNAME(AS4H) STATUS(O) START(R)
In this example, the status of workstation AS4H is set to OFFLINE. Started operations are restarted on the alternate workstation.
Example 2 - Batch job 
//CHSTATUS JOB (ACCOUNT),'Change WS status',CLASS=A
//STEP1    EXEC PGM=EQQEVPGM
//STEPLIB  DD DSN=OPC.LOAD.MODULE.LIBRARY,DISP=SHR
//EQQMLIB  DD DSN=OPC.MESSAGE.LIBRARY,DISP=SHR
//EQQMLOG  DD SYSOUT=A
//SYSIN    DD *
WSSTAT SUBSYS(OPCB) WSNAME(AS4H) STATUS(A)
/*
In this example, the status of workstation AS4H is set to ACTIVE.