Add agreements between partners in integration accounts for workflows in Azure Logic Apps

After you add partners to your integration account, specify how partners exchange messages by defining agreements in your integration account. Agreements help organizations communicate seamlessly with each other by defining the specific industry-standard protocol for exchanging messages and by providing the following shared benefits:

  • Enable organizations to exchange information by using a well-known format.

  • Improve efficiency when conducting business-to-business (B2B) transactions.

  • Make creating, managing, and using agreements easy for building enterprise integration solutions.

An agreement requires a host partner, which is always your organization, and a guest partner, which is the organization that exchanges messages with your organization. The guest partner can be another company, or even a department in your own organization. Using this agreement, you specify how to handle inbound and outbound messages from the host partner's perspective.

This article shows how to create and manage an agreement, which you can then use to exchange B2B messages with another partner by using the AS2, X12, EDIFACT, or RosettaNet operations.

If you're new to logic apps, review What is Azure Logic Apps? For more information about B2B enterprise integration, review B2B enterprise integration workflows with Azure Logic Apps and Enterprise Integration Pack.

Prerequisites

  • An Azure account and subscription. If you don't have a subscription yet, sign up for a free Azure account.

  • An integration account resource where you define and store artifacts, such as trading partners, agreements, certificates, and so on, for use in your enterprise integration and B2B workflows. This resource has to meet the following requirements:

    • Is associated with the same Azure subscription as your logic app resource.

    • Exists in the same location or Azure region as your logic app resource.

    • If you're using the Logic App (Consumption) resource type, your integration account requires a link to your logic app resource before you can use artifacts in your workflow.

    • If you're using the Logic App (Standard) resource type, your integration account doesn't need a link to your logic app resource but is still required to store other artifacts, such as partners, agreements, and certificates, along with using the AS2, X12, and EDIFACT operations. Your integration account still has to meet other requirements, such as using the same Azure subscription and existing in the same location as your logic app resource.

    Note

    Currently, only the Logic App (Consumption) resource type supports RosettaNet operations. The Logic App (Standard) resource type doesn't include RosettaNet operations.

  • At least two trading partners in your integration account. An agreement requires a host partner and a guest partner. Also, an agreement requires that both partners use the same or compatible business identity qualifier that's appropriate for an AS2, X12, EDIFACT, or RosettaNet agreement.

  • Optionally, the logic app resource and workflow where you want to use the agreement to exchange messages. The workflow requires any trigger that starts your logic app's workflow.

If you're new to logic apps, review What is Azure Logic Apps and Quickstart: Create your first logic app.

Add an agreement

  1. In the Azure portal search box, enter integration accounts, and select Integration accounts.

  2. Under Integration accounts, select the integration account where you want to add your partners.

  3. On the integration account menu, under Settings, select Agreements.

  4. On the Agreements pane, select Add.

  5. On the Add pane, provide the following information about the agreement:

    Property Required Value Description
    Name Yes <agreement-name> The name for your agreement
    Agreement type Yes AS2, X12, EDIFACT, or RosettaNet The protocol type for your agreement. When you create your agreement file, the content in that file must match the agreement type.
    Host Partner Yes <host-partner-name> The host partner represents your organization
    Host Identity Yes <host-partner-identifier> The host partner's identifier
    Guest Partner Yes <guest-partner-name> The guest partner represents the organization that communicates with your organization
    Guest Identity Yes <guest-partner-identifier> The guest partner's identifier
    Receive Settings Varies Varies These properties specify how the host partner receives inbound messages from the guest partner in the agreement. For more information, review the respective agreement type:

    - AS2 message settings
    - EDIFACT message settings
    - X12 message settings

    Send Settings Varies Varies These properties specify how the host partner sends outbound messages to the guest partner in the agreement. For more information, review the respective agreement type:

    - AS2 message settings
    - EDIFACT message settings
    - X12 message settings

    RosettaNet PIP references Varies Varies This pane specifies information about one or more Partner Interface Processes (PIP) to use RosettaNet messages. For more information, review Exchange RosettaNet messages.

    Important

    The resolution for an agreement depends on matching the following items that are defined in the partner and inbound message:

    • The sender's qualifier and identifier
    • The receiver's qualifier and identifier

    If these values change for your partner, make sure that you update the agreement too.

  6. When you're done, select OK.

    Your agreement now appears on the Agreements list.

Edit an agreement

  1. In the Azure portal search box, enter integration accounts, and select Integration accounts.

  2. Under Integration accounts, select the integration account where you want to add your partners.

  3. On the integration account menu, under Settings, select Agreements.

  4. On the Agreements pane, select your agreement, select Edit, and make your changes.

  5. When you're done, select OK.

Delete an agreement

  1. In the Azure portal search box, enter integration accounts, and select Integration accounts.

  2. Under Integration accounts, select the integration account where you want to add your partners.

  3. On the integration account menu, under Settings, select Agreements.

  4. On the Agreements pane, select the agreement to delete, and then select Delete.

  5. To confirm that you want to delete the agreement, select Yes.

Next steps