IBM Integration Bus, Version 10.0.0.9 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


CWF common MRM entities

This file is used as a common entities file for all CWF MRM information.

Details of this text reuse file

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.

Byte alignment

Property Type Meaning
Byte Alignment Enumerated type Specify how the object is aligned from the start of the message. Select one of:
  • 1 Bytes. The default value.
  • 2 Bytes
  • 4 Bytes
  • 8 Bytes
  • 16 Bytes
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.

Occurrences

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.

Physical representation

Property Type Meaning
Physical Type Enumerated type Select one from the displayed list:
  • Fixed Length String. The element's length is determined by other length properties as follows.
  • Length Encoded String 1. The first byte of the element contains the length of the string following the length byte in length units. The maximum length of a Length Encoded String 1 element is 255 length units.
  • Length Encoded String 2. The element's first 2 bytes contain the length of the string following the two length bytes in length units. The maximum length of a Length Encoded String 2 element is 65535 length units. The two length bytes are in the format of the WebSphere® MQ queue manager Encoding.
  • Null Terminated String. The string ends with the hexadecimal NULL character, X'00'.
  • Packed Decimal. The dateTime is coded as a Packed Decimal number. It is valid only if the DateTime Format property represents numeric-only data.
  • Packed Decimal. Equates to the COMP-3 data type in COBOL.
  • External Decimal. Equates to the data type PIC 9 USAGE DISPLAY in COBOL.
  • Integer. This equates to the data type SHORT or LONG in C, or the COMP, COMP-4, COMP-5, or BINARY numeric data type in COBOL.
  • Binary. The dateTime is encoded as a binary sequence of bytes. If you select this option, the range of symbols that you can specify for the Format String property is less than the range of symbols you can specify if you select a string option (see Message Sets: DateTime formats for details).
  • Time Seconds. This value supports C time_t and Java™ Date and Time objects. It is valid only if the DateTime Format property represents numeric-only data.
  • Time Milliseconds. This value supports C time_t and Java Date and Time objects. It is valid only if the DateTime Format property represents numeric-only data.
  • Float. This equates to the data type FLOAT or DOUBLE in C or the COMP-1 or COMP-2 data type in COBOL and is the default value.

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:

  • Elements that have Physical Type set to Integer and Packed Decimal are represented in the appropriate WebSphere MQ Encoding value.
  • Elements that have Physical Type set to Integer, Packed Decimal, and Float are represented in the appropriate WebSphere MQ Encoding value.
  • Elements that have Physical Type set to External Decimal are represented in the WebSphere MQ CodedCharSetId value.
Physical Type Enumerated type Select one from the displayed list:
  • Fixed Length String. The element's length is determined by other length properties as follows.
  • Length Encoded String 1. The first byte of the element contains the length of the string following the length byte in length units. The maximum length of a Length Encoded String 1 element is 255 length units.
  • Length Encoded String 2. The element's first 2 bytes contain the length of the string following the two length bytes in length units. The maximum length of a Length Encoded String 2 element is 65535 length units. The two length bytes are in the format of the WebSphere MQ queue manager Encoding.
  • Null Terminated String. The string ends with the hexadecimal NULL character, X'00'.
  • Packed Decimal. The dateTime is coded as a Packed Decimal number. It is valid only if the DateTime Format property represents numeric-only data.
  • Binary. The dateTime is encoded as a binary sequence of bytes. If you select this option, the range of symbols that you can specify for the Format String property is less than the range of symbols you can specify if you select a string option (see Message Sets: DateTime formats for details).
  • Time Seconds. This value supports C time_t and Java Date and Time objects. It is valid only if the DateTime Format property represents numeric-only data.
  • Time Milliseconds. This value supports C time_t and Java Date and Time objects. It is valid only if the DateTime Format property represents numeric-only data.

The default value is fixed length string.

Physical Type Enumerated type Select one from the displayed list:
  • Integer. This equates to the data type SHORT or LONG in C, or the COMP, COMP-4, COMP-5, or BINARY numeric data type in COBOL.
  • Packed Decimal. Equates to the COMP-3 data type in COBOL.
  • External Decimal. Equates to the data type PIC 9 USAGE DISPLAY in COBOL.

The representation of numeric elements can be affected by the Encoding and CodedCharSetId attributes that are set for the WebSphere MQ queue manager:

  • Elements that have Physical Type set to Integer and Packed Decimal are represented in the appropriate WebSphere MQ Encoding value.
  • Elements that have Physical Type set to External Decimal are represented in the WebSphere MQ CodedCharSetId value.
