CICS Commands

The following is a list of the common CICS commands and their COBOL syntax. If you are using PL/1 then just substitute ; for END-EXEC. [ ] indicate optional parameters, [ | ] indicates a choice of one of the options listed (or none), { | } indicates you must specify one of the options. abend force the current task to terminate abnormally EXEC CICS ABEND [ABCODE(name)] [CANCEL] [NODUMP] ENDEXEC. lets you access system information maintained in storage outside your program EXEC CICS ADDRESS [ACEE(pointer-ref)] [COMMAREA(pointer-ref)] [CSA(pointer-ref)] [CWA(pointer-ref)]

address

[EIB(pointer-ref)] [TCTUA(pointer-ref)] [TWA(pointer-ref)] ENDEXEC. allocate establishes a distributed processing session with another system EXEC CICS ALLOCATE SYSID(name) [PROFILE(name)] [NOQUEUE | NOSUSPEND] [STATE(data-area)] ENDEXEC. obtain current time and date EXEC CICS ASKTIME [ABSTIME(data-area)] END-EXEC. obtain information from various system control areas EXEC CICS ASSIGN option(data-area) ENDEXEC. formats alphanumeric data into numeric data

asktime

assign

bif deedit

EXEC CICS BIF DEEDIT FIELD(data-area) [LENGTH(data-value)] END-EXEC. build attach creates an ATTACH FMH used to initiate a background transaction with LU6.1 or MRO EXEC CICS BUILD ATTACH ATTACHID(name) [PROCESS(name)] [RESOURCE(name)] [RPROCESS(name)] [RRESOURCE(name)] [QUEUE(name)] [IUTYPE(data-value)] [DATASTR(data-value)] [RECFM(data-value)] ENDEXEC. cancel cancels the effect of a DELAY, POST, or START command EXEC CICS CANCEL [REQID(name)] [TRANSID(name)] [SYSID(name)] END-EXEC.

change task changes the priority of the current task EXEC CICS CHANGE TASK PRIORITY(data-value) END-EXEC. connect process initiates an application program on a remote system once a session has been ALLOCATEd EXEC CICS CONNECT PROCESS {CONV(name) | SESSION(name) } PROCNAME(data-area) PROCLENGTH(data-area) SYNCLEVEL(data-area) [PIPLIST(data-area) PIPLENGTH(data-value)] [STATE(data-area)] ENDEXEC. send data to a remote process and receive a response EXEC CICS CONVERSE [CONVID(name) | SESSION(name)]

converse

[ATTACHID(name)] FROM(data-area) { FROMLENGTH(data-area) | FROMFLENGTH(data-area) } { INTO(data-area) | SET(pointer-ref) } {TOLENGTH(data-area) | TOFLENGTH(data-area) } [MAXLENGTH(data-value) | MAXFLENGTH(data-value)] [NOTRUNCATE] [STATE(data-area)] ENDEXEC. delay suspend a task EXEC CICS DELAY [INTERVAL(hhmmss) | TIME(hhmmss) | FOR [HOURS(hh)] [MINUTES(mm)] [SECONDS(ss)] | UNTIL [HOURS(hh)] [MINUTES(mm)] [SECONDS(ss)]] [REQID(name)] END-EXEC.

delete

remove a record from a file EXEC CICS DELETE { DATASET(name) | FILE(name) } [RIDFLD(data-area) [KEYLENGTH(data-value) [GENERIC[NUMREC(dataarea)]]]] [RBA | RRN] [SYSID(name)] END-EXEC. remove a record from a transient data queue EXEC CICS DELETEQ TD QUEUE(name) [SYSID(name)] END-EXEC. remove a record from a temporary storage queue EXEC CICS DELETEQ TS QUEUE(name) [SYSID(name)] END-EXEC. release a user defined resource EXEC CICS DEQ RESOURCE(data-area) [LENGTH(data-value)]

deleteq td

deleteq ts

deq

