Add Queue Item

Adds an item to a queue of the job's workspace.

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.addQueueItem

Properties#

Input#

Queue Name#

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

The name of the queue in the job's workspace.

Payload#

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

The item's data as a JSON document, for example {"invoice":"INV-1"}.

Options#

Reference#

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

The caller's identifier for the item, unique when the queue enforces unique references.

Priority#

Priority · Int32 · Optional · Default: Not specified in package metadata

0 to 100, higher is taken first. Leave at 0 for Priority Band or the queue's default.

Priority Band#

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

Low (25), Normal (50), High (75) or Critical (100). Used when Priority is 0.

Allowed values: Low, Normal, High, Critical.

Defer Until#

DeferUntil · DateTimeOffset? · Optional · Default: Not specified in package metadata

The item stays hidden until this time. Leave empty to make it available at once.

Deadline#

Deadline · DateTimeOffset? · Optional · Default: Not specified in package metadata

When the item must be finished by, for the queue's SLA.

Output#

Item Id#

ItemId · String · Output

The identifier of the created queue item.

Item Number#

ItemNumber · Int64 · Output

The item's number, as the Orchestrator UI shows it.

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#

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

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Queues. Keywords: queue, item, enqueue, add, transaction, orchestrator.

Properties

Input

Options

Output

Retry and risk

Related activities