EDI attributes

This section provides a description of the EDI attributes that you can use while setting up your EDI exchanges. Some of these attributes are predefined in the control string representing the transformation map associated with the EDI document. The values set in the control string (at the Data Interchange Services client) override any values you enter at the Community Console.

Envelope profile attributes

You can set various attributes for an EDI envelope profile. The attributes that are available depend on the EDI Type. In general, the attributes correspond to an EDI standard, and the allowable values depend on the EDI standard the envelope profile represents.

None of the attributes requires a value. For some of the attributes, a default value is used if you do not enter a value. The tables in this section list the attributes that have associated defaults and their default values.

Note: The envelope profile properties not listed do not have default values. The text value you specify is used if it is not overridden by generic or specific envelope properties set in the map or in a connection.

X12 attributes

The tables in this section list the X12 attributes for which default values are supplied.

General attributes

Table 84 lists the General attributes for which default values are provided.

Table 84. General attributes
Field name Required? Description Default
INTCTLLEN (Interchange Control Number Length) No

Defines a specific length for the interchange control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
GRPCTLLEN (Group Control Number Length) No

Defines a specific length for the group control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
TRXCTLLEN (Transaction Control Number Length) No

Defines a specific length for the transaction control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
ENVTYPE (Envelope Type) No

This attribute is not set by the Hub Admin but is derived from the envelope profile type being created.

X12
MAXDOCS (Max Transactions Number) No

Maximum number of transactions in an envelope. If you enter a value, it must be an integer.

No maximum
CTLNUMFLAG (Control Numbers by Transaction ID) No

Yes indicates that separate sets of control numbers are kept based on the EDI transaction type.

No indicates that a common set of control numbers for any EDI transaction type should be used.

No
Interchange attributes

No X12 interchange attributes are required, and the attributes do not have default values.

Group attributes

Table 85 lists the group attributes for which default values are provided.

Table 85. Group attributes
Field name Required? Description Default
GS01 (Functional group ID) No The group identifier. The default value comes from the control-string header. You can view this value in the Data Interchange Services client by looking at the Functional Group column of the EDI Document Definitions page.
GS08 (Group version) No The group version. The default value is per the standard.
Transaction attributes

No transaction attributes are required. The attributes do not have default values.

UCS attributes

This section lists whether default values apply to a UCS interchange, group, and transaction.

General attributes

Table 86 lists the General attributes for which default values are provided.

Table 86. General attributes
Field name Required? Description Default
INTCTLLEN (Interchange Control Number Length) No

Defines a specific length for the interchange control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

5
GRPCTLLEN (Group Control Number Length) No

Defines a specific length for the group control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
TRXCTLLEN (Transaction Control Number Length) No

Defines a specific length for the transaction control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
ENVTYPE (Envelope Type) No

This attribute is not set by the Hub Admin but is derived from the envelope profile type being created.

UCS
MAXDOCS (Max Transactions Number) No

Maximum number of transactions in an envelope. If you enter a value, it must be an integer.

No maximum
CTLNUMFLAG (Control Numbers by Transaction ID) No

Yes indicates that separate sets of control numbers are kept based on the EDI transaction type.

No indicates that a common set of control numbers for any EDI transaction type should be used.

No
Interchange attributes

No interchange attributes are required. The attributes do not have default values.

Group attributes

Table 87 lists the group attributes for which default values are provided.

Table 87. Group attributes
Field name Required? Description Default
GS01 (Functional group ID) No The group identifier. The default value comes from the control-string header. You can view this value in the Data Interchange Services client by looking at the Functional Group column of the EDI Document Definitions page.
GS08 (Group version) No The group version. The default value is per the standard.
Transaction attributes

No transaction attributes are required. The attributes do not have default values.

EDIFACT attributes

This section lists whether default values apply to an EDIFACT interchange, group, and message.

General attributes

Table 88 lists the General attributes for which default values are provided.

Table 88. General attributes
Field name Required? Description Default
INTCTLLEN (Interchange Control Number Length) No

Defines a specific length for the interchange control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
GRPCTLLEN (Group Control Number Length) No

Defines a specific length for the group control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
TRXCTLLEN (Transaction Control Number Length) No

