AWS b2bi documentation change
Summary
Added detailed control number configuration section, restructured partnership creation steps to include EDI acknowledgment settings, control number management, and new line formatting options
Security assessment
The changes add documentation about control number management which helps prevent duplicate transactions and maintain EDI integrity, but there's no evidence of addressing a specific security vulnerability. The new line formatting warning helps avoid partner rejection but isn't explicitly security-related.
Diff
diff --git a/b2bi/latest/userguide/transform-outbound-variations.md b/b2bi/latest/userguide/transform-outbound-variations.md index e96c6cf56..4997e208b 100644 --- a//b2bi/latest/userguide/transform-outbound-variations.md +++ b//b2bi/latest/userguide/transform-outbound-variations.md @@ -5 +5 @@ -Generating outbound EDICreate a profileCreate an outbound transformerCreate a trading capability for outbound EDICreate partnershipDelimiters for outbound EDI +Generating outbound EDICreate a profileCreate an outbound transformerCreate a trading capability for outbound EDICreate partnershipControl number configurationDelimiters for outbound EDI @@ -226 +226 @@ If you intend to perform outbound EDI transformations with this partner, fill in - 3. Enter header details in the **Outbound EDI configuration**. The system uses the outbound EDI header information to format the outbound EDI document according to the needs of the partner to whom you are sending these documents. + 3. In the **Inbound EDI configuration** section. choose which acknowledgments, if any, to generate. @@ -228 +228 @@ If you intend to perform outbound EDI transformations with this partner, fill in - * Provide **Interchange control header** information: also known as the ISA segment + 1. For **TA1 Technical Acknowledgments** , choose whether or not to generate. @@ -230 +230 @@ If you intend to perform outbound EDI transformations with this partner, fill in - * Provide **Functional group header** information: also known as the GS segment + 2. For **Functional (997 and 999) Acknowledgments** , choose whether or not to generate, and whether or not to include AK2 loop. @@ -232 +232 @@ If you intend to perform outbound EDI transformations with this partner, fill in - * Optionally, specify **Delimiters** +For more information about EDI acknowledgements, see [EDI acknowledgements](./edi-ack.html). @@ -234 +234 @@ If you intend to perform outbound EDI transformations with this partner, fill in -###### Note + 4. Enter header details in the **Outbound EDI configuration**. The system uses the outbound EDI header information to format the outbound EDI document according to the needs of the partner to whom you are sending these documents. @@ -236 +236 @@ If you intend to perform outbound EDI transformations with this partner, fill in -When creating or updating a Partnership, you must specify all delimiters or leave them all blank. Defining certain delimiters, but not others, is not a valid configuration. + 1. Provide **Interchange control header** information (also known as the ISA segment). @@ -238 +238 @@ When creating or updating a Partnership, you must specify all delimiters or leav -Take care when specifying delimiters: for more information, see Delimiters for outbound EDI. + 2. Provide **Functional group header** information (also known as the GS segment). @@ -240 +240 @@ Take care when specifying delimiters: for more information, see Delimiters for o - * Optionally, for **EDI validation** , select **Enable outbound EDI** (selected by default) + 3. Specify starting control numbers. For more information about control numbers, see Control number configuration. @@ -242 +242,5 @@ Take care when specifying delimiters: for more information, see Delimiters for o - 4. Optionally, add tags as needed. + 4. Optionally, specify **Delimiters**. When creating or updating a partnership, you must specify all delimiters or leave them all blank. Defining certain delimiters, but not others, is not a valid configuration. Take care when specifying delimiters: for more information, see Delimiters for outbound EDI. + + 5. In the New Lines Formatting section, specify the behavior that you require. + + * Select a new line formatting configuration option. Choose **New line on character count** only when your trading partner specifically requires it, as trading partners might reject your EDI files because of misinterpretation. @@ -244 +248,7 @@ Take care when specifying delimiters: for more information, see Delimiters for o - 5. After you have configured all of the settings, choose **Create partnership**. + * Choose the character to represent new lines in your generated EDI documents. + + 6. Optionally, for **EDI validation** , select **Enable outbound EDI** (selected by default). + + 5. Optionally, add tags as needed. + + 6. After you have configured all of the settings, choose **Create partnership**. @@ -254,0 +265,51 @@ Finally, we highly recommend that you subscribe to events emitted by B2B Data In +## Control number configuration + +You can configure the starting values for control numbers used in EDI documents generated by AWS B2B Data Interchange. + +A control number is an integer that is used to identify a specific interchange, functional group, or transaction within a functional group as it pertains to a specific trading partner. AWS B2B Data Interchange generates control numbers for each X12 envelope contained in a generated EDI acknowledgement or outbound EDI document. The control numbers created and maintained by B2B Data Interchange include the following: + + * **Interchange Control Number** : For the ISA (interchange) envelope, B2B Data Interchange generates an interchange control number that is unique to the sender ID and receiver ID pair. For example, the first acknowledgement or outbound EDI document sent from **SEND01** to **RECV01** receives an ICN of 001. The next interchange (whether an acknowledgement or outbound EDI document) sent from **SEND01** to **RECV01** receives an ICN of 002, and so on. + +###### Note + +Specifically, this number is unique for the I _SA05 and ISA06 (sender)_ & _ISA07 and ISA08 (receiver)_ combination. + + * **Functional Group Control Number** : For the GS (functional group) envelope, B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination. For example, the first functional group in an interchange sent from **SEND01** to **RECV01** with a functional identifier code of FA, would be assigned a functional group control number of 001. The next functional group (whether in the same interchange or a new interchange) with the same unique combination of sender ID, receiver ID, and functional identifier code is assigned a functional group control number of 002, and so on. + +In the case where there is a functional group with the same sender ID and receiver ID, but a different functional identifier code, the functional group control number would also be 001, as this introduces a new, unique combination of sender ID, receiver ID, and functional identifier code. + +###### Note + +Specifically, the functional group control number is unique for the _GS01 (functional identifier code)_ & _GS02 (sender)_ & _GS03 (receiver)_ combination. + + * **Transaction Set Control Number** : For ST (transactional level) envelope, B2B Data Interchange generates a unique transaction set control number for every transaction in a functional group. For example, if there are three transactions in a functional group, the transactions are assigned transaction set control numbers of 001, 002, and 003. In the case where there is another functional group in the same interchange with two transactions, the transactions in this functional group are assigned transaction set control numbers of 001 and 002. + + + + +The following sample EDI document shows the relationship of the three envelopes (indenting added for readability). + + + ISA*01*0000000000*01*0000000000*ZZ*ABCDEFGHIJKLMNO*ZZ*123456789012345*101127*1719*U*00400*000003438*0*P*> + GS*FA*999999999*4405197800*20111206*1100*1*X*004010VICS + ST*997*0001 + AK1*PO*1421 + AK9*A*1*1*1 + SE*4*0001 + GE*1*1 + IEA*1*000000001 + +### Migration considerations + +When migrating from another EDI system to AWS B2B Data Interchange, you may want to continue the sequence of control numbers from your previous system. Configure the starting control number parameters in your partnership settings to maintain continuity and prevent duplicate interchange and functional group control numbers + +For example, if your previous system used interchange control numbers up to 9999, you could configure AWS B2B Data Interchange to start from 10000: + + + { + "controlNumbers": { + "startingInterchangeControlNumber": 10000 + } + } + + @@ -276 +337 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Inbound EDI +EDI splitting