Previous Topic: SCHEDULE a File Transfer

Next Topic: DISPLAY Transfer Requests

The Programming Interface › Programming Requirements › Operator Control Function Parameters

Operator Control Function Parameters

Because the z/OS XCOMJOB interface does not feature operator control functions, some new parameters allow these functions within the CA XCOM Data Transport CICS menu interface. The following list contains operator control function parameters.

TYPE={DISPLAY|CANCEL|HOLD|RELEASE|SUSPEND|RESUME|ALTER}

Immediately following are descriptions of what happens when any of the seven possible values of TYPE is invoked. There is no default value.

Note: The DISPLAY function can return many transfer requests, but the other functions can apply to a single transfer request only.

DISPLAY

Displays the set of requested transfers.

CANCEL

Cancels the specified active or inactive transfer request.

HOLD

Holds an inactive transfer request.

RELEASE

Releases a transfer request that has been held.

SUSPEND

Suspends an active transfer request.

RESUME

Resumes a suspended transfer request.

ALTER

Alters a transfer request.

INACTIVE={YES|NO}

Used for TYPE=DISPLAY functions only.

Set INACTIVE=YES if you want CA XCOM Data Transport to search the INACTIVE queue for file transfers that meet your selection criteria. Set INACTIVE=NO (the default) if you do not want CA XCOM Data Transport to search the inactive queue.

ACTIVE={YES|NO}

Used for TYPE=DISPLAY functions only.

Set ACTIVE=YES if you want CA XCOM Data Transport to search the ACTIVE queue for file transfers that meet your selection criteria. Set ACTIVE=NO (the default) if you do not want CA XCOM Data Transport to search the active queue.

COMPLETED={YES|NO}

Used for TYPE=DISPLAY functions only.

Set COMPLETED=YES if you want CA XCOM Data Transport to search the COMPLETED queue for file transfers that meet your selection criteria. Set COMPLETED=NO (the default) if you do not want CA XCOM Data Transport to search the COMPLETED queue.

Note that the COMPLETED queue is another name for the CA XCOM Data Transport History File. Both successful and unsuccessful transfers are written to the History File. When you set COMPLETED=YES, you must specify one of the selection criteria fields (LUSER, ID, REQ#, GROUP, STARTDATE, or ENDDATE) to limit the number of records returned. CA XCOM Data Transport returns the entire History File to the requester unless a limit is set.

ALTER={STARTDATE| STARTTIME|EXEPRTY|SCHPRTY}

Used for TYPE=ALTER functions only. Required if TYPE=ALTER.

Immediately following are descriptions of what happens when any of the four possible values of ALTER is invoked. There is no default value. You can specify only one of these values for each TYPE=ALTER request.

STARTDATE

Changes the Start Date of a transfer request.

STARTTIME

Changes the Start Time of a transfer request.

EXEPRTY

Changes the Execution Priority of a transfer request.

SCHPRTY

Changes the Schedule Priority of a transfer request.

MICR=nnnnnnnn

Must be supplied when performing any operator control function other than TYPE=DISPLAY. When you set TYPE=DISPLAY, CA XCOM Data Transport can request information on a single transfer request.

This eight‑character hexadecimal field is stored in the CA XCOM Data Transport server and is returned when a TYPE=DISPLAY function is executed. Before performing any operator control function you must first successfully display the transfer request to be changed, get the MICR field from the TS queue, and then perform the operator control function.

LUSER

One of the selection criteria fields used by CA XCOM Data Transport to limit the amount of data returned by a TYPE=DISPLAY request.

Corresponding to the LUSER parameter for schedule requests, LUSER identifies the Local User responsible for scheduling a transfer request. You could use this field to display all transfer requests for a user ID. We recommend that you use this field only on TYPE=DISPLAY requests, because the MICR field identifies a unique transfer.

GROUP

Limits the data returned by TYPE=DISPLAY requests to a specific group.

IPNAME

Limits the data returned by TYPE=DISPLAY requests to a specific TCP/IP node.

LU

Limits the data returned by TYPE=DISPLAY requests to a specific logical unit.

USER

Limits the data returned by TYPE=DISPLAY requests to a specific user.

REQ#

Limits the data returned by a TYPE=DISPLAY request to a single request number. CA XCOM Data Transport returns only data with that request number.

Remember that the user does not supply the request number. Instead, CA XCOM Data Transport returns the request number to the user after CA XCOM Data Transport successfully schedules a transfer request.

ID

Limits the data returned to a specific transfer ID. You can set a specific ID on a TYPE=SCHEDULE request by using the ID parameter.

STARTDATE=yyyymmdd|yyddd

STARTDATE can be provided in two formats:

Example

STARTDATE=20120201 schedules a transfer to begin on February 1, 2012.

Example

STARTDATE=12032 schedules a transfer to start on the 32nd day of 2012, which is the same as February 1, 2012.

STARTTIME=hhmm

Required when ALTER=STARTTIME.

This four‑character field represents the requested transfer Start Time.

hh

Represents the hour of the day

mm

Represents the minutes past the hour.

Examples

0030 and 1415 represent 12:30 am and 2:15 pm, respectively.

EXEPRTY=nnn

Required when ALTER=EXEPRTY.

Specifies the new execution priority. Valid range is 0 to 255.

SCHPRTY=nnn

Required when ALTER=SCHPRTY.

Specifies the new schedule priority. Valid range is 0 to 255.

ENDDATE=yyyymmdd|yyddd

ENDATE can be provided in two formats:

Example

ENDATE =20120201 schedules a transfer to end on February 1, 2012.

Example

ENDATE =12032 schedules a transfer to end on the 32nd day of 2012, which is the same as February 1, 2012.