Defines a specific length for the transaction control number. If you enter a value, it must be an integer.

If no value is entered, the default length is used.

9
ENVTYPE (Envelope Type) No

This attribute is not set by the Hub Admin but is derived from the envelope profile type being created.

EDIFACT
EDIFACTGRP (Create Groups for EDI) No

This value is only for EDIFACT envelope types. (The group level has been deprecated in EDIFACT.)

Yes indicates that functional groups (UNG/UNE segments) should be created for EDIFACT DATA.

No indicates that they should not.

No
MAXDOCS (Max Transactions Number) No

Maximum number of transactions in an envelope. If you enter a value, it must be an integer.

No maximum
CTLNUMFLAG (Control Numbers by Transaction ID) No

Yes indicates that separate sets of control numbers are kept based on the EDI transaction type.

No indicates that a common set of control numbers for any EDI transaction type should be used.

No
Interchange attributes

No interchange attributes are required. The attributes do not have default values.

Group attributes

Table 89 lists the group attributes for which default values are provided.

Table 89. Group attributes
Field name Required? Description Default
UNG01 (Functional group ID) No The group identifier. The default value comes from the control-string header. You can view this value in the Data Interchange Services client by looking at the Functional Group column of the EDI Document Definitions page.
Message attributes

Table 90 lists the message attributes for which default values are provided.

Table 90. Message attributes
Field name Required? Description Default
UNH0201 (Message Type) No The type of message. The default value comes from the control-string header. You can view this value in the Data Interchange Services client by looking at the EDI Document Definitions page.
UNH0202 (Message Version) No The version of the message. D
UNH0203 (Message Release) No The release of the message. Per the standard
UNH0204 (Controlling Agency) No The code identifying a controlling agency. UN

Document flow definition and connection attributes

This section lists document flow definition attributes for the envelope. Some of these attributes can be set only at the protocol or connection level, as indicated.

Separator and delimiter attributes

This section lists the characters used as delimiters or separators within an EDI interchange. Table 91 shows the attribute as it appears on the Community Console, the corresponding term in X12 and EDIFACT (ISO 9735 Version 4, Release 1), whether the attribute is required, and a description of the attribute. Following the table is an example of how these characters appear in an EDI document.

Attribute descriptions

The separator and delimiter attributes are listed in Table 91.

Note: Some characters (as noted) can be hexadecimal values. These can be Unicode values or values from another type of encoding. For Unicode, use the format \unnnn. For other encoding, use the form 0xnn.

Table 91. Envelope profile attributes
Attribute X12 term EDIFACT term Description
Segment delimiter segment terminator segment terminator

This is a single character, which appears at the last character of a segment. The character can be a hexadecimal value.

The default value is based on the EDI type.

X12
~ (tilde)
EDIFACT
' (single quote)
UCS
~ (tilde)
Data element delimiter data element separator data element separator

This is a single character, which separates the data elements of a segment. The character can be a hexadecimal value.

The default value is the based on the EDI type.

X12
* (asterisk)
EDIFACT
+ (plus sign)
UCS
* (asterisk)
Subelement delimiter component element separator component data element separator

This is a single character, which separates the component elements of a composite data element. The character can be a hexadecimal value.

The default value is the based on the EDI type.

X12
\ (back slash)
EDIFACT
: (colon)
UCS
\ (back slash)
Release character release character

This is a single character, which overrides the meaning of the next character, allowing a separator character to appear within a data element. The character can be a hexadecimal value. It applies to EDIFACT only.

EDIFACT
? (question mark)
Repeating data element separator repetition separator repetition separator

This is a single character, which separates the instances of a repeating data element. This character can be a hexadecimal value.

The default value is based on the EDI type for X12 or EDIFACT.

X12
^ (hat sign, accent circumflex)
EDIFACT
* (asterisk)
Decimal notation decimal notation (deprecated)

This attribute was used in decimal formatting or parsing and is now deprecated. It can be a period or comma only.

The default value is a period.

Example EDI structure

This section shows a simple EDI interchange and how the attributes described in Table 91 are used in an interchange.

An EDI message consists of a series of segments in a particular order. A segment consists of a series of elements. In a segment, an element can be a simple data element, which contains only one item of information. An element can also be a composite data element, containing two or more simple data elements. The simple elements that make up a composite element are called component data elements.

