Creating an Outbound EDI Transactions
- Akash Kumar Jaiswal (Unlicensed)
- Rohan Dhanwade (Deactivated)
You can create an EDI transaction by using prebuilt EDI Template bundled with Connect. Use this template to create an EDI Outbound Transaction.
Before you start creating, ensure that you have created an EDI Partner and Data Dictionary.
To create an EDI Outbound Transaction:
- Click Transactions > Templates.
On the Templates screen, search EDI Outbound in the Search bar.
- Click for the EDI Outbound Template to create an EDI Transaction.
Connect automatically populates the name and description for the Transaction, you can edit the name and description, if necessary.
In the Select Project field, select a project with which you want to associate the transaction.
The Select Project field is available only when you log in as a user with Company Only role type.Click Continue to define the Network and Partner.
Choose the Network and Partner from the list. Only EDI Partners will be populated in the Partner drop-down list.
To select multiple Networks from the drop-down list, click on the networks one by one.Click Next to define the EDI Configuration.
On the EDI Configuration window, do the following:
Select the EDI standard from the EDI Standard drop-down list. The available options are X12, HIPAA, and EDIFACT.
- Select the version from the EDI Standard Version drop-down list. This list will have all the EDI versions you have created in the Data Dictionary. You will find 004010, 005010, and EDIFACT_D96A as a default EDI version.
- Provide the assigned code in the Association Assigned Code text box.
- On the basis of the selected EDI version, the list of transaction set codes is populated in the Transaction Set Code drop-down list. Select the code from the drop-down list.
Select the indicator from the Test/Production Indicator drop-down list. The available options are T-Test and P-Production.
Select the option from the Expect Acknowledgement drop-down list. Select Yes to receive an acknowledgment for the outbound messages sent.
Provide the number of hours elapse before an expected functional acknowledgment is considered as overdue in the Hours Overdue text box.
To receive an acknowledgment for the outbound messages sent, you need to create an EDI Inbound Transaction using 997 Transaction Set Code. While creating an EDI Inbound Transaction, following fields must have the same values provided while creating EDI Outbound Transaction.
- Partner Name
- EDI Standard Version
- Association Assigned Code
- Test/Production Indicator
After you have selected the values in the above fields, select 997 in the Transaction Set Code. When you select 997 in the Transaction Set Code, an Acknowledgment Processing Type drop-down list appears. Following are the available options:
Reconcile Send acknowledgment for receiving the acknowledgment of an outbound message sent. Transform Transform 997 EDI Transaction Set Code to another EDI Transaction Set Code. Reconcile
and
TransformSend acknowledgment for receiving the acknowledgment of an outbound message sent and transform
997 EDI Transaction Set Code to another EDI Transaction Set Code.Option
Description
Select Use Global Transaction Control No check box to use the control number defined while adding a Partner.
- Type the last used transaction control number in the Last used Transaction Control No text box. The value is populated automatically based on the selected Transaction Set Code defined in Step d.
- The value in the Responsible Agency Code is populated automatically based on the Transaction Set Code you have selected.
- Select Compliance Check check box to execute a compliance check on your document.
In the Data encryption at rest field, select either of the following options.
Option
Description
Use Global Policy Select 'Use Global Policy' to use Global Property value for Template. Yes Select 'Yes' to enable EAR for Template. It will not use Global Property value. No Select 'No' to disable EAR for Template. It will not use Global Property value. Select the mode of transfer from the Batch Mode drop-down list. Select Yes to generate the multiple group
segments within a single ISA and define the schedule for the batch process to send the outbound EDI message at defined intervals to the Partner.A Generate Multiple Groups check box appears, select this checkbox to generate the multiple group segments within a single ISA. This is only applicable when Batch Mode is selected as Yes.
A Schedule drop-down list appears. Click to create a Calendar Event. On the Calendar Event window:
- Provide the name and description of the Calendar Event in the text boxes.
- Select the date from which Calendar event will start and stop triggering in the Event Start Date and Event Expiry Date. Click to select the date from the calendar. The date must be in MM/dd/yyyy format.
- Select the start and expiry time from the Time drop-down list.
Select the days of the week on which the event should fire from the Firing Days drop-down list. Following are the available options:
Option Description All Days
The event will fire on all days (Mon to Sun) of the week.
Business Days
The event will fire from Monday to Friday excluding holidays.
Week Days
The event will fire from Monday to Friday even if there are any holidays.
- Define the frequency of execution in the Firing Schedule. You need to define the frequency using Cron Expression. Click Help to know more about Cron Expressions.
- Select Content Based Routing check box to select the Partner (to send the data) based on the content of the outbound source file. For example, based on the value of a particular field of the source file you want to decide to which Partner outbound message should be sent. Content-based routing is used when data of one source file should go to the multiple Partners.
- Expand Group Envelope Properties.
- The value in the Functional ID is populated automatically based on the Transaction Set Code you have selected.
- Provide the Sender ID and Receiver ID in the text boxes.
- Select the Use Global Control No check box to use the group control number defined while adding a Partner.
Type the last used group control number in the Last Used Control Number text box.
- The value in the Responsible Agency Code and Envelope Version are populated automatically based on the Transaction Set Code you have selected.
- Select the Sequence from Group check box to follow the same sequence of the group. On selecting the check box, Format drop-down list appears. Select the format of the control number from the Format drop-down list.
- Expand ISA Envelope Properties.
- Click to create the new one. The Create EDI ISA Envelope window appears.
- Type the name and description for the ISA Outbound Envelope activity in the Name and Description text boxes.
- Type the value in the Authorization code qualifier,default is 00. This is a required field with a maximum of two characters.
- Type the code in the Authorization code. This is an optional alphanumeric field, with a minimum of one character and a maximum of 10 characters.
- Type the value in the Security code qualifier,default is 00. This is a required field with a maximum of two characters.
- Type the code in the Security code. This is an optional alphanumeric field, with a minimum of one character and a maximum of 10 characters.
- Type the value in the Interchange SenderID qualifier. This is a required field with a maximum of two characters.
- Type the code in the Interchange SenderID. This is an alphanumeric field, with a minimum of one character and a maximum of 15 characters.
- Type the value in the Interchange ReceiverID qualifier. This is a required field with a maximum of two characters.
- Type the code in the Interchange ReceiverID. This is an alphanumeric field, with a minimum of one character and a maximum of 15 characters.
- Type the code in the Interchange Standards Identifier. This is a required field with a maximum of one character.
- Select the version from the Interchange VersionID.
- Select Use Global Interchange Control No check box to use the interchange control number defined in the outbound Partner of this ISA outbound envelope activity.
- Type the control number in the Interchange Control No. This is a required field with a maximum of nine characters.
- Select Yes from the Acknowledgement drop-down list to receive an acknowledgment for the messages sent.
- Select the indicator from the Test/Production Indicator drop-down list.
- Provide the required separator in the Element Separator and Sub-element Separator. Select Hex Format check box for the hexadecimal values.
- Provide the single separator in the Segment Terminator. Select Hex Format check box for the hexadecimal values. This character indicates the end of an EDI segment. In an X12 interchange, the segment terminator is defined as the character in the last character position of the ISA segment.
- Provide the single separator in the Repetition Separator. Select Hex Format check box for the hexadecimal values.The repetition separator is used to separate segments that repeat within a transaction set.
Select an appropriate segment line break from the Segment line break text box to display your EDI file data in a block format. Following are the available options:
Option Name Description CR-Carriage Return
Appends a \n as segment terminator.
LF-Line Feed
Appends a \r as segment terminator.
CR LF-Carriage Return/Line Feed
Appends a \r\n as segment terminator.
- Select a project to associate your activity from the Project drop-down list.
- Click Save.
- Click to create the new one. The Create EDI ISA Envelope window appears.
Click Next to define the Source application account.
Select the source application. The supported applications are Database, File, FTP, and JMS.
Click Next. Depending on the chosen Source application in the Template you are using, you need to select the account. You can either use an existing account or create a new one. Click to add a new account. For information on how to add a new account, refer to Appendix C: Supported Applications.
For Database, you need to define the Database Source and Database Event. For more information, click here.
For FTP, you need to select the trigger, FTP Account, and configuration details. For more information, click here.
For File, you need to define the File Event. For more information, click here.
For JMS, you need to define the JMS Event. For more information, click here.
Click Next to define the source format and layout. This screen appears only for FTP and File Source applications.
Select the source data format and source data layout for the Source application. Source data format is the format in which the data of the source file exists, for example, text, excel. Source data layout is the layout of the source file. You can either use the existing layout or create a new layout. To create a new layout, click .
Click Next to define the encryption. This screen appears only for FTP and File Source applications.
Select the Is Source File Encrypted? check box if the source file is in the encrypted form. On selecting the check box, you need to provide the key details.
Field Name Description Key Manager Select the Key Manager from the list. To create a Key Manager, visit Account > Security Settings. To create a Key Manager, click here. Key Name The default value is the default. Private Key Password Password of the key. Confirm Password Confirm the password of the key. Click Next to select the destination application. The supported applications are File, FTP, JMS, and Spazio MFT/s.
Click Next. The next screen differs depending upon the chosen Destination application.
For FTP, you need to select the action, FTP Account, and configuration details. For more information, click here.
For File, you need to define the LAN Target. For more information, click here.
For JMS, you need to define the JMS Target. For more information, click here.
For Spazio MFT/s, you need to define the Spazio MFT Target. For more information, click here.
Click Next to define the file generation policy details. This screen appears only for FTP and File Destination applications.
Provide the details in the corresponding fields.
- Browse to and select the file.
- Type the name of the destination file in the File Name text box to define the pattern of destination file name. In case, you want the destination file name to be same as the source file name, type $$baseInputFileName$$ as a value in the File Name text box. File Name can contain date-time stamp followed by % in the format: File_Name%%dd-mm-yy_hhmmssSS%%. For example, test_output%%01-01-2016_15-15-23%%.
Select Add Time Stamp check box to add the time stamp in the file. Select the date and time format from the Time Stamp Format drop-down list. This appends the selected date and time stamp in the name of the newly created file.
Select the Create Unique File check box to have a unique name in each destination file created. When this option is selected, a unique number is appended to the file name.
- Type the extension of the file in the File Extension text box.
- Click Next to define the encryption. This screen appears only for FTP and File Destination applications.
Select Want to encrypt target file? check box if you want to encrypt the destination file. On selecting the check box, new fields appear. Provide the details in the corresponding fields and click Next.
- Click Next to define the routing. This screen appears if you have selected Content Based Routing check box while defining EDI settings.
Provide the details in the fields.
- Click Next to define the mapping.
- Define the mapping between the fields of the selected source and the destination application.
Click Save & Exit to save the Transaction.
This creates the Transaction and is listed in the Transactions screen.