CICS Commands and Parameters Coverage

CICS Commands and Parameters Coverage

•	Supported CICS Commands

•	Supported EIB Fields

•	Supported BMS Macros

•	Supported ECI C API Parameters

Supported CICS Commands

The following tables describe the CICS commands and parameters that are supported by Oracle Tuxedo ART for CICS.

Note:

Commands and parameters not listed in Table 12‑1 and Table 12‑2 are not supported.

CICS Command and Parameter Support Table

 

Table 12‑1 CICS Command (COBOL Support)

Category	CICS Command	Command Parameter	Notes
ABEND	ABEND	ABCODE(name)
		CANCEL
	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)
APPC Mapped conversation	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)
BMS	PURGE MESSAGE		Not supported by ARTWTRN/ARTWTR1
	RECEIVE MAP	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
BMS	SEND MAP	ACCUM	Not supported by ARTWTRN/ARTWTR1
		ALARM
		CURSOR(data-value)
		DATAONLY	Not supported by ARTWTRN/ARTWTR1
		DEFAULT
		ERASE
		ERASEAUP
		FREEKB
		FROM(data-area)
		FRSET
		LENGTH(data-value)
		MAP(name)
		MAPONLY	Not supported by ARTWTRN/ARTWTR1
		MAPSET(name)
		PRINT
		NOFLUSH	Not supported by ARTWTRN/ARTWTR1
		TERMINAL
		WAIT
BMS	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)
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		• All its options are recognized by ART CICS. • ENTER TRACENUM was written as ENTER TRACEID in Mainframe CICS v3 or earlier.
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)
Environment services	ASSIGN	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
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	• Not supported in File2File when using COBOL-IT. • DELETE RBA can only be used in KSDS dataset.
		RIDFLD(data-area)
		SYSID(systemname)	Recognized
	ENDBR	DATASET(filename)
		FILE(filename)
		REQID(data-value)	Recognized
		SYSID(systemname)	Recognized
File Control Services	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	Not supported in File2File when using COBOL-IT.
		RIDFLD(data-area)
		RRN	Recognized
		SET(ptr-ref)
		SYSID(systemname)	Recognized
		UPDATE	Recognized
File Control Services	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
File Control Services	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
File Control Services	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)
File Control Services	WRITE	DATASET(filename)
		FILE(filename)
		FROM(data-area)
		KEYLENGTH(data-value)
		LENGTH(data-value)
		RBA	• Not supported in File2File when using COBOL-IT. • WRITE RBA can only be used in ESDS dataset.
		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)
Interval Control Services	DELAY	FOR
		HOURS(data-value)
		INTERVAL(hhmmss)	The default value is INTERVAL(0).
		MINUTES(data-value)
		REQID(name)
		SECONDS(data-value)
		TIME(hhmmss)
Interval Control Services	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)
Interval Control Services	RETRIEVE	INTO(data-area)
		LENGTH(data-area)
		QUEUE(data-area)
		RTERMID(data-area)
		RTRANSID(data-area)
		SET(ptr-ref)
Interval Control Services	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	Recognized
		PROTECT
		QUEUE(name)	This option cannot be used with TERMID.
		REQID(name)
		RTERMID(name)
		RTRANSID(name)
		SECONDS(data-value)
Interval Control Services	START	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/QUEUE option for the START TRANSID command.
		USERID(data-value)	The security stub is called with USERID and TRANSID.
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)
LUTYPE6.1 Conversation	SEND (LUTYPE6.1)	FLENGTH(data-value)
		FROM(data-area)
		INVITE
		LAST
		LENGTH(data-value)
		SESSION(name)
		WAIT
Program Control	LINK	CHANNEL(name)
		COMMAREA(data-area)
		LENGTH(data-value)
		PROGRAM(name)
		SYNCONRETURN
		SYSID(systemname)
	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	DELETE	Recognized
		TOKEN(data-area)
	SPOOLOPEN OUTPUT	ASA	Recognized
		CLASS(data-value)
		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.
		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)
	FREEMAIN	DATA(data-area)
		DATAPOINTER(ptr-value)
Syncpoint	SYNCPOINT
	SYNCPOINT ROLLBACK	ROLLBACK
