13.1.1 CICS Command and Parameter Support Table
Table 13-1 CICS Command (COBOL Support)
Category | CICS Command | Command Parameter | Notes |
---|---|---|---|
ABEND
|
ABEND
|
ABCODE(name)
|
|
CANCEL
|
|||
NODUMP
|
|||
HANDLE ABEND
|
CANCEL
|
||
LABEL(label)
|
Support HANDLE ABEND generated by
command ABEND ; partially support system
ABEND .
|
||
PROGRAM(name)
|
|||
RESET
|
Recognized | ||
APPC Mapped conversation
|
ALLOCATE (APPC)
|
NOQUEUE
|
Recognized |
STATE(cvda)
|
|||
SYSID(systemname)
|
|||
CONNECT PROCESS
|
CONVID(name)
|
||
PROCLENGTH(data-value)
|
|||
PROCNAME(data-area)
|
|||
STATE(cvda)
|
|||
SYNCLEVEL(data-value)
|
|||
CONVERSE (APPC)
|
CONVID(name)
|
||
FROM(data-area)
|
|||
FROMLENGTH(data-value)
|
|||
FROMFLENGTH(data-value)
|
|||
INTO(data-area)
|
|||
MAXFLENGTH(data-value)
|
|||
MAXLENGTH(data-value)
|
|||
NOTRUNCATE
|
|||
SET(ptr-ref)
|
|||
STATE(cvda)
|
|||
TOFLENGTH(data-area)
|
|||
TOLENGTH(data-area)
|
|||
APPC Mapped conversation
|
EXTRACT PROCESS
|
CONVID(name)
|
|
SYNCLEVEL(data-area)
|
|||
FREE (APPC)
|
CONVID(name)
|
||
STATE(cvda)
|
|||
ISSUE CONFIRMATION
|
CONVID(name)
|
||
STATE(cvda)
|
|||
RECEIVE (APPC)
|
CONVID(name)
|
||
FLENGTH(data-area)
|
|||
INTO(data-area)
|
|||
LENGTH(data-area)
|
|||
MAXFLENGTH(data-value)
|
|||
MAXLENGTH(data-value)
|
|||
NOTRUNCATE
|
|||
SET(ptr-ref)
|
|||
STATE(cvda)
|
|||
SEND (APPC)
|
CONFIRM
|
||
CONVID(name)
|
|||
FLENGTH(data-value)
|
|||
FROM(data-area)
|
|||
INVITE
|
|||
LAST
|
|||
LENGTH(data-value)
|
|||
STATE(cvda)
|
|||
WAIT
|
|||
WAIT CONVID (APPC)
|
CONVID(name)
|
||
STATE(cvda)
|
|||
AUTHENTICATION
|
SIGNOFF
|
||
SIGNON
|
USERID(data-value)
|
||
PASSWORD(data-value)
|
|||
VERIFY PASSWORD
|
CHANGETIME(data-area)
|
Recognized | |
DAYSLEFT(data-area)
|
Recognized | ||
ESMREASON(data-area)
|
Recognized | ||
ESMRESP(data-area)
|
Return values
|
||
EXPIRYTIME(data-area)
|
Recognized | ||
INVALIDCOUNT(data-area)
|
Recognized | ||
LASTUSETIME(data-area)
|
Recognized | ||
PASSWORD(data-value)
|
|||
RESP(data-area)
|
Return values:
|
||
USERID(data-value)
|
To use VERIFY PASSWORD , you must configure
XAUTHSVR in Oracle Tuxedo.
|
||
BMS
|
PURGE MESSAGE
|
Not supported by ARTWTRN/ARTWTR1 | |
RECEIVE MAP
|
ASIS
|
||
FROM(data-area)
|
Not supported by ARTWTRN/ARTWTR1 | ||
INTO(data-area)
|
|||
LENGTH(data-value)
|
Not supported by ARTWTRN/ARTWTR1 | ||
MAP(name)
|
|||
MAPSET(name)
|
|||
SET(ptr-ref)
|
Not supported by ARTWTRN/ARTWTR1 | ||
TERMINAL
|
|||
SEND CONTROL
|
ACCUM
|
Not supported by ARTWTRN/ARTWTR1 | |
ALARM
|
|||
CURSOR(data-value)
|
|||
DEFAULT
|
Not supported by ARTWTRN/ARTWTR1 | ||
ERASE
|
|||
ERASEAUP
|
Not supported by ARTWTRN/ARTWTR1 | ||
FREEKB
|
|||
FRSET
|
|||
PRINT
|
|||
TERMINAL
|
Not supported by ARTWTRN/ARTWTR1 | ||
WAIT
|
|||
SEND MAP
|
ACCUM
|
Not supported by ARTWTRN/ARTWTR1 | |
ALARM
|
|||
CURSOR(data-value)
|
|||
DATAONLY
|
Not supported by ARTWTRN/ARTWTR1 | ||
DEFAULT
|
|||
ERASE
|
|||
ERASEAUP
|
|||
FORMFEED
|
Recognized | ||
FREEKB
|
|||
FROM(data-area)
|
|||
FRSET
|
|||
LENGTH(data-value)
|
|||
MAP(name)
|
|||
MAPONLY
|
Not supported by ARTWTRN/ARTWTR1 | ||
MAPSET(name)
|
|||
NOFLUSH
|
Not supported by ARTWTRN/ARTWTR1 | ||
PRINT
|
|||
SET(ptr-ref)
|
|||
TERMINAL
|
Not supported by ARTWTRN/ARTWTR1 | ||
WAIT
|
|||
SEND PAGE
|
RELEASE
|
Not supported by ARTWTRN/ARTWTR1 | |
RETAIN
|
|||
TRAILER(data-area)
|
|||
TRANSID(name)
|
|||
SEND TEXT
|
ACCUM
|
Not supported by ARTWTRN/ARTWTR1 | |
ALARM
|
|||
CURSOR(data-value)
|
|||
ERASE
|
|||
FREEKB
|
|||
FROM(data-area)
|
|||
HEADER(data-area)
|
Not supported by ARTWTRN/ARTWTR1 | ||
JUSTIFY(data-value)
|
|||
LENGTH(data-value)
|
|||
NLEOM
|
|||
PRINT
|
|||
TRAILER(data-area)
|
Not supported by ARTWTRN/ARTWTR1 | ||
TERMINAL
|
|||
WAIT
|
|||
Built-in Functions
|
BIF DEEDIT
|
FIELD(data-area)
|
|
LENGTH(data-value)
|
|||
Channel
|
DELETE CONTAINER (CHANNEL)
|
CHANNEL(data-value)
|
|
ENDBROWSE CONTAINER
|
BROWSETOKEN(data-value)
|
||
GET CONTAINER (CHANNEL)
|
CHANNEL(data-value)
|
||
FLENGTH(data-area)
|
|||
INTO(data-area)
|
|||
NODATA
|
|||
SET(ptr-ref)
|
|||
GETNEXT CONTAINER
|
BROWSETOKEN(data-value)
|
||
MOVE CONTAINER (CHANNEL)
|
AS(data-value)
|
||
CHANNEL(data-value)
|
|||
TOCHANNEL(data-value)
|
|||
PUT CONTAINER (CHANNEL)
|
CHANNEL(data-value)
|
||
FLENGTH(data-value)
|
|||
FROM(data-area)
|
|||
STARTBROWSE CONTAINER
|
BROWSETOKEN(data-area)
|
||
CHANNEL(data-value)
|
|||
START CHANNEL
|
CHANNEL(name)
|
||
COLLECT STATISTICS
|
SET(ptr-ref)
|
Recognized | |
MONITOR(data-value)
|
|||
Console Support
|
WRITE OPERATOR
|
TEXT(data-value)
|
We provide a stub function. This function can be replaced by the integration team for project needs. |
TEXTLENGTH(data-value)
|
|||
Diagnostic Services
|
DUMP TRANSACTION
|
All its options are recognized by ART CICS. | |
ENTER TRACENUM
|
|
||
Environment services
|
ADDRESS
|
COMMAREA(ptr-ref)
|
|
CWA(ptr-ref)
|
|||
EIB(ptr-ref)
|
|||
TCTUA(ptr-ref)
|
|||
TWA(ptr-ref)
|
|||
ADDRESS SET
|
SET(data-area/ptr-ref)
|
||
USING(ptr-ref/data-area)
|
|||
ASSIGN
|
ABCODE(data-area)
|
||
ABDUMP(data-area)
|
|||
ABPROGRAM(data-area)
|
|||
APPLID(data-area)
|
|||
ASRAINTRPT(data-area)
|
Recognized | ||
ASRAKEY(cvda)
|
Recognized | ||
ASRAPSW(data-area)
|
Recognized | ||
ASRAREGS(data-area
|
Recognized | ||
ASRASPC(cvda)
|
Recognized | ||
ASRASTG(cvda)
|
Recognized | ||
CHANNEL(data-area)
|
|||
CWALENG(data-area)
|
|||
FACILITY(data-area)
|
Recognized | ||
FCI(data-area)
|
Recognized | ||
INITPARM(data-area)
|
In each section, if INITPARM parameters are
specified more than one time, only the last definition will take
effect.
|
||
INITPARMLEN(data-area)
|
|||
KATAKANA(data-area)
|
|||
NETNAME(data-area)
|
|||
OPID(data-area)
|
Recognized | ||
PROGRAM(data-area)
|
|||
SOSI(data-area)
|
|||
STARTCODE(data-area)
|
|||
SYSID(data-area)
|
|||
TCTUALENG(data-area)
|
|||
TERMCODE(data-area)
|
Recognized | ||
TWALENG(data-area)
|
|||
USERID(data-area)
|
|||
USERNAME(data-area)
|
|||
Exception Support
|
HANDLE CONDITION
|
condition(label)
|
|
IGNORE CONDITION
|
condition
|
||
PUSH HANDLE
|
|||
POP HANDLE
|
|||
File control services
|
DELETE
|
DATASET(filename)
|
|
FILE(filename)
|
|||
GENERIC(VSAM KSDS only)
|
Not supported in File2File when using COBOL-IT. | ||
KEYLENGTH(data-value)
|
|||
NUMREC(data-area)(VSAM KSDS only)
|
Recognized | ||
RBA
|
|
||
RIDFLD(data-area)
|
|||
SYSID(systemname)
|
Recognized | ||
ENDBR
|
DATASET(filename)
|
||
FILE(filename)
|
|||
REQID(data-value)
|
Recognized | ||
SYSID(systemname)
|
Recognized | ||
READ
|
DATASET(filename)
|
||
EQUAL
|
|||
FILE(filename)
|
|||
GENERIC
|
Not supported in File2File when using COBOL-IT | ||
GTEQ
|
|||
INTO(data-area)
|
|||
KEYLENGTH(data-value)
|
|||
LENGTH(data-area)
|
|||
RBA
|
|||
RIDFLD(data-area)
|
|||
RRN
|
Recognized | ||
SET(ptr-ref)
|
|||
SYSID(systemname)
|
Recognized | ||
UPDATE
|
Recognized | ||
READNEXT
|
DATASET(filename)
|
||
FILE(filename)
|
|||
INTO(data-area)
|
|||
KEYLENGTH(data-value)
|
|||
LENGTH(data-area)
|
|||
RBA
|
Not supported in File2File when using COBOL-IT. | ||
RIDFLD(data-area)
|
|||
RRN
|
Recognized | ||
SET(ptr-ref)
|
|||
SYSID(systemname)
|
Recognized | ||
READPREV
|
DATASET(filename)
|
||
FILE(filename)
|
|||
INTO(data-area)
|
|||
KEYLENGTH(data-value)
|
|||
LENGTH(data-area)
|
|||
RBA
|
Not supported in File2File when using COBOL-IT. | ||
RIDFLD(data-area)
|
|||
RRN
|
Recognized | ||
SET(ptr-ref)
|
|||
SYSID(systemname)
|
Recognized | ||
RESETBR
|
DATASET(filename)
|
||
EQUAL
|
|||
FILE(filename)
|
|||
GENERIC
|
Not supported in File2File when using COBOL-IT. | ||
GTEQ
|
|||
KEYLENGTH(data-value)
|
|||
RBA
|
Not supported in File2File when using COBOL-IT. | ||
RIDFLD(data-area)
|
|||
REWRITE
|
DATASET(filename)
|
||
FILE(filename)
|
|||
FROM(data-area)
|
|||
LENGTH(data-value)
|
|||
SYSID(systemname)
|
Recognized | ||
STARTBR
|
DATASET(filename)
|
||
EQUAL
|
|||
FILE(filename)
|
|||
GENERIC
|
Not supported in File2File when using COBOL-IT. | ||
GTEQ
|
|||
KEYLENGTH(data-value)
|
|||
RBA
|
Not supported in File2File when using COBOL-IT. | ||
REQID(data-value)
|
Recognized | ||
RIDFLD(data-area)
|
|||
RRN
|
Recognized | ||
SYSID(systemname)
|
Recognized | ||
UNLOCK
|
DATASET
|
Recognized | |
FILE(filename)
|
|||
TOKEN(data-area)
|
|||
WRITE
|
DATASET(filename)
|
||
FILE(filename)
|
|||
FROM(data-area)
|
|||
KEYLENGTH(data-value)
|
|||
LENGTH(data-value)
|
|||
RBA
|
|
||
RIDFLD(data-area)
|
|||
RRN
|
Recognized | ||
SYSID(systemname)
|
Recognized | ||
Interval Control Services
|
ASKTIME
|
ABSTIME(data-area)
|
|
CANCEL
|
REQID(name)
|
Not supports for cancelling the remote requests
issued by DELAY command
|
|
SYSID(systemname)
|
|||
TRANSID(name)
|
|||
DELAY
|
FOR
|
||
HOURS(data-value)
|
|||
INTERVAL(hhmmss)
|
The default value is INTERVAL(0) .
|
||
MINUTES(data-value)
|
|||
REQID(name)
|
|||
SECONDS(data-value)
|
|||
TIME(hhmmss)
|
|||
FORMATTIME
|
ABSTIME(data-area)
|
||
DATE(data-area)
|
|||
DATEFORM(data-area)
|
|||
DATESEP(data-value)
|
|||
DAYCOUNT(data-area)
|
|||
DAYOFMONTH(data-area)
|
|||
DAYOFWEEK(data-area)
|
|||
DDMMYY(data-area)
|
|||
DDMMYYYY(data-area)
|
|||
FULLDATE(data-area)
|
|||
MMDDYY(data-area)
|
|||
MMDDYYYY(data-area)
|
|||
MONTHOFYEAR(data-area)
|
|||
TIME(data-area)
|
|||
TIMESEP(data-value)
|
|||
YEAR(data-area)
|
|||
YYDDD(data-area)
|
|||
YYDDMM(data-area)
|
|||
YYMMDD(data-area)
|
|||
YYYYDDD(data-area)
|
|||
YYYYDDMM(data-area)
|
|||
YYYYMMDD(data-area)
|
|||
RETRIEVE
|
INTO(data-area)
|
||
LENGTH(data-area)
|
|||
QUEUE(data-area)
|
|||
RTERMID(data-area)
|
|||
RTRANSID(data-area)
|
|||
SET(ptr-ref)
|
|||
START
|
AFTER
|
||
AT
|
|||
FROM(data-area)
|
|||
HOURS(data-value)
|
|||
INTERVAL(hhmmss)
|
|||
LENGTH(data-value)
|
If not specified, START LENGTH will be automatically set. Its default value is in "LENGTH OF data-area " format; "data-area " is the one specified in FROM .
|
||
MINUTES(data-value)
|
|||
NOCHECK
|
|||
PROTECT
|
|||
QUEUE(name)
|
This option cannot be used with TERMID .
|
||
REQID(name)
|
The specified REQID must be unique in
START asynchronous CICS delayed transactions when /Q,
or ARTSRM_ORA or ARTSRM_UDB
implementation is used.
|
||
RTERMID(name)
|
|||
RTRANSID(name)
|
|||
SECONDS(data-value)
|
|||
SYSID(systemname)
|
|||
TERMID(name)
|
The Oracle Tuxedo server, TMUSREVT , must be
configured in the UBBCONFIG file to support this
command.
|
||
TIME(hhmmss)
|
|||
TRANSID(name)
|
TERMID option cannot be used together with the RTRANSID/RTERMID/QUE UE option for the START TRANSID command.
|
||
USERID(data-value)
|
The security stub is called with USERID and
TRANSID .
|
||
Journaling
|
JOURNAL
|
FROM(data-area)
|
|
JFILEID(data-value)
|
Specifies a value in the range 1 through 99, the number that is
to be taken as the journal identifier. When specifying
JFILEID as nn , the journal will be
written to journal file DFHJnn .
|
||
JTYPEID(data-value)
|
|||
WRITE JOURNALNAME
|
FLENGTH(data-value)
|
||
FROM(data-area)
|
|||
JTYPEID(data-value)
|
|||
PFXLENG(data-value)
|
|||
PREFIX(data-value)
|
|||
STARTIO
|
Recognized | ||
WAIT
|
Recognized | ||
LUTYPE6.1 Conversation
|
ALLOCATE (LUTYPE6.1)
|
SYSID(systemname)
|
|
CONVERSE (LUTYPE6.1)
|
FROM(data-area)
|
||
FROMFLENGTH(data-value)
|
|||
FROMLENGTH(data-value)
|
|||
INTO(data-area)
|
|||
MAXFLENGTH(data-value)
|
|||
MAXLENGTH(data-value)
|
|||
NOTRUNCATE
|
|||
SESSION(name)
|
|||
SET(ptr-ref)
|
|||
TOFLENGTH(data-area)
|
|||
TOLENGTH(data-area)
|
|||
FREE (LUTYPE6.1)
|
SESSION(name)
|
||
RECEIVE (LUTYPE6.1)
|
FLENGTH(data-area)
|
||
INTO(data-area)
|
|||
LENGTH(data-area)
|
|||
MAXFLENGTH(data-value)
|
|||
MAXLENGTH(data-value)
|
|||
NOTRUNCATE
|
|||
SESSION(name)
|
|||
SET(ptr-ref)
|
|||
SEND (LUTYPE6.1)
|
FLENGTH(data-value)
|
||
FROM(data-area)
|
|||
INVITE
|
|||
LAST
|
|||
LENGTH(data-value)
|
|||
SESSION(name)
|
|||
WAIT
|
|||
NAMED COUNTER SERVICES
|
DEFINE COUNTER
|
COUNTER(name)
|
Mark POOL option as “Recognized” in each command |
VALUE(data-value)
|
|||
MINIMUM(data-value)
|
|||
MAXIMUM(data-value)
|
|||
GET COUNTER
|
COUNTER(name)
|
||
VALUE(data-area)
|
|||
INCREMENT(data-value)
|
|||
REDUCE
|
|||
WRAP
|
|||
COMPAREMIN(data-value)
|
|||
COMPAREMAX(data-value)
|
|||
QUERY COUNTER
|
COUNTER(name)
|
||
VALUE(data-area)
|
|||
MINIMUM(data-area)
|
|||
MAXIMUM(data-area)
|
|||
UPDATE COUNTER
|
COUNTER(name)
|
||
VALUE(data-area)
|
|||
COMPAREMIN(data-area)
|
|||
COMPAREMAX (data-area)
|
|||
DELETE COUNTER
|
COUNTER(name)
|
||
Program Control
|
LINK
|
CHANNEL(name)
|
|
COMMAREA(data-area)
|
|||
DATALENGTH(data-value)
|
|||
LENGTH(data-value)
|
|||
PROGRAM(name)
|
|||
SYNCONRETURN
|
|||
SYSID(systemname)
|
|||
TRANSID(name)
|
|||
LOAD
|
ENTRY(ptr-ref)
|
||
PROGRAM(name)
|
|||
RELEASE
|
PROGRAM(name)
|
||
RETURN
|
CHANNEL(name)
|
||
COMMAREA(data-area)
|
|||
IMMEDIATE
|
|||
INPUTMSG(data-area)
|
|||
INPUTMSGLEN(data-value)
|
|||
LENGTH(data-value)
|
|||
TRANSID(name)
|
|||
XCTL
|
CHANNEL(name)
|
||
COMMAREA(data-area)
|
|||
LENGTH(data-value)
|
|||
PROGRAM(name)
|
|||
Spool Interface (JES)
|
SPOOLCLOSE
|
ASA
|
Recognized |
CLASS(data-value)
|
|||
SPOOLOPEN OUTPUT
|
NOCC
|
||
NODE(data-value)
|
Only support for local node if there is no /*XEQ NODE line defined in JCL file for the automatic submission to JES.
|
||
PRINT
|
Recognized | ||
PUNCH
|
Recognized | ||
RECORDLENGTH(data-value)
|
|||
TOKEN(data-area)
|
|||
USERID(data-value)
|
Supports only INTRDR
|
||
SPOOLWRITE
|
FLENGTH(data-value)
|
||
FROM(data-area)
|
|||
TOKEN(data-area)
|
|||
Storage Control
|
GETMAIN
|
FLENGTH(data-value)
|
|
INITIMG(data-value)
|
|||
SET(ptr-ref)
|
|||
SHARED
|
Only supports ARTSTRN/1 , ARTATRN/1
and ARTDPL in SHM mode.
|
||
FREEMAIN
|
DATA(data-area)
|
||
DATAPOINTER(ptr-value)
|
|||
Syncpoint
|
SYNCPOINT
|
||
SYNCPOINT ROLLBACK
|
ROLLBACK
|
||
System Commands
|
INQUIRE CONNECTION
|
ACCESSMETHOD(cvda)
|
|
CONNSTATUS(cvda)(APPC and MRO only)
|
|||
NETNAME(data-area)
|
|||
ACQSTATUS(cvda)
|
Recognized | ||
SERVSTATUS(cvda)
|
|||
START
|
|||
NEXT
|
|||
END
|
|||
INQUIRE DB2CONN
|
CONNECTERROR(cvda
|
Recognized | |
CONNECTST(cvda)
|
|||
DB2GROUPID(data-area)
|
|||
DB2ID(data-area)
|
|||
PLAN(data-area)
|
|||
INQUIRE NETNAME
|
|
||
INQUIRE STORAGE
|
ADDRESS(ptr-value)
|
Recognized | |
DSANAME(cvda)
|
Recognized | ||
ELEMENT(ptr-ref)
|
Recognized. CICS NULL pointer is returned. | ||
ELEMENTLIST(ptr-ref)
|
Recognized. CICS NULL pointer is returned. | ||
FLENGTH(data-area)
|
Recognized. 0 is returned. | ||
LENGTHLIST(ptr-ref)
|
Recognized. CICS NULL pointer is returned. | ||
NUMELEMENTS(data-area)
|
Recognized. 0 is returned. | ||
TASK(data-value)
|
Recognized | ||
INQUIRE SYSTEM
|
JOBNAME(data-area)
|
||
RELEASE(data-area)
|
Returns the value configured in either
KIX_CICS_RELEASE environment variable or
CICS_RELEASE in system configuration file
systems.desc . If both of them are configured, the
value in systems.desc is returned; If neither of them
is configured, value '0660 ' (corresponding to CICS
4.1) is returned.
|
||
SHUTSTATUS(cvda)
|
Only NOTAPPLIC is returned.
|
||
INQUIRE TERMINAL
|
ACCESSMETHOD(cvda)
|
Partial CVDA values are supported for the
following options: –
|
|
ALTSUFFIX(data-area)
|
|||
ACQSTATUS(cvda)(VTAM only)
|
|||
CREATESESS(cvda)(VTAM only)
|
|||
NETNAME(data-area)
|
|||
NEXTTRANSID(data-area)
|
|||
SERVSTATUS(cvda)
|
|||
SIGNONSTATUS(cvda)
|
|||
TRACING(cvda)
|
|||
TRANSACTION(data-area)
|
|||
USERID(data-area)
|
|||
REMOTESYSTEM(data-area)
|
|||
SERVSTATUS(cvda)
|
|||
SIGNONSTATUS(cvda)
|
|||
TRACING(cvda)
|
|||
TRANSACTION(data-area)
|
|||
USERID(data-area)
|
|||
AIDCOUNT(data-area)
|
Recognized | ||
TERMSTATUS(cvda)
|
|||
TASKID(data-area)
|
|||
DEVICE(cvda)
|
|||
INQUIRE TRANCLASS
|
MAXACTIVE(data-area)
|
The following parameters are not applicable in CICS Runtime
environment: ACTIVE
PURGETHRESH
QUEUED
|
|
INQUIRE TRANSACTION
|
PROGRAM(data-area)
|
||
STATUS(cvda)
|
|||
INQUIRE TSPOOL
|
START
|
Recognized | |
INQUIRE TSQNAME
|
START
|
Recognized | |
POOLNAME(data-value)
|
|||
SET CONNECTION
|
CONNSTATUS(cvda)(APPC only)
|
|
|
INQUIRE FILE
|
ACCESSMETHOD(cvda)
|
Only VSAM is returned.
|
|
DSNAME(data-area)
|
The default value of DSNAME is the VSAM file name; once specified by SET FILE DSNAME , INQUIRE FILE DSNAME will return the specified value.
|
||
EMPTYSTATUS(cvda)(VSAM only)
|
Only NOEMPTYREQ is returned.
|
||
ENABLESTATUS(cvda)
|
|||
LSRPOOLID(data-area)(VSA M only)
|
Only 0 is returned.
|
||
MAXNUMRECS(data-area)(da ta tables only)
|
Only 0 is returned
|
||
OPENSTATUS(cvda)
|
|||
TABLE(cvda)(VSAM and CFDT only)
|
Only NOTTABLE is returned.
|
||
TYPE(cvda)
|
|||
INQUIRE PROGRAM
|
RESCOUNT(data-area)
|
To use this option, RESCOUNT-STAT must be set to
ENABLED in programs.desc .
|
|
INQUIRE EXITPROGRAM
|
ENTRYNAME(data-area)
|
Recognized | |
CONNECTST(cvda)
|
|||
QUALIFIER(data-area)
|
|||
STARTSTATUS(cvda)
|
|||
INQUIRE TASK
|
ATTACHTIME(data-area)
|
||
TASK(data-value)
|
|||
TRANSACTION(data-area)
|
|||
RUNSTATUS(cvda)
|
Recognized. Only RUNNING is returned.
|
||
SUSPENDTYPE(data-area)
|
Recognized. Only NULL is returned.
|
||
PROGRAM(data-area)
|
|||
STARTCODE(data-area)
|
|||
TWASIZE(data-area)
|
|||
UOW(data-area)
|
|||
USERID(data-area)
|
|||
INQUIRE TASK LIST
|
LISTSIZE(data-area)
|
||
SET(ptr-ref)
|
|||
SETTRANSID(ptr-ref)
|
|||
DISPATCHABLE
|
Recognized | ||
RUNNING
|
Recognized | ||
SUSPENDED
|
Recognized | ||
SET FILE
|
DSNAME(data-value)
|
||
ENABLESTATUS(cvda)
|
The supported CVDA values are DISABLED and
ENABLED .
|
||
OPENSTATUS(cvda)
|
The supported CVDA values are CLOSED and
OPEN .
|
||
SET PROGRAM
|
COPY(cvda)
|
||
NEWCOPY
|
When using NEWCOPY command to reload programs, you
must delete the compiled executable file before copying new
compiled executable file to runtime environment.
|
||
PHASEIN
|
|||
SET TDQUEUE
|
ATIFACILITY(cvda)
|
Recognized | |
NOTERMINAL
|
|||
TERMINAL
|
|||
ATITERMID(data-value)
|
|||
ATITRANID(data-value)
|
|||
ATIUSERID(data-value)
|
|||
ENABLESTATUS(cvda)
|
|||
DISABLED
|
|||
ENABLED
|
|||
OPENSTATUS(cvda)
|
|||
CLOSED
|
|||
OPEN
|
|||
TRIGGERLEVEL(data-value)
|
|||
SET TERMINAL
Note: The |
ATISTATUS(cvda)
|
The supported CVDA values are ATI and
NOATI .
|
|
CREATESESS(cvda) (VTAM only)
|
The supported CVDA value is CREATE .
|
||
SERVSTATUS(cvda)
|
The supported CVDA values are INSERVICE and
OUTSERVICE .
|
||
TERMSTATUS(cvda) (VTAM only)
|
The supported CVDA values are ACQUIRED and
RELEASED .
|
||
TTISTATUS(cvda)
|
The supported CVDA values are NOTTI and
TTI .
|
||
Task Control
|
DEQ
|
LENGTH(data-value)
|
Mandatory, only the enqueues and dequeues on data values are supported, not the enqueues on address. |
MAXLIFETIME(cvda)
|
|||
RESOURCE(data-area)
|
|||
ENQ
|
LENGTH(data-value)
|
||
MAXLIFETIME(cvda)
|
The supported CVDA values are TASK and
UOW .
|
||
NOSUSPEND
|
|||
RESOURCE(data-area)
|
|||
SUSPEND
|
|||
Temporary Storage
|
DELETEQ TS
|
QNAME(name)
|
|
QUEUE(name)
|
|||
SYSID(systemname)
|
|||
READQ TS
|
INTO(data-area)
|
||
ITEM(data-value)
|
|||
LENGTH(data-area)
|
|||
NEXT
|
|||
NUMITEMS(data-area)
|
|||
QNAME(name)
|
|||
QUEUE(name)
|
|||
SET(ptr-ref)
|
|||
SYSID(systemname)
|
Recognized | ||
WRITEQ TS
|
AUXILIARY
|
||
FROM(data-area)
|
|||
ITEM(data-area)
|
|||
LENGTH(data-value)
|
|||
MAIN
|
|||
NOSUSPEND
|
|||
NUMITEMS(data-area)
|
|||
QNAME(name)
|
|||
QUEUE(name)
|
|||
REWRITE
|
|||
SYSID(systemname)
|
Recognized | ||
Terminal Control
|
CONVERSE (terminal)
|
ASIS
|
|
CTLCHAR(data-value)
|
|||
ERASE
|
|||
FROM(data-area)
|
|||
FROMFLENGTH(data-value)
|
|||
FROMLENGTH(data-value)
|
|||
INTO(data-area)
|
|||
MAXFLENGTH
|
|||
MAXLENGTH
|
|||
NOTRUNCATE
|
|||
STRFIELD
|
|||
SET(ptr-ref)
|
|||
TOFLENGTH(data-area)
|
|||
TOLENGTH(data-area)
|
|||
EXTRACT LOGONMSG
|
INTO(data-area)
|
||
LENGTH(data-area)
|
|||
SET(ptr-ref)
|
|||
HANDLE AID
|
ANYKEY
|
||
CLEAR
|
|||
ENTER
|
|||
OPERID
|
Recognized | ||
PA1-PA3
|
|||
PF1-PF24
|
|||
ISSUE DISCONNECT (default)
|
|||
ISSUE PASS
|
FROM(data-area)
|
||
LENGTH(data-value)
|
|||
LUNAME(name)
|
|||
RECEIVE
|
ASIS
|
||
BUFFER
|
Not supported by ARTWTRN/ARTWTR1 | ||
FLENGTH(data-value)
|
|||
INTO(data-area)
|
|||
LENGTH(data-value)
|
|||
MAXFLENGTH(data-value)
|
Not supported by ARTWTRN/ARTWTR1 | ||
MAXLENGTH(data-value)
|
|||
NOTRUNCATE
|
Not supported by ARTWTRN/ARTWTR1 | ||
SET(ptr-ref)
|
|||
SEND
|
ALTERNATE
|
||
CTLCHAR(data-value)
|
When bit 2/3 of WCC is '00 ' and bit 4
is '1' , the LENGTH and
FLENGTH must not be greater than 1896.
|
||
DEFRESP
|
|||
ERASE
|
|||
FLENGTH(data-value)
|
Not supported by ARTWTRN/ARTWTR1 | ||
FROM(data-area)
|
|||
LAST
|
|||
LENGTH(data-value)
|
|||
STRFIELD
|
|||
WAIT
|
Not supported by ARTWTRN/ARTWTR1 | ||
WAIT TERMINAL
|
|||
Transient Data
|
DELETEQ TD
|
QUEUE(name)
|
|
SYSID(systemname)
|
|||
READQ TD
|
INTO(data-area)
|
||
LENGTH(data-area)
|
|||
QUEUE(name)
|
|||
WRITEQ TD
|
FROM(data-area)
|
||
LENGTH(data-value)
|
|||
QUEUE(name)
|
|||
SYSID(systemname)
|
|||
Web Service
|
INVOKE WEBSERVICE
|
CHANNEL(name)
|
|
OPERATION(data-area)
|
|||
URI(data-area)
|
|||
WEBSERVICE(name)
|
|||
SOAPFAULT CREATE
|
FAULTCODE(cvda)
|
Recognized Note: All CVDA values are recognized, including CLIENT,SENDER, SERVER, and RECEIVER .
|
|
FAULTSTRING(data-value)
|
Recognized | ||
FAULTSTRLEN(data-value)
|
Recognized | ||
WEB Support
|
WEB CLOSE
|
SESSTOKEN(data-value)
|
|
WEB CONVERSE
|
ACTION(cvda)
|
Recognized | |
CHARACTERSET(data-value)
|
Recognized | ||
CLIENTCONV(cvda)
|
Recognized | ||
CLOSESTATUS(cvda)
|
Recognized | ||
DOCTOKEN(data-value)
|
Recognized | ||
FROM(data-area)
|
|||
FROMLENGTH(data-area)
|
|||
INTO(data-area)
|
|||
MAXLENGTH(data-value)
|
|||
MEDIATYPE(data-area)
|
Recognized | ||
METHOD(cvda)
|
Recognized | ||
NOTRUNCATE
|
Recognized | ||
QUERYSTRING(data-area)
|
While a query string is specified, the message body is ignored. | ||
QUERYSTRLEN(data-value)
|
|||
PATH(data-area)
|
Recognized | ||
PATHLENGTH(data-value)
|
Recognized | ||
SESSTOKEN(data-value)
|
|||
SET(ptr-ref)
|
|||
STATUSCODE(data-area)
|
|||
STATUSLEN(data-value)
|
|||
STATUSTEXT(data-area)
|
|||
TOLENGTH(data-area)
|
|||
URIMAP(data-value)
|
Recognized | ||
WEB ENDBROWSE FORMFIELD
|
|||
WEB EXTRACT (Server)
|
HOST(data-area)
|
||
HOSTLENGTH(data-area)
|
|||
HTTPMETHOD(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
HTTPVERSION(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
METHODLENGTH(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
PATH(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
PATHLENGTH(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
PORTNUMBER(data-area)
|
|||
QUERYSTRING(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
QUERYSTRLEN(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
REQUESTTYPE(cvda)
|
Recognized
Always returns HTTPYES .
|
||
SCHEME(cvda)
|
Enable SALT Property: enableHTTPRequestLine
|
||
VERSIONLEN(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
WEB OPEN
|
CERTIFICATE(data-value)
|
Recognized | |
CIPHERS(data-value)
|
Recognized | ||
CODEPAGE(data-value)
|
Recognized | ||
HOST(data-value)
|
|||
HOSTLENGTH(data-value)
|
|||
HTTPRNUM(data-area)
|
Recognized | ||
HTTPVNUM(data-area)
|
Recognized | ||
NUMCIPHERS(data-value)
|
Recognized | ||
PORTNUMBER(data-value)
|
|||
SCHEME(cvda)
|
Recognized | ||
SESSTOKEN(data-area)
|
|||
URIMAP(data-value)
|
|||
WEB READ HTTPHEADER
|
HTTPHEADER(data-area)
|
Enable SALT Property: enableCustomHTTPHeaders
|
|
NAMELENGTH(data-value)
|
|||
VALUE(data-area)
|
|||
VALUELENGTH(data-area)
|
|||
WEB READNEXT FORMFIELD
|
FORMFIELD(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
|
NAMELENGTH(data-area)
|
|||
VALUE(data-area)
|
|||
VALUELENGTH(data-area)
|
|||
WEB RECEIVE (Server)
|
CHARACTERSET(data-value)
|
||
CLNTCODEPAGE(data-value)
|
|||
HOSTCODEPAGE(data-value)
|
|||
INTO(data-area)
|
|||
LENGTH(data-area)
|
|||
MAXLENGTH(data-value)
|
|||
NOTRUNCATE
|
|||
SERVERCONV(cvda)
|
Recognized | ||
SET(ptr-ref)
|
|||
TYPE(cvda)
|
Recognized Always returns HTTPYES .
|
||
WEB SEND (Server)
|
CHARACTERSET(data-value)
|
Recognized | |
FROM(data-area)
|
|||
FROMLENGTH(data-value)
|
|||
SERVERCONV(cvda)
|
|||
WEB STARTBROWSE FORMFIELD
|
CLNTCODEPAGE(data-value)
|
Recognized | |
FORMFIELD(data-area)
|
Enable SALT Property: enableHTTPRequestLine
|
||
HOSTCODEPAGE(data-value)
|
Recognized | ||
NAMELENGTH(data-area)
|
|||
WEB WRITE HTTPHEADER
|
HTTPHEADER(data-area)
|
Enable SALT Property: enableCustomHTTPHeaders
|
|
NAMELENGTH(data-value)
|
|||
SESSTOKEN(data-value)
|
Recognized | ||
VALUE(data-area)
|
|||
VALUELENGTH(data-value)
|
Note:
- For each command, if none of its listed "command parameters" is mandatory to set originally, ART CICS supports users to code none of them.
-
RESP
,RESP2
, andNOHANDLE
are supported on all commands. - Recognized parameters are processed by the pre-processor and have no effect on the behavior of CICS Runtime.
- Some CICS commands require ARTSRM server. See ARTSRM Configuration for the complete set of those CICS commands.
-
INQUIRE TERMINAL
,SET TERMINAL
,ISSUE PASS
, andEXTRACT LOGONMSG
requireARTLOGN
server
Table 13-2 CICS Command (C Support)
Category | CICS Command | Command Parameter | Notes |
---|---|---|---|
ABEND
|
ABEND
|
ABCODE(name)
|
|
NODUMP
|
|||
Channel commands
|
GET CONTAINER (CHANNEL)
|
CHANNEL(data-value)
|
|
FLENGTH(data-area)
|
|||
INTO(data-area)
|
|||
NODATA
|
|||
SET(ptr-ref)
|
|||
PUT CONTAINER (CHANNEL)
|
CHANNEL(data-value)
|
||
FLENGTH(data-value)
|
|||
FROM(data-area)
|
|||
Environment services
|
ADDRESS
|
EIB(ptr-ref)
|
|
COMMAREA(ptr-ref)
|
|||
CWA(ptr-ref)
|
|||
ASSIGN
|
APPLID(data-area)
|
||
LANGINUSE(data-area)
|
|||
LANGINUSE(data-area)
|
|||
Interval Control Services
|
ASKTIME
|
ABSTIME(data-area)
|
|
FORMATTIME
|
ABSTIME(data-area)
|
||
DATESEP(data-value)
|
|||
TIME(data-area)
|
|||
TIMESEP(data-value)
|
|||
YYYYMMDD(data-area)
|
|||
RETRIEVE
|
INTO(data-area)
|
||
LENGTH(data-value)
|
|||
SET(ptr-ref)
|
|||
Program Control
|
LINK
|
COMMAREA(data-area)
|
|
DATALENGTH(data-value)
|
|||
LENGTH(data-value)
|
|||
PROGRAM(name)
|
|||
SYNCONRETURN
|
|||
SYSID(systemname)
|
|||
TRANSID(name)
|
|||
RETURN
|
|||
Syncpoint
|
SYNCPOINT
|
||
SYNCPOINT ROLLBACK
|
|||
Terminal Control
|
RECEIVE
|
INTO(data-area)
|
|
LENGTH(data-value)
|
|||
Transient Data
|
WRITEQ TD
|
FROM(data-area)
|
|
LENGTH(data-value)
|
|||
QUEUE(name)
|
|||
Storage Control
|
GETMAIN
|
FLENGTH(data-value)
|
|
INITIMG(data-value)
|
|||
SET(ptr-ref)
|
|||
SHARED
|
|||
FREEMAIN
|
DATA(data-area)
|
||
DATAPOINTER(ptr-value)
|
Parent topic: Supported CICS Commands