Deploy a simple EDI flow

Your EDI integration may differ from this reference implementation. Book time with our technical team to get both a customized integration plan and onboarding support free of cost.

Deploy bootstrap

Bootstrap overview

The implementation uses several Stedi products to store, receive, translate, and send EDI documents.

Inbound EDI

The bootstrap workflow uses the following process to handle incoming EDI:

1. You upload EDI documents to a Stedi bucket in your account. Buckets provide unlimited file storage.
   A trading partner could also add files to the bucket using Stedi SFTP. SFTP provides access to an SFTP endpoint that Stedi hosts.

2. The bucket sends a notification when it receives new documents.

3. The notification invokes a Stedi function called [edi-inbound](https://github.com/Stedi-Demos/bootstrap/tree/main/src/functions/edi/inbound) that contains custom code for the workflow. A Stedi function has access to all the resources in your Stedi account.
4. The function extracts the sender ID (ISA-06) and the receiver ID (ISA-08) from the EDI message. It then uses those IDs to retrieve the partnership information related to those two trading partners from Stedi Stash.
   The partnership information contains an ID for a Stedi guide. Stedi guides map EDI fields to JSON fields for a particular transaction set.
5. The function sends the EDI data and the Stedi guide ID to EDI Translate API, which validates the EDI data and converts it into JSON.

6. The function sends the JSON document to an external endpoint or system outside of Stedi, such as a custom endpoint, an ERP system, or cloud storage. You can configure a webhook for testing.

Outbound EDI

The bootstrap workflow uses the following process to produce outgoing EDI:

1. You manually invoke a function called edi-outbound. For testing, you do this in your Stedi account UI.
   You could also call this function manually using the Stedi CLI. When you call the function, you need to pass in a JSON object containing a sending partner ID, a receiving partner ID, and a payload. The bootstrap repository contains an example payload.

2. The function uses the sending partner ID and receiving partner ID to retrieve partner profiles for both the sender and receiver from Stedi Stash. As with the inbound workflow, the partnership information contains a Stedi guide ID.

3. The function generates control numbers required in the ISA, GS, and ST segments of the EDI message. Control numbers for ISA and GS must be unique across messages, so the workflow uses Stedi Stash to track them.

4. The function uses the control numbers and the information in each partner profile to construct the ISA and GS envelopes.

5. The function passes the guide ID and the JSON to EDI Translate, which translates the data to X12 EDI.

6. The function sends the completed EDI document to a Stedi bucket.

Customize the bootstrap workflow

To create a fully functional EDI integration, trading partners must be able to securely send and receive EDI documents from one another. In order to configure an EDI integration using the boostrap workflow, you also need to create the following resources:

• Partner profiles for both you and your trading partners (senders and receivers)
• Partnerships defining the relationship between you and your partners
• Stash lookup entries for each partner that map their EDI identifiers to their partner profile

This section explains how to edit resources in the bootstrap workflow to exchange EDI files with real trading partners. It also explains how to map the JSON output from EDI Translate into a custom schema for your internal system and add mappings to the bootstrap's Stash keyspace.

Free, custom set-up

Working together helps us understand what Stedi customers need and helps get your integration into production as quickly as possible. Contact us for a free, custom set-up that includes the following support:

• Help customizing the bootstrap workflows for your use cases
• Help deploying the bootstrap architecture to your Stedi account
• Best practices for designing a scalable Stedi integration
• EDI experts to answer your questions
• Live troubleshooting over Slack or video call

Update your partner profile

1. Using the Stedi UI, go to Stash.
2. Open the keyspace called partners-configuration.
3. Edit the key called profile|this-is-me and change the value to the following:

{
 "id": "this-is-me",
 "partnerName": "<YOUR_NAME>",
 "acknowledgementRequestedCode": "<ACKNOWLEDGMENT_REQUEST>",
 "partnerApplicationId": "<GS_APPLICATION_ID>",
 "partnerInterchangeId": "<ISA_ID",
 "partnerInterchangeQualifier": "<ID_QUALIFIER>"
}

Add a partner profile for your trading partners

1. Using the Stedi UI, go to Stash.
2. Open the keyspace called partners-configuration.
3. Add a key called profile|<WORKFLOW_PARTNER_ID> with the following value:

{
 "id": "<WORKFLOW_PARTNER_ID>",
 "partnerName": "<PARTNER_NAME>",
 "acknowledgementRequestedCode": "<ACKNOWLEDGMENT_REQUEST>",
 "partnerApplicationId": "<GS_APPLICATION_ID>",
 "partnerInterchangeId": "<ISA_PARTNER_ID>",
 "partnerInterchangeQualifier": "<PARTNER_ID_QUALIFIER>"
}

4. Add a key called lookup|ISA|<PARTNER_ID_QUALIFIER>/<ISA_PARTNER_ID> with the following value:

{
 "partnerId": "<WORKFLOW_PARTNER_ID>"
}

5. Add a key called partnership|this-is-me|<WORKFLOW_PARTNER_ID> with the following value:

{
 "transactionSets": [
   {
     "description": "<SEND_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "bucketName": "<BUCKET_NAME>",
           "path": "trading_partners/<WORKFLOW_PARTNER_ID>/outbound",
           "type": "bucket"
         }
       }
     ],
     "guideId": "<SEND_GUIDE_ID>",
     "receivingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "sendingPartnerId": "this-is-me",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   },
   {
     "description": "<RECEIVE_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "type": "webhook",
           "url": "<DESTINATION_URL>"
         }
       }
     ],
     "guideId": "<RECEIVE_GUIDE_ID>",
     "receivingPartnerId": "this-is-me",
     "sendingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   }
 ]
}