System Commands	INQUIRE CONNECTION	ACCESSMETHOD(cvda)	Only VTAM is returned.
		CONNSTATUS(cvda)(APPC and MRO only)	Only ACQUIRED is returned. CONNSTATUS equals to ACQSTATUS.
		NETNAME(data-area)
	INQUIRE NETNAME		• For all other supported INQUIRE NETNAME options, please refer to INQUIRE TERMINAL. • Only support for terminals in the same CICS region.
	INQUIRE SYSTEM	JOBNAME(data-area)
		SHUTSTATUS(cvda)	Only NOTAPPLIC is returned.
	INQUIRE TERMINAL	ACCESSMETHOD(cvda)	• Partial CVDA values are supported for the following options: – ACCESSMETHOD: VTAM – CREATESESS: NOCREATE – REMOTESYSTEM: Blank – SERVSTATUS: INSERVICE and OUTSERVICE – TRACING: STANTRACE • Only support for terminals in the same CICS region.
		ALTSUFFIX(data-area)
		ACQSTATUS(cvda)(VTAM only)
		CREATESESS(cvda)(VTAM only)
		NETNAME(data-area)
		NEXTTRANSID(data-area)
		REMOTESYSTEM(data-area)
		SERVSTATUS(cvda)
		SIGNONSTATUS(cvda)
		TRACING(cvda)
		TRANSACTION(data-area)
		USERID(data-area)
System Commands	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)
	SET CONNECTION	CONNSTATUS(cvda) (APPC only)	• Recognized. • CONNSTATUS equals to ACQSTATUS.
	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)(VSAM only)	Only 0 is returned.
		MAXNUMRECS(data-area)(data tables only)	Only 0 is returned.
		OPENSTATUS(cvda)
		TABLE(cvda)(VSAM and CFDT only)	Only NOTTABLE is returned.
		TYPE(cvda)
System Commands	INQUIRE PROGRAM	RESCOUNT(data-area)	To use this option, RESCOUNT-STAT must be set to ENABLED in programs.desc.
	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 TERMINAL Note: The terminals must be in the same CICS region.	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)	The supported CVDA values are TASK and UOW.
		RESOURCE(data-area)
	ENQ	LENGTH(data-value)	Mandatory, only the enqueues and dequeues on data values are supported, not the enqueues on address.
		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)	Recognized
Temporary Storage	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
		ALTERNATE
		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)
Terminal Control	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	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)
Terminal Control	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
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)

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, and NOHANDLE are supported on all commands.

•	Recognized parameters are processed by the pre-processor and have no effect on the behavior of CICS Runtime.

 

Table 12‑2 CICS Command (C Support)

Category	CICS Command	Command Parameter	Notes
Environment services	ADDRESS	EIB (ptr-ref)
		COMMAREA (ptr-ref)
Interval Control Services	RETRIEVE	INTO (data-area)
		LENGTH (data-value)
Program Control	LINK	COMMAREA(data-area)
		LENGTH(data-value)
		PROGRAM(name)
	RETURN
Terminal Control	RECEIVE	INTO (data-area)
		LENGTH (data-value)
Transient Data	WRITEQ TD	FROM(data-area)
		LENGTH(data-value)
		QUEUE(name)

External Interface for Write Operator

The "WRITE OPERATOR" function calls a "stub" named ExternWriteOperator.

ExternWriteOperator receives all parameters of the WRITE OPERATOR and simply returns zero in the return code and nothing else.

It can be replaced by a customer function that respects the interface described below.

The WRITE OPERATOR passes the following parameters and expects a return code in signed int format.

Listing 12‑1 WRITE OPERATOR Parameters

TEXT pic x(1024).

TEXTLENGTH PIC S9(9) COMP-5.

ROUTECODES pic x(1024).

NUMROUTES PIC S9(9) COMP-5.

ACTION PIC X(2).

REPLY pic x(1024).

MAXLENGTH PIC S9(9) COMP-5.

REPLYLENGTH PIC S9(9) COMP-5.

TIMEOUT PIC S9(9) COMP-5.

 

S9(9) COMP-5 is equivalent to a signed int.

The parameters REPLY and REPLYLENGTH may be returned to the WRITE OPERATOR function if requested, that is to say, if MAXLENGTH > zero.

Example COBOl Code for ExternWriteOperator

Listing 12‑2 Example ExternWriteOperator.cbl Code

IDENTIFICATION DIVISION.

