Skip to Content

EDI for Cloud v2 Connection

Introduction

An EDI for Cloud v2 connection, created using the EDI for Cloud v2 connector, establishes access to Harmony EDI. Once a connection is configured, you can create instances of EDI for Cloud v2 activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Important

This connector requires a subscription to Harmony EDI. Contact your Customer Success Manager (CSM) for more information.

Create or Edit an EDI for Cloud v2 Connection

A new EDI for Cloud v2 connection is created using the EDI for Cloud v2 connector from one of these locations:

An existing EDI for Cloud v2 connection can be edited from these locations:

Configure an EDI for Cloud v2 Connection

Each user interface element of the EDI for Cloud v2 connection configuration screen is described below.

EDI for Cloud v2 connection configuration

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each EDI for Cloud v2 connection and must not contain forward slashes / or colons :. This name is also used to identify the EDI for Cloud v2 endpoint, which refers to both a specific connection and its activities.

  • Access Token: If an Environment ID is specified (in Optional Settings), enter the access token associated with the specified environment. If an Environment ID is not specified, enter the access token associated with the project's environment. The access token is generated in the Management Console Access Tokens page.

  • Region: When using agent version 10.73 or earlier, select the Harmony region, one of APAC, EMEA, or NA. When using agent version 10.74 or later, the region of the organization currently being accessed is selected by default.

  • Use Proxy Settings (Private Agent Only): When using a Private Agent, this setting can be selected to use Private Agent proxy settings.

  • Optional Settings: Click to expand additional optional settings:

    • Organization ID: Enter the Harmony organization ID (required when using agent version 10.73 or earlier). When using agent version 10.74 or later, the organization currently being accessed is used when an organization ID is not specified.

    • Environment ID: Enter the Harmony environment ID (required when using agent version 10.73 or earlier). The environment ID is found by hovering over the environment name on the Management Console Environments page. When using agent version 10.74 or later, the environment of the project is used when an environment ID is not specified.

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps

After an EDI for Cloud v2 connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

  • Get Document: Retrieves all documents (from a specified partner) from Harmony EDI and is intended to be used as a source in an operation.

  • Send Document: Sends documents to Harmony EDI and is intended to be used as a target in an operation.

  • Get Status: Retrieves the status of documents from Harmony EDI and is intended to be used as a source in an operation.

  • Set Status: Updates the status of a document in Harmony EDI and is intended to be used as a target in an operation.