Physical Type Enumerated type Select one from the displayed list:
  • Integer. This equates to the data type SHORT or LONG in C, or the COMP, COMP-4, COMP-5, or BINARY numeric data type in COBOL.
  • Float. This equates to the data type FLOAT or DOUBLE in C or the COMP-1 or COMP-2 data type in COBOL and is the default value.
  • Packed Decimal. Equates to the COMP-3 data type in COBOL.
  • External Decimal. Equates to the data type PIC 9 USAGE DISPLAY in COBOL.

The representation of numeric elements can be affected by the Encoding and CodedCharSetId attributes that are set for the WebSphere MQ queue manager:

  • Elements that have Physical Type set to Integer, Packed Decimal, and Float are represented in the appropriate WebSphere MQ Encoding value.
  • Elements that have Physical Type set to External Decimal are represented in the WebSphere MQ CodedCharSetId value.
Physical Type Enumerated type Select one from the displayed list:
  • Fixed Length String. The element's length is determined by other length properties as follows.
  • Length Encoded String 1. The first byte of the element contains the length of the string following the length byte in length units. The maximum length of a Length Encoded String 1 element is 255 length units.
  • Length Encoded String 2. The element's first 2 bytes contain the length of the string following the two length bytes in length units. The maximum length of a Length Encoded String 2 element is 65535 length units. The two length bytes are in the format of the WebSphere MQ queue manager Encoding.
  • Null Terminated String. The string ends with the hexadecimal NULL character, X'00'.

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:
  • If you set the Physical Type to Float, select a value from the displayed list. The default value is 8.
  • If you set the Physical Type to Integer, select 1, 2, or 4 (the default) from the displayed list.
  • If you set the Physical Type to Packed Decimal, enter a value between 1 and 10.
  • If you set the Physical Type to Extended Decimal, enter a value between 1 and 256. (Numbers greater than the maximum COBOL PICTURE clause of 18 are assumed to be 18.)
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:
  • If you set the Physical Type to Integer, select 1, 2, or 4 (the default) from the displayed list.
  • If you set the Physical Type to Packed Decimal, enter a value between 1 and 10.
  • If you set the Physical Type to Extended Decimal, enter a value between 1 and 256. (Numbers greater than the maximum COBOL PICTURE clause of 18 are assumed to be 18.)
Length Integer Enter the number of bytes to specify the element length:
  • If you set the Physical Type to Float, select a value from the displayed list. The default value is 8.
  • If you set the Physical Type to Integer, select 1, 2, or 4 (the default) from the displayed list.
  • If you set the Physical Type to Packed Decimal, enter a value between 1 and 10.
  • If you set the Physical Type to Extended Decimal, enter a value between 1 and 256. (Numbers greater than the maximum COBOL PICTURE clause of 18 are assumed to be 18.)
