Class: ProcessInterface

ProcessInterface

Exposes an interface for interaction with the processes in the backend

Which implementation (server/electron) is selected is based on the webpack config

Source:

Methods

(async) addProcess(bpmn)

Permanently stores the given process in the backend if possible

Parameters:
Name Type Description
bpmn Object

object containing the initial process information including the bpmn
Source:

(async) blockProcess(processDefinitionsId)

Server Version: Sets the process into a state where it cant be deleted by another client Electron Version: does nothing

Parameters:
Name Type Description
processDefinitionsId String
Source:

(async) blockTask(processDefinitionsId, taskId)

Server Version: Sets task inside a process into a state where it can't be deleted Electron Version: does nothing

Parameters:
Name Type Description
processDefinitionsId String
taskId String
Source:

(async) broadcastBPMNEvents(processDefinitionsId, type, context)

Server version: sends an event that occured in the process modeler to the backend to be distributed to other clients Electron version: does nothing

Parameters:
Name Type Description
processDefinitionsId String
type String
context Object
Source:

(async) broadcastScriptChangeEvent(processDefinitionsId, elId, elType, script, change)

Server version: sends an event to allow collaborative script editing to the server Electron version: does nothing

Parameters:
Name Type Description
processDefinitionsId String
elId String
elType String
script String
change Object
Source:

(async) deleteUserTaskHTML(processDefinitionsId, taskId)

Removes the stored html for a user task in the backend

Parameters:
Name Type Description
processDefinitionsId String

the id of the process
taskId String

the id of the user task
Source:

(async) getProcess(id) → {Object}

Gets object containing process information including its bpmn

Parameters:
Name Type Description
id String
Source:
Returns:

process information

Type
Object

(async) getProcesses() → {Array}

Function that gets all available processes

Source:
Returns:
  • contains all available processes
Type
Array

(async) getUserTasksHTML(processDefinitionsId) → {Object}

Returns the html for all user tasks in a process

Parameters:
Name Type Description
processDefinitionsId String

the id of the process
Source:
Returns:
  • an object with the user task ids as the keys and the related html as values
Type
Object

(async) observeProcessEditing(processDefinitionsId)

Server version: Registers client for modeling updates for the process with the given id Electron version: does nothing

Parameters:
Name Type Description
processDefinitionsId String
Source:

(async) pullProcess(id)

Server: Returns a process from the backend writing it to the browser storage in the process Electron: Same a getProcess

Parameters:
Name Type Description
id String

the definitions id of the process
Source:

(async) pushToBackend(processDefinitionsId)

Takes a process from the local storage and pushes its data to the backend to allow sharing with other users

Parameters:
Name Type Description
processDefinitionsId String
Source:

(async) removeProcess(processDefinitionsId, isAuthenticated)

Removes the process from the permanent storage in the backend if it exists

Parameters:
Name Type Description
processDefinitionsId String
isAuthenticated String

if the current user is logged in
Source:

(async) saveScriptTaskJS(processDefinitionsId, taskId, js)

Stores the script used in a script task in the backend

Parameters:
Name Type Description
processDefinitionsId String

the id of the process that contains the script task
taskId String

the id of the script task
js String

the script that is supposed to be stored
Source:

(async) saveUserTaskHTML(processDefinitionsId, taskId, html)

Saves the Html used in a user task in a process in the backend

Parameters:
Name Type Description
processDefinitionsId String

the id of the process
taskId String

the id of the user task
html String

the html used in the user task
Source:

(async) stopObservingProcessEditing(processDefinitionsId)

Server version: Unregisters client from modeling updates for process with given id Electron version: does nothing

Parameters:
Name Type Description
processDefinitionsId string
Source:

(async) unblockProcess(processDefinitionsId)

Server Version: Sets the process into a state where its deletion isn't blocked by this client anymore Electron Version: does nothing

Parameters:
Name Type Description
processDefinitionsId String
Source:

(async) unblockTask(processDefinitionsId, taskId)

Sets task in process back into state where it can be deleted again

Parameters:
Name Type Description
processDefinitionsId String
taskId String
Source:

(async) updateConstraints(processDefinitionsId, elementId, constraints)

Makes other editing clients update the constraints of an element

Parameters:
Name Type Description
processDefinitionsId String
elementId String
constraints Object
Source:

(async) updateLocations(processDefinitionsId, elementId, locations)

Makes other editing clients update the locations of an element

Parameters:
Name Type Description
processDefinitionsId String
elementId String
locations Object
Source:

(async) updateMilestones(processDefinitionsId, elementId, milestones)

Makes other editing clients update the milestones of an element

Parameters:
Name Type Description
processDefinitionsId String
elementId String
milestones Object
Source:

(async) updateProcess(id, bpmn)

Replaces the old bpmn of a process with a new one

Parameters:
Name Type Description
id String

the id of the process
bpmn String

the process definition
Source:

(async) updateProcessDescription(processDefinitionsId, processId, description)

Updates the description of the process contained in the process definition

Parameters:
Name Type Description
processDefinitionsId String
processId String

the id of the specific process we want to update the description of
description String
Source:

(async) updateProcessMetaData(processDefinitionsId, metaDataChanges)

Updates meta data of a process (should be used for data not in bpmn like departments of variables)

Parameters:
Name Type Description
processDefinitionsId String
metaDataChanges Object
Source:

(async) updateProcessName(processDefinitionsId, newName)

Updates the name associated with a process in the backend

Parameters:
Name Type Description
processDefinitionsId String
newName String
Source:

(async) updateResources(processDefinitionsId, elementId, resources)

Makes other editing clients update the resources of an element

Parameters:
Name Type Description
processDefinitionsId String
elementId String
resources Object
Source:

(async) updateWholeXml(processDefinitionsId, bpmn)

Forces xml overwrite in other clients in server version and just updates the stored process definition in electron version

Parameters:
Name Type Description
processDefinitionsId String
bpmn String
Source: