EDI for Cloud v2 Get Document activity

Introduction

An EDI for Cloud v2 Get Document activity, using its EDI for Cloud v2 connection, retrieves all documents (from a specified partner) from Jitterbit EDI and is intended to be used as a source to provide data in an operation.

Important

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

Create an EDI For Cloud V2 Get Document activity

An instance of an EDI for Cloud v2 Get Document activity is created from an EDI for Cloud v2 connection using its Get Document activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an activity instance in Component reuse.

An existing EDI for Cloud v2 Get Document activity can be edited from these locations:

The design canvas (see Component actions menu in Design canvas).
The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure an EDI For Cloud V2 Get Document activity

Follow these steps to configure an EDI for Cloud v2 Get Document activity:

Step 1: Enter a name and select a partner
Provide a name for the activity and select a partner.
Step 2: Select a document type
Select a document type.
Step 3: Review the data schemas
Any request or response schemas are displayed.

Step 1: Enter a name and select a partner

In this step, provide a name for the activity and select a partner. Each user interface element of this step is described below.

EDI for Cloud v2 Get Document activity configuration step 1

Name: Enter a name to identify the activity. The name must be unique for each EDI for Cloud v2 Get Document activity and must not contain forward slashes / or colons :.
Select a Partner: This section displays partners available in the EDI for Cloud v2 endpoint.
- Selected Partner: After a partner is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of partners. The search is not case-sensitive. If partners are already displayed within the table, the table results are filtered in real time with each keystroke. To reload partners from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload partners from the EDI for Cloud v2 endpoint. This may be useful if partners have been added to Jitterbit EDI. This action refreshes all metadata used to build the table of partners displayed in the configuration.
- Selecting a Partner: Within the table, click anywhere on a row to select a partner. Only one partner can be selected. The information available for each partner is fetched from the EDI for Cloud v2 endpoint:
  - Name: The name of the partner.
  - Description: The description of the partner.
Tip

If the table does not populate with available partners, the EDI for Cloud v2 connection may not be successful, or you may need to add an EDI partner. Ensure you are connected by reopening the connection and retesting the credentials. Once tested, add at least one EDI partner.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a document type

In this step, select a document type. Each user interface element of this step is described below.

EDI for Cloud v2 Get Document activity configuration step 2

Select a Document Type: This section displays document types available in the EDI for Cloud v2 endpoint.
- Selected Partner: The partner selected in the previous step is listed here.
- Selected Document Type: After a document type is selected, it is listed here.
- Search: Enter any column's value into the search box to filter the list of document types. The search is not case-sensitive. If document types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload document types from the endpoint when searching, enter search criteria and then refresh, as described below.
- Refresh: Click the refresh icon or the word Refresh to reload document types from the EDI for Cloud v2 endpoint. This may be useful if document types have been added to Jitterbit EDI. This action refreshes all metadata used to build the table of document types displayed in the configuration.
- Selecting a Document Type: Within the table, click anywhere on a row to select a document type. Only one document type can be selected. The information available for each document type is fetched from the EDI for Cloud v2 endpoint:
  - Name: The name of the document type.
  - Description: The description of the document type.
Tip

If the table does not populate with available document types, the EDI for Cloud v2 connection may not be successful, or you may need to add a new inbound document workflow. Ensure you are connected by reopening the connection and retesting the credentials. Once tested, add an inbound workflow for the partner.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

EDI for Cloud v2 Get Document activity configuration step 3

Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

Important

The eiCloudID value can be used for the docInfo fields in the Get status and Set status activities.

The EDI for Cloud v2 connector uses a custom Jitterbit API.
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the EDI for Cloud v2 endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring an EDI for Cloud v2 Get Document activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

EDI for Cloud v2 Get Document activities can be used as a source with these operation patterns:

Transformation pattern
Two-target archive pattern (as the first source only)
Two-target HTTP archive pattern (as the first source only)
Two-transformation pattern (as the first source only)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.