api documentation for bpmn (v0.2.2)

BPMN 2.0 execution engine

table of contents

  1. module bpmn
    1. boolean bpmn._initialising
    2. boolean bpmn._initialized
    3. function bpmn.ProcessManager (options)
    4. function bpmn.clearCache ()
    5. function bpmn.createUnmanagedCollaboratingProcesses (bpmnFilePath, callback)
    6. function bpmn.createUnmanagedCollaboratingProcessesFromXML (bpmnXML, handler, callback)
    7. function bpmn.createUnmanagedProcess (bpmnFilePath, callback)
    8. function bpmn.createUnmanagedProcessFromXML (bpmnXML, handler, callback)
    9. function bpmn.getBPMNDefinitions (bpmnFilePath, cache)
    10. function bpmn.mapName2HandlerName (bpmnName)
    11. object bpmn.ProcessManager.prototype
    12. object bpmn._definitionsToInitialize
    13. object bpmn._initialiseCallbacks
    14. object bpmn._initializationError
    15. object bpmn._persistency
    16. object bpmn._processCache
    17. object bpmn._processDefinitions
    18. object bpmn._processHandlers
    19. object bpmn.activity
    20. object bpmn.boundaryEvents
    21. object bpmn.bunyan2winston
    22. object bpmn.callActivity
    23. object bpmn.client
    24. object bpmn.collaborationDefinition
    25. object bpmn.debugger
    26. object bpmn.definitions
    27. object bpmn.endEvents
    28. object bpmn.errors
    29. object bpmn.events
    30. object bpmn.file
    31. object bpmn.find
    32. object bpmn.flowObject
    33. object bpmn.gateways
    34. object bpmn.handler
    35. object bpmn.history
    36. object bpmn.intermediateEvents
    37. object bpmn.logLevels
    38. object bpmn.logger
    39. object bpmn.manager
    40. object bpmn.messageFlows
    41. object bpmn.mongodb
    42. object bpmn.parser
    43. object bpmn.parserUtils
    44. object bpmn.participant
    45. object bpmn.persistency
    46. object bpmn.process
    47. object bpmn.processDefinition
    48. object bpmn.rest
    49. object bpmn.sequenceFlows
    50. object bpmn.startEvents
    51. object bpmn.state
    52. object bpmn.subProcess
    53. object bpmn.tasks
    54. object bpmn.timeouts
    55. object bpmn.utils
  2. module bpmn.ProcessManager
    1. function bpmn.ProcessManager (options)
  3. module bpmn.ProcessManager.prototype
    1. function bpmn.ProcessManager.prototype._afterInitialization (callback)
    2. function bpmn.ProcessManager.prototype._createCollaboratingProcesses (processDescriptors, callback)
    3. function bpmn.ProcessManager.prototype._createSingleProcess (processId, processName, callback)
    4. function bpmn.ProcessManager.prototype._getAllProcesses (callback)
    5. function bpmn.ProcessManager.prototype._initialiseDefinition (processDefinition)
    6. function bpmn.ProcessManager.prototype.addBpmnFilePath (bpmnFilePath, processHandler)
    7. function bpmn.ProcessManager.prototype.addBpmnXML (bpmnXml, processName, processHandler)
    8. function bpmn.ProcessManager.prototype.addHandler (name, handler)
    9. function bpmn.ProcessManager.prototype.addHandlerFilePath (name, handlerFilePath)
    10. function bpmn.ProcessManager.prototype.addHandlerString (name, handlerString)
    11. function bpmn.ProcessManager.prototype.createProcess (descriptors, callback)
    12. function bpmn.ProcessManager.prototype.createServer (options, restifyOptions)
    13. function bpmn.ProcessManager.prototype.findByName (processName, caseSensitive, callback)
    14. function bpmn.ProcessManager.prototype.findByProperty (query, callback)
    15. function bpmn.ProcessManager.prototype.findByState (stateName, callback)
    16. function bpmn.ProcessManager.prototype.get (processId, callback)
    17. function bpmn.ProcessManager.prototype.getAllProcesses (callback)
    18. function bpmn.ProcessManager.prototype.getDefinitionNames (callback)
  4. module bpmn.activity
    1. function bpmn.activity.BPMNActivity (bpmnId, name, type)
    2. string bpmn.activity.activityEndHandlerPostfix
  5. module bpmn.boundaryEvents
    1. function bpmn.boundaryEvents.BPMNBoundaryEvent (bpmnId, name, type, attachedToRef)
    2. function bpmn.boundaryEvents.createBPMNBoundaryEvent (node)
    3. function bpmn.boundaryEvents.isBoundaryEventName (localName)
    4. function bpmn.boundaryEvents.isTimerEventName (localName)
  6. module bpmn.bunyan2winston
    1. function bpmn.bunyan2winston.createLogger (log)
  7. module bpmn.callActivity
    1. function bpmn.callActivity.BPMNCallActivity (bpmnId, name, type, calledElementName, calledElementNamespace, location)
    2. function bpmn.callActivity.createBPMNCallActivity (node, baseFileName, prefix2NamespaceMap, importNamespace2LocationMap)
    3. function bpmn.callActivity.isCallActivityName (localName)
  8. module bpmn.client
    1. function bpmn.client.BPMNProcessClient (bpmnProcess)
  9. module bpmn.collaborationDefinition
    1. function bpmn.collaborationDefinition.BPMNCollaborationDefinition (bpmnId)
    2. function bpmn.collaborationDefinition.createBPMNCollaborationDefinition (node)
    3. function bpmn.collaborationDefinition.isCollaborationDefinitionName (localName)
  10. module bpmn.debugger
    1. function bpmn.debugger.DebuggerInterface (url, fileName)
    2. function bpmn.debugger.createDebuggerInterface (node, fileName)
    3. function bpmn.debugger.isDebuggerElement (node)
  11. module bpmn.definitions
    1. function bpmn.definitions.clearCache ()
    2. function bpmn.definitions.getBPMNCollaborationDefinitions (bpmnFilePath)
    3. function bpmn.definitions.getBPMNDefinitions (bpmnFilePath)
    4. function bpmn.definitions.getBPMNDefinitionsFromXML (bpmnXML, mainProcessName, bpmnFilePath)
    5. function bpmn.definitions.getBPMNProcessDefinition (bpmnFilePath)
    6. function bpmn.definitions.getBPMNProcessDefinitions (bpmnFilePath)
    7. function bpmn.definitions.getCachedBPMNDefinitions (bpmnFilePath)
  12. module bpmn.endEvents
    1. function bpmn.endEvents.BPMNEndEvent (bpmnId, name, type)
    2. function bpmn.endEvents.createBPMNEndEvent (node)
    3. function bpmn.endEvents.isEndEventName (localName)
  13. module bpmn.errors
    1. function bpmn.errors.createBPMNParseErrorQueue (fileName)
  14. module bpmn.events
    1. function bpmn.events.isMessageEventName (localName)
  15. module bpmn.file
    1. function bpmn.file.Persistency (path)
  16. module bpmn.find
    1. function bpmn.find.findByName (bpmnProcesses, processName, caseSensitive)
    2. function bpmn.find.findByProperty (bpmnProcesses, query)
    3. function bpmn.find.findByState (bpmnProcesses, stateName)
  17. module bpmn.flowObject
    1. function bpmn.flowObject.BPMNFlowObject (bpmnId, name, type)
  18. module bpmn.gateways
    1. function bpmn.gateways.BPMNExclusiveGateway (bpmnId, name, type)
    2. function bpmn.gateways.BPMNParallelGateway (bpmnId, name, type)
    3. function bpmn.gateways.createBPMNGateway (node, errorQueue)
    4. function bpmn.gateways.isGatewayName (localName)
  19. module bpmn.handler
    1. function bpmn.handler.callHandler (name, process, data, handlerDoneCallback)
    2. function bpmn.handler.getHandlerFileName (bpmnFilePath)
    3. function bpmn.handler.getHandlerFromFile (bpmnFilePath)
    4. function bpmn.handler.getHandlerFromProcess (name, process)
    5. function bpmn.handler.getHandlerFromString (moduleString)
    6. function bpmn.handler.mapName2HandlerName (name)
    7. string bpmn.handler.handlerNameSeparator
  20. module bpmn.history
    1. function bpmn.history.BPMNProcessHistory (history)
    2. function bpmn.history.HistoryEntry (name, type, begin, end)
    3. function bpmn.history.setDummyTimestampFunction ()
    4. function bpmn.history.setTimestampFunction (getTimestampFunction)
  21. module bpmn.intermediateEvents
    1. function bpmn.intermediateEvents.BPMNIntermediateCatchEvent (bpmnId, name, type)
    2. function bpmn.intermediateEvents.BPMNIntermediateThrowEvent (bpmnId, name, type)
    3. function bpmn.intermediateEvents.createBPMNIntermediateCatchEvent (node)
    4. function bpmn.intermediateEvents.createBPMNIntermediateThrowEvent (node)
    5. function bpmn.intermediateEvents.isIntermediateCatchEventName (localName)
    6. function bpmn.intermediateEvents.isIntermediateThrowEventName (localName)
  22. module bpmn.logger
    1. function bpmn.logger.Logger (process, options)
    2. object bpmn.logger.logLevels
  23. module bpmn.manager
    1. function bpmn.manager.ProcessManager (options)
  24. module bpmn.messageFlows
    1. function bpmn.messageFlows.BPMNMessageFlow (bpmnId, name, type, sourceRef, targetRef)
    2. function bpmn.messageFlows.createBPMNMessageFlow (node)
    3. function bpmn.messageFlows.isMessageFlowName (localName)
  25. module bpmn.mongodb
    1. function bpmn.mongodb.Persistency (uri, options)
  26. module bpmn.parser
    1. function bpmn.parser.parse (bpmnXML, errorQueue, mainProcessName, fileName)
  27. module bpmn.parserUtils
    1. function bpmn.parserUtils.getAttributesValue (node, attributeName)
    2. function bpmn.parserUtils.splitPrefixedName (prefixedName)
  28. module bpmn.participant
    1. function bpmn.participant.BPMNParticipant (bpmnId, name, type, processRef)
    2. function bpmn.participant.createBPMNParticipant (node)
    3. function bpmn.participant.isParticipantName (localName)
  29. module bpmn.persistency
    1. function bpmn.persistency.Persistency (options)
  30. module bpmn.process
    1. function bpmn.process.createBPMNProcess (id, processDefinition, eventHandler, persistency, parentProcess, parentToken, parentHistoryEntry, callback)
  31. module bpmn.processDefinition
    1. function bpmn.processDefinition.BPMNProcessDefinition (bpmnId, name, debuggerInterface)
    2. function bpmn.processDefinition.createBPMNProcessDefinition (node, debuggerInterface)
    3. function bpmn.processDefinition.isExecutable (node)
    4. function bpmn.processDefinition.isProcessName (localName)
  32. module bpmn.rest
    1. function bpmn.rest.clearReceivedMessageIds ()
    2. function bpmn.rest.createServer (manager, options, restifyOptions)
  33. module bpmn.sequenceFlows
    1. function bpmn.sequenceFlows.BPMNSequenceFlow (bpmnId, name, type, sourceRef, targetRef)
    2. function bpmn.sequenceFlows.createBPMNSequenceFlow (node)
    3. function bpmn.sequenceFlows.isSequenceFlowName (localName)
  34. module bpmn.startEvents
    1. function bpmn.startEvents.BPMNStartEvent (bpmnId, name, type)
    2. function bpmn.startEvents.createBPMNStartEvent (node)
    3. function bpmn.startEvents.isStartEventName (localName)
  35. module bpmn.state
    1. function bpmn.state.BPMNProcessState (state)
    2. function bpmn.state.CallActivityToken (flowObjectName, owningProcessId, calledProcessId)
    3. function bpmn.state.Token (flowObjectName, owningProcessId)
  36. module bpmn.subProcess
    1. function bpmn.subProcess.BPMNSubProcess (bpmnId, name, type, subProcessDefinition)
    2. function bpmn.subProcess.createBPMNSubProcess (node, subProcessDefinition)
    3. function bpmn.subProcess.isSubProcessName (localName)
  37. module bpmn.tasks
    1. function bpmn.tasks.BPMNTask (bpmnId, name, type)
    2. function bpmn.tasks.createBPMNTask (node)
    3. function bpmn.tasks.isTaskName (localName)
  38. module bpmn.timeouts
    1. function bpmn.timeouts.BPMNPendingTimerEvents (bpmnProcess)
  39. module bpmn.utils
    1. function bpmn.utils.HashMap (caseSensitive)
    2. function bpmn.utils.firstToUpper (name)
    3. function bpmn.utils.toUpperCamelCase (name)

