Guide to getting started with Jitterbit EDI

Introduction

This guide shows you how to set up Jitterbit EDI to process an X12 850 4010 transaction. (You can use another document or standard, but the settings are different.)

This guide takes you through the following tasks:

1. Gather information
2. Generate an ISA ID and add a partner
3. Create one or more workflows
4. Configure EDI settings
5. Prepare an EDI file
6. Configure communications
7. Verify
8. Integrate EDI

1. Gather information

You should coordinate with each of your trading partners to schedule testing and obtain their implementation guides, communication preferences, and test files.

These are the most important things you'll need:

• Your trading partner's EDI implementation guide.

• Your trading partner's FTP connection information. (AS2 and VAN connections are not covered in this guide. If you need to use these, see Communication settings, or contact Jitterbit support or your Customer Success Manager (CSM).)

• An EDI test document.

2. Generate an ISA ID and add a partner

Out of the box, there are no partners set up in Jitterbit EDI. The first time you add one, you are prompted to generate an ISA ID.

To add your first partner and generate your ISA ID, follow these steps:

1. Select EDI > Admin from the Harmony portal menu. The Admin page opens (with an empty Trading Partners pane):

   

2. Click the Add icon in the Trading Partners pane (left), or the Add Trading Partner button (middle). The Add a Trading Partner pane opens:

   

3. This page lists over 1000 partners ready to be added to your environment. To search for the one you want, enter the partner's name or ID into the search bar. (If the partner you want doesn't exist in the system, you must create it yourself.)

4. When you find the partner you want, hover on it, then click its Add button:

   

5. As this is your first time setting up Jitterbit EDI in the selected environment, the following screen opens:

   

   Tip

   You won't see this again unless you set up Jitterbit EDI in a new environment.

6. Select your organization's qualifier code, and enter your company ISA ID.

   Important

   Do not use your production ID in a QA or test environment.

7. When you're sure of your codes, click the Save button.

8. To close the Add a Trading Partner screen, click the Close icon.

9. Select the new partner in the Trading Partners pane (left). In the main area, the Manage workflows tab is selected:

   

3. Create one or more workflows

Once a partner is added, you can define (at least one, but usually many) workflows for the partner.

To create a workflow, follow these steps:

1. With the new partner selected, click the Add New Workflow button. An empty row is added to the list of workflows:

   

2. Click the Map processing menu, then select EDIXml. This reveals more fields. Set them as follows:

   • Direction: Inbound. (Confirm this with the implementation guide or with your trading partner.)

     Tip

     When the direction is Outbound, there's also a Validation switch. If you turn this on, the format of the document is checked before sending.

   • EDI Standard: X12

   • Document type: 850 (Note: For this setup use X12 as your EDI standard and refer to your the implementation guide or ask your trading partner for the qualifier and ISA ID.)

   • Version: 4010

   • Active: Enabled

   

3. Click the Save button.

4. Configure EDI settings

When you add a workflow, the EDI settings tab shows fields applicable to whatever setting you used for EDI Standard (X12 in this case) for the first workflow listed in the Manage Workflows tab. (Until you create your first workflow, the EDI settings tab is empty.) These fields are the EDI envelope settings, used for processing outbound EDI documents.

To configure the EDI envelope settings, follow these steps (refer to your partner's implementation guide for guidance on values, and the EDI envelopes reference section for details of each field):

1. With the new partner selected in the Admin > Trading Partners pane, select the EDI settings tab:

   

2. Expand all sections, then check or change the values according to the details in the partner's EDI implementation guide:

   

3. Click the Save button.

5. Prepare an EDI file

For this step, you'll need to get a test file from your trading partner. If can't get one, use the sample 850 4010, but make sure to change the file's IDs to match your EDI settings.

This example explains how to create the proper header for your test file. The Partner ID and the Company ID are in the Preferred IDs section of the EDI settings tab:

6. Configure communications

Your partner's implementation guide should describe how to send and receive files with the partner. Jitterbit EDI supports communications with FTP (File Transfer Protocol), AS2 (Applicability Statement 2), or using Jitterbit's own VAN (Value-Added Network).

Follow these steps to set up an FTP connection:

1. With the new partner selected, select the Communications settings tab:

   

2. Click the Create button, then select FTP connection. The Create a new FTP connection panel appears:

   

3. Enter values for the following fields:

   

   • Name: A name for the connection.
   • Login: The username for the FTP server.
   • Password: The password for the FTP server. Leave blank if no password has been set.
   • Address: The IP address or host name of the FTP server.
   • Port: The port number. (Your firewall must allow traffic on the port.)
   • Protocol: Select FTP.
   • Security: Select the security type, one of Explicit, Implicit, or None.
   • Mode: Select the FTP mode, Active or Passive.

4. Turn on the Active switch.

5. Expand the Additional Options tab, then turn on the Download active switch.

6. Expand the Automation tab.

7. In the Automation tab, open the Frequency menu, then select 15 minutes.

8. In the Automation tab, click the calendar icon in the Next run field, then select a date and time for the connection to run.

9. In your FTP server's root folder, create two subfolders, Download and Upload. If you are using the test file in this setup guide, or a test file from your trading partner, place it in the Download folder.

7. Verify

To check that your document was sent and the test transaction was successfully processed, look for it on the Transactions page:

If you don’t see it, open the Messaging page, where you should see the transaction and the reason for its failure:

8. Integrate

Once Jitterbit EDI is successfully communicating with partners and processing documents, you can use Integration Studio to automate the other processes you may need to do after sending or receiving an EDI document.

To create an EDI integration project, follow these steps:

1. Create an access token for EDI, selecting the same environment used for your Jitterbit EDI configurations.

2. Select Integration Studio > Projects from the Harmony portal menu.

3. Click the New Project button.

4. Enter a project name, select the same environment used for your Jitterbit EDI configurations, then click the Start designing button.

5. In the open project's design component palette search bar, enter EDI for Cloud v2, then select the found connector.

6. In the EDI for Cloud v2 endpoint configuration, enter the access token, the click the Save Changes button.

7. In the design component palette under Available endpoints, click the Jitterbit EDI V2 endpoint, then drag and drop the Get Document activity to an operation on the design canvas.

8. Configure the Get Document activity:

   1. In step 1, select the trading partner, then click the Next button.

   2. In step 2, select the document, then click the Next button.

   3. In step 3, check the data schema, then click the Finished button.