Queue task activities

Queue task activities in Maestro BPMN processes: required fields for creating, updating, and resolving Orchestrator queue items, organized by activity.

Queue task activities create, update, and resolve Orchestrator queue items from a task in a Maestro BPMN process. Queue activities are accessed from the Action dropdown in a task's Properties panel. Queue activities are available in the following task types — refer to Tasks for the full list:

• Service tasks
• User tasks
• Send tasks
• Receive tasks
• Business rule tasks
• Script tasks

Queue item lifecycle

Estado	How it's reached
Novo	The item is added to the queue.
InProgress	A queue trigger starts a process instance for the item and sets it to InProgress.
Successful / Failed	The process sets the final state with Set transaction status.
Abandonado	Automatic, if an item stays InProgress for 24 hours without reaching a final state. If retry is configured on the queue, Orchestrator clones the item and re-queues it.

Observação:

One queue item starts exactly one Maestro BPMN process instance. A single instance consuming multiple items in a loop isn't supported in this release.

Create queue items

Adds a new item to an Orchestrator queue with New status.

Campo	Required	Description
Queue name	Sim	The Orchestrator queue to add the item to.
Caminho da pasta	Sim	The Orchestrator folder that contains the queue.
Prioridade	Não	The processing priority of the item.
Prazo	Não	The date and time by which the item must be processed.
Adiar data	Não	The earliest date and time the item becomes available for processing.
Custom data	Não	Additional data attached to the item, available to the robot or process that processes it.

Create and wait for queue items

Adds an item to a queue and waits for the item to reach a final state before continuing the process. Uses the same fields as Create queue items.

Bulk add queue items

Adds multiple items to a queue in a single batch, up to 15,000 items per call.

Campo	Required	Description
Queue name	Sim	The Orchestrator queue to add items to.
Caminho da pasta	Sim	The Orchestrator folder that contains the queue.
Itens	Sim	The list of items to add, up to 15,000 per call.
Commit type	Sim	AllOrNothing rejects the entire batch if any item fails validation. ProcessAllIndependently adds all valid items and reports failures individually.

When commit type is ProcessAllIndependently, the activity returns the list of items that failed to be added.

Delete queue items

Removes items with New status from a specified queue.

Campo	Required	Description
Queue name	Sim	The Orchestrator queue to remove items from.
Caminho da pasta	Sim	The Orchestrator folder that contains the queue.
Itens	Sim	The items to remove. Only items with New status can be removed.

Postpone transaction item

Sets a defer date, and optionally a due date, for an in-progress transaction item, and returns the item to New status.

Campo	Required	Description
Defer date	Sim	The earliest date and time the item becomes available for processing again.
Data de conclusão	Não	The deadline by which the item must be processed.

Observação:

Postpone transaction item isn't retried automatically when the underlying call fails with a 4xx error.

Set transaction progress

Updates an InProgress transaction item with a custom status string. The status is visible in Orchestrator.

Campo	Required	Description
Progresso	Sim	A custom text string describing the current processing state of the item.

Set transaction status

Sets the final state of a transaction item to Successful or Failed.

Campo	Required	Description
Status	Sim	Successful or Failed.
Error type	Condicional	Required when status is Failed. BusinessException or ApplicationException.
Motivo do erro	Condicional	Required when status is Failed. A short description of the error.
Detalhes do Erro	Não	Additional error information.

Maestro automatically retries the task unless the underlying call fails with a 4xx error. On failure, the task returns the error code OrchestratorSetTransactionResultFailed.

For the trigger that starts a process from a queue item, refer to Events. For more information about tasks, refer to Tasks in BPMN modeling.