[LUW | TASK | MAXLIFETIME(data-area)] END-EXEC. dump force a storage dump EXEC CICS DUMP [TRANSACTION] DUMPCODE(name) [FROM(data-area) [LENGTH(data-value) | FLENGTH(data-value)]] [SEGMENTLIST(data-area) LENGTHLIST(data-area) NUMSEGMENTS(dataarea)] [COMPLETE] [TRT] [TASK] [STORAGE] [PROGRAM] [TERMINAL] [TABLES] [DCT] [FCT] [PCT] [PPT] [SIT] [TCT] END-EXEC. terminate a browse operation EXEC CICS ENDBR { DATASET(name) | FILE(name) } REQID(datavalue) [SYSID(name)]

endbr

END-EXEC. enq reserve a user defined resource EXEC CICS ENQ RESOURCE(data-area) [LENGTH(data-value)] [NOSUSPEND] [LUW | TASK | MAXLIFETIME(dataarea)] END-EXEC. write a user trace entry into the CICS trace table EXEC CICS ENTER {TRACENUM(data-value) | TRACEID(data-value) } [FROM(data-area) [FROMLENGTH(dataarea)]] [RESOURE(dataarea)] [EXCEPTION] ENDEXEC. retrieve values from an ATTACH FMH EXEC CICS EXTRACT ATTACH [ATTACHID(name) | CONVID(name) |

enter

extract attach

SESSION(name)] [PROCESS(name)] [RESOURCE(name)] [RPROCESS(name)] [RRESOURCE(name)] [QUEUE(name)] [IUTYPE(data-value)] [DATASTR(data-value)] [RECFM(data-value)] ENDEXEC. extract attributes determine the current state of an MRO or APPC conversation EXEC CICS EXTRACT ATTRIBUTES [CONVID(name) | SESSION(name)] [STATE(data-value)] ENDEXEC. used in a back end program to obtain information passed via the CONNECT PROCESS command in the front end program EXEC CICS EXTRACT

extract process

PROCESS [CONVID(name) | SESSION(name)] [PROCNAME(datavalue)PROCLENGTH(dataarea) [MAXPROCLEN(datavalue)]] [SYNCLEVEL(dataarea)] [PIPLIST(data-area) PIPLENGTH(data-value)] END-EXEC. formattime convert time to required format EXEC CICS FORMATTIME ABSTIME(data-value) [YYDDD(data-area)] [YYMMDD(data-area)] [YYDDMM(data-area)] [DDMMYY(data-area)] [MMDDYY(data-area)] [DATE(data-area) [DATEFORM(data-area)]] [DATESEP[(data-value)]] [DAYCOUNT(data-area)] [DAYOFWEEK(data-area)] [DAYOFMONTH(data-area)]

[MONTHOFYEAR(dataarea)] [YEAR(data-area)] [TIME(data-area) [TIMESEP[(data-value)]]] END-EXEC. free release a distributed processing session EXEC CICS FREE [CONVID(name) | SESSION(name)] [STATE(data-area)] ENDEXEC. release virtual storage EXEC CICS FREEMAIN { DATA(data-area) | DATAPOINTER(pointer-ref) } END-EXEC. aquire virtual storage EXEC CICS GETMAIN SET(pointer-ref) { LENGTH(data-value) | FLENGTH(data-value) [BELOW] } [INITIMG(datavalue)] [NOSUSPEND]

freemain

getmain

[SHARED] {USERKEY | CICSKEY] END-EXEC. handle abend establish abend exits EXEC CICS HANDLE ABEND { PROGRAM(name) | LABEL(label) | CANCEL | RESET } END-EXEC. establish routines to be invoked when AID keys (enter, pf and pa keys) are detected by a receive map EXEC CICS HANDLE AID option [(label)] END-EXEC. specifies how certain exception conditions should be processed EXEC CICS HANDLE CONDITION conditionname [(label)] END-EXEC. specifies that certain exception conditions should be ignored EXEC CICS IGNORE CONDITION conditionname ... END-EXEC.

handle aid

handle condition

ignore condition

link

