Skip to content

bpmn-server / Configuration

Class: Configuration#

Implements#

Table of contents#

Constructors#

Properties#

Methods#

Constructors#

constructor#

• new Configuration(«destructured»): Configuration

Each factory given replaces the default one; one left out keeps it.

Parameters#

Name Type
«destructured» any

Returns#

Configuration

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:63

Properties#

definitionsPath#

• Optional definitionsPath: string

Implementation of#

IConfiguration.definitionsPath

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:16

templatesPath#

• Optional templatesPath: string

Implementation of#

IConfiguration.templatesPath

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:17

timers#

• timers: Object

Type declaration#

Name Type
forceTimersDelay number
precision number

Implementation of#

IConfiguration.timers

Defined in#

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

database#

• database: Object

Type declaration#

Name Type
MongoDB { db_url: string ; db: string ; Locks_collection: "wf_locks" ; Instance_collection: "wf_instances" ; Archive_collection: "wf_archives" }
MongoDB.db_url string
MongoDB.db string
MongoDB.Locks_collection "wf_locks"
MongoDB.Instance_collection "wf_instances"
MongoDB.Archive_collection "wf_archives"
loopbackRepositories? any

Implementation of#

IConfiguration.database

Defined in#

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

logger#

• logger: ILogger

Implementation of#

IConfiguration.logger

Defined in#

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

apiKey#

• apiKey: string

Implementation of#

IConfiguration.apiKey

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:30

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.

Implementation of#

IConfiguration.moddleOptions

Defined in#

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

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.

Implementation of#

IConfiguration.servicesFile

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:32

sendGridAPIKey#

• sendGridAPIKey: string

Defined in#

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

serverId#

• Optional serverId: string

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

Implementation of#

IConfiguration.serverId

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:53

locks#

• Optional locks: Object

Type declaration#

Name Type
retryDelay? number
maxTries? number
staleAfter? number

Implementation of#

IConfiguration.locks

Defined in#

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

shutdownTimeout#

• Optional shutdownTimeout: number

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

Implementation of#

IConfiguration.shutdownTimeout

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:55

demo#

• Optional demo: boolean

Deprecated

Both of the above false. Set them instead.

Implementation of#

IConfiguration.demo

Defined in#

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

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.

Implementation of#

IConfiguration.runTimers

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:57

runServiceTasks#

• Optional runServiceTasks: boolean

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

Implementation of#

IConfiguration.runServiceTasks

Defined in#

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

connectors#

• Optional connectors: IConnectorsConfiguration

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

Implementation of#

IConfiguration.connectors

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:59

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

Implementation of#

IConfiguration.modelHistory

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:60

Methods#

definitions#

▸ definitions(server): ModelsDatastore

Parameters#

Name Type
server any

Returns#

ModelsDatastore

Implementation of#

IConfiguration.definitions

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:34

appDelegate#

▸ appDelegate(server): IAppDelegate

Parameters#

Name Type
server any

Returns#

IAppDelegate

Implementation of#

IConfiguration.appDelegate

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:37

dataStore#

▸ dataStore(server): IDataStore

Parameters#

Name Type
server any

Returns#

IDataStore

Implementation of#

IConfiguration.dataStore

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:40

cacheManager#

▸ cacheManager(server): NoCacheManager

Parameters#

Name Type
server any

Returns#

NoCacheManager

Implementation of#

IConfiguration.cacheManager

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:43

scriptHandler#

▸ scriptHandler(server): ScriptHandler

Parameters#

Name Type
server any

Returns#

ScriptHandler

Implementation of#

IConfiguration.scriptHandler

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:46

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

Implementation of#

IConfiguration.documentStore

Defined in#

packages/bpmn-server/src/common/DefaultConfiguration.ts:51

locker#

▸ locker(server): ILockManager

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

Parameters#

Name Type
server any

Returns#

ILockManager

Implementation of#

IConfiguration.locker

Defined in#

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

Comments