Length Integer Enter the number of bytes to specify the element length:
  • If you set the Physical Type to Integer, select 1, 2, or 4 (the default) from the displayed list.
  • If you have set Physical Type to Packed Decimal, enter a value between 1 and 6.
  • If you have set Physical Type to Extended Decimal, enter a value between 1 and 11.
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):
  • Bytes. The length is given in bytes.
  • Bytes.
  • Characters. The Length is given in characters. This means that the number of bytes that are processed in the bitstream depends on the code page of the characters that are being processed.
    • For a single-byte code page (SBCS CCSID) such as "latin-1" (CCSID 850), the number of bytes is equal to the number of characters.
    • For a double-byte code page (DBCS CCSID) such as "UTF-16" (CCSID 1200), the number of bytes is exactly twice the number of characters.
    • For a multibyte code page (MBCS CCSID) such as "UTF-8" (CCSID 1208), the number of bytes depends on the bitstream content. The parser reads one character at a time and determines whether the character comprises one or more bytes.
  • Character Units. This option specifies that the size of each character (in bytes) is determined by the code page of the message.
    • For single-byte and double-byte code pages, this option is identical to Characters.
    • For a multibyte code page, this option provides improved parsing performance by assuming that every character is encoded in the smallest character unit that the code page supports. However, this means that a message must contain only these characters if it is to be processed correctly. For example, in code page "UTF-8" (CCSID 1208), the minimum character unit is 1 byte; therefore, the parser can make a single read (of the number of bytes specified by the Length property) to fetch the entire message. The message must contain only characters that are encoded in 1-byte units.
  • End of Bitstream. All data up to the end of the bitstream is processed. This option is valid only if the element is the last in the message. If you select this value, you do not need to enter a value for the Length Count or Length Reference property.
  • End of Bitstream. All data up to the end of the bitstream is processed. This option is valid only if the element is the last in the message. If you select this value, you do not need to enter a value for the Length Count.

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):
  • Bytes. The length is given in bytes.
  • Characters. The Length is given in characters. This means that the number of bytes that are processed in the bitstream depends on the code page of the characters that are being processed.
    • For a single-byte code page (SBCS CCSID) such as "latin-1" (CCSID 850), the number of bytes is equal to the number of characters.
    • For a double-byte code page (DBCS CCSID) such as "UTF-16" (CCSID 1200), the number of bytes is exactly twice the number of characters.
    • For a multibyte code page (MBCS CCSID) such as "UTF-8" (CCSID 1208), the number of bytes depends on the bitstream content. The parser reads one character at a time and determines whether the character comprises one or more bytes.
  • Character Units. This option specifies that the size of each character (in bytes) is determined by the code page of the message.
    • For single-byte and double-byte code pages, this option is identical to Characters.
    • For a multibyte code page, this option provides improved parsing performance by assuming that every character is encoded in the smallest character unit that the code page supports. However, this means that a message must contain only these characters if it is to be processed correctly. For example, in code page "UTF-8" (CCSID 1208), the minimum character unit is 1 byte; therefore, the parser can make a single read (of the number of bytes specified by the Length property) to fetch the entire message. The message must contain only characters that are encoded in 1-byte units.
  • End of Bitstream. All data up to the end of the bitstream is processed. This option is valid only if the element is the last in the message. If you select this value, you do not need to enter a value for the Length Count or Length Reference property.

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):
  • Bytes. The length is given in bytes.
  • Characters. The Length is given in characters. This means that the number of bytes that are processed in the bitstream depends on the code page of the characters that are being processed.
    • For a single-byte code page (SBCS CCSID) such as "latin-1" (CCSID 850), the number of bytes is equal to the number of characters.
    • For a double-byte code page (DBCS CCSID) such as "UTF-16" (CCSID 1200), the number of bytes is exactly twice the number of characters.
    • For a multibyte code page (MBCS CCSID) such as "UTF-8" (CCSID 1208), the number of bytes depends on the bitstream content. The parser reads one character at a time and determines whether the character comprises one or more bytes.
  • Character Units. This option specifies that the size of each character (in bytes) is determined by the code page of the message.
    • For single-byte and double-byte code pages, this option is identical to Characters.
    • For a multibyte code page, this option provides improved parsing performance by assuming that every character is encoded in the smallest character unit that the code page supports. However, this means that a message must contain only these characters if it is to be processed correctly. For example, in code page "UTF-8" (CCSID 1208), the minimum character unit is 1 byte; therefore, the parser can make a single read (of the number of bytes specified by the Length property) to fetch the entire message. The message must contain only characters that are encoded in 1-byte units.
  • End of Bitstream. All data up to the end of the bitstream is processed. This option is valid only if the element is the last in the message. If you select this value, you do not need to enter a value for the Length Count.

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):
  • Bytes.
  • Characters. The Length is given in characters. This means that the number of bytes that are processed in the bitstream depends on the code page of the characters that are being processed.
    • For a single-byte code page (SBCS CCSID) such as "latin-1" (CCSID 850), the number of bytes is equal to the number of characters.
    • For a double-byte code page (DBCS CCSID) such as "UTF-16" (CCSID 1200), the number of bytes is exactly twice the number of characters.
    • For a multibyte code page (MBCS CCSID) such as "UTF-8" (CCSID 1208), the number of bytes depends on the bitstream content. The parser reads one character at a time and determines whether the character comprises one or more bytes.
  • Character Units. This option specifies that the size of each character (in bytes) is determined by the code page of the message.
    • For single-byte and double-byte code pages, this option is identical to Characters.
    • For a multibyte code page, this option provides improved parsing performance by assuming that every character is encoded in the smallest character unit that the code page supports. However, this means that a message must contain only these characters if it is to be processed correctly. For example, in code page "UTF-8" (CCSID 1208), the minimum character unit is 1 byte; therefore, the parser can make a single read (of the number of bytes specified by the Length property) to fetch the entire message. The message must contain only characters that are encoded in 1-byte units.
  • End of Bitstream. All data up to the end of the bitstream is processed. This option is valid only if the element is the last in the message. If you select this value, you do not need to enter a value for the Length Count.

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:
  • Leading Overpunched. This option sets a bit in the first byte if the number is negative. No setting is made if the number is positive. For example, the ASCII hexadecimal representation of the number 22 is x'3232'. Using this option, the number +22 would be x'3232' and the number -22 would be x'7232'. The default value.
  • Leading Separate. This option sets the first byte of the element to '+' if the number is positive and to '-' if the number is negative. For this option, the length must include the sign byte.
  • Trailing Overpunched. This option sets a bit in the last byte if the number is negative. No setting is made if the number is positive. Using this option, the number +22 would be x'3232' and the number -22 would be x'3272'.
  • Trailing Separate. This option sets the last byte of the element to '+' if the number is positive and to '-' if the number is negative. For this option, the length must include the sign byte.
