Skip to main content

Update Queue Transaction Data

AutomatR.OrchestratorActivities.UpdateQueueTransactionData

The "Update Queue Transaction Data" activity in AutomatR OrchestratorActivities allows you to modify transaction data for a queue item in Orchestrator. This activity is particularly useful when you need to update or add custom data, a custom status key, or both to a transaction in a queue.

Properties

NameDescription
Input
Transaction IDSpecifies the ID of the transaction to be updated. String variables containing the transaction ID.
Custom DataEnter custom data in dictionary format to associate additional information with the transaction.
Replace Custom DataSelect True or False to indicate whether to replace existing custom data with the provided data. If True, existing custom data is replaced; if False, new data is appended.
Custom Status KeySpecifies a custom status key to be set for the transaction.
Misc
Display NameProvides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name.
Optional
DelaySpecifies the amount of time (in seconds) to wait before executing the "Update Queue Transaction Data" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the time is 1000 milliseconds or 1 sec, i.e., 1.
Output
StatusOutputs the result of the "Update Queue Transaction Data" operation, indicating whether the transaction data was updated successfully or encountered errors. Boolean variables to store the operation result.

How to use:

  1. Drag and drop the "Update Queue Transaction Data" activity onto the workflow.
  2. Configure the properties by specifying the transaction ID and either the custom data, custom status key, or both.
  3. Optionally, configure additional parameters such as delay.
  4. Execute the workflow to modify the specified transaction data in Orchestrator.

Example: Consider an example where the "Update Queue Transaction Data" activity is used to update custom data and a custom status key for a transaction:

Update Queue Transaction Data:
Transaction ID: "123456"
Custom Data: { "Key1": "UpdatedValue1", "Key2": "UpdatedValue2" }
Replace Custom Data: True
Custom Status Key: "UpdatedCustomKey"
Status: isTransactionDataUpdatedSuccessfully

In this example, the activity updates the custom data for the transaction with ID "123456," replacing existing data with the provided values. Additionally, it sets a new custom status key. The result of the operation (success or failure) is stored in the Boolean variable "isTransactionDataUpdatedSuccessfully" for further handling in the workflow.