Zum Inhalt springen

EDI for Cloud v2 List Transactions activity

Introduction

An EDI for Cloud v2 List Transactions activity, using its EDI for Cloud v2 connection, retrieves transactions from Jitterbit EDI based on specified filter criteria. This activity is intended to be used as a source in operations.

Create an EDI for Cloud v2 List Transactions activity

An instance of an EDI for Cloud v2 List Transactions activity is created from an EDI for Cloud v2 connection using its List Transactions 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 Creating an activity instance in Component reuse.

An existing EDI for Cloud v2 List Transactions activity can be edited from these locations:

Configure an EDI for Cloud v2 List Transactions activity

Follow these steps to configure an EDI for Cloud v2 List Transactions activity:

Step 1: Enter a name

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

  • Name: Enter a name to identify the activity. The name must be unique for each EDI for Cloud v2 List Transactions activity and must not contain forward slashes (/) or colons (:).

  • 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: Review the data schemas

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

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

    The EDI for Cloud v2 connector uses a custom Jitterbit API.

    The request and response data schemas consist of these nodes and fields:

    • Request:

      Here's the updated table with brackets removed from all examples:

      Request schema node/field Description
      Request Request to retrieve a list of transactions
      page Integer specifying the page number for pagination
      pageSize Integer specifying the number of results per page
      partnerName Array of trading partner names to filter by (["partnerName1", "partnerName2]")
      #text String value of the partner name
      documentType Array of document types to filter by ("850", "810")
      #text String value of the document type
      documentID Array of document IDs to filter by (["1000007", "1000008"])
      #text String value of the document ID
      status Array of status values to filter by (["In progress", "Pending"])
      #text String value of the status
      toMe Boolean indicating whether to include inbound transactions
      fromMe Boolean indicating whether to include outbound transactions
      transactionDateFrom String specifying the start date for the transaction date range filter ("2025-08-11")
      transactionDateTo String specifying the end date for the transaction date range filter ("2025-08-20")

    • Response:

      Response schema node/field Description
      Response Response containing the list of transactions
      documents Array of transaction documents matching the filter criteria
      item Individual transaction document
      docInfo The eiCloudID value returned in a Get Document activity
      partnerName String of the trading partner name
      documentID String of the document identifier
      docType String of an EDI document type
      transactionDate String of the transaction date
      amount Decimal value of the transaction amount
      status String of the transaction status
      direction String indicating the transaction direction (inbound/outbound)
      message String containing any transaction message
      statusCode Integer representing the status code
      status String of the overall response status
      message String containing any response message

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the MCP Client (Beta) 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 List Transactions 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 List Transactions activities can be used as a source with these operation patterns:

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.