Creating a CICS service for C or top-down

NO

Character fields are mapped to a JSON string and are processed as fixed-length fields. The maximum length of the data is equal to the length of the field. This value does not apply to Enterprise and Other PL/I language structures.

NULL

Character fields are mapped to a JSON string and are processed as null-terminated strings. z/OS Connect adds a terminating null character when transforming from a JSON payload. The maximum length of the character string is calculated as one character less than the length indicated in the language structure. NULL is the default value for the characterVarying property for C and C++. This value does not apply to Enterprise and Other PL/I language structures.

COLLAPSE

Character fields are mapped to a JSON string. Trailing white space in the field is not included in the JSON payload. The request JSON payload is parsed to remove all leading, trailing, and embedded white space. COLLAPSE is the default value for the characterVarying property for COBOL and PL/I.

BINARY

Character fields are mapped to a JSON string containing base64 encoded data and are processed as fixed-length fields.

ENABLED

Any application-supplied runtime data that is inconsistent with the language structure, is treated as an error and message DFHPI1010 is issued. An error response is returned to the application.

DISABLED

Data values in application-supplied runtime data that are inconsistent with the language structure are replaced by default values. For example, a zero replaces a bad value in a numeric field. Message DFHPI1010 is not issued and a normal response is returned to the application. This feature can be used to avoid INVALID_PACKED_DEC and INVALID_ZONED_DEC error responses that are generated from uninitialized output fields.

ENABLED

If the data is less than the fixed length that CICS is expecting, z/OS Connect rejects the truncated data and issues an error message.

DISABLED

If the data is less than the fixed length that CICS is expecting, z/OS Connect tolerates the truncated data and processes the missing data as null values.

EIB_ONLY

The transid property specifies the name of the CICS transaction that appears in the CICS exec interface block (EIB); the EIBTRNID field contains the value of the transid property. The called CICS program runs under the default mirror transaction CSMI.

EIB_AND_MIRROR

The transid property specifies the name of the CICS transaction under which the called CICS program runs. The transaction must be defined in the CICS region, and the transaction definition must specify the mirror program, DFHMIRS. The value specified by the transid property is available to the called CICS program for querying the transaction ID. The value of the transid property also appears in the EIBTRNID field of the CICS EIB.

true

Context containers are sent to CICS.

false

Context containers are not sent to CICS.

useContextContainers can only be used when programInterface is set to CHANNEL

For more information, see Context containers.

httpHeaders can only be used when useContextContainers is set to true.

ARRAY

Character arrays are mapped to a JSON array. This means that every character is mapped as an individual JSON value.

STRING

Character arrays are mapped to an JSON string. This means that the entire COBOL array is mapped as a single JSON string.

DBCS

Data from PIC ( n ) fields is treated as DBCS encoded data.

NATIONAL

Data from PIC ( n ) fields is treated as UTF-16 encoded data.

PACKED15

Packed decimal fields of length 15 (8 bytes) are treated as CICS ABSTIME fields, and mapped as timestamps.

UNUSED

Packed decimal fields of length 15 (8 bytes) are not treated as timestamps.

ENABLED

z/OS Connect will attempt to recognize empty records within an array (See truncateNullArrayValues for more information about identifying empty records). If five consecutive empty array records are detected, the array is truncated at the first such record when generating JSON. This truncation capability is only enabled for arrays with structured content, arrays of simple primitive fields are not subject to truncation. Truncation of arrays can result in a more concise representation of the data in JSON, but is not without risk. If five consecutive data records are misidentified as uninitialised storage (perhaps because they legitimately contain low values), data loss can be experienced. If truncateNullArrays is enabled and truncateNullArrayValues is not set, then the default value for truncateNullArrayValues is used.

DISABLED

z/OS Connect will not attempt to truncate arrays.

NULL

The null character (0x00) is treated as empty.

SPACE

An SBCS EBCDIC Space (0x40) is treated as empty.

ZERO

An unsigned zoned decimal zero (0xF0) is treated as empty.

Specifies the number of bytes to allow for each character. The value of this property can be a positive integer in the range of 1 - 2147483647. All nonnumeric character-based mappings, are subject to this multiplier. Binary, numeric, zoned, and packed decimal fields are not subject to this multiplier.

This property can be useful if, for example, you are planning to use DBCS characters where you might opt for a multiplier of 3 to allow space for potential shift-out and shift-in characters around every double-byte character at run time.

When you set ccsid=1200 (indicating UTF-16), the only valid values for characterMultiplier are 2 or 4. When you use UTF-16, the default value is 2. Use characterMultiplier=2 when you expect application data to contain characters that require 1 UTF-16 encoding unit. Use characterMultiplier=4 when you expect application data to contain characters that require 2 UTF-16 encoding units.

The default is 1. Messages with the DFH prefix might refer to this property as CHAR-MULTIPLIER.

COLLAPSE

Leading, trailing, and embedded white space is removed and all tabs, new lines, and consecutive spaces are replaced with single space characters.

REPLACE

Any tabs or new lines are replaced with the appropriate number of spaces.

PRESERVE

Retains any white space in the data value.

PACKED15

JSON date-time format properties are processed as a time stamp and is mapped to CICS ABSTIME format.

STRING

JSON date-time format properties are processed as text.

Specifies whether inline variable repeating content is used based on the maxItems JSON schema keyword. Variably repeating content that is mapped inline is placed in the current container with the rest of the generated language structure. The variably repeating content is stored in two parts, as a counter that stores the number of occurrences of the data and as an array that stores each occurrence of the data. The alternative mapping for variably repeating content is container-based mapping, which stores the number of occurrences of the data and the name of the container where the data is placed. Storing the data in a separate container has performance implications that might make inline mapping preferable.

The value of inlineMaxOccursLimit can be a positive integer in the range of 0 - 32767. A value of 0 indicates that inline mapping is not used. A value of 1 ensures that optional elements are mapped inline. If the value of the maxOccurs property is greater than the value of inlineMaxOccursLimit, container-based mapping is used; otherwise inline mapping is used.

When deciding whether you want variably repeating lists to be mapped inline, consider the length of a single item of recurring data. If few instances of long length occur, container-based mapping is preferable; if many instances of short length occur, inline mapping is preferable.

The default is 1.

SAME-AS-MAPPING-LEVEL

This option generates language structures in the default style.

UNDERSCORES-AS-HYPHENS

For COBOL only. This option converts any underscores in the JSON schema to hyphens, rather than the character X, to improve the readability of the generated COBOL language structures. If any field name clashes occur, the fields are numbered to ensure that they are unique.

INTEGER-AS-PIC9

For COBOL only. This option generates language structures that contain integer values from the JSON schema as numerals rather than alphanumeric characters.

LESS-DUP-NAMES

This option generates non-structural structure field names with _value at the end of the name to enable direct referencing to the field. For example, in the following PL/I language structure, when mappingOverrides=LESS-DUP-NAMES is specified, level 12 field streetName is suffixed with _value:

09 streetName,
12 streetName CHAR(255) VARYING
UNALIGNED,
12 filler BIT (7),
12 attr_nil_streetName_value BIT (1),

The resulting structure is as follows:

09 streetName,
12 streetName_value CHAR(255) VARYING
UNALIGNED,
12 filler BIT (7),
12 attr_nil_streetName_value BIT (1),

RIGHT

Names are truncated from the right.

LEFT

Names are truncated from the left.

YES

build toolkit supports the maximum size of 31 when generating the COBOL language structure type COMP-3.

NO

build toolkit limits the packed decimal variable length to 18 when generating the COBOL language structure type COMP-3. If the packed decimal size is greater than 18, message DFHPI9022W is displayed to indicate that the specified type is being restricted to a total of 18 digits.