PROGRAM-ID. "ExternWriteOperator".

DATA DIVISION.

WORKING-STORAGE SECTION.

copy "ctypes".

01 ret-code usage int.

LINKAGE SECTION.

01 LK-TEXT pic x(1024).

01 LK-TEXTLENGTH PIC S9(9) COMP-5.

01 LK-ROUTECODES pic x(1024).

01 LK-NUMROUTES PIC S9(9) COMP-5.

01 LK-ACTION PIC X(2).

01 LK-REPLY pic x(1024).

01 LK-MAXLENGTH PIC S9(9) COMP-5.

01 LK-REPLYLENGTH PIC S9(9) COMP-5.

01 LK-TIMEOUT PIC S9(9) COMP-5.

 

PROCEDURE DIVISION USING LK-TEXT LK-TEXTLENGTH LK-ROUTECODES

LK-NUMROUTES LK-ACTION LK-REPLY

LK-MAXLENGTH LK-REPLYLENGTH LK-TIMEOUT.

 

 

* * display "ExternWriteOperator : LK-TEXT =<" LK-TEXT ">"

* * display "ExternWriteOperator : LK-TEXTLENGTH =<" LK-TEXTLENGTH ">"

* * display "ExternWriteOperator : LK-ROUTECODES =<" LK-ROUTECODES ">"

* * display "ExternWriteOperator : LK-NUMROUTES =<" LK-NUMROUTES ">"

* * display "ExternWriteOperator : LK-ACTION =<" LK-ACTION ">"

* * display "ExternWriteOperator : LK-REPLY =<" LK-REPLY ">"

* * display "ExternWriteOperator : LK-MAXLENGTH =<" LK-MAXLENGTH ">"

* * display "ExternWriteOperator : LK-REPLYLENGTH =<" LK-REPLYLENGTH ">"

* * display "ExternWriteOperator : LK-TIMEOUT =<" LK-TIMEOUT ">"

 

* * in case of REPLY

if LK-MAXLENGTH > zero

* * move "..............." to LK-REPLY

* * move 15 to LK-REPLYLENGTH

end-if

 

move zero to ret-code

* * return code

* * 0 = OK

* * -1 = operation failed (INVREC wil returned to the user program)

* * -9 = time out ocurred before the operators's reply was received

 

 

GOBACK returning ret-code.

External Interface for Query Security

The "QUERY SECURITY" function calls a “stub” named ExternQuerySecurity.

The delivered ExternQuerySecurity stub receives all parameters of the QUERY SECURITY, it always allows access to the resources and returns zero in the return code. It can be replaced by a customer function that respects the interface described below.

The QUERY SECURITY passes the following parameters:

Listing 12‑3 Query Security Extern Inteface

restype pic x(7).

restype-data-value pic x(12).

resclass pic x(8).

resclass-data-value pic x(8).

residlength pic x(11).

residlength-data-value pic s9(8) comp-5.

resid pic x(5).

resid-data-value pic x(246).

logmessage pic x(10).

logmessage-cvda pic s9(8) comp-5.

read pic x(10).

read-cvda pic s9(8) comp-5.

update pic x(10).

update-cvda pic s9(8) comp-5.

control pic x(10).

control-cvda pic s9(8) comp-5.

alter pic x(10).

alter-cvda pic s9(8) comp-5.

resp pic s9(8) comp-5.

resp2 pic s9(8) comp-5.

userid                      pic x(8).

All parameters are passed to ExternQuerySecurity, only the following parameters are expected in return:

read-cvda pic s9(8) comp-5.

update-cvda pic s9(8) comp-5.

control-cvda pic s9(8) comp-5.

alter-cvda pic s9(8) comp-5.

resp pic s9(8) comp-5.

resp2 pic s9(8) comp-5.

If "read" is fulfilled with "READ", read-cvda is expected.

If "update" is fulfilled with "READ", update-cvda is expected.

If "control" is fulfilled with "READ", control-cvda is expected.

If "alter" is fulfilled with "READ", alter-cvda is expected.

"resp" and "resp2" are always expected.

Note:

Each interface field is ended by a binary zero, it easier if you want write the "ExternQuerySecurity" in C.

The cvda values for "read" are:

READABLE 35.

NOTREADABLE 36.

The cvda values for "update" are:

