Business Document data types

Where do I define the data type attribute of a node with values

Data type attributes

Data type reference tables

Data type is an attribute of a Business Document that describes the physical structure of the data and belongs to a DML Data Class from which it inherits a set of characteristics. In a Business Document, the DML data class / data type combination that you assign to a node determines how the data can be read in and be written to that node.

Each data type depends on a data class. A data class is an attribute of a node with values that generally describes what kind of data can be stored in the node, for example, Integer, and Date & Time. It does not describe the physical structure of data. For example, the Real number data class indicates that data can be expressed using decimal and exponential values. However, by itself, the data class does not indicate how many significant digits are included in the data. That type of information is specified using the data type.

For more information, see Business Documents, Business Document structure, Where do I define the data type attribute of a node with values, and Axway Mapping Services DML Reference Guide.

When an Integration Process is executed, it applies the data class to validate that the data values contained in nodes correspond to the expected values. If not, then the Map Engine treats the associated Business Document as an exception. For example, if the data class is set to Integer, and the node contains alphabetic characters, the associated Business Document is rejected.

Where do I define the data type attribute of a node with values

You define the data type attribute of individual nodes when the Business Document editor is open, either in the General view of the Attributes section or in the Structure view. In the Structure view, click in the cell of the Data type column to display a drop-down list of the available data types for the selected node.

Data type attributes

Some data types have attributes that you can use to refine the definition of the physical structure of data. In the General view of the Attributes section of a Business Document, you can identify the data types that have values in the Data type field.

Note for the name of the data type:
  • Abbreviated names are enclosed in parentheses. For example, String (len).
  • Abbreviated formats are enclosed in square brackets. For example, Date [YYYYMMDD].

The way an attribute is enclosed indicates whether you can modify the value that is supplied by the software in the Definition field.

  • If the attribute has a default value, then the attribute is enclosed inside parentheses. For example, String (len). You can modify the value supplied in the Definition field.
  • If the attribute has a predefined value, then the attribute is enclosed inside square brackets. For example, Date [YYYYMMDD]. You cannot modify the value supplied in the Definition field.

Attributes with default values

The following table describes the data type attributes with default values. In most cases, the default values optimize the performance of the Map Engine:

Abbreviation Attribute Details

(dp)

date pattern

Specifies the format of a date or a date/time.

(len)

length

In non-XML Business Documents, specifies the maximum number of characters that a node can contain.

In XML Business Documents, specifies:

  • The minimum number of characters that a node can contain
  • The maximum number of characters that a node can contain
  • Both the minimum and the maximum number of characters that a node can contain

(m,e)

mantissa, exponent

Specifies:

  • Mantissa: the maximum number of significant digits
  • Exponent: the maximum number of digits after the decimal sign

(p)

precision

Specifies:

  • The maximum number of numeric characters that an integer can contain
  • The Plus sign position is set to Left; and Optional plus sign, if used, is set to Enabled. The maximum number of digits is extended by one if the plus sign is missing. (for example, +12 and 923 are accepted).

(p,s)

precision, scale

Specifies:

  • Precision: the maximum number of characters and all numeric characters. The decimal sign is not included in the definition.
  • Scale: the maximum number of numeric characters after the decimal sign

(n,v)

or

(n)

whole real, virtual scale or

whole real

Specifies:

  • If (n,v): the maximum number of characters and all numeric characters, with implied decimal places (without a decimal separator). The decimal sign is not included in the definition. The explicit sign is only present when negative and is part of the total length of the field.
  • Scale: the maximum number of numeric characters after the decimal sign, or
  • If (n): the maximum number of characters and all numeric characters, with no decimal places.

Attributes with predefined values

The following table lists and describes the data type attributes with predefined values:

Attribute Meaning

[false,true]

Expected values for a Boolean expression

[0,1]

Expected values for a Boolean expression

[YYMMDD]

Six-digit date that begins with a two-digit year

[YYYYMMDD]

Eight-digit date that begins with a four-digit year

[YYYY/MM/DD]

Eight-digit date that begins with a four-digit year and separates year, month, and day with slashes

[YY/MM/DD]

Six-digit date that begins with a four-digit year and separates year, month, and day with slashes

[DD/MM/YYYY]

Eight-digit date that ends with a four-digit year and separates year, month, and day with slashes

[DD/MM/YY]

Six-digit date that ends with a two-digit year and separates year, month, and day with slashes

Data type reference tables

The data types that you can apply depend on the data class. In turn, the possible data classes depend on the structure type of the Business Document. For more information, see Business Document structure, Business Documents, and Axway Mapping Services DML Reference Guide.  The tables in this section summarize the possible combinations of data class / data type for each structure type. The tables also indicate the values that are assigned to the data type attributes of each data type listed (see Data type attributes).

Click the name of the Business Document type to display the table of data class / data type values for each type:

Related topics

Business Documents

Business Document structure

Related Links