C H A P T E R 4 - Compatibility With IBM CICS

C H A P T E R 4

Compatibility With IBM CICS

This chapter includes the following topics:

Sun MTP and IBM CICS Differences

Levels of Support for CICS Commands

Supported CICS Commands

Proprietary Command

Supported BMS Functions

Supported EIB Fields

Sun MTP and IBM CICS Differences

There are several areas where Sun MTP differs from IBM CICS due to differences in the underlying architecture. In Sun MTP, each terminal's transactions are executed in a separate transaction server; in IBM CICS, all transactions run in a single large partition.

Absolute Addressing

Because each user is running in a separate virtual address space, be very careful when passing absolute addresses between transactions running on different terminals. In general, it should not be done.

However, addresses that refer to areas in shared memory are guaranteed to be the same across transaction servers. Sun MTP implements the Common System Area (CSA) and the Common Work Area (CWA) in shared memory, as well as the event control blocks used by the POST and WAIT EVENT commands. These addresses can be passed freely.

Areas acquired using the EXEC CICS GETMAIN command are allocated in the transaction server and must not be passed to other transactions, but can be freely passed between programs within a transaction. If allocating so that other transactions can reference the data in these areas, use either the SHARED option of the EXEC CICS GETMAIN command or a table loaded using the EXEC CICS LOAD command.

Assignment of Terminal Identifiers

The terminal identifier associated with a given user session is assigned at the time the user starts a client. The actual terminal identifier is assigned dynamically, based on the order in which the client connects to the region.

The terminal is given the identifier Annn, where A is any alphabetic character and nnn is a sequentially assigned 3-digit decimal number.

The starting terminal identifier for the region is defined in the System Initialization Table (SIT). The default is C000; however, the value can be changed to avoid conflict with any mainframe terminal identifiers. For example, the first terminal to log in to the region is assigned the identifier C000; the second is assigned C001. If a specific terminal identifier is required, specify it when you start the client.

You must assign terminal identifiers in the Terminal Control Table (TCT) for 3270 devices and printers. Optionally, you can assign terminal identifiers for TN3270E sessions. Refer to the section on the TCT in the Sun Mainframe Transaction Processing Software Reference Guide for information about assigning terminal identifiers.

Byte Ordering

On certain computers, the byte ordering of 2-byte and 4-byte integers is different from the byte order on computers with IBM 370 architecture. In most cases, the compiler shields these differences from the program by ensuring that the 2-byte and 4-byte integers are in the order expected by the program.

However, in two cases involving COBOL programs, you might need to modify your programs:

When a program uses Base Locator Linkage (BLL) cells or pointer variables and that program performs calculations on these addresses

When calling C subroutines from COBOL programs

Base Locator Linkage (BLL) and Pointer Variables for COBOL

BLL cells are used in programs adhering to the COBOL 74 standard when CICS commands are used that contain the SET option. The SET option returns an address.

Pointer variables are used in programs adhering to the COBOL standard. This address must be in the format used by the system for addresses. Sun MTP returns these addresses in the proper format for Micro Focus COBOL. However, this format depends on the type of COBOL program you are using and the COBOL version. The following table illustrates the differences.

TABLE 4-1 Byte Ordering
Micro Focus COBOL Version	Program Type	Set Type	Format
Before 3.0	COBOL 74 (`.clt`)	BLL Cell	`9(9) COMP-5`
Before 3.0	COBOL (`.cl2`)	Pointer	`9(9) COMP-5`
3.0 or later	COBOL 74 (`.clt`)	BLL Cell	`9(9) COMP`
3.0 or later	COBOL (`.cl2`)	Pointer	`9(9) COMP-5`

When converting COBOL 74 programs from versions prior to 3.0 and later, BLL cell formats must have the picture clause changed if they are COMP-5 format. The pointer to integer redefinitions in Micro Focus COBOL must use the PIC 9(9) COMP-5 format for the redefinition. Because these addresses can be greater than nine digits, the notrunc compiler option should be used. Finally, Sun MTP determines which SET format to use based on the program type (.clt or .cl2).

Calling C Subroutines From COBOL Programs

C subroutines always use 2-byte and 4-byte integers in the order defined by the system architecture. If integers are passed from COBOL to C, you must declare them in COBOL as COMP-5. Otherwise, the C subroutine might not execute properly.

Supported ISC Functions

Sun MTP provides a subset of the following CICS ISC functions:

Transaction routing

Function shipping

Asynchronous processing

Distributed program link (DPL)

Distributed Transaction processing (DTP)

These functions work bidirectionally; that is, from a Sun MTP region to a CICS region and vice versa. Interoperability with systems other than CICS has not been verified.

When using these ISC functions, Sun MTP checks the value of the SYSID parameter in EXEC CICS commands and validates it against system entries defined in the TCT.

Transaction routing enables terminals connected to one system to run transactions in another.

Function shipping is provided for VSAM file control, transient data queue, and temporary storage queue commands. The specific commands that function shipping can use are listed in the following table.

TABLE 4-2 Function Shipping Commands
Command Function	Commands
VSAM file control	`READ, WRITE, DELETE, REWRITE, UNLOCK, STARTBR, RESETBR, ENDBR, READNEXT, READPREV`
Transient data queue control	`READQ TD, WRITEQ TD, DELETEQ TD`
Temporary storage queue control	`READQ TS, WRITEQ TS, DELETEQ TS`

Sun MTP function shipping is a conversation over a confirm level logical unit 6.2 (LU6.2) session that requires that the mirror transaction CVMI or CPMI be defined on the CICS system receiving the function shipping request. Abends or implicit or explicit requests for syncpoints cause confirm level syncpoint protocol exchanges with the mirror.

Asynchronous processing relates to remote START and CANCEL commands. It permits a transaction to start a transaction in a remote system and pass data to it. Asynchronous processing applies to any application situation in which it is not necessary or desirable to block access to local resources while a remote request is being processed.

DPL enables a program on one system to link to a program on another system. DPL enables users to link to existing programs running on mainframes that access such resources as DB2 or DL/I databases.

DTP allows the distribution of the processing among multiple systems. It is useful for applications that require remote processing of remote resources or transfer of online or batch data between systems. Sun MTP supports the EXEC CICS command-level interface for DTP with the restrictions defined in Supported CICS Commands.

Sun MTP does not support the following areas of ISC:

Logical device control

BMS paging with Sun MTP as the TOR (terminal owning region)

Routing list in transaction routing/terminal control

Batch data interchange in terminal control

Sync level 2 mirrors and protocols

Two of the three LU6.2 conversation security modes are implemented: local and identify. Verify is not supported.

While it is not the direct concern of the individual developer, be aware that code set translation is required for display usage data that must be sent to the host. Tools are provided to assist in this task. Here, Sun MTP takes a different approach to IBM ASCII products where the host is responsible for inbound data conversion. Sun MTP looks like an EBCDIC host to CICS.

For more information about using ISC functions, refer to the Sun Mainframe Transaction Processing Software Administrator's Guide.

Index Initialization

This section describes how the contents of working storage are initialized in COBOL programs and how the concept of working storage is treated for compatibility in PL/I and C programs.

COBOL Programs

Before Sun MTP run a COBOL application program, it initializes the contents of working storage. Using a copy of working storage that was saved before executing the COBOL program for the first time, Sun MTP saves everything from DFH-START (which is included by kixclt as the first working-storage item) to DFHEIV (which is the last item before the linkage section). However, because COBOL indexes are not stored within these boundaries, Sun MTP is unable to initialize the COBOL indexes for every execution of a COBOL program. Therefore, these index values must be initialized by the application.

PL/I and C Programs

Although PL/I and C do not have a concept of working storage, two characters are defined in an include file to provide compatibility with Sun MTP. The include file is part of the API. The characters correspond to the beginning and end of working storage.

Levels of Support for CICS Commands

The following table describes the three levels of support for CICS commands.

Level	Description of Support
Supported	Commands are checked for correct syntax. If the syntax is correct, the command executes.
Recognized but not supported	Commands are checked for correct syntax. If the syntax is correct, the command executes but is treated as a null command. That is, Sun MTP returns to the calling program with a return code of zero.
Not recognized	Commands are flagged as an error.

Refer to the CICS documentation for information about how to include CICS commands in an application program.

Sun MTP supports the following options for handling commands:

NOHANDLE

RESP

RESP2

DFHRESP

The NOHANDLE, RESP, and RESP2 options can be used on any command that might return an error condition. The DFHRESP option can be used in an IF statement to check for a specific error. Commands return zero for RESP2, unless otherwise noted.

Supported CICS Commands

This section describes the command-level CICS statements (API) that Sun MTP supports.

`ABEND`

ABEND [ABCODE (char-4)] [CANCEL] [NODUMP]

ABEND abnormally terminates a task. The main storage associated with the task is released. It is fully supported.

`ABCODE`	Identifies the termination.
`CANCEL`	Ignores exits established by `HANDLE ABEND` commands.
`NODUMP`	Specifies an abend without causing a dump to be taken.

`ADDRESS`

ADDRESS [COMMAREA(pointer-ref)] [CSA(pointer-ref)] [CWA(pointer-ref)] [EIB(pointer-ref)] [TCTUA(pointer-ref)] [TWA(pointer-ref)]

ADDRESS provides the ability to obtain access to the storage areas that are specified as options.

`COMMAREA`	Returns the address of the currently defined communication area for the currently executing program. `COMMAREA` is used to pass information between application programs. The pointer reference is the address of the current `COMMAREA`. If the `COMMAREA` does not exist, the pointer reference is set to the null value `X'FF000000'`.
`CSA`	Returns the address of a 1024-byte common storage area. However, all fields in this area are set to nulls. Because the internal structure of Sun MTP differs significantly from IBM CICS, no access to internal structures is allowed.
`CWA`	If the length of the Common Work Area (CWA) in the System Initialization Table (SIT) is nonzero, the address of the `CWA` is returned. If the length is zero, the value `X'FF000000'` is returned. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the SIT.
`EIB`	Returns the address of the execution interface block (EIB).
`TCTUA`	If the length of the Terminal Control Table User Area (TCTUA) in the TCT is nonzero, the address of the `TCTUA` is returned. If the length is zero, the value `X'FF000000'` is returned. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TCT.
`TWA`	If the length of the Transaction Work Area (TWA) in the Program Control Table (PCT) is nonzero, the address of the `TWA` is returned. If the length is zero, the value `X'FF000000'` is returned. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the PCT.

The following option is not supported:

ACEE

`ALLOCATE` (APPC mapped)

ALLOCATE SYSID(char-4) [PROFILE(char-4)] [NOQUEUE | NOSUSPEND] [STATE(cvda)]

ALLOCATE is fully supported. It allocates an LU6.2 session for use by a DTP program.

`NOQUEUE`	Returns control to the instruction following the `ALLOCATE` if a session is not immediately available from the specified `SYSID`.
`NOSUSPEND`	Alternative keyword for `NOQUEUE`.
`PROFILE`	If specified, must match a `MODE NAME` in the LU6.2 configuration file.
`STATE`	Gets the state of the current conversation. The `cvda` value returned is `ALLOCATED`.
`SYSID`	Must match an entry in the TCT-System Entries table.

`ASKTIME`

ASKTIME [ABSTIME(doubleword)]

ASKTIME updates the fields EIBDATE and EIBTIME in the EXEC interface block with the current date and time. ABSTIME returns a double word value that is the time, in milliseconds, since 00:00:00.000 on January 1, 1900.

ABSTIME

COBOL

Defined in COBOL as S9(15) COMP-3.

In earlier versions of Sun MTP, you were required to convert the fields to S9(15) COMP to use them in COBOL statements such as MOVE, COMPUTE, or DISPLAY. If you did convert the fields to S9(15) COMP, you must use the -n option of kixstart or unikixmain.

Either format is acceptable for calls to ASKTIME or FORMATTIME.

PL/I

Defined in PL/I as FIXED DEC(15).

On some platforms, the three least significant digits of this value (the milliseconds) are always zero.

`ASSIGN`

ASSIGN option(data-area) [option(data-area)] ...

ASSIGN provides the ability to obtain the values of various system variables. The command is partially supported. The list of options describes the value returned for each option. If you specify options that are not supported, no value is placed in the associated data area.