module bpmn

function bpmn.ProcessManager (options)

function bpmn.clearCache ()

function bpmn.createUnmanagedCollaboratingProcesses (bpmnFilePath, callback)

function bpmn.createUnmanagedCollaboratingProcessesFromXML (bpmnXML, handler, callback)

function bpmn.createUnmanagedProcess (bpmnFilePath, callback)

function bpmn.createUnmanagedProcessFromXML (bpmnXML, handler, callback)

function bpmn.getBPMNDefinitions (bpmnFilePath, cache)

function bpmn.mapName2HandlerName (bpmnName)

module bpmn.ProcessManager

function bpmn.ProcessManager (options)

module bpmn.ProcessManager.prototype

function bpmn.ProcessManager.prototype._afterInitialization (callback)

function bpmn.ProcessManager.prototype._createCollaboratingProcesses (processDescriptors, callback)

function bpmn.ProcessManager.prototype._createSingleProcess (processId, processName, callback)

function bpmn.ProcessManager.prototype._getAllProcesses (callback)

function bpmn.ProcessManager.prototype._initialiseDefinition (processDefinition)

function bpmn.ProcessManager.prototype.addBpmnFilePath (bpmnFilePath, processHandler)

function bpmn.ProcessManager.prototype.addBpmnXML (bpmnXml, processName, processHandler)

function bpmn.ProcessManager.prototype.addHandler (name, handler)

function bpmn.ProcessManager.prototype.addHandlerFilePath (name, handlerFilePath)

function bpmn.ProcessManager.prototype.addHandlerString (name, handlerString)

function bpmn.ProcessManager.prototype.createProcess (descriptors, callback)

function bpmn.ProcessManager.prototype.createServer (options, restifyOptions)

function bpmn.ProcessManager.prototype.findByName (processName, caseSensitive, callback)

function bpmn.ProcessManager.prototype.findByProperty (query, callback)

function bpmn.ProcessManager.prototype.findByState (stateName, callback)

function bpmn.ProcessManager.prototype.get (processId, callback)

function bpmn.ProcessManager.prototype.getAllProcesses (callback)

function bpmn.ProcessManager.prototype.getDefinitionNames (callback)

module bpmn.activity

function bpmn.activity.BPMNActivity (bpmnId, name, type)

module bpmn.boundaryEvents

function bpmn.boundaryEvents.BPMNBoundaryEvent (bpmnId, name, type, attachedToRef)

function bpmn.boundaryEvents.createBPMNBoundaryEvent (node)

function bpmn.boundaryEvents.isBoundaryEventName (localName)

function bpmn.boundaryEvents.isTimerEventName (localName)