UPDATABLE 37.

NOTUPDATABLE 38.

The cvda values for "control" are:

CTRLABLE 56.

NOTCTRLABLE 57.

The cvda values for "alter" are:

ALTERABLE 52.

NOTALTERABLE 53.

For more details, see cvda values in IBM documentation.

S9(9) COMP-5 is equivalent to a signed int.

Example COBOl Code for ExternQuerySecurity

Listing 12‑4 Example COBOL Code for ExternQuerySecurity

IDENTIFICATION DIVISION.

PROGRAM-ID. "ExternQuerySecurity".

DATA DIVISION.

WORKING-STORAGE SECTION.

copy "ctypes".

01 ret-code usage int.

01 cvda-logmessage pic s9(8) comp-5.

88 LOG value 54.

88 NOLOG value 55.

01 cvda-read pic s9(8) comp-5.

88 READABLE value 35.

88 NOTREADABLE value 36.

01 cvda-update pic s9(8) comp-5.

88 UPDATABLE value 37.

88 NOTUPDATABLE value 38.

01 cvda-control pic s9(8) comp-5.

88 CTRLABLE value 56.

88 NOTCTRLABLE value 57.

01 cvda-alter pic s9(8) comp-5.

88 ALTERABLE value 52.

88 NOTALTERABLE value 53.

LINKAGE SECTION.

01 LK-restype pic x(7).

01 LK-restype-data-value pic x(12).

01 LK-resclass pic x(8).

01 LK-resclass-data-value pic x(8).

01 LK-residlength pic x(11).

01 LK-residlength-data-value pic s9(8) comp-5.

01 LK-resid pic x(5).

01 LK-resid-data-value pic x(246).

01 LK-logmessage pic x(10).

01 LK-logmessage-cvda pic s9(8) comp-5.

01 LK-read pic x(10).

01 LK-read-cvda pic s9(8) comp-5.

01 LK-update pic x(10).

01 LK-update-cvda pic s9(8) comp-5.

01 LK-control pic x(10).

01 LK-control-cvda pic s9(8) comp-5.

01 LK-alter pic x(10).

01 LK-alter-cvda pic s9(8) comp-5.

01 LK-resp pic s9(8) comp-5.

01 LK-resp2 pic s9(8) comp-5.

       01 LK-userid                      pic x(8).

PROCEDURE DIVISION USING LK-restype

LK-restype-data-value

LK-resclass

LK-resclass-data-value

LK-residlength

LK-residlength-data-value

LK-resid

LK-resid-data-value

LK-logmessage

LK-logmessage-cvda

LK-read

LK-read-cvda

LK-update

LK-update-cvda

LK-control

LK-control-cvda

LK-alter

LK-alter-cvda

LK-resp

LK-resp2

                                LK-userid

.

* * display "ExternQuerySecurity : LK-restype =" LK-restype

* * display "ExternQuerySecurity : LK-restype-data-value =" LK-restype-data-value

* * display "ExternQuerySecurity : LK-resclass =" LK-resclass

* * display "ExternQuerySecurity : LK-resclass-data-value =" LK-resclass-data-value

* * display "ExternQuerySecurity : LK-residlength =" LK-residlength

* * display "ExternQuerySecurity : LK-residlength-data-value=" LK-residlength-data-value

* * display "ExternQuerySecurity : LK-resid =" LK-resid

* * display "ExternQuerySecurity : LK-resid-data-value =" LK-resid-data-value

* * display "ExternQuerySecurity : LK-logmessage =" LK-logmessage

* * display "ExternQuerySecurity : LK-logmessage-cvda =" LK-logmessage-cvda

* * display "ExternQuerySecurity : LK-read =" LK-read

* * display "ExternQuerySecurity : LK-read-cvda =" LK-read-cvda

* * display "ExternQuerySecurity : LK-update =" LK-update

* * display "ExternQuerySecurity : LK-update-cvda =" LK-update-cvda

* * display "ExternQuerySecurity : LK-control =" LK-control

* * display "ExternQuerySecurity : LK-control-cvda =" LK-control-cvda

* * display "ExternQuerySecurity : LK-alter =" LK-alter

* * display "ExternQuerySecurity : LK-alter-cvda =" LK-alter-cvda

* * display "ExternQuerySecurity : LK-resp =" LK-resp

