Configuring Agreements from a BizTalk perspective
Important
Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.
If you're brand new to Logic Apps, then we suggest getting started here:
-
Create your first logic app, or quickly get started using a pre-built template
-
View all the available connectors you can use in your logic apps
Configuring EDI messaging in the Microsoft Azure BizTalk Services Portal is different when compared with BizTalk Server TPM Portal. Following is an overview of the Microsoft Azure BizTalk Services steps to configuring in the Microsoft Azure BizTalk Services Portal:
Log in to the BizTalk Services Portal. The first time you log in, you are prompted to register you/your company’s BizTalk Service deployment. You can then add “partners.” BizTalk Server “Party” and BizTalk Services “Partners” section discusses these steps.
When “partners” are created in the BizTalk Services Portal home page, a profile is automatically created for every partner. You can also create new profiles or update the existing profile. BizTalk Server “Profile” and BizTalk Services “Profile” section discusses this information.
Create an X12 or AS2 agreement between the partners. General Settings, Receive Settings, and Send Settings are configured. BizTalk Server “Agreement” and BizTalk Services “Agreement” section discusses this information.
When complete, deploy the agreement. BizTalk Server “Enable” and BizTalk Services “Deploy section discusses this information.
This topic acts as a guide for configuring EDI components in BizTalk Services compared to BizTalk Server.
BizTalk Server “Party” and BizTalk Services “Partners”
A “party” in BizTalk Server is called a “partner” in BizTalk Services. The following tables compare the “party” settings in BizTalk Server with the “partner” settings in BizTalk Services.
Represent you or your company to send messages or receive messages
This table lists the different tasks involved when registering you or your company’s BizTalk Service deployment. It lists the “party” tasks in BizTalk Server and the replacement “partner” settings in BizTalk Services.
Task |
BizTalk Server |
BizTalk Services |
---|---|---|
Create the “partner” |
In BizTalk Administration, create a new Party and check Local BizTalk processes messages received by the party or supports sending messages from this party. This option establishes you or your company as the service provider. This is the only time you check this option when creating a party. How to Create a Party provides the details. |
The first time you log in to the BizTalk Services Portal, you register you/your company’s BizTalk Service. This is the only time you enter the BizTalk Service. Once configured, the BizTalk Service cannot be deleted. Configuring EDI, AS2, and EDIFACT on BizTalk Services Portal provides the details. |
Optionally, enter additional details, like your name, phone number, e-mail address, etc. |
In BizTalk Administration, open your party properties and add Additional Properties. How to Create a Party provides the details. |
The very first time you log in to the BizTalk Services Portal, you register you or your company’s BizTalk Service. You can later add additional details. Configuring EDI, AS2, and EDIFACT on BizTalk Services Portal provides the details. |
Send |
In BizTalk Administration, open your party properties and select Send Ports. This associates the send port(s) with your service provider party. How to Create a Party provides the details. |
The “send” is configured when an agreement is created between two partners. Specifically:
|
Certificate |
In BizTalk Administration, open your party properties and select Certificate. How to Create a Party provides the details. |
The certificate is associated with you or your company’s profile. When a partner is created, a profile is automatically created. A certificate can then be added to the profile. Specifically:
|
To summarize:
To add you or your company as a service provider in BizTalk Server, create a party and check the Local BizTalk processes messages received by the party or supports sending messages from this party option in the party properties. See How to Create a Party.
To register you or your company’s BizTalk Service, log in to the BizTalk Services Portal for the very first time and enter your properties. See Configuring EDI, AS2, and EDIFACT on BizTalk Services Portal.
Add “partners”
This table lists the task involved when creating a partner. It lists the “party” task in BizTalk Server and the replacement “partner” settings in BizTalk Services.
Task |
BizTalk Server |
BizTalk Services |
---|---|---|
Create the “partner” |
In BizTalk Administration, create a new Party. Do NOT check Local BizTalk processes messages received by the party or supports sending messages from this party. How to Create a Party provides the details. |
In the BizTalk Services Portal home page, click Partners. Manage Partners and Profiles in Azure BizTalk Services provides the steps. |
To summarize on how to create a “partner”:
In BizTalk Server, create a “party.” Do NOT check the Local BizTalk processes messages received by the party or supports sending messages from this party option in the party properties. See How to Create a Party.
In BizTalk Services, create a “partner.” See Manage Partners and Profiles in Azure BizTalk Services.
BizTalk Server “Profile” and BizTalk Services “Profile”
“Profiles” exist in BizTalk Server and BizTalk Services. The following table compares the “profile” settings in BizTalk Server with the “profile” settings in BizTalk Services.
Add a profile
This table lists the task involved to add or edit a profile. It lists the “profile” tasks in BizTalk Server and the replacement “profile” settings in BizTalk Services.
Task |
BizTalk Server |
BizTalk Services |
---|---|---|
Create/edit a profile. |
When a party is created in BizTalk Administration, a profile is automatically created. The profile properties include:
Configuring Business Profile Properties provides the steps to add/edit a party profile. |
When a partner is created in the BizTalk Services Portal, a profile is automatically created. Click the partner name to edit similar properties:
Manage Partners and Profiles in Azure BizTalk Services provides the steps to add and edit a partner profile. |
To summarize on how to create a profile:
When a party is created in BizTalk Server, a profile is automatically created. This profile can be modified. See Managing Business Profiles.
When a party is created in BizTalk Services, a profile is automatically created. This profile can be modified. To start configuring profiles, see Manage Partners and Profiles in Azure BizTalk Services.
BizTalk Server “Agreement” and BizTalk Services “Agreement”
“Agreements” exist in BizTalk Server and BizTalk Services. The following tables compare the “agreement” settings in BizTalk Server with the “agreement” settings in BizTalk Services.
X12 Agreements
Add an Agreement: X12 General settings
This table lists the different tasks involved when adding an agreement and configuring “General” settings. It lists the “agreement” tasks in BizTalk Server and the replacement “agreement” settings in BizTalk Services.
Task |
BizTalk Server |
BizTalk Services |
---|---|---|
Create an agreement: General |
A profile is required to create an agreement. In BizTalk Administration, right-click the profile and create a new agreement. This option displays the following properties:
Configuring General Settings (X12) provides the steps to edit these properties. No identifiers are configured in the General properties in BizTalk Server. |
A profile is required to create an agreement. In the BizTalk Services Portal home page, click Agreements and then click the X12 tab. The General tab is opened and displays the following properties:
|
To summarize on how to create an agreement:
When an agreement is created in BizTalk Server, configure the General settings. See Configuring General Settings (X12).
When an agreement is created in BizTalk Services, configure the General Settings. See Create an X12 Agreement in Azure BizTalk Services.
Add an Agreement: X12 Receive settings
Warning
If you click another tab while creating the agreement, the agreement settings are not saved.
This table lists the different tasks involved when adding an agreement and configuring “Receive” settings. It lists the “agreement” tasks in BizTalk Server and the replacement “agreement” settings in BizTalk Services.
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Receive Properties Location |
When you click OK in the Agreement General Properties, two new tabs display: First Party->Second Party and Second Party->First Party. The Second Party->First Party is the Receive. Important In this scenario, First Party is the Service Provider; which means Local BizTalk processes messages received by the party or supports sending messages from this party is enabled for the First Party. |
In the BizTalk Services Portal home page, click Agreements, click the X12 tab, and then Create Agreement. The General Settings are opened, which are previously described. When the General Settings are added, click Continue to display the Receive properties. Important This agreement in BizTalk Server translate to two separate agreements in BizTalk Services: Agreement 1: First Party is the Hosted Partner. Agreement 2: Second Party is the Hosted Partner. |
Interchange Settings
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Identifiers |
|
The Protocol page has the equivalent settings:
The X12 General Settings have the equivalent settings:
Note In BizTalk Server, the receive agreement and send agreement can have a different pair of sender and receiver identities (ISA 5, ISA6, ISA7, ISA8). In BizTalk Services, the identity pair is the same for receive and send agreements. |
Acknowledgements |
|
The Protocol page has the equivalent settings:
|
Envelopes |
Configured in Send. |
No equivalent configuration. |
Character set and separators |
Character set to be used: Basic, Extended, or UTF8/Unicode. |
No equivalent configuration. |
Local Host Settings |
|
No equivalent configuration. |
Validation |
|
The Protocol page has the equivalent settings:
|
Batch Configuration |
Configured in Send. |
No equivalent configuration. |
Send Ports |
Configured in Send. |
No equivalent configuration. |
Transaction Set Settings
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Transaction Set List |
|
No equivalent configuration. On the other hand, the equivalent is implicit because only the message types configured in the X12 Agreement (Receive Settings, Schemas) are allowed. Messages corresponding to other message types are suspended. |
Validation |
|
The Protocol page has the equivalent settings:
Advanced Settings (Validation) in the Protocol page has the following equivalent settings:
|
Local Host Settings |
|
The Protocol page has the equivalent settings:
|
Envelopes |
Configured in Send. |
No equivalent configuration. |
To summarize on how to add X12 Receive settings:
When an agreement is created in BizTalk Server, configure the General settings and then configure the Receive settings. See Configuring Interchange Settings (X12) and Configuring Transaction Set Settings (X12).
When an agreement is created in BizTalk Services, configure the General Settings and then configure the Receive Settings. See Create an X12 Agreement in Azure BizTalk Services.
Add an Agreement: X12 Send settings
Warning
If you click another tab while creating the agreement, the agreement settings are not saved.
This table lists the different tasks involved when adding an agreement and configuring “Send” settings. It lists the “agreement” tasks in BizTalk Server and the replacement “agreement” settings in BizTalk Services.
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Send Properties Location |
When you click OK in the Agreement General Properties, two new tabs display: First Party->Second Party and Second Party->First Party. The First Party->Second Party is the Send. |
In the BizTalk Services Portal home page, click Agreements, click the X12 tab, and then click Create Agreement. The General Settings are opened, which are previously described. When the General Settings are added, click Continue and then click the Send tab to display the Send properties. |
Interchange Settings
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Identifiers |
|
The Protocol page has the equivalent settings:
No equivalent configuration for the following BizTalk Server settings:
|
Acknowledgements |
|
The Protocol page has the equivalent settings:
|
Envelopes |
|
The Protocol page has the equivalent settings:
In BizTalk Server, you select the transaction type. In BizTalk Services, you select the schema for which these envelope settings should be applied. |
Character set and separators |
|
The Protocol page has the equivalent settings:
|
Local Host Settings |
|
The Protocol page has the equivalent settings:
|
Validation |
|
No equivalent configuration. |
Batch Configuration |
New Batch:
|
The Batching page has the equivalent settings:
|
Send Ports |
Send ports |
The Transport page has the equivalent settings, which include sending the message to Service Bus, BizTalk Services bridge, Microsoft Azure blob destinations, an HTTP URL, an FTP server or an AS2 transport. |
Transaction Set Settings
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Transaction Set List |
|
No equivalent configuration. On the other hand, the equivalent is implicit because only the message types configured in the X12 Agreement (Send Settings, Schemas) are allowed. Messages corresponding to other message types are suspended. |
Validation |
|
The Protocol page has the equivalent settings:
No equivalent configuration for the following BizTalk Server settings:
|
Local Host Settings |
Configured in Receive. |
No equivalent configuration. |
Envelopes |
|
The Protocol page has the equivalent Schemas option. |
To summarize on how to add X12 Send settings:
When an agreement is created in BizTalk Server, configure the General settings, configure the Receive settings, and then configure the Send settings. See Configuring Interchange Settings (X12) and Configuring Transaction Set Settings (X12).
When an agreement is created in BizTalk Services, configure the General Settings, configure the Receive Settings, and then configure the Send Settings. See Create an X12 Agreement in Azure BizTalk Services.
AS2 Agreements
Add an Agreement: AS2 General settings
This table lists the different tasks involved when adding an agreement and configuring “General” settings. It lists the “agreement” tasks in BizTalk Server and the replacement “agreement” settings in BizTalk Services.
Task |
BizTalk Server |
BizTalk Services |
---|---|---|
Create an agreement: General |
A profile is required to create an agreement. In BizTalk Administration, right-click the profile and create a new agreement. This option displays the following properties:
Configuring General Party Properties (AS2) provide the steps to edit these properties. No identifiers are configured in the General properties in BizTalk Server. |
A profile is required to create an agreement. In the BizTalk Services Portal home page, click Agreements and then click the AS2 tab. The General tab is opened and displays the following properties:
|
To summarize on how to add AS2 General settings:
When an agreement is created in BizTalk Server, configure the General settings. See Configuring General Party Properties (AS2).
When an agreement is created in BizTalk Services, configure the General Settings. See Create an AS2 Agreement in Azure BizTalk Services.
Add an agreement: AS2 Receive settings
Warning
If you click another tab while creating the agreement, the agreement settings are not saved.
This table lists the different tasks involved when adding an agreement and configuring “Receive” settings. It lists the “agreement” tasks in BizTalk Server and the replacement “agreement” settings in BizTalk Services.
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Receive Properties Location |
When you click OK in the Agreement General Properties, two new tabs display: First Party->Second Party and Second Party->First Party. The Second Party->First Party is the Receive. |
In the BizTalk Services Portal home page, click Agreements, click the AS2 tab, and then Create Agreement. The General Settings are opened, which are previously described. When the General Settings are added, click Continue to display the Receive properties. |
Identifiers |
|
Equivalent to AS2 Identity in the General Settings. |
Validation |
|
Following are the equivalent configuration settings:
No equivalent configuration for the following BizTalk Server settings:
|
Acknowledgements (MDNs) |
In BizTalk Server, the following acknowledgment options are telling the sending party to include the MDN. Another way of saying this is that receiving party is “requesting” the MDN.
|
In BizTalk Services, acknowledgment messages are sent from the managed partner to the unmanaged partner (based on the Transport URL in the Send Settings). MDN options include:
No equivalent configuration for the following BizTalk Server settings:
|
Local Host Settings |
|
No equivalent configuration. Tracking is enabled at the General Settings. |
Signature Certificate |
|
No equivalent configuration. Certificates are added when a partner is configured. See Manage Partners and Profiles in Azure BizTalk Services. |
Send Ports |
Configured in Send. |
In the Route Settings tab, you can route to the following:
|
To summarize on how to add AS2 Receive settings:
When an agreement is created in BizTalk Server, configure the General settings and then configure the Receive settings. See Configuring AS2 Agreement Properties.
When an agreement is created in BizTalk Services, configure the General Settings and then configure the Receive Settings. See Create an AS2 Agreement in Azure BizTalk Services.
Add an agreement: AS2 Send settings
Warning
If you click another tab while creating the agreement, the agreement settings are not saved.
This table lists the different tasks involved when adding an agreement and configuring “Send” settings. It lists the “agreement” tasks in BizTalk Server and the replacement “agreement” settings in BizTalk Services.
Task |
BizTalk Server setting |
BizTalk Services replacement |
---|---|---|
Send Properties Location |
When you click OK in the Agreement General Properties, two new tabs display: First Party->Second Party and Second Party->First Party. The First Party->Second Party is the Send. |
In the BizTalk Services Portal home page, click Agreements, click the AS2 tab, and then click Create Agreement. The General Settings are opened, which are previously described. When the General Settings are added, click Continue and then click the Send tab to display the Send properties. |
Identifiers |
|
Equivalent to AS2 Identity in the General Settings. |
Validation |
|
Following are the equivalent configuration settings:
No equivalent configuration for the following BizTalk Server settings:
|
Acknowledgements (MDNs) |
In BizTalk Server, the following acknowledgment options are telling the sending party to include the MDN. Another way of saying this is that receiving party is “requesting” the MDN.
|
In BizTalk Services, this setting configures the agreement to send MDN receipts to the sender on the original AS2 message after the message has been delivered. MDN options include:
No equivalent configuration for the following BizTalk Server settings:
|
Local Host Settings |
|
No equivalent configuration. Tracking is enabled at the General Settings. |
Signature Certificate |
|
No equivalent configuration. Certificates are added when a partner is configured. See Manage Partners and Profiles in Azure BizTalk Services. |
Send Ports |
Send ports |
No equivalent configuration. |
To summarize on how to add AS2 Send settings:
When an agreement is created in BizTalk Server, configure the General settings, configure the Receive settings, and then configure the Send settings. See Configuring AS2 Agreement Properties.
When an agreement is created in BizTalk Services, configure the General Settings, configure the Receive Settings, and then configure the Send Settings. See Create an AS2 Agreement in Azure BizTalk Services.
Summary Overview:
In BizTalk Server, an agreement has General Settings, Second Party->First Party (Receive) settings and First Party->Second Party (Send) settings. Each settings section is separated by tabs when creating an agreement in BizTalk Administration. See Managing Agreements.
In BizTalk Services, an agreement has General Settings, Receive Settings and Send Settings. Each settings section is separated by tabs when creating an agreement in the BizTalk Services Portal. See Create an AS2 Agreement in Azure BizTalk Services and Create an X12 Agreement in Azure BizTalk Services.
BizTalk Server “Enable” and BizTalk Services “Deploy
In BizTalk Server, when an Agreement is configured, you Enable the agreement in BizTalk Administration by right-clicking the Agreement and clicking Enable. In BizTalk Services when the Agreement is configured, you Deploy the agreement in the BizTalk Services Portal home page by clicking Deploy.
To summarize deploying the agreement:
In BizTalk Server, you Enable an agreement in BizTalk Administration. See How to Enable or Disable an Agreement.
In BizTalk Services, you Deploy an agreement in the BizTalk Services Portal.
See Also
Configuring EDI, AS2, and EDIFACT on BizTalk Services Portal
EDI, AS2, and EDIFACT Messaging (Business to Business)