invoke a program, return to the next statement after completion EXEC CICS LINK PROGRAM(name) [COMMAREA(data-area) [LENGTH(data-value)] [DATALENGTH(datavalue)]] [INPUTMSG(dataarea) [INPUTMSGLEN(datavalue)]] [SYSID(name)] [SYNCONRETURN] [TRANSID(name)] ENDEXEC. retrieve and load an object module and return its length and address EXEC CICS LOAD PROGRAM(name) [SET(pointer-ref)] [LENGTH(data-area) | FLENGTH(data-area)] [ENTRY(pointer-ref)]

load

[HOLD] END-EXEC. pop handle restores handle abend, aid, and conditions temporarily suspended by push handle EXEC CICS POP HANDLE END-EXEC. create a Timer Event Control Area EXEC CICS POST [INTERVAL(hhmmss) | TIME(hhmmss) | AFTER [HOURS(hh)] [MINUTES(mm)] [SECONDS(ss)] | AT [HOURS(hh)] [MINUTES(mm)] [SECONDS(ss)]] SET(pointer-ref) [REQID(name)] END-EXEC. delete a logical message before the task terminates EXEC CICS PURGE MESSAGE END-EXEC.

post

purge message

push handle temporarily suspend handle

abend, aid, and conditions EXEC CICS PUSH HANDLE END-EXEC. read read a record from a file EXEC CICS READ { DATASET(name) | FILE(name) } { INTO(dataarea) | SET(pointer-ref) } [LENGTH(data-area)] RIDFLD(data-area) [KEYLENGTH(data-area) [GENERIC]] [SYSID(name)] [RBA | RRN] [GTEQ | EQUAL] [UPDATE] END-EXEC. read the next sequential record from a file EXEC CICS READNEXT { DATASET(name) | FILE(name) } { INTO(dataarea) | SET(pointer-ref) } [LENGTH(data-area)] RIDFLD(data-area) [KEYLENGTH(data-area)]

readnext

[SYSID(name)] [RBA | RRN] [REQID(data-value)] END-EXEC. readprev read the previous sequential record from a file EXEC CICS READPREV { DATASET(name) | FILE(name) } { INTO(dataarea) | SET(pointer-ref) } [LENGTH(data-area)] RIDFLD(data-area) [KEYLENGTH(data-area)] [SYSID(name)] [RBA | RRN] [REQID(data-value)] END-EXEC. read a record from a transient data queue EXEC CICS READQ TD QUEUE(name) { INTO(data-area) | SET(pointer-ref) } [LENGTH(data-area)] [SYSID(name)] [NOSUSPEND] END-EXEC.

readq td

readq ts

read a record from a temporary storage queue EXEC CICS READQ TS QUEUE(name) { INTO(data-area) | SET(pointer-ref) } [LENGTH(data-area)] [NUMITEMS(data-area)] [ITEM(data-value) | NEXT] [SYSID(name)] END-EXEC.

receive receive data sent by a remote (distributed) process EXEC CICS RECEIVE [CONVID(name) | SESSION(name)] { INTO(data-area) | SET(pointer-ref) } { LENGTH(data-area) | FLENGTH(data-area) } [MAXLENGTH(data-value) | MAXFLENGTH(data-value)] [NOTRUNCATE] [STATE(data-area)] ENDEXEC.

receive (terminal)

retrieve input data from a terminal EXEC CICS RECEIVE { INTO(data-area) | SET(pointer-ref) } { LENGTH(data-area) | FLENGTH(data-area) } [MAXLENGTH(data-value) | MAXFLENGTH(data-value)] [NOTRUNCATE] [ASIS] [BUFFER] END-EXEC.

receive map receive data from a terminal via BMS EXEC CICS RECEIVE MAP(name) [MAPSET(name)] [INTO(data-area) | SET(pointer-ref)] [ASIS] END-EXEC. release free virtual storage acquired via a load command EXEC CICS RELEASE PROGRAM(name) ENDEXEC.

resetbr