There is no nesting of composite data elements. A composite element can contain only simple data elements, not other composites. Although not shown here, a component data element can also be defined as a repeating data element.

Consider the following example:

ABC*123*AA\BB\CC*001^002^003*star?*power~

In this example:

Additional EDI attributes

This section lists additional EDI attributes that you can set at the document flow definition level or the connection level.

Table 92. Additional EDI attributes
Attribute Required Description Restrictions Default
Segment output
No

Used in EDI/XML transformation, this indicates whether a line break should occur after each EDI segment or XML element.

Limited to protocol or connection Yes
Allow documents with duplicate document IDs No

Yes indicates that duplicate document IDs (interchange control numbers) are allowed.

No indicates that duplicate interchange control numbers should be treated as an error.

Limited to protocol or connection No
Max error level at Transformation

No

Indicates the maximum number of errors that can occur during a transformation before the transformation fails.

Valid values are 0, 1, or 2.

If the transformation map contains an Error command to indicate a user-specified error, and the level parameter of the Error command is greater than this value, the transformation fails.

Limited to protocol or connection 0
FA Map

No

Provides the map to use for converting the internal generic FA to the specific FA.

Note: You select this attribute from a list of maps identified as FA maps (map type of "K").
Limited to protocol or connection
Envelope Profile Yes

The EDI envelope profile name to use for enveloping. All envelope profiles that you have defined are available from the list.

XMLNS Active No

Do namespace processing for the input XML document. This attribute is used by the XML transformation step.

Valid values are Yes or No.

Schema: Yes
DTD: No
Max validation error level No

The maximum acceptable validation error level (the error severity to accept before considering the transaction "failed").

Valid values are 0, 1, or 2.

0
Allow only validation with no errors
1
Do not fail documents that have only simple element validation errors
2
Do not fail documents that have element or segment validation errors.
0
Validation level No

Indicates the level of checking to be performed at the transaction level. A value of 2 means to use the values set for the Alphanumeric validation table and Char Set validation table attributes. This attribute also applies to the Detailed validation of segments attribute if that attribute is set to Yes.

Valid values are 0, 1, or 2.

0
Only perform basic validation, such as checking for missing mandatory elements and segments and minimum or maximum lengths. Do not validate element values against the data types or code lists specified in the transaction definition.
1
Perform level 0 validation, plus validate the element values against the code lists specified for the data element.
2
Perform level 1 validation, plus validate that the element value is correct for the data type of the element.
0
Char set validation table No

Indicates the table to use for character set validation. This table is used only when the Validation level attribute is 2.

This attribute refers to the virtual code lists table. The user can create new code lists in the Code Lists tab of the Mapping area in the Data Interchange Services client. This area also contains code lists that are used for other purposes, such as validation of certain EDI elements.

CHARSET
Alphanumeric validation table No

Indicates the table to use for alphanumeric validation. This table is used only when the Validation level attribute is 2.

The attribute refers to the virtual code list tables. The user can create new code lists in the Code Lists tab of the Mapping area in the Data Interchange Services client. This area also contains code lists that are used for other purposes, such as validation of certain EDI elements.

ALPHANUM
Generate group level info only in functional Ack No

This attribute applies to EDI-X12. The values are Yes or No.

Yes
Generate group level information only for functional acknowledgment.
No
Generate full functional acknowledgment detail (for each individual transaction and segments and elements within a transaction).
Limited to protocol or connection No
Century control year

No

When dates are being converted from two-digit years to four-digit years, two-digit years after this value are assumed to have a century value of "19". Two-digit years equal to or before this value are assumed to have a century value of "20".

The valid range is 0-99.

Limited to protocol or connection 10
Detailed validation of segment

No

This attribute applies to the following segment headers and trailers:

  • X12
    • ISA, IEA
    • GS, GE
    • ST, SE
  • EDIFACT
    • UNA
    • UNB, UNZ
    • UNG, UNE
    • UNH, UNT
  • UNTUCS
    • BG, EG
    • GS, GE
    • ST, SE

Valid values are Yes or No.

Yes
Perform detailed envelope segment validation. The depth of checking is controlled by the Validation level attribute.
No
Do not perform detailed envelope segment validation.
Limited to protocol or connection No
TA1 override

