The following definitions describe the content of each field in
the CICS® Service Flow Runtime passthrough
map header (CIA-MAP-HEADER).
- CIAMH-STRUCID
- Structure
Identifier. The value must be CIAMH. This is always an input field. The initial
value of this field is CIAMH.
- CIAMH-DATA-FORMAT-INDICATOR
- This
field indicates the format of the input application request or output application
reply that follows this map header. Valid values are:
- I - unformatted input
- B - BMS symbolic map/application data structure (ADS) format
- 3 - 3270 data stream format
- T - text format as the result of a SEND/SEND TEXT vector
This is an input or output field. The initial value of this field
is spaces. On input however, the only supported values are I and B.
Meaning the service requestor can only send application request data that
is unformatted (i.e., to initiate a transaction with terminal input data or
3270 data stream format data) or in an ADS format (for example, an ADS received
as an application reply as the result of a SEND MAP vector).
- CIAMH-MAP-DATA-LENGTH
- This
field indicates the length of the input application request or output application
reply data that follows this map header. If CIAMH-DATA-FORMAT-INDICATOR indicates
unformatted input, this field indicates the length of the unformatted application
request data. If CIAMH-DATA-FORMAT-INDICATOR indicates a BMS ADS format, this
field indicates the length of the BMS ADS format either in the application
request or application reply data.
This is an input/output field. The
initial value of this field is zero.
- CIAMH-MAP-NAME
- This
field indicates the BMS map name associated with the BMS ADS data. This field
applies only if CIAMH-DATA-FORMAT-INDICATOR indicates the data format is BMS
ADS.
This is an input or output field. The initial value of this field
is spaces.
- CIAMH-MAPSET-NAME
- This
field indicates the BMS map set name that contains the BMS map indicated in
CIAMH-MAP-NAME. This field applies only if CIAMH-DATA-FORMAT-INDICATOR indicates
the data format is BMS ADS.
This is an input or output field. The initial
value of this field is spaces.
- CIAMH-MAP-ROWS
- This
field indicates the number of screen rows in the BMS map if present.
This
is an output field. The initial value of this field is zero.
- CIAMH-MAP-COLUMNS
- This
field indicates the number of screen columns in the BMS map if present.
This
is an output field. The initial value of this field is zero.
- CIAMH-FIELD-COUNT
- This
field indicates the number of fields within the ADS, that is the number of
named fields in the BMS map definition macros. A separate field is counted
for each element of an array defined with the OCCURS parameter but subfields
of group fields (GRPNAME) are not counted. The field count may be zero, in
which case there are no ADS field descriptors following this header.
This
is an output field. The initial value of this field is zero.
- CIAMH-EXT-ATTRIBUTE-COUNT
- This
field indicates the number of extended attributes in each field of the ADS,
this is the number of attributes specified in the DSATTS parameter in the
BMS map definition.
This is an output field. The initial value of this
field is zero.
- CIAMH-EXT-ATTRIBUTES
- This
field indicates the one character code for the attribute types in each field,
in order, derived from the DSATTS parameter in the BMS map definition. Valid
values are:
- C = COLOR
- P = PS
- H = HILIGHT
- V = VALIDN
- O = OUTLINE
- S = SOSI
- T = TRANSP
This is an output field. The initial value of this field is spaces.
- CIAMH-CURSPOS-FIELDNAME
- This
field indicates the name of the ADS field where the cursor is initially positioned
on output, and finally positioned on input.
This is an input and output
field. The initial value of this field is spaces.