re-establish position for a browse EXEC CICS RESETBR { DATASET(name) | FILE(name) } RIDFLD(data-area) [KEYLENGTH(data-value) [GENERIC]] [RBA | RRN] [GTEQ | EQUAL] [REQID(data-value)] [SYSID(name)] END-EXEC. retrieves data passed to another program via the start command EXEC CICS RETRIEVE [INTO(data-area) | SET(pointer-ref)] [LENGTH(data-area)] [RTRANSID(data-area)] [RTERMID(data-area)] [QUEUE(data-area)] [WAIT] END-EXEC. return to the invoking program EXEC CICS RETURN

retrieve

return

[TRANSID(name) [COMMAREA(data-area) LENGTH(data-value)]] [IMMEDIATE]] [INPUTMSG(data-area) [INPUTMSGLEN(datavalue)]] END-EXEC. rewrite updates a record in a file EXEC CICS REWRITE { DATASET(name) | FILE(name) } FROM(dataarea) [LENGTH(data-area)] [SYSID(name)] END-EXEC. allows BMS messages to be routed to multiple terminals EXEC CICS ROUTE [LIST(data-area)] [OPCLASS(data-area)] [INTERVAL(hhmmss) | AFTER [HOURS(hh)] [MINUTES(mm)] [SECONDS(ss)] | AT [HOURS(hh)] [MINUTES(mm)]

route

[SECONDS(ss)]] [ERRTERM{(name)]] [TITLE(data-area)] [REQID(name)] [NLEOM] END-EXEC. send send data to a remote process (distributed) EXEC CICS SEND [CONVID(name) | SESSION(name)] [ATTACHID(name)] [FROM(data-area) [LENGTH(data-area) | FLENGTH(data-area)]] [INVITE | LAST] [CONFIRM | WAIT] [STATE(dataarea)] END-EXEC. send (terminal) send data to a terminal EXEC CICS SEND FROM(data-area) [LENGTH(data-area) | FLENGTH(data-area)] [DEST(name)] [WAIT] [INVITE | LAST] [DEFRESP] [STRFIELD]

[ERASE] [CTLCHAR(dataarea)] END-EXEC. send control send device control instructions to a terminal EXEC CICS SEND CONTROL [ERASEAUP | ERASE] [ALARM] [FREEKB] [FRSET] [CURSOR(datavalue)] [PRINT] [FORMFEED] [ACCUM] [PAGING | TERMINAL [WAIT] [LAST]] [L40 | L64 | L80 | HONEOM] [REQID(name)] END-EXEC. send map send data to a terminal via BMS EXEC CICS SEND MAP(name) [MAPSET(name)] [FROM(data-area)] [LENGTH(data-value)] [DATAONLY | MAPONLY] [ERASEAUP | ERASE] [ALARM] [FREEKB]

[FRSET] [CURSOR(datavalue)] [PRINT] [FORMFEED] [NLEOM] [ACCUM] [PAGING | TERMINAL [WAIT]] [LAST] [L40 | L64 | L80 | HONEOM] [REQID(name)] END-EXEC. send page write the last page of a BMS message to temporary storage EXEC CICS SEND PAGE [RELEASE [TRANSID(name)] | RETAIN] [AUTOPAGE | NOAUTOPAGE] [OPERPURGE] [TRAILER(data-area)] END-EXEC. send data to a terminal letting BMS automatically format the data EXEC CICS SEND TEXT FROM(data-area) [LENGTH(data-value)]

send text

[ERASE] [ALARM] [FREEKB] [CURSOR(datavalue)] [PRINT] [FORMFEED] [NLEOM] [ACCUM] [PAGING | TERMINAL [WAIT]] [LAST] [HEADER(data-area)] [TRAILER(data-area)] [JUSTIFY(datavalue) | JUSFIRST | JUSLAST] [L40 | L64 | L80 | HONEOM] [REQID(name)] END-EXEC. send text noedit send data to a terminal similar to terminal control but can direct to temporary storage using paging option EXEC CICS SEND TEXT NOEDIT FROM(data-area) [LENGTH(data-value)] [ERASE] [ALARM] [FREEKB] [PRINT] [PAGING | TERMINAL [WAIT] [LAST]] [L40 | L64 | L80 | HONEOM]