Map inbound messages to a custom JSON shape

1. Using the Stedi UI, go to Stash.
2. Open the keyspace called partners-configuration.
3. Edit the partnership that has the configuration for the inbound messages.
4. In the value for that configuration, find the transaction set related to messages you receive. (The one where receivingPartnerId is this-is-me.)
5. Add a key mappingId with the value set to your mapping ID. Add it to the object inside the destinations array on the same level as the key destination. For example:

{
 "transactionSets": [
   {
     "description": "<SEND_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "bucketName": "<BUCKET_NAME>",
           "path": "trading_partners/<WORKFLOW_PARTNER_ID>/outbound",
           "type": "bucket"
         }
       }
     ],
     "guideId": "<SEND_GUIDE_ID>",
     "receivingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "sendingPartnerId": "this-is-me",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   },
   {
     "description": "<RECEIVE_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "type": "webhook",
           "url": "<DESTINATION_URL>"
         },
         "mappingId": "01GPXEHSDA5VY0GWMYM74HZP3H"
       }
     ],
     "guideId": "<RECEIVE_GUIDE_ID>",
     "receivingPartnerId": "this-is-me",
     "sendingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   }
 ]
}

Map outbound custom JSON to EDI-like shape

1. Using the Stedi UI, go to Stash.
2. Open the keyspace called partners-configuration.
3. Edit the partnership that has the configuration for the outbound messages.
4. In the value for that configuration, find the transaction set related to messages you send. (The one where sendingPartnerId is this-is-me.)
5. Add a key mappingId with the value set to your mapping ID. Add it to the object inside the destinations array on the same level as the key destination. For example:

{
 "transactionSets": [
   {
     "description": "<SEND_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "bucketName": "<BUCKET_NAME>",
           "path": "trading_partners/<WORKFLOW_PARTNER_ID>/outbound",
           "type": "bucket"
         },
         "mappingId": "01GPXEHSDA5VY0GWMYM74HZP3H"
       }
     ],
     "guideId": "<SEND_GUIDE_ID>",
     "receivingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "sendingPartnerId": "this-is-me",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   },
   {
     "description": "<RECEIVE_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "type": "webhook",
           "url": "<DESTINATION_URL>"
         }
       }
     ],
     "guideId": "<RECEIVE_GUIDE_ID>",
     "receivingPartnerId": "this-is-me",
     "sendingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   }
 ]
}

Automatically send 997 functional acknowledgments in response to inbound documents

1. Using the Stedi UI, go to Stash.
2. Open the keyspace called partners-configuration.
3. Edit the partnership that has the configuration for the inbound messages you would like to send acknowledgments for.
4. In the value for that configuration, find the transaction set related to messages you receive. (The one where receivingPartnerId is this-is-me.)
5. Add a key acknowledgmentConfig with the value set to an object that has a single key acknowledgmentType set to 997 (this is the only type of acknowledgment that is supported).
6. Additionally, add a new transaction set for the 997 acknowledgments to indicate the destination that these documents should be written to. For example:

{
 "transactionSets": [
   {
     "description": "<SEND_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "bucketName": "<BUCKET_NAME>",
           "path": "trading_partners/<WORKFLOW_PARTNER_ID>/outbound",
           "type": "bucket"
         }
       }
     ],
     "guideId": "<SEND_GUIDE_ID>",
     "receivingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "sendingPartnerId": "this-is-me",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   },
   {
     "acknowledgmentConfig": {
       "acknowledgmentType": "997"
     },
     "description": "<RECEIVE_DESCRIPTION>",
     "destinations": [
       {
         "destination": {
           "type": "webhook",
           "url": "<DESTINATION_URL>"
         }
       }
     ],
     "guideId": "<RECEIVE_GUIDE_ID>",
     "receivingPartnerId": "this-is-me",
     "sendingPartnerId": "<WORKFLOW_PARTNER_ID>",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   },
   {
     "description": "Outbound 997 Acknowledgments",
     "destinations": [
       {
         "destination": {
           "bucketName": "<BUCKET_NAME>",
           "path": "trading_partners/<WORKFLOW_PARTNER_ID>/outbound",
           "type": "bucket"
         }
       }
     ],
     "transactionSetIdentifier": "997",
     "usageIndicatorCode": "<USAGE_INDICATOR_CODE>"
   }
 ]
}

Send and receive documents with SFTP