If you have set Physical Type to any other value, the value Not Applicable is set for you.
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:

  • Select NUL, '0', or SPACE from the displayed list.
  • Enter a character between quotation marks; for example, "c" or 'c', where c is any alphanumeric character.
  • Enter a Unicode value in the form U+xxxx where xxxx is a Unicode value specified in hexadecimal. The maximum length of the string that you can enter is 10.
  • Enter a hexadecimal character in the form 0xYY, where YY is a hexadecimal value.
  • Enter a decimal byte value (from 0 to 255).

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:
  • Select NUL, '0', or SPACE from the displayed list.
  • Enter a character between quotation marks; for example, "c" or 'c', where c is any alphanumeric character.
  • Enter a Unicode value in the form U+xxxx where xxxx is a Unicode value specified in hexadecimal. The maximum length of the string that you can enter is 10.
  • Enter a hexadecimal character in the form 0xYY, where YY is a hexadecimal value.
  • Enter a decimal byte value (from 0 to 255).

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.

Representation of null values

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:
  • NULLPadFill. This option is valid only if Physical Type is Fixed Length String. The field is filled with the value specified by the Padding Character. The default value.
  • NULLLogicalValue. The Encoding Null Value property is first converted to an actual value, and rendered in the way specified for the field.
  • NULLLiteralValue. This specifies that Encoding Null Value contains a value that is directly substituted as if it is a string. Use this option when the value you have set for Encoding Null Value to specify a null date is not a dateTime value, or does not conform to the standard dateTime format yyyy-MM-dd 'T'HH:mm:ss.
  • NULLLiteralFill. The field is filled with the value specified by the Encoding Null Value. Encoding Null Value must resolve to a single character.
Encoding Null Enumerated type Select one of the following options from the displayed list:
  • NULLPadFill. This option is valid only if Physical Type is External Decimal. The field is filled with the value specified by the Padding Character. Encoding Null Value must be set to an empty string.
  • NULLLogicalValue. The Encoding Null Value is transformed to match the required format for the field. The default value.
  • NULLLiteralValue. The Encoding Null Value is directly substituted as if it is a string. You can specify a nonnumeric value for Encoding Null Value.
  • NULLLiteralFill. The field is filled with the value specified by the Encoding Null Value. Encoding Null Value must resolve to a single character.
Encoding Null Enumerated type Select one of the following options from the displayed list:
  • NULLPadFill. This is valid only if Physical Type is Fixed Length String. The field is filled with the value specified by the Padding Character. Encoding Null Value must be set to an empty string.
  • NULLLogicalValue. The Encoding Null Value is transformed to match the required format for the field. The default value.
  • NULLLiteralValue. The Encoding Null Value is directly substituted as if it is a string.
  • NULLLiteralFill. The field is filled with the value specified by the Encoding Null Value. Encoding Null Value must resolve to a single character.
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:
  • Select SPACE, NUL, 0x00 or 0xFF from the displayed list
  • Enter a character between quotation marks, for example 'c' or "c", where c is any alphanumeric character.
  • Enter a hexadecimal character code in the form 0xYY where YY is a hexadecimal value.
  • Enter a decimal character code in the form YY where YY is a decimal value.
  • Enter a Unicode value in the form U+xxxx where xxxx is a Unicode value specified in hexadecimal format.
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:
  • Select SPACE, NUL, 0x00 or 0xFF from the displayed list
  • Enter a character between quotation marks, for example 'c' or "c", where c is any alphanumeric character.
  • Enter a hexadecimal character in the form 0xYY where YY is a hexadecimal value.
  • Enter a decimal character code in the form YY where YY is a decimal value.
  • Enter a Unicode value in the form U+xxxx where xxxx is a Unicode value specified in hexadecimal format.
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:
  • Select SPACE, NUL, 0x00 or 0xFF from the displayed list
  • Enter a character between quotation marks, for example 'c' or "c", where c is any alphanumeric character.
  • Enter a hexadecimal character code in the form 0xYY where YY is a hexadecimal value.
  • Enter a decimal character code in the form YY where YY is a decimal value.
  • Enter a Unicode value in the form U+xxxx where xxxx is a Unicode value specified in hexadecimal format.

adcwfent.htm | Last updated 2017-07-17 12:45:22