Module: processHelper

This module is supposed to aid in the creation of Proceed processes with MS specific information

e.g. values from the MS store or meta data not stored in the bpmn

Source:

Methods

(async, inner) createProcess(processInfo, noDefaultsopt) → {ProcessInfo}

Creates a new proceed process either from a given bpmn or from a default bpmn template creates a bpmn and a meta info object

Parameters:
Name Type Attributes Default Description
processInfo Object

the initial process meta info and optional bpmn
noDefaults Boolean <optional>
 false

if the meta info is not supposed to be completed with default values (defaults to false)
Source:
Returns:

the process bpmn and meta information

Type
ProcessInfo

(inner) getDefaultProcessMetaInfo() → {ProceedProcess}

Creates a default process meta object containing all fields we expect a process meta object to have

Source:
Returns:

object containing all the necessary meta info of a process with default values

Type
ProceedProcess

(async, inner) getProcessInfo(bpmn)

Parses all necessary information from a process description

Parameters:
Name Type Description
bpmn String

the xml process description
Source:

Type Definitions

ProceedProcess

Type:
  • Object
Properties:
Name Type Attributes Description
id String

// the id as it is in the definitions element of the process
type String

// the type of the process (process or project etc.)
originalId String

// the id the process had previously (most likely an imported process)
name String

// the name as it is in the definitions element of the process
description String

// the description (the content of documentation element of the first process element in the process model)
processIds Array.<String>

// the ids of all process elements inside the process modell
subprocesses Array.<Object>

// the processes that are referenced by callActivity elements inside the process model

Properties
Name Type Description
id String

// the id of the referenced ProceedProcess
name String

// the name of the referenced ProceedProcess
isCallActivity Boolean

// if the subprocess is a callactivity
variables Array.<Object>

// [{ name: String, type: String }] the variables supposed to be used in the process

Properties
Name Type Description
name String

// the name of the variable
type String

// the type of the variable (eg. number, array, string)
departments Array.<String>

// the departments the process belongs to
inEditingBy Array.<Object>

// information about the clients that are editing the process, used in the server version for collaborative editing

Properties
Name Type Description
id String

// the id of the client editing this process
task String | null

// id of the task this client is editing
createdOn String

// the date and time the process was added in the management-system
lastEdited String

// the date and time the process was edited the last time
shared Boolean <optional>

// only used in the server version for processes stored in the backend
Source:

ProcessInfo

Type:
  • Object
Properties:
Name Type Description
bpmn String

the process definition
metaInfo ProceedProcess

the meta information about the process
Source: