Articles in this section

Generate functional acknowledgment for an EDI X12 transaction

A functional acknowledgment is a receipt issued by the receiver in response to a transaction sent by a trading partner. This receipt confirms to the sender (trading partner) that their transaction, sent via integrator.io, has been received. The main purpose of the functional acknowledgment (EDI transaction 997) is to reliably confirm the integrity and successful delivery of EDI transactions between trading partners.

A functional acknowledgment includes details such as:

  • Sender and receiver identification

  • Control numbers

  • Date and time of receipt

  • The Status code indicates the transmission's outcome, which can vary depending on the EDI standards, such as ANSI X12 or EDIFACT.

Once the EDI file sent by the trading partner is verified against the file definition rules during export, the verification result must be used as input for import processing. This process generates and sends the Functional Acknowledgment (FA) back to the originator of the EDI file.

DOCS_5519_functional_acknowledgement_drawio.svg

Example of a functional acknowledgement sample file

ISA*01*0000000000*01*0000000000*ZZ*ABCDEFGHIJKLMNO*ZZ*123456789012345*101127*1719*U*00400*000003438*0*P*>~
GS*FA*4405197800*999999999*20111206*1045*49*X*004060~
ST*997*0008*3~
AK1*AA*49*001000~
AK2*100*001*REFNO~
AK3*BEG*01*1*1~
AK4*3*02*1*1~
AK5*A*1*2*1*2*4~
AK9*A*1*2*3*2*1*3*2*4~
SE*31*0008~
GE*1*49~
IEA*1*000000049~

Acknowledgment generation - flows to consider

You can generate acknowledgments for any EDI X12 flow in the Celigo platform, that is, you can acknowledge the data sent to the Celigo platform (completed inbound transfers) from a trading partner. To generate acknowledgments, let us consider the following 2 flows:

  • Flow 1 – An existing EDI flow between two trading partners: An example flow

    • Step 1: An export to get an EDI file from a trading partner (TP1).

    • Step 2: An import that gets the parsed export and then generates the EDI file to send to another trading partner (TP2).

  • Flow 2 – Acknowledgment generation custom flow: This flow shows or acknowledges the completed inbound transfers (exports) in the above flow:

    • Step 1: A listener that is based on the parsed export from Flow 1.

    • Step 2: An import that generates an acknowledgment to the trading partner (TP1) in Flow 1 when EDI files are successfully transmitted.

This article focuses on Flow 2. Flow 1 is out of scope for this article except for the minor configuration required in the export that relates to Flow 2.

Flow 2: Create a functional acknowledgment custom flow

  1. In your integrator.io account, from the respective EDI integration tile, click + Create flow.

    Note

    The flow should be created in the same EDI integration that includes the EDI flows.

  2. On the new flow page, below Sources, click Add source.

  3. In the Application field, enter integrator.io.

  4. From the search results, in the Connectors list, select Celigo integrator.io.

  5. On the Create source window, in the What would you like to do? drop-down menu, select Listen for real-time data from source application.

  6. Click Create flow step.

    Create_source.png
  7. On the Create listener window, provide a Name and Description.

  8. Below the Generate URL & sample data section, next to the Public URL field, click + to generate the URL.

    FA_generate_URL.jpg
  9. Once the public URL is generated, click Save & close.

  10. On the new flow page, below Destination & Lookups, click Add destination/lookup.

  11. On the destination side, you can configure the appropriate trading partner. For more information, see EDI trading partners.

After you configure the source and destination, see the sample image.

FA_generation_flow.png

Important

In the EDI generator helper, add "documentType": "997" in the file definition rules for the FA status column in the Dashboard - EDI Activity to be updated.

FA_reconciliation_FDR_document_type.png

Flow 1: Configure the export with the new listener

  1. In your integrator.io account, select the EDI flow.

  2. In Flow builder, click the the export from which you wish to listen and then send the functional acknowledgment.

  3. On the Edit export window, below How would you like to parse files? section, check the Send functional acknowledgment box.

  4. From the Select listener for functional acknowledgment * drop-down menu, select the listener you created in the previous step.

    FA_fields.jpg

    Note

    Note: In the Select listener for functional acknowledgment * drop-down menu, you will find the listeners from the flows related to that specific integration.

  5. Click Save & close.

After the above configuration is saved, enable the custom flow.

Check the FA status or download the acknowledgment from the dashboard

  1. In integrator.io, from the left menu, click Dashboard.

  2. In the EDI activity tab, view the functional acknowledgment (FA) status or download the acknowledgment (ack) after you run the flow. For more information, see Understand the Dashboard - EDI activity.

    FA_generation_Dashboard.png