Generating X12 Functional Acknowledgements (997)

Generating Functional Acknowledgements

Boomi 3.x has a built in functionality to generate Functional Acknowledgements (997) EDI files for the documents that are received.
The following steps are required to setup Functional Acknowledgements (hereafter referred to as FAs).

Step 1: Setup Queue

When FAs are generated, the system will require an Outbound queue to send the data.  This queue should contain a transport that will be utilized to send the data out and can vary based on trading partner.
The next step will prompt for this queue name so this step is done first.
You should create an FA queue for each Trading Partner.
One item to note about the queue however is that it must be setup to have a document framework of X12 in order for the data to be processed properly. Also, a schedule is required on the 997 queue for the documents to be sent out to the Trading Partner.

Step 2: Set up Trading Partners

For the system to properly track and generate this data, trading partner information must be setup initially.
From the Designer, Select the Components tab

Right click on "Trading Partners" and select New

Fill in Name – all other items are not mandatory

Select "Document Frameworks" and select X12 EDI from the drop down.
This will bring up three options

• Control Information
• Documents
• Options
  1. Control Information -- this screen is used to populate the ISA and GS information in EDI transmissions.  If EDI transmissions will only be received with FAs sent, this screen should still be filled out.
  2. Documents -- this screen is used to indicate what documents may be received or sent.  Select the type from the drop down and then select the associated EDI profile that goes with it.
  3. Options -- this screen is used to define how FAs should be handled.
     • Inbound Document Split Options -  How the system should process inbound  data
     • Functional Acknowledgement Options -- Whether to acknowledge the functional group, transaction set or not at all.
     • Functional Acknowledgement Queue - Specifies the queue to send the FAs out.
     • Filter FAs -- Determines whether FAs should be sent inbound to processes or filtered out.

Monitoring Functional Acknowledgements

FAs can be monitored by utilizing Boomi System Manager.  Log into the application and select the proper queue from the "Tracking View" screen.  If this screen does not initially appear, click on the queue icon from the left tool bar to activate it.

Inbound EDI
Select the Inbound queue which receives the data

Outbound EDI
Select the Inbound queue which is part of the process that sends the data
After selecting the right queue, a screen similar to the following should appear.  This will provide information on the EDI transmission and whether or not it has been acknowledged.
Note that the actual screen has more information than what is shown below.  There are additional columns to the right of Transaction Set that are viewable via IP Manager.

Note also that the user has the ability to remove rows from this screen.  This is useful if a document for some reason has been received in more than once and only one FA should go back.
The screen can also be filtered to bring up data from a specific date or range of dates.  Select View – Change Filter to bring up the filter screen

Alerting for Overdue or Non-Acknowledged Data sets

Alerting for missing or overdue FAs can be done manually utilizing a process that queries the Boomi database.  This information can then either be written to a file or emailed to a user utilizing a "Message" shape.

The following is a sample SQL statement (assuming MSSQL database) that could be utilized to look for records that meet this criteria.
select distinct datecreated,isacontrolnumber, gscontrolnumber, stcontrolnumber, senderid, receiverid from document, documentframeworkstatus, x12documentdata where document.documentkey = documentframeworkstatus.documentkey and document.documentkey = x12documentdata.documentkey and acknowledgestatus = 0 and document.datecreated < getdate() - 2
The above SQL statement is designed to query the database and indicate which transmissions have not been acknowledged for more than 2 days.