module bpmn.bunyan2winston

function bpmn.bunyan2winston.createLogger (log)

module bpmn.callActivity

function bpmn.callActivity.BPMNCallActivity (bpmnId, name, type, calledElementName, calledElementNamespace, location)

function bpmn.callActivity.createBPMNCallActivity (node, baseFileName, prefix2NamespaceMap, importNamespace2LocationMap)

function bpmn.callActivity.isCallActivityName (localName)

module bpmn.client

function bpmn.client.BPMNProcessClient (bpmnProcess)

module bpmn.collaborationDefinition

function bpmn.collaborationDefinition.BPMNCollaborationDefinition (bpmnId)

function bpmn.collaborationDefinition.createBPMNCollaborationDefinition (node)

function bpmn.collaborationDefinition.isCollaborationDefinitionName (localName)

module bpmn.debugger

function bpmn.debugger.DebuggerInterface (url, fileName)

function bpmn.debugger.createDebuggerInterface (node, fileName)

function bpmn.debugger.isDebuggerElement (node)

module bpmn.definitions

function bpmn.definitions.clearCache ()

function bpmn.definitions.getBPMNCollaborationDefinitions (bpmnFilePath)

function bpmn.definitions.getBPMNDefinitions (bpmnFilePath)

function bpmn.definitions.getBPMNDefinitionsFromXML (bpmnXML, mainProcessName, bpmnFilePath)

function bpmn.definitions.getBPMNProcessDefinition (bpmnFilePath)

function bpmn.definitions.getBPMNProcessDefinitions (bpmnFilePath)

function bpmn.definitions.getCachedBPMNDefinitions (bpmnFilePath)

module bpmn.endEvents

function bpmn.endEvents.BPMNEndEvent (bpmnId, name, type)

function bpmn.endEvents.createBPMNEndEvent (node)

function bpmn.endEvents.isEndEventName (localName)

module bpmn.errors

function bpmn.errors.createBPMNParseErrorQueue (fileName)

module bpmn.events

function bpmn.events.isMessageEventName (localName)

module bpmn.file

function bpmn.file.Persistency (path)

module bpmn.find

function bpmn.find.findByName (bpmnProcesses, processName, caseSensitive)

function bpmn.find.findByProperty (bpmnProcesses, query)

function bpmn.find.findByState (bpmnProcesses, stateName)

module bpmn.flowObject

function bpmn.flowObject.BPMNFlowObject (bpmnId, name, type)

module bpmn.gateways

function bpmn.gateways.BPMNExclusiveGateway (bpmnId, name, type)

function bpmn.gateways.BPMNParallelGateway (bpmnId, name, type)

function bpmn.gateways.createBPMNGateway (node, errorQueue)

