@5minds/node-red-contrib-processcube 1.4.0-develop-d2cbe1-m2d1k6k4 → 2.0.0-feature-629c78-m2dq1ygt

package/externaltask-input.html

@@ -58,11 +58,26 @@
 Waiting for external tasks that correspond to the `Topic` configured in
 the connected ProcessCube Engine for processing.
 
+## Configs
+
+: name (string) : The name of the node
+: engine (string) : The ProcessCube Engine to connect to
+: topic (string) : The topic of the external task
+: workerConfig (object) : The configuration for the worker
+
+### workerConfig
+
+- workerId (string): The id of the worker
+- lockDuration (number): The duration in milliseconds the external task is locked for execution
+- maxTasks (number): The maximum number of tasks that can be fetched at once
+- longpollingTimeout (number): The duration in milliseconds the external task is locked for execution
+- payloadFilter (Req-Expression): The filter for the payload of the external task
+
 ## Outputs
 
 : payload (string) : The payload the external task was started with.
 : task (object) : The external task object
-: flowNodeInstanceId : The unique identifier of the external task, which is needed to complete the task
+: flowNodeInstanceId (string) : The unique identifier of the external task, which is needed to complete the task
 
 ### Details
 

package/externaltask-input.js

@@ -109,8 +109,14 @@ module.exports = function (RED) {
             });
         };
 
+        let options = {};
+
+        if (!!config.workerConfig) {
+            options = RED.util.evaluateNodeProperty(config.workerConfig, 'json', node);
+        }
+
         client.externalTasks
-            .subscribeToExternalTaskTopic(config.topic, etwCallback, RED.util.evaluateNodeProperty(config.workerConfig, 'json', node))
+            .subscribeToExternalTaskTopic(config.topic, etwCallback, options)
             .then(async (externalTaskWorker) => {
                 node.status({ fill: 'blue', shape: 'ring', text: 'subcribed' });
 
@@ -136,7 +142,8 @@ module.exports = function (RED) {
                             showStatus(node, Object.keys(started_external_tasks).length);
                             break;
                         default:
-                            node.error(`Worker error ${errorType}: ${error.message}`);
+                            // reduce noise error logs
+                            // node.error(`Worker error ${errorType}: ${error.message}`);
                             break;
                     }
                 });

package/nodered/flows.json

@@ -71,6 +71,22 @@
         "info": "",
         "env": []
     },
