@5minds/node-red-contrib-processcube 1.7.4-feature-6f3f78-m6l0ykww → 1.7.4

package/processdefinition-query.html

@@ -61,143 +61,144 @@
 </script>
 
 <script type="text/markdown" data-help-name="processdefinition-query">
-    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.
-
-    Only models can be queried by setting the `models_only` flag.
-
-    ## Inputs
-
-    : 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.
-
-    ### Query fields
-
-    **Summary**:
-
-    **Description**: Filter result for &#39;ProcessInstance Query&#39;
-
-    #### 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&lt;string&gt; | string | SearchQuery
-            - string: myCorrelationId
-            - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
-            - object:
-        - Description: Filter by the CorrelationId of the ProcessInstances.
-    - Name: `processInstanceId` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: myProcessInstance_12345678
-            - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
-            - object:
-        - Description: Filter by the ID of the ProcessInstances.
-    - Name: `processDefinitionId` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: myProcess_12345678
-            - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
-            - object:
-        - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
-    - Name: `processModelId` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: myProcessModel_12345678
-            - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
-            - object:
-        - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
-    - Name: `processModelName` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: My Process Model
-            - Array&lt;string&gt;: 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&lt;string&gt; | string | SearchQuery
-            - string: 12345678
-            - Array&lt;string&gt;: 12345678,87654321
-            - object:
-        - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
-    - Name: `ownerId` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: 12345678
-            - Array&lt;string&gt;: 12345678,87654321
-            - object:
-        - Description: Filter by the ID of the User that owns the ProcessInstances.
-    - Name: `state` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: running
-            - Array&lt;string&gt;: running,finished
-            - object:
-        - Description: Filter by the state of the ProcessInstances.
-    - Name: `parentProcessInstanceId` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: myParentProcessInstance_12345678
-            - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
-            - object:
-        - Description: Filter by the ID of the parent ProcessInstance.
-    - Name: `embeddedProcessModelId` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: myModel1
-            - Array&lt;string&gt;: myModel1,myModel2
-            - object:
-        - Description: Filter by the ID of the embedded process model.
-    - Name: `terminatedByUserId` Required: ``
-        - Type: Array&lt;string&gt; | string | SearchQuery
-            - string: 12345678
-            - Array&lt;string&gt;: 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&lt;string&gt; | 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&lt;string&gt; | 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&lt;string&gt; | 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&lt;string&gt; | 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&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
-    - [ProcessCube&copy; LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube&copy;
+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.
+
+Only models can be queried by setting the `models_only` flag.
+
+## Inputs
+
+: 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.
+
+
+### Query fields
+
+**Summary**: 
+
+**Description**: Filter result for &#39;ProcessInstance Query&#39;
+
+#### 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&lt;string&gt; | string | SearchQuery
+    - string: myCorrelationId
+    - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
+    - object: 
+  - Description: Filter by the CorrelationId of the ProcessInstances.
+- Name: `processInstanceId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myProcessInstance_12345678
+    - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
+    - object: 
+  - Description: Filter by the ID of the ProcessInstances.
+- Name: `processDefinitionId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myProcess_12345678
+    - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
+    - object: 
+  - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
+- Name: `processModelId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myProcessModel_12345678
+    - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
+    - object: 
+  - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
+- Name: `processModelName` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: My Process Model
+    - Array&lt;string&gt;: 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&lt;string&gt; | string | SearchQuery
+    - string: 12345678
+    - Array&lt;string&gt;: 12345678,87654321
+    - object: 
+  - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
+- Name: `ownerId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: 12345678
+    - Array&lt;string&gt;: 12345678,87654321
+    - object: 
+  - Description: Filter by the ID of the User that owns the ProcessInstances.
+- Name: `state` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: running
+    - Array&lt;string&gt;: running,finished
+    - object: 
+  - Description: Filter by the state of the ProcessInstances.
+- Name: `parentProcessInstanceId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myParentProcessInstance_12345678
+    - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
+    - object: 
+  - Description: Filter by the ID of the parent ProcessInstance.
+- Name: `embeddedProcessModelId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myModel1
+    - Array&lt;string&gt;: myModel1,myModel2
+    - object: 
+  - Description: Filter by the ID of the embedded process model.
+- Name: `terminatedByUserId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: 12345678
+    - Array&lt;string&gt;: 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&lt;string&gt; | 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&lt;string&gt; | 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&lt;string&gt; | 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&lt;string&gt; | 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&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
+-  [ProcessCube&copy; LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube&copy;
 </script>

package/processdefinition-query.js

@@ -16,10 +16,6 @@ module.exports = function (RED) {
 
             node.log(`Querying process definitions with query: ${JSON.stringify(query)}`);
 
-            const isUser = !!msg._client?.user;
-            const identity = isUser ? { userId: msg._client.user.id, token: msg._client.user.accessToken } : null;
-            query.identity = identity;
-
             client.processDefinitions
                 .getAll(query)
                 .then((matchingProcessDefinitions) => {

package/processinstance-delete.html

@@ -50,63 +50,61 @@
 </script>
 
 <script type="text/markdown" data-help-name="processinstance-delete">
-    Delete old instances of a process model in the ProcessCube.
+Delete old instances of a process model in the ProcessCube.
 
-    ## Inputs
+## Inputs
 
-    : payload.duration (number): The number of given time periods.
-    : payload.time_type ('hours' | 'days'): The type of time period to use.
-    : payload.batch_size (number): The number of instances to be deleted simultaneously. (default 100)
+: payload.duration (number): The number of given time periods.
+: payload.time_type ('hours' | 'days'): The type of time period to use.
+: payload.batch_size (number): The number of instances to be deleted simultaneously. (default 100)
 
-    ## Outputs
+## Outputs
 
-    : Explanation of the payload:
+: Explanation of the payload:
 
-    Object
-    {
+Object
+{
     successfulDeletions: [Array of strings],
     failedDeletions: [Array of objects]
+}
+
+- successfulDeletions:
+    - Type: Array<String>
+    - Content: A list of successfully deleted process instance IDs.
+
+    - excample:
+        successfulDeletions: [
+        "instanceId1",
+        "instanceId2",
+        "instanceId3"
+       ]
+
+- failedDeletions:
+    - Type: Array<Object>
+    - Content: A list of objects containing details of the failed deletions.
+    - Each object has the following fields:
+        - id: The ID of the process instance that could not be deleted.
+        - error: The error message or the reason for the error.
+
+- Example of a complete output:
+    {
+        successfulDeletions: [
+            "instanceId1",
+            "instanceId2",
+            "instanceId3"
+        ],
+        failedDeletions: [
+            { id: "instanceId4", error: "Permission denied" },
+            { id: "instanceId5", error: "Instance not found" }
+        ]
     }
 
-    - successfulDeletions:
-
-        - Type: Array<String>
-        - Content: A list of successfully deleted process instance IDs.
-
-        - excample:
-          successfulDeletions: [
-          "instanceId1",
-          "instanceId2",
-          "instanceId3"
-          ]
-
-    - failedDeletions:
-
-        - Type: Array<Object>
-        - Content: A list of objects containing details of the failed deletions.
-        - Each object has the following fields:
-            - id: The ID of the process instance that could not be deleted.
-            - error: The error message or the reason for the error.
-
-    - Example of a complete output:
-      {
-      successfulDeletions: [
-      "instanceId1",
-      "instanceId2",
-      "instanceId3"
-      ],
-      failedDeletions: [
-      { id: "instanceId4", error: "Permission denied" },
-      { id: "instanceId5", error: "Instance not found" }
-      ]
-      }
-
-    The node processes the IDs in configurable batches (default value: 100) and inserts successfully deleted or failed instances into the arrays accordingly.
-    As processing is currently forced to batch, a detailed error output is not possible.
-    If an error occurs during the processing of a batch, all Id's of this batch are marked as faulty.
+The node processes the IDs in configurable batches (default value: 100) and inserts successfully deleted or failed instances into the arrays accordingly.
+As processing is currently forced to batch, a detailed error output is not possible. 
+If an error occurs during the processing of a batch, all Id's of this batch are marked as faulty.
 
-    ### References
+### 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;
+-   [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/processinstance-delete.js

@@ -7,9 +7,6 @@ module.exports = function (RED) {
             node.engine = RED.nodes.getNode(config.engine);
             const client = node.engine ? node.engine.engineClient : null;
 
-            const isUser = !!msg._client?.user;
-            const userIdentity = isUser ? { userId: msg._client.user.id, token: msg._client.user.accessToken } : null;
-
             if (!client || !client.processInstances) {
                 node.error('No engine or processInstances API configured.', msg);
                 return;
@@ -37,7 +34,7 @@ module.exports = function (RED) {
             const multiplier = timeType === 'hours' ? 1 : 24;
             node.log(`Time type: ${timeType}`);
 
-            const deletionDate = new Date(Date.now() - timeToUse * multiplier * 60 * 60 * 1000);
+            const deletionDate = new Date(Date.now() - timeToUse * multiplier * 60 * 60 * 1000);            
 
             const modelId = msg.payload.processModelId?.trim() || config.modelid?.trim();
             if (!modelId) {
@@ -67,18 +64,12 @@ module.exports = function (RED) {
                             state: ['finished', 'error', 'terminated'],
                             limit: batchSize,
                         },
-                        {
-                            includeXml: false,
-                            identity: userIdentity,
-                        },
+                        { includeXml: false }
                     );
 
                     const processInstances = result.processInstances || [];
                     if (processInstances.length === 0) {
-                        node.log(
-                            `No more process instances to delete for Model-ID: ${modelId} with Date: ${deletionDate.toISOString()}`,
-                            msg,
-                        );
+                        node.log(`No more process instances to delete for Model-ID: ${modelId} with Date: ${deletionDate.toISOString()}`, msg);
                         hasMoreResults = false;
                         continue;
                     }
@@ -86,30 +77,24 @@ module.exports = function (RED) {
                     const ids = processInstances.map((obj) => obj.processInstanceId);
 
                     try {
-                        await client.processInstances.deleteProcessInstances(ids, true, userIdentity);
+                        await client.processInstances.deleteProcessInstances(ids, true);
                         msg.payload.successfulDeletions.push(...ids);
-                        sumSuccessful += ids.length;
+                        sumSuccessful += ids.length;                         
                     } catch (deleteError) {
                         var message = JSON.stringify(deleteError);
                         sumFailed += ids.length;
                         ids.forEach((id) => {
                             msg.payload.failedDeletions.push({ id, error: message });
                         });
-                        node.warn(
-                            `Failed to delete some process instances for Model-ID: ${modelId}. Error: ${message}`,
-                        );
+                        node.warn(`Failed to delete some process instances for Model-ID: ${modelId}. Error: ${message}`);
                     }
                 }
-                node.log(
-                    `Successfully deleted ${sumSuccessful} process instances and ${sumFailed} failed to delete process instances for Model-ID: ${modelId}.`,
-                );
+                node.log(`Successfully deleted ${sumSuccessful} process instances and ${sumFailed} failed to delete process instances for Model-ID: ${modelId}.`);
+
 
                 node.send(msg);
             } catch (queryError) {
-                node.error(
-                    `Failed to query process instances for Model-ID: ${modelId}. Error: ${queryError.message}`,
-                    msg,
-                );
+                node.error(`Failed to query process instances for Model-ID: ${modelId}. Error: ${queryError.message}`, msg);
             }
         });
     }