Step 8: Configure the Trading Partner Agreement between the Parties
In this step, you configure an X12 trading partner agreement to define the parameters for exchanging X12 messages between the two trading partners, OrderSystem and Fabrikam.
Prerequisites
You must be logged on as a member of the BizTalk Server Administrators group.
To configure an agreement
Click Start, click All Programs, click Microsoft BizTalk Server, and then click BizTalk Server Administration.
In the BizTalk Server Administration console, click Parties in the console tree, and in the Parties and Business Profiles page, right-click Fabrikam_Profile, point to New, and then click Agreement.
In the General Properties page, for the Name text box, enter a name for the agreement.
From the Protocol drop-down list, select X12.
In the Second Party section, from the Party drop-down list, select OrderSystem.
In the Second Party section, from the Business drop-down list, select OrderSystem_Profile.
You will notice that two new tabs get added next to the General tab. Each tab is for configuring a one-way agreement and each one-way agreement represents one complete transaction of message (including message transfer and acknowledgement transfer).
In the General tab, on the General Properties page, in the Common Host Settings section, select Turn ON reporting, and then select Store message payload for reporting.
Perform the following tasks on the Fabrikam->OrderSystem tab.
On the Identifiers page under the Interchange Settings section, enter values for the qualifier and identifier fields (ISA5, ISA6, ISA7, and ISA8) that correspond to the values for those header fields in your test message.
Use this To do this Sender qualifier (ISA5) Select ZZ - Mutually Defined. Sender identifier (ISA6) Enter THEM. Receiver qualifier (ISA7) Select ZZ - Mutually Defined. Receiver identifier (ISA8) Enter US. Note
BizTalk Server requires the qualifier and identifier fields for sender and receiver in order to perform agreement resolution. It will match the values of ISA5, ISA6, ISA7, and ISA8 in the interchange header with those in the properties of an agreement. BizTalk Server will also resolve the agreement by matching the sender qualifier and identifier (without the receiver qualifier and identifier). If BizTalk Server cannot resolve the agreement, it will use the fallback agreement properties.
On the Acknowledgements page, under the Interchange Settings section, click 997 Expected. Selecting this check box prompts the receive pipeline to generate a 997 acknowledgment when it receives the 850 interchange..
On the Validation page under the Interchange Settings section, make sure Interchange Control Number (Check for duplicate ISA13) option is unchecked.
Note
Clearing the Check for duplicate ISA13 property enables you to receive multiple instances of the same message.
On the Local Host Settings page, under the Interchange Settings section, clear Route ACK to send pipeline on request-response receive port.
Note
Clearing the Route ACK property is required because this solution returns an asynchronous acknowledgment via a separate send port, rather than a synchronous acknowledgment via the send port associated with a two-way receive port.
On the Local Host Settings page under the Transaction Set Settings section, select the namespace for the schema to be used to process the incoming interchange.
Use this To do this Default Select the checkbox in the column For ST1 Select 850 - Purchase Order. GS2 Enter THEM. Target Namespace Select http://schemas.microsoft.com/BizTalk/EDI/X12/2006.Note
Setting the properties enables BizTalk Server to determine the schema to be used in processing the incoming 850 interchange. If an interchange has the values of GS02 and ST01 that are entered on a line of the grid, then the target namespace for the same line will be used to determine the schema to be used.
Perform the following tasks on the OrderSystem->Fabrikam tab.
On the Identifiers page under the Interchange Settings section, enter values for the qualifier and identifier fields (ISA5, ISA6, ISA7, and ISA8) that correspond to the values for those header fields in your test message.
Use this To do this Sender qualifier (ISA5) Select ZZ - Mutually Defined. Sender identifier (ISA6) Enter US. Receiver qualifier (ISA7) Select ZZ - Mutually Defined. Receiver identifier (ISA8) Enter THEM. On the Charset and Separators page, under the Interchange Settings section, select CR LF for the Suffix property.
On the Send Ports page under the Interchange Settings section, associate the send port that will be sending the acknowledgement back to Fabrikam. In the Send ports grid, under the Name column, click an empty cell, and from the drop-down list, select the send port (toTHEM_997) created for sending the 997 acknowledgement to Fabrikam.
On the Envelopes page under the Transaction Set Settings section, enter values for all columns in the first line of the grid.
Use this To do this Default Select the checkbox in the Default column. Note: When you select this row as the default, the values for GS1, GS2, GS3, GS7, and GS8 are used even if the values for Transaction Type, Version/Release, and Target namespace are not a match for the message. Transaction Type Select the message type of your test message, 850 - Purchase Order. Version/Release Enter the EDI version, 00401. Target namespace Select http://schemas.microsoft.com/Edi/X12.GS1 Verify that PO - Purchase Order (850) is selected. GS2 Enter 1234567.
Sender Application ID.GS3 Enter 0000000.
Receiver Application ID.GS4 Select CCYYMMDD. Note: You have to select the value in the drop-down list, not just click in the field to display the default. If you click in the field without selecting the value from the drop-down list, the value will not actually be selected. GS5 Select HHMM. GS7 Select X - Accredited Standards Committee X12. GS8 Verify that 00401 has been entered. Note
BizTalk Server will set the values for GS01, GS02, GS03, GS04, GS05, GS07, and GS08 of the outbound acknowledgments based on the values entered for Transaction Type, Version/Release, and Target namespace. The send pipeline attempts to match the transaction set type, the X12 version, and the target namespace with the corresponding values in the header of the message. If successful, it uses the GS values associated with the Transaction Type, Version/Release, and Target namespace values.
Click Apply.
Click OK. The newly added agreement is listed in the Agreements section of the Parties and Business Profiles pane. The newly added agreement is enabled by default.
Restart the BizTalk Service. In the BizTalk Server Administration Console, under Platform Settings, click Host Instances, right-click BizTalkServerApplication, and then click Restart.
Note
The BizTalk Service needs to be restarted after EDI status reporting has been activated or deactivated for the change to take effect.
Next Steps
Test the EDI solution as described in Step 9: Test the EDI Solution
See Also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for