* * display "ExternQuerySecurity : LK-resp2 =" LK-resp2

 

 

if address of LK-read not = null

if LK-read = "READ"

set READABLE to true

move cvda-read to LK-read-cvda

end-if

end-if

if address of LK-update not = null

if LK-update = "UPDATE"

set UPDATABLE to true

move cvda-update to LK-update-cvda

end-if

end-if

if address of LK-control not = null

if LK-control = "CONTROL"

set CTRLABLE to true

move cvda-control to LK-control-cvda

end-if

end-if

if address of LK-alter not = null

if LK-alter = "ALTER"

set ALTERABLE to true

move cvda-alter to LK-alter-cvda

end-if

end-if

 

move zero to LK-resp LK-resp2

 

move zero to ret-code

* * return code

* * 0 = OK

* * -1 = operation failed (INVREC wil returned to the user program)

 

GOBACK returning ret-code.

 

 

Developing the ExternQuerySecurity in C

1.	Use this interface:

int ExternQuerySecurity(char *restype, char *restype_data_value, char *resclass, char *resclass_data_value, char *residlength, int *residlength_data_value, char *resid, char *resid_data_value, char *logmessage, int *logmessage_cvda, char *read, int *read_cvda, char *update, int *update_cvda, char *control, int *control_cvda, char *alter, int *alter_cvda, int *resp, int *resp2, char *userid);

2.	Generate an "ExternQuerySecurity.o", and link it in ART servers (STRN, STR1, ATRN, ATR1, CTRN, CTR1).

3.	In the makefile_intg (Cics_Rt/tools), add the "ExternQuerySecurity.o" in object variables for each server (STRN_OBJS, STR1_OBJS, ATRN_OBJS, ATR1_OBJS, CTRN_OBJS, CTR1_OBJS)

4.	Execute the makefile to rebuild these servers.

Supported EIB Fields

The following table describes the EIB fields that are supported by Oracle Tuxedo ART for CICS.

 

Table 12‑3 Supported EIB Fields

EIB fields	Notes
EIBAID
EIBATT	Recognized
EIBCALEN
EIBCOMPL	Recognized
EIBCONF	Recognized
EIBCPOSN
EIBDATE
EIBDS
EIBEOC	Recognized
EIBERR	Recognized
EIBERRCD	Recognized
EIBFMH	Recognized
EIBFN
EIBFREE	Recognized
EIBNODAT	Recognized
EIBRCODE
EIBRECV
EIBREQID
EIBRESP
EIBRESP2
EIBRLDBK	Recognized
EIBRSRCE
EIBSIG	Recognized
EIBSYNC	Recognized
EIBSYNRB	Recognized
EIBTASKN
EIBTIME
EIBTRMID
EIBTRNID

Supported BMS Macros

The following describes the BMS Macros that are supported by Oracle Tuxedo ART for CICS.

•	Mapset DFHMSD

•	Map DFHMDI

•	Field DFHMDF

Mapset DFHMSD

TYPE=(Choose only one from list)

SYSPARM (recognized)

DSECT (recognized)

MAP (recognized)

FINAL

Note:

recognized means function is not achieved, but there are no errors when doing MAPGEN compilation.

MODE=(Choose only one from list)

OUT

IN

INOUT

LANG=(Choose only one from list)

COBOL

PLI

C

STORAGE=AUTO

BASE=NAME

CTRL=(Choose any combination from the list, separate with a comma)

FREEKB

ALARM

FRSET

EXTATT=(Choose only one from list)

NO

MAPONLY

YES

COLOR=(Choose only one from list)

DEFAULT

Color

HILIGH=(Choose only one from list)

OFF

BLINK

REVERSE

UNDERLINE

PS=(Choose only one from list)

Psid

TERM=3270-2

SUFFIX=(One alphanumeric character or blank)

MAPATTS=(Choose any combination from list, separate with a comma)

COLOR

HILIGHT

OUTLINE

PS

SOSI

DSATTS=(Choose any combination from list, separate with a comma)

COLOR

HILIGHT

OUTLINE

PS

SOSI

OUTLINE=(Choose only one from list)

BOX

LEFT

LEFT,RIGHT

LEFT,OVER

LEFT,UNDER

LEFT,RIGHT,OVER

LEFT,RIGHT,UNDER

