Proposed Pull Request Change

📄 Document Links

View on GitHub View on Microsoft Learn

--- title: Exchange EDIFACT messages in B2B workflows description: Exchange EDIFACT messages between partners by creating workflows with Azure Logic Apps and Enterprise Integration Pack. services: logic-apps ms.suite: integration author: divyaswarnkar ms.author: divswa ms.reviewer: estfan, azla ms.topic: how-to ms.date: 02/10/2025 ms.custom: sfi-image-nochange --- # Exchange EDIFACT messages using workflows in Azure Logic Apps To send and receive EDIFACT messages in workflows that you create using Azure Logic Apps, use the **EDIFACT** connector, which provides operations that support and manage EDIFACT communication. This guide shows how to add the EDIFACT encoding and decoding actions to an existing logic app workflow. When no **EDIFACT** trigger is available, you can any trigger to start your workflow. The examples in this guide use the [Request trigger](../connectors/connectors-native-reqres.md). ## Connector technical reference The **EDIFACT** connector has different versions, based on [logic app type and host environment](logic-apps-overview.md#resource-environment-differences). | Logic app | Environment | Connector version | |-----------|-------------|-------------------| | **Consumption** | Multitenant Azure Logic Apps | **EDIFACT** managed connector (Standard class). The **EDIFACT** connector has only one trigger, but you can use any trigger that works for your scenario. For more information, see the following documentation: <br><br>- [EDIFACT managed connector reference](/connectors/edifact/) <br>- [EDIFACT message limits](logic-apps-limits-and-config.md#b2b-protocol-limits) | | **Standard** | Single-tenant Azure Logic Apps and App Service Environment v3 (Windows plans only) | **EDIFACT** built-in connector and **EDIFACT** managed connector. The built-in version differs in the following ways: <br><br>- The built-in version provides only actions, but you can use any trigger that works for your scenario. <br><br>- Accepts a flat file as input versus XML for the managed version. <br><br>- The built-in version can directly access Azure virtual networks. You don't need an on-premises data gateway.<br><br>For more information, see the following documentation: <br><br>- [EDIFACT managed connector reference](/connectors/edifact/) <br>- [EDIFACT built-in connector operations](#edifact-built-in-operations) <br>- [EDIFACT message limits](logic-apps-limits-and-config.md#b2b-protocol-limits) | <a name="edifact-built-in-operations"></a> ### EDIFACT built-in operations (Standard workflows only) The **EDIFACT** built-in connector has the following actions, which are similar to their counterpart **EDIFACT** managed connector actions, except where noted in [Limitations and known issues](#limitations-known-issues). * [**EDIFACT Encode** action](#encode) * [**EDIFACT Decode** action](#decode) <a name="limitations-known-issues"></a> ### Limitations and known issues * **EDIFACT** built-in connector * This connector's actions currently support payloads up to 100 MB. * The **EDIFACT Decode** action currently doesn't include the following capabilities: * Check for duplicate interchange, group, and transaction set control numbers, if configured. * Preserve the entire interchange. Otherwise, the **EDIFACT Encode** and **EDIFACT decode** built-in connector actions have capabilities similar to their counterpart **EDIFACT** managed connector actions. * This connector's actions currently don't support interchanges with multiple transactions or batched messages. * This connector's actions don't currently emit EDI-specific tracking. ## Prerequisites * An Azure account and subscription. If you don't have a subscription yet, [sign up for a free Azure account](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn). * An [integration account resource](./enterprise-integration/create-integration-account.md) 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: * Both your integration account and logic app resource must exist in the same Azure subscription and Azure region. * Defines at least two [trading partners](logic-apps-enterprise-integration-partners.md) that participate in the **EDIFACT** operation used in your workflow. The definitions for both partners must use the same *business identity* qualifier, which is **ZZZ - Mutually Defined** for this scenario. * Defines an [EDIFACT agreement](logic-apps-enterprise-integration-agreements.md) between the trading partners that participate in your workflow. Each agreement requires a host partner and a guest partner. The content in the messages between you and the other partner must match the agreement type. For information about agreement settings to use when receiving and sending messages, see [EDIFACT message settings](logic-apps-enterprise-integration-edifact-message-settings.md). > [!IMPORTANT] > > The **EDIFACT** connector supports only UTF-8 characters. If your output contains > unexpected characters, check that your EDIFACT messages use the UTF-8 character set. * Based on whether you're working on a Consumption or Standard logic app workflow, your logic app resource might require a link to your integration account: | Logic app workflow | Link required? | |--------------------|----------------| | Consumption | Connection and [link to integration account](enterprise-integration/create-integration-account.md?tabs=azure-portal%2Cconsumption#link-to-logic-app) are required. You can create the connection when you add the **EDIFACT** operation to your workflow. | | Standard | Connection to integration account required, but no link required. You can create the connection when you add the **EDIFACT** operation to your workflow. | * The logic app resource and workflow where you want to use the EDIFACT operations. For more information, see the following documentation: * [Create an example Consumption logic app workflow in multitenant Azure Logic Apps](quickstart-create-example-consumption-workflow.md) * [Create an example Standard logic app workflow in single-tenant Azure Logic Apps](create-single-tenant-workflows-azure-portal.md) * The content to encode or decode. In Consumption workflows, the **EDIFACT** managed connector actions accept an XML message as input. In Standard workflows, the **EDIFACT** built-in connector actions accept a flat file, while the **EDIFACT** managed connector accepts an XML message. <a name="encode"></a> ## Encode EDIFACT messages The **EDIFACT** managed connector action named **Encode to EDIFACT message** action and the **EDIFACT** built-in connector action named **EDIFACT Encode** performs the following tasks, except where noted in [Limitations and known issues](#limitations-known-issues): * Resolve the agreement by matching the sender qualifier & identifier and receiver qualifier and identifier. * Serialize the Electronic Data Interchange (EDI), which converts XML-encoded messages into EDI transaction sets in the interchange. * Apply transaction set header and trailer segments. * Generate an interchange control number, a group control number, and a transaction set control number for each outgoing interchange. * Replace separators in the payload data. * Validate EDI and partner-specific properties, such as the schema for transaction-set data elements against the message schema, transaction-set data elements, and extended validation on transaction-set data elements. * Generate an XML document for each transaction set. * Request a technical acknowledgment, functional acknowledgment, or both, if configured. * As a technical acknowledgment, the CONTRL message indicates the receipt for an interchange. * As a functional acknowledgment, the CONTRL message indicates the acceptance or rejection for the received interchange, group, or message, including a list of errors or unsupported functionality. ### [Consumption](#tab/consumption) 1. In the [Azure portal](https://portal.azure.com), open your logic app resource and workflow in the designer. 1. In the designer, [follow these general steps to add the **EDIFACT** action named **Encode to EDIFACT message by agreement name** to your workflow](create-workflow-with-trigger-or-action.md?tabs=consumption#add-action). > [!NOTE] > > If you want to use **Encode to EDIFACT message by identities** action instead, > you later have to provide different values, such as the **Sender identifier** > and **Receiver identifier** that's specified by your EDIFACT agreement. > You also have to specify the **XML message to encode**, which can be the output > from the trigger or a preceding action. 1. Provide the following connection information for your integration account: | Property | Required | Description | |----------|----------|-------------| | **Connection name** | Yes | A name for the connection | | **Integration account** | Yes | From the list of available integration accounts, select the account to use. | For example:  1. When you're done, select **Create**. 1. In the **EDIFACT** action, provide the following property values: | Property | Required | Description | |----------|----------|-------------| | **Name of EDIFACT agreement** | Yes | The EDIFACT agreement to use. | | **XML message to encode** | Yes | The XML message to encode. Specifically, the business identifier for the message sender as specified by your EDIFACT agreement. | | Other parameters | No | This operation includes the following other parameters: <br><br>- **Data element separator** <br>- **Release indicator** <br>- **Component separator** <br>- **Repetition separator** <br>- **Segment terminator** <br>- **Segment terminator suffix** <br>- **Decimal indicator** <br><br>For more information, see [EDIFACT message settings](logic-apps-enterprise-integration-edifact-message-settings.md). | For example, the payload to encode can be the **Body** content output from the **Request** trigger:  1. Save your workflow. ### [Standard](#tab/standard) #### EDIFACT built-in connector 1. In the [Azure portal](https://portal.azure.com), open your logic app resource and workflow in the designer. 1. In the designer, [follow these general steps to add the **EDIFACT** action named **EDIFACT Encode** to your workflow](create-workflow-with-trigger-or-action.md?tabs=standard#add-action). 1. In the EDIFACT action pane, provide the required property values: | Property | Required | Description | |----------|----------|-------------| | **Message To Encode** | Yes | The flat file content to encode. Specifically, the business identifier for the message sender as specified by your EDIFACT agreement. | | **Advanced parameters** | No | From the list, add any other properties that you want to use. This operation includes the following other parameters: <br><br>- **Sender Identity Receiver Qualifier** <br>- **Sender Identity Receiver Identifier** <br>- **Receiver Identity Receiver Qualifier** <br>- **Receiver Identity Receiver Identifier** <br>- **Name of EDIFACT agreement** | For example, the flat file payload to encode can be the **Body** content output from the **Request** trigger:  1. Save your workflow. #### EDIFACT managed connector 1. In the [Azure portal](https://portal.azure.com), open your logic app resource and workflow in the designer. 1. In the designer, [follow these general steps to add the **EDIFACT** action named **Encode to EDIFACT message by agreement name** to your workflow](create-workflow-with-trigger-or-action.md?tabs=standard#add-action). > [!NOTE] > > If you want to use **Encode to EDIFACT message by identities** action instead, > you later have to provide different values, such as the **Sender identifier** > and **Receiver identifier** that's specified by your EDIFACT agreement. > You also have to specify the **XML message to encode**, which can be the output > from the trigger or a preceding action. 1. Provide the following connection information for your integration account: | Property | Required | Description | |----------|----------|-------------| | **Connection name** | Yes | A name for the connection | | **Integration Account ID** | Yes | The resource ID for your integration account, which has the following format: <br><br>**`/subscriptions/<Azure-subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.Logic/integrationAccounts/<integration-account-name>`** <br><br>For example: <br>`/subscriptions/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/resourceGroups/integrationAccount-RG/providers/Microsoft.Logic/integrationAccounts/myIntegrationAccount` <br><br>To find this resource ID, follow these steps: <br>1. In the Azure portal, open your integration account. <br>2. On the integration account menu, select **Overview**. <br>3. On the **Overview** page, select **JSON View**. <br>4. From the **Resource ID** property, copy the value. | | **Integration Account SAS URL** | Yes | The request endpoint URL that uses shared access signature (SAS) authentication to provide access to your integration account. This callback URL has the following format: <br><br>**`https://<request-endpoint-URI>sp=<permissions>sv=<SAS-version>sig=<signature>`** <br><br>For example: <br>`https://prod-04.west-us.logic-azure.com:443/integrationAccounts/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX?api-version=2015-08-1-preview&sp=XXXXXXXXX&sv=1.0&sig=ZZZZZZZZZZZZZZZZZZZZZZZZZZZ` <br><br>To find this URL, follow these steps: <br>1. In the Azure portal, open your integration account. <br>2. On the integration account menu, under **Settings**, select **Callback URL**. <br>3. From the **Generated Callback URL** property, copy the value. | | **Size of Control Number Block** | No | The block size of control numbers to reserve from an agreement for high throughput scenarios | For example:  1. When you're done, select **Create**. 1. In the EDIFACT action pane, provide the following property values: | Property | Required | Description | |----------|----------|-------------| | **Name of EDIFACT agreement** | Yes | The EDIFACT agreement to use. | | **XML message to encode** | Yes | The XML message to encode. Specifically, the business identifier for the message sender as specified by your EDIFACT agreement. | | Other parameters | No | This operation includes the following other parameters: <br><br>- **Data element separator** <br>- **Release indicator** <br>- **Component separator** <br>- **Repetition separator** <br>- **Segment terminator** <br>- **Segment terminator suffix** <br>- **Decimal indicator** <br><br>For more information, see [EDIFACT message settings](logic-apps-enterprise-integration-edifact-message-settings.md). | For example, the payload to encode can be the **Body** content output from the **Request** trigger:  1. Save your workflow. --- <a name="decode"></a> ## Decode EDIFACT messages The **EDIFACT** managed connector action named **Decode EDIFACT message** action and the **EDIFACT** built-in connector action named **EDIFACT Decode** performs the following tasks, except where noted in [Limitations and known issues](#limitations-known-issues): * Validate the envelope against the trading partner agreement. * Resolve the agreement by matching the sender qualifier and identifier along with the receiver qualifier and identifier. * Split an interchange into multiple transaction sets when the interchange has more than one transaction, based on the agreement's **Receive Settings**. * Disassemble the interchange. * Validate Electronic Data Interchange (EDI) and partner-specific properties, such as the interchange envelope structure, the envelope schema against the control schema, the schema for the transaction-set data elements against the message schema, and extended validation on transaction-set data elements. * Verify that the interchange, group, and transaction set control numbers aren't duplicates (managed connector only), if configured, for example: * Check the interchange control number against previously received interchanges. * Check the group control number against other group control numbers in the interchange. * Check the transaction set control number against other transaction set control numbers in that group. * Split the interchange into transaction sets, or preserve the entire interchange (managed connector only), for example: * Split Interchange as transaction sets - suspend transaction sets on error. The decoding action splits the interchange into transaction sets and parses each transaction set. The action outputs only those transaction sets that fail validation to `badMessages`, and outputs the remaining transactions sets to `goodMessages`. * Split Interchange as transaction sets - suspend interchange on error. The decoding action splits the interchange into transaction sets and parses each transaction set. If one or more transaction sets in the interchange fail validation, the action outputs all the transaction sets in that interchange to `badMessages`. * Preserve Interchange - suspend transaction sets on error. The decoding action preserves the interchange and processes the entire batched interchange. The action outputs only those transaction sets that fail validation to `badMessages`, and outputs the remaining transactions sets to `goodMessages`. * Preserve Interchange - suspend interchange on error. The decoding action preserves the interchange and processes the entire batched interchange. If one or more transaction sets in the interchange fail validation, the action outputs all the transaction sets in that interchange to `badMessages`. * Generate a technical acknowledgment, functional acknowledgment, or both, if configured. * A technical acknowledgment or the CONTRL ACK, which reports the results from a syntactical check on the complete received interchange. * A functional acknowledgment that acknowledges the acceptance or rejection for the received interchange or group. ### [Consumption](#tab/consumption) 1. In the [Azure portal](https://portal.azure.com), open your logic app resource and workflow in the designer. 1. In the designer, [follow these general steps to add the **EDIFACT** action named **Decode EDIFACT message** to your workflow](create-workflow-with-trigger-or-action.md?tabs=consumption#add-action). 1. Provide the following connection information for your integration account: | Property | Required | Description | |----------|----------|-------------| | **Connection name** | Yes | A name for the connection | | **Integration account** | Yes | From the list of available integration accounts, select the account to use. | For example:  1. When you're done, select **Create**. 1. In the **EDIFACT** action, provide the following property values: | Property | Required | Description | |----------|----------|-------------| | **EDIFACT flat file message to decode** | Yes | The XML flat file message to decode. | | Other parameters | No | This operation includes the following other parameters: <br><br>- **Component separator** <br>- **Data element separator** <br>- **Release indicator** <br>- **Repetition separator** <br>- **Segment terminator** <br>- **Segment terminator suffix** <br>- **Decimal indicator** <br>- **Payload character set** <br>- **Segment terminator suffix** <br>- **Preserve Interchange** <br>- **Suspend Interchange On Error** <br><br>For more information, see [EDIFACT message settings](logic-apps-enterprise-integration-edifact-message-settings.md). | For example, the payload to decode can be the **Body** content output from the **Request** trigger:  ### [Standard](#tab/standard) #### EDIFACT built-in connector 1. In the [Azure portal](https://portal.azure.com), open your logic app resource and workflow in the designer. 1. In the designer, [follow these general steps to add the **EDIFACT** action named **EDIFACT Decode** to your workflow](create-workflow-with-trigger-or-action.md?tabs=standard#add-action). 1. In the **EDIFACT** action, provide the following property values: | Property | Required | Description | |----------|----------|-------------| | **Message To Decode** | Yes | The flat file to decode. | | Other parameters | No | This operation includes the following other parameters: <br><br>- **Component Separator** <br>- **Data Element Separator** <br>- **Release Indicator** <br>- **Repetition Separator** <br>- **Segment Terminator** <br>- **Segment Terminator Suffix** <br>- **Decimal Indicator** <br>- **Payload Character Set** <br>- **Segment Terminator Suffix** <br>- **Preserve Interchange** <br>- **Suspend Interchange On Error** <br><br>For more information, see [EDIFACT message settings](logic-apps-enterprise-integration-edifact-message-settings.md). | For example, the payload to decode can be the **Body** content output from the **Request** trigger:  1. Save your workflow. #### EDIFACT managed connector 1. In the [Azure portal](https://portal.azure.com), open your logic app resource and workflow in the designer. 1. In the designer, [follow these general steps to add the **EDIFACT** action named **Decode EDIFACT message** to your workflow](create-workflow-with-trigger-or-action.md?tabs=standard#add-action). 1. Provide the following connection information for your integration account: | Property | Required | Description | |----------|----------|-------------| | **Connection name** | Yes | A name for the connection | | **Integration account** | Yes | From the list of available integration accounts, select the account to use. | For example:  1. When you're done, select **Create**. 1. In the EDIFACT action pane, provide the following property values: | Property | Required | Description | |----------|----------|-------------| | **Name of EDIFACT agreement** | Yes | The EDIFACT agreement to use. | | **EDIFACT flat file message to decode** | Yes | The XML flat file message to decode. | | Other parameters | No | This operation includes the following other parameters: <br><br>- **Component separator** <br>- **Data element separator** <br>- **Release indicator** <br>- **Repetition separator** <br>- **Segment terminator** <br>- **Segment terminator suffix** <br>- **Decimal indicator** <br>- **Payload character set** <br>- **Segment terminator suffix** <br>- **Preserve Interchange** <br>- **Suspend Interchange On Error** <br><br>For more information, see [EDIFACT message settings](logic-apps-enterprise-integration-edifact-message-settings.md). | For example, the payload to decode can be the **Body** content output from the **Request** trigger:  --- ## Handle UNH2.5 segments in EDIFACT documents In an EDIFACT document, the [UNH2.5 segment](logic-apps-enterprise-integration-edifact-message-settings.md#receive-settings-schemas) is used for schema lookup. For example, in this sample EDIFACT message, the UNH field is `EAN008`: `UNH+SSDD1+ORDERS:D:03B:UN:EAN008` To handle an EDIFACT document or process an EDIFACT message that has a UN2.5 segment, follow these steps: 1. Update or deploy a schema that has the UNH2.5 root node name. For example, suppose the schema root name for the sample UNH field is `EFACT_D03B_ORDERS_EAN008`. For each `D03B_ORDERS` that has a different UNH2.5 segment, you have to deploy an individual schema. 1. In the [Azure portal](https://portal.azure.com), add the schema to your integration account resource or logic app resource, based on whether you have a Consumption or Standard logic app workflow respectively. 1. Whether you're using the EDIFACT decoding or encoding action, upload your schema and set up the schema settings in your EDIFACT agreement's **Receive Settings** or **Send Settings** sections respectively. 1. To edit your EDIFACT agreement, on the **Agreements** pane, select your agreement. On the **Agreements** pane's toolbar, select **Edit as JSON**. * In the agreement's `receiveAgreement` section, find the `schemaReferences` section, and add the UNH2.5 value.  * In the agreement's `sendAgreement`section, find the `schemaReferences` section, and add the UNH2.5 value.  ## Next steps * [EDIFACT message settings](logic-apps-enterprise-integration-edifact-message-settings.md)