Add a trading partner in Jitterbit EDI

Introduction

Before you can interact with a trading partner in EDI, you must set up their details on the Trading partners page ( EDI > Trading Partners). If you haven't done this yet, the page is empty:

The left panel has a count of the number of partners added, and an area for creating and assigning labels to partners.

The main panel is Trading partners. It has the following controls:

• Search: Enter a search string to view matching partners.

• View mode: How to view added partners. Select Grid view to view partners as icons on a grid, or List view (the default) to view them in a table.

• Import: Import a trading partner.

• New partner: Add a trading partner.

Add a trading partner

To add a trading partner, follow these steps:

1. Select a Harmony environment from the Environments menu.

2. Click the New partner button. The Add a trading partner drawer opens:

   

3. Use the search bar to find a partner by name or ID, or browse through the pages of available partners using the page navigation buttons. When you find the one you want, hover on it, then click its Add button. The added partner appears in the Trading partners pane, and the drawer closes. Do this for every partner you want to work with. (If the partner you want doesn't exist, you must create it then add it.)

   Note

   The first time you add a partner to an environment, the ISA ID Generation dialog opens, where you must create your first ISA ID.

4. To configure a partner, select it. A drawer opens with the following tabs:

   

   • Manage workflows

   • EDI settings

   • Transaction management

   • Communication settings

   You can adjust the drawer and its contents with the following controls:

   • Previous: Select the previous trading partner.

   • Next: Select the next trading partner.

   • Collapse: Collapse the drawer.

   • Expand: Expand the drawer to fill the page.

   • Return: Return the drawer to its original size.

   • Close: Close the drawer.

Add a user-created trading partner

If you want to add a partner that doesn't exist in the list, you must create it. To do this, follow the steps below.

1. Click the New partner button. The Add a trading partner drawer opens.

2. Click the Create button. The Create New Trading Partner dialog opens.

3. Set values for the following fields:

   • Trading Partner Name: The partner's name.

   • EDI Standard: The EDI communications standard to use with this partner. Choose from EDIFACT, TRADACOMS, or X12.

   • Qualifier: Open the menu and select a qualifier code. (Not available when the EDI standard is TRADACOMS.)

   • ISA ID: The partner's ISA ID. Select a qualifier code from the list. (Not available when the EDI standard is TRADACOMS.) You cannot add a partner ISA ID if it already exists in your environment. If the partner ISA ID you want to add exists in the EDI partner library but not in your current environment, you can click the Add Trading Partner button to add it to the current environment.

4. (Optional) To add an image to represent the partner in the trading partners list, click Upload Image, then select a JPG, PNG, or SVG image file.

5. Check your values carefully, as they can not changed once saved. When you are sure, click Save.

6. The system creates the new partner within the currently selected environment, and adds it to your list of partners. In List view mode, the Type column shows Custom.

To change the name or the logo, follow these steps:

1. Hover on a partner you've created.

2. Click Edit (in the Actions column when in List view mode). The Edit Trading Partner dialog opens.

3. In the dialog, you can do the following:

   • To change the partner name, edit the text in the Trading Partner Name field.

   • To change the logo, click the Replace Image button. To set it, click the Upload Image button.

4. Click the Save button.

Change a trading partner's settings

To edit a trading partner's settings, follow these steps:

1. Select the partner in the Trading Partners pane. If you have a lot of partners, use the search bar to find the one you want.

2. Edit the partner's workflows, EDI settings, transaction management settings, or communication settings.

3. Click Save.

Delete a trading partner

To delete a trading partner, follow these steps:

1. Hover on a partner.

2. Click Delete (in the Actions column when in List view mode). A dialog opens asking you to confirm the action:

   Dialog text

   Delete Trading Partner
   Are you sure you want to delete the Trading Partner partnerName? The trading partner, its settings, and all related workflows will be permanently deleted.

   Please type "DELETE" to confirm.

3. Enter the word DELETE where indicated, then click the Delete button.

   Caution

   This action permanently deletes the partner, its settings, and workflows. (Saved connections are preserved.)

Import or export partners

You can import and export trading partners as JSON-formatted files:

• To import a trading partner definition file, click the Import button, then select a .json file.

• To export one partner, hover on one, then click Export (in the Actions column when in List view mode).

• To export multiple partners, select them, then click Export in the toolbar.

Labels

You can create and assign a label to a partner, then use it to filter your added trading partners. You can create multiple labels, but can only assign one label to a trading partner. Once assigned, the only way to unassign a label is to delete the label.

Create

To create a label, follow these steps:

1. In the left panel, click the + New label icon.

2. Enter the label.

3. Click or press Enter to save it, or to discard it.

Assign

To assign a label, follow these steps:

1. Hover on a partner, then click Label (in the Actions column when in List view mode). The label list opens.

2. If you see the label you want, select it, otherwise use the search bar to find one. When a label is selected, the label list closes.

Delete

To delete a label, follow these steps:

1. Hover on a label.

2. Click Delete.

3. The label is deleted and unassigned from any partners using it.

Filter

To filter your trading partners by label, select a label in the left panel.