Skip to content

bpmn-server / ModelVerifier

Class: ModelVerifier#

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new ModelVerifier(server?, options?): ModelVerifier

Parameters#

Name Type
server? IBPMNServer
options IVerifyOptions

Returns#

ModelVerifier

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:65

Properties#

issues#

• issues: IModelIssue[] = []

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:60

processId#

• processId: string

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:61

services#

• services: any = null

the application's services provider, when it can be had without a running execution

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:63

server#

• Private Optional server: IBPMNServer

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:65

options#

• Private options: IVerifyOptions = {}

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:65

Accessors#

decisionsFolder#

• get decisionsFolder(): string

Returns#

string

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:67

moddleOptions#

• get moddleOptions(): any

Returns#

any

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:87

Methods#

add#

▸ add(severity, code, message, element?): void

Parameters#

Name Type
severity ModelIssueSeverity
code string
message string
element? any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:72

result#

▸ result(): IModelVerification

Returns#

IModelVerification

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:80

verify#

▸ verify(source, name): Promise\<IModelVerification>

Parameters#

Name Type
source string
name string

Returns#

Promise\<IModelVerification>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:91

verifyApplication#

▸ verifyApplication(name, source, definition): Promise\<void>

  1. the application's own checks (appDelegate.verifyModel), reported with these. A check that throws is reported as a warning: it never stops the model being verified.

Parameters#

Name Type
name string
source string
definition any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:147

verifyDataObjects#

▸ verifyDataObjects(processes): void

Data objects are loaded by the application (appDelegate.loadDataObject) when an element connected to them runs: one connected to nothing is never loaded, and an application without loadDataObject loads none.

Parameters#

Name Type
processes any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:167

verifyContainer#

▸ verifyContainer(container): void

Parameters#

Name Type
container any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:192

verifyGateway#

▸ verifyGateway(gateway, incoming, outgoing): void

Parameters#

Name Type
gateway any
incoming any
outgoing any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:256

verifyEventDefinitions#

▸ verifyEventDefinitions(event): void

Parameters#

Name Type
event any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:284

verifyDiagram#

▸ verifyDiagram(root, processes): void

Parameters#

Name Type
root any
processes any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:291

loadDefinition#

▸ loadDefinition(name, source): Promise\<Definition>

Parameters#

Name Type
name string
source string

Returns#

Promise\<Definition>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:310

checkConnector#

▸ checkConnector(node, connector, def): Promise\<void>

A task that calls a connector (docs/docs/connectors.md): it names <connector>/<operationId>, and no service; with a server, the connector and the operation are there and enabled, the operation's required inputs are given, and every input is one of the operation's.

Parameters#

Name Type
node ServiceTask
connector any
def any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:333

verifyExecutables#

▸ verifyExecutables(definition): Promise\<void>

Parameters#

Name Type
definition Definition

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:390

checkDecision#

▸ checkDecision(node, def): Promise\<void>

A business rule task's decision: named, found in the decisions folder, readable and valid, and its result saved (a result variable or output parameters).

Parameters#

Name Type
node BusinessRuleTask
def any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:477

checkScript#

▸ checkScript(script, what, element): void

Parameters#

Name Type
script string
what string
element any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:511

checkServiceReferences#

▸ checkServiceReferences(code, what, element): void

appServices.name in a script or expression must be something the application's services provide: calling one that is not there fails when the process runs; reading one gives undefined, which fails as soon as it is used (Object.keys(appServices.rules)).

Parameters#

Name Type
code string
what string
element any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:527

checkExpression#

▸ checkExpression(expression, what, element): void

Parameters#

Name Type
expression string
what string
element any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:540

checkTemplate#

▸ checkTemplate(text, what, element): void

A text with ${...} parts: each part is an expression.

Parameters#

Name Type
text string
what string
element any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:567

checkValue#

▸ checkValue(value, what, element): void

A value evaluated only when it is an expression ($js, ${js}) or has ${...} parts; any other text is as written.

Parameters#

Name Type
value string
what string
element any

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:574

checkTimer#

▸ checkTimer(timer, element, checkScripts): void

Parameters#

Name Type
timer any
element any
checkScripts boolean

Returns#

void

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:583

knownModels#

▸ knownModels(): Promise\<Set\<string>>

Returns#

Promise\<Set\<string>>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:596

servicesProvider#

▸ servicesProvider(): Promise\<IServiceProvider>

Returns#

Promise\<IServiceProvider>

Defined in#

packages/bpmn-server/src/elements/verifyModel.ts:607

Comments