+    {
+        "id": "76c047e0d8770a20",
+        "type": "tab",
+        "label": "Other Events",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "2766c40d84283368",
+        "type": "tab",
+        "label": "Placeholder",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
     {
         "id": "4c59118134081e05",
         "type": "group",
@@ -467,6 +483,52 @@
         "w": 572,
         "h": 142
     },
+    {
+        "id": "865723b71ced9418",
+        "type": "group",
+        "z": "76c047e0d8770a20",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "930624edc6169c55",
+            "2f2ec1cc0213eab5",
+            "bde205e77cd20558"
+        ],
+        "x": 34,
+        "y": 39,
+        "w": 502,
+        "h": 142
+    },
+    {
+        "id": "9081b057a931f0cf",
+        "type": "group",
+        "z": "2766c40d84283368",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "03ac7bc273197c45",
+            "bb734a85d4b37728",
+            "3d03550f7d93bfd3"
+        ],
+        "x": 54,
+        "y": 39,
+        "w": 422,
+        "h": 142
+    },
     {
         "id": "42e6796dddd9d4db",
         "type": "processcube-engine-config",
@@ -798,6 +860,8 @@
         "name": "Test_Auth",
         "engine": "b78932d162d8d468",
         "topic": "Test_Auth",
+        "workerConfig": "{}",
+        "workerConfigType": "json",
         "x": 120,
         "y": 180,
         "wires": [
@@ -861,6 +925,8 @@
         "name": "SampleError_Auth",
         "engine": "b78932d162d8d468",
         "topic": "SampleError_Auth",
+        "workerConfig": "{}",
+        "workerConfigType": "json",
         "x": 150,
         "y": 360,
         "wires": [
@@ -1387,7 +1453,7 @@
         "g": "a71a168415778e2c",
         "name": "",
         "engine": "42e6796dddd9d4db",
-        "query": "{\"includeXml\":false}",
+        "query": "{\"includeXml\":false,\"processDefinitionId\":\"External-Task-Sample_Definition\"}",
         "query_type": "json",
         "x": 320,
         "y": 140,
@@ -1996,5 +2062,95 @@
         "x": 760,
         "y": 60,
         "wires": []
+    },
+    {
+        "id": "930624edc6169c55",
+        "type": "process-event-listener",
+        "z": "76c047e0d8770a20",
+        "g": "865723b71ced9418",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "processmodel": "External-Task-Sample_Process",
+        "eventtype": "starting",
+        "query": "{}",
+        "query_type": "json",
+        "x": 160,
+        "y": 140,
+        "wires": [
+            [
+                "2f2ec1cc0213eab5"
+            ]
+        ]
+    },
+    {
+        "id": "2f2ec1cc0213eab5",
+        "type": "debug",
+        "z": "76c047e0d8770a20",
+        "g": "865723b71ced9418",
+        "name": "debug 34",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 430,
+        "y": 140,
+        "wires": []
+    },
+    {
+        "id": "bde205e77cd20558",
+        "type": "comment",
+        "z": "76c047e0d8770a20",
+        "g": "865723b71ced9418",
+        "name": "Hört auf die Events der Processe",
+        "info": "",
+        "x": 190,
+        "y": 80,
+        "wires": []
+    },
+    {
+        "id": "03ac7bc273197c45",
+        "type": "process-terminate",
+        "z": "2766c40d84283368",
+        "g": "9081b057a931f0cf",
+        "name": "",
+        "engine": "42e6796dddd9d4db",
+        "x": 170,
+        "y": 140,
+        "wires": [
+            [
+                "bb734a85d4b37728"
+            ]
+        ]
+    },
+    {
+        "id": "bb734a85d4b37728",
+        "type": "debug",
+        "z": "2766c40d84283368",
+        "g": "9081b057a931f0cf",
+        "name": "debug 35",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "false",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 370,
+        "y": 140,
+        "wires": []
+    },
+    {
+        "id": "3d03550f7d93bfd3",
+        "type": "comment",
+        "z": "2766c40d84283368",
+        "g": "9081b057a931f0cf",
+        "name": "Event for Terminating a Process",
+        "info": "",
+        "x": 210,
+        "y": 80,
+        "wires": []
     }
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "1.4.0-develop-d2cbe1-m2d1k6k4",
+    "version": "2.0.0-feature-629c78-m2dq1ygt",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "scripts": {

package/process-terminate.html

@@ -29,9 +29,10 @@
 <script type="text/markdown" data-help-name="process-terminate">
 Terminate an instance of a process model in the ProcessCube.
 
-## Inputs
+## Configs
 
-: payload (string): The id of the processinstance that is going to be terminated.
+: name (string): name of the node
+: engine (string): the engine to connect to
 
 ## Outputs
 

package/processinstance-query.html

@@ -50,13 +50,127 @@ 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.
+: msg (Object | JSON) : The selected field of the *msg*, eg *payload*, will be used as the input for the query or can be directly set as JSON.
+: query (Object) : The query that was used.
 
 ## Outputs
 
 : processInstances (Array) : The process instances that matched the query.
 : totalCount (number) : The number of matches.
 
+### Query fields
+
+**Summary**: 
+
+**Description**: Gets all ProcessInstances that match the given query.
+
+#### Parameters:
+- Name: `offset` Required: `false`
+  - Type: number
+  - Description: The index of the first ProcessInstance to include in the result set.
+- Name: `limit` Required: `false`
+  - Type: number
+  - Description: The maximum number of ProcessInstances to return.
+- Name: `correlationId` Required: `false`
+  - Type: Array<string> | string | SearchQuery
+    - string: myCorrelationId
+    - Array<string>: myCorrelationId1,myCorrelationId2
+    - object: 
+  - Description: Filter by the CorrelationId of the ProcessInstances.
+- Name: `processInstanceId` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: myProcessInstance_12345678
+    - Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
+    - object: 
+  - Description: Filter by the ID of the ProcessInstances.
+- Name: `processDefinitionId` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: myProcess_12345678
+    - Array<string>: myProcess_12345678,myProcess_87654321
+    - object: 
+  - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
+- Name: `processModelId` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: myProcessModel_12345678
+    - Array<string>: myProcessModel_12345678,myProcessModel_87654321
+    - object: 
+  - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
+- Name: `processModelName` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: My Process Model
+    - Array<string>: My Process Model,My Other Process Model
+    - object: 
+  - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
+- Name: `processModelHash` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: 12345678
+    - Array<string>: 12345678,87654321
+    - object: 
+  - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
+- Name: `ownerId` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: 12345678
+    - Array<string>: 12345678,87654321
+    - object: 
+  - Description: Filter by the ID of the User that owns the ProcessInstances.
+- Name: `state` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: running
+    - Array<string>: running,finished
+    - object: 
+  - Description: Filter by the state of the ProcessInstances.
+- Name: `parentProcessInstanceId` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: myParentProcessInstance_12345678
+    - Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
+    - object: 
+  - Description: Filter by the ID of the parent ProcessInstance.
+- Name: `terminatedByUserId` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: 12345678
+    - Array<string>: 12345678,87654321
+    - object: 
+  - Description: Filter by the ID of the User that terminated the ProcessInstances.
+- Name: `createdBefore` Required: ``
+  - Type: string
+  - Description: The maximum created date of the ProcessInstances to include in the results.
+- Name: `createdAt` Required: ``
+  - Type: Array<string> | string
+    - string: 2021-01-01T00:00:00.000Z
+    - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
+  - Description: The minimum created date of the ProcessInstances to include in the results.
+- Name: `createdAfter` Required: ``
+  - Type: string
+  - Description: The minimum created date of the ProcessInstances to include in the results.
+- Name: `updatedBefore` Required: ``
+  - Type: string
+  - Description: The maximum updated date of the ProcessInstances to include in the results.
+- Name: `updatedAt` Required: ``
+  - Type: Array<string> | string
+    - string: 2021-01-01T00:00:00.000Z
+    - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
+  - Description: The exact updated date of the ProcessInstances to include in the results.
+- Name: `updatedAfter` Required: ``
+  - Type: string
+  - Description: The minimum updated date of the ProcessInstances to include in the results.
+- Name: `finishedBefore` Required: ``
+  - Type: string
+  - Description: The maximum finished date of the ProcessInstances to include in the results.
+- Name: `finishedAt` Required: ``
+  - Type: Array<string> | string
+    - string: 2021-01-01T00:00:00.000Z
+    - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
+  - Description: The exact finished date of the ProcessInstances to include in the results.
+- Name: `finishedAfter` Required: ``
+  - Type: string
+  - Description: The minimum finished date of the ProcessInstances to include in the results.
+- Name: `triggeredByFlowNodeInstance` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: myFlowNodeInstance_12345678
+    - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
+    - object: 
+  - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
+
 ### References
 
 -  [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform