This file is used as a common entities file for all CWF MRM information.
This file is used to contain information that is common to the CWF layer in the MRM documentation.
The tables below define the properties of objects where they are common for multiple topics. The properties have been grouped together where they appear grouped in the product. The exception is the first table which contains properties used all over the place!
Some tables or sections are used as a whole, but most tables just contain the rows that define the object property. To view the row ID you need to view the table markup. The ID is displayed as an attribute.
In most cases there is a single row for a property where there are no differences between where it is used for each object or object type. In other cases, there are multiple rows for each property where there are differences in the meaning for a property between each object type. For example, binary, Boolean, and string. Occasionally, where this has happened, a common row is defined that contains all the information required, and rows that contain links to the specific information for building the description of that property for that type are built beneath that common row.
Extreme caution should be used when editing this file to ensure that the changes you make affect only those topics that are required to be changed. In some cases, this common information is used in excess of 20 topics.
Property | Type | Meaning |
---|---|---|
Byte Alignment | Enumerated type | Specify how the object is aligned from the start
of the message. Select one of:
|
Leading Skip Count | Integer | Specify the number of bytes to skip before reading
or writing this object. The default is 0, the minimum value is 0, and the maximum value
is 999999.
You can use this value to ignore unwanted fields in a structure, or
to model a field defined by C or COBOL data which requires alignment
on a 2, 4, 8 or 16 byte boundary. Specify the number of bytes to skip
before reading or writing this object. When an output message is written,
Skip Count bytes are assigned the value of the message set Byte Alignment
Pad property. For repeating objects, this property is applied to the first instance only. |
Trailing Skip Count | Integer | Specify the number of bytes to skip after reading
or writing this object. The default is 0, the minimum value is 0, and the maximum value
is 999999.
You can use this value to ignore unwanted fields in a structure, or
to model a repeating structure containing fields which require alignment
on a 2, 4, 8 or 16 byte boundary. When an output message is written,
Skip Count bytes are assigned the value of the message set Byte Alignment
Pad property. For repeating objects, this property is applied to all instances. |
Property | Type | Meaning |
---|---|---|
Repeat Reference | Enumerated type | Use this property if the object occurs multiple
times, and the number of occurrences is given dynamically by a field
earlier in the message. Select an integer object from the displayed
list of integer objects that occur before this object in the structure
of the message. The value of the selected integer specifies the number
of occurrences of this object. If no objects are listed, there are
no integer objects before this one in the message structure. If a Repeat Reference is specified, it overrides any setting for the Max Occurs logical property when parsing and writing the message, but not for validation of the message. |
Property | Type | Meaning |
---|---|---|
Physical Type | Enumerated type | Select one from the displayed list:
The default value is fixed length string. The representation of numeric elements can be affected by the Encoding and CodedCharSetId attributes that are set for the WebSphere MQ queue manager:
|
Physical Type | Enumerated type | Select one from the displayed list:
The default value is fixed length string. |
Physical Type | Enumerated type | Select one from the displayed list:
The representation of numeric elements can be affected by the Encoding and CodedCharSetId attributes that are set for the WebSphere MQ queue manager:
|
Physical Type | Enumerated type | Select one from the displayed list:
The representation of numeric elements can be affected by the Encoding and CodedCharSetId attributes that are set for the WebSphere MQ queue manager:
|
Physical Type | Enumerated type | Select one from the displayed list:
The default is Fixed Length String. |
Property | Type | Meaning |
---|---|---|
DateTime Format | String | Specify a template for date and time. The default dateTime format is dependent on the logical type of the object. For information about the defaults for the dateTime format according to the logical type, see Message Sets: DateTime defaults by logical type. See Message Sets: DateTime formats for details of date and time formats. |
Property | Type | Meaning |
---|---|---|
Length | Button and Integer | Enter the number of bytes to specify the element
length:
|
Length | Button and Integer | If you have
selected the length to be defined by Length,
enter the number of length units for the element. The minimum value that you can specify is 1. The maximum value that you can specify is 2147483647. The default value is empty (not set). |
Length | Button and Integer | If you have
selected a Physical Type of Fixed Length String, Packed Decimal, or Binary, and have selected
the length to be defined by Length,
enter the number of length units for the element. The minimum value that you can specify is 1 for all three physical types. The maximum value that you can specify is 256 for Fixed Length String, 10 for Packed Decimal, and 2147483647 for Binary. The default value is 0 (zero). |
Length | Integer | Enter the number of bytes to specify the element
length:
|
Length | Integer | Enter the number of bytes to specify the element
length:
|
Length | Integer | Enter the number of bytes to specify the element
length:
|
Length | Button and Integer | If you have
selected a Physical Type of Fixed Length String or Binary, and have selected
the length to be defined by Length,
enter the number of length units for the element. The minimum value that you can specify is 0 (zero), the maximum value that you can specify is 2147483647 The default value is 0 (zero). |
Property | Type | Meaning |
---|---|---|
Length Reference | Button and Enumerated type | If you have selected the length to be defined
by Length Reference,
select the name of the integer object that specifies the length of
this object. Make your selection from the displayed list of integer
objects that are defined as siblings of the current object, and occur
before it in the structure of the message. For information about reordering elements, see Message Sets: Reordering objects. |
Inclusive Length Reference | Check box | This property is applicable only if Length Reference is set. If the check box is selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object plus the length of the sibling integer object. If the check box is not selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object only. If the check box is selected, the Length Units property of the sibling integer object must be the same as that of the current object. |
Property | Type | Meaning |
---|---|---|
Length Units | Enumerated type | Select the unit of length for the element or
attribute. Select one of the following options from the displayed
list (some physical types do not offer all these options):
The default is Bytes. The Length Units property is used whether the length is specified using the Length Count property, the Length Reference property, or in the physical type's Length Encoded String 1 or Length Encoded String 2 (where the length is encoded in the message). |
Length Units | Enumerated type | Select the unit of length for the element or
attribute. Select one of the following options from the displayed
list (some physical types do not offer all these options):
The default is Bytes. |
Length Units | Enumerated type | Select the unit of length for the element or
attribute. Select one of the following options from the displayed
list (some physical types do not offer all these options):
The default is Bytes. |
Length Units | Enumerated type | Select the unit of length for the element or
attribute. Select one of the following options from the displayed
list (some physical types do not offer all these options):
The default is Bytes. |
Property | Type | Meaning |
---|---|---|
Signed | Check box | Specify whether
the value is signed. This property is applicable only if the Physical type property is Packed Decimal. By default, this check box is cleared, which indicates that the value is not signed. |
Signed | Check box | Select (the default) or clear this property. This property is used with Sign Orientation. |
Signed | Check box | Select or clear (unsigned, the default) this property. If you have set Physical Type to Float, this is selected. This property is used with Sign Orientation. |
Property | Type | Meaning |
---|---|---|
Sign EBCDIC Custom Overpunched | Check box | If the Physical
Type is set to External
Decimal and the Signed
EBCDIC Custom property is set, this indicates that the
Sign EBCDIC Custom Overpunched representation is to be used within
an ASCII environment. If this check box is not selected (the default),
the Sign ASCII representation is used. The setting of the Sign EBCDIC Custom Overpunched check box is appropriate only if the Sign Orientation property is set to Leading or Trailing (indicating that the element/attribute has an embedded sign representation). The check box is not available if the element/attribute is unsigned (for example, if the Signed check box is not set). |
Property | Type | Meaning |
---|---|---|
Sign Orientation | Enumerated type | If you have set Physical
Type to External
Decimal and you have selected Signed, choose from the following
options that represent the COBOL options for displaying numeric data:
|
Property | Type | Meaning |
---|---|---|
Virtual Decimal Point | Integer | Specify the number of places to the left (for a positive value) or right (for a negative value) that a decimal point is to be moved from its assumed position. For example, a decimal element containing 1234 with a Virtual Decimal value of 3 is 1.234, equivalent to 'V' or 'P' in a COBOL picture clause. There is no C equivalent |
Virtual Decimal Point | Integer | Specify
the number of places to the left (for a positive value) or right (for
a negative value) that a decimal point is to be moved from its assumed
position. For example, a float element containing 1234 with a Virtual Decimal
value of 3 is 1.234.
This property is not applicable if you have set Physical Type to Float. |
Property | Type | Meaning |
---|---|---|
Justification | Enumerated type | If you have set the Physical Type property to , select Left Justify (the default value) or Right Justify from the list. If you have selected another value for Physical Type, this property is inactive. |
Justification | Enumerated type | If you have set the Physical Type property to Fixed Length String, select Left Justify (the default value) or Right Justify from the list. If you have selected another value for Physical Type, this property is inactive. |
Justification | Enumerated type | If you have set the Physical Type property to External Decimal, select Left Justify or Right Justify (the default value) from the list. If you have selected another value for Physical Type, this property is inactive. |
Property | Type | Meaning |
---|---|---|
Padding Character | String | If you have set the Physical Type property to Fixed Length String, and the Justification property is either Left Justify or Right Justify, this property is applicable. When writing an output message, use the padding character to fill out the remaining character positions when the string length is less than the length implied by the Length or Length Reference property. Whether the string is padded from the left or the right is governed by the Justification property. When parsing an input message, the padding character is trimmed from the end of the string. Whether the string is trimmed from the left or the right is governed by the Justification property. Specify this character in one of the following ways:
The choice of which of these padding character forms is used for an MRM element depends on the padding character that is required and whether the padding character is to be subject to data conversion. In most cases, the specification of a padding character in quotation marks is sufficient, and when this padding character is used, it is converted to the target code page of the output MRM message that is being generated. For example, when converting from ASCII to the code page 500, if you have specified U+0008 as your padding character, it is converted from 0x08 to 0x15, the ASCII and EBCDIC representations of 'back space'. If a padding character is required that cannot easily be entered in the padding character field, the Unicode mnemonic format can be used to specify the required character. When used, this Unicode value is also converted to the target code page of the MRM message that is being generated. If you are converting a message from one code page to another, ensure that the converted value of the padding character is valid for this code page. If the padding character cannot be represented in the target code page, it is replaced by a substitution character. The substitution character is fixed and its value depends on the specified target code page. If a padding character is required that is not subject to data conversion, the hexadecimal or decimal format can be used and you then have the option of specifying an absolute value as a padding character that is inserted directly into the output message. If this format is used, ensure still that this value is valid for the code page of any output messages that are created using these MRM definitions. |
Padding Character | String | The
padding character is used to fill out the remaining character positions
when the string length is less than the specified string size. If
you have set the Physical Type property
to Extended Decimal,
and the Justification property
is either Left Justify or Right Justify, specify this
character in one of the following ways:
The choice of which of these padding character forms is used for an MRM element depends on the padding character that is required and whether the padding character is to be subject to data conversion. In most cases, the specification of a padding character in quotation marks is sufficient, and when this padding character is used, it is converted to the target code page of the output MRM message that is being generated. For example, when converting from ASCII to the code page 500, if you have specified U+0008 as your padding character, this is converted from 0x08 to 0x15, the ASCII and EBCDIC representations of 'back space'. If a padding character is required that cannot easily be entered in the padding character field, the Unicode mnemonic format can be used to specify the required character. When used, this Unicode value is also converted to the target code page of the MRM message that is being generated. If you are converting a message from one code page to another, ensure that the converted value of the padding character is valid for this code page. If the padding character cannot be represented in the target code page, it is replaced by a substitution character. The substitution character is fixed and its value depends on the specified target code page. If a padding character is required that is not subject to data conversion, the hexadecimal or decimal format can be used and you then have the option of specifying an absolute value as a padding character that is inserted directly into the output message. If this format is used, ensure still that this value is valid for the code page of any output messages that are created using these MRM definitions. |
Property | Type | Meaning |
---|---|---|
Encoding Null | Enumerated type | Select one
of the following options from the displayed list. The option that
you select determines the value that you must set for the property Encoding Null Value:
|
Encoding Null | Enumerated type | Select
one of the following options from the displayed list:
|
Encoding Null | Enumerated type | Select one
of the following options from the displayed list:
|
Encoding Null Value | String | If you set the Encoding Null property to NULLPadFill, this property is disabled. If you set the Encoding Null property to NULLLogicalValue, you must set this property to an ISO8601 dateTime format. These formats are described in Message Sets: DateTime as string data. For example, specify a value conforming to yyyy-MM-dd'T'HH:mm:ss such as 1970-12-01. If you set the Encoding Null property to NULLLiteralValue, you can enter any value that is the same length as the field. If you
set the Encoding Null property
to NULLLiteralFill,
the value must resolve to a single character. Set the character in
one of the following ways:
|
Encoding Null Value | String | The
use of this property depends on the Encoding
Null property, except for NULLLiteralFill. The default
value is zero. If you set the Encoding
Null property to NULLLiteralFill,
the value must resolve to a single character. Set the character in
one of the following ways:
|
Encoding Null Value | STRING | The use
of this property depends on the Encoding
Null property. If specified, its length must be equal
to the length of the string element, except for NULLLiteralFill. The default value is empty (not set). If you set the Encoding Null property to NULLLiteralFill, the value
must resolve to a single character. Set the character in one of the
following ways:
|