Component Transport Control
Purpose
The TRNSPCTL AUTHREQ is used to send an operational request to a Component Transport Server. The requests can be used to initiate the following functions:
- Put the Component Transport Server into a hold state. When the server is in a hold state, all new requests will be queued and any warehouse datasets will be closed and de-allocated. This can be used to allow backups of warehouse datasets.
- Release the server from a hold state.
- Start the warehouse housekeeping function. If you are not running this function periodically by coding HKINTERVAL=0 in the Component Transport parameters, you can trigger the housekeeping through this call.
API Parameter List
ECIR, CTQ
The ECIR Data Structure must have the values in following Table set.
ECIR Data Structure Values for Component Transport Control
Parameter | Value |
|---|---|
OBJECT | TRNSPCTL |
METHOD | AUTHREQ |
CTQ Data Structure
The CTQ data area contains details required to perform the Component Transport function. The CTQ layout is described in following Table.
CTQ Layout
Position | Length | Type | Field | Description |
|---|---|---|---|---|
1 | 4 | CHAR | CTREQTYP | Request Type. Valid values are: |
5 | 2 | BINARY | CTQCOMPT | Not used |
7 | 8 | CHAR | SCTSRVNM | Name of the Component Transport Server |
15 | 4 | CHAR | SWLBTYPE | Not used |
19 | 254 | CHAR | SWLBNAME | Not used |
273 | 24 | CHAR | SSTORKEY | Not used |
297 | 8 | CHAR | TCTSRVNM | Not used |
305 | 4 | CHAR | TWLBTYPE | Not used |
309 | 254 | CHAR | TWLBNAME | Not used |
563 | 24 | CHAR | TSTORKEY | Not used |
587 | 24 | CHAR | VSTORKEY | Not used |
611 | 8 | CHAR | ERRID | If the return code is not zero, this contains the ID of the error. |
619 | 8 | CHAR | ERRCODE | If the return code is not zero, this contains the error code. |
627 | 72 | CHAR | ERRSTXT | If the return code is not zero, this contains a short error message. |
699 | 255 | CHAR | ERRLTXT | If the return code is not zero, this contains the long error message. |