Table 30 summarizes the application domain’s specific
gates. It shows the level-1 trace point IDs of the modules providing the functions
for the gates, the functions provided by the gates, and whether or not the
functions are available through the exit programming interface (XPI).
Table 30. Application domain’s specific gates
Gate |
Trace |
Function |
XPI |
ABAB |
AP 0741
AP 0742
|
CREATE_ABEND_RECORD
UPDATE_ABEND_RECORD
START_ABEND
INQUIRE_ABEND_RECORD
TAKE_TRANSACTION_DUMP
|
NO
NO
NO
NO
|
APAP |
AP 0910
AP 0911
|
TRANSFER_SIT
|
NO
|
APCR |
AP 4E00
AP 4E01
 |
ESTIMATE_ALL
ESTIMATE_CHANGED
EXPORT_ALL
EXPORT_CHANGED
IMPORT_ALL
IMPORT_CHANGED,
 |
NO
NO
NO
NO
NO
NO
 |
APEX |
AP 0510
AP 0515
|
INVOKE_USER_EXIT
|
NO
|
APID |
AP 092A
AP 092B
|
PROFILE
QUERY_NETNAME
|
NO
|
APIQ |
AP 0920
AP 0921
|
INQ_APPLICATION_DATA
|
YES
|
APJC |
AP F900
AP F901
|
WRITE_JOURNAL_DATA
|
YES
|
APLH |
AP 19A0
AP 19A1
|
ESTABLISH_LANGUAGE
NOTIFY_REFRESH
START_PROGRAM
|
NO
NO
NO
|
APLI |
AP 1940
AP 1941
|
ESTABLISH_LANGUAGE
START_PROGRAM
|
NO
NO
|
APLJ |
AP 1960
AP 1961
|
ESTABLISH_LANGUAGE
START_PROGRAM
PIPI_INIT_SUB_DP
PIPI_CALL_SUB
PIPI_TERM
|
NO
NO
NO
NO
NO
|
APRT |
AP 1900
AP 1901
|
ROUTE_TRANSACTION
|
NO
|
APTC |
AP 4900
AP 4901
|
CANCEL
CLOSE
EXTRACT_PROCESS
ISSUE_NOTIFY
LISTEN
OPEN
RECEIVE
SEND
SET_SESSION
|
NO
NO
NO
NO
NO
NO
NO
NO
NO
|
APTD |
AP F600
AP F601
|
WRITE_TRANSIENT_DATA
READ_TRANSIENT_DATA
DELETE_TRANSIENT_DATA
INITIALIZE_TRANSIENT_DATA
RESET_TRIGGER_LEVEL
|
NO
|
APXM |
AP 0590
AP 0591
|
INIT_XM_CLIENT
BIND_XM_CLIENT
RELEASE_XM_CLIENT
|
NO
NO
NO
|
BRAI |
AP 4AE0
AP 4AE1
|
INQUIRE_AUTOINSTALL
SET_AUTOINSTALL
INSTALL_BRIDGE_FACILITY
DELETE_BRIDGE_FACILITY
|
NO
NO
NO
NO
|
BRAT |
AP 2800
AP 2801
|
ATTACH
|
NO
|
BRFM |
AP 2140
AP 2141
|
Subroutine for bridge facility allocation/deletion.
|
NO
|
BRFR |
AP 4A00
AP 4A01
|
ALLOCATE_BRIDGE_FACILITY
REALLOCATE_BRIDGE_FACILITY
DETACH_BRIDGE_FACILITY
SET_BRIDGE_FACILITY
INQUIRE_BRIDGE_FACILITY
STARTBR_BRIDGE_FACILITY
GET_NEXT_BRIDGE_FACILITY
ENDBR_BRIDGE_FACILITY
GARBAGE_COLLECT
|
NO
NO
NO
NO
NO
NO
NO
NO
NO
|
BRIC |
AP 2166
AP 2167
|
Subroutine interfacing interval control EXEC
commands and the bridge exit.
|
NO
|
BRIQ |
AP 2820
|
INQUIRE_CONTEXT
|
YES
|
BRLK |
AP 4A20
AP 4A21
|
START_BRIDGE
CONTINUE_BRIDGE
ABEND_BRIDGE
|
NO
NO
NO
|
BRME |
AP 4C40
AP 4C41
|
API_EMULATOR
|
NO
|
BRMF |
AP 4C20
AP 4C21
|
FORMATTER
|
NO
|
BRMG |
AP 4A40
AP 4A41
|
ALLOCATE_MESSAGE
REALLOCATE_MESSAGE
OUTPUT_MESSAGE
RESEND_MESSAGE
DELETE_MESSAGE
READ_VECTOR
ALLOCATE_VECTOR
ERASE_OUTPUT_VECTORS
|
NO
NO
NO
NO
NO
NO
NO
NO
|
BRMS |
AP 2160
AP 2161
|
Subroutine interfacing BMS EXEC commands and
the bridge exit.
|
NO
|
BRNS |
AP 4A60
AP 4A61
|
INITIALISE_NUMBER
CONNECT_NUMBER
DISCONNECT_NUMBER
ALLOCATE_NUMBER
RELEASE_NUMBER
|
NO
NO
NO
NO
NO
|
BRRM |
AP 2840
AP 2841
|
RMRO callback for PREPARE and COMMIT
|
NO
|
BRSP |
AP 216C
AP 216D
|
Subroutine interfacing syncpoint requests and
the bridge exit.
|
NO
|
BRTC |
AP 2163
AP 2164
|
Subroutine interfacing terminal control EXEC
commands and the bridge exit.
|
NO
|
BRXM |
AP 2860
AP 2861
|
XMAC callback for INIT_XM_CLIENT and
BIND_XM_CLIENT
|
NO
|
ICXM |
AP 05C0
AP 05C1
|
INQUIRE_FACILITY
|
NO
|
LILI |
AP 1940
AP 1941
|
INITIALIZE_LANGUAGES
TERMINATE_LANGUAGES
FIND_PROGRAM_ATTRIBUTES
GO_TO
|
NO
NO
NO
NO
|
RTSU |
AP 1910
AP 1911
|
COMMIT_SURROGATE
FREE_SURROGATE
GET_RECOVERY_STATUS
PREPARE_SURROGATE
RESET_SURROGATE
|
NO
NO
NO
NO
NO
|
TDOC |
AP F640
AP F641
|
OPEN_TRANSIENT_DATA
CLOSE_TRANSIENT_DATA
CLOSE_ALL_EXTRA_TD_QUEUES
|
NO
NO
NO
|
TDTM |
AP F680
AP F681
|
ADD_REPLACE_TDQDEF
INQUIRE_TDQDEF
START_BROWSE_TDQDEF
GET_NEXT_TDQDEF
END_BROWSE_TDQDEF
SET_TDQDEF
DISCARD_TDQDEF
COMMIT_TDQDEFS
|
NO
NO
NO
NO
NO
NO
NO
NO
|
TDXM |
AP 05B0
AP 05B1
|
BIND_FACILITY
BIND_SECONDARY_FACILITY
RELEASE_FACILITY
INQUIRE_FACILITY
|
NO
NO
NO
NO
|
SAIQ |
AP E120
AP E122
|
INQUIRE_SYSTEM
SET_SYSTEM
|
YES
YES
|
TFAL |
AP D600
AP D601
|
ALLOCATE
CANCEL_AID
CHECK_TRANID_IN_USE
CANCEL_AIDS_FOR_CONNECTION
CANCEL_AIDS_FOR_TERMINAL
DISCARD_AIDS
FIND_TRANSACTION_OWNER
GET_MESSAGE
INITIALIZE_AID_POINTERS
INQUIRE_ALLOCATE_AID
LOCATE_AID
LOCATE_REMDEL_AID
LOCATE_SHIPPABLE_AID
MATCH_TASK_TO_AID
PURGE_ALLOCATE_AIDS
RECOVER_START_DATA
REMOTE_DELETE
REMOVE_EXPIRED_AID
REMOVE_EXPIRED_REMOTE_AID
REMOVE_MESSAGE
REMOVE_REMOTE_DELETES
REROUTE_SHIPPABLE_AIDS
RESCHEDULE_BMS
RESET_AID_QUEUE
RESTORE_FROM_KEYPOINT
RETRIEVE_START_DATA
SCHEDULE_BMS
SCHEDULE_START
SCHEDULE_TDP
SLOWDOWN_PURGE
TAKE_KEYPOINT
TERM_AVAILABLE_FOR_QUEUE
TERMINAL_NOW_UNAVAILABLE
UNCHAIN_AID
UPDATE_TRANNUM_FOR_RESTART
|
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
|
TFBF |
AP 1730
AP 1731
|
BIND_FACILITY
|
NO
|
TFIQ |
AP 1700
AP 1701
|
INQUIRE_TERMINAL_FACILITY
INQUIRE_MONITOR_DATA
SET_TERMINAL_FACILITY
|
NO
NO
NO
|
TFRF |
AP 1710
AP 1711
|
RELEASE_FACILITY
|
NO
|
TFXM |
AP 1790
AP 1791
|
INIT_XM_CLIENT
BIND_XM_CLIENT
|
NO
NO
|
MRXM |
AP 17B0
AP 17B1
|
INIT_XM_CLIENT
BIND_XM_CLIENT
|
NO
NO
|
62XM |
AP 17C0
AP 17C1
|
INIT_XM_CLIENT
BIND_XM_CLIENT
|
NO
NO
|
The CREATE_ABEND_RECORD function of the ABAB gate is used to create an
abend record (TACB).
Input parameters
- [ABEND_CODE]
- is the four-character transaction abend code.
- [FAILING_PROGRAM]
- is the name of the program in which the abend occurred.
- [REQUEST_ID]
- is the request ID from the TCTTE for a terminal-oriented task.
- [FAILING_RESOURCE]
- is the name of the system TCTTE (the connection) if the abend was raised
by DFHZAND.
- [REMOTE_SYSTEM]
- is the name of the remote system if the abend was raised in the client
transaction to reflect an abend occurring in the DPL server.
- [SENSE_BYTES]
- is the SNA sense bytes if the abend was raised by DFHZAND.
- [ERROR_MESSAGE]
- is the error message sent from the remote system if the abend was raised
by DFHZAND.
- [EXECUTION_KEY]
- is a code indicating the execution key at the time the abend was issued,
or at the time the operating system abend or program check occurred.
- [STORAGE_TYPE]
- is a code indicating the storage hit on an OC4.
- [ERROR_OFFSET]
- is the offset of a program check or operating system abend in the failing
application program or CICS® AP domain program.
- [GENERAL_REGISTERS]
- is the contents of the general purpose registers at the time of a program
check or operating system abend.
- [PSW]
- is the contents of the PSW at the time of a program check or operating
system abend.
- [INTERRUPT_DATA]
- is the interrupt code and instruction length code etc, at the time of
a program check or operating system abend.
- [ALET]
- is the access list entry token (ALET) at the time of a program check
or operating system abend.
- [STOKEN]
- is the subspace token (STOKEN) at the time of a program check or operating
system abend.
- [SPACE]
- indicates whether the task was in SUBSPACE or BASESPACE mode at the
time of a program check or operating system abend. It can have any of these
values:
BASESPACE|SUBSPACE|NOSPACE
- [GREG_ORDER]
- indicates the order of the registers passed in GENERAL_REGISTERS. DFHSRP
saves the registers in the abend record in the order 0-15, and INQUIRE_ABEND_RECORD
will always return them in this order. It can have either of these values:
R14TOR13|R0TOR15
- [ACCESS_REGISTERS]
- is the contents of the access registers at the time of a program check
or operating system abend.
- [FLOATING_POINT_REGISTERS]
- is the contents of the floating point registers at the time of a program
check or operating system abend.
- [STATUS_FLAGS]
- is the status flags at the time of the abend.
Output parameters
- ABEND_TOKEN
- is the token allocated by ABAB for this abend. The token must be passed
on subsequent UPDATE_ABEND_RECORD and START_ABEND requests to ABAB. The token
is no longer valid after a START_ABEND request.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The UPDATE_ABEND_RECORD function of the ABAB gate is used to update an
abend record (TACB).
Input parameters
- ABEND_TOKEN
- is the token allocated by ABAB for this abend (on a preceding CREATE_ABEND_RECORD
request). The token must be passed on subsequent UPDATE_ABEND_RECORD and START_ABEND
requests to ABAB. The token is no longer valid after a START_ABEND request.
- [ABEND_CODE]
- is the four-character transaction abend code.
- [FAILING_PROGRAM]
- is the name of the program in which the abend occurred.
- [REQUEST_ID]
- is the request ID from the TCTTE for a terminal-oriented task.
- [FAILING_RESOURCE]
- is the name of the system TCTTE (the connection) if the abend was raised
by DFHZAND.
- [REMOTE_SYSTEM]
- is the name of the remote system if the abend was raised in the client
transaction to reflect an abend occurring in the DPL server.
- [SENSE_BYTES]
- is the SNA sense bytes if the abend was raised by DFHZAND.
- [ERROR_MESSAGE]
- is the error message sent from the remote system if the abend was raised
by DFHZAND.
- [EXECUTION_KEY]
- is a code indicating the execution key at the time the abend was issued,
or at the time the operating system abend or program check occurred.
- [STORAGE_TYPE]
- is a code indicating the storage hit on an OC4.
- [ERROR_OFFSET]
- is the offset of a program check or operating system abend in the failing
application program or CICS AP domain program.
- [GENERAL_REGISTERS]
- is the contents of the general purpose registers at the time of a program
check or operating system abend.
- [PSW]
- is the contents of the PSW at the time of a program check or operating
system abend.
- [INTERRUPT_DATA]
- is the interrupt code and instruction length code etc, at the time of
a program check or operating system abend.
- [ALET]
- is the access list entry token (ALET) at the time of a program check
or operating system abend.
- [STOKEN]
- is the subspace token (STOKEN) at the time of a program check or operating
system abend.
- [SPACE]
- indicates whether the task was in SUBSPACE or BASESPACE mode at the
time of a program check or operating system abend. It can have any of these
values:
BASESPACE|SUBSPACE|NOSPACE
- [GREG_ORDER]
- indicates the order of the registers passed in GENERAL_REGISTERS. DFHSRP
saves the registers in the abend record in the order 0-15, and INQUIRE_ABEND_RECORD
will always return them in this order. It can have either of these values:
R14TOR13|R0TOR15
- [ACCESS_REGISTERS]
- is the contents of the access registers at the time of a program check
or operating system abend.
- [FLOATING_POINT_REGISTERS]
- is the contents of the floating point registers at the time of a program
check or operating system abend.
- [STATUS_FLAGS]
- is the status flags at the time of the abend.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
INVALID_TOKEN |
The START_ABEND function of the ABAB gate is used to start transaction
abend processing.
Input parameters
- ABEND_TOKEN
- is the token allocated by ABAB for this abend (on a preceding CREATE_ABEND_RECORD
request).
- [DUMP]
- indicates whether a transaction dump should be produced for this abend.
It can have either of these values:
YES|NO
- [IGNORE_HANDLES]
- indicates whether this abend should be passed to any EXEC CICS HANDLE
routines that are active. IGNORE_HANDLES(YES) results in EXEC CICS HANDLE
being ignored at all levels of the program stack. It can have either of these
values:
YES|NO
Output parameters
- RETRY_ADDRESS
- if an XPCTA exit requests retry, control returns to the point of invocation
of start_info, passing the retry address. This address includes the AMODE
indicator in the first bit; it can be used as the target address in a DFHAM
TYPE=BRANCH by the caller of START_ABEND GENERAL_REGISTERS is also set to
point to the list of registers to be used for the retry, and SPACE to indicate
the subspace.
- [GENERAL_REGISTERS]
- is the contents of the general purpose registers at the time of a program
check or operating system abend.
- [SPACE]
- indicates whether the task was in SUBSPACE or BASESPACE mode at the
time of a program check or operating system abend.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
INVALID_TOKEN |
The INQUIRE_ABEND_RECORD function of the ABAB gate is used to inquire about
an abend record (TACB).
Input parameters
- [ABEND_TYPE]
- indicates which abend record the information is to be extracted from.
It can have any of these values:
LATEST|FIRST|LASTASRA
Output parameters
- [ABEND_CODE]
- is the four-character transaction abend code.
- [DUMP]
- indicates whether a dump was requested for this abend. It can have either
of these values:
YES|NO
- [REQUEST_ID]
- is the request ID from the TCTTE for a terminal-oriented task.
- [FAILING_RESOURCE]
- is the name of the system TCTTE (the connection) if the abend was raised
by DFHZAND.
- [FAILING_PROGRAM]
- is the name of the program in which the abend occurred.
- [REMOTE_SYSTEM]
- is the name of the remote system if the abend was raised in the client
transaction to reflect an abend occurring in the DPL server.
- [SENSE_BYTES]
- is the SNA sense bytes if the abend was raised by DFHZAND.
- [ERROR_MESSAGE]
- is the error message sent from the remote system if the abend was raised
by DFHZAND.
- [EXECUTION_KEY]
- is a code indicating the execution key at the time the abend was issued,
or at the time the operating system abend or program check occurred.
- [STORAGE_TYPE]
- is a code indicating the storage hit on an OC4.
- [ERROR_OFFSET]
- is the offset of a program check or operating system abend in the failing
application program or CICS AP domain program.
- [GENERAL_REGISTERS]
- is the contents of the general purpose registers at the time of a program
check or operating system abend.
- [PSW]
- is the contents of the PSW at the time of a program check or operating
system abend.
- [INTERRUPT_DATA]
- is the interrupt code and instruction length code etc, at the time of
a program check or operating system abend.
- [ALET]
- is the access list entry token (ALET) at the time of a program check
or operating system abend.
- [STOKEN]
- is the subspace token (STOKEN) at the time of a program check or operating
system abend.
- [SPACE]
- indicates whether the task was in SUBSPACE or BASESPACE mode at the
time of a program check or operating system abend. It can have any of these
values:
BASESPACE|SUBSPACE|NOSPACE
- [ACCESS_REGISTERS]
- is the contents of the access registers at the time of a program check
or operating system abend.
- [FLOATING_POINT_REGISTERS]
- is the contents of the floating point registers at the time of a program
check or operating system abend.
- [STATUS_FLAGS]
- is the status flags at the time of the abend.
- [IGNORE_HANDLES]
- indicates whether this abend should be passed to any EXEC CICS HANDLE
routines that are active. IGNORE_HANDLES(YES) results in EXEC CICS HANDLE
being ignored at all levels of the program stack. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
NO_ABEND_RECORD |
The TAKE_TRANSACTION_DUMP function of the ABAB gate is used to take a transaction
dump.
Notes:
- The TRANSACTION resource definition must specify dump and DUMP(YES) must
be specified or defaulted on the associated START_ABEND call.
- A transaction dump is not taken if any of the following is true:
- The application is going to handle the abend; that is, there is an active
handle at this level and IGNORE_HANDLES(NO) is specified or defaulted on the
associated START_ABEND call.
- The application is Language Environment/370 enabled, in which case the
language interface deals with the abend.
- A transaction dump is currently in progress.
Input parameters
None.
Output parameters
None.
The TRANSFER_SIT function of the APAP gate is used to transfer the address
of DFHSIT to the AP domain after a GET_PARAMETERS call from this domain to
the parameter manager domain.
Input parameters
- SIT
- specifies the address and length of the system initialization table
(DFHSIT).
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_ADDRESS
INCONSISTENT_RELEASE
|
INVALID |
INVALID_SIT_LENGTH
INVALID_ADDRESS
INVALID_FUNCTION
|
The
ESTIMATE_ALL function of the APCR gate is used to estimate the size of terminal
input/output area (TIOA) needed to ship a channel.
Input parameters
- COMMAND
- is the type of API command that caused the channel to be shipped. COMMAND
can have any of these values:
START_MRO|START_ISC|LINK|RETURN
- [CHANNEL_NAME]
- is the name of the channel.
- [CHANNEL_TOKEN]
- is a token referencing the channel.
Output parameters
- BYTES_NEEDED
- is the total size, in bytes, of the exported channel, including channel
and container headers and the overall length of the data in the containers.
This total includes all bytes for all containers.
- [CHANNEL_TOKEN_OUT]
- contains, if CHANNEL_NAME was specified on input, a token referencing
the channel.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ERROR
|

