Skip to content

bpmn-server / IConfiguration

Interface: IConfiguration#

Implemented by#

Table of contents#

Properties#

Methods#

Properties#

definitionsPath#

• Optional definitionsPath: string

Defined in#

packages/bpmn-server/src/interfaces/common.ts:10

templatesPath#

• Optional templatesPath: string

Defined in#

packages/bpmn-server/src/interfaces/common.ts:11

timers#

• timers: Object

Type declaration#

Name Type Description
forceTimersDelay? number -
precision? number -
pollInterval? number Milliseconds between re-reads of waiting timers, so a timer another server scheduled is fired here when that server is gone (0: never; default 60000).

Defined in#

packages/bpmn-server/src/interfaces/common.ts:12

database#

• database: IMongoDBDatabaseConfiguration | ISQLiteDatabaseConfiguration

Defined in#

packages/bpmn-server/src/interfaces/common.ts:18

apiKey#

• apiKey: string

Defined in#

packages/bpmn-server/src/interfaces/common.ts:19

moddleOptions#

• Optional moddleOptions: any

Extensions to the BPMN model's types (bpmn-moddle's); reading a model needs them, in and out of the engine.

Defined in#

packages/bpmn-server/src/interfaces/common.ts:21

servicesFile#

• Optional servicesFile: string

The names of the application's services (scanServices in bpmn-web), for what checks models outside the engine. Default: services.json in the current folder.

Defined in#

packages/bpmn-server/src/interfaces/common.ts:23

logger#

• logger: ILogger

Defined in#

packages/bpmn-server/src/interfaces/common.ts:24

serverId#

• Optional serverId: string

This process's identity as a lock owner (default SERVER_ID, else host, process id and a random suffix).

Defined in#

packages/bpmn-server/src/interfaces/common.ts:35

locks#

• Optional locks: Object

Type declaration#

Name Type Description
retryDelay? number Milliseconds between lock tries (1500).
maxTries? number Tries before a lock gives up (20).
staleAfter? number Milliseconds after which a lock or a timer claim is stale (300000).

Defined in#

packages/bpmn-server/src/interfaces/common.ts:36

shutdownTimeout#

• Optional shutdownTimeout: number

How long shutdown() waits for running executions, in milliseconds (10000).

Defined in#

packages/bpmn-server/src/interfaces/common.ts:45

runTimers#

• Optional runTimers: boolean

false: timers are never scheduled: a timer event waits until it is invoked, and no process starts on a timer. It says so in the run's decisions. Default true.

Defined in#

packages/bpmn-server/src/interfaces/common.ts:50

runServiceTasks#

• Optional runServiceTasks: boolean

false: service tasks call nothing: they end with no output, and say so in the run's decisions. Default true.

Defined in#

packages/bpmn-server/src/interfaces/common.ts:52

demo#

• Optional demo: boolean

Deprecated

Both of the above false. Set them instead.

Defined in#

packages/bpmn-server/src/interfaces/common.ts:54

modelHistory#

• Optional modelHistory: boolean

Each save of a model keeps a version in .history/<name>/ beside it, for the editor's History tab (default true).

Defined in#

packages/bpmn-server/src/interfaces/common.ts:56

connectors#

• Optional connectors: IConnectorsConfiguration

Connectors' calls (docs/docs/connectors.md): the defaults a connector's own timeout and retries override.

Defined in#

packages/bpmn-server/src/interfaces/common.ts:58

Methods#

definitions#

▸ definitions(server): IModelsDatastore

Parameters#

Name Type
server any

Returns#

IModelsDatastore

Defined in#

packages/bpmn-server/src/interfaces/common.ts:25

appDelegate#

▸ appDelegate(server): IAppDelegate

Parameters#

Name Type
server any

Returns#

IAppDelegate

Defined in#

packages/bpmn-server/src/interfaces/common.ts:26

dataStore#

▸ dataStore(server): IDataStore

Parameters#

Name Type
server any

Returns#

IDataStore

Defined in#

packages/bpmn-server/src/interfaces/common.ts:27

scriptHandler#

▸ scriptHandler(server): IScriptHandler

Parameters#

Name Type
server any

Returns#

IScriptHandler

Defined in#

packages/bpmn-server/src/interfaces/common.ts:28

cacheManager#

▸ cacheManager(server): ICacheManager

Parameters#

Name Type
server any

Returns#

ICacheManager

Defined in#

packages/bpmn-server/src/interfaces/common.ts:29

documentStore#

▸ documentStore(server): IDocumentStore

The storage adapter both data stores use (MongoDB when absent): an in-memory store, an application's database.

Parameters#

Name Type
server any

Returns#

IDocumentStore

Defined in#

packages/bpmn-server/src/interfaces/common.ts:31

locker#

▸ locker(server): ILockManager

The lock adapter (the data store's own when absent).

Parameters#

Name Type
server any

Returns#

ILockManager

Defined in#

packages/bpmn-server/src/interfaces/common.ts:33

Comments