@5minds/node-red-contrib-processcube 1.1.4-develop-e4b670-m0m25yen → 1.1.4-develop-9a2b44-m0m8kbzf

package/externaltask-event-listener.html

@@ -45,6 +45,11 @@ A node which listens for events triggered by externaltasks
 
 ## Outputs
 
+: flowNodeInstanceId (string): The unique identifier for the flow node instance.
+: externalTaskEvent (Object): An Object containing the event data returned by the engine.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
 ### References
 
 -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform

package/externaltask-input.html

@@ -37,9 +37,9 @@ the connected ProcessCube Engine for processing.
 
 ## Outputs
 
-: payload (string) : Defines the input of the external task token
+: payload (string) : The payload the external task was started with.
 : task (object) : The external task object
-: flowNodeInstanceId : The Id of the external task, which is needed to complete the task
+: flowNodeInstanceId : The unique identifier of the external task, which is needed to complete the task
 
 ### Details
 

package/message-event-trigger.html

@@ -6,7 +6,6 @@
             name: { value: '' },
             engine: { value: '', type: 'processcube-engine-config' },
             messagename: { value: '', required: true },
-            processInstanceId: { value: '' },
         },
         inputs: 1,
         outputs: 1,
@@ -30,24 +29,21 @@
         <label for="node-input-messagename"><i class="fa fa-tag"></i> Message Name</label>
         <input type="text" id="node-input-messagename" placeholder="Name of the Message-Event" />
     </div>
-    <div class="form-row">
-        <label for="node-input-processinstanceid"><i class="fa fa-tag"></i> Process Instance Id</label>
-        <input type="text" id="node-input-processinstanceid" placeholder="Id of the recipient process instance" />
-    </div>
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-input">
-A Message event to an intermediate message event can be triggert.
+A node to trigger an event that will be send to the corresponding intermediate message event in the connected ProcessCube Engine.
 
 From the config the `messagename` and the `processInstanceId` must be set.
 
 ## Inputs
 
-: payload (Object) : Will sent to the event and used an new token payload.
+: payload (Object) : The payload will be sent to the message event and be used as a new token payload.
+: processInstanceId (string) : The process instance where the message event should be triggered.
 
 ### References
 
 -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
 -   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
-    
+
 </script>

package/message-event-trigger.js