The ESTIMATE_CHANGED function of the APCR gate is used to obtain the size
of the channel data structure that will be used to ship the containers that
have been modified since the IMPORT_ALL call. Only new, modified, or deleted
containers are shipped, with deleted containers being shipped as container
headers only.
This call must be supplied with a CONTAINER_LIST from an earlier IMPORT_ALL
call. This list specifies all the containers that were created by the IMPORT_ALL
call.
The output includes a NEW_CONTAINER_LIST that can be passed to a subsequent
EXPORT_CHANGED call. This list specifies all the containers that have been
modified or deleted since the IMPORT_ALL call, and that must therefore be
exported by EXPORT_CHANGED.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel.
- COMMAND
- is the type of API command that caused the channel to be shipped. COMMAND
can have any of these values:
START_MRO|START_ISC|LINK|RETURN
- CONTAINER_LIST
- is a list of all the containers in the channel, obtained from an earlier
IMPORT_ALL call.
Output parameters
- BYTES_NEEDED
- is the size, in bytes, of the channel data structure needed to transmit
the containers that have been modified since the IMPORT_ALL call. This figure
includes:
- The total size of any new containers in the channel, including the container
headers and the data in the containers
- The total size of any modified containers in the channel, including the
container headers and the data in the containers
- The total size of the container headers for any deleted containers in
the channel
- NEW_CONTAINER_LIST
- is a list of all the containers in the channel that have been created,
modified, or deleted since the last IMPORT_ALL call. This list must be passed
to a subsequent EXPORT_CHANGED call.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ERROR
|

The EXPORT_ALL function of the APCR gate is used to export the complete
contents of a channel.
If a TERMINAL_TOKEN is supplied, terminal control is used to export the
channel.
If an RS_TOKEN is supplied, the channel is exported from a listener region
by request streams.
If a CORRELATION_ID is supplied, the channel is exported from an AOR by
request streams.
The COMMAND keyword is used both to document the origin of the request
in a trace, and to control whether an ID is used before or after the overall
channel length.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be exported.
- COMMAND
- is the type of API command that caused the channel to be exported. COMMAND
can have any of these values:
START_MRO|START_ISC|LINK|RETURN|SIBUS
- [CORRELATION_ID]
- If CORRELATION_ID is specified, the channel is exported from an AOR
by request streams. (RZTA SEND_REPLY is used.)
- [RS_TOKEN]
- is a token referencing the request stream with which the channel is
associated. If RS_TOKEN is specified, the channel is exported from a listener
region by request streams. (RZSO SEND_REQUEST is used).
- [TERMINAL_TOKEN]
- is a token referencing the terminal with which the channel is associated.
If TERMINAL_TOKEN is specified, CICS terminal control is used to export the
channel.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ERROR
TERMINAL_ERROR
|
- CHANNEL_ERROR
- indicates a failure in extracting the channel and container details.
- TERMINAL_ERROR
- indicates that a transmission error was detected either by terminal
control or by request streams. If the error is detected by terminal control,
TC_ABEND, TC_RESPONSE, and TC_SENSE provide additional terminal control diagnostic
information. These keywords can be omitted for requests to export a channel
using a request stream.
- [TC_ABEND]
- is the terminal control abend code.
- [TC_RESPONSE]
- is the terminal control response code.
- [TC_SENSE]
- is the terminal sense code.

The EXPORT_CHANGED function of the APCR gate is used to return only those
parts of a channel that have changed since IMPORT_ALL was issued.
Currently, only terminal control is supported on this call. Request streams
are not supported.
EXPORT_CHANGED must be supplied with a CONTAINER_LIST built by an ESTIMATE_CHANGED
call.
Currently, EXPORT_CHANGED always builds output in the form used by the
LINK commands (length followed by ID).
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be exported.
- CONTAINER_LIST
- is a list of the containers in this channel that have been created,
modified, or deleted since the last IMPORT_ALL call. This list should be obtained
from the NEW_CONTAINER_LIST field of an ESTIMATE_CHANGED call.
- COMMAND
- is the type of API command that caused the channel to be exported. Currently,
COMMAND can have only the following value:
LINK
- TERMINAL_TOKEN
- is a token referencing the terminal with which the channel is associated.
CICS terminal control is used to export the channel.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ERROR
DATA_ERROR
TERMINAL_ERROR
|
- CHANNEL_ERROR
- indicates a failure in extracting the channel and container details.
- DATA_ERROR
- indicates a failure in extracting the data from the channel’s containers.
- TERMINAL_ERROR
- indicates that a transmission error was detected by CICS terminal control.
If an error is detected by terminal control, TC_ABEND, TC_RESPONSE, and TC_SENSE
provide additional terminal control diagnostic information.
- [TC_ABEND]
- is the terminal control abend code.
- [TC_RESPONSE]
- is the terminal control response code.
- [TC_SENSE]
- is the terminal sense code.

The IMPORT_ALL function of the APCR gate is used to import the complete
contents of a channel.
Typically, IMPORT_ALL creates the channel (and all its containers) into
which the channel data is imported. However, if the CHANNEL_TOKEN_IN keyword
is specified, IMPORT_ALL can import into an existing channel. In this case,
the existing channel is typically empty, though this is not enforced.
If a TERMINAL_TOKEN is supplied, terminal control is used to import the
channel.
If an RS_TOKEN is supplied, the channel is imported into an AOR by request
streams.
If neither a TERMINAL_TOKEN nor an RS_TOKEN is supplied, the channel is
imported into a listener region by request streams.
The COMMAND keyword is used both to document the origin of the request
in a trace, and to control whether an ID is used before or after the overall
channel length.
Input parameters
- CHANNEL_TOKEN_IN
- is a token referencing an existing channel into which the channel data
is to be imported.
- COMMAND
- is the type of API command that caused the channel to be imported. COMMAND
can have any of these values:
START_MRO|START_ISC|LINK|RETURN|SIBUS
- [DATA_START]
- is the position of the beginning of the channel data in the inbound
TIOA.
- [RS_TOKEN]
- is a token referencing the request stream with which the channel to
be imported is associated. If RS_TOKEN is specified, the channel is imported
into an AOR by request streams. (RZTA RECEIVE_REQUEST is used.)
If neither
TERMINAL_TOKEN nor RS_TOKEN is specifed, the channel is imported into a listener
region by request streams. (RZSO RECEIVE_REPLY is used.) In this case, a CORRELATION_ID
is returned for use with a subsequent EXPORT_ALL request.
- [TERMINAL_TOKEN]
- is a token referencing the terminal with which the channel to be imported
is associated. CICS terminal control is used to import the channel.
If
TERMINAL_TOKEN is specified, DATA_START must also be specified, to identify
the position of the beginning of the channel data in the inbound TIOA.
If neither TERMINAL_TOKEN nor RS_TOKEN is specifed, the channel is imported
into a listener region by request streams. (RZSO RECEIVE_REPLY is used.) In
this case, a CORRELATION_ID is returned for use with a subsequent EXPORT_ALL
request.
Output parameters
- [CHANNEL_NAME]
- is the name of the channel that has been created.
- [CHANNEL_TOKEN]
- is a token referencing the channel that has been created.
- [CONTAINER_LIST]
- is the address of a control block that identifies the initial state
of the channel. It can be passed to a subsequent EXPORT_CHANGED call, when
it is used to identify what changes have been made by comparing the initial
state of the channel to the current state. This allows CICS to re-export only
the changed containers.
- [CORRELATION_ID]
-
- [DATA_END]
-
- [SIZE]
-
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
DATA_ERROR
TERMINAL_ERROR
|
- DATA_ERROR
- indicates that an error was detected in the inbound channel data. For
example, an invalid channel or container header or a premature end to data
all result in DATA_ERROR.
- TERMINAL_ERROR
- indicates that a transmission error was detected either by CICS terminal
control or by request streams.
If an error is detected by terminal control,
TC_ABEND, TC_RESPONSE, and TC_SENSE provide additional terminal control diagnostic
information. These keywords can be omitted for requests to import a channel
using a request stream.
- [TC_ABEND]
- is the terminal control abend code.
- [TC_RESPONSE]
- is the terminal control response code.
- [TC_SENSE]
- is the terminal sense code.

The IMPORT_CHANGED function of the APCR gate is used to import those parts
of a channel that have been modified since an EXPORT_ALL call. Any modified
containers are either replaced or deleted. New containers are added. Unchanged
containers are not received on the connection.
Currently, only terminal control intersystem links are supported. Request
streams are not supported.
Currently, IMPORT_CHANGED always expects data in the format used for function-shipped
LINK commands (length followed by ID).
DATA_START is used to locate the beginning of the channel data in the TIOA.
Input parameters
- CHANNEL_TOKEN
- is a token referencing the channel to be imported.
- COMMAND
- is the type of API command that caused the channel to be imported. COMMAND
can have only the following value:
LINK
- DATA_START
- is the position of the beginning of the channel data in the inbound
TIOA.
- TERMINAL_TOKEN
- is a token referencing the terminal with which the channel to be imported
is associated. CICS terminal control is used to import the channel.
If
TERMINAL_TOKEN is specified, DATA_START must also be specified, to identify
the position of the beginning of the channel data in the inbound TIOA.
Output parameters
- CHANNEL_ERROR
- indicates a failure in extracting the channel and container details.
- [DATA_END]
- is the position in the final TIOA, immediately following the end of
the channel.
- [SIZE]
- The total number of bytes in all the containers in the channel.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|EXCEPTION|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
CHANNEL_ERROR
DATA_ERROR
TERMINAL_ERROR
|
- DATA_ERROR
- indicates that an error was detected in the inbound channel data. For
example, an invalid channel or container header or a premature end to data
all result in DATA_ERROR.
- TERMINAL_ERROR
- indicates that a transmission error was detected either by CICS terminal
control or by request streams.
If an error is detected by terminal control,
TC_ABEND, TC_RESPONSE, and TC_SENSE provide additional terminal control diagnostic
information. These keywords can be omitted for requests to import a channel
using a request stream.
- [TC_ABEND]
- is the terminal control abend code.
- [TC_RESPONSE]
- is the terminal control response code.
- [TC_SENSE]
- is the terminal sense code.
The INVOKE_USER_EXIT function of the APEX gate is used to invoke the user
exit at a specified exit point.
Input parameters
- EXIT_POINT
- is the name of the exit.
- TRACE
- indicates whether or not user exits are to be traced. It can have either
of these values:
YES|NO
- [EXIT_PARAMETER_n]
- is the parameter (number n) required by the exit. The nature
of the parameter varies from one exit to another.
Output parameters
- EXIT_RETURN_CODE
- is the return code, if any, issued by the exit.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, DISASTER, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
EXIT_PROGRAM_FAILURE
CHANGE_MODE_FAILURE
|
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION
INVALID_EXIT_POINT
|
The PROFILE function of the APID gate extracts information from the AP
domain profile for timeout.
Input parameters
- NAME
- is the name of the profile
Output parameters
- RTIMEOUT
- is the read timeout value.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
NOT_FOUND
TM_LOCATE_FAILED
|
The PROFILE function of the APID gate extracts information from the AP
domain profile for timeout.
Input parameters
- SYSID
- is the name of the sysid
Output parameters
- NETNAME
- is the value of the netname for the given sysid.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
NOT_FOUND
TM_LOCATE_FAILED
|
The INQ_APPLICATION_DATA function of the APIQ gate is used to inquire about
application data owned by the application domain.
Input parameters
None.
Output parameters
- [EIB]
- is the address of the EXEC Interface Block.
- [SYSEIB]
- is the address of the System EXEC Interface Block.
- [TCTUA]
- is the address of the Task Control Table User Area.
- [TCTUASIZE]
- is the length (in bytes) of the Task Control Table User Area.
- [TWA]
- is the address of the Task Work Area.
- [TWASIZE]
- is the length (in bytes) of the Task Work Area.
- [RSA]
- is the address of the apllication's register save area.
- [DSA]
- is the address of the head of the chain of dynamic storage for reentrant
programs.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INQ_FAILED
LOOP
|
EXCEPTION |
DPL_PROGRAM
NO_TRANSACTION_ENVIRONMENT
TRANSACTION_DOMAIN_ERROR
|
INVALID |
INVALID_FUNCTION |
The WRITE_JOURNAL_DATA function of the APJC gate is used to write a single
record into a named journal.
Input parameters
- JOURNALNAME
- is the journal identifier name.
- JOURNAL_RECORD_ID
- is the system type record identifier.
- FROM
- is the address of the record.
- [RECORD_PREFIX]
- is the journal record user prefix.
- WAIT
- specifies whether or not CICS is to wait until the record is written
to auxiliary storage before returning control to the exit program. It can
have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
JOURNAL_NOT_FOUND
LENGTH_ERROR
JOURNAL_NOT_OPEN
STATUS_ERROR
IO_ERROR
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The ESTABLISH_LANGUAGE function of the APLH gate is used to establish the
language of a compiled Java™ program with hot-pooling.
Input parameters
- LOAD_POINT
- is the load point address of the program.
- ENTRY_POINT
- is the entry point address of the program.
- [PROGRAM_LENGTH]
- is the length of the program.
- [DEFINED_LANGUAGE]
- is the language defined for the program. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI|NOT_DEFINED
- EXECUTION_KEY
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
- DATA_LOCATION
- defines whether the program can handle only 24-bit addresses (data located
below the 16MB line) can handle 31-bit addresses (data located above or below
the 16MB line). It can have either of these values:
ANY|BELOW
- LANGUAGE_BLOCK
- is a token identifying the current language block for the program.
- PROGRAM
- is the 8-character name of the program whose language is to be determined
- REQUEST_TYPE
- identifies the call of establish language. If the caller has a request
type of link and establish language fails, then abend. Do not abend for a
request type of load.
- THREADSAFE
- indicates whether whether the program is quasi-reentrant (and must execute
on the QR TCB) or threadsafe (and can execute on the QR TCB or an OPEN TCB).
- JVM_CLASS_PTR
- is a token addressing the JVM class name length and value.
- HOTPOOL
- indicates whether the program is to be run in a hotpool under an H8
TCB, or under QR as usual.
- JVM_PROG
- indicates whether the request is for establish language for a JVM program.
Output parameters
- [NEW_BLOCK]
- is a new token identifying the new language block for the program.
- [LANGUAGE_ESTABLISHED]
- is the language established for the program. It can have any of these
values:
ASSEMBLER|C370|COBOL|COBOL2|LE370|PLI|JVM|
ASSEMBLER_CICS|MVSLE370|
NOT_DEFINED|NOT_APPLIC
- [CICSVAR_THREADSAFE]
- is the threadsafe value established for the program. It can have any
of these values:
YES|NO|NOT_DEFINED
- [RUNTIME_ENVIRONMENT]
- is the runtime environment established for the program. It can have
any of these values:
JVM_RUNTIME|LE370_RUNTIME|NON_LE370_RUNTIME|
HOTPOOL_RUNTIME
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND |
INVALID |
INVALID_FUNCTION |
The START_PROGRAM function of the APLI gate is used to start a compiled
Java program using hot-pooling.
Input parameters
- PROGRAM
- is the eight-character name of the program.
- LINK_LEVEL
- is the 16-bit value indicating the link-level of the program.
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF). It can have any of these values:
CEDF|NOCEDF
- [EXECUTION_SET]
- indicates whether you want CICS to link to and run the program as if
it were running in a remote CICS region (with or without the API restrictions
of a DPL program). It can have either of these values:
FULLAPI|DPLSUBSET|NOT_APPLIC
- [PARMLIST_PTR]
- is an optional token identifying the parameter list for the program.
- COMMAREA
- is an optional token identifying the communications area for the program.
- [ENVIRONMENT_TYPE]
- is the environment type of the program. It can have any of these values:
EXEC|GLUE|PLT|SYSTEM|TRUE|URM
- [SYNCONRETURN]
- defines whether or not a syncpoint is to be taken on return from the
linked program. It can have either of these values:
YES|NO
- LANGUAGE_BLOCK
- LANGUAGE_BLOCK is a token giving the address of the current Program
Language Block.
- [SYSEIB_REQUEST]
- indicates whether or not an EXEC CICS LINK or EXEC CICS XCTL had the
SYSEIB translator option specified.
- [DEFERRED_ABEND_FOR_XCTL]
- indicates whether a Runaway type abend should be started on completion
of the current START_PROGRAM.
Output parameters
- ABEND_CODE
- is the four-character abend code which is issued by CICS when an exception
response is given and the cause of the error was a transaction abend.
- IGNORE_PENDING_XCTL
- indicates whether or not a pending XCTL should be ignored by program
manager.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND
JVMPOOL_DISABLED
JVM_PROFILE_NOT_FOUND
JVM_PROFILE_NOT_VALID
SYSTEM_PROPERTIES_NOT_FND
USER_CLASS_NOT_FOUND
|
INVALID |
INVALID_FUNCTION |
The NOTIFY_REFRESH function is called to inform AP domain when a program
is refeshed, so that it can quiesce all users of the program.
Input parameters
- PROGRAM
- is the eight-character name of the program.
Output parameters
- [ABEND_CODE]
- is the four-character abend code that is to be issued by CICS when an
exception response is given and the cause of the error is a transaction abend.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND |
INVALID |
INVALID_FUNCTION |
The ESTABLISH_LANGUAGE function of the APLI gate is used to establish the
language of a conventional compiled program.
Input parameters
- LOAD_POINT
- is the load point address of the program.
- ENTRY_POINT
- is the entry point address of the program.
- [PROGRAM_LENGTH]
- is the length of the program.
- [DEFINED_LANGUAGE]
- is the language defined for the program. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI|NOT_DEFINED
- EXECUTION_KEY
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
- DATA_LOCATION
- defines whether the program can handle only 24-bit addresses (data located
below the 16MB line) can handle 31-bit addresses (data located above or below
the 16MB line). It can have either of these values:
ANY|BELOW
- LANGUAGE_BLOCK
- is a token identifying the current language block for the program.
- PROGRAM
- is the 8-character name of the program whose language is to be determined
- REQUEST_TYPE
- identifies the call of establish language. If the caller has a request
type of link and establish language fails, then abend. Do not abend for a
request type of load.
- THREADSAFE
- indicates whether whether the program is quasi-reentrant (and must execute
on the QR TCB) or threadsafe (and can execute on the QR TCB or an OPEN TCB).
- JVM_CLASS_PTR
- is a token addressing the JVM class name length and value.
- HOTPOOL
- indicates whether the program is to be run in a hotpool under an H8
TCB, or under QR as usual.
- JVM_PROG
- indicates whether the request is for establish language for a JVM program.
Output parameters
- [NEW_BLOCK]
- is a new token identifying the new language block for the program.
- [LANGUAGE_ESTABLISHED]
- is the language established for the program. It can have any of these
values:
ASSEMBLER|C370|COBOL|COBOL2|LE370|PLI|JVM|
ASSEMBLER_CICS|MVSLE370|
NOT_DEFINED|NOT_APPLIC
- [CICSVAR_THREADSAFE]
- is the threadsafe value established for the program. It can have any
of these values:
YES|NO|NOT_DEFINED
- [RUNTIME_ENVIRONMENT]
- is the runtime environment established for the program. It can have
any of these values:
JVM_RUNTIME|LE370_RUNTIME|NON_LE370_RUNTIME|
HOTPOOL_RUNTIME
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND |
INVALID |
INVALID_FUNCTION |
The START_PROGRAM function of the APLI gate is used to start a program.
Input parameters
- PROGRAM
- is the eight-character name of the program.
- LINK_LEVEL
- is the 16-bit value indicating the link-level of the program.
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF). It can have any of these values:
CEDF|NOCEDF
- [EXECUTION_SET]
- indicates whether you want CICS to link to and run the program as if
it were running in a remote CICS region (with or without the API restrictions
of a DPL program). It can have either of these values:
FULLAPI|DPLSUBSET|NOT_APPLIC
- [PARMLIST_PTR]
- is an optional token identifying the parameter list for the program.
- COMMAREA
- is an optional token identifying the communications area for the program.
- [ENVIRONMENT_TYPE]
- is the environment type of the program. It can have any of these values:
EXEC|GLUE|PLT|SYSTEM|TRUE|URM
- [SYNCONRETURN]
- defines whether or not a syncpoint is to be taken on return from the
linked program. It can have either of these values:
YES|NO
- LANGUAGE_BLOCK
- LANGUAGE_BLOCK is a token giving the address of the current Program
Language Block.
- [SYSEIB_REQUEST]
- indicates whether or not an EXEC CICS LINK or EXEC CICS XCTL had the
SYSEIB translator option specified.
- [DEFERRED_ABEND_FOR_XCTL]
- indicates whether a Runaway type abend should be started on completion
of the current START_PROGRAM.
Output parameters
- ABEND_CODE
- is the four-character abend code which is issued by CICS when an exception
response is given and the cause of the error was a transaction abend.
- IGNORE_PENDING_XCTL
- indicates whether or not a pending XCTL should be ignored by program
manager.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND
JVMPOOL_DISABLED
JVM_PROFILE_NOT_FOUND
JVM_PROFILE_NOT_VALID
SYSTEM_PROPERTIES_NOT_FND
USER_CLASS_NOT_FOUND
|
INVALID |
INVALID_FUNCTION |
The ESTABLISH_LANGUAGE function of the APLI gate is used to establish the
language parameters of a Java bytecode program.
Input parameters
- LOAD_POINT
- is the load point address of the program.
- ENTRY_POINT
- is the entry point address of the program.
- [PROGRAM_LENGTH]
- is the length of the program.
- [DEFINED_LANGUAGE]
- is the language defined for the program. It can have any of these values:
ASSEMBLER|C370|COBOL|LE370|PLI|NOT_DEFINED
- EXECUTION_KEY
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
- DATA_LOCATION
- defines whether the program can handle only 24-bit addresses (data located
below the 16MB line) can handle 31-bit addresses (data located above or below
the 16MB line). It can have either of these values:
ANY|BELOW
- LANGUAGE_BLOCK
- is a token identifying the current language block for the program.
- PROGRAM
- is the 8-character name of the program whose language is to be determined
- REQUEST_TYPE
- identifies the call of establish language. If the caller has a request
type of link and establish language fails, then abend. Do not abend for a
request type of load.
- THREADSAFE
- indicates whether whether the program is quasi-reentrant (and must execute
on the QR TCB) or threadsafe (and can execute on the QR TCB or an OPEN TCB).
- JVM_CLASS_PTR
- is a token addressing the JVM class name length and value.
- HOTPOOL
- indicates whether the program is to be run in a hotpool under an H8
TCB, or under QR as usual.
- JVM_PROG
- indicates whether the request is for establish language for a JVM program.
Output parameters
- [NEW_BLOCK]
- is a new token identifying the new language block for the program.
- [LANGUAGE_ESTABLISHED]
- is the language established for the program. It can have any of these
values:
ASSEMBLER|C370|COBOL|COBOL2|LE370|PLI|JVM|
ASSEMBLER_CICS|MVSLE370|
NOT_DEFINED|NOT_APPLIC
- [CICSVAR_THREADSAFE]
- is the threadsafe value established for the program. It can have any
of these values:
YES|NO|NOT_DEFINED
- [RUNTIME_ENVIRONMENT]
- is the runtime environment established for the program. It can have
any of these values:
JVM_RUNTIME|LE370_RUNTIME|NON_LE370_RUNTIME|
HOTPOOL_RUNTIME
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND |
INVALID |
INVALID_FUNCTION |
The START_PROGRAM function of the APLI gate is used to start a Java bytecode
program.
Input parameters
- PROGRAM
- is the eight-character name of the program.
- LINK_LEVEL
- is the 16-bit value indicating the link-level of the program.
- [CEDF_STATUS]
- indicates whether or not the EDF diagnostic screens are displayed when
the program is running under the control of the execution diagnostic facility
(EDF). It can have any of these values:
CEDF|NOCEDF
- [EXECUTION_SET]
- indicates whether you want CICS to link to and run the program as if
it were running in a remote CICS region (with or without the API restrictions
of a DPL program). It can have either of these values:
FULLAPI|DPLSUBSET|NOT_APPLIC
- [PARMLIST_PTR]
- is an optional token identifying the parameter list for the program.
- COMMAREA
- is an optional token identifying the communications area for the program.
- [ENVIRONMENT_TYPE]
- is the environment type of the program. It can have any of these values:
EXEC|GLUE|PLT|SYSTEM|TRUE|URM
- [SYNCONRETURN]
- defines whether or not a syncpoint is to be taken on return from the
linked program. It can have either of these values:
YES|NO
- LANGUAGE_BLOCK
- LANGUAGE_BLOCK is a token giving the address of the current Program
Language Block.
- [SYSEIB_REQUEST]
- indicates whether or not an EXEC CICS LINK or EXEC CICS XCTL had the
SYSEIB translator option specified.
- [DEFERRED_ABEND_FOR_XCTL]
- indicates whether a Runaway type abend should be started on completion
of the current START_PROGRAM.
Output parameters
- ABEND_CODE
- is the four-character abend code which is issued by CICS when an exception
response is given and the cause of the error was a transaction abend.
- IGNORE_PENDING_XCTL
- indicates whether or not a pending XCTL should be ignored by program
manager.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND
JVMPOOL_DISABLED
JVM_PROFILE_NOT_FOUND
JVM_PROFILE_NOT_VALID
SYSTEM_PROPERTIES_NOT_FND
USER_CLASS_NOT_FOUND
|
INVALID |
INVALID_FUNCTION |
The PIPI_INIT_SUB_DP function of the APLJ gate is used to invoke the Language
Environment PIPI init_sub_dp function to initialize a subroutine
environment.
Input parameters
- PIPI_TABLE_ADDRESS
- is the address of the PIPI table.
- PIPI_SERVICE_RTNS
- is the address of the PIPI service routine vector. For CICS, this addresses
a vector providing entry points in DFHAPPIJ for GETSTORAGE and FREESTORAGE.
- PIPI_RUNTIME_OPTIONS
- is a character string containing the runtime options to be passed to
Language Environment by PIPI.
- EXECUTION_KEY
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
Output parameters
- PIPI_TOKEN
- is a token identifying the PIPI subroutine environment for subsequent
PIPI_CALL_SUB and PIPI_CALL_TERM calls.
- [PIPI_RETURN_CODE]
- is the return code set by PIPI.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND |
INVALID |
INVALID_FUNCTION |
The PIPI_CALL_SUB function of the APLJ gate is used to invoke the Language
Environment PIPI call_sub function to call a subroutine in a previously
initialized enclave.
Input parameters
- PIPI_TOKEN
- is the token identifying the PIPI subroutine environment, as returned
on the PIPI_INIT_SUB_DP call.
- PIPI_TABLE_INDEX
- is the index into the PIPI table for the required function.
- PIPI_CALL_PARAMETERS
- is the address of the parameters to be passed on the PIPI subroutine
call.
- EXECUTION_KEY
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
Output parameters
- [PIPI_RETURN_CODE]
- is the return code set by PIPI.
- [PIPI_SUB_RETURN_CODE]
- is the subroutine return code. If the enclave is terminated due to an
unhandled condition, a STOP statement, or an EXIT statement (or an exit()
function), this contains the return code for enclave termination.
- [PIPI_SUB_REASON_CODE]
- is the subroutine reason code. This is 0 for normal subroutine returns.
If the enclave is terminated due to an unhandled condition, a STOP statement,
or an EXIT statement (or an exit() function), this contains the reason code
for enclave termination.
- [PIPI_SUB_FEEDBACK]
- is the feedback code for enclave termination. This is the CEE000 feedback
code for normal subroutine returns. If the enclave is terminated due to an
unhandled condition, a STOP statement, or an EXIT statement (or an exit()
function), this contains the feedback code for enclave termination.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND |
INVALID |
INVALID_FUNCTION |
The PIPI_TERM function of the APLJ gate is used to invoke the Language
Environment PIPI term function to terminate a previously initialized
enclave.
Input parameters
- PIPI_TOKEN
- is the token identifying the PIPI subroutine environment, as returned
on the PIPI_INIT_SUB_DP call.
- EXECUTION_KEY
- is the key in which CICS gives control to the program, and determines
whether the program can modify CICS-key storage. It can have either of these
values:
CICS|USER
Output parameters
- [PIPI_RETURN_CODE]
- is the return code set by PIPI.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
TRANSACTION_ABEND |
INVALID |
INVALID_FUNCTION |
The ROUTE_TRANSACTION function of the APRT gate is used to dynamically
route transactions (which are defined to be dynamic and not automatically
initiated) based on decisions made by the dynamic transaction routing program. For transactions which
are automatically initiated or are defined to be remote and not dynamic, DFHAPRT
will statically route such transactions.
Input parameters
- DYNAMIC
- indicates whether or not the transaction is defined as dynamic. It can
have either of these values:
YES|NO
- REMOTE
- indicates whether or not the transaction is defined as remote. It can
have either of these values:
YES|NO
- REMOTE_NAME
- is the four-character transaction identifier by which this transaction
is to be known on the remote CICS region.
- REMOTE_SYSTEM
- is the eight-character name of the remote CICS region to which the transaction
is to be routed.
- DTRTRAN
- indicates whether or not dynamic transaction routing is available. It
can have either of these values:
YES|NO
Output parameters
- RAN_LOCALLY
- indicates whether or not the transaction ran on the local CICS region
(that is, was not routed to a remote CICS region). It can have either of these
values:
YES|NO
- ABEND_CODE
- is the four-character transaction abend code issued if the transaction
terminates abnormally.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
EXCEPTION |
PROGRAM_NOT_FOUND
TRANSACTION_ABEND
ISC_DISABLED
REMOTE_CONN_OOS
REMOTE_CONN_OOS_SYS_CHGD
ALL_SESSIONS_BUSY
ROUTE_FAILED
DTRTRAN_REJECTED
NOTAUTH
|
The CANCEL function of the APTC gate invalidates the listening function.
Input parameters
- TOKEN
- is the token for the session TCTTE
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
TOKEN_UNKNOWN
TC_ERROR
|
The CLOSE function of the APTC gate is used in cleanup.
Input parameters
- TOKEN
- is the token for the session TCTTE
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
TOKEN_UNKNOWN
TC_ERROR
|
The EXTRACT_PROCESS function of the APTC gate extracts information for
the request.
Input parameters
- NONE
- No input parameters
Output parameters
- CONVID
- is the conversation id (which is the session tctte termid).
- PROCESS_NAME
- is the name of the process to be invoked
- SYNCLEVEL
- is the synclevel of the conversation
- PIPDATA
- Applicable only for LU6.2 conversations
- PIPDATA LENGTH
- Applicable only for LU6.2 conversations.
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
TOKEN_UNKNOWN
TC_ERROR
|
The ISSUE_NOTIFY function of the APTC gate is used to inform the program
DFHAPTC that a request has arrived.
Input parameters
- TOKEN
- is the token for the session TCTTE
- USER_TOKEN
- is the token supplied the the person who is to be notified.
- ACTION
- specifies the action that should be taken.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
TOKEN_UNKNOWN
ISSUE_NOTIFY_ERROR
ACTION_UNKNOWN
|
The LISTEN function of the APTC gate is used to update the TCTTE with the
user token.
Input parameters
- TOKEN
- is the token for the session TCTTE
- USER_TOKEN
- is a token supplied by requeststreams.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
TOKEN_UNKNOWN
TC_ERROR
|
The OPEN function of the APTC gate is used to allocate a session to the
specified AOR.
Input parameters
- SYSID
- specifies the name of the AOR
- TRANID
- is the transaction name to be attached in the AOR.
- NETNAME
- specifies the netname or applid of the AOR.
- QUEUE
- is the queue option specified by the routing program.
Output parameters
- ERROR CODE
- indicates the code passed back from the allocate procedure.
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
OPEN_ERROR |
The RECEIVE function of the APTC gate is used to receive data.
Input parameters
- TOKEN
- is the token for the session TCTTE
- RECEIVE_BUFFER
- is the buffer into which the reply is to be placed.
Output parameters
- LAST
- is an indicator to indicate if this is the last flow.
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
TOKEN_UNKNOWN
RECEIVE_BUFFER_TOO_SMALL
TC_ERROR
NO_TCTTE
|
The SEND function of the APTC gate is used to send the request to the AOR.
Input parameters
- TOKEN
- is the token for the session TCTTE
- SEND_BLOCK
- is the block data with the length and send data pointer.
- PREFIX_AREA
- specifies the requeststreams information.
- LAST
- is an indicator to indicate if this is the last flow.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
TOKEN_UNKNOWN
TC_ERRO
NO_TCTTE
|
The SET_SESSION function of the APTC gate is used to send the request to
the AOR.
Input parameters
- TOKEN
- is the token for the session TCTTE
- RECOVERY_STATUS
- indicates if recovery is necessary.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of the following
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
TOKEN_UNKNOWN
TC_ERROR
|
The WRITE_TRANSIENT_DATA function of the APTD gate is used to write a single
record (or multiple records) to a named transient data queue.
Input parameters
- QUEUE
- specifies the name of the queue to which the data is to be written
- FROM_LIST
- is a list specifying the address and the length of each record that
is to be written to the specified queue.
- [RSL_CHECK]
- states whether resource-level checking is to be carried out. It can
take the values:
YES|NO
Output parameters
- [TD_RECORD]
- indicates the number of records that were successfully written to the
transient data queue.
- [TD_MIN_LENGTH]
- indicates the minimum allowable length of a transient data record if
a RESPONSE of EXCEPTION, and a REASON of LENGTH_ERROR is returned.
- [TD_MAX_LENGTH]
- indicates the maximum allowable length of a transient data record if
a RESPONSE of EXCEPTION, and a REASON of LENGTH_ERROR is returned.
- RESPONSE
- is Transient Data’s response to the call. It can have any of the
following values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, DISASTER, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
CSM_ERROR
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
EXCEPTION |
QUEUE_REMOTE
QUEUE_NOT_FOUND
QUEUE_NOT_AUTH
QUEUE_DISABLED
QUEUE_NOT_OPEN
QUEUE_NOT_OUTPUT
QUEUE_FULL
NO_SPACE
IO_ERROR
LENGTH_ERROR
LOCKED
NO_RECOVERY_TABLE
|
INVALID |
INVALID_FROM_LIST_P
INVALID_FROM_LIST_N
INVALID_FROM_P
INVALID_FROM_N
INVALID_RSL_CHECK
|
The READ_TRANSIENT_DATA function of the APTD gate is used to read a single
record from a named transient data queue.
Input parameters
- QUEUE
- specifies the name of the queue to which a record is to be read.
- INTO
- specifies a piece of storage into which the record is placed.
- SUSPEND
- specifies whether the caller wishes to wait if the record to be read
has not been committed to the queue yet. It can take the values:
YES|NO
- [RSL_CHECK]
- states whether resource level checking is to be carried out. It can
take the values:
YES|NO
- [DATA_LOC]
- if this is a READ TD SET rather than an INTO, DATA_LOC specifies whether
Transient Data should obtain the required SET storage from above or below
the 16MB line. It can take the values:
ANY|BELOW
- [DATA_KEY]
- if this is a READ TD SET rather than an INTO, DATA_KEY specifies whether
Transient Data should obtain the required SET storage from CICS key or user
key storage. It can take the values:
CICS|USER
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of the
following values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or DISASTER. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
CSM_ERROR
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
EXCEPTION |
QUEUE_REMOTE
QUEUE_NOT_FOUND
QUEUE_NOT_AUTH
QUEUE_DISABLED
QUEUE_NOT_OPEN
QUEUE_NOT_INPUT
QUEUE_BUSY
IO_ERROR
LENGTH_ERROR
LOCKED
|
The DELETE_TRANSIENT_DATA function of the APTD gate is used to delete the
specified transient data queue.
Input parameters
- QUEUE
- specifies the name of the queue to which the data is to be deleted.
- [RSL_CHECK]
- states whether resource level checking is to be carried out. It can
take the values:
YES|NO
- [DISCARDING_DEFINITION]
- states whether this DELETEQ request is part of an attempt by Transient
Data to discard a transient data queue definition. It can take the values:
YES|NO
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of the
following values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
CSM_ERROR
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
EXCEPTION |
QUEUE_REMOTE
QUEUE_NOT_FOUND
QUEUE_NOT_AUTH
QUEUE_DISABLED
QUEUE_EXTRA
IO_ERROR
LOCKED
NO_RECOVERY_TABLE
|
The RESET_TRIGGER_LEVEL function of the APTD gate is used to reset a transient
data queue so that another trigger transaction can be attached. Sometimes
it is necessary to include the RESET_TRIGGER_LEVEL function if a trigger transaction
abends.
Input parameters
- QUEUE
- specifies the name of the queue for which the trigger transaction is
to be reset.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of the
following values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are: ABEND, DCT_ERROR,
CSM_ERROR, DIRECTORY_MGR_ERROR, and LOGIC_ERROR.
The INITIALISE_TRANSIENT_DATA function of the APTD gate is invoked as part
of the initialization process for the transient data facility.
Input parameters
None.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of the
following values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
CSM_ERROR
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
The TRANSACTION_INITIALIZATION function of the APXM gate is called from
the transaction manager domain to the AP Domain during transaction initialization.
The AP domain allocates the AP domain transaction lifetime control blocks,
and anchors them in the AP domains transaction token.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
GETMAIN_FAILURE |
The TRANSACTION_INITIALIZATION function of the APXM gate is called from
the transaction manager domain to the AP Domain during transaction initialization.
The AP domain allocates the AP domain transaction lifetime control blocks,
and anchors them in the AP domains transaction token.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
GETMAIN_FAILURE |
The RMI_START_OF_TASK function of the APXM gate is called from transaction
manager domain to the AP Domain during transaction initialization. The AP
domain invokes any task-related user exits enabled for start of task.
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
The TRANSACTION_TERMINATION function of the APXM gate is called from the
transaction manager domain during transaction termination, and releases AP
domain transaction lifetime resources.
Input parameters
- TERMINATION_TYPE
- is the type of transaction termination. It can have either of these
values:
NORMAL|ABNORMAL
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
FREEMAIN_FAILURE |
Get the status of bridge autoinstall
Input parameters
None
Output parameters
- AIBRIDGE
- Values: YES, AUTO
Specifies if the URM is used
(YES) or names are generated automatically (AUTO).
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
-
Set the status of bridge autoinstall
Input parameters
- AIBRIDGE
- Values: YES, AUTO
Specifies if the URM is used
(YES) or names are generated automatically (AUTO).
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
-
Call the autoinstall URM to rename the bridge facility.
Input parameters
- MECHANISM
- Values: LINK, START
Specifies the type of mechanism
used to invoke the bridge transaction. If invoked using the start bridge exit
mechanism it is set to START and if invoked using the link3270 machanism it
is set to LINK.
- REQUESTED_TERMID
- Termid requested by the client (if any).
- REQUESTED_NETNAME
- Netname requested by the client (if any).
Output parameters
- TERMID
- Termid generated/accepted by the URM.
- NETNAME
- Netname generated/accepted by the URM.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: AUTOINSTALL_NOT_ACTIVE, LINK_URM_DISABLED,
LINK_URM_FAILED, AUTOINSTALL_ABEND, INVALID_TERMID, INVALID_NETNAME, REQUEST_REJECTED
Notify the URM that a bridge facility is being deleted.
Input parameters
- MECHANISM
- Values: LINK, START
Specifies the type of mechanism
used to invoke the bridge transaction. If invoked using the start bridge exit
mechanism it is set to START and if invoked using the link3270 machanism it
is set to LINK.
- TERMID
- Termid generated/accepted by the URM.
- NETNAME
- Netname generated/accepted by the URM.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: AUTOINSTALL_NOT_ACTIVE, LINK_URM_DISABLED,
LINK_URM_FAILED, AUTOINSTALL_ABEND
The ATTACH function of the BRAT gate is called to attach a transaction
with a bridge primary client.
Input parameters
- TRANSACTION_ID
- The 4 byte transaction id of the user transaction to be attached.
- [BREXIT]
- An optional program name to be used as the bridge exit. If this is not
specified, DFHBRAT will get the default value from transaction manager. If
there is no default bridge exit, an error is returned.
- [USERID]
- The USERID that should be signed-on to the terminal. This is only set
when no facility token is passed.
- [BRDATA]
- The address and length of a block of storage containing data to be passed
to bridge exit. This is used as part of the
primary client data.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, DISASTER or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NO_BREXIT
NO_STORAGE
USERID_NOT_AUTH_BREXIT
NOT_FOUND
DISABLED
NO_XM_STORAGE
NOT_ENABLED_FOR_SHUTDOWN
STATE_SYSTEM_ATTACH
|
DISASTER |
ABEND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
Initial allocation of a session.
Input parameters
- TRANSACTION
- Name of transaction on Router
- USERID
- Userid of request
- FACILITYKEEPTIME
- Bridge facility expiry time
- FACILITYLIKE
- Bridge facility model terminal
- [REQUESTED_TERMID]
- Client requested termid
- [REQUESTED_NETNAME]
- Client requested netname
Output parameters
- FACILITYTOKEN
- Bridge facilitytoken
- TERMID
- Allocated Termid
- NETNAME
- Allocated Netname
- SEQNO
- Request sequence number
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: NO_FREE_NAME, ALLOCATE_RANGE_FAILED, AUTOINSTALL_FAILED,
AUTOINSTALL_BAD_TERMID, AUTOINSTALL_BAD_NETNAME, AUTOINSTALL_REJECTED
Reallocation of a session.
Input parameters
- FACILITYTOKEN
- Bridge facilitytoken
- TRANSACTION
- Name of transaction on Router
- USERID
- Userid of request
Output parameters
- SYSID
- AOR owning bridge facility
- FACILITYKEEPTIME
- Bridge facility expiry time
- FACILITYLIKE
- Bridge facility model terminal
- [TERMID]
- Allocated Termid
- [NETNAME]
- Allocated Netname
- SEQNO
- Request sequence number
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: INVALID_FACILITYTOKEN, FACILITYTOKEN_IN_USE,
SECURITY_VIOLATION
Detach a session. This will delete it if the keeptime is zero.
Input parameters
- FACILITYTOKEN
- Bridge facilitytoken
- KEEP_INTERVAL
- Bridge facility expiry time
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: INVALID_FACILITYTOKEN, RELEASE_RANGE_FAILED
Update the BFNB
Input parameters
- FACILITYTOKEN
- Bridge facilitytoken
- [SYSID]
- AOR owning bridge facility
- [REMOTE_TRANSACTION]
- Name of transaction on AOR
- [STATUS]
- Values: RELEASED
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
-
- REASON
- Values: INVALID_FACILITYTOKEN
Get information in the BFNB.
Input parameters
- FACILITYTOKEN
- Bridge facilitytoken
Output parameters
- [TERMID]
- Allocated Termid
- [NETNAME]
- Allocated Netname
- [TRANSACTION]
- Name of transaction on Router
- [TASKID]
- Taskid of request
- [USERID]
- Userid of request
- [SYSID]
- AOR owning bridge facility
- [KEEP_INTERVAL]
- Bridge facility expiry time
- [STATUS]
- Values: ACQUIRED, AVAILABLE, RELEASED
State
of bridge facility
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: INVALID_FACILITYTOKEN
Get a cursor for a BFNB browse.
Output parameters
- BROWSE_TOKEN
- Browse cursor
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
-
Get information in a BFNB in a browse.
Input parameters
- BROWSE_TOKEN
- Browse cursor
Output parameters
- [FACILITYTOKEN]
- Bridge facilitytoken
- [TERMID]
- Allocated Termid
- [NETNAME]
- Allocated Netname
- [TRANSACTION]
- Name of transaction on Router
- [TASKID]
- Taskid of request
- [USERID]
- Userid of request
- [SYSID]
- AOR owning bridge facility
- [KEEP_INTERVAL]
- Bridge facility expiry time
- [STATUS]
- Values: ACQUIRED, AVAILABLE, RELEASED
State
of bridge facility
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: BROWSE_END, INVALID_BROWSE_TOKEN
End a browse
Input parameters
- BROWSE_TOKEN
- Browse cursor
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values:
Invalid:
INVALID_BROWSE_TOKEN
Get rid of any expired bridge facilities.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: RELEASE_RANGE_FAILED
The INQUIRE_CONTEXT of the BRIQ gate is called to inquire on bridge state
data.
Input parameters
- [TRANSACTION_TOKEN]
- The XM transaction token for the task to be inquired upon.
Output parameters
- [CALL_EXIT_FOR_SYNC]
- Can have either of these two values:
YES|NO
- [BRIDGE_ENVIRONMENT]
- Can have either of these two values:
YES|NO
- [CONTEXT]
- The transaction context. It can have either of these values:
NORMAL|BRIDGE|BREXIT
- [START_CODE]
- The emulated startcode of the user transaction
- [BRIDGE_TRANSACTION_ID]
- The transaction identifier of the bridge monitor (if CONTEXT is BRIDGE
or BREXIT).
- [BRIDGE_EXIT_PROGRAM]
- The name of the bridge exit program (if CONTEXT is BRIDGE or BREXIT).
- [BRIDGE_FACILITY_TOKEN]
- A token identifying the bridge facility
- [IDENTIFIER]
- Data created by the bridge exit for problem determination purposes.
- [BRDATA]
- Data passed to the bridge exit during attach.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, DISASTER or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BAD_TOKEN
NO_TRANSACTION_ENVIRONMENT
|
DISASTER |
ABEND |
INVALID |
INVALID_FORMAT |
Start a transaction in a bridge environment.
Input parameters
- TRANSACTION_ID
- The id of the transaction to be started.
- FACILITY_TOKEN
- The bridge facility associated with this session.
- [PRIORITY]
- XM priority of the transaction
Output parameters
- CONVERSATIONAL
- Values: YES, NO
Is the bridge transaction in
waiting.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: TXN_ALREADY_RUNNING, NO_STORAGE, TRANSACTION_NOT_FOUND,
DISABLED, NOT_ENABLED_FOR_SHUTDOWN, STATE_SYSTEM_ATTACH
Connects to a bridge transaction to supply a reply to a conversional request.
Input parameters
- FACILITY_TOKEN
- The bridge facility associated with this session.
Output parameters
- CONVERSATIONAL
- Values: YES, NO
Is the bridge transaction in
waiting.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: TRANSACTION_NOT_RUNNING
Connects to a bridge transaction waiting for a conversional request to
tell it to abend.
Input parameters
- FACILITY_TOKEN
- The bridge facility associated with this session.
- ABEND_CODE
- The abend code with which to abend the bridge.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: TRANSACTION_NOT_RUNNING
Process a 3270 bridge exit request
Input parameters
- BRXA
- The bridge exit interface area
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: Internal error.
Exception:
Process a 3270 bridge formatter request.
Input parameters
- BRXA
- The bridge exit interface area
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values:
Exception
MESSAGE_ERROR
The Link3270 message contains a bad BRIV. Invalid
INVALID_FORMAT
Internal error.
INVALID_FUNCTION
Internal error.
INVALID_DATA
Internal error.
Exception:
Allocate the message control blocks for a request.
Input parameters
- FACILITYTOKEN
- Bridge facilitytoken.
- ADDRESS
- Address of commarea.
- INPUT_LENGTH
- Length of input message.
- OUTPUT_LENGTH
- Maximum length of output message.
Output parameters
- MESSAGE_TOKEN
- Token representing the BMB instance.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: INVALID_ADDRESS, INVALID_INPUT_LENGTH, INVALID_FACILITYTOKEN,
INVALID_OUTPUT_LENGTH, STATE_ALREADY_ALLOC
Obtain access to message control blocks.
Input parameters
- FACILITYTOKEN
- Bridge facilitytoken.
- ADDRESS
- Address of commarea.
- INPUT_LENGTH
- Length of input message.
- OUTPUT_LENGTH
- Maximum length of output message.
- UNRETURNED_VECTORS
- Values: CLEAR, KEEP
Action to take on any unread
BRIVs.
- POSITION
- Values: IRRELEVANT, FIRST, SUBSEQUENT
Should
retrieve vectors be ignored?
Output parameters
- MESSAGE_TOKEN
- Token representing the BMB instance.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: INVALID_ADDRESS, INVALID_FACILITYTOKEN, INVALID_INPUT_LENGTH,
INVALID_OUTPUT_LENGTH, RETRIEVE_VECTOR_FOUND, BAD_VECTOR, STATE_NOT_ALLOC,
STATE_ALREADY_ALLOC
Get a copy of the outbound message. If insufficient room only copy complete
vectors, and record how much is left.
Input parameters
- MESSAGE_TOKEN
- Token representing the BMB instance.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: STATE_UNKNOWN_MSG, STATE_ALREADY_OUTPUT, INVALID_MESSAGE_TOKEN
Get a copy of the previous outbound message.
Input parameters
- FACILITYTOKEN
- Bridge facilitytoken.
- ADDRESS
- Address of commarea.
- OUTPUT_LENGTH
- Maximum length of output message.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: INVALID_ADDRESS, INVALID_FACILITYTOKEN, INVALID_OUTPUT_LENGTH,
STATE_NOT_OUTPUT, STATE_UNKNOWN_MSG, INVALID_MESSAGE_TOKEN
Delete the message blocks.
Input parameters
- MESSAGE_TOKEN
- Token representing the BMB instance.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: INVALID_FACILITYTOKEN, INVALID_MESSAGE_TOKEN
Read an inbound vector from the message. There are several vector types
which each have have their own cursors. The vector address is valid until
an OUTPUT_MESSAGE request.
Input parameters
- MESSAGE_TOKEN
- Token representing the BMB instance.
- VECTOR_TYPE
- Values: HEADER, RM, RE, CO, RT
Output parameters
- ADDRESS
- Address of commarea.
- VECTOR_LENGTH
- Length of the vector allocated or read.
- [ERROR_OFFSET]
- For bad vectors, the offset of the field in error in the input message.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: BAD_VECTOR, END_OF_MESSAGE, STATE_ALREADY_OUTPUT,
STATE_UNKNOWN_MSG, INVALID_MESSAGE_TOKEN
Allocate the storage for a new vector in the outbound message. The vector
address is valid until an ALLOCATE_VECTOR or OUTPUT_MESSAGE request.
Input parameters
- MESSAGE_TOKEN
- Token representing the BMB instance.
- VECTOR_TYPE
- Values: HEADER, BRIV
- [VECTOR_LENGTH]
- Length of the vector allocated or read.
Output parameters
- ADDRESS
- Address of commarea.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: STATE_ALREADY_OUTPUT, STATE_UNKNOWN_MSG, INVALID_MESSAGE_TOKEN
Remove all BRIV's from the output message.
Input parameters
- MESSAGE_TOKEN
- Token representing the BMB instance.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- Values: STATE_ALREADY_OUTPUT, STATE_UNKNOWN_MSG, INVALID_MESSAGE_TOKEN
Initialise control blocks and the numberspace file.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- Values: INVALID_FORMAT, INVALID_FUNCTION, ABEND, ADD_LOCK_FAILED,
ADD_SUBPOOL_FAILED, ALREADY_INITIALISED, INQUIRE_KERNEL, UNLOCK_FAILED, UNKNOWN_KE_ERROR_CODE
Connect to the numberspace, and build numberspace blocks
Input parameters
- NUMBER_FILENAME
- Numberspace file name.
- NUMBER_SPACE
- Name of the numberspace.
- OWNER
-
- START_NUMBER
- The first number within the number range associated with the numberspace.
- NUMBER_RANGE
- The range of numbers within the numberspace.
- FREE_NUMBERS
- Values: YES, NO
Should numbers previously allocated
to this region be freed during the first allocate number or release number
request.
- ENQUEUE
- Values: YES, NO
Are requests are enqueued or
not. If YES and the allocated request has to wait an exception of enqueue_waiter
is returned and a numbers is not allocated.
Output parameters
- TOKEN
-
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- Values: CONNECTED, NUMBER_FILE_ERROR, INVALID_FORMAT,
INVALID_FUNCTION, ABEND, ADD_LOCK_FAILED, CONNECT_ERROR, GETMAIN_ERROR, INVALID_RANGE_NUMBER,
INVALID_START_NUMBER, LOCK_FAILED, NOT_INITIALISED, UNKNOWN_KE_ERROR_CODE,
UNLOCK_FAILED
Disconnect from the numberspace. The numberspace blocks are freed and the
local allocation record is deleted. If no numbers are allocated the C1 and
C2 records are also deleted. The file is closed.
Input parameters
- TOKEN
-
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- Values: NUMBER_FILE_ERROR, INVALID_FORMAT, INVALID_FUNCTION,
ABEND, ALLOC_RECORD_CORRUPT, C1_ALLOC_MISMATCH, C1_C2_MISMATCH, C1_RECORD_CORRUPT,
C2_RECORD_CORRUPT, FREEMAIN_ERROR, INVALID_TOKEN, LOCK_FAILED, NOT_INITIALISED,
NSBLK_C1_MISMATCH, NUMBERS_ALLOCATED, UNEXPECTED_NUMFILE_ERROR, UNKNOWN_KE_ERROR_CODE,
UNKNOWN_RECORD_TYPE, UNLOCK_FAILED
Allocate the next available number.
Input parameters
- TOKEN
-
Output parameters
- NUMBER
- Number allocated by the numberspace.
- [CONNECTION_NUMBER]
- The numberspace token. The connection number allocated to this regio
- [NUMBER_RANGE]
- The range of numbers within the numberspace.
- [ALLOCATED_NUMBERS]
- The allocated numbers within the range.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- Values: NUMBER_FILE_ERROR, ALL_NUMBERS_ALLOCATED, ENQUEUE_WAITER,
INVALID_FORMAT, INVALID_FUNCTION, ABEND, ALLOC_RECORD_CORRUPT, C1_ALLOC_MISMATCH,
C1_C2_MISMATCH, C1_RECORD_CORRUPT, C2_RECORD_CORRUPT, INVALID_TOKEN, NOT_INITIALISED,
NSBLK_C1_MISMATCH, UNEXPECTED_NUMFILE_ERROR, UNKNOWN_KE_ERROR_CODE, UNKNOWN_RECORD_TYPE,
LOCK_FAILED, UNLOCK_FAILED
Release an allocated number from the numberspace.
Input parameters
- TOKEN
-
- NUMBER
- Number allocated by the numberspace.
Output parameters
- [CONNECTION_NUMBER]
- The numberspace token. The connection number allocated to this region.
- [NUMBER_RANGE]
- The range of numbers within the numberspace.
- [ALLOCATED_NUMBERS]
- The allocated numbers within the range.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- Values: NUMBER_FILE_ERROR, INVALID_FORMAT, INVALID_FUNCTION,
ABEND, ALLOC_RECORD_CORRUPT, C1_ALLOC_MISMATCH, C1_C2_MISMATCH, C1_RECORD_CORRUPT,
C2_RECORD_CORRUPT, INVALID_NUMBER, INVALID_TOKEN, NOT_INITIALISED, NSBLK_C1_MISMATCH,
NUMBER_NOT_ALLOCATED, NUMBER_NOT_ALLOC_LOCALLY, UNEXPECTED_NUMFILE_ERROR,
UNKNOWN_KE_ERROR_CODE, UNKNOWN_RECORD_TYPE, LOCK_FAILED, UNLOCK_FAILED
The INQUIRE_FACILITY function of the ICXM gate is used to inquire about
the interval control facilities that support facility management calls from
the transaction management domain.
Input parameters
- [FACILITY_TOKEN]
- is the token identifying the transaction that has been trigger-level
attached.
Output parameters
- FACILITY_NAME
- is the four-character name of the transaction that has been trigger-level
attached.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
The INITIALIZE_LANGUAGES function of the LILI gate is called during CICS
initialization to initialize Language Environment (Partition Initialization).
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION |
The TERMINATE_LANGUAGES function of the LILI gate is called during CICS
shutdown to terminate Language Environment (Partition Termination).
Input parameters
None.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION |
The FIND_PROGRAM_ATTRIBUTES function of the LILI gate is called by EDF
to find the working storage, static storage and entry point of a program.
It issues a Determine_Working_Storage request to Language Environment.
Input parameters
- USERS_RSA_POINTER
- is the address of the user program's register save area.
Output parameters
- WORKING_STORAGE
- defines the area into which the address and length of Working Storage
are to be put.
- STATIC_STORAGE
- defines the area into which the address and length of Static Storage
are to be put.
- PROGRAM_ENTRY_POINT
- is a token giving the address of a location set by Language Environment
to hold the true entry point of the program. This is the entry point of the
program as seen by the user, and ignores any CICS and Language Environment
stubs.
- [ENTRY_POINT_NAME]
- is a token giving the address of a location set by Language Environment
to address a character string built by Language Environment that identifies
the program at Program Entry Point. The area addressed is a halfword length
value, followed by the character string, which has a maximum length of 64
characters.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION |
The GO_TO function of the LILI gate is used in the processing of the HANDLE
command, when a condition or abend occurs, to produce information for the
call to Language Environment's Perform_goto function.
Input parameters
- LANGUAGE
- is the language of the program that issued the HANDLE command, as taken
from the handle table.
- LABEL
- For COBOL languages, this is the address of a special Register Save
Area built by CICS, which contains the values of the registers at the time
the original HANDLE ABEND command was issued. Language Environment is able
to determine the GO_TO address from values set in this RSA. For other languages,
this is the actual GO_TO address.
- USERS_RSA
- is the address of the Register Save Area at the time of the HANDLE command.
Output parameters
- PARAMETER_LIST
- is the address of a parameter list built by DFHLILI, conforming to the
Extended Run Time Language Interface protocols, which is to be used when calling
Language Environment to drive GO_TO.
- REGISTER_SAVE_AREA
- is the address of a save area, provided by DFHLILI, for use by Language
Environment during the processing of the GO_TO call.
- ENVIRONMENT_ENTRY_POINT
- is the address of the entry point to the Language Environment interface
module CEECCICS.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
LOOP
|
INVALID |
INVALID_FUNCTION |
The INIT_XM_CLIENT function of the TFXM gate is the initialization phase
of the transaction initialization that has been initiated from a terminal
or an LU6.1 session.
Input parameters
- [PRIMARY_CLIENT_BLOCK]
- is the address of the TCTTE and its length.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The BIND_XM_CLIENT function of the TFXM gate is the bind phase of the transaction
initialization that has been initiated from a terminal or an LU6.1 session.
Input parameters
- [PRIMARY_CLIENT_BLOCK]
- is the address of the TCTTE and its length.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The INIT_XM_CLIENT function of the MRXM gate is the initialization phase
of the transaction initialization that has been initiated from a terminal
or an MRO session.
Input parameters
- [PRIMARY_CLIENT_BLOCK]
- is the address of the TCTTE and its length.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The BIND_XM_CLIENT function of the MRXM gate is the bind phase of the transaction
initialization that has been initiated from a terminal or an MRO session.
Input parameters
- [PRIMARY_CLIENT_BLOCK]
- is the address of the TCTTE and its length.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The INIT_XM_CLIENT function of the 62XM gate is the initialization phase
of the transaction initialization that has been initiated from a terminal
or an LU6.2 or APPC session.
Input parameters
- [PRIMARY_CLIENT_BLOCK]
- is the address of the TCTTE and its length.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The BIND_XM_CLIENT function of the 62XM gate is the bind phase of the transaction
initialization that has been initiated from a terminal or an LU6.2 or APPC
session.
Input parameters
- [PRIMARY_CLIENT_BLOCK]
- is the address of the TCTTE and its length.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|KERNERROR
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The COMMIT_SURROGATE function of the RTSU gate is used to update the state
of a surrogate TCTTE when a Unit of Work is committed or backed out.
Input parameters
- SURROGATE
- The address of the surrogate TCTTE
- [UOW_STATUS]
- Indicates if the Unit of Work is being committed or backed out. It can
have either of these two values:
FORWARD|BACKWARD
Output parameters
- FREE_REQUIRED
- Indicates if the surrogate should now be freed (because, for instance,
the relay link has been freed). It can have either of these two values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
INVALID_SURROGATE
INVALID_SAVED_STATE
|
The FREE_SURROGATE function of the RTSU gate is used to free a surrogate
TCTTE from the currently executing task.
Input parameters
- SURROGATE
- The address of the surrogate TCTTE
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
INVALID_SURROGATE
|
The GET_RECOVERY_STATUS function of the RTSU gate is used to determine
what actions are required of the relay link at syncpoint.
Input parameters
- SURROGATE
- The address of the surrogate TCTTE
Output parameters
- RECOVERY_STATUS
- Indicates the syncpoint protocols required on the relay link. It can
have any of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1
- ABORT_ALLOWED
- Indicates whether, during the syncpoint protocols, an ABORT FMH7 should
be sent on the relay link. It can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
INVALID_SURROGATE
|
The PREPARE_SURROGATE function of the RTSU gate is used to update the state
of a surrogate TCTTE at the start of syncpoint.
Input parameters
- SURROGATE
- The address of the surrogate TCTTE
- INITIATOR
- Indicates if the associated relay link is the initiator of the syncpoint
request. It can have either of these two values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, DISASTER or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_STATE |
DISASTER |
ABEND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
INVALID_SURROGATE
|
The RESET_SURROGATE function of the RTSU gate is used to restore the state
of a surrogate TCTTE when ISSUE_ABEND or ISSUE_ERORR was received on the relay
link in reply to an ISSUE PREPARE request.
Input parameters
- SURROGATE
- The address of the surrogate TCTTE
- REPLY_TO_PREPARE
- Indicates which reply was received in response to ISSUE_PREPARE. It
can have either of these two values:
ISSUE_ERROR¬ISSUE_ABEND
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
INVALID_SURROGATE
|
The INQUIRE_SYSTEM function of the SAIQ gate is used to inquire about system
data owned by the application domain.
Input parameters
- [GMMTEXT]
- is an optional token identifying the text of the "good-morning"
message.
Output parameters
- [AKP]
- is a fullword binary field indicating the activity keypoint frequency,
in the range 200 through 65 535, of the local CICS region.
- [CICSREL]
- is a 4-character string indicating the level (version and release numbers)
of CICS code present.
- [CICSSTATUS]
- is the current status of the local CICS system. It can have any of these
values:
ACTIVE|FIRSTQUIESCE|FINALQUIESCE|INITIALIZING
- [CICSSYS]
- is the one-character identifier of the operating system for which the
running CICS system has been built. A value of "X" represents MVS™ system
with extended addressing.
- [CWA]
- is the address of the CWA.
- [CWALENGTH]
- is the length (in bytes) of the CWA.
- [DATE]
- is a four-character packed-decimal value indicating the current date
(00yydddc, where yy=years, ddd=days, c is the sign).
- [DCE_SUFFIX]
- is the two-character suffix of the DCE initialization side file, as
specified on the DCESUFFX system initialization parameter.
- [DTRPRGRM]
- is the 8-character name of the program controlling the dynamic routing
of transactions.
- [GMMLENGTH]
- is a halfword binary field indicating the length of the "good-morning"
message text.
- [GMMTRANID]
- is the four-character identifier of the "good-morning" transaction.
- [INITSTATUS]
- is the initialization status of the local CICS region. It can have any
of these values:
FIRSTINIT|SECONDINIT|THIRDINIT|INITCOMPLETE
- [JOBNAME]
- is the eight-character MVS job name for the local CICS region.
- [OPREL]
- indicates the release number of the operating system currently running.
The values is ten times the formal release number. For example, "21"
represents Release 2.1.
- [OPSYS]
- is a one-character identifier indicating the type of operating system
currently running. A value of "X" represents MVS.
- [PLTPI]
- is the two-character suffix of the program list table, which contains
a list of programs to be run in the final stages of system initialization.
- [SECURITYMGR]
- indicates whether an external security manager (such as RACF®) is active
in the CICS region, or whether no security is being used. It can have either
of these values:
EXTSECURITY|NOSECURITY
- [SHUTSTATUS]
- is the shutdown status of the local CICS region. It can have any of
these values:
CONTROLSHUT|SHUTDOWN|CANCELLED|NOTSHUTDOWN
- [STARTUP]
- is the type of startup used for the local CICS region. It can have any
of these values:
COLDSTART|WARMSTART|EMERGENCY|LOGTERM|STANDBY|AUTOSTART
- [STARTUPDATE]
- is a four-character packed-decimal value indicating the date on which
the local CICS region was started.
- [TERMURM]
- is the eight-character name of the terminal autoinstall program.
- [TIMEOFDAY]
- is a four-character packed-decimal value indicating the time at which
the local CICS region was started (hhmmsstc, where hh=hours, mm=minutes, ss=seconds,
c is the sign).
- [XRFSTATUS]
- indicates whether the local CICS region is a PRIMARY (active) or TAKEOVER
(alternate) XRF CICS region, or has no XRF support. It can have any of these
values:
PRIMARY|TAKEOVER|NOXRF
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INQ_FAILED
LOOP
|
EXCEPTION |
LENGTH_ERROR
UNKNOWN_DATA
|
The SET_SYSTEM function of the SAIQ gate is used to set system data values
owned by the application domain.
Input parameters
- [AKP]
- is a fullword binary field indicating the activity keypoint frequency,
in the range 200 through 65 535, of the local CICS region.
- [DCE_SUFFIX]
- is the two-character suffix of the DCE initialization side file.
- [DTRPRGRM]
- is the 8-character name of the program controlling the dynamic routing
of transactions.
- [GMMTEXT]
- is an optional token identifying the text of the "good-morning"
message.
- [GMMLENGTH]
- is a halfword binary field indicating the length of the "good-morning"
message text.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
SET_FAILED
LOOP
|
EXCEPTION |
AKP_SIZE_ERROR
LENGTH_ERROR
NO_KEYPOINTING
|
The OPEN_TRANSIENT_DATA function of the TDOC gate is used to open an extrapartition
transient data queue.
Input parameters
- QUEUE
- specifies the name of the extrapartition transient data queue to be
opened.
- TD_QUEUE_TOKEN
- can be specified instead of QUEUE. The token uniquely identifies the
extrapartition queue to be opened.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
EXCEPTION |
QUEUE_INTRA
QUEUE_REMOTE
QUEUE_OPEN
QUEUE_NOT_FOUND
|
DISASTER |
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
The CLOSE_TRANSIENT_DATA function of the TDOC gate is used to close an
extrapartition transient data queue.
Input parameters
- QUEUE
- specifies the name of the extrapartition transient data queue to be
closed.
- TD_QUEUE_TOKEN
- can be specified instead of QUEUE. The token uniquely identifies the
extrapartition queue to be closed.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
EXCEPTION |
QUEUE_INTRA
QUEUE_REMOTE
QUEUE_CLOSED
QUEUE_NOT_FOUND
QUEUE_NULL
QUEUE_NOT_CLOSED
|
The CLOSE_ALL_EXTRA_TD_QUEUES function of the TDOC gate closes all extrapartition
transient data queues which are currently open in the system. The CLOSE_ALL_EXTRA_TD_QUEUES
function is usually invoked as part of a warm shutdown.
Input parameters
None.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER. Possible values are: ABEND, DCT_ERROR,
DIRECTORY_MGR_ERROR, and LOGIC_ERROR.
The ADD_REPLACE_TDQUEUE function of the TDTM gate is used to install a
transient data queue definition.
Input parameters
- QUEUE_NAME
- specifies the name of the queue to be installed.
- TD_QUEUE_TOKEN
- can be specified instead of QUEUE. The token uniquely identifies a DCT
entry that has already been built, but needs to be installed.
- TD_TYPE
- specifies the queue type. Possible values are:
EXTRA|INTRA|INDIRECT|REMOTE
- BLOCK_LENGTH
- specifies the block length of an extrapartition queue.
- BUFFER_NUMBER
- specifies the number of buffers to be associated with an extrapartition
queue.
- DDNAME
- specifies the DDNAME to be associated with an extrapartition queue.
- DISPOSITION
- specifies the disposition of the data set to be associated with an extrapartition
queue. Possible values are:
SHR|OLD|MOD
- DSNAME
- specifies the DSNAME of the data set to be associated with an extrapartition
queue.
- ERROR_OPTION
- specifies the action to be taken in the event of an I/O error. This
input parameter applies to extrapartition queues only. Possible values are:
IGNORE|SKIP
- FACILITY
- specifies the facility associated with this intrapartition queue when
a trigger transaction is attached. Possible values are:
TERMINAL|FILE|SYSTEM
- FACILITY_ID
- specified together with the FACILITY option, FACILITY_ID identifies
the facility that the trigger transaction should be associated with.
- INDIRECT_DEST
- specifies the destination queue if this queue is an indirect queue.
- WAIT_ACTION
- specifies the action to be taken if this logically recoverable intrapartition
queue suffers an indoubt failure. Possible values are:
QUEUE|REJECT
- WAIT
- specifies whether this logically recoverable intrapartition queue can
wait for the resolution of an indoubt failure. Possible values are:
YES|NO
- OPEN_TIME
- specifies whether this extrapartition queue should be opened as part
of installation processing. Possible values are:
INITIAL|DEFERRED
- RECORD_LENGTH
- specifies the record length of an extrapartition queue in bytes.
- RECORD_FORMAT
- specifies the format of records held in an extrapartition queue. Possible
values are:
FIXUNB|FIXUNBA|FIXUNBM|FIXBLK|FIXBLKA|FIXBLKM|
VARBLK|VARBLKA|VARBLKM|VARUNB|VARUNBA|
VARUNBM|UNDEFINED
- RECOVERY
- specifies the recovery type of an intrapartition queue. Possible values
are:
NO|PH|LG
- REMOTE_NAME
- specifies the remote name of the queue if this is a remote queue definition.
- REMOTE_SYSTEM
- specifies the remote system identifier (SYSID) if this is a remote queue
definition.
- REWIND
- specifies where the tape is positioned in relation to the end of the
data set. This input parameter applies to extrapartition queues only. Possible
values are:
REREAD|LEAVE
- TRANSACTION_ID
- specifies the ATI transaction to be invoked when the trigger level is
reached.
- TRIGGER_LEVEL
- specifies the trigger level of the intrapartition queue.
- TYPE_FILE
- indicates whether this queue is:
- An input queue
- An output queue
- Whether the queue is to be read backwards.
Possible values are:
INPUT|OUTPUT|RDBACK
- USERID
- specifies the userid to be associated with a trigger-level attached
transaction.
- SYSOUTCLASS
- specifies the SYSOUT class to be used for the associated output extrapartition
queue.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
CATALOG_WRITE_FAILED
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
EXCEPTION |
COLD_START_IN_PROGRESS
DDNAME_NOT_FOUND
DFHINTRA_NOT_OPENED
DISABLE_PENDING
DUPLICATE
INSUFFICIENT_STORAGE
NOT_CLOSED
NOT_DISABLED
NOT_EMPTY
NOT_SAME_TYPE
QUEUE_NOT_OPENED
SECURITY_FAILURE
USERID_NOTAUTHED
|
The INQUIRE_TDQUEUE function of the TDTM gate is used to inquire on a specified
queue.
Input parameters
- QUEUE_NAME
- specifies the name of the queue to be inquired upon.
Output parameters
- [ATI_FACILITY]
- specifies the facility associated with this intrapartition queue when
a trigger transaction is attached. Possible values are:
TERMINAL|FILE|SYSTEM
- [ATI_TERMID]
- specified together with the FACILITY option, FACILITY_ID identifies
the facility that the trigger transaction should be associated with.
- [ATI_TRANID]
- specifies the ATI transaction to be invoked when the trigger level is
reached.
- [BUFFER_NUMBER]
- specifies the number of buffers to be associated with an extrapartition
queue.
- [DDNAME]
- specifies the DDNAME to be associated with an extrapartition queue.
- [DISPOSITION]
- specifies the disposition of the data set to be associated with an extrapartition
queue. Possible values are:
SHR|OLD|MOD
- [DSNAME]
- specifies the DSNAME of the data set to be associated with the extrapartition
queue.
- [EMPTY_STATUS]
- indicates whether the queue contains any records, and whether the queue
is full. This option applies to extrapartition queues only. Possible values
are:
FULL|EMPTY|NOTEMPTY
- [ENABLE_STATUS]
- indicates the status of the queue. Possible values are:
ENABLED|DISABLING|DISABLED
- [ERROR_OPTION]
- specifies what action is to be taken in the event of an I/O error. This
option applies to extrapartition queues only. Possible values are:
IGNORE|SKIP
- [INDIRECT_DEST]
- specifies the destination queue if this queue is an indirect queue.
- [WAIT]
- specifies whether this logically recoverable intrapartition queue can
wait for the resolution of an indoubt failure. Possible values are:
YES|NO
- [WAIT_ACTION]
- specifies the action to be taken if this logically recoverable intrapartition
queue suffers an indoubt failure. Possible values are:
QUEUE|REJECT
- [NUM_ITEMS]
- states the number of committed items in the queue.
- [OPEN_STATUS]
- indicates whether the queue is open. Possible values are:
OPEN|CLOSED
- [RECORD_FORMAT]
- specifies the format of the records held on the extrapartition queue.
Possible values are:
FIXUNB|FIXUNBA|FIXUNBM|FIXBLK|FIXBLKA|FIXBLKM|
VARBLK|VARBLKA|VARBLKM|VARUNB|VARUNBA|
VARUNBM|UNDEFINED
- [RECORD_LENGTH]
- specifies the record length of the extrapartition queue.
- [RECOVERY]
- specifies the recovery type of an intrapartition queue. Possible values
are:
NO|PH|LG
- [REMOTE_NAME]
- specifies the remote name of the queue if this is a remote queue definition.
- [REWIND]
- specifies where the tape is positioned in relation to the end of the
data set. This input parameter applies to extrapartition queues only. Possible
values are:
REREAD|LEAVE
- [TD_QUEUE_TOKEN]
- states which token is associated with this queue.
- [TD_TYPE]
- specifies the queue type. Possible values are:
EXTRA|INTRA|INDIRECT|REMOTE
- [TRIGGER_LEVEL]
- specifies the trigger level of the intrapartition queue.
- [TYPE_FILE]
- specifies whether this queue is:
- An input queue
- An output queue
- Whether it is a queue that is to be read backwards.
Possible values are:
INPUT|OUTPUT|RDBACK
- [USERID_TOKEN]
- indicates which token is associated with the USERID that was specified
for this intrapartition queue.
- [SYSOUTCLASS]
- specifies the SYSOUT class to be used for the associated output extrapartition
queue.
- [BLOCK_LENGTH]
- specifies the block length of an extrapartition queue.
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is DISASTER or EXCEPTION. Possible values
are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
EXCEPTION |
QUEUE_NOT_FOUND |
The START_BROWSE_TDQDEF function of the TDTM gate initiates a browse from
a specified queue, or from the start of the DCT.
Input parameters
- START_AT
- specifies a queue from which the browse should start.
Output parameters
- BROWSE_TOKEN
- is returned and uniquely identifies this browse session.
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- returned when RESPONSE is DISASTER. Possible values are: ABEND, DCT_ERROR,
DIRECTORY_MGR_ERROR, and LOGIC_ERROR
The GET_NEXT_TDQDEF function of the TDTM gate returns information about
a queue as part of a browse operation.
Input parameters
- BROWSE_TOKEN
- identifies the browse session.
Output parameters
- QUEUE_NAME
- is the name of the queue.
- [ATI_FACILITY]
- specifies the facility associated with this intrapartition queue when
a trigger transaction is attached. Possible values are:
TERMINAL|FILE|SYSTEM
- [ATI_TERMID]
- specified together with the FACILITY option, FACILITY_ID identifies
the facility that the trigger transaction should be associated with.
- [ATI_TRANID]
- specifies the ATI transaction to be invoked when the trigger level is
reached.
- [BUFFER_NUMBER]
- specifies the number of buffers to be associated with an extrapartition
queue.
- [DDNAME]
- specifies the DDNAME to be associated with an extrapartition queue.
- [DISPOSITION]
- specifies the disposition of the data set to be associated with an extrapartition
queue. Possible values are:
SHR|OLD|MOD
- [DSNAME]
- specifies the DSNAME of the data set to be associated with the extrapartition
queue.
- [EMPTY_STATUS]
- indicates whether the queue contains any records, and whether the queue
is full. This option applies to extrapartition queues only. Possible values
are:
FULL|EMPTY|NOTEMPTY
- [ENABLE_STATUS]
- indicates the status of the queue. Possible values are:
ENABLED|DISABLING|DISABLED
- [ERROR_OPTION]
- specifies what action is to be taken in the event of an I/O error. This
option applies to extrapartition queues only. Possible values are:
IGNORE|SKIP
- [INDIRECT_DEST]
- specifies the destination queue if this queue is an indirect queue.
- [WAIT]
- specifies whether this logically recoverable intrapartition queue can
wait for the resolution of an indoubt failure. Possible values are:
YES|NO
- [WAIT_ACTION]
- specifies the action to be taken if this logically recoverable intrapartition
queue suffers an indoubt failure. Possible values are:
QUEUE|REJECT
- [NUM_ITEMS]
- states the number of committed items in the queue.
- [OPEN_STATUS]
- indicates whether the queue is open. Possible values are:
OPEN|CLOSED
- [RECORD_FORMAT]
- specifies the format of the records held on the extrapartition queue.
Possible values are:
FIXUNB|FIXUNBA|FIXUNBM|FIXBLK|FIXBLKA|FIXBLKM|
VARBLK|VARBLKA|VARBLKM|VARUNB|VARUNBA|
VARUNBM|UNDEFINED
- [RECORD_LENGTH]
- specifies the record length of the extrapartition queue.
- [RECOVERY]
- specifies the recovery type of an intrapartition queue. Possible values
are:
NO|PH|LG
- [REMOTE_NAME]
- specifies the remote name of the queue if this is a remote queue definition.
- [REWIND]
- specifies where the tape is positioned in relation to the end of the
data set. This input parameter applies to extrapartition queues only. Possible
values are:
REREAD|LEAVE
- [TD_QUEUE_TOKEN]
- states which token is associated with this queue.
- [TD_TYPE]
- specifies the queue type. Possible values are:
EXTRA|INTRA|INDIRECT|REMOTE
- [TRIGGER_LEVEL]
- specifies the trigger level of the intrapartition queue.
- [TYPE_FILE]
- specifies whether this queue is:
- An input queue
- An output queue
- Whether it is a queue that is to be read backwards.
Possible values are:
INPUT|OUTPUT|RDBACK
- [USERID_TOKEN]
- indicates which token is associated with the USERID that was specified
for this intrapartition queue.
- [SYSOUTCLASS]
- specifies the SYSOUT class to be used for the associated output extrapartition
queue.
- [BLOCK_LENGTH]
- specifies the block length of an extrapartition queue.
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
EXCEPTION |
NO_MORE_DATA_AVAILABLE |
INVALID |
INVALID_BROWSE_TOKEN |
The END_BROWSE_TDQDEF function of the TDTM gate terminates a browse session.
Input parameters
- BROWSE_TOKEN
- identifies the browse session.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- returned when RESPONSE is DISASTER, or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
|
INVALID |
INVALID_BROWSE_TOKEN |
The SET_TDQUEUE function of the TDTM gate updates attributes of an installed
transient data queue.
Input parameters
- QUEUE_NAME
- identifies the queue to be updated.
- [ATI_FACILITY]
- specifies the type of facility associated with this queue. Possible
values are:
TERMINAL|FILE|SYSTEM
- [ATI_TERMID]
- indicates whether the ATI facility is to be updated.
- [ATI_TRANID]
- indicates whether the ATI transaction is to be updated.
- [ATI_USERID]
- indicates whether the USERID associated with the ATI transaction is
to be updated.
- [USERID_TOKEN]
- is the token that is supplied by the user domain when the userid is
added to the system.
Output parameters
- OLD_USER_TOKEN
- identifies the token associated with a previous USERID.
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- returned when RESPONSE is EXCEPTION or DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
CATALOG_WRITE_ERROR
|
EXCEPTION |
IS_CXRF
NOT_CLOSED
DISABLE_PENDING
NOT_DISABLED
QUEUE_IS_INDOUBT
QUEUE_NOT_FOUND
|
The DISCARD_TDQDEF function of the TDTM gate deletes an installed transient
data queue definition and removes it from the catalog. A DELETEQ command is
issued as part of the discard process.
Input parameters
- QUEUE_NAME
- identifies the queue to be discarded.
- [TD_QUEUE_TOKEN]
- can be specified instead of QUEUE_NAME. TD_QUEUE_TOKEN identifies the
queue to be discarded.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- returned when RESPONSE is EXCEPTION or DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
DCT_ERROR
DIRECTORY_MGR_ERROR
LOGIC_ERROR
CATALOG_DELETE_FAILED
|
EXCEPTION |
NAME_STARTS_WITH_C
NOT_CLOSED
NOT_DISABLED
DISABLE_PENDING
QUEUE_NOT_FOUND
|
The COMMIT_TDQDEFS function of the TDTM gate catalogs all installed transient
data queue definitions as part of cold start processing.
Input parameters
- TOKEN
- specifies the catalog to which the queue definitions are to be written.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- returned when RESPONSE is DISASTER. Possible values are: DIRECTORY_MGR_ERROR,
CATALOG_WRITE_FAILED, and ABEND.
The BIND_FACILITY function of the TDXM gate is used to associate a transaction
with the definition for the transient data queue that caused the transaction
to be trigger-level attached, where the principal facility is the queue itself
(that is there is no terminal associated with the queue).
Input parameters
None.
Output parameters
- RESPONSE
- is Transient Data’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is DISASTER. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
The BIND_SECONDARY_FACILITY function of the TDXM gate is used to associate
a transaction with the definition for a transient data queue that has caused
the transaction to be trigger-level attached (where the principal facility
is a terminal and the secondary facility is the transient data queue itself).
Input parameters
None.
Output parameters
- FACILITY_NAME
- is the name of the transient data queue. The queue is the secondary
facility and has been associated with this transaction.
- RESPONSE
- is Transient Data’s response to the call. It can have any of the
following values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is DISASTER. Possible value is ABEND.
The RELEASE_FACILITY function of the TDXM gate is used to disassociate
a transaction from the TD queue. (The principal facility type is either TERMINAL
or TDQUEUE.)
Input parameters
- TERMINATION_TYPE
- is the type of transaction termination. It can have either of these
values:
NORMAL ABNORMAL
- [RESTART_REQUESTED]
- indicates whether or not the transaction is to be restarted. It can
have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- REASON
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
RESTART_FAILURE |
The INQUIRE_FACILITY function of the TDXM gate is used to inquire about
the transient data facilities that support facility manager calls from the
transaction manager domain.
Input parameters
- [FACILITY_TOKEN]
- is the token identifying the transaction that has been trigger-level
attached.
Output parameters
- FACILITY_NAME
- is the four-character name of the transaction that has been trigger-level
attached.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
The ALLOCATE function of the TFAL gate is used to allocate a terminal for
a transaction.
Input parameters
- REQUEST_ID
- is the four-character transaction identifier initiating the attach.
- [MODE_NAME]
- is the eight-character mode-name of the terminal to be attached.
- SYSTEM_TOKEN
- is the token identifying the CICS region to which the terminal is to
be attached.
- [PRIVILEGED]
- indicates whether or not the terminal is to be attached as a privileged
terminal. It can have either of these values:
YES|NO
- [NON_PURGEABLE]
- indicates whether or not the terminal is to be purgeable. It can have
either of these values:
YES|NO
Output parameters
- TERMINAL_TOKEN
- is the token identifying the terminal that has been attached.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
GETMAIN_FAILED
LOGIC_ERROR
|
EXCEPTION |
ALLOCATE_FAILURE
ALLOCATE_PURGED
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The CANCEL_AID function of the TFAL gate is used to cancel a terminal-transaction
AID.
Input parameters
- TERMID
- is the four-character terminal identifier.
- TRANID
- is the four-character transaction identifier.
- TERM_OWNER_NETNAME
- is the APPLID of the CICS region that "owns" the terminal.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The CANCEL_AIDS_FOR_CONNECTION function of the TFAL gate is used to cancel
AIDs for the given CICS region.
Input parameters
- SYSTEM_TOKEN
- is the token identifying the CICS region.
- CALLER
- is the method used to call this function. It can have either of these
values:
BUILDER|API
- FORCE
- indicates whether or not system AIDs are to be canceled. It can have
either of these values:
YES|NO
- FACILITY
- indicates the facility type associated with the AIDs. It can have either
of these values:
CONNECTION|TERMINAL
Output parameters
- [AIDS_CANCELLED]
- indicates whether or not AIDs were canceled as a result of this request.
It can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NULL_SYSTEM_TOKEN |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The CANCEL_AIDS_FOR_TERMINAL function of the TFAL gate is used to cancel
all AIDs for the given terminal.
Input parameters
Note:
Specify either TERMID or TERMINAL_TOKEN, not both.
- TERMID
- is the four-character terminal identifier.
- TERMINAL_TOKEN
- is the token identifying the terminal.
- CALLER
- is the method used to call this function. It can have one of these values:
BUILDER|API|BUILDER_REMDEL
- FORCE
- indicates whether or not system AIDs are to be canceled. It can have
either of these values:
YES|NO
- FACILITY
- indicates the facility type associated with the AIDs. It can have either
of these values:
CONNECTION|TERMINAL
Output parameters
- [AIDS_CANCELLED]
- indicates whether or not AIDs were canceled as a result of this request.
It can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NULL_TERMINAL_TOKEN, |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The CHECK_TRANID_IN_USE function of the TFAL gate is used to check whether
any of the AID chains contain ferrences to the given TRANID
Input parameters
- TRANID
- is the four-character transaction identifier.
Output parameters
- IN_USE
- indicates whether or not the transaction identifier (specified by the
TRANID parameter) is in use. It can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The DISCARD_AIDS function of the TFAL gate is used to attach a task which
will release start data and free the AIDs in the chain addressed by the AID_TOKEN
Input parameters
- AID_TOKEN
- is the token identifying the chain of AIDs.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The FIND_TRANSACTION_OWNER function of the TFAL gate is used to determine
the CICS region that owns the given transaction (that is, at which the transaction
instance originated).
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
- TRANID
- is the four-character transaction identifier.
Output parameters
- TRAN_OWNER_SYSID
- is the four-character system identifier for the CICS region that owns
the transaction instance.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND
TOR_LINK_NOT_ACTIVE
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The GET_MESSAGE function of the TFAL gate is used to get a message from
a terminal.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
- PREVIOUS_AID_TOKEN
- is the AID token identifying the previous transaction that ran at this
terminal.
Output parameters
- AID_TOKEN
- is the AID token identifying the current transaction for which the message
was got.
- TSQUEUE_NAME
- is the eight-character name of the temporary storage queue name of the
message whose BMS AID was found.
- BMS_TITLE_PRESENT
- indicates whether or not a BMS title is present on the terminal. It
can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The INITIALIZE_AID_POINTERS function of the TFAL gate is used to initialize
the AID pointers for the given CICS region.
Input parameters
- SYSTEM_TOKEN
- is the token identifying the CICS region.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The INQUIRE_ALLOCATE_AID function of the TFAL gate is used to inquire about
the AIDs allocated for the given CICS region.
Input parameters
- SYSTEM_TOKEN
- is the token identifying the CICS region.
- [PRIVILEGED]
- indicates whether or not to inquire only about privileged ISC type AIDs.
It can have either of these values:
YES|NO
Output parameters
- EXISTS
- indicates whether or not the AID exists. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The LOCATE_AID function of the TFAL gate is used for automatic transaction
initiation to determine the AID for the specified terminal, and if found,
to use the transaction identifier from the AID to attach the task.
Input parameters
- TERMID
- is the four-character terminal-identifier.
- [TYPE]
- denotes the type of AID to be located. It can have one of these values:
BMS|PUT|INT|TDP|ISC|REMDEL
Output parameters
- [TRANID]
- is the four-character transaction identifier associated with the specified
terminal.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The LOCATE_REMDEL_AID function of the TFAL gate is used to determine the
AID (for a delete remote TERMINAL definition request) for the specified system
(SYSTEM_TOKEN specified) or after the given (PREVIOUS_AID_TOKEN specified).
Input parameters
- SYSTEM_TOKEN
- is the token identifying the CICS region.
- PREVIOUS_AID_TOKEN
- is the AID token identifying the previous transaction that ran at this
terminal.
Output parameters
- AID_TOKEN
- is the AID token identifying the transaction to be deleted.
- TARGET_SYSID
- is the four-character system identifier for the target CICS system.
- TERMID
- is the four-character terminal identifier from the REMDEL AID.
- TERM_OWNER_NETNAME
- is the eight-character netname from the REMDEL AID.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The LOCATE_SHIPPABLE_AID function of the TFAL gate is used to determine
an AID (for a delete remote TERMINAL definition request or for a remote terminal
request) to be shipped to the specified system.
Input parameters
- SYSTEM_TOKEN
- is the token identifying the CICS region.
Output parameters
- AID_TOKEN
- is the AID token identifying the transaction to be deleted.
- LAST
- Indicates that either:
- there is a single qualifying AID or all qualifying AIDs have the same
AIDTRMID (YES), or
- in addition to the AID returned there are other qualifying AIDs (NO)
It can have either of these values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The MATCH_TASK_TO_AID function of the TFAL gate is used to inquire about
AIDs for the given terminal and transaction.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
- TRANID
- is the four-character transaction identifier.
Output parameters
- TDQUEUE_NAME
- is the eight-character name of the transient data queue for the AID.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND
MATCHED_TERMID_ONLY
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The PURGE_ALLOCATE_AIDS function of the TFAL gate is used to delete purgeable
allocate AIDs for a given connection after user exit XZIQUE in DFHZISP has
issued return code 8 (delete all) or return code 12 (delete all for given
modegroup).
Input parameters
- SYSTEM_TOKEN
- is the token identifying the CICS region.
- [MODE_NAME]
- The name of the modegroup. If this parameter is omitted, the default
is all modegroups.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The RECOVER_START_DATA function of the TFAL gate is used to retrieve a
PUT-type AID stored in a DWE and rechain it onto the TCTSE in front of the
first AID for the terminal.
Input parameters
- AID_TOKEN
- is the AID token identifying the transaction to be deleted.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
NULL_SYSTEM_TOKEN
GETMAIN_FAILED
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The REMOTE_DELETE function of the TFAL gate is used to chain a REMOTE DELETE
(REMDEL) AID onto the system entry of the specified target CICS region. The
REMDEL AID tells the target region to delete its shipped definition of the
specified terminal.
Input parameters
- TARGET_SYSID
- is the four-character system identifier for the target CICS region.
- TERMINAL_TOKEN
- is the token identifying the terminal.
- TERMID
- is the four-character terminal identifier for the terminal associated
with the transaction.
- TERM_OWNER_NETNAME
- Is the VTAM® APPLID of the CICS region that "owns" the terminal.
Note:
The terminal identifier can either be specified as TERMID and TERM_OWNER_NETNAME
(where TERMID is the name known in the terminal owning system), or it can
be specified by TERMINAL_TOKEN if the TCTTE address is known.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
GETMAIN_FAILED |
EXCEPTION |
TOR_LINK_NOT_ACTIVE |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The REMOVE_EXPIRED_AID function of the TFAL gate is used to search all
AID chains for a BMS AID that has yet to be initiated and which matches the
eligibility parameters. Unchain the first such AID found, copy details from
the AID into the caller’s parameter list, and freemain the AID.
Input parameters
- [NORMAL_EXPIRY_TIME]
- is the normal threshold time.
- [ADJUSTED_EXPIRY_TIME]
- is the adjusted threshold time.
- [MSGID]
- is the BMS message identifier
- [LDC]
- is the logical device code
Note:
If MSGID and LDC are specified, the expiry time is not checked.
Output parameters
- TSQUEUE_NAME
- is the eight-character name of the temporary storage queue name of the
message whose BMS AID was found.
- TRANID
- is the four-character transaction identifier associated with the specified
terminal.
- TERMID
- is the four-character terminal identifier for the terminal associated
with the transaction.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The REMOVE_EXPIRED_REMOTE_AID function of the TFAL gate is used to search
for an uninitiated remote AID which is older than the expiry time specified
by the caller, unchain the AID, and cleanup any associated resources.
Input parameters
- NORMAL_EXPIRY_TIME
- is the normal threshold time.
- ADJUSTED_EXPIRY_TIME
- is the adjusted threshold time.
Output parameters
- TRANID
- is the four-character transaction identifier associated with the specified
terminal.
- TERMID
- is the four-character terminal identifier for the terminal associated
with the transaction.
- TERM_OWNER_SYSID
- is the system identifier of the CICS region that "owns" the
terminal.
- SHIPPED
- identifies whether the AID has been shipped. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The REMOVE_MESSAGE function of the TFAL gate is used to:
- Find an uninitiated BMS AID for the specified terminal
- Unchain and freemain the AID, provided that the AID security fields match
those of the currently signed-on operator
- Return the TS queue name from the AID.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
- [MSGID]
- is the BMS message identifier
Output parameters
- TSQUEUE_NAME
- is the eight-character name of the temporary storage queue name for
the message whose BMS AID was found.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND
SECURITY_MISMATCH
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The REMOVE_REMOTE_DELETES function of the TFAL gate is used to unchain
and freemain all REMDEL AIDs from the AID chain of the specified system entry.
Optional parameters TERMID and TERM_OWNER_NETNAME may be specified; in which
case only those REMDEL AIDs which match the specified values are removed.
Input parameters
- TARGET_SYSID
- is the four-character system identifier for the target CICS region.
- SYSTEM_TOKEN
- is the token identifying the CICS region.
Note:
Specify either
the TARGET_SYSID parameter or the SYSTEM_TOKEN parameter, not both.
- [TERMID]
- is the four-character terminal identifier for the terminal associated
with the transaction.
- [TERM_OWNER_NETNAME]
- is the netname of the region that "owns" the terminal.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The REROUTE_SHIPPABLE_AIDS function of the TFAL gate is used to redirect
AIDs for remote terminals from one remote system to another.
Input parameters
- ORIGINAL_SYSTEM_TOKEN
- is the token identifying the remote system which was the AIDs’
original target.
- TARGET_SYSTEM_TOKEN
- is the token identifying the remote system which is the AIDs’ new
target.
- TERMINAL_NETNAME
- is the eight-character NETNAME which identifies the terminal whose AIDs
are to be rerouted.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
LOGIC_ERROR |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The RESCHEDULE_BMS function of the TFAL gate is used to build a BMS AID
and chain it to the front of the AID queue.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
- TRANID
- is the four-character transaction identifier associated with the specified
terminal.
- TSQUEUE_NAME
- is the eight-character name of the temporary storage queue name of the
message whose BMS AID was found.
- BMS_TIMESTAMP
- Timestamp for BMS AID. Used to test if AID is older than specified EXPIRY_TIME.
- [OPIDENT]
- Identifies the operator
Note:
You can specify either the OPIDENT
parameter or the OPCLASS parameter, not both.
- [OPCLASS]
- Identifies the operator class.
Note:
You can specify either
the OPIDENT parameter or the OPCLASS parameter, not both.
- [BMS_TITLE_PRESENT]
- Indicates if title in message control record. You can specify either
of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
GETMAIN_FAILED |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The RESET_AID_QUEUE function of the TFAL gate is used to:
- Give ALP a chance to reset the AID queue when a transaction ends
- Give ALP a chance to bid for the use of the terminal if ATI tasks are
waiting.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The RESTORE_FROM_KEYPOINT function of the TFAL gate is used to: reschedule
a chain of AIDs that we restored from the catalog during CICS system initialization.
Input parameters
- AID_TOKEN
- A token denoting the chain of AIDs which are to be rescheduled.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The RETRIEVE_START_DATA function of the TFAL gate is used to return the
AID address and temporary storage queue name associated with the start data
for the specified transaction and terminal.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
- TRANID
- is the four-character transaction identifier associated with the specified
terminal.
Output parameters
- TSQUEUE_NAME
- is the eight-character name of the temporary storage queue name of the
message whose BMS AID was found.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The SCHEDULE_BMS function of the TFAL gate is used to: schedule a BMS AID.
Input parameters
- TERMID
- is the four-character terminal identifier for the terminal associated
with the transaction.
- TRANID
- is the four-character transaction identifier associated with the specified
terminal.
- TSQUEUE_NAME
- is the eight-character name of the temporary storage queue name of the
message whose BMS AID was found.
- BMS_TIMESTAMP
- is the timestamp for the BMS AID. This is used to test if the AID is
older than its EXPIRY_TIME.
- [OPIDENT]
- Identifies the operator.
Note:
You can specify either the
OPIDENT parameter or the OPCLASS parameter, not both.
- [OPCLASS]
- Identifies the operator class.
Note:
You can specify either
the OPIDENT parameter or the OPCLASS parameter, not both.
- [BMS_TITLE_PRESENT]
- Indicates if the title is in the message control record. You can specify
either of these values:
YES|NO
- [TERMINAL_NETNAME]
- is the eight-character NETNAME which identifies the terminal whose AIDs
are to be rerouted.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
GETMAIN_FAILED |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The SCHEDULE_START function of the TFAL gate is used to schedule a PUT
or INT type AID
Input parameters
- TRANID
- is the four-character transaction identifier associated with the specified
terminal.
- TERMID
- is the four-character terminal identifier for the terminal associated
with the transaction.
- [TRAN_OWNER_SYSID]
- is the system identifier of the CICS region that "owns" the
transaction.
- [TERM_OWNER_SYSID]
- is the system identifier of the CICS region to which the request should
be shipped.
Note:
You can specify either the TERM_OWNER_SYSID parameter
or TERM_OWNER_NETNAME parameter, not both.
- [TERM_OWNER_NETNAME]
- is the system identifier of the CICS region to which the request should
be shipped.
Note:
You can specify either the TERM_OWNER_SYSID parameter
or TERM_OWNER_NETNAME parameter, not both.
- [ROUTED_FROM_TERMID]
- is the four-character terminal identifier for the terminal from which
a task was transaction-routed to issue this START request.
- [SHIPPED_VIA_SESSID]
- is the identifier of the session via which this START request was function
shipped.
- [MODE_NAME]
- is the mode name to be used
- [TSQUEUE_NAME]
- is the name of the temporary storage queue which contains the data associated
with the START request.
- [FEPI]
- indicates that this is a FEPI START request. It can have either of these
values:
YES|NO
- [RECOVERABLE_DATA]
- indicates that the request is associated with recoverable data It can
have either of these values:
YES|NO
- [IN_DOUBT]
- indicates that the Unit of Work making the request is in doubt, and
the request should not be scheduled until the Unit of Work is committed. It
can have either of these values:
YES|NO
- [TERMINAL_NETNAME]
- is the eight-character NETNAME of the terminal associated with the transaction.
- [SHIPPED_VIA_SYSID]
- identifies the connection via which this request was function shipped
or transaction routed.
- [TOR_NETNAME]
- is the netname of the CICS region that owns the terminal.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
GETMAIN_FAILED |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The SCHEDULE_TDP function of the TFAL gate is used to schedule a TDP type
AID.
Input parameters
- TRANID
- is the four-character transaction identifier associated with the specified
terminal.
- TERMID
- is the four-character terminal identifier for the terminal associated
with the transaction.
- TDQUEUE_NAME
- is the destination identifier for the TD queue.
- [TERMINAL_NETNAME]
- is the eight-character NETNAME of the terminal associated with the transaction.
Output parameters
- AID_TOKEN
- is the AID token identifying the transaction to be deleted.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
GETMAIN_FAILED |
EXCEPTION |
UNKNOWN_TRANID |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The SLOWDOWN_PURGE function of the TFAL gate is used to:
- Search the specified system entry’s AID chain for the first allocate-type
AID associated with a stall-purgeable task
- Cancel the identified transaction.
Input parameters
- SYSTEM_TOKEN
- is the four-character terminal identifier for the terminal associated
with the transaction.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION, or INVALID. Possible values
are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The TAKE_KEYPOINT function of the TFAL gate is used to return a chain of
AIDs which are to be written to the global catalog.
Input parameters
None.
Output parameters
- AID_TOKEN
- is the token identifying the chain of AIDs.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The TERM_AVAILABLE_FOR_QUEUE function of the TFAL gate is used, when a
terminal becomes available for allocation, to give DFHALP the chance to attach
or resume a task which requires this terminal.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
GETMAIN_FAILED
ATTACH_ERROR
|
EXCEPTION |
NOT_FOUND |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The TERMINAL_NOW_UNAVAILABLE function of the TFAL gate is used to perform
required actions when a terminal or connection becomes unavailable.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The UNCHAIN_AID function of the TFAL gate is used to unchain and optionally
freemain the specified AID.
Input parameters
- AID_TOKEN
- is the AID token identifying the transaction to be deleted.
- FREEMAIN
- indicates whether freemain is wanted. It can have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. Possible values are:
RESPONSE |
Possible REASON values |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The UPDATE_TRANNUM_FOR_RESTART function of the TFAL gate is used to update
the AID’s TRANNUM to that of the restarted task.
Input parameters
- TERMINAL_TOKEN
- is the token identifying the terminal.
- ORIGINAL_TRANNUM
- is the TRANNUM set in the AID when original task was attached.
- NEW_TRANNUM
- is the new TRANNUM to be set in the AID.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NULL_TERMINAL_TOKEN |
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The BIND_FACILITY function of the TFBF gate is used to associate a transaction
with the terminal.
Input parameters
- [PROFILE]
- is the eight-character name of the profile to be used to associate the
transaction and terminal.
- [PARTITIONSET_NAME]
- is the eight-character name of a partition set. This parameter is used
only of the value of PARTITIONSET is NAME.
- [PARTITIONSET]
- indicates if a partition set is to be used for the terminal facility.
It can have any of these values:
NONE|NAME|OWN|KEEP
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
REMOTE_SCHEDULE_FAILURE
SECURITY_FAILURE
TABLE_MANAGER_FAILURE
|
EXCEPTION |
NO_TERMINAL
TRANSACTION_ABEND
|
INVALID |
INVALID_FORMAT
INVALID_FUNCTION
|
The INQUIRE_TERMINAL_FACILITY function of the TFIQ gate is used to inquire
about attributes of a named terminal facility.
Input parameters
Note:
Specify a value for either the TRANSACTION_TOKEN or TERMINAL_TOKEN
parameter, not both.
- [TRANSACTION_TOKEN]
- is a token identifying a transaction for which you want to inquire about
the associated terminal.
- [TERMINAL_TOKEN]
- is a token identifying a terminal.
Output parameters
- [FACILITY_NAME]
- is the four-character name of the terminal facility.
- [NETNAME]
- is the eight-character netname of the terminal facility.
- [PSEUDO_CONV_COMMAREA]
- is a block into which the communications area for a pseudo-conversational
transaction is copied.
- [TERMINAL_TRAFFIC_READ]
- indicates whether or not reading is supported. It can have either of
these values:
YES|NO
- [TERMINAL_TRAFFIC_WRITE]
- indicates whether or not writing is supported. It can have either of
these values:
YES|NO
- [TERMINAL_USER_AREA]
- is a block into which the terminal user area is copied.
- [NATIONAL_LANGUAGE_IN_USE]
- is the three-character code indicating the national language in use
for the terminal facility. (See Table 120.)
- [INSPECT_DATA]
- is a token indicating the Language Environment® runtime options for the terminal facility.
- [STORAGE_FREEZE]
- indicates whether or not storage normally freed during the processing
of a transaction for the terminal facility is to be frozen. (The frozen storage
is not freed until the end of the transaction.) It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NO_TERMINAL |
INVALID |
INVALID_TERMINAL_TYPE |
The SET_TERMINAL_FACILITY function of the TFIQ gate is used to set attributes
of a named terminal facility.
Input parameters
Note:
Specify a value for either the TRANSACTION_TOKEN or TERMINAL_TOKEN
parameter, not both.
- [TRANSACTION_TOKEN]
- is a token identifying a transaction for which you want to inquire about
the associated terminal.
- [TERMINAL_TOKEN]
- is a token identifying a terminal.
- [COUNT_STORAGE_VIOLATION]
- indicates whether or not storage violations are to be counted for this
terminal facility. It can have either of these values:
YES|NO
- [INPUTMSG]
- is a block into which the input message for a pseudo-conversational
transaction is copied.
- [PSEUDO_CONV_NEXT_TRANSID]
- is the four-character identifier of the transaction to which control
is passed on a normal return from a pseudo-conversational transaction (to
which the pseudo_conversational data is passed).
- [PSEUDO_CONV_COMMAREA]
- is a block into which the communications area for a pseudo-conversational
transaction is copied.
- [PSEUDO_CONV_IMMEDIATE]
- is the four-character identifier of the transaction to which control
is passed on an immediate return from a pseudo-conversational transaction
(to which the pseudo_conversational data is passed).
- [NATIONAL_LANGUAGE_IN_USE]
- is the three-character code indicating the national language in use
for the terminal facility. (See Table 120.)
- [INSPECT_DATA]
- is a token indicating the Language Environment runtime options
for the terminal facility.
- [STORAGE_FREEZE]
- indicates whether or not storage normally freed during the processing
of a transaction for the terminal facility is to be frozen. (The frozen storage
is not freed until the end of the transaction.) It can have either of these
values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NO_TERMINAL
PERMANENT_TRANSID
|
INVALID |
INVALID_TERMINAL_TYPE |
The INQUIRE_MONITOR_DATA function of the TFIQ gate is used to inquire about
monitoring data of the terminal facility.
Input parameters
None.
Output parameters
- [FACILITY_TYPE]
- indicates the type of terminal facility. It can have any of these values:
LU61|LU62|IRC|IRC_XCF|OTHER
- [FACILITY_NAME]
- is the four-character name of the terminal facility.
- [NETNAME]
- is the eight-character netname of the terminal facility.
- [INPUT_MSG_LENGTH]
- is the length (in bytes) of the input message for the terminal facility.
- [SERVICE_REPORTING_CLASS]
- is a token indicating the service reporting class for the terminal facility
(for MVS workload manager purposes).
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
NO_TERMINAL |
[[ Contents Previous Page | Next Page Index ]]