No

Allow generation of a TA1 request if indicated in the Interchange envelope segment. Applies only to EDI-X12.

If set to Yes, a TA1 is generated if specified in the Interchange envelope segment.

If set to No, a TA1 is not generated, even if it was specified in the Interchange envelope segment.

Limited to protocol or connection Yes
Discard on error

No

This attribute is used in polymorphic processing.

In the case of a batch that results from de-enveloping, this attribute indicates whether to discard the entire batch if any of the transactions fail.

Valid values are Yes and No.

Limited to protocol or connection No
Connection Profile Qualifier1

No

This attribute is used by the Enveloper to determine which profile to use for an interchange connection. Transactions with different values for this attribute are put into different interchanges.

Interchange qualifier No

The code used to identify the format of the interchange sender or receiver identifier.

Interchange identifier No

Identifies the specific sender or receiver of the document. The type of data entered is determined by the Interchange qualifier attribute.

Interchange usage indicator No

Indicates whether the source documents being translated are classified as Production, Test, or Information documents.

Valid values are P, T, and I.

Group application sender identifier No

Identifies the specific sender of the transaction. This attribute, when agreed to by trading partners, facilitates addressing within a company.

Group application receiver identifier No

Identifies the specific receiver or application of the transaction. This attribute, when agreed to by trading partners, facilitates addressing within a company.

Interchange reverse routing No

Indicates the address to which the recipient should address any replies.

Interchange routing address No

The sub-address code for onward routing.

Group application sender qualifier No

The code used to identify the format of the group application sender identifier.

Group application receiver qualifier No

The code used to identify the format of the group application receiver identifier.

Group application password No

This attribute defines security information.

Data Interchange Services client properties

This section lists the properties that can be set as part of the transformation map in the Data Interchange Services client and their corresponding WebSphere Partner Gateway attributes.

Table 93. Map properties and their corresponding attributes
Data Interchange Services client property Overrides WebSphere Partner Gateway attribute
AckReq Acknowledge Requested
Alphanum Alphanumeric validation table
Charset Char set validation table
CtlNumFlag Control numbers by Transaction Id
EdiDecNot (Decimal notation) Decimal notation
EdiDeDlm (Data element separator) Data element delimiter
EdiDeSep (Repeating data element separator) Repeating data element separator
EdifactGrp Create Groups for EDI
EdiRlsChar (Release character) Release character
EdiSeDlm (Component data element separator) Subelement delimiter
EdiSegDlm (Segment terminator) Segment delimiter
EnvProfName Envelope profile
EnvType Envelope type
MaxDocs Max Transactions Number
Reroute Interchange reverse routing
SegOutput Segment output
ValLevel Validation level
ValErrLevel Max validation error level
ValMap Validation map

Table 94 lists additional Data Interchange Services client properties and their associated WebSphere Partner Gateway attributes.

Table 94. Data Interchange Services client properties and their associated attributes
Data Interchange Services client property Overrides WebSphere Partner Gateway attribute
IchgCtlNum Interchange control number
IchgSndrQl Interchange sender qualifier
IchgSndrId Interchange sender ID
IchgRcvrQl Interchange receiver qualifier
IchgRcvrId Interchange receiver ID
IchgDate Interchange date
IchgTime Interchange time
IchgPswd Interchange password
IchgUsgInd Interchange usage indicator
IchgAppRef Interchange application reference
IchgVerRel Interchange version and release
IchgGrpCnt Number of groups in interchange
IchgCtlTotal Control total from interchange trailer segment
IchgTrxCnt Number of documents in interchange
GrpCtlNum Group control number
GrpFuncGrpId Functional group ID
GrpAppSndrId Group application sender ID
GrpAppRcvrId Group application receiver ID
GrpDate Group date
GrpTime Group time
GrpPswd Group password
GrpVer Group version. Group version
GrpRel Group release. Group release
GrpTrxCnt Number of documents in group
TrxCtlNum Transaction control number
TrxCode Transaction code
TrxVer Transaction version
TrxRel Transaction release
TrxSegCnt Number of EDI Segments in the document

Copyright IBM Corp. 2003, 2005