JCICS API mapping to EXEC CICS API
This reference gives you an overview of JCICS classes and methods and, where applicable, their EXEC CICS API equivalents, categorized according to the function that they perform. Deprecated classes and methods are excluded.
For details of JCICS, see JCICS Javadoc reference. For details of the EXEC CICS API, see CICS command summary.
APPC mapped conversations
Note that APPC unmapped conversation support is not available from the JCICS API.
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| initiate() | AttachInitiator | ALLOCATE, CONNECT PROCESS |
| converse() | Conversation | CONVERSE |
| get*() | Conversation | EXTRACT ATTRIBUTES |
| get*() | Conversation | EXTRACT PROCESS |
| free() | Conversation | FREE |
| issueAbend() | Conversation | ISSUE ABEND |
| issueConfirmation() | Conversation | ISSUE CONFIRMATION |
| issueError() | Conversation | ISSUE ERROR |
| issuePrepare() | Conversation | ISSUE PREPARE |
| issueSignal() | Conversation | ISSUE SIGNAL |
| receive() | Conversation | RECEIVE |
| send() | Conversation | SEND |
| flush() | Conversation | WAIT CONVID |
Basic Mapping Support (BMS)
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| sendControl() | TerminalPrincipalFacility | SEND CONTROL |
| sendText() | TerminalPrincipalFacility | SEND TEXT |
| No equivalent | Not supported | SEND MAP, RECEIVE MAP |
Channels and containers
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| createContainer() | Channel | No equivalent |
| delete() | Channel | DELETE CHANNEL |
| deleteContainer() | Channel | DELETE CONTAINER CHANNEL |
| getContainer() | Channel | No equivalent |
| getContainerCount() | Channel | QUERY CHANNEL |
| getContainerNames() | Channel | No equivalent |
| getName() | Channel | No equivalent |
| isContainerExistenceCheckingEnabled() | Channel | No equivalent |
| setContainerExistenceCheckingEnabled() | Channel | No equivalent |
| toString() | Channel | No equivalent |
| append() | Container | PUT64 CONTAINER APPEND |
| appendString() | Container | PUT64 CONTAINER APPEND |
| delete() | Container | DELETE CONTAINER CHANNEL |
| exists() | Container | No equivalent |
| get() | Container | GET64 CONTAINER |
| getCCSID() | Container | No equivalent |
| getDatatype() | Container | No equivalent |
| getLength() | Container | GET CONTAINER CHANNEL NODATA |
| getLengthNoConvert() | Container | No equivalent |
| getName() | Container | No equivalent |
| getNoConvert() | Container | No equivalent |
| getString() | Container | GET64 CONTAINER |
| prepend() | Container | PUT64 CONTAINER PREPEND |
| prependString() | Container | PUT64 CONTAINER PREPEND |
| put() | Container | PUT64 CONTAINER |
| putString() | Container | PUT64 CONTAINER |
| link() | Program | LINK |
| setNextChannel() | TerminalPrincipalFacility | RETURN CHANNEL |
| issue() | StartRequest | START CHANNEL |
| createChannel() | Task | No equivalent |
| getCurrentChannel() | Task | ASSIGN CHANNEL |
Diagnostic services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| No equivalent | Not supported | DUMP TRANSACTION |
| enterTrace() | EnterRequest | ENTER TRACENUM |
Document services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| create*() | Document | DOCUMENT CREATE |
| append*() | Document | DOCUMENT INSERT |
| insert*() | Document | DOCUMENT INSERT |
| addSymbol() | Document | DOCUMENT SET |
| setSymbolList() | Document | DOCUMENT SET |
| retrieve*() | Document | DOCUMENT RETRIEVE |
| get*() | Document | DOCUMENT |
Environment services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| getABCODE() | AbendException | ASSIGN |
| getApplicationContext() | Task | ASSIGN |
| getAPPLID() | Region | ASSIGN |
| getCurrentChannel() | Task | ASSIGN |
| getCWA() | Region | ADDRESS |
| setCWA() | Region | ADDRESS |
| getName() | TerminalPrincipalFacility ConversationPrincipalFacility |
ASSIGN |
| getFCI() | Task | ASSIGN |
| getNetName() | TerminalPrincipalFacility ConversationPrincipalFacility |
ASSIGN |
| getPrinSysid() | TerminalPrincipalFacility ConversationPrincipalFacility |
ASSIGN |
| getProgramName() | Task | ASSIGN |
| getStartCode() | Task | ASSIGN |
| getSYSID() | Region | ASSIGN |
| getTCTUA() | TerminalPrincipalFacility | ASSIGN |
| getTERMCODE() | TerminalPrincipalFacility | ASSIGN |
| getTWA() | Task | ADDRESS |
| setTWA() | Task | ADDRESS |
| getUSERID() |
Task Terminal TerminalPrincipalFacility ConversationPrincipalFacility |
ASSIGN |
| getTransactionName() | Task | EIBTRNID |
| getUser() | Terminal | ASSIGN |
| verifyPhrase() | Security | VERIFY PHRASE |
File services for keyed files
The following tables show how the JCICS classes and methods map to the EXEC CICS API commands for each type of CICS® file and index. In these tables, the check mark ✓ indicates whether a method in a class is applicable to a specific file type.
| Methods | JCICS class | KSDS primary or secondary index | ESDS secondary index | EXEC CICS commands |
|---|---|---|---|---|
| read() | KeyedFile† | ✓ | ✓ | READ |
| readForUpdate() | KeyedFile† | ✓ | ✓ | READ UPDATE |
| readGeneric() | KeyedFile† | ✓ | ✓ | READ GENERIC |
| rewrite() | KeyedFile† | ✓ | ✓ | REWRITE |
| write() | KSDS | ✓ | ✓ | WRITE |
| delete() | KSDS | ✓ | Not applicable | DELETE |
| deleteGeneric() | KSDS | ✓ | Not applicable | DELETE GENERIC |
| unlock() | KeyedFile† | ✓ | ✓ | UNLOCK |
| startBrowse() | KeyedFile† | ✓ | ✓ | STARTBR |
| startGenericBrowse() | KeyedFile† | ✓ | ✓ | STARTBR GENERIC |
| next() | KeyedFileBrowse† | ✓ | ✓ | READNEXT |
| previous() | KeyedFileBrowse† | ✓ | ✓ | READPREV |
| reset() | KeyedFileBrowse† | ✓ | ✓ | RESET BROWSE |
| end() | FileBrowse† | ✓ | ✓ | ENDBR |
†When you perform this KeyedFile operation, it is preferable to use the appropriate KSDS, ESDS, KSDS_Browse, or ESDS_Browse subclass.
File services for non-keyed files
The following tables show how the JCICS classes and methods map to the EXEC CICS API commands for each type of CICS file and index. In these tables, the check mark ✓ indicates whether a method in a class is applicable to a specific file type.
| Methods | JCICS class | ESDS primary index | RRDS primary index | EXEC CICS commands |
|---|---|---|---|---|
| read() | ESDS | ✓ | Not applicable | READ |
| read() | RRDS | Not applicable | ✓ | READ |
| readForUpdate() | ESDS | ✓ | Not applicable | READ UPDATE |
| readForUpdate() | RRDS | Not applicable | ✓ | READ UPDATE |
| rewrite() | ESDS | ✓ | Not applicable | REWRITE |
| rewrite() | RRDS | Not applicable | ✓ | REWRITE |
| write() | ESDS | ✓ | Not applicable | WRITE |
| write() | RRDS | Not applicable | ✓ | WRITE |
| delete() | RRDS | Not applicable | ✓ | DELETE |
| unlock() | KeyedFile | ✓ | Not applicable | UNLOCK |
| unlock() | RRDS | Not applicable | ✓ | UNLOCK |
| startBrowse() | ESDS | ✓ | Not applicable | STARTBR |
| startBrowse() | RRDS | Not applicable | ✓ | STARTBR |
| next() | ESDS_Browse | ✓ | Not applicable | READNEXT |
| next() | RRDS_Browse | Not applicable | ✓ | READNEXT |
| previous() | ESDS_Browse | ✓ | Not applicable | READPREV |
| previous() | RRDS_Browse | Not applicable | ✓ | READPREV |
| reset() | ESDS_Browse | ✓ | Not applicable | RESET BROWSE |
| reset() | RRDS_Browse | Not applicable | ✓ | RESET BROWSE |
| end() | FileBrowse | ✓ | ✓ | ENDBR |
| setXRBA() | ESDS | ✓ | Not applicable | No equivalent |
HTTP and TCP/IP services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| get*() | CertificateInfo | EXTRACT CERTIFICATE / EXTRACT TCPIP |
| get*() | HttpRequest | EXTRACT WEB |
| getHeader() | HttpRequest | WEB READ HTTPHEADER |
| getFormField() | HttpRequest | WEB READ FORMFIELD |
| getContent() | HttpRequest | WEB RECEIVE |
| getQueryParm() | HttpRequest | WEB READ QUERYPARM |
| startBrowseHeader() | HttpRequest | WEB STARTBROWSE HTTPHEADER |
| getNextHeader() | HttpRequest | WEB READNEXT HTTPHEADER |
| endBrowseHeader() | HttpRequest | WEB ENDBROWSE HTTPHEADER |
| startBrowseFormField() | HttpRequest | WEB STARTBROWSE FORMFIELD |
| getNextFormField() | HttpRequest | WEB READNEXT FORMFIELD |
| endBrowseFormField() | HttpRequest | WEB ENDBROWSE FORMFIELD |
| startBrowseQueryParm() | HttpRequest | WEB STARTBROWSE QUERYPARM |
| getNextQueryParm() | HttpRequest | WEB READNEXT QUERYPARM |
| endBrowseQueryParm() | HttpRequest | WEB ENDBROWSE QUERYPARM |
| writeHeader() | HttpResponse | WEB WRITE |
| getDocument() | HttpResponse | No equivalent |
| getCurrentDocument() | HttpResponse | No equivalent |
| sendDocument() | HttpResponse | WEB SEND |
Program services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| link() | Program | LINK |
| setNextTransaction() | TerminalPrincipalFacility | No equivalent |
| setNextCOMMAREA() | TerminalPrincipalFacility | No equivalent |
| setNextChannel() | TerminalPrincipalFacility | No equivalent |
| invoke() | Application | INVOKE APPLICATION |
Scheduling services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| cancel() | StartRequest | CANCEL |
| retrieve() | Task | RETRIEVE |
| issue() | StartRequest | START |
Serialization services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| dequeue() | SynchronizationResource | DEQ |
| enqueue() | SynchronizationResource | ENQ |
| tryEnqueue() | SynchronizationResource | ENQ |
Temporary storage queue services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| delete() | TSQ | DELETEQ TS |
| readItem() | TSQ | READQ TS |
| readNextItem() | TSQ | READQ TS |
| writeItem() | TSQ | WRITEQ TS |
| rewriteItem() | TSQ | WRITEQ TS |
| writeItemConditional() | TSQ | WRITEQ TS |
| rewriteItemConditional() | TSQ | WRITEQ TS |
Terminal services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| converse() | TerminalPrincipalFacility | CONVERSE |
| Not supported | HANDLE AID | |
| receive() | TerminalPrincipalFacility | RECEIVE |
| send() | TerminalPrincipalFacility | SEND |
| Not supported | WAIT TERMINAL | |
| writeOperator() | Task | WRITE OPERATOR |
Transforming between data and XML
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| SetName | XmlTransform | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| dataToXML | Transform | TRANSFORM DATATOXML |
| xmltoData | Transform | TRANSFORM XMLTODATA |
| setChannel | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| setDataContainer | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| setElementName | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| setElementNamespace | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| setNsContainer | TransformInput | TRANSFORM XMLTODATA |
| setTypeName | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| setTypeNamespace | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| setXmlContainer | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| setXmltransform | TransformInput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| getElementName | TransformOutput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| getElementNamespace | TransformOutput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| getTypeName | TransformOutput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
| getTypeNamespace | TransformOutput | TRANSFORM DATATOXML TRANSFORM XMLTODATA |
Transient data queue services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| delete() | TDQ | DELETEQ TD |
| readData(), readDataConditional() | TDQ | READQ TD |
| writeData() | TDQ | WRITEQ TD |
Unit of work (UOW) services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| commit() | Task | SYNCPOINT |
| rollback() | Task | SYNPOINT ROLLBACK |
Web services
| Methods | JCICS class | EXEC CICS commands |
|---|---|---|
| invoke() | WebService | INVOKE WEBSERVICE |
| create() | SoapFault | SOAPFAULT CREATE |
| addFaultString() | SoapFault | SOAPFAULT ADD FAULTSTRING |
| addSubCode() | SoapFault | SOAPFAULT ADD SUBCODESTR |
| delete() | SoapFault | SOAPFAULT DELETE |
| create() | WSAEpr | WSAEPR CREATE |
| delete() | WSAContext | WSACONTEXT DELETE |
| set*() | WSAContext | WSACONTEXT BUILD |
| get*() | WSAContext | WSACONTEXT GET |