Skip to main content

WorkflowServiceParameters

@webda/workflow

Class: WorkflowServiceParameters

Defined in: packages/workflow/src/workflow.service.ts:191

Parameters of the WorkflowService

Extends​

  • ServiceParameters

Constructors​

Constructor​

new WorkflowServiceParameters(): WorkflowServiceParameters

Returns​

WorkflowServiceParameters

Inherited from​

ServiceParameters.constructor

Properties​

allowStoredSystem​

allowStoredSystem: boolean

Defined in: packages/workflow/src/workflow.service.ts:221

Allow useSystem tasks in stored workflows

Default​

false

concurrency​

concurrency: number

Defined in: packages/workflow/src/workflow.service.ts:201

Maximum number of tasks running at once on this replica

Default​

10

flows?​

optional flows?: FlowDefinitionData[]

Defined in: packages/workflow/src/workflow.service.ts:241

Flows to register

leaseDuration​

leaseDuration: number

Defined in: packages/workflow/src/workflow.service.ts:206

Lease of a claimed task (ms), renewed while it runs

Default​

60000

maxBufferedSignals​

maxBufferedSignals: number

Defined in: packages/workflow/src/workflow.service.ts:251

Maximum number of unexpired buffered signals per (event, key): a new one past it is refused

Default​

100

maxContextSize​

maxContextSize: number

Defined in: packages/workflow/src/workflow.service.ts:211

Maximum size of the journal and input of an instance (bytes of JSON)

Default​

262144

maxSignalPayload​

maxSignalPayload: number

Defined in: packages/workflow/src/workflow.service.ts:246

Maximum size of a signal payload (bytes of JSON)

Default​

65536

pollInterval​

pollInterval: number

Defined in: packages/workflow/src/workflow.service.ts:196

Interval between two polls of the worker (ms)

Default​

1000

signalTtl​

signalTtl: string

Defined in: packages/workflow/src/workflow.service.ts:226

How long a signal sent before any wait is kept (Duration syntax)

Default​

"1d"

stopTimeout​

stopTimeout: number

Defined in: packages/workflow/src/workflow.service.ts:237

Grace period of stop() for the running attempts (ms), then they are aborted and their outcome dropped

Default​

30000

storedWorkflowRole​

storedWorkflowRole: string

Defined in: packages/workflow/src/workflow.service.ts:256

Role needed to create, update or delete a stored workflow

Default​

"workflow-admin"

sweepInterval​

sweepInterval: number

Defined in: packages/workflow/src/workflow.service.ts:232

Interval of the recovery sweep (ms): an active instance not updated for this long and without a live task is replayed

Default​

60000

syncInterval​

syncInterval: number

Defined in: packages/workflow/src/workflow.service.ts:265

Without syncPubSub, interval between two reloads of the stored workflows (ms)

Default​

60000

syncPubSub?​

optional syncPubSub?: string

Defined in: packages/workflow/src/workflow.service.ts:260

PubSub service announcing the stored workflow changes to the other replicas

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

worker​

worker: boolean

Defined in: packages/workflow/src/workflow.service.ts:216

Run the worker loop on this replica

Default​

true

Methods​

load()​

load(params?): this

Defined in: packages/workflow/src/workflow.service.ts:272

Parameters​

params?​

any = {}

the input parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with