Set Transaction Status

Marks a claimed queue item successful or failed.

Behaviour

Risk: Medium · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash

Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.setTransactionStatus

Properties#

Input#

Transaction Item#

TransactionItem · QueueItem · Required · Default: Not specified in package metadata

The claimed item, as Get Transaction Item returned it.

Status#

Status · String · Required · Default: Not specified in package metadata

Successful, or Failed with an error type.

Allowed values: Successful, Failed.

Error Type#

ErrorType · String · Optional · Default: Not specified in package metadata

A business exception is final; an application exception is retried while the queue allows.

Allowed values: ApplicationException, BusinessException.

Shown when Status=Failed.

Reason#

Reason · String · Optional · Default: Not specified in package metadata

Why the item failed, as operators see it.

Shown when Status=Failed.

Options#

Output#

Output · String · Optional · Default: Not specified in package metadata

The item's output data as a JSON document.

Progress#

Progress · String · Optional · Default: Not specified in package metadata

Free-text progress recorded on the item before its status.

Analytics#

Analytics · String · Optional · Default: Not specified in package metadata

Reporting data as a JSON document, checked against the queue's analytics schema.

Output#

Retry Count#

RetryCount · Int32 · Output

How many times the item has been retried, counting a retry this call queued.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Related activities#

• Add Queue Item
• Bulk Add Queue Items
• Delete Queue Items
• Get Queue Items
• Get Transaction Item
• Postpone Transaction Item
• Set Transaction Progress
• Wait Queue Item

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Queues. Keywords: queue, item, transaction, status, complete, fail, successful, business, application, exception, orchestrator.

Properties

Input

Options

Output

Retry and risk

Related activities