LEFT,RIGHT,OVER,UNDER

RIGHT

RIGHT,OVER

RIGHT,UNDER

RIGHT,OVER,UNDER

OVER

OVER,UNDER

UNDER

SOSI=(Choose only one from list)

YES

NO

Map DFHMDI

SIZE=(line,column)

CTRL=(Choose any combination from the list, separate with a comma)

FREEKB

ALARM

FRSET

EXTATT=(Choose only one from list)

NO

MAPONLY

YES

COLOR=(Choose only one from list)

DEFAULT

Color

HILIGHT=(Choose only one from list)

OFF

BLINK

REVERSE

UNDERLINE

PS=(Choose only one from list)

psid

MAPATTS=(Choose any combination from list, separate with a comma)

COLOR

HILIGHT

OUTLINE

PS

SOSI

DSATTS=(Choose any combination from list, separate with a comma)

COLOR

HILIGHT

OUTLINE

PS

SOSI

OUTLINE=(Choose only one from list)

BOX

LEFT

LEFT,RIGHT

LEFT,OVER

LEFT,UNDER

LEFT,RIGHT,OVER

LEFT,RIGHT,UNDER

LEFT,RIGHT,OVER,UNDER

RIGHT

RIGHT,OVER

RIGHT,UNDER

RIGHT,OVER,UNDER

OVER

OVER,UNDER

UNDER

SOSI=(Choose only one from list)

YES

NO

COLUMN=(Choose only one from list)

SAME

Number

NEXT

LINE=(Choose only one from list)

SAME

Number

NEXT

JUSTIFY=(Choose only one from list)

LEFT

LEFT,FIRST

LEFT,LAST

RIGHT

RIGHT,FIRST

RIGHT,LAST

BOTTOM

HEADER=YES

TRAILER=YES

Field DFHMDF

CASE=MIXED

POS=(Choose only one from list)

Number

Line,Column

LENGTH=number

JUSTIFY=(Choose only one from list)

LEFT

LEFT,BLANK

LEFT,ZERO

RIGHT

RIGHT,BLANK

RIGHT,ZERO

INITIAL='char-data'

XINIT='hex-data'

GINIT='DBCS-characters'

ATTRB=(parameter group A, parameter B, parameter group C)

Choose exactly one from parameter group A:

ASKIP

PROT

UNPROT

UNPROT,NUM

Choose zero or one from parameter group B:

BRT

NORM

DRK

Choose any combination (0 to all) from parameter group C; this group is allowed only if parameter from gourp B is also used:

IC

FSET

COLOR=(Choose only one from list)

DEFAULT

Color

PS=(Choose only one from list)

Psid

HILIGHT=(Choose only one from list)

OFF

BLINK

REVERSE

UNDERLINE

GRPNAME=group-name

OCCURS=number

PICIN='value'

PICOUT='value'

OUTLINE=(Choose only one from list)

BOX

LEFT

LEFT,RIGHT

LEFT,OVER

LEFT,UNDER

LEFT,RIGHT,OVER

LEFT,RIGHT,UNDER

LEFT,RIGHT,OVER,UNDER

RIGHT

RIGHT,OVER

RIGHT,UNDER

RIGHT,OVER,UNDER

OVER

OVER,UNDER

UNDER

SOSI=(Choose only one from list)

YES

NO

Supported ECI C API Parameters

The following table describes the ECI C API parameters that are supported by Oracle Tuxedo ART for CICS.

Notes:

Only ECI v1 API CICS_ExternalCall (ECI_Parms) is supported.

 

Table 12‑4 ECI C API Parameters

Call Type	Parameter	Notes
ECI_SYNC / ECI_ASYNC	eci_call_type
	eci_program_name	eci_program_name is the program name defined in programs.desc in ART CICS.
	eci_userid	If security is not enabled on ART CICS side, eci_userid is not checked on ECI Emulator.
	eci_password	If security is not enabled on ART CICS side, eci_password is not checked on ECI Emulator.
	eci_extend_mode
	eci_luw_token
	eci_version
	eci_commarea
	eci_commarea_length
	eci_system_name	It cannot be NULL since no default system name is allowed.
	eci_userid2
	eci_password2
	eci_timeout
ECI_GET_REPLY	eci_call_type
	eci_commarea
	eci_commarea_length
	eci_version