Module cics 

The CICS region a harness run stands in for: one task, its files, its temporary-storage and transient-data queues, and the time services; and the commands a program runs against it, as CicsCommands the executor builds and run carries out.

Structs

AbendExit

The program level’s HANDLE ABEND exit, which CANCEL and entering it deactivate and RESET reactivates.

Assign

The ASSIGN options ironwork answers.

At

A command’s name as written, which messages give, its RESP, RESP2 and NOHANDLE, and where it is.

Browse

A browse’s position: the key it is at, and whether the record there is itself next (after STARTBR or RESETBR) or was the last returned.

CicsCommand

Control

SEND MAP’s and SEND CONTROL’s write command and write control character options.

FileDef

A file-control table entry: a CICS FILE name’s data set, given with –file.

FileOptions

Handlers

HANDLE CONDITION, IGNORE CONDITION and HANDLE ABEND, which belong to the program level.

Record

Where a record read arrives: INTO, or SET’s pointer; LENGTH, which also limits it. WRITE’s LENGTH is the same option.

Resp

RESP, RESP2 and NOHANDLE, which decide what raising a condition does.

Task

The task: who and what started it, and the resources it has touched.

Transfer

LINK’s and XCTL’s options.

TsQueue

A temporary-storage queue: its items (item numbers start at 1) and where READQ TS NEXT is.

Enums

Cics

One variant per command ironwork carries out; any other is Unsupported.

Condition

A CICS exception condition, one variant per name DFHRESP knows, spelt as IBM spells it.

DataSet

What kind of VSAM data set a CICS file is.

Datum

An option’s argument: a data item, another operand (a literal, LENGTH OF and the like), text the translator kept as written (a label, a name that is not a data item), or none at all.

ExitTarget

FileControl

Flow

Where control goes after a command.

FormatValue

A FORMATTIME output: text for the date and time forms, a number for the counts.

Handler

Constants

EIBAID

EIBCALEN

EIBCPOSN

EIBDATE

EIBFN

EIBRESP

EIBRESP2

EIBRSRCE

EIBTASKN

EIBTIME

EIBTRMID

EIBTRNID

EIB_LEN

The EXEC interface block’s length: EIBRLDBK, its last field, is at X’54’.

Traits

CicsHost

What a command asks of the executor running it beyond Host: the run unit, the program level’s handlers, operands that are not data items, names only the executor can resolve, and running a program for LINK and XCTL.

Handles

Turns a command’s handles into another executor’s, as lowering turns the walker’s references into the LIR’s ids.

Terminal

The task’s terminal: SEND writes a 3270 data stream to it, and RECEIVE reads the stream the operator’s next AID key sends back.

Functions

abend_exit

Where an abend that reaches a logical level goes: to the level’s HANDLE ABEND exit when it is active, which CICS deactivates on the way in (C142). None passes the abend to the next higher level.

abstime

Milliseconds from 1900-01-01T00:00:00 to a Unix time given as seconds and hundredths.

begin_command

Every command starts with EIBRESP and EIBRESP2 zero.

begin_task

Fills the EXEC interface block for the task’s first program: time, date, transaction, task number, terminal, COMMAREA length and the AID that started it.

bytes

An option’s bytes: a data item’s storage, or another operand’s as CALL BY CONTENT passes it.

eib_date

EIBDATE’s value for an ABSTIME: 0CYYDDD as a decimal number.

eib_time

EIBTIME’s value for an ABSTIME: 0HHMMSS as a decimal number.

enter_exit_program

A HANDLE ABEND PROGRAM exit, entered as by LINK with the COMMAREA of the program that set it. One that cannot be loaded abends APCT, which passes to the next higher level.

format_time

One FORMATTIME option’s value for an ABSTIME, or None for an option this does not produce. datesep and timesep are the separators when DATESEP / TIMESEP were given.

in_task

EXEC CICS is refused outside a CICS task.

ok

A command that succeeded: RESP and RESP2, when asked for, are zero.

parse_file

Parses NAME=path,KSDS,key=OFFSET:LENGTH,len=RECLEN[,text|,fixed|,variable] or NAME=path,RRDS,len=RECLEN[,text|,fixed|,variable].

raise

Raises a condition. RESP or NOHANDLE take it; otherwise HANDLE CONDITION (the condition’s own entry, else ERROR) or IGNORE CONDITION decides; otherwise the task abends with the condition’s AEIx code, which a HANDLE ABEND exit can intercept.

run

Runs a command.

unix_seconds

Unix seconds (rounded down) of an ABSTIME.

unsupported

The abend message for a command ironwork does not carry out.

Type Aliases

Opt

An option that may be absent.