AWS::B2BI::Partnership X12InterchangeControlHeaders

In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope. It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AcknowledgmentRequestedCode" : String,
  "ReceiverId" : String,
  "ReceiverIdQualifier" : String,
  "RepetitionSeparator" : String,
  "SenderId" : String,
  "SenderIdQualifier" : String,
  "UsageIndicatorCode" : String
}

YAML

  AcknowledgmentRequestedCode: String
  ReceiverId: String
  ReceiverIdQualifier: String
  RepetitionSeparator: String
  SenderId: String
  SenderIdQualifier: String
  UsageIndicatorCode: String

Properties

AcknowledgmentRequestedCode

Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9]*$

Minimum: 1

Maximum: 1

Update requires: No interruption

ReceiverId

Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9 ]*$

Minimum: 15

Maximum: 15

Update requires: No interruption

ReceiverIdQualifier

Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9]*$

Minimum: 2

Maximum: 2

Update requires: No interruption

RepetitionSeparator

Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

Note

This parameter is only honored for version greater than 401 (VERSION_4010 and higher).

For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.

Required: No

Type: String

Minimum: 1

Maximum: 1

Update requires: No interruption

SenderId

Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9 ]*$

Minimum: 15

Maximum: 15

Update requires: No interruption

SenderIdQualifier

Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9]*$

Minimum: 2

Maximum: 2

Update requires: No interruption

UsageIndicatorCode

Located at position ISA-15 in the header. Specifies how this interchange is being used:

• T indicates this interchange is for testing.

• P indicates this interchange is for production.

• I indicates this interchange is informational.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9]*$

Minimum: 1

Maximum: 1

Update requires: No interruption