function bpmn.gateways.isGatewayName (localName)

module bpmn.handler

function bpmn.handler.callHandler (name, process, data, handlerDoneCallback)

function bpmn.handler.getHandlerFileName (bpmnFilePath)

function bpmn.handler.getHandlerFromFile (bpmnFilePath)

function bpmn.handler.getHandlerFromProcess (name, process)

function bpmn.handler.getHandlerFromString (moduleString)

function bpmn.handler.mapName2HandlerName (name)

module bpmn.history

function bpmn.history.BPMNProcessHistory (history)

function bpmn.history.HistoryEntry (name, type, begin, end)

function bpmn.history.setDummyTimestampFunction ()

function bpmn.history.setTimestampFunction (getTimestampFunction)

module bpmn.intermediateEvents

function bpmn.intermediateEvents.BPMNIntermediateCatchEvent (bpmnId, name, type)

function bpmn.intermediateEvents.BPMNIntermediateThrowEvent (bpmnId, name, type)

function bpmn.intermediateEvents.createBPMNIntermediateCatchEvent (node)

function bpmn.intermediateEvents.createBPMNIntermediateThrowEvent (node)

function bpmn.intermediateEvents.isIntermediateCatchEventName (localName)

function bpmn.intermediateEvents.isIntermediateThrowEventName (localName)

module bpmn.logger

function bpmn.logger.Logger (process, options)

module bpmn.manager

function bpmn.manager.ProcessManager (options)

module bpmn.messageFlows

function bpmn.messageFlows.BPMNMessageFlow (bpmnId, name, type, sourceRef, targetRef)

function bpmn.messageFlows.createBPMNMessageFlow (node)

function bpmn.messageFlows.isMessageFlowName (localName)

module bpmn.mongodb

function bpmn.mongodb.Persistency (uri, options)

module bpmn.parser

function bpmn.parser.parse (bpmnXML, errorQueue, mainProcessName, fileName)

module bpmn.parserUtils

function bpmn.parserUtils.getAttributesValue (node, attributeName)

function bpmn.parserUtils.splitPrefixedName (prefixedName)

module bpmn.participant

function bpmn.participant.BPMNParticipant (bpmnId, name, type, processRef)

function bpmn.participant.createBPMNParticipant (node)

function bpmn.participant.isParticipantName (localName)

module bpmn.persistency

function bpmn.persistency.Persistency (options)

module bpmn.process

function bpmn.process.createBPMNProcess (id, processDefinition, eventHandler, persistency, parentProcess, parentToken, parentHistoryEntry, callback)

module bpmn.processDefinition

function bpmn.processDefinition.BPMNProcessDefinition (bpmnId, name, debuggerInterface)

function bpmn.processDefinition.createBPMNProcessDefinition (node, debuggerInterface)

function bpmn.processDefinition.isExecutable (node)

function bpmn.processDefinition.isProcessName (localName)

module bpmn.rest

function bpmn.rest.clearReceivedMessageIds ()

function bpmn.rest.createServer (manager, options, restifyOptions)

module bpmn.sequenceFlows

function bpmn.sequenceFlows.BPMNSequenceFlow (bpmnId, name, type, sourceRef, targetRef)

function bpmn.sequenceFlows.createBPMNSequenceFlow (node)

function bpmn.sequenceFlows.isSequenceFlowName (localName)

module bpmn.startEvents

function bpmn.startEvents.BPMNStartEvent (bpmnId, name, type)

function bpmn.startEvents.createBPMNStartEvent (node)

function bpmn.startEvents.isStartEventName (localName)

module bpmn.state

function bpmn.state.BPMNProcessState (state)

function bpmn.state.CallActivityToken (flowObjectName, owningProcessId, calledProcessId)

function bpmn.state.Token (flowObjectName, owningProcessId)

module bpmn.subProcess

function bpmn.subProcess.BPMNSubProcess (bpmnId, name, type, subProcessDefinition)

function bpmn.subProcess.createBPMNSubProcess (node, subProcessDefinition)

function bpmn.subProcess.isSubProcessName (localName)

module bpmn.tasks

function bpmn.tasks.BPMNTask (bpmnId, name, type)

function bpmn.tasks.createBPMNTask (node)

function bpmn.tasks.isTaskName (localName)

module bpmn.timeouts

function bpmn.timeouts.BPMNPendingTimerEvents (bpmnProcess)

module bpmn.utils

function bpmn.utils.HashMap (caseSensitive)

function bpmn.utils.firstToUpper (name)

function bpmn.utils.toUpperCamelCase (name)

[ this document was created with utility2 ]