Skip to main content

Update Item State

Updates the state of a queue item

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

if ContinueOnError property is true, no error is caught when the project is executed even if Catch node is used.

Input​

  • Item ID - The ID of the queue item to update.
  • Progress - The progress of the queue item.
  • Reference - The reference of the queue item.
  • Priority - The priority of the queue item. Possible values are: Low, Normal, High.
  • Status - The status of the queue item. Possible values are: Successful, Failed, Abandoned.
  • Additional Try Count - The additional try count for the queue item.

How It Works​

The Update Item State node modifies the state and properties of a queue item:

  1. Receives Item ID and state update parameters
  2. Validates inputs (Item ID, Progress, Priority, Status, etc.)
  3. Sends update request to Robomotion Orchestrator
  4. Updates item properties:
    • Progress: Custom text to track processing stages
    • Priority: Changes item priority (Low/Normal/High)
    • Status: Marks as Successful, Failed, or Abandoned
    • Additional Try Count: Adds more retry attempts
    • Reference: Updates reference information
  5. The updated item becomes available based on new state

Requirements​

  • Item ID must be provided (from Get Next Item or Wait Item)
  • The item must exist in the queue
  • Appropriate permissions to update queue items

Error Handling​

Error CodeDescriptionSolution
Core.Queue.Update.ErrOnCreateFailed to parse node configurationVerify node configuration is valid JSON
Core.Queue.Update.OnMessageMessage parsing failedCheck input message format is valid
Core.Queue.Update.OnMessage"Get item id error"Ensure Item ID is provided
Core.Queue.Update.OnMessage"Get item progress error"Verify Progress input is valid string
Core.Queue.Update.OnMessage"Get item reference error"Verify Reference input is valid string
Core.Queue.Update.OnMessageHTTP request errorCheck network connectivity
Core.Queue.Update.OnMessageAPI returned errorVerify item exists and you have permissions
Core.Queue.Update.OutputMarshalFailed to serialize outputCheck message structure

Usage Examples​

Example 1: Mark Item as Successfully Processed​

Complete processing and mark item as successful:

[Get Next Item] → itemId, itemData
    ↓
[Process Data Successfully]
    ↓
[Update Item State]
    Item ID: ${itemId}
    Status: Successful
    Progress: "Completed"
    ↓
[Delete Item]

Example 2: Handle Processing Failure with Retry​

Mark item as failed to allow retry:

[Get Next Item] → itemId, itemData
    ↓
[Try: Process Item]
    ↓ (error caught)
[Update Item State]
    Item ID: ${itemId}
    Status: Failed
    Progress: "API call failed - will retry"
    Reference: `Error: ${error.message}`

Result: Item returns to queue for retry (if tries remaining)

Example 3: Track Processing Stages​

Use Progress to track multi-stage processing:

[Get Next Item] → itemId, itemData
    ↓
[Update Item State: Progress = "Validating"]
    ↓
[Validate Data]
    ↓
[Update Item State: Progress = "Processing"]
    ↓
[Process Data]
    ↓
[Update Item State: Progress = "Saving"]
    ↓
[Save to Database]
    ↓
[Update Item State: Status = Successful, Progress = "Complete"]

Usage Notes​

  • When Continue On Error is enabled, errors are not caught even if Catch node is present
  • Status values:
    • Successful: Item completed successfully, won't be retried
    • Failed: Item failed, will retry if attempts remain
    • Abandoned: Item exceeded max retries or permanently failed
  • Priority values: Low (1), Normal (2), High (3)
  • Progress is a freeform text field for tracking stages
  • Additional Try Count adds more retry attempts to the item
  • Reference can be updated to add notes or error messages
  • Updating status to Successful or Abandoned removes item from active processing
  • Failed items return to queue for retry if try count allows

Tips​

  • Always update status after processing (Successful or Failed)
  • Use Progress field to track multi-step processing for debugging
  • Add error messages to Reference for failed items
  • Set Status to Successful before Delete Item to maintain clean audit trail
  • Use Failed status for retriable errors (network issues, temporary failures)
  • Use Abandoned status for permanent failures (data corruption, business rule violations)
  • Increase Additional Try Count cautiously - investigate why retries are needed
  • Update Priority to escalate urgent items
  • Track Progress for long-running processes to show intermediate states
  • Combine with Log node to record state changes
  • Use reference field to store error details or processing notes