@5minds/node-red-contrib-processcube 1.5.6-feature-aa14a2-m3pntyi8 → 1.5.7-develop-41d845-m3q6c4hg

package/wait-for-usertask.html

@@ -70,6 +70,125 @@ Waiting for Usertasks of the connected ProcessCube Engine.
 - `msg.payload` or a constant json to filter the UserTasks for Waiting for
 - `Only for new` will trigger only for new UserTasks if checked and also for old ones if not checked.
 
+### Query fields
+
+**Summary**: 
+
+**Description**: Filter result for 'Wait for UserTask'
+
+#### 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: `embeddedProcessModelId` Required: ``
+  - Type: Array<string> | string | SearchQuery
+    - string: myModel1
+    - Array<string>: myModel1,myModel2
+    - object: 
+  - Description: Filter by the ID of the embedded process model.
+- 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

package/wait-for-usertask.js

@@ -5,12 +5,13 @@ module.exports = function (RED) {
 
         node.engine = RED.nodes.getNode(config.engine);
 
+        const client = node.engine.engineClient;
+
         let subscription = null;
         let currentIdentity = node.engine.identity;
         let subscribe = null;
 
         node.on('input', async function (msg) {
-            const client = node.engine.engineClient;
             subscribe = async () => {
                 if (!client) {
                     node.error('No engine configured.');
@@ -19,49 +20,44 @@ module.exports = function (RED) {
 
                 const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
 
-                subscription = await client.userTasks.onUserTaskWaiting(
-                    async (userTaskWaitingNotification) => {
-                        const newQuery = {
-                            flowNodeInstanceId: userTaskWaitingNotification.flowNodeInstanceId,
-                            ...query,
-                        };
-
-                        try {
-                            const matchingFlowNodes = await client.userTasks.query(newQuery, {
-                                identity: currentIdentity,
-                            });
-
-                            if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {
-                                // remove subscription
-                                client.userTasks.removeSubscription(subscription, currentIdentity);
-
-                                const userTask = matchingFlowNodes.userTasks[0];
-
-                                msg.payload = { userTask: userTask };
-                                node.send(msg);
-                            } else {
-                                // nothing todo - wait for next notification
-                            }
-                        } catch (error) {
-                            node.error(error);
+                subscription = await client.userTasks.onUserTaskWaiting(async (userTaskWaitingNotification) => {
+
+                    const newQuery = {
+                        'flowNodeInstanceId': userTaskWaitingNotification.flowNodeInstanceId,
+                        ...query
+                    };
+
+                    try {
+                        const matchingFlowNodes = await client.userTasks.query(newQuery, { identity: currentIdentity });
+
+                        if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length == 1) {
+                            // remove subscription
+                            client.userTasks.removeSubscription(subscription, currentIdentity);
+
+                            const userTask = matchingFlowNodes.userTasks[0];
+
+                            msg.payload = { userTask: userTask };
+                            node.send(msg);
+                        } else {
+                            // nothing todo - wait for next notification
                         }
-                    },
-                    { identity: currentIdentity }
-                );
+                    } catch (error) {
+                        node.error(error);
+                    }
 
-                node.log({ 'Handling old userTasks config.only_for_new': config.only_for_new });
+                }, { identity: currentIdentity });
+
+                node.log({ "Handling old userTasks config.only_for_new": config.only_for_new });
 
                 if (config.only_for_new === false) {
                     // only check suspended user tasks
                     const suspendedQuery = {
-                        state: 'suspended',
-                        ...query,
+                        'state': 'suspended',
+                        ...query
                     };
 
                     try {
-                        const matchingFlowNodes = await client.userTasks.query(suspendedQuery, {
-                            identity: currentIdentity,
-                        });
+                        const matchingFlowNodes = await client.userTasks.query(suspendedQuery, { identity: currentIdentity });
 
                         if (matchingFlowNodes.userTasks && matchingFlowNodes.userTasks.length >= 1) {
                             const userTask = matchingFlowNodes.userTasks[0];
@@ -84,6 +80,7 @@ module.exports = function (RED) {
         });
 
         node.engine.registerOnIdentityChanged(async (identity) => {
+
             if (subscription) {
                 client.userTasks.removeSubscription(subscription, currentIdentity);
                 currentIdentity = identity;
@@ -93,11 +90,11 @@ module.exports = function (RED) {
             }
         });
 
-        node.on('close', async () => {
+        node.on("close", async () => {
             if (client != null && subscription != null) {
                 client.userTasks.removeSubscription(subscription, currentIdentity);
             }
         });
     }
-    RED.nodes.registerType('wait-for-usertask', WaitForUsertask);
-};
+    RED.nodes.registerType("wait-for-usertask", WaitForUsertask);
+}