`ABCODE (char-4)`	Value of the abend code. If an abend has not occurred, it returns blanks.
`ABDUMP (char-1)`	Always returns the value `X'00'`.
`APLKYBD (char-1)`	Always returns the value `X'00'`.
`APLTEXT (char-1)`	Always returns the value `X'00'`.
`APPLID (char-8)`	Application name specified in the SIT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide.
`BTRANS (char-1)`	Always returns the value `X'00'`, indicating that there is no background transparency.
`COLOR (char-1)`	Depending on the client, returns the value `X'00'` to indicate that there is no extended color capability, or the value `X'FF'` to indicate support for extended color.
`CWALENG (halfword)`	Length of the `CWA` in the SIT.
`DELIMITER (char-1)`	Always returns the value `X'00'`.
`DESTCOUNT (halfword)`	Always returns the value `X'0001'`.
`DESTID (char-8)`	Always returns spaces.
`DESTIDLENG (halfword)`	Always returns zero.
`DSSCS (char-1)`	Always returns the value `X'00'`.
`DS3270 (char-1)`	Always returns the value `X'00'`.
`EWASUPP (char-1)`	Always returns the value `X'00'`.
`EXTDS (char-1)`	Always returns the value `X'00'`, indicating that there is no extended data stream capability.
`FACILITY (char-4)`	Contains the terminal, transaction, DTP conversation ID or queue that initiated this transaction.
`FCI (char-1)`	Returns the value `X'01'` to indicate that a terminal is associated with the transaction or `X'00'` to indicate that no terminal is associated with this transaction.
`GCHARS (halfword)`	Always returns zero.
`GCODES (halfword)`	Always returns zero.
`GMMI (char-1)`	Always returns the value `X'00'` to indicate that there is no good morning message.
`HILIGHT (char-1)`	Depending on the client, returns the value `X'00'` to indicate that there is no extended highlight capability or the value `X'FF'` to indicate support for extended highlight.
`INITPARM (address)`	Always returns a null address.
`INITPARMLEN (halfword)`	Always returns zero.
`INPARTN (char-2)`	Always returns spaces.
`KATAKANA (char-1)`	Always returns the value `X'00'` to indicate that the principal facility does not support Katakana.
`LDCMNEM (char-1)`	Always returns the value `X'00'` to indicate that no overflow has taken place.
`LDCNUM (char-1)`	Always returns the value `X'00'` to indicate that no overflow has taken place.
`MAPCOLUMN (halfword)`	Always returns zero.
`MAPHEIGHT (halfword)`	Always returns zero.
`MAPLINE (halfword)`	Always returns zero.
`MAPWIDTH (halfword)`	Always returns zero.
`MSRCONTROL (char-1)`	Always returns the value `X'00'` to indicate that the terminal does not support MSR control.
`NATLANGINUSE (char-1)`	Always returns the value `X'00'`.
`NETNAME (char-8)`	If the terminal type is 3270, the logical unit name is returned. Otherwise, the logical tty name is returned.
`NEXTTRANSID (char-4)`	Always returns spaces.
`NUMTAB (char-1)`	Always returns the value `X'00'` to indicate that no tabs are required.
`OPCLASS (char-3)`	If the user signed on with `CSSN`, returns the operator class from the Sign-On Table (SNT). Otherwise, returns the operator class from the TCT. For information about the SNT and the TCT, refer to the Sun Mainframe Transaction Processing Software Reference Guide.
`OPERKEYS (char-3)`	If the user signed on with `CSSN`, returns the first three characters of the operator resource key from the SNT. Otherwise, returns the first three characters of the operator resource key from the TCT.
`OPID (char-3)`	If the user signed on with `CSSN`, returns the operator identification from the SNT. Otherwise, returns the operator identification from the TCT.
`OPSECURITY (char-8)`	If the user signed on with `CSSN`, returns the full 8-byte operator security key from the SNT. Otherwise, returns the full 8-byte operator security key from the TCT. Mainframe programs expect a 3-byte value. Because Sun MTP returns an 8-byte value, any programs using this command must be modified to adjust for this difference. Otherwise, memory could be corrupted.
`ORGABCODE (char-4)`	Always returns spaces.
`OUTLINE (char-1)`	Always returns the value `X'00'`.
`PAGENUM (char-2)`	Returns the current BMS page number or `INVREQ` if BMS Paging is not active.
`PARTNPAGE (char-2)`	Always returns blanks, indicating that partitions are not in use.
`PARTNS (char-1)`	Always returns the value `X'00'` to indicate that the terminal does not support partitions.
`PARTNSET (char-6)`	Always returns blanks, indicating that there is no application partition set.
`PRINSYSID (char-4)`	Returns the SysID of the connection that a remote system is known by in the local system. If the principal facility of the task is not a DTP conversation, `INVREQ` is returned.
`PROGRAM (char-8)`	Returns the 8-character name of the currently running program.
`PS (char-1)`	Always returns the value `X'00'` to indicate that there is no programmed symbols capability.
`QNAME (char-4)`	Returns the name of the transient data queue that initiated this task.
`RESSEC (char-1)`	Always returns spaces.
`RESTART (char-1)`	Always returns the value `X'00'` to indicate a normal start as opposed to a restart.
`SCRNHT (halfword)`	Returns a value indicating the screen height.
`SCRNWD (halfword)`	Returns a value indicating the screen width.
`SIGDATA (halfword)`	Always returns zero.
`SOSI (char-4)`	Always returns the value `X'00'`, indicating that there is no Shift Out/Shift In capability.
`STARTCODE (char-2)`	Returns a code indicating how the transaction was started.
`STATIONID (char-1)`	Always returns the value `X'00'`, indicating no 2980 station identifier.
`SYSID (char-4)`	Gives the system identifier from the SIT.
`TASKPRIORITY (halfword)`	Always returns zero.
`TCTUALENG (halfword)`	Gives the length of the `TCTUA` from the TCT.
`TELLERID (char-1)`	Always returns spaces.
`TERMCODE (char-2)`	Returns the terminal type and model. If the terminal is a 3277 remote terminal, the type is always equal to `X'91'`. The model can be `2', `4,' or `5' indicating a 3270 model 2, 4, or 5, respectively. For DTP sessions, the type is `X'C0'` and the model is always set to `0'.
`TERMPRIORITY (halfword)`	Always returns zero.
`TEXTKYBD (char-1)`	Always returns the value `X'00'`.
`TEXTPRINT (char-1)`	Always returns the value `X'00'`.
`TRANPRIORITY (halfword)`	Always returns zero.
`TWALENG (halfword)`	Length of the `TWA` from the PCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the PCT.
`UNATTEND (char-1)`	Always returns the value `X'00'`, indicating that the terminal is attended.
`USERID (char-8)`	If the user signed on either using `CSSN`, `CESN` or automatically through transaction routing, returns this user ID. Otherwise, returns the default system user ID for the Sun MTP region executing the transaction. Refer to the Sun Mainframe Transaction Processing Software Configuration Guide for information about the `KIXISC_USERID` environment variable.
`USERNAME (data-area)`	Returns a 20-character identifier of the operator name that corresponds to the `USERID`.
`USERPRIORITY (halfword)`	Always returns zero.
`VALIDATION (char-1)`	Always returns the value `X'00'`, indicating that there is no validation capability.

The following options are not supported:

`ABPROGRAM`	`ALTSCRNHT`	`ALTSCRNWD`
`ASRAINTRPT`	`ASRAPSW`	`ASRAREGA`
`CMDSEC`	`DEFSCRNHT`	`DEFSCRNWD`
`SUSERNAME`

`BIF DEEDIT`

BIF DEEDIT FIELD(data-area) [LENGTH(halfword)]

BIF DEEDIT removes alphabetic and special characters from a data field, then right justifies and zero-fills the remaining digits.

`FIELD`	Specifies the field to be edited.
`LENGTH`	Specifies the field length in bytes.

`CANCEL`

CANCEL REQID(char-8) [TRANSID(char-4)] [SYSID(char-4)]]

CANCEL provides the ability to cancel a previous START command. It is effective only if the task to be cancelled has not yet started.

`REQID`	Must match the `REQID` specified in a previous `START` command.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about asynchronous processing.
`TRANSID`	If specified, it must match an entry in the PCT. It also must match the `TRANSID` specified in a previous `START` command.

`CHANGE PASSWORD`

CHANGE PASSWORD(current-pw) (char-8) USERID(current-uid) (char-8) NEWPASSWORD(new-pw) (char-8) ESMREASON(err-reason) (fullword binary)

CHANGE PASSWORD provides the ability to change a user's password. It is fully supported, with the exception noted at the end of this section. The new password is available immediately.

`PASSWORD`	Current password.
`USERID`	Current user ID.
`NEWPASSWORD`	New password.
`ESMREASON`	Error detail on the new password.

The password is changed only if the user ID and current password are valid and properly specified. Otherwise, the following error conditions are returned.

Condition	RESP2	Reason
`NOTAUTH`	2	Current password is wrong.
`NOTAUTH`	19	Current password is suspended and `ESMREASON` is set to 901.
`NOTAUTH`	4	New password is greater than the maximum length; `ESMREASON` is set to 902.
`NOTAUTH`	4	New password is less than minimum length; `ESMREASON` is set to 903.
`NOTAUTH`	4	New password value is identical to the old password value; `ESMREASON` is set to 904.
`USERIDERR`	8	Current userid is invalid.

The following option is not supported:

ESMRESP

`COLLECT STATISTICS`

COLLECT STATISTICS SET(pointer-ref) TDQUEUE(data-value)

For COLLECT STATISTICS, Sun MTP supports the collection of a single statistical item, the number of intrapartition outputs, associated with the Intrapartition Transient Data Queue. The intrapartition output count is initialized to zero when the region is started. It is updated as activity occurs against the transient data queues and is available through the COLLECT STATISTICS command during the life of the region. When the region is shut down and restarted, the count is initialized to zero again.

`SET`	Specifies a pointer to be set with the address of the data area that contains the formatted statistics.
`TDQUEUE`	The data-value is the 4-character name of the queue from the Destination Control Table (DCT).

The following error is returned when the queue name is not found in the DCT:

NOTFND RESP2=2

The following options are not supported:

`AUTOINSTALL`	`CONNECTION`	`DISPATCHER`
`DTB`	`FILE`	`IRCBATCH`
`JOURNALNUM`	`LASTRESET`	`LASTRESETHRS`
`LASTRESETMIN`	`LASTRESETSEC`	`LSRPOOL`
`MONITOR`	`NODE`	`POOL`
`POOL TARGET`	`PROGAUTO`	`PROGRAM`
`STORAGE`	`SYSDUMP`	`TABLEMGR`
`TCLASS`	`TERMINAL`	`TRANCLASS`
`TRANDUMPCODE`	`TRANSACTION`	`TSQUEUE`
`VTAM`

`CONNECT PROCESS`

CONNECT PROCESS CONVID (char-4) PROCNAME(char-8) PROCLENGTH(halfword) [PIPLIST(data-area) PIPLENGTH(halfword)] SYNCLEVEL(halfword) [STATE(cvda)]

CONNECT PROCESS is supported with the exception noted. It specifies a transaction name and synchronization level that a DTP program uses to start a partner on a remote system.

`CONVID`	Identifies the conversation to which the command relates.
`PIPLENGTH`	Total length of the specified process initialization parameter (PIP) list. If `PIPLIST` is specified, you must specify `PIPLENGTH`.
`PIPLIST`	The PIP data to be sent to the remote system. The PIP list consists of variable-length records, each containing a single PIP.
`PROCLENGTH`	Length of the name specified by the `PROCNAME` option.
`PROCNAME`	Transaction to be attached in the remote system.
`STATE`	Gets the state of the current conversation.
`SYNCLEVEL`	Synchronization level for the current session.

The following option is not supported:

SESSION

`CONVERSE` (APPC)

CONVERSE FROM(data-area) FROMLENGTH(halfword)|FROMFLENGTH(fullword) [INTO(data-area)|SET(pointer-ref)] [TOLENGTH(halfword-data-area)| TOFLENGTH(fullword-data area)] [MAXLENGTH(halfword)|MAXFLENGTH(fullword)] [NOTRUNCATE] [CONVID (char-4)] [STATE (cvda)]

CONVERSE is a combination of a SEND command followed by a RECEIVE. It is supported for 3278/3279-type terminals and for DTP conversations. It is not supported for other types of terminals.

`CONVID`	Identifies the conversation to which the command relates.
`FROM`	Data to be sent to the partner transaction.
`FROMFLENGTH`	Fullword alternative to `FROMLENGTH`.
`FROMLENGTH`	Length, as a halfword binary value, of the data to be sent.
`INTO`	Application target data area into which to receive data from the application program connected to the other end of the current conversation.
`MAXFLENGTH`	Fullword alternative to `MAXLENGTH`.
`MAXLENGTH`	Maximum amount of data that CICS is to receive in response to a `CONVERSE` command. If `INTO` is specified, `MAXLENGTH` overrides the use of `TOLENGTH` as an input. If `SET` is specified, `MAXLENGTH` provides a way for the program to limit the amount of data it receives at one time. If the length of data exceeds the value specified and the `NOTRUNCATE` option is not present, the data is truncated to that value and the `LENGERR` condition occurs. The data area specified in the `TOLENGTH` option is set to the original length of data. If the length of data exceeds the value specified and the `NOTRUNCATE` option is present, CICS retains the remaining data and uses it to satisfy subsequent `RECEIVE` commands. If there is no argument to `MAXLENGTH`, CICS defaults to the value in the `TOGENGTH` option.
`NOTRUNCATE`	When the data available exceeds the length requested, retain the remaining data for retrieval by subsequent `RECEIVE` commands, instead of discarding it.
`SET`	Pointer reference to set to the address of the data received from the partner transaction. The pointer reference, unless changed by other commands or statements, is valid until the next `CONVERSE` (APPC) command or the end of the task.
`STATE`	Gets the state of the current conversation.
`TOFLENGTH`	Fullword alternative to `TOLENGTH`.
`TOLENGTH`	Length, as a halfword binary value, of the data to be received. If you specify `INTO`, but omit `MAXLENGTH`, this option specifies the maximum length that the program accepts.

`CONVERSE` (LUTYPE2/LUTYPE3)

CONVERSE FROM(data-area) {FROMLENGTH(halfword)| FROMFLENGTH(fullword)} {INTO(data-area)|SET(pointer-ref)} {TOLENGTH(halfword-data-area)| TOFLENGTH(fullword-data area)} [MAXLENGTH(halfword)|MAXFLENGTH(fullword)] [NOTRUNCATE] [[ERASE] [CTLCHAR(char-1)]]

CONVERSE is a combination of a SEND command followed by a RECEIVE. It is supported for 3278/3279-type terminals, with the exceptions noted and for DTP conversations. It is not supported for other types of terminals.

`CTLCHAR`	A 1-byte write control character that controls the `CONVERSE` command. A COBOL user must specify a data area containing this character. If this option is omitted, all modified data tags are reset to zero and the keyboard is restored.
`ERASE`	Erases the buffer or the display image and returns the cursor to the upper left corner of the screen before writing occurs.
`FROM`	Data to be sent to the partner transaction.
`FROMFLENGTH`	Fullword alternative to `FROMLENGTH`.
`FROMLENGTH`	Length, as a halfword binary value, of the data to be sent.
`INTO`	Application target data area into which to receive data from the application program connected to the other end of the current conversation.
`MAXFLENGTH`	Fullword alternative to `MAXLENGTH`.
`MAXLENGTH`	Maximum amount of data that CICS is to receive in response to a `CONVERSE` command. If `INTO` is specified, `MAXLENGTH` overrides the use of `TOLENGTH` as an input. If `SET` is specified, `MAXLENGTH` provides a way for the program to limit the amount of data it receives at one time. If the length of data exceeds the value specified and the `NOTRUNCATE` option is not present, the data is truncated to that value and the `LENGERR` condition occurs. The data area specified in the `TOLENGTH` option is set to the original length of data. If the length of data exceeds the value specified and the `NOTRUNCATE` option is present, CICS retains the remaining data and uses it to satisfy subsequent `RECEIVE` commands. If there is no argument to `MAXLENGTH`, CICS defaults to the value in the `TOGENGTH` option.
`NOTRUNCATE`	When the data available exceeds the length requested, retain it for retrieval by subsequent `RECEIVE` commands, instead of discarding it.
`SET`	Pointer reference to set to the address of the data received from the partner transaction. The pointer reference, unless changed by other commands or statements, is valid until the next `CONVERSE` (APPC) command or the end of the task.
`TOFLENGTH`	Fullword alternative to `TOLENGTH`.
`TOLENGTH`	Length of the data to be received as a halfword binary value. If you specify `INTO` but omit `MAXLENGTH`, this option specifies the maximum length that the program accepts.

The following options are not supported:

ASIS DEFRESP STRFIELD

`DELAY`

DELAY [INTERVAL(packed-7)|TIME(packed-7)| FOR[HOURS(hh)][MINUTES(mm)][SECONDS(ss)]| UNTIL[HOURS(hh)][MINUTES(mm)][SECONDS(ss)]] [REQID(char-8)]

DELAY is fully supported. It suspends the processing of a task for the specified interval.

`FOR`	Specifies the duration of the delay.
`HOURS`	Fullword binary value in the range 0-99.
`INTERVAL`	Interval of time that must elapse from the time when the `DELAY` command is issued.
`MINUTES`	Fullword binary value in the range 0-59 or 0-5999.
`REQID`	Unique name that identifies a command; used as a temporary storage identifier.
`SECONDS`	Fullword binary value in the range 0-59 or 0-359999.
`TIME`	Suspension time.
`UNTIL`	Specifies the time at the end of the delay.

`DELETE`

DELETE DATASET(dataset)|FILE(dataset) [RIDFLD(data-area)] [KEYLENGTH(halfword)] [GENERIC [NUMREC (halfword-data-area)]] [SYSID(char-4)] [RBA|RRN]

DELETE is fully supported for VSAM datasets. It deletes a record or a group of records from a dataset.

`DATASET`	Dataset name. If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for more information.
`FILE`	Dataset name.
`GENERIC`	Search key is a generic key with a length specified in the `KEYLENGTH` option. Can only be used with KSDS files.
`KEYLENGTH`	Length of the key specified in the `RIDFLD` option.
`NUMREC`	Data area that CICS set to the number of deleted records.
`RBA`	Specifies that the record identification field specified in the `RIDFLD` option contains a relative byte address.
`RIDFLD`	Record identification field; can be a key, a relative byte address or a relative record number.
`RRN`	Record identification field specified in the `RIDFLD` option contains a relative record number.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`DELETEQ TD`

DELETEQ TD QUEUE(char-4) [SYSID(char-4)]

DELETEQ TD is fully supported. It deletes all the data associated with the transient data queue specified in the QUEUE option.

`QUEUE`	If `SYSID` is not coded, it must match a destination entry in the DCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the DCT.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TCT.

`DELETEQ TS`

DELETEQ TS QUEUE(char-8) [SYSID(char-4)]

DELETEQ TS is fully supported. It deletes all the data associated with the temporary storage queue specified in the QUEUE option.

`QUEUE`	If `SYSID` is not coded, an entry must be made in the TST if the queue is recoverable or remote. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TST.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`DEQ`

DEQ RESOURCE(data-area) [LENGTH(halfword)] [MAXLIFETIME(cvda) [LUW|TASK]]

DEQ is fully supported. It dequeues and makes available a previously enqueued resource.

LENGTH

Resource has a length given by the data value; a halfword binary value from 1-255.

MAXLIFETIME

Duration of the ENQ being released. Values passed are LUW and TASK.

LUW: The default. ENQ was acquired with a duration of a logical unit of work.

TASK: ENQ was acquired with a duration of a task.

RESOURCE

Resource to be dequeued from, or a data area containing the resource. If it is a data area, you must use the LENGTH option.

`DUMP`

DUMP DUMPCODE(char-4) [FROM(data-area)[LENGTH(halfword) | FLENGTH(fullword)]] [COMPLETE] [TASK] [STORAGE] [PROGRAM] [TERMINAL] [TABLES] [DCT] [FCT] [PCT] [PPT] [SIT] [TCT]

DUMP dumps specific transaction storage areas in Sun MTP. The command is fully supported, although the internal table areas have a different format than CICS.

Note - This command performs the same function as DUMP TRANSACTION. However, the DUMP TRANSACTION command is not supported.

`COMPLETE`	Dumps all main storage areas related to a task, all tables and all control blocks.
`DUMPCODE`	Name that identifies the dump.
`FLENGTH`	Length (fullword binary) of the storage area specified in the `FROM` option.
`FROM`	Dumps the specified data area.
`LENGTH`	Length (halfword binary) of the data area specified in the `FROM` option.
`PROGRAM`	Dumps program storage areas associated with the task.
`STORAGE`	Dumps storage areas associated with the task.
`TABLES`	Dumps the DCT, FCT, PCT, PPT, SIT, and TCT. If you want to dump certain tables, use the specific table option.
`TASK`	Dumps storage areas associated with the task. This option dumps more storage areas than the `STORAGE` option. Refer to the IBM CICS documentation for more information.
`TERMINAL`	Dumps storage areas associated with the terminal.

`ENDBR`

ENDBR DATASET(dataset)|FILE(dataset) [REQID(halfword)] [SYSID(char-4)]

ENDBR is fully supported for VSAM datasets. It ends a browse operation on a dataset. ISAM and DAM datasets are not supported.

`DATASET`	Dataset name. If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for more information.
`FILE`	Dataset name of file being browsed.
`REQID`	Unique request identifier for a browse. If not specified, a default value of zero is used.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`ENQ`

ENQ RESOURCE(data-area) [LENGTH(halfword)] [MAXLIFETIME(cvda) | UOW | TASK] [NOSUSPEND]

ENQ is fully supported. It enqueues a resource that is to be protected from concurrent use by other tasks.

If no UOW, TASK, or MAXLIFETIME option is specified and the task has to wait for the resource to become available, the task assumes the life (that is, UOW or TASK) that was assigned to the resource when the resource was originally enqueued.

`LENGTH`	Resource has a length given by the data value; a halfword binary value from 1-255.
`MAXLIFETIME`	Duration of the `ENQ` to be automatically released. Values passed are `UOW` and `TASK`.
`UOW`	The default. Duration of the `ENQ` is a unit of work. The `LUW` option is supported for backward compatibility.
`TASK`	Duration of the `ENQ` is a task.
`NOSUSPEND`	The application program is not to be suspended if the resource on the `ENQ` command is unavailable, but the `ENQBUSY` condition occurs.
`RESOURCE`	The resource to be enqueued on, specified by an area whose address represents the resource or by a variable that contains the resource. If you specify a variable, you must use the `LENGTH` option.

`ENTER`

ENTER TRACEID(halfword) [FROM(char-8)] [RESOURCE(char-8)] [ENTRYNAME(char-8)]

ENTER puts user data into a trace table. You can then print this data using the DUMP command.

`ENTRYNAME`	Entry name.
`FROM`	Data area whose contents are to be entered into the data field of the trace table entry.
`RESOURCE`	An 8-character name that is to be entered into the resource field of the trace table entry.
`TRACEID`	Trace identifier.

The following options are not supported:

`ACCOUNT`	`FROMLENGTH`	`MONITOR`
`PERFORM`	`TRACENUM`

`EXTRACT ATTRIBUTES`

EXTRACT ATTRIBUTES [CONVID(char-4)|SESSION(char-4)] STATE(cvda)

EXTRACT ATTRIBUTES is fully supported. It informs the application program of the current state of the DTP conversation.

`CONVID`	Identifies the conversation to which the command relates. Use this option with new programs.
`SESSION`	Symbolic identifier of the session. Included for compatibility with older releases.
`STATE`	Gets the state of the transaction program.

`EXTRACT CERTIFICATE`

EXTRACT CERTIFICATE(pointer-ref) [LENGTH(data-area)] OWNER | ISSUER [COMMONNAME(pointer-ref)] [COMMONNAMELEN(data-area)] [COUNTRY(pointer-ref)] [COUNTRYLEN(data-area)] [STATE(pointer-ref)] [STATELEN(data-area)] [LOCALITY(pointer-ref)] [LOCALITYLEN(data-area)] [ORGANIZATION(pointer-ref)] [ORGANIZATLEN(data-area)] [ORGUNIT(pointer-ref)] [ORGUNITLEN(data-area)]

EXTRACT CERTIFICATE enables the application to obtain information from the X.509 certificate that was received from an SSL client during an SSL handshake with the SSL server (unikixssl). The certificate contains the fields that identify the owner (or subject) of the certificate, and fields that identify the Certificate Authority (CA) that issued the certificate. You can select the fields that you require by specifying the OWNER or ISSUER option. You cannot retrieve both OWNER and ISSUER fields with one command.

`CERTIFICATE`	Specifies a pointer reference to be set to the address of the full certificate (distinguished name) received from the client. The string `no certificate` is returned if the client did not provide a certificate. If `no certificate` is returned, the other options return zero length.
`LENGTH`	Specifies a fullword binary data area to be set to the length of the full certificate (distinguished name).
`OWNER`	Indicates that the values returned by this command refer to the owner of the certificate.
`ISSUER`	Indicates that the values returned by this command refer to the certificate of the CA that issued this certificate.
`COMMONNAME`	Specifies a pointer reference to be set to the common name from the client certificate.
`COMMONNAMLEN`	Specifies a fullword binary data area to be set to the length of the common name from the client certificate.
`COUNTRY`	Specifies a pointer reference to be set to the address of the country from the client certificate.
`COUNTRYLEN`	Specifies a halfword binary data area to be set to the length of the country from the client certificate.
`STATE`	Specifies a pointer reference to be set to the address of the state or province from the client certificate.
`STATELEN`	Specifies a halfword binary data area to be set to the length of the state or province from the client certificate.
`LOCALITY`	Specifies a pointer reference to be set to the address of the locality from the client certificate.
`LOCALITYLEN`	Specifies a halfword binary data area to be set to the length of the locality from the client certificate.
`ORGANIZATION`	Specifies a pointer reference to be set to the address of the organization from the client certificate.
`ORGANIZATLEN`	Specifies a halfword binary data area to be set to the length of the organization from the client certificate.
`ORGUNIT`	Specifies a pointer reference to be set to the address of the organization unit from the client certificate.
`ORGUNITLEN`	Specifies a halfword binary data area to be set to the length of the organization unit from the client certificate.

The following options are not supported:

SERIALNUM SERIALNUMLEN USERID

If a transaction that uses the EXTRACT CERTIFICATE API was not started by an SSL client (through unikixssl), an INVREQ RESP value is returned.

`EXTRACT PROCESS`

EXTRACT PROCESS[CONVID(char-4)] [PROCNAME(char-8) PROCLENGTH(halfword) [MAXPROCLEN(halfword)]] [SYNCLEVEL(halfword)] [PIPLIST(pointer-ref) PIPLENGTH(halfword)

EXTRACT PROCESS is fully supported. It extracts information about the current DTP conversation.

`CONVID`	Identifies the conversation to which the command relates.
`MAXPROCLEN`	Buffer length of `PROCNAME`. If not specified, the buffer is assumed to have 32 bytes.
`PIPLENGTH`	Halfword binary data area in which the total length of the process initialization parameter (PIP) list is returned. If `PIPLIST` is specified, you must specify `PIPLENGTH`.
`PIPLIST`	Pointer reference that is set to the address of a data area containing a PIP list. This list contains variable-length records in the same format as the list in the `CONNECT PROCESS` command. A returned value of zero means that no PIP data has been received.
`PROCLENGTH`	Halfword data area set to the length of the process name. If `PROCNAME` is specified, you must specify this option.
`PROCNAME`	Data area to receive the process name specified by the remote system that caused the task to start.
`SYNCLEVEL`	Synclevel value.

`FORMATTIME`

FORMATTIME ABSTIME(doubleword) [YYDDD(char-6-data-area)] [YYYYDDD(char-8-data-area)] [YYMMDD(char-8-data-area)] [YYYYMMDD(char-10-data-area)] [YYDDMM(char-8-data-area)] [YYYYDDMM(char-10-data-area)] [DDMMYY(char-8-data-area)] [DDMMYYYY(char-10-data-area)] [MMDDYY(char-8-data-area)] [MMDDYYYY(char-10-data-area)] [DATE(char-8-data-area)] [DATEFORM(char-6-data-area)] [DATESEP [(char-1)]] [DAYCOUNT(fullword-data-area)] [DAYOFWEEK(fullword-data-area)] [DAYOFMONTH(fullword-data-area)] [MONTHOFYEAR(fullword-data-area)] [YEAR(fullword-data-area)] [TIME(char-8-data-area)TIMESEP(char-1)]]

FORMATTIME is fully supported. It formats the time as returned from the ABSTIME option of the ASKTIME command. The various year/month/day options are not described.

`ABSTIME`	Data value for the time, in packed decimal.
`DATE`	Variable that is to receive the date.
`DATEFORM`	Format of the installation-defined date. This option requires that the `DATE` option be used.
`DATESEP`	Separator character inserted between year, month, and day values. If omitted, no separator is inserted.
`DAYCOUNT`	Returns the number of days since January 1, 1900.
`DAYOFWEEK`	Returns the relative day number of the week, where Sunday is 0 and Saturday is 6.
`DAYOFMONTH`	Returns the number of the day in the month.
`MONTHOFYEAR`	Relative month of the year, where January is 1 and December is 12.
`TIME`	An 8-character value using the 24-hour clock. The separator is specified by the `TIMESEP` option.
`TIMESEP`	Character separator in the returned time. If you omit this option, no separator is used. If you omit the `(char-1)`, colons are used.
`YEAR`	The 4-figure number of the year.

`FREE`

FREE [CONVID(char-4)] [STATE(cvda)]

FREE is fully supported. It is used to deallocate a DTP conversation.

`CONVID`	Identifies the session to be freed.
`STATE`	Gets the state of the current conversation

`FREEMAIN`

FREEMAIN DATA(data-area)

FREEMAIN is fully supported. It releases main storage previously acquired by an application program.

`GETMAIN`

GETMAIN SET(pointer-ref) LENGTH(halfword) | FLENGTH(fullword) [INITIMG(char-1)] [NOSUSPEND] [SHARED]

GETMAIN is supported with the exception noted. It acquires main storage for use by an application program. Normally, storage acquired using this command is taken from the transaction's virtual address space and is not accessible by any other transaction. If storage is acquired with the SHARED option, the storage is acquired from shared memory. Shared memory addresses are guaranteed to be consistent between transactions. Storage that is acquired with this option must be explicitly freed.

`FLENGTH`	Number of bytes of storage required, in fullword binary format.
`INITIMG`	Optional 1-byte initialization value.
`LENGTH`	Number of bytes of storage required, in halfword binary format.
`NOSUSPEND`	Has no effect because availability of storage is not affected by events in other parts of the system.
`SET`	Sets the pointer reference to the address of the acquired main storage.
`SHARED`	Prevents the automatic release of storage obtained by a `GETMAIN` command at the end of the task that requested it.

The following option is not supported:

BELOW

`HANDLE ABEND`

HANDLE ABEND PROGRAM(char-8)|LABEL(program-label)| CANCEL|RESET

HANDLE ABEND is fully supported. It specifies the action to take if an abnormal termination occurs.

`CANCEL`	Cancels the previously established exit at the logical level of the application program in control.
`LABEL`	Program label to which control branches is abnormal termination occurs.
`PROGRAM`	Identifies the name of the program to which control is passed, if the task terminates abnormally.
`RESET`	Reactivates an exit cancelled by a `HANDLE ABEND CANCEL` command, or by CICS.

`HANDLE AID`

HANDLE AID option [(program-label)] [option [(program-label)]] ...

HANDLE AID is supported, with the exceptions noted at the end of this section. It specifies the label to which to pass control when an attention identifier (AID) is received from the terminal. Up to 12 options can be specified in a single HANDLE AID command.

`CLEAR`	`ENTER`	`NULL`
`PA1 - PA3`	`PF1 - PF24`

The following options are not supported:

`CLRPARTN`	`LIGHTPEN`	`MRSE`
`OPERID`	`STRF`	`TRIGGER`

`HANDLE CONDITION`

HANDLE CONDITION condition [(program-label)] [condition [(program-label)]] ...

HANDLE CONDITION specifies the points in the program to which control is to be passed when subsequent CICS commands generate exceptional conditions. Up to 16 conditions can be specified in a single HANDLE CONDITION command.

The following options are not supported:

`ALLOCERR`	`CBIDERR`	`DSSTAT`
`ENDINPT`	`ENVDEFERR`	`EODS`
`EOF`	`IGREQCD`	`INBFMH`
`INVERRTERM`	`INVLDC`	`INVPARTN`
`INVPARTNSET`	`INVTSREQ`	`LOADING`
`NONVAL`	`NOPASSBKRD`	`NOPASSBKWR`
`NOSPOOL`	`NOSTART`	`OPENERR`
`PARTNFAIL`	`RDATT`	`RETPAGE`
`ROLLEDBACK`	`RTEFAIL`	`RTESOME`
`SELNERR`	`SESSBUSY`	`SESSIONERR`
`SPOLBUSY`	`SPOLERR`	`STRELERR`
`SUPPRESSED`	`UNEXPIN`	`WRBRK`
`USERIDERR`

`IGNORE CONDITION`

IGNORE CONDITION condition [condition] ...

IGNORE CONDITION specifies exceptional conditions that are to be ignored when they occur in subsequent CICS commands.

The following options are not supported:

`ALLOCERR`	`CBIDERR`	`DSSTAT`
`ENDINPT`	`ENVDEFFERR`	`EOC`
`EODS`	`EOF`	`ERROR`
`EXPIRED`	`IGREQCD`	`IGREQID`
`INBFMH`	`INVERRTERM`	`INVLDC`
`INVPARTN`	`INVPARTNSET`	`INVTSREQ`
`LOADING`	`NONVAL`	`NOPASSBKRD`
`NOPASSBKWR`	`NOSPACE`	`NOSPOOL`
`NOSTART`	`OPENERR`	`PARTNFAIL`
`RDATT`	`RETPAGE`	`ROLLEDBACK`
`RTEFAI`	`RTESOME`	`SELNERR`
`SESSBUSY`	`SESSIONERR`	`SIGNAL`
`SPOLBUSY`	`SPOLERR`	`STRELERR`
`SUPPRESSED`	`SYSBUSY`	`TERMERR`
`UNEXPIN`	`WRBRK`	`USERIDERR`

`INQUIRE CONNECTION`

INQUIRE CONNECTION(char-4) [NETNAME(char-8)] [ACCESSMETHOD](cvda) [PROTOCOL(cvda)] [SERVSTATUS(cvda)] [CONNSTATUS(cvda)] [ACQSTATUS(cvda)]

INQUIRE CONNECTION retrieves information about the named connection (system ID) to a remote system or CICS region.

`ACCESSMETHOD`	Sun MTP supports the following CVDA values: `VTAM IRC INDIRECT XM`
`CONNSTATUS`	Sun MTP supports the following CVDA values: `ACQUIRED RELEASED`
`NETNAME`	An 8-character field that contains the returned remote system name.
`PROTOCOL`	Sun MTP supports the following CVDA values: `NOTAPPLIC APPC LU61`
`SERVSTATUS`	Sun MTP supports the following CVDA values: `INSERVICE OUTSERVICE`
`ACQSTATUS`	Returns the same value as the `CONNSTATUS` option and is retained only for compatibility purposes. Use `CONNSTATUS` in new applications. `CONNSTATUS` and `ACQSTATUS` cannot be used together. Sun MTP supports the following CVDA values: `ACQUIRED` `RELEASED`

The following options are not supported:

`AUTOCONNECT`	`EXITTRACING`	`PENDSTATUS`
`XLNSTATUS`	`ZCPTRACINGS`

`INQUIRE FILE`

INQUIRE FILE (char-8) [ENABLESTATUS(cvda)] [OPENSTATUS(cvda)] [RECORDSIZE(fullword binary data-area)] [REMOTESYSTEM(char-4)] [TYPE(cvda)]

INQUIRE FILE returns information about VSAM files. It supports the following options. It is not supported for alternate index files.

`ENABLESTATUS`	Indicates whether the file is accessible from applications. Sun MTP supports these CVDA values: `ENABLED DISABLED UNENABLED`
`OPENSTATUS`	Indicates whether the file is open or closed. Sun MTP supports these CVDA values: `OPEN CLOSED`
`RECORDSIZE`	Actual size of fixed-length records; maximum size of variable-length records.
`REMOTESYSTEM`	Name of the remote system, if the file is remote.
`TYPE`	Organization of records in the dataset. Sun MTP supports the following values for VSAM files: `ESDS KSDS RRDS`

Because Sun MTP does not support the concept of transitional states for files, it does not support such values as OPENING, CLOSING, or DISABLING.

`INQUIRE PROGRAM`

INQUIRE PROGRAM (8-char-data-value) [EXECUTIONSET(cvda)] [LANGUAGE(cvda)] [PROGTYPE(cvda)] [REMOTENAME(data-area)] [REMOTESYSTEM(data-area)] [RESCOUNT(data-area)] [STATUS(cvda)] [TRANSID(data-area)] [USECOUNT(data-area)]

The INQUIRE PROGRAM command returns information about programs as defined to the system. The following options are supported.

`PROGRAM`	Program name as specified to Sun MTP. If the named program cannot be found, `PGMIDERR` is set and the `RESP2` code is set to 1.
`EXECUTIONSET`	Returns a CVDA value indicating whether the program is restricted to the distributed program link subset of the CICS API. Applies only to executable programs and governs the API only when a program is invoked locally. The CVDA values are: `DPLSUBSET`: The program is always restricted. `FULLAPI`: The program is not restricted unless it is invoked remotely.
`LANGUAGE`	Returns a CVDA value indicating the language in which the module was written. These are the CVDA values that correspond to the Type indicators in the PPT: `ASSEMBLER`: 150 `C`: 149 `COBOL`: 151 `PLI` or `PL1`: 152 `JAVA`: 1080 `NOTAPPLIC`: 1 `NOTAPPLIC` returns a 1 CVDA value, indicating that `LANGUAGE` does not apply because the module is a mapset or remote program.
`PROGTYPE`	Returns a CVDA value indicating a program type: Map: 155 Program: 154
REMOTENAME	Returns the 8-character name by which the program is known in the region named in the `REMOTESYSTEM` option of its `PROGRAM` definition.
REMOTESYSTEM	Returns the 4-character name of the region where the program is defined.
`RESCOUNT`	Returns a full-word binary count of the concurrent separate uses of this module at the time of the inquiry. A `-1` is returned if the module is a remote program.
`STATUS`	Always returns `ENABLED 23`.
TRANSID	Returns the 4-character name of the transaction under which this program executes remotely. This value comes from the `TRANSID` option in the `PROGRAM` definition and applies only to programs defined as remote.
`USECOUNT`	Returns a full-word binary count of the total number of uses of this module since the region startup. A `-1` is returned if the module is a remote program.

`INQUIRE REQID`

INQUIRE REQID (data-area) TERMID (data-area) TRANSID (data-area)

The INQUIRE REQID command returns information about a request. REQID is the 8-character identifier of the request about which the inquiry is made. The following options are supported.

`TERMID`	Returns a 4-character terminal identifier that was specified in the `TERMID` option of the `START` command that created the request.
`TRANSID`	Returns the 4-character transaction identifier that was specified in the `TRANSID` option of the `START` command that created the request.

If the REQID is found, normal error-free conditions are returned in the RESP/RESP2 fields.

If the REQID is not found, RESP is set with the NOTFND condition, and RESP2 is set to 1.

`INQUIRE SYSTEM`

INQUIRE SYSTEM [CICSSTATUS(cvda)] [JOBNAME(data-area)] [APPLID(data-area)]

The INQUIRE SYSTEM command returns information about the running region.

APPLID

Returns the 8-character Application Name from the System Initialization Table (SIT).

CICSSTATUS

Status of the running region. Supported values:

STARTUP: Region is starting up but is not yet fully active.

Value = 180

ACTIVE: Region is fully active.

Value = 181

FIRSTQUIESCE: Region is in the first quiesce state of shutdown. PLTSD stage 1 programs are run during FIRSTQUIESCE.

Value = 182

FINALQUIESCE: Region is in the final quiesce state of shutdown. PLTSD stage 2 programs are run during FINALQUIESCE.

Value = 183

JOBNAME

Returns the 8-character Application Name from the SIT.

`INQUIRE TASK`

INQUIRE TASK (data-value) [FACILITY(data-area)] [FACILITYTYPE(cvda)] [PROCESSID(data-area0] [RUNSTATUS(cvda)] [STARTCODE(data-area)] [TRANSACTION(data-area)] [USERID(data-area)]

The INQUIRE TASK command retrieves information about a specified user task. User tasks are tasks associated with user-defined transactions or with Sun MTP-supplied transactions that are usually invoked by an operator.

`FACILITY`	Returns a 4-character string representing the name of the facility associated with the specified task. If the task was initiated from a terminal the name of the terminal is returned. If the task was initiated by a destination trigger level the name of the associated transient data queue is returned. Otherwise, a null value is returned.
`FACILITYTYPE`	Returns a CVDA value indicating the type of facility that initiated the specified task. Possible values are: `DEST`: The task was initiated by a destination trigger level. `TASK`: The task was initiated by another task. `TERM`: The task was initiated from a terminal.
`PROCESSID`	Returns a 32-bit binary value indicating the process ID of the process (`unikixtran`) running the transaction associated with the task. This is a Sun MTP-specific option.
`RUNSTATUS`	Returns a CVDA value indicating whether the task is running. The only supported value is `RUNNING`.
`STARTCODE`	Returns a 2-character string indicating how the specified task was started. Possible values are: `D`: A Distributed Program Link (DPL) request. The program cannot issue I/O requests against its principal facility, nor can it issue any syncpoint requests. `DS`: A DPL request, as in code `D`, except that the program can issue syncpoint requests. `QD`: Transient data trigger level. `S`: `START` command without data. `SD`: `START` command with data. `TD`: Terminal input. `QB`: Batch request.
`TASK`	Specifies a task number, in 4-byte packed-decimal format.
`TRANSACTION`	Returns a 4-character string representing the name of the transaction (if any) associated with the task. Blanks are returned if there is no associated transaction.
USERID	Returns an 8-character string identifying the user currently associated with the task.

The TASKIDERR condition occurs if the specified task cannot be found.

The following options are not supported:

UOWSTATE TCLASS

`INQUIRE TASK LIST`

INQUIRE TASK LIST LISTSIZE(full-word binary data-area) [RUNNING] [SUSPENDED] [SET(pointer)]

The INQUIRE TASK LIST command returns a list of user tasks as defined to the system. Task states must be specified explicitly.

`LISTSIZE`	Returns a fullword binary field giving the number of tasks in the categories you included in your inquiry. Required parameter.
`RUNNING`	Lists only tasks that are actually running (not suspended). This includes the issuing task.
`SUSPENDED`	Lists only tasks that are currently suspended (tasks waiting for some event or condition). This excludes the issuing task.
`SET`	Address of a list of 4-byte packed-decimal task numbers. Each entry in the list identifies a task in one of the requested categories. If there are no tasks in the requested categories, the `SET` pointer contains a null value.

Note - If neither RUNNING nor SUSPENDED is supplied in the command, all tasks are included in the task list.

The following options are not supported:

DISPATCHABLE SETTRANSID

`INQUIRE TDQUEUE`

INQUIRE TDQUEUE(4-char-data-value) [ATITRANID(4-byte-data-area)] [ENABLESTATUS](cvda) [NUMITEMS(fullword binary data-area)] [OPENSTATUS(cvda)] [TRIGGERLEVEL(fullword binary data-area)] [TYPE(cvda)]

INQUIRE TDQUEUE retrieves information about the named transient data queue.

`ATITRANID`	Name of the transaction to start when the `TRIGGERLEVEL` value is reached.
`ENABLESTATUS`	Indicates whether applications can access the queue. CVDA values are: `ENABLED DISABLED` Applications cannot access a `DISABLED` queue; the queue can still be `OPEN`.
`NUMITEMS`	Intrapartition queues only. Returns the logical number of records in the queue. The null value, `-1`, is returned if the specified queue is not intrapartition.
`OPENSTATUS`	Extrapartition queues only. Indicates whether the queue is open, closed, or in an intermediate state. The only CVDA values supported are: `OPEN CLOSED`
`TRIGGERLEVEL`	Intrapartition queues only. Number of requests that must be present for output to a queue before automatic transaction initiation (ATI) can occur. The null value, `-1`, is returned if the specified queue is not intrapartition.
`TYPE`	Indicates whether the queue is intrapartition (`INTRA`), extrapartition (`EXTRA`), remote (`REMOTE`), or indirect (`INDIRECT`).

The following options are not supported:

`ATIFACILITY`	`ATITERMID`	`BLOCKFORMAT`
`EMPTYSTATUS`	`INDIRECTNAME`	`IOTYPE`
`PRINTCONTROL`	`RECORDFORMAT`	`RECORDLENGTH`
`RECOVSTATUS`	`REMOTENAME`	`REMOTESYSTEM`

`INQUIRE TERMINAL`

INQUIRE TERMINAL(char-4) [ACQSTATUS(cvda)] [DEVICE(cvda)] [NEXTTRANSID(data-area)] [SERVSTATUS(cvda)] [TERMSTATUS(cvda)] [TRANSACTION(char-4)] [USERID(data-area)] [USERNAME(data-area)]

The INQUIRE TERMINAL command returns information about the named terminal. The terminal name is the same as the installed terminal definition and includes printers as well as terminals. If the named terminal cannot be found, TERMIDERR is set and RESP2 code is set to 1.

`ACQSTATUS`	Returns the same value as the `TERMSTATUS` option and is retained only for compatibility purposes. Use `TERMSTATUS` in new applications.
`DEVICE`	Returns the terminal type that is stored in the TCT.
`NEXTTRANSID`	Returns a 4-character identifier of the next transaction to run on behalf of this terminal. If nothing is specified, blanks are returned.
`SERVSTATUS`	Returns a CVDA value indicating whether the terminal is available for use (from the point of view of the local CICS system, which can be different from the system that owns the terminal). `SERVSTATUS` corresponds to the `INSERVICE` option in the terminal definition. For a VTAM terminal, "available" (`INSERVICE`) does not necessarily imply that the terminal is acquired.
`TERMSTATUS`	Returns a CVDA value indicating whether CICS is in session with the logical unit represented by this terminal. `cvda` values are: `ACQUIRED CICS`: In session with the logical unit. `RELEASED CICS`: Not in session with the logical unit.
`TRANSACTION`	Returns the name of the transaction running on the named terminal. If no transaction is running, the 4-character data field passed as an argument to `TRANSACTION` is returned filled with blanks.
`USERID`	Returns an 8-character identifier of the user signed on at this terminal.
`USERNAME`	Returns a 20-character identifier of the operator name that corresponds to the `USERID`.

The following options are not supported:

`ACCESSMETHOD`	`ALTPAGEHT`	`ALTPAGEWD`
`ALTPRINTER`	`ALTPRTCOPYST`	`ALTSCRNHT`
`ALTSCRNW`	`ALTSUFFIX`	`APLKYBDST`
`APLTEXTST`	`ATISTATUS`	`AUDALARMST`
`BACKTRANSST`	`COLORST`	`COPYST`
`CREATESESS`	`DEFPAGEHT`	`DEFPAGEWD`
`DEFSCRNHT`	`DEFSCRNWD`	`DISREQST`
`DUALCASEST`	`EXITTRACING`	`EXTENDEDDSST`
`FMHPARMST`	`FORMFEEDST`	`GCHARS`
`GCODES`	`HFORMST`	`HILIGHTST`
`KATAKANAST`	`LIGHTPENST`	`MODENAME`
`MSRCONTROLST`	`NATLANG`	`NATURE`
`OBFORMATST`	`OBOPERIDST`	`OPERID`
`OUTLINEST`	`PAGEHT`	`PAGESTATUS`
`PAGEWD`	`PARTITIONSST`	`PRINTADAPTST`
`PRINTER`	`PROGSYMBOLST`	`PRTCOPYST`
`QUERYST`	`RELREQST`	`REMOTENAME`
`REMOTESYSTEM`	`SCRNHT`	`SCRNWD`
`SCREENHEIGHT`	`SCREENDWIDTH`	`SECURITY`
`SESSIONTYPE`	`SIGNONSTATUS`	`SOSIST`
`TASKID`	`TCAMCONTROL`	`TERMMODEL`
`TERMPRIORITY`	`TEXTKYBDST`	`TEXTPRINTST`
`TRACING`	`TTISTATUS`	`UCTRANST`
`USERAREA`	`USERAREALEN`	`VALIDATIONST`
`VFORMST`	`ZCPTRACING`

`INQUIRE TRANCLASS`

INQUIRE TRANCLASS(8-char data-value) [MAXACTIVE(data-area)|ACTIVE(data-area)] QUEUED(data-area)

The INQUIRE TRANCLASS command returns information about the named transaction class.

`ACTIVE`	Number of transaction processors running for the specified transaction class.
`MAXACTIVE`	Maximum number of transaction processors assigned to the specified class.
`QUEUED`	Number of transactions queued for the transaction class.

The following option is not supported:

PURGETHRESH

If an invalid class name is provided, the TCIDERR condition is returned.

`INQUIRE TRANSACTION`

INQUIRE TRANSACTION(4-char data-value) [DUMPING(cvda)] [PROGRAM(8-char data-area)] [REMOTENAME(8-char data-area)] [REMOTESYSTEM(4-char data-area)] [SCRNSIZE(cvda)] [STATUS(cvda)] [TRANCLASS(8-char data-area)] [TWASIZE(data-area)]

The INQUIRE TRANSACTION command is supported with the exceptions noted. It returns information about the named transaction.

`PROGRAM`	Name of the first program to execute when this transaction is started.
`DUMPING`	Returns a CVDA value indicating whether to take a transaction dump if a task executing this transaction terminates abnormally. The CVDA values are: `NOTRANDUMP`: No dump should be taken. `TRANDUMP`: A dump should be taken.
`REMOTENAME`	Name by which this transaction is known in the remote system, if applicable.
`REMOTESYSTEM`	Name of the remote system on which the transaction is defined, if applicable.
`SCRNSIZE`	Returns a CVDA value indicating whether a task executing this transaction should use an alternate screen size or the default. The CVDA values are: `ALTERNATE`: Use the alternate screen size. `DEFAULT`: Use the default screen size.
`STATUS`	Returns a CVDA value indicating whether the transaction is available for use. The CVDA values are: `DISABLED`: The transaction cannot be executed. `ENABLED`: The transaction is available.
`TRANCLASS`	Name of the transaction class to which the transaction belongs.
`TWASIZE`	Returns a full-word binary field giving the size in bytes of the transaction work area (TWA) for this transaction.

The following options are not supported:

`CMDSEC`	`DTB`	`DTIMEOUT`
`PRIORITY`	`PROFILE`	`PURGEABILITY`
`ROUTING`	`RESSEC`	`RTIMEOUT`
`TASKDATAKEY`	`TASKDATALOC`	`TRACING`
`TRPROF`

`ISSUE ABEND`

ISSUE ABEND [CONVID(char-4)] [STATE(cvda)]

ISSUE ABEND is fully supported. It is used to abend a DTP conversation.

`CONVID`	Conversation to abend.
`STATE`	Gets the state of the current conversation.

`ISSUE CONFIRMATION`

ISSUE CONFIRMATION [CONVID(char-4)] [STATE(cvda)]

ISSUE CONFIRMATION is fully supported. It is used to send a positive response to a SEND CONFIRM request on a DTP conversation.

`CONVID`	Conversation to which to send the response.
`STATE`	Gets the state of the current conversation.

`ISSUE DISCONNECT`

ISSUE DISCONNECT

Terminates a session between a region and a logical unit or terminal.

The following option is not supported:

SESSION

`ISSUE ERASEAUP`

ISSUE ERASEAUP

ISSUE ERASEAUP erases all unprotected fields in the 3270 buffer. It is supported for 3278/3279-type terminals. It is not supported for other types of terminals.

The following option is not supported:

WAIT

`ISSUE ERROR`

ISSUE ERROR [CONVID(char-4)] [STATE(cvda)]

ISSUE ERROR is fully supported. It is used to inform a partner on a DTP conversation of an error.

`CONVID`	Conversation to which the command relates.
`STATE`	Gets the state of the current conversation.

`ISSUE PRINT`

ISSUE PRINT

ISSUE PRINT enables the transaction to print the screen on the system printer or a 3270 printer. ISSUE PRINT is fully supported.

`ISSUE SIGNAL`

ISSUE SIGNAL [CONVID(char-4)] [STATE(cvda)]

ISSUE SIGNAL is used to request a change of direction from the partner transaction on a DTP conversation.

`CONVID`	Conversation to which the command relates.
`STATE`	Gets the state of the current conversation.

The following option is not supported:

SESSION

`JOURNAL`

JOURNAL JFILEID(halfword) JTYPEID(char-2) FROM(data-area) [LENGTH(halfword)] [REQID(fullword)] [PREFIX(data-value) [PFXLENG(halfword)]] [NOSUSPEND]

JOURNAL writes records to external, non-VSAM files defined in the JCT. All JOURNAL commands in Sun MTP are written synchronously. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the JCT.

The following options are not supported:

STARTIO WAIT

`LINK`

LINK PROGRAM(char-8) [COMMAREA(data-area) [LENGTH(halfword)] [DATALENGTH(halfword)]] [SYSID(char-4)][SYNCONRETURN] [TRANSID(char-4)]

LINK temporarily passes control from one application program to another.

`COMMAREA`	Data area that is passed to the invoked program as a communication area. The invoked program accesses the communication area in the same storage locations as the invoking program; the communication area is not copied to another area of storage.
`DATALENGTH`	Contiguous space that begins at the start of the `COMMAREA` where data is passed to the linked program.
`LENGTH`	Binary halfword or literal value that indicates the length of the data area specified in the `COMMAREA` option. This option is required if you code `COMMAREA`.
`PROGRAM`	If `SYSID` is not coded, it must match an entry in the PPT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the PPT.
`SYNCONRETURN`	If `SYSID` is coded, specifies that the remote system is to take a syncpoint on successful completion of the server program. If omitted, the default synchronization level is the same as that of the link.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about DPL. `SYSID` and `INPUTMSG` are mutually exclusive.
`TRANSID`	Name of the transaction that the remote system is to attach and run the server program under. If not specified, the remote system attaches the `CSMI` or `CVMI` by default.

The following options are not supported:

INPUTMSG INPUTMSGLEN

`LOAD`

LOAD PROGRAM(char-8) [SET(pointer-ref)] [LENGTH(halfword-data-area)| FLENGTH(fullword-data-area)] [ENTRY(pointer-ref)] [HOLD]

LOAD loads a program, table, or map into shared storage. The address returned by the command is guaranteed to be the same for all transactions referencing the program, table, or map. The program, table, or map must not have an extension and must be located in one of the directories specified in the KIXPROGS environment variable.

`FLENGTH`	Length of the loaded program, table, or map. Use if the length of the loaded program is greater than 32 KB.
`HOLD`	Do not delete the loaded program, table, or map (if still resident) when the task issuing the `LOAD` command is terminated.
`LENGTH`	Length of the loaded program, table, or map.
`SET`	Pointer reference to set to the address at which a program, table, or map is loaded.

LOAD supports the following options as noted:

`ENTRY`	Only supported for PL/I programs, as described in Using LOAD PROGRAM ENTRY With Shared Libraries.
`PROGRAM`	Must match an entry in the PPT with a type of A or L. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the PPT.

`POP HANDLE`

POP HANDLE

POP HANDLE is fully supported. This command restores any of the following HANDLE commands that were suspended with PUSH HANDLE.

`HANDLE ABEND`	`HANDLE AID`	`HANDLE CONDITION`
`IGNORE`	`IGNORE CONDITION`

`POST`

POST [INTERVAL(packed-7)|TIME(packed-7)| AFTER{[HOURS(hh)][MINUTES(mm)] [SECONDS(ss)]}|AT{[HOURS(hh)] [MINUTES(mm)][SECONDS(ss)]}] SET(pointer-ref) [REQID(char-8)]

POST is fully supported. It requests that a timer event control area be posted after the specified interval has expired.

`AFTER`	Amount of time to expire.
`AT`	Time of expiring.
`HOURS(hh)`	Fullword binary value in the range 0-99.
`INTERVAL`	Expiration time as an interval of time that is to elapse from the time at which the `POST` command is issued.
`MINUTES(mins)`	Fullword binary value in the range 0-59 or 0-5999.
`REQID`	Unique name to identify a command; used as a temporary storage identifier.
`SECONDS(secs)`	Fullword binary value in the range 0-59 or 0-359,999.
`SET`	Sets a pointer reference to the address of the timer event control area generated by CICS.
`TIME`	Expiration time.

An INVREQ condition can occur if the POST command is not valid for processing by CICS. On failure, the value of EIBRESP2 indicates the reason for the failure.

Condition	RESP2	Reason
`INVREQ`	4	Hours are out of range.
	5	Minutes are out of range.
	6	Seconds are out of range.

The default action is to terminate the task abnormally.

`PURGE MESSAGE`

PURGE MESSAGE

PURGE MESSAGE terminates the building of a logical message. The areas allocated for the part of the logical message built thus far are deleted.

`PUSH HANDLE`

PUSH HANDLE

PUSH HANDLE is fully supported. This command suspends HANDLE commands. The commands can be restored by using the POP HANDLE command.

The following commands can be suspended:

`HANDLE ABEND`	`HANDLE AID`	`HANDLE CONDITION`
`IGNORE`	`IGNORE CONDITION`

`READ`

READ DATASET(dataset)|FILE(dataset) SET(pointer-ref)|INTO(data-area) [LENGTH(halfword-data-area)] RIDFLD(data-area) [KEYLENGTH(halfword) [GENERIC]] [SYSID(char-4)] [RBA|RRN] [GTEQ|EQUAL] [UPDATE]

READ is supported with the exceptions noted at the end of this section. For VSAM datasets, it reads a record from a dataset. ISAM and DAM datasets are not supported.

`DATASET`	If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the FCT.
`EQUAL`	Search is satisfied only by a record having the same key as that specified in the `RIDFLD` option.
`FILE`	Name of the file to access. This is the dataset name in the FCT.
`GENERIC`	Search key is a generic key whose length is specified in the `KEYLENGTH` option.
`GTEQ`	If the search for a record having the same key as that specified in the `RIDFLD` option is unsuccessful, the first record having a greater key is retrieved.
`INTO`	Data area into which the record retrieved from the dataset is to be written.
`KEYLENGTH`	Length of the key that was specified in the `RIDFLD` option.
`LENGTH`	Length of the data area where the record is to be put. When the `READ` command is complete, `LENGTH` contains the actual record length.
`RBA`	Record identification field specified in the `RIDFLD` option contains a relative byte address.
`RIDFLD`	Record identification field.
`RRN`	Record identification field specified in the `RIDFLD` option contains a relative record number.
`SET`	CICS is to supply a buffer where the record is read, and specifies the pointer reference that is to contain the address of the retrieved record.
`SYSID`	If specified, it must match an entry on the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.
`UPDATE`	Obtains the record for updating or deletion. If omitted, a read-only operation is assumed.

The following options are not supported:

`DEBKEY`	`DEBREC`	`SEGSET`
`SEGSETALL`

`READNEXT`

READNEXT DATASET(dataset)|FILE(dataset) SET(pointer-ref)|INTO(data-area) [LENGTH(halfword-data-area)] RIDFLD(data-area) [KEYLENGTH(halfword)] [REQID(halfword)] [SYSID(char-4)] [RBA|RRN]

READNEXT is fully supported for VSAM datasets. It reads records in sequential order from a dataset. ISAM and DAM datasets are not supported.

`DATASET`	If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the FCT.
`FILE`	Name of the file to access. This is the dataset name in the FCT.
`INTO`	Data area into which the record retrieved from the dataset is to be written.
`KEYLENGTH`	Length of the key that was specified in the `RIDFLD` option.
`LENGTH`	Length of the data area where the record is to be put. When the `READNEXT` command is complete, `LENGTH` contains the actual record length.
`RBA`	Record identification field specified in the `RIDFLD` option contains a relative byte address.
`REQID`	Unique request identifier for a browse; used to control multiple browse operations on a dataset.
`RIDFLD`	Record identification field.
`RRN`	Record identification field specified in the `RIDFLD` option contains a relative record number.
`SET`	CICS is to supply a buffer where the record is read, and specifies the pointer reference that is to contain the address of the retrieved record.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

The following options are not supported:

SEGSET SEGSETALL

`READPREV`

READPREV DATASET(dataset)|FILE(dataset) SET(pointer-ref)|INTO(data-area) [LENGTH(halfword-data-area)] RIDFLD(data-area) [KEYLENGTH(halfword)] [REQID(halfword)] [SYSID(char-4)] [RBA|RRN]

READPREV is fully supported for VSAM datasets. It reads records in reverse sequential order from a dataset. ISAM and DAM datasets are not supported.

`DATASET`	If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the FCT.
`FILE`	Name of the file to access. This is the dataset name in the FCT.
`INTO`	Data area into which the record retrieved from the dataset is to be written.
`KEYLENGTH`	Length of the key that was specified in the `RIDFLD` option.
`LENGTH`	Length of the data area where the record is to be put. When the `READPREV` command is complete, `LENGTH` contains the actual record length.
`RBA`	Record identification field specified in the `RIDFLD` option contains a relative byte address.
`REQID`	Unique request identifier for a browse; used to control multiple browse operations on a dataset.
`RIDFLD`	Record identification field.
`RRN`	Record identification field specified in the `RIDFLD` option contains a relative record number.
`SET`	CICS is to supply a buffer where the record is read, and specifies the pointer reference that is to contain the address of the retrieved record.
`SYSID`	If specified, it must match an entry on the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

The following options are not supported:

SEGSET SEGSETALL

`READQ TD`

READQ TD QUEUE(char-4) SET(pointer-ref)|INTO(data-area) [LENGTH(halfword-data-area)] [SYSID(char-4)] [NOSUSPEND]

READQ TD is fully supported. It reads data from the transient data queue specified in the QUEUE option.

`INTO`	User data area into which the data read from the queue is to be placed.
`LENGTH`	If you specify the `INTO` option, `LENGTH` must be a data area that specifies the maximum length of data that the program accepts.
`NOSUSPEND`	Has no effect on the local system, but is passed on a function shipping request.
`QUEUE`	If `SYSID` is not coded, it must match an entry in the DCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the DCT.
`SET`	Sets a pointer reference to the address of the data read from the queue.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`READQ TS`

READQ TS QUEUE(char-8) SET(pointer-ref)|INTO(data-area) [LENGTH(halfword-data-area)] [NUMITEMS(halfword-data-area)] [ITEM(halfword)|NEXT] [SYSID(char-4)]

READQ TS is fully supported. It retrieves data from the temporary storage queue specified in the QUEUE option.

`INTO`	User data area into which the data read from the queue is to be placed.
`ITEM`	Item number of the logical record to be retrieved from the queue.
`LENGTH`	If you specify the `INTO` option, `LENGTH` must be a data area that specifies the maximum length of data that the program accepts.
`NEXT`	Retrieves the next sequential logical record.
`NUMITEMS`	Field into which a number indicating how many items there are in the queue is stored.
`QUEUE`	If `SYSID` is not coded and the queue is either recoverable or remote, it must match an entry in the TST. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TST.
`SET`	Sets a pointer reference to the address of the data read from the queue.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`RECEIVE` (APPC)

RECEIVE INTO(data-area) | SET(pointer-ref) LENGTH(halfword-data-area) | FLENGTH(fullword-data-area) [MAXLENGTH [(halfword)] | MAXFLENGTH [(fullword)]] [NOTRUNCATE] [CONVID(char-4)] [STATE(cvda)]

RECEIVE reads data from a terminal or DTP conversation. It is fully supported from 3278/3279-type terminals. Other types of terminals are not supported.

`CONVID`	Identifies the conversation to which the command relates.
`INTO`	Application target data area into which to receive data from the application program connected to the other end of the current conversation. The length of the `INTO` data area must be greater than or equal to the maximum specified in the `LENGTH`, `FLENGTH`, `MAXLENGTH`, and `MAXFLENGTH` options.
`FLENGTH`	Fullword alternative to `LENGTH`.
`LENGTH`	Length of the data received. If you specify the `INTO` option, but omit the `MAXLENGTH` option, the argument must be a data area that specifies the maximum length that the program accepts. If the value specified is less than zero, zero is assumed. If you specify the `SET` option, the argument must be a data area. When the data is received, the data area is set to the length of the data.
`MAXFLENGTH`	Fullword alternative to `MAXLENGTH`.
`MAXLENGTH`	Maximum amount of data to be returned in response to a `RECEIVE` command. If `INTO` is specified, `MAXLENGTH` overrides the use of `LENGTH` as an input. If `SET` is specified, `MAXLENGTH` provides a way for the program to limit the amount of data it receives at one time. If the length of data exceeds the value specified and the `NOTRUNCATE` option is not present, the data is truncated to that value and the `LENGERR` condition occurs. The data area specified in the `LENGTH` option is set to the original length of data. If the length of the data exceeds the value specified and the `NOTRUNCATE` option is present, the remaining data is retained and used to satisfy subsequent `RECEIVE` commands. If this option is omitted, the value indicated for the `LENGTH` option is assumed.
`NOTRUNCATE`	When the data available exceeds the length requested, retain the remaining data for retrieval by subsequent `RECEIVE` commands, instead of discarding it.
`SET`	Sets a pointer reference to the address of the data received from the partner transaction.
`STATE`	Gets the value of the current conversation.

`RECEIVE` (LUTYPE2/LUTYPE3)

RECEIVE INTO(data-area) | SET(pointer-ref) LENGTH(halfword-data-area) | FLENGTH(fullword-data-area) [MAXLENGTH [(halfword)] | MAXFLENGTH [(fullword)]] [NOTRUNCATE] [ASIS] [BUFFER]

RECEIVE reads data from a terminal or DTP conversation. It is fully supported from 3278/3279-type terminals. Other types of terminals are not supported.

`ASIS`	Lowercase characters in the 3270 input data stream are not translated to uppercase. This enables the current task to receive a message containing both uppercase and lowercase data.
`BUFFER`	Reads the contents of the 3270 buffer, beginning at buffer location 1 and continuing until all contents of the buffer are read. All character and attribute sequences (including nulls) occur in the input data stream in the same order as they occur in the 3270 buffer.
`INTO`	Receiving field for the data read from the logical unit.
`FLENGTH`	Fullword alternative to `LENGTH`.
`LENGTH`	Length of the data transmitted. If you specify the `INTO` option, but omit the `MAXLENGTH` option, the argument must be a data area that specifies the maximum length that the program accepts. If the value specified is less than zero, zero is assumed. If the length of data exceeds the value specified and the `NOTRUNCATE` option is not present, the data is truncated to that value and the `LENGERR` condition occurs. When the data is received, the data area is set to the original length of the data. If you specify the `SET` option, the argument must be a data area. When the data is received, the data area is set to the length of the data.
`MAXFLENGTH`	Fullword alternative to `MAXLENGTH`.
`MAXLENGTH`	Maximum amount of data to recover. If `INTO` is specified, `MAXLENGTH` overrides the use of `LENGTH` as an input. If `SET` is specified, `MAXLENGTH` provides a way for the program to limit the amount of data it receives at one time. If the length of data exceeds the value specified and the `NOTRUNCATE` option is not present, the data is truncated to that value and the `LENGERR` condition occurs. The data area specified in the `LENGTH` option is set to the original length of data. If the length of the data exceeds the value specified and the `NOTRUNCATE` option is present, the remaining data is retained and used to satisfy subsequent `RECEIVE` commands. The data area specified in the `LENGTH` option is set to the length of the data returned. If this option is omitted, the value indicated for the `LENGTH` option is assumed.
`NOTRUNCATE`	When the data available exceeds the length requested, retain the remaining data for retrieval by subsequent `RECEIVE` commands, instead of discarding it.
`SET`	Sets a pointer reference to the address of the data read from the terminal or logical unit.

`RECEIVE MAP`

RECEIVE MAP (char-7) [MAPSET(char-7)] [SET(pointer) | INTO(data-area)] [FROM(data-area) LENGTH(halfword) | TERMINAL [ASIS]]

RECEIVE MAP maps data from the terminal into a data area. It is supported for 3278/3279-type terminals. Other types of terminals are not supported.

`ASIS`	Lowercase characters in the 3270 input data stream are not translated to uppercase.
`FROM`	Data area containing the mapped data.
`INTO`	Data area into which to write the mapped data.
`LENGTH`	Length of the data to be formatted as a halfword binary value.
`MAPSET`	Name of the mapset without its suffix.
`SET`	Sets the pointer to the address of the 12-byte prefix to the mapped data.
`TERMINAL`	Read the input data from the terminal that originated the transaction.

The following option is not supported:

INPARTN

`RELEASE`

RELEASE PROGRAM(char-8)

RELEASE is fully supported. It deletes a previously loaded program, table, or map from main storage.

PROGRAM

Identifies a program name; must match an entry in the PPT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the PPT.

`RESETBR`

RESETBR DATASET(dataset) | FILE(dataset) RIDFLD(data-area) [KEYLENGTH(halfword) [GENERIC]] [REQID(halfword)] [SYSID(char-4)] [GTEQ | EQUAL] [RBA | RRN]

RESETBR is fully supported for VSAM datasets. It specifies the record in a dataset at which to restart a browse operation. ISAM and DAM datasets are not supported.

`DATASET`	If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the FCT.
`EQUAL`	Search is satisfied only by a record having the same key as that specified in the `RIDFLD` option.
`FILE`	Name of the dataset to access.
`GENERIC`	Search key is a generic key whose length is specified in the `KEYLENGTH` option.
`GTEQ`	If the search for a record having the same key as that specified in the `RIDFLD` option is unsuccessful, the first record having a greater key is retrieved.
`KEYLENGTH`	Length of the key that was specified in the `RIDFLD` option.
`RBA`	Record identification field specified in the `RIDFLD` option contains a relative byte address.
`REQID`	Unique request identifier for a browse; used to control multiple browse operations on a dataset.
`RIDFLD`	Record identification field.
`RRN`	Record identification field specified in the `RIDFLD` option contains a relative record number.
`SYSID`	If specified, it must match an entry on the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for more information.

`RETRIEVE`

RETRIEVE [INTO(data-area) | SET(pointer-ref)] [LENGTH(halfword)] [RTRANSID(char-4)] [RTERMID(char-4)] [QUEUE(char-48)]

RETRIEVE is used by a task started by a prior START command. It retrieves data stored by the START command.

`INTO`	User data area into which retrieved data is to be written.
`LENGTH`	Length of the data retrieved.
`QUEUE`	The 8-character name of the queue that can be accessed by the transaction issuing the `RETRIEVE` command.
`RTRANSID`	A 4-character area used in the `TRANSID` option of a `START` command that can be executed subsequently.
`RTERMID`	A 4-character area used in the `TERMID` option of a `START` command that can be executed subsequently.
`SET`	Sets the pointer reference to the address of the retrieved data.

The following option is not supported:

WAIT

`RETURN`

RETURN [TRANSID(char-4) [COMMAREA(data-area) [LENGTH(halfword)]] [IMMEDIATE]]

RETURN returns control from an application program to the program that called it or to the system.

`COMMAREA`	Communication area that is to be made available to the next program that receives control.
`IMMEDIATE`	Ensures that the transaction specified in the `TRANSID` option is attached as the next transaction.
`LENGTH`	Length in bytes of the `COMMAREA`.
`TRANSID`	If specified, it must match an entry in the PCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for more information.

The following options are not supported:

INPUTMSG INPUTMSGLEN

`REWRITE`

REWRITE DATASET(dataset) | FILE(dataset) FROM(data-area) [LENGTH(halfword)] [SYSID(char-4)]

REWRITE is fully supported for VSAM datasets. It updates a record in a dataset. ISAM and DAM datasets are not supported.

`DATASET`	If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for more information.
`FILE`	Name of the dataset to be accessed.
`FROM`	Record to write to the dataset referred to by this file.
`LENGTH`	Actual length of the record to write.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`SEND` (APPC mapped)

SEND [FROM(data-area) {LENGTH(halfword) | FLENGTH(fullword)}] [CONVID(char-4)] [INVITE | LAST] [CONFIRM | WAIT] [STATE(cvda)]

SEND writes data to a terminal or a DTP conversation. It is supported for 3278/3279-type terminals and for the system printer. Other types of terminals are not supported.

`CONFIRM`	Indicates that an application using a synchronization level 1 or 2 conversation requires a response from the remote application.
`CONVID`	Identifies the conversation to which the command relates.
`FLENGTH`	Fullword alternative to `LENGTH`.
`FROM`	Data to send to a partner transaction. This option can be omitted if `INVITE`, `WAIT`, `CONFIRM` or `LAST` is used.
`INVITE`	Enables an application program to add control data to data already sent to a process in a connected APPC system. Control data is not transmitted until the subsequent execution of a `WAIT` or a `SYNCPOINT` command unless `CONFIRM` or `WAIT` is also specified.
`LAST`	Last `SEND` command for a transaction.
`LENGTH`	Length of the data to send.
`STATE`	Gets the state of the current conversation.
`WAIT`	Ensures that all data and indicators so far sent on a conversation are flushed to the partner transaction. If `WAIT` is not specified, control is returned to the application program when processing of the command has started.

`SEND` (LUTYPE2/LUTYPE3)

SEND FROM(data-area) {LENGTH(halfword) | FLENGTH(fullword)} [STRFIELD | [ERASE] [CTLCHAR(char-1)]] [INVITE | LAST] [WAIT]

SEND writes data to a terminal or a DTP conversation. It is supported for 3278/3279-type terminals and for the system printer. Other types of terminals are not supported.

`CTLCHAR`	A 1-byte write control character that controls a `SEND` command for a 3270. A COBOL user must specify a data area containing this character. If the option is omitted, all modified data tags are reset to zero and the keyboard is restored.
`ERASE`	Erases the buffer or the screen and returns the cursor to the upper left corner of the screen before writing occurs.
`FLENGTH`	Fullword alternative to `LENGTH`.
`FROM`	Data to be written to the logical unit.
`INVITE`	Next terminal control command to be executed for this facility is a `RECEIVE`.
`LAST`	Last output operation for a transaction and therefore the end of a bracket.
`LENGTH`	Length of the data to write.
`STRFIELD`	Data area specified in the `FROM` option contains structured fields.
`WAIT`	Complete the processing of the command before attempting any subsequent processing. If not specified, control is returned to the application program when processing of the command has started.

The following option is not supported:

DEFRESP

`SEND CONTROL`

SEND CONTROL [CURSOR(halfword)] [ERASE | ERASEAUP] [PRINT] [FREEKB] [ALARM] [FRSET] [ACCUM] [SET(pointer) | PAGING | TERMINAL] [REQID(char-2)] [L80 | HONEOM]

SEND CONTROL sends device controls to a terminal. It is supported for 3278/3279-type terminals. Other types of terminals are not supported.

`ACCUM`	One of several commands that are used to build a logical message.
`ALARM`	Activates the 3270 audible alarm.
`CURSOR`	Location to which the cursor is to be returned on completion of a `SEND CONTROL` command.
`ERASE`	Erase the screen printer buffer or partition and return the cursor to the upper left corner of the screen.
`ERASEAUP`	Erase all unprotected character locations in the partition or the entire screen.
`FREEKB`	Unlocks the 3270 keyboard.
`FRSET`	Resets the modified data tags of all fields currently in the 3270 buffer to the unmodified condition.
`HONEOM`	Use the default printer line length.
`L80`	Specifies an 80-character line length for a 3270 printer.
`PAGING`	Specifies that the output data is not to be sent immediately to the terminal, but is to be placed in temporary storage and displayed in response to paging commands entered by the terminal user.
`PRINT`	Starts a print operation.
`REQID`	Use a 2-character prefix as part of a temporary storage identifier for message recovery.
`SET`	Sets the pointer to the address of the output data.
`TERMINAL`	Send the output data to the terminal that originated the transaction.

The following options are not supported:

`ACTPARTN`	`FORMFEED`	`LAST`
`LDC`	`L40` and `L64`	`MSR`
`OUTPARTN`	`WAIT`

`SEND MAP`

SEND MAP maps output to the terminal or to a program-defined data area. It is supported for 3278/3279-type terminals and for the system printer identified by the PRINTER environment variable, with the exceptions noted. Other types of terminals are not supported.

`ACCUM`	One of several commands that are used to build a logical message.
`ALARM`	Activates the 3270 audible alarm.
`CURSOR`	Location to which the cursor is to be returned on completion of a `SEND MAP` command.
`DATAONLY`	Writes only application program data.
`ERASE`	Erase the screen printer buffer or partition and return the cursor to the upper left corner of the screen.
`ERASEAUP`	Erase all unprotected character locations in the partition or the entire screen.
`FREEKB`	Unlocks the 3270 keyboard.
`FROM`	Data area containing the data to process.
`FRSET`	Resets the modified data tags of all fields currently in the 3270 buffer to the unmodified condition.
`HONEOM`	Use the default printer line length.
`L80`	Specifies an 80-character line length for a 3270 printer.
`LENGTH`	Length of the data to format.
`MAPONLY`	Writes only default data from the map.
`MAPSET`	The name of the mapset without its suffix.
`PAGING`	Specifies that the output data is not to be sent immediately to the terminal, but is to be placed in temporary storage and displayed in response to paging commands entered by the terminal user.
`PRINT`	Starts a print operation.
`SET`	Sets the pointer to the address of the output data.
`TERMINAL`	Sends the output data to the terminal that originated the transaction.

The following options are not supported:

`ACTPARTN`	`FMHPARM`	`FORMFEED`
`LAST`	`LDC`	`L40` and `L64`
`MSR`	`NLEOM`	`NOFLUSH`
`OUTPARTN`	`REQID`	`WAIT`

`SEND PAGE`

SEND PAGE [SET(pointer-ref)] [RELEASE [TRANSID(char-4)] | RETAIN] [TRAILER(data-area)]

SEND PAGE completes and transmits a formatted message being built through the use of a SEND MAP or SEND TEXT command with the ACCUM option specified. It is supported for 3278/3279-type terminals. Other types of terminals are not supported.

`RELEASE`	After the `SEND PAGE` command, control is to return to the program at the next higher logical level after the pages are written to the terminal.
`RETAIN`	After the `SEND PAGE` command, control is to return to the application program after the pages are written to the terminal.
`SET`	Sets the pointer to the address of the output data.
`TRAILER`	Text data area that contains trailer data to be placed at the bottom of the last page only.
`TRANSID`	Transaction identifier to use with the next input message from the terminal to which the task is attached.

The following options are not supported:

`AUTOPAGE`	`CURRENT,ALL`	`FMHPARM`
`LAST`	`NOAUTOPAGE`	`OPERPURGE`

`SEND TEXT`

SEND TEXT FROM(data-area) LENGTH(halfword) [REQID(char-2)] [CURSOR(halfword)] [SET(pointer) | PAGING] [HEADER(data-area)] [TRAILER(data-area)] [JUSTIFY(halfword)] [ACCUM] [ERASE] [PRINT] [FREEKB] [ALARM] [L80 | HONEOM]

SEND TEXT formats output without a controlling map. It is supported for 3278/3279-type terminals. Other types of terminals are not supported.

`ACCUM`	One of several commands used to build a logical message.
`ALARM`	Activates the 3270 audible alarm.
`CURSOR`	Location to which the 3270 cursor is to be returned on completion of a `SEND TEXT` command.
`ERASE`	Erases the screen printer buffer or partition and returns the cursor to the upper left corner of the screen before this page of output is displayed.
`FREEKB`	Unlocks the 3270 keyboard after the data is written.
`FROM`	Data area containing the data to send.
`HEADER`	Places header data at the beginning of each page of text data.
`HONEOM`	Use the default printer line length.
`JUSTIFY`	Specifies the line of the page at which the text data is to be positioned.
`L80`	Specifies an 80-character line length for a 3270 printer.
`LENGTH`	Length of the data to be sent.
`PAGING`	Specifies that the output data is not to be sent immediately to the terminal, but is to be placed in temporary storage and displayed in response to paging commands entered by the terminal user.
`PRINT`	Starts a print operation at a 3270 printer. If omitted, the data is sent to the printer buffer but is not printed.
`REQID`	A 2-character prefix used as part of a temporary storage identifier for message recovery.
`SET`	Sets the pointer to the address of the data.
`TRAILER`	Places text data area that contains trailer data at the bottom of each output page.

The following options are not supported:

`ACTPARTN`	`FORMFEED`	`JUSFIRST`
`JUSLAST`	`LAST`	`LDC`
`L40` and `L64`	`MSR`	`NLEOM`
`OUTPARTN`	`TERMINAL LAST`	`TERMINAL WAIT`

`SEND TEXT MAPPED`

SEND TEXT MAPPED FROM(data-area) LENGTH(halfword) [TERMINAL]

SEND TEXT MAPPED outputs data previously generated by BMS and returned to the program using the SET option of a SEND or SEND TEXT command. It is supported for 3278/3279-type terminals. Other types of terminals are not supported.

`FROM`	Data area containing the data to send.
`LENGTH`	Length of the data.
`TERMINAL`	Sends input data to the terminal that originated the transaction.

The following options are not supported:

LAST PAGING REQID WAIT

`SEND TEXT NOEDIT`

SEND TEXT NOEDIT FROM(data-area) [LENGTH(halfword)] [TERMINAL] [ERASE] [PRINT] [FREEKB] [ALARM] [L80]

SEND TEXT NOEDIT writes an unedited data stream to a terminal. SEND TEXT NOEDIT is supported for 3278/3279-type terminals. Other types of terminals are not supported.

`ALARM`	Activates the 3270 audible alarm.
`ERASE`	Erases the screen printer buffer or partition and returns the cursor to the upper left corner of the screen before this page of output is displayed.
`FREEKB`	Unlocks the 3270 keyboard after the data is written.
`FROM`	Data area containing the data to send.
`L80`	Specifies an 80-character line length for a 3270 printer.
`LENGTH`	Length of the data.
`PRINT`	Starts a print operation at a 3270 printer. If omitted, the data is sent to the printer buffer but is not printed.
`TERMINAL`	Sends the data to the terminal that originated the transaction.

The following options are not supported:

`HONEOM`	`LAST`	`L40` and `L64`
`OUTPARTN`	`PAGING`	`REQID`
`WAIT`

`SET CONNECTION`

SET CONNECTION(data-value) [ACQSTATUS(cvda) | CONNSTATUS(cvda)[ACQUIRED | RELEASED]] [SERVSTATUS(cvda)[INSERVICE | OUTSERVICE]]

SET CONNECTION enables you to change both the definition and the current status of a connection between your local region and another region or another system. A CONNECTION definition is sometimes known as a system entry.

To use the SET CONNECTION command to activate a connection, you must define the control point in the link station definition in SNAP-IX. You must also ensure that the user ID of the user that starts the Sun MTP region is added to the sna group in the /etc/group file.

`ACQSTATUS`	Specifies the same information as the `CONNSTATUS` option and is retained only for compatibility. Use `CONNSTATUS` in new applications.
`CONNECTION`	Specifies the 4-character name of the connection that you are modifying. This is the name by which the connected region is known to your system, from its `CONNECTION` definition.
`CONNSTATUS`	Specifies whether or not Sun MTP is to be in session with the remote system represented by the connection (that is, whether the connection is to be acquired). The CVDA values are: `ACQUIRED`: CICS is to be in session, and to establish a connection if none exists. If the `SERVSTATUS` value of the connection is `OUTSERVICE`, you must specify `INSERVICE` as well as `ACQUIRED`. `RELEASED`: CICS is not to be in session, and is to terminate the connection if one exists. The connection is not released until all tasks currently using a session on the connection terminate.
`SERVSTATUS`	Specifies whether the connection is to be available for use. The CVDA values are: `INSERVICE`: The connection is to be available. `OUTSERVICE`: The connection is not available.

The following options are not supported:

`PURGETYPE`	`CANCEL`	`FORCECANCEL`
`EXITTRACING`	`EXITTRACE`	`NOEXITTRACE`
`PENDSTATUS`	`NOTPENDING`	`FORCEPURGE`
`PURGE`	`FORCE`	`ZCPTRACING`
`NOZCPTRACE`	`ZCPTRACE`

`SET FILE`

SET FILE enables you to change attributes of a single VSAM file.

Note - SET FILE is not supported for alternate index files.

`CLOSED`	Closes the file.
`DISABLED`	Makes the file unavailable to application programs.
`EMPTYREQ`	Reinitializes the file on `OPEN` so that the file is empty. If the file is currently busy (with batch) at the time of the `EMPTYREQ`, an `INVREQ` condition is returned unless `WAIT` is specified.
`ENABLED`	Makes the file available to application programs. An error is returned when the online transaction tries to enable a dataset that is locked by a batch stream.
`FORCE`	Waits until all activity has completed on the file before doing a `CLOSED` or `DISABLED`. Same as `WAIT`.
`NOEMPTYREQ`	Does not reinitialize the file on `OPEN` so that the file is empty. Default.
`NOWAIT`	Does not wait if the file is currently busy, but instead, returns `INVREQ` condition. Default.
`OPEN`	Opens the file. An error is returned when the online transaction tries to open a dataset that is locked by a batch stream.
`RESET`	Reinitializes the file on `OPEN` so that the file is empty. Same as `EMPTYREQ`.
`WAIT`	Waits until all activity has completed on the file before doing a `CLOSED` or `DISABLED`.

`SET PROGRAM`

SET PROGRAM(data-value) [COPY(cvda) | NEWCOPY] [EXECUTIONSET(cvda) | DPLSUBSET | FULLAPI] [JVMCLASS(data-area) | SHLIB(data-area)] [STATUS(cvda)]

The SET PROGRAM command modifies the definition of a particular program.

`PROGRAM`	The 8-character name of the program.
`COPY`	Specifies that a new copy of the program is to be loaded the next time a program is requested. The CVDA values are: `NEWCOPY`: Indicates a new copy of the program is to be used the next time the program is requested (invoked). `PHASEIN`: Not currently supported. The translator will recognize the option and issue a warning.
`EXECUTIONSET`	Specifies whether the program is to be restricted to executing the distributed program link (DPL) subset of the CICS API. `EXECUTIONSET` applies only to executable programs and governs the API only when a program executes locally. The CVDA values are: `DPLSUBSET`: Indicates the program is always restricted. `FULLAPI`: Indicates the program is not restricted unless it is invoked remotely.
`JVMCLASS`	A 255-character data area that specifies the Java class name of the program. Valid only for Java programs.
SHLIB	A 16-character data area that contains the name of the shared object associated with the program. Assumed to be relative to `$KIXSYS` unless the `KIXLIB` environment variable is set to a path name. (Sun MTP-specific option)
`STATUS`	Specifies whether the program is available for use. The CVDA values are: `DISABLED`: The program is not available. `ENABLED`: The program is available.

The following options are not supported:

`CEDFSTATUS`	`HOTPOOLING`	`JVMDEBUG`
`RUNTIME`	`SHARESTATUS`	`VERSION`

`SET TDQUEUE`

SET TDQUEUE(char-4) [ENABLED | DISABLED] [OPEN | CLOSED] [TRIGGERLEVEL(integer)]

SET TDQUEUE enables you to change the attributes of an intrapartition or extrapartition transient data queue. All queues are enabled at startup.

`CLOSED`	Closes the queue. Applies only to extrapartition data queues. You cannot close a `DISABLED` queue.
`DISABLED`	Makes the queue unavailable to applications. You cannot open or close a `DISABLED` queue. Reading, writing, or deleting a `DISABLED` queue causes the transaction to abort and returns a disabled condition.
`ENABLED`	Makes the queue available to applications.
`OPEN`	Opens the queue. Applies only to extrapartition data queues. You cannot open a `DISABLED` queue.
`TRIGGERLEVEL`	Number of output requests to allow before the transaction specified in the DCT is initiated. The level is any number from 0 to 32,767. Trigger level only applies to intrapartition queues. You can change the trigger level for `DISABLED` intrapartition queues.

The following options are not supported:

ATIFACILITY ATITERMID ATITRANID

`SET TERMINAL`

SET TERMINAL(termid) [ACQSTATUS(cvda)|TERMSTATUS(cvda)[ACQUIRED | RELEASED]]

SET TERMINAL changes some of the values of a named terminal definition.

ACQSTATUS

Sets the session status for the logical unit represented by the terminal. Use for compatibility only; use TERMSTATUS for new applications. See TERMSTATUS for CVDA values.

TERMSTATUS

Sets the session status for the logical unit represented by the terminal. Use for new applications. The CVDA values are:

ACQUIRED: Sun MTP is to acquire a session with the logical unit represented by this terminal.

RELEASED: Sun MTP is to terminate the session. The session is terminated when the current active transaction finishes.

The following options are not supported:

`ALTPRINTER`	`ALTPRTCOPYST`	`ATISTATUS`
`CREATESESS`	`DISCREQST`	`EXITTRACING`
`NEXTTRANSID`	`OBFORMATST`	`PAGESTATUS`
`PRINTER`	`PRTCOPYST`	`PURGE`
`PURGETYPE`	`RELREQST`	`SERVSTATUS`
`TCAMCONTROL`	`TERMPRIORITY`	`TRACING`
`TTISTATUS`	`UCTRANST`	`ZCPTRACING`

Responses are:

NORMAL

Returned following the successful execution of this command.

TERMIDERR

Returned when the specified termid cannot be found in the TCT.

INVREQ

Returned under the following circumstances:

The Sun MTP region does not support SNA 3270 terminals; unikixtrin is not executing.
The Sun MTP Terminal Handler (unikixi) identified by the specified terminal's TCT entry is not executing.
The command attempts to set an ACQUIRED terminal to ACQUIRED.
The command attempts to set a RELEASED terminal to RELEASED.

`SET TRANCLASS`

SET TRANCLASS(8-char data value) MAXACTIVE(data-area) [[USE](8-char target class name)]

The SET TRANCLASS command is used to change the number of transaction processors assigned to a transaction class. All options except PURGETHRESH are supported.

`MAXACTIVE`	The new number of active transaction processors that will be assigned to the class.
`[USE](8-char target class name)`	The transaction class from or to which transaction processors are reassigned. If not specified, KIXDFLT class is used. The `USE` keyword is optional; the 8-character target class name can be used alone. This option is a Sun MTP extension to the API.

Conditions returned from these statements are:

`TCIDERR`	Returned if an invalid class name is provided.
`INVREQ`	Returned if the `MAXACTIVE` parameter is invalid and the reconfiguration of the classes cannot be performed.

The following option is not supported:

PURGETHRESH

`SET TRANSACTION`

SET TRANSACTION(data-value) [DUMPING(cvda) | TRANDUMP | NOTRANDUMP] [TRANCLASS(data-value)] [STATUS(cvda) | DISABLED | ENABLED]

The SET TRANSACTION command enables you to change some attributes of a transaction definition.

`TRANSACTION`	The 4-character transaction identifier.
`DUMPING`	Specifies whether a transaction dump should be taken if a task executing this transaction terminates abnormally. The CVDA values are: `NOTRANDUMP`: A dump will not be taken. `TRANDUMP`: A dump will be taken.
`TRANCLASS`	The 8-character name of the transaction class to which this transaction will belong.
`STATUS`	Indicates whether the transaction is available. The CVDA values are: `DISABLED`: The transaction is not available. `ENABLED`: The transaction is available.

The following options are not supported:

`PRIORITY`	`PURGEABILITY`	`RUNAWAY`
`RUNAWAYTYPE`	`SHUTDOWN`	`TRACING`

`SIGNOFF`

SIGNOFF

SIGNOFF signs you off a terminal or principal terminal where you previously signed on. On failure, the value of EIBRESP2 indicates the reason for the failure.

Condition	RESP2	Reason
`INVREQ`	1	Not signed on.
	2	No terminal on this transaction.

`SIGNON`

SIGNON USERID(char-8) [PASSWORD(char-8)] [NEWPASSWORD(char-8)]

SIGNON associates the characteristics of the user specified by USERID with a terminal. If you specify NEWPASSWD, the password is changed to the new password string.

On failure, the value of EIBRESP2 indicates the reason for the failure.

Condition	RESP2	Reason
`NOTAUTH`	2	Incorrect password.
`USERIDERR`	8	The user ID is not in the SNT.
`INVREQ`	9	Terminal already signed on.
`INVREQ`	10	No terminal associated with the task.

The following options are not supported:

ESMRESP NATLANG NATLANGINUSE OIDCARD

`START`

START [INTERVAL(packed-7) | TIME(packed-7) | AFTER [HOURS(data-value)] [MINUTES(data-value) [SECONDS(data-value)] | AT [HOURS(data-value)] [MINUTES(data-value) [SECONDS(data-value)]] TRANSID(char-4) [REQID(char-8)] [FROM(data-area) LENGTH(halfword)] [TERMID(char-4)] [SYSID(char-4)] [RTRANSID(char-4)] [RTERMID(char-4)] [QUEUE(char-8)] [NOCHECK] [PROTECT]

The START command begins an asynchronous task at the same terminal, another terminal, or a printer. You can use it to start a task that is disconnected from any device.

AFTER	With one or more of the `HOURS`, `MINUTES`, and `SECONDS` options, `AFTER` specifies the period of time that is to elapse before the new task is started. This option must be used instead of `INTERVAL` in C or C++ programs. `AFTER HOURS(0)` is the default.
AT	Specifies the time when the new task is to start. This option must be used instead of `TIME` in C or C++ programs.
`FROM`	Data to store for a task that is to be started at some future time.
HOURS	A 32-bit binary value that specifies the number of hours. For use with `AFTER` or `AT`. Must be in the range 0 through 99.
`INTERVAL`	Expiration time as an interval of time that is to elapse from the time at which the `START` command is issued. To ensure that the Daylight Savings Time change is accounted for and the transaction starts at the correct time, you must set the `KIX_ADJ_DST` environment variable to any value. If the application tries to start the transaction at a time that is not valid in the local time zone, the resulting `START` will be unpredictable.
`LENGTH`	Length of the data to store for the new task.
MINUTES	A 32-bit binary value that specifies the number of minutes. For use with `AFTER` or `AT`. The value must be in the range 0 through 59 if `HOURS` or `SECONDS` is also specified. Otherwise, it must be in the range 0 through 5,999.
`NOCHECK`	If `SYSID` is coded, enables the system to improve performance of the `START` command by providing less error checking and slightly less functionality.
`PROTECT`	Cannot schedule the started transaction until the local transaction has successfully completed a syncpoint. If the starting task abends before the syncpoint occurs, the `START` request is cancelled.
`QUEUE`	Name of the temporary storage queue that the started transaction can use.
`REQID`	Unique name that identifies a command; used as a temporary storage identifier.
`RTERMID`	A value, such as a terminal name, that can be retrieved when the transaction specified in the `TRANSID` option is started.
`RTRANSID`	A value, such as a transaction name, that can be retrieved when the transaction specified in the `TRANSID` option is started.
SECONDS	A 32-bit binary value that specifies the number of seconds. For use with `AFTER` or `AT`. The value must be in the range 0 through 59 if `HOURS` or `MINUTES` is also specified. Otherwise, it must be in the range 0 through 359,999.
`SYSID`	If specified, it must match an entry on the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about asynchronous processing.
TIME	Specifies the time when the new task should be started.
`TRANSID`	If `SYSID` is not coded, it must match an entry in the PCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the PCT.
`TERMID`	If the command is to execute locally, it must match an entry in the TCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TCT.

The following option is not supported:

FMH

`STARTBR`

STARTBR DATASET(dataset) | FILE(dataset) RIDFLD(data-area) [KEYLENGTH(halfword) [GENERIC]] [REQID(halfword)] [SYSID(char-4)] [RBA | RRN] [GTEQ | EQUAL]

STARTBR is fully supported for VSAM datasets. It specifies the record in a dataset at which a browse operation is to start. Indexed sequential access method (ISAM) and direct access method (DAM) datasets are not supported.

`DATASET`	If `SYSID` is not coded, it must match an entry in the FCT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the FCT.
`EQUAL`	Search is satisfied only by a record having the same key as that specified in the `RIDFLD` option.
`FILE`	Name of the file to access. This is the dataset name in the FCT.
`GENERIC`	Search key is a generic key whose length is specified in the `KEYLENGTH` option.
`GTEQ`	If the search for a record having the same key as that specified in the `RIDFLD` option is unsuccessful, the first record having a greater key is retrieved.
`KEYLENGTH`	Length of the key that was specified in the `RIDFLD` option.
`RBA`	Record identification field specified in the `RIDFLD` option contains a relative byte address.
`REQID`	Unique request identifier for a browse; used to control multiple browse operations on a dataset.
`RIDFLD`	Record identification field.
`RRN`	Record identification field specified in the `RIDFLD` option contains a relative record number.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

The following options are not supported:

DEBKEY DEBREC

`SUSPEND`

SUSPEND

SUSPEND is fully supported. It is used to relinquish control to a task of higher priority. However, because tasks in a Sun MTP region execute in separate transaction servers, it has no effect.

`SYNCPOINT`

SYNCPOINT [ROLLBACK]

SYNCPOINT indicates the completion of a logical unit of work. SYNCPOINT dequeues any enqueued resources. It also commits any updated VSAM records and releases any locked records for recoverable VSAM datasets. Updates to recoverable temporary storage queues, recoverable transient data queues, and recoverable asynchronous starts are also committed.

ROLLBACK

Dequeues all enqueued resources, unlocks all locked records and restores updates to recoverable resources to their previous states.

`TRACE`

TRACE [ON | OFF] [SYSTEM] [EI] [USER] [SINGLE]

TRACE controls system and user trace table entries. Tracing in Sun MTP is by terminal and, within this restriction, TRACE is fully supported.

`UNLOCK`

UNLOCK DATASET(dataset) | FILE(dataset) [SYSID(char-4)]

UNLOCK is fully supported for VSAM datasets. It releases a file where a record is being held for update. ISAM and DAM datasets are not supported.

`DATASET`	Must match an entry in the FCT. If `SYSID` is specified, the file is assumed to be remote. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the FCT.
`FILE`	Name of the dataset to release. Must match an entry in the FCT. If `SYSID` is specified, the file is assumed to be remote.
`SYSID`	System to which the request is directed. If specified, it must match an entry on the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TCT.

`VERIFY PASSWORD`

VERIFY PASSWORD(current-pw)(char-8) USERID(current-uid)(char-8) [DAYSLEFT(remaining days)](halfword binary) [EXPIRYTIME(expiration date)](packed decimal 8 bytes) ESMREASON(err-reason) (fullword binary)

VERIFY PASSWORD is used to verify that the password entered is valid.

`PASSWORD`	Current password.
`USERID`	Current user ID.
`DAYSLEFT`	Number of days left on this password.
`EXPIRYTIME`	Date when password will expire.
`ESMREASON`	Error detail on the new password.

DAYSLEFT and EXPIRYTIME are optional arguments. If the password is non-expiring, these two arguments are returned as -1.

The PASSWORD and USERID must be valid for any other information to be returned. Otherwise, the following error conditions are returned:

Condition	RESP2	Reason
`NOTAUTH`	2	Current password is wrong.
`NOTAUTH`	3	Current password is expired; new password is needed.
`NOTAUTH`	19	Current password is suspended and `ESMREASON` is set to 901.
`USERIDERR`	8	Current user ID is invalid.

The following options are not supported:

CHANGETIME ESMRESP INVALIDCOUNT LASTUSETIME

`WAIT CONVID`

WAIT CONVID(char-4) [STATE(cvda)]

WAIT CONVID is fully supported. It is used to flush any buffered data on a DTP conversation.

`CONVID`	Identifies the conversation to which the command relates.
`STATE`	Gets the state of the current conversation.

CVDA values for STATE are:

`ALLOCATED`	`CONFFREE`	`CONFRECEIVE`
`CONFSEND`	`FREE`	`PENDFREE`
`PENDRECEIVE`	`RECEIVE`	`ROLLBACK`
`SEND`	`SYNCFREE`	`SYNCRECEIVE`
`SYNCSEND`

`WAIT EVENT`

WAIT EVENT ECADDR(pointer-value)

WAIT EVENT is fully supported. It suspends processing of a task until the specified timer event control area is posted.

ECADDR

Address of the timer event control area that must be posted before activity can resume.

`WAIT JOURNAL`

WAIT JOURNAL JFILEID(halfword) [REQID(fullword)] [STARTIO]

WAIT JOURNAL synchronizes the JOURNAL file with the transaction and ensures that records are written. Because the JOURNAL in Sun MTP is synchronous, the WAIT JOURNAL command has no effect.

`WRITE`

WRITE DATASET(dataset) | FILE(dataset) FROM(data-area) [LENGTH(halfword)] RIDFLD(data-area) [KEYLENGTH(halfword)] [SYSID(char-4)] [RBA | RRN] [MASSINSERT]

WRITE is fully supported for VSAM datasets. It writes a record to a dataset. ISAM and DAM datasets are not supported.

`DATASET`	If `SYSID` is not coded, it must match the dataset name in the FCT.
`FILE`	Name of the file to access. This is the dataset name in the FCT.
`FROM`	Record to write to the specified dataset.
`KEYLENGTH`	Length of the key that is specified in the `RIDFLD` option, except when `RBA` or `RRN` is specified.
`LENGTH`	Length of the record to write.
`MASSINSERT`	Specifies that the `WRITE` command is part of a mass-insert operation, that is, a series of writes, each specifying `MASSINSERT`.
`RBA`	Specifies that the record identification field specified in the `RIDFLD` option contains a relative byte address. Use only when writing to an ESDS file. If the file is 4 Gbytes in size, or greater, `INVREQ` is set and RESP2 is set to `1`.
`RIDFLD`	Record identification field.
`RRN`	Record identification field specified in the `RIDFLD` option contains a relative record number. Use only when writing to an RRDS file.
`SYSID`	If specified, must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`WRITE OPERATOR`

WRITE OPERATOR TEXT(data-value) [TEXTLENGTH(data-value)]

WRITE OPERATOR supports the options listed. Output meant for the console (CONSOLE) is directed to unikixmain.log. To view unikixmain.log, type the following command from the $KIXSYS directory:

$ tail -f unikixmain.log

`TEXT`	Data area that contains the output for the console.
`TEXTLENGTH`	Length of the text expressed in a fullword binary value. If the length of the text is greater than 120, `INVREQ` is set and `RESP2` is set to 1.

The following options are not supported:

`ACTION`	`CRITICAL`	`EVENTUAL`
`IMMEDIATE`	`NUMROUTES`	`REPLY`
`ROUTECODES`	`TIMEOUT`

`WRITEQ TD`

WRITEQ TD QUEUE(char-4) FROM(data-area) [LENGTH(halfword)] [SYSID(char-4)]

WRITEQ TD is fully supported. It writes transient data to the destination specified in the QUEUE option.

`FROM`	Data to write to the transient data queue.
`LENGTH`	Length of the data to write.
`QUEUE`	If `SYSID` is not coded, it must match an entry in the DCT. If the destination type is `PRINTER`, the data is written to the system printer. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the DCT.
`SYSID`	If specified, it must match an entry on the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`WRITEQ TS`

WRITEQ TS QUEUE(char-8) FROM(data-area) LENGTH(halfword) [ITEM(halfword) | [REWRITE]] [NUMITEMS(halfword)] [SYSID(char-4)] [MAIN | AUXILIARY] [NOSUSPEND]

WRITEQ TS is fully supported. It writes data to the temporary storage queue specified in the QUEUE option.

`AUXILIARY`	Temporary storage queue is on a direct access storage device in auxiliary storage.
`FROM`	Data to write to temporary storage.
`ITEM`	Item in the queue to replace. See `NUMITEMS`.
`LENGTH`	Length of the data to be written.
`MAIN`	Temporary storage queue is in main storage.
`NOSUSPEND`	Has no effect for local requests because the temporary storage is acquired from the user's virtual address space and availability is not affected by events in other parts of the system.
`NUMITEMS`	Halfword binary field into which is stored the total count of records that are currently on the queue after the `WRITEQ TS` command completes. If the record being written starts a new queue, the number returned at completion is 1; subsequent item numbers follow sequentially. `NUMITEMS` is not reliably valid if `REWRITE` is also specified on the command. For compatibility with earlier releases, `ITEM` on a `WRITEQ TS` command without `REWRITE` performs a similar function to `NUMITEMS`.
`QUEUE`	If `SYSID` is not coded and the queue is either recoverable or remote, it must match an entry in the TST. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TST.
`REWRITE`	Overwrites the existing record in the queue with the data provided. If you specify `REWRITE`, you must specify `ITEM`.
`SYSID`	If specified, it must match an entry in the TCT-System Entries screen. Refer to the Sun Mainframe Transaction Processing Software Administrator's Guide for information about function shipping.

`XCTL`

XCTL PROGRAM(char-8) [COMMAREA(data-area)[LENGTH(halfword)]]

XCTL passes control from one application program to another without the possibility of returning.

`COMMAREA`	The communication area to make available to the invoked program.
`LENGTH`	Length, in bytes, of the communication area.
`PROGRAM`	Must match an entry in the PPT. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the PPT.

The following options are not supported:

INPUTMSG INPUTMSGLEN

Proprietary Command

LEXECTERM is a proprietary command that conforms to the CICS API syntax.

`LEXECTERM`

LEXECTERM FROM(COM-BUF) LENGTH(COM-LEN)

The LEXECTERM command allows your application program to execute another program from the command line through a system call. The shell script or program and commands that make up the command line must reside in $UNIKIX/bin. When the command is complete, control is returned to the program normally.

FROM

COM-BUF contains the command line to execute.

LENGTH

COM-LEN is the length of the command line in COM-BUF from 1 to 256. If the value in the length field is not within the range, this error message is displayed:

1480E Key length may not be greater than 255

If the terminal from which the transaction with the embedded EXEC CICS LEXECTERM was invoked is not a local non-3270 type terminal, the INVREQ error message is displayed:

Transaction not authorized for 3270 terminal

Supported BMS Functions

Sun MTP supports most BMS software functions for 3270 Model 2, Model 4, and Model 5 terminals and CICS printers. The standard command set for BMS is also supported for these printers and terminal types.

The following table describes the support for minimum, standard, and full function BMS. If functions are not supported, it is due to differences in hardware availability under the operating system. Internally, Sun MTP directly supports 3270-type terminals and, using curses, supports standard ASCII terminals. Curses is a screen handling and optimization package. All BMS data streams are first converted to 3270 data streams for internal usage. For terminals other than 3270-type terminals, these datastreams are then converted by the terminal handler using the UNIX curses library for output to the terminal.

TABLE 4-3 BMS Functions Supported by Version
BMS Version	Function Provided	Support
Minimum	`SEND MAP` command	Yes. See SEND MAP for supported options.
	`RECEIVE MAP` command	Yes. See RECEIVE MAP for supported options.
	`SEND CONTROL` command	Yes. See SEND CONTROL for supported options.
	Default and Alternate screens	Default and Alternate. Must use a 3270 Model 2 as the Default; can use a Model 2, 4, or 5 as an Alternate.
	Extended Attributes	Allowed in the program; generates map copies with extended attributes. Some attributes are supported for certain devices. See Extended Attributes.
	Mapset Suffixes	Yes
	Screen Coordination with Null Maps	Yes
	Field and Block Data	Field only
Standard	Outboard Formats	No
	Partitions	No
	Controlling a mag slot reader	No
	`NLEOM` for 3270 printers	No
	`SEND TEXT` command	Yes. See SEND TEXT for supported options.
	Subsystem LDC controls	No
Full	Terminal operator paging	Yes
	Cumulative Mapping	Yes
	Page Overflow	Yes
	Cumulative Text Processing	Yes
	Routing (`ROUTE` command)	No
	Message Switching	No
	Returning BMS-generated data streams to program before output	Yes

Extended Attributes

Extended attributes are supported differently depending on the terminal type. TABLE 4-4 lists the support available for each terminal type.

The following extended attributes are not supported:

Transparency

Validation

TABLE 4-4 Ex tended Attributes Supported by Terminal Type
Terminal	Extended Attribute	Support
3270*	Color	Supported fully
	Hilight	Supported fully
	Outline	Supported fully
	SOSI	Supported fully
	PS	Supports only one programmed symbol per region
ASCII terminal using UNIX terminal client	Color	Not supported
	Hilight	Supported fully depending on the features of the physical terminal used
	Outline	Not supported
	SOSI	Supported fully
	PS	Supports only one programmed symbol per region
X terminal emulating a VT220 using UNIX terminal client	Color	Not supported
	Hilight	Supported except for blink
	Outline	Not supported
	SOSI	Supported fully
	PS	Supports only one programmed symbol per region
^{* During the bind of the 3270 terminal, it is determined whether the terminal supports extended attributes. By default, 3270 login assumes that the terminal is set to the high order bit of byte 15 of the Bind format in order for the LU to be set to 0x80 to enable extended attributes.}^{The default 3270 login can be changed to have extended attributes enabled. Refer to the User's Guide for the 3270 terminal to determine the proper method for making this change.}

Alternate Screen Sizes

The default screen size for Sun MTP is 24 rows x 80 characters when emulating a 3270 terminal. Sun MTP also supports two alternate screen sizes:

43x80 (3270 Model 4)

27x132 (3270 Model 5)

Sun MTP uses the size of the terminal and the screen size field in the PCT to determine whether alternate screen sizes are available and whether they should be used. How these parameters are set differs by terminal type.

Alternate screen sizes are activated when the transaction has a screen size value of ALT in its PCT entry. If the physical terminal is capable of the alternate screen size, Sun MTP changes the first ERASE/WRITE command to the terminal to ERASE/WRITE ALTERNATE to force the screen to the alternate screen size. You can generate the ERASE/WRITE command by any EXEC CICS SEND, SEND MAP or other terminal output command.

A mapset suffix determines which mapset to display for a specific screen. The suffix for mapsets is specified in the BMS and in the terminal definition. By convention, Model 4 mapsets typically use a suffix of 4 and Model 5 mapsets use a suffix of 5. Model 2 mapsets use the letter M as a suffix.

For example, a transaction is normally built to be executed on any size terminal. To accomplish this, the transaction must send its output using BMS. BMS uses the following algorithm, which is designed to hide the differing screen sizes from the application:

When an alternate screen size is used and a mapping operation is requested, Sun MTP uses the mapset name in the request to search for the mapset. This mapset name has the suffix appended.

If it is not found, an M is appended to the mapset in order to search for a 3270 Model 2 mapset.

If that mapset is not found, the name is used directly.

Determining the Screen Size

Screen sizes are determined based on the terminal type.

3270 Terminals

Sun MTP determines the screen size through the bind of the 3270 terminal. Byte 24 of the bind contains a bit mask that describes the terminal's screen size capabilities. By default, the 3270 terminal is only capable of displaying screens of 24 rows x 80 characters. However, if byte 24 is equal to 0x7F, the values in bytes 22 and 23 are used as the alternate screen size. Only alternate screen sizes of 43 rows x 80 characters and 27 rows x 132 characters are supported.

ASCII Terminals

Sun MTP determines the screen size for ASCII terminals from an option to the terminal client. When starting the terminal client, the alternate screen size defaults to the largest size that the terminal can support. For example, if the screen is equal to or greater than 43 rows x 80 characters but not 132 characters wide, the ASCII terminal client defaults to Model 4 alternate screen size support.

If the screen is equal to or greater than 27 rows x 132 characters, the ASCII terminal client defaults to Model 5 alternate screen size support. To override this support, the -4 and -5 options exist to set Model 4 or Model 5, respectively. In any case, the screen must be large enough to support the size chosen.

The LINES and COLS environment variables are used to determine the actual size. Unlike the actual 3270 terminals, when a switch is made between Model 2 transactions and Model 4 or Model 5 transactions, the font is not changed. Only the portion of the screen required for the Model 2 is used and the additional space is protected.

Specifying a BMS Suffix

The BMS suffix is set differently depending on the terminal type.

3270-type Terminals

Normally, a 3270-type terminal does not need to be defined in the TCT. However, if you are setting a BMS suffix, you must define the terminal and suffix in the TCT- 3270 Devices screen. Refer to the Sun Mainframe Transaction Processing Software Reference Guide for information about the TCT.

Local Client Terminal

Use the -x option to the unikix command, which takes a single alphanumeric character that becomes the suffix. If the -x option is not present, no suffix is set.

Supported EIB Fields

This section describes the fields in the CICS Execution Interface Block (EIB) and identifies those that are supported. If a field is not supported (marked with an N in the following table), the EIB entry is set to blanks or binary zeros. The entry is displayed on debug screens and in dumps, but no other useful reference is made to it.

TABLE 4-5 CICS Execution Block Interface (EIB) Field Support *(1 of 3)*
EIB Entry	Length/Type	Description	Sun MTP Support
`EIBAID`	`PIC X(1).`	Contains the attention identifier (AID) associated with the last terminal control or BMS input operation from a display device.	Y
`EIBATT`	`PIC X(1).`	Indicates that the RU contains attach header data (`X'FF'`).	N
`EIBCALEN`	`PIC S9(4) comp.`	Contains the length of the communication area that was passed to the application program from the last program, using the `COMMAREA` and `LENGTH` options. If no communication area is passed, this field contains zeros.	Y
`EIBCOMPL`	`PIC X(1).`	On a terminal control `RECEIVE` command, this EIB entry indicates whether the data is complete (`X'FF'`). If the `NOTRUNCATE` option has been used on the `RECEIVE` command, CICS retains data in excess of the amount requested through the `LENGTH` or `MAXLENGTH` option. `EIBRECV` is set indicating that further `RECEIVE` commands are required. `EIBCOMPL` is not set until the last of the data has been retrieved. `EIBCOMPL` is always set when a `RECEIVE` command without the `NOTRUNCATE` option is executed.	Y
`EIBCONF`	`PIC X(1).`	Indicates that a `CONFIRM` request was received (`X'FF'`) for an APPC conversation.	Y
`EIBCPOSN`	`PIC S9(4) comp.`	Contains the cursor address (position) associated with the last terminal control or BMS input operation from a display device.	Y
`EIBDATE`	`PIC S9(7) comp-3.`	Contains the date the task is started. This field is updated by the `ASKTIME` command. The date is in packed decimal form (0CYYDDD+) where C shows the century with values 0 for the 1900s and 1 for the 2000s. For example, the dates 31 December 1999 and 1 January 2000 have `EIBDATE` values of 0099365 and 0100001, respectively.	Y
`EIBDS`	`PIC X(8).`	Contains the symbolic identifier of the last dataset referred to in a file control request.	Y
`EIBEOC`	`PIC X(1).`	Indicates that an end-of-chain indicator is in the RU just received (`X'FF'`).	Y
`EIBERR`	`PIC X(1).`	Indicates that an error was received (`X'FF'`) on an APPC conversation.	Y
`EIBERRCD`	`PIC X(4).`	When `EIBERR` is set, `EIBERRCD` contains the error code that was received. The following values can be returned in the first two bytes of `EIBERRCD`: `X'0889'` Conversation error detected `X'0824'` `SYNCPOINT ROLLBACK` requested	Y
`EIBFMH`	`PIC X(1).`	Indicates that the user data just received or retrieved contains an FMS (`X'FF'`).	Y
`EIBFN`	`PIC X(2).`	Contains a code that identifies the last CICS command to be issued by the task (updated when the requested function has been completed).	Y
`EIBFREE`	`PIC X(1).`	Indicates that the application program cannot continue using the facility. The application program should either free the facility or terminate so that the facility is freed by CICS (`X'FF'`).	Y
`EIBNODAT`	`PIC X(1).`	Indicates that no data has been sent by the remote application (`X'FF'`). A message has been received from the remote system that conveyed only control information. The use of this field is restricted to application programs holding conversations across APPC links only.	Y
`EIBRCODE`	`PIC X(6).`	Contains the CICS response code returned after the functions requested by the last CICS command to be issued by the task has been completed. For a normal response, this field contains hexadecimal zeros (`6 X'00'`).	Y
`EIBRECV`	`PIC X(1).`	Indicates that the application program is to continue receiving data from the facility by executing `RECEIVE` commands (`X'FF'`).	Y
`EIBREQID`	`PIC X(8).`	Contains the request identifier assigned to an interval control command by CICS; this field is not used when a request identifier is specified in the application program.	Y
`EIBRESP`	`PIC 9(09) comp.`	Contains a number corresponding to the `RESP` condition that occurred.	Y
`EIBRESP2`	`PIC 9(09) comp.`	Contains more detailed information that can help explain why the `RESP` condition occurred.	Y
`EIBRLDBK`	`PIC X(1).`	Indicates a rollback.	N
`EIBRSRCE`	`PIC X(8).`	Contains the symbolic identifier of the resource being accessed by the latest executed command.	Y
`EIBSIG`	`PIC X(1).`	Indicates that `SIGNAL` was received (`X'FF'`).	Y
`EIBSYNC`	`PIC X(1).`	Indicates that the application program must take a syncpoint or terminate. Before either is done, the application program must ensure that any other facilities owned by it are put into the send state or are freed (`X'FF'`).	N
`EIBSYNRB`	`PIC X(1).`	Indicates that the application program should issue a `SYNCPOINT ROLLBACK` command (`X'FF'`). This field is only set in application programs holding a conversation on an APPC or MRO link.	N
`EIBTASKN`	`PIC S9(7) comp-3.`	Contains the task number assigned to the task by CICS. This number is displayed in trace table entries generated while the task is in control. The format of the field is packed decimal.	Y
`EIBTIME`	`PIC S9(7) comp-3.`	Contains the time at which the task is started. This field is updated by the `ASKTIME` command. The time is in packed decimal format (0HHMMSS+).	Y
`EIBTRMID`	`PIC X(4).`	Contains the symbolic terminal identifier of the principal facility (terminal or logical unit) associated with the task.	Y
`EIBTRNID`	`PIC X(4).`	Contains the symbolic transaction identifier of the task.	Y
`EIBSEND`	`PIC X(1).`	Not an IBM field; only set to `0x00` by Sun MTP.

Sun MTP and IBM CICS Differences

Absolute Addressing

Assignment of Terminal Identifiers

Byte Ordering

Base Locator Linkage (BLL) and Pointer Variables for COBOL

Calling C Subroutines From COBOL Programs

Supported ISC Functions

Index Initialization

COBOL Programs

PL/I and C Programs

Levels of Support for CICS Commands

Supported CICS Commands

ABEND

ADDRESS

ALLOCATE (APPC mapped)

ASKTIME

ASSIGN

BIF DEEDIT

CANCEL

CHANGE PASSWORD

COLLECT STATISTICS

CONNECT PROCESS

CONVERSE (APPC)

CONVERSE (LUTYPE2/LUTYPE3)

DELAY

DELETE

DELETEQ TD

DELETEQ TS

DEQ

DUMP

ENDBR

ENQ

ENTER

EXTRACT ATTRIBUTES

EXTRACT CERTIFICATE

EXTRACT PROCESS

FORMATTIME

FREE

FREEMAIN

GETMAIN

HANDLE ABEND

HANDLE AID

HANDLE CONDITION

IGNORE CONDITION

INQUIRE CONNECTION

INQUIRE FILE

INQUIRE PROGRAM

INQUIRE REQID

INQUIRE SYSTEM

INQUIRE TASK

INQUIRE TASK LIST

INQUIRE TDQUEUE

INQUIRE TERMINAL

INQUIRE TRANCLASS

INQUIRE TRANSACTION

ISSUE ABEND

ISSUE CONFIRMATION

ISSUE DISCONNECT

ISSUE ERASEAUP

ISSUE ERROR

ISSUE PRINT

ISSUE SIGNAL

JOURNAL

LINK

LOAD

POP HANDLE

POST

PURGE MESSAGE

PUSH HANDLE

READ

READNEXT

READPREV

READQ TD

READQ TS

RECEIVE (APPC)

RECEIVE (LUTYPE2/LUTYPE3)

RECEIVE MAP

RELEASE

RESETBR

RETRIEVE

`ABEND`

`ADDRESS`

`ALLOCATE` (APPC mapped)

`ASKTIME`

`ASSIGN`

`BIF DEEDIT`

`CANCEL`

`CHANGE PASSWORD`

`COLLECT STATISTICS`

`CONNECT PROCESS`

`CONVERSE` (APPC)

`CONVERSE` (LUTYPE2/LUTYPE3)

`DELAY`

`DELETE`

`DELETEQ TD`

`DELETEQ TS`

`DEQ`

`DUMP`

`ENDBR`

`ENQ`

`ENTER`

`EXTRACT ATTRIBUTES`

`EXTRACT CERTIFICATE`

`EXTRACT PROCESS`

`FORMATTIME`

`FREE`

`FREEMAIN`

`GETMAIN`

`HANDLE ABEND`

`HANDLE AID`

`HANDLE CONDITION`

`IGNORE CONDITION`

`INQUIRE CONNECTION`

`INQUIRE FILE`

`INQUIRE PROGRAM`

`INQUIRE REQID`

`INQUIRE SYSTEM`

`INQUIRE TASK`

`INQUIRE TASK LIST`

`INQUIRE TDQUEUE`

`INQUIRE TERMINAL`

`INQUIRE TRANCLASS`

`INQUIRE TRANSACTION`

`ISSUE ABEND`

`ISSUE CONFIRMATION`

`ISSUE DISCONNECT`

`ISSUE ERASEAUP`

`ISSUE ERROR`

`ISSUE PRINT`

`ISSUE SIGNAL`

`JOURNAL`

`LINK`

`LOAD`

`POP HANDLE`

`POST`

`PURGE MESSAGE`

`PUSH HANDLE`

`READ`

`READNEXT`

`READPREV`

`READQ TD`

`READQ TS`

`RECEIVE` (APPC)

`RECEIVE` (LUTYPE2/LUTYPE3)

`RECEIVE MAP`

`RELEASE`

`RESETBR`

`RETRIEVE`

`RETURN`

`REWRITE`

`SEND` (APPC mapped)

`SEND` (LUTYPE2/LUTYPE3)

`SEND CONTROL`

`SEND MAP`

`SEND PAGE`

`SEND TEXT`

`SEND TEXT MAPPED`

`SEND TEXT NOEDIT`

`SET CONNECTION`

`SET FILE`