EDI for Cloud v2 Set Status activity

Introduction

An EDI for Cloud v2 Set Status activity, using its EDI for Cloud v2 connection, updates the status of a document in Jitterbit EDI and is intended to be used as a target to consume data in an operation.

To use the Set Status activity, you must first use a Get document or Send document activity to retrieve the internal document identifier, eiCloudId or docInfo respectively, for the document. eiCloudId and docInfo represent the same identifier. The docInfo value must be provided in the Set Status activity's request schema.

Create an EDI For Cloud V2 Set Status activity

An instance of an EDI for Cloud v2 Set Status activity is created from an EDI for Cloud v2 connection using its Set Status 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 Set Status 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 Set Status activity

Follow these steps to configure an EDI for Cloud v2 Set Status activity:

• Step 1: Enter a name
  Enter a name for the activity.

• Step 2: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name

In this step, enter 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 Set Status 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 Schemas: 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:

    Request Schema Node/Field	Description
    SetDocStatusRequest	Request to update the document transaction message and status.
    docInfo	String of the internal document identifier. It can be obtained using a Get document or Send document activity.
    ref_number	String of an external integration reference number.
    reprocess	Boolean that determines if a document should be reprocessed. Setting this value to true is the same as using the Reprocess button on the EDI Transactions page.
    message	Node representing the message. Messages are shown with documents on the EDI Transactions page.
    type	String of the message type, either Message or Error. These message types will set the document transaction status to Success and Error respectively.
    text	String of the message text.
    messages	Node representing submessages.
    type	String of the submessage type, either Message or Error.
    text	String of the submessage text.

  • Response:

    Response Schema Node/Field	Description
    SetDocStatusResponse	Response from updating the document transaction message and status.
    status	String of the message update's success or failure from EDI.
    message	String of the response status message detailing the message update's success or failure. It will also mention if the document was reprocessed.
    docInfo	Long integer of the internal document identifier.
    blobId	String with the response blob ID. This field may be null.

• 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 Set Status 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 Set Status activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.