@@ -15,7 +15,7 @@ module.exports = function (RED) {
 
             engine.engineClient.events
                 .triggerMessageEvent(config.messagename, {
-                    processInstanceId: config.processinstanceid,
+                    processInstanceId: msg.processinstanceid,
                     payload: msg.payload,
                     identity: engine.identity,
                 })

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "1.1.4-develop-e4b670-m0m25yen",
+    "version": "1.1.4-develop-9a2b44-m0m8kbzf",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "scripts": {

package/process-event-listener.html

@@ -75,6 +75,95 @@ A node which listens for events triggered by processes
 
 ## Outputs
 
+### starting
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### started
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: flowNodeId (string): The id of the flowNode the process was started with.
+: token (Object): The start token of the process instance.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### resumed
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: token (Object): The current token of the process instance.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### finished
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: flowNodeId (string): The id of the flowNode the process was finished with.
+: token (Object): The end token of the process instance.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### terminated
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: token (Object): The current token of the process instance.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### error
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: token (Object): The current token of the process instance.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### owner-changed
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### instances-deleted
+
+: processInstanceId (string): The unique identifier for the process instance.
+: processModelId (string): The id of the process model.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### is-executable-changed
+
+: processModelId (string): The id of the process model.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### deployed
+
+: processModelId (string): The id of the process model.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
+### undeployed
+
+: processModelId (string): The id of the process model.
+: action (string): The event that occured. 
+: type (string): The target of the event.
+
 ### References
 
 -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform

package/process-start.html

@@ -43,10 +43,15 @@ The `processModelId` and `startEventId` can be set in the message object to over
 
 ## Inputs
 
-: payload (Object) : Will be used as the input for the process.
+: payload (Object) : Will be used as the start token for the process.
 : processModelId (String) : Will be used as the process model and override the configured `Processmodel`.
 : startEventId (String) : Will be used as the start event and override the configured `Startevent`.
 
+## Outputs
+
+: processInstanceId (string) : The unique identifier of the started process instance.
+: correlationId (string) : The unique correlation identifier of the started process instance.
+
 ### References
 
 -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform

package/process-terminate.html

@@ -29,6 +29,14 @@
 <script type="text/markdown" data-help-name="process-terminate">
 Terminate an instance of a process model in the ProcessCube.
 
+## Inputs
+
+: payload (string): The id of the processinstance that is going to be terminated.
+
+## Outputs
+
+: payload (string): The id of the processinstance that was terminated.
+
 ### References
 
 -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform

package/processdefinition-query.html

@@ -61,7 +61,7 @@
 </script>
 
 <script type="text/markdown" data-help-name="processdefinition-query">
-Query process definitions or process models from the ProcessCube engine.
+A node to query process definition on the ProcessCube Engine.
 
 The `query` can be given a direkt query field from the configutation or a message property.
 
@@ -71,6 +71,11 @@ Only models can be queried by setting the `models_only` flag.
 
 : payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
 
+## Outputs
+
+: processDefinitions / models (Array) : The processDefinitions / models that matched the query.
+: totalCount (number) : The number of matches.
+
 ### References
 
 - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform

package/processinstance-query.html

@@ -46,12 +46,17 @@
 </script>
 
 <script type="text/markdown" data-help-name="processinstance-query">
-Query a process instance in the ProcessCube.
+A node to query process instances on the ProcessCube Engine.
 
 ## Inputs
 
 : payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
 
+## Outputs
+
+: processInstances (Array) : The process instances that matched the query.
+: totalCount (number) : The number of matches.
+
 ### References
 
 -  [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform

package/signal-event-trigger.html

@@ -6,7 +6,6 @@
             name: { value: '' },
             engine: { value: '', type: 'processcube-engine-config' },
             signalname: { value: '', required: true },
-            processInstanceId: { value: '' },
         },
         inputs: 1,
         outputs: 1,
@@ -30,10 +29,7 @@
         <label for="node-input-signalname"><i class="fa fa-tag"></i> Signal Name</label>
         <input type="text" id="node-input-signalname" placeholder="Name of the Signal" />
     </div>
-    <div class="form-row">
-        <label for="node-input-processinstanceid"><i class="fa fa-tag"></i> Process Instance Id</label>
-        <input type="text" id="node-input-processinstanceid" placeholder="Id of the recipient process instance" />
-    </div>
+    
 </script>
 
 <script type="text/markdown" data-help-name="signal-event-trigger">
@@ -44,6 +40,7 @@ From the config the `signalname` and the `processInstanceId` must be set.
 ## Inputs
 
 : payload (Object) : Will sent to the event and used an new token payload.
+: processInstanceId (string) : The process instance where the signal event should be triggered.
 
 ### References
 

package/signal-event-trigger.js

@@ -15,7 +15,7 @@ module.exports = function (RED) {
     
             client.events
                 .triggerSignalEvent(config.signalname, {
-                    processInstanceId: config.processinstanceid,
+                    processInstanceId: msg.processinstanceid,
                     payload: msg.payload,
                     identity: engine.identity,
                 })

package/usertask-event-listener.html

@@ -68,6 +68,12 @@ A node which listens for events triggered by usertasks
 
 ## Outputs
 
+: flowNodeInstanceId (string): The unique identifier for the usertask instance.
+: userTaskEvent (Object): An Object representing the event returned by the engine.
+: processInstance (Object): An Object representing the process instance data.
+: action (string): The event that occured.
+: type (string): The target of the event.
+
 ### References
 
 -   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform