interface X12InterchangeControlHeadersProperty

Language	Type name
.NET	`Amazon.CDK.aws_b2bi.CfnPartnership.X12InterchangeControlHeadersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsb2bi#CfnPartnership_X12InterchangeControlHeadersProperty`
Java	`software.amazon.awscdk.services.b2bi.CfnPartnership.X12InterchangeControlHeadersProperty`
Python	`aws_cdk.aws_b2bi.CfnPartnership.X12InterchangeControlHeadersProperty`
TypeScript	`aws-cdk-lib` » `aws_b2bi` » `CfnPartnership` » `X12InterchangeControlHeadersProperty`

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_b2bi as b2bi } from 'aws-cdk-lib';
const x12InterchangeControlHeadersProperty: b2bi.CfnPartnership.X12InterchangeControlHeadersProperty = {
  acknowledgmentRequestedCode: 'acknowledgmentRequestedCode',
  receiverId: 'receiverId',
  receiverIdQualifier: 'receiverIdQualifier',
  repetitionSeparator: 'repetitionSeparator',
  senderId: 'senderId',
  senderIdQualifier: 'senderIdQualifier',
  usageIndicatorCode: 'usageIndicatorCode',
};

Properties

Name	Type	Description
acknowledgmentRequestedCode?	`string`	Located at position ISA-14 in the header.
receiverId?	`string`	Located at position ISA-08 in the header.
receiverIdQualifier?	`string`	Located at position ISA-07 in the header.
repetitionSeparator?	`string`	Located at position ISA-11 in the header.
senderId?	`string`	Located at position ISA-06 in the header.
senderIdQualifier?	`string`	Located at position ISA-05 in the header.
usageIndicatorCode?	`string`	Located at position ISA-15 in the header. Specifies how this interchange is being used:.

acknowledgmentRequestedCode?

Type: string (optional)

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.

receiverId?

Type: string (optional)

Located at position ISA-08 in the header.

This value (along with the receiverIdQualifier ) identifies the intended recipient of the interchange.

receiverIdQualifier?

Type: string (optional)

Located at position ISA-07 in the header.

Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

repetitionSeparator?

Type: string (optional)

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.

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 .

senderId?

Type: string (optional)

Located at position ISA-06 in the header.

This value (along with the senderIdQualifier ) identifies the sender of the interchange.

senderIdQualifier?

Type: string (optional)

Located at position ISA-05 in the header.

Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

usageIndicatorCode?

Type: string (optional)

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.