[REQID(name)] END-EXEC. signoff signs the user off cics EXEC CICS SIGNOFF ENDEXEC. signs the user on to cics EXEC CICS SIGNON USERID(datavalue) [PASSWORD(data-value)] [NEWPASSWORD(datavalue)] [OIDCARD(datavalue)] [NATLANG(datavalue)] [natlanginuse(data-area)] [ESMRESP(data-area)] END-EXEC. initiate another task after or at a specified time EXEC CICS START TRANSID(name) [INTERVAL(hhmmss) | TIME(hhmmss) | AFTER [HOURS(hh)] [MINUTES(mm)] [SECONDS(ss)] | AT

signon

start

[HOURS(hh)] [MINUTES(mm)] [SECONDS(ss)]] [TERMID(name)] [SYSID(name)] [REQID(name)] [FROM(data-area) [LENGTH(data-value)]] [RTRANSID(name)] [RTERMID(name)] [QUEUE(name)] [NOCHECK] [PROTECT] END-EXEC. startbr initiate a browse EXEC CICS STARTBR { DATASET(name) | FILE(name) } RIDFLD(data-area) [KEYLENGTH(data-area) [GENERIC]] [SYSID(name)] [RBA | RRN] [GTEQ | EQUAL] [REQID(data-value)] ENDEXEC.

suspend

temporarily return control to cics EXEC CICS SUSPEND ENDEXEC. rollback or make permanent updates applied to protected resources EXEC CICS SYNCPOINT [ROLLBACK] END-EXEC. release a record held by a READ UPDATE command EXEC CICS UNLOCK { DATASET(name) | FILE(name) } [SYSID(name)] END-EXEC.

syncpoint

unlock

wait convid suspend task until accumulated data has been transmitted during an APPC conversation EXEC CICS WAIT CONVID(name) [STATE(data-area)] ENDEXEC. wait event delay the task until a

previously issued POST has expired EXEC CICS WAIT EVENT ECADDR(pointer-value) END-EXEC. wait synchronizes the current task journalnum with a previously written journal entry by suspending the task until the record has been successfully written to the journal file EXEC CICS WAIT JOURNALNUM(data-value) [REQID(data-value)] [STARTIO] END-EXEC. write write a record to a file EXEC CICS WRITE { DATASET(name) | FILE(name) } FROM(dataarea) [LENGTH(data-area)] RIDFLD(data-area) [KEYLENGTH(data-area)] [SYSID(name)] [RBA | RRN] [MASSINSERT] END-

EXEC. write write a record to the journal journalnum file EXEC CICS WRITE JOURNALNUM(data-value) JTYPEID(data-value) FROM(data-area) [LENGTH(data-area)] [PREFIX(data-value) [PFXLENG(data-value)]] [REQID(data-area)] [WAIT] [STARTIO] [NOSUSPEND] END-EXEC. write operator write a message to a system console EXEC CICS WRITE OPERATOR TEXT(datavalue) [TEXTLENGTH(datavalue)] [ROUTECODES(data-value) [NUMROUTES)datavalue)]] [ACTION(datavalue) | EVENTUAL | IMMEDIATE | CRITICAL |

REPLY(data-area) MAXLENGTH(data-value) [REPLYLENGTH(dataarea)] [TIMEOUT(datavalue)]] END-EXEC. writeq td write a record to a transient data queue EXEC CICS WRITEQ TD QUEUE(name) FROM(dataarea) [LENGTH(data-area)] [SYSID(name)] END-EXEC. write a record to a temporary storage queue EXEC CICS WRITEQ TS QUEUE(name) FROM(dataarea) [LENGTH(data-area)] [ITEM(data-value) [REWRITE]] [NUMITEMS(data-area)] [SYSID(name)] [MAIN | AUXILIARY] [NOSUSPEND] END-EXEC. terminate the current program and execute the one specified

writeq ts

xctl

EXEC CICS XCTL PROGRAM(name) [COMMAREA(data-area) [LENGTH(data-value)]] [INPUTMSG(data-area) [INPUTMSGLEN(datavalue)]] END-EXEC.