@5minds/node-red-contrib-processcube 1.8.2 → 1.8.3-feature-829069-m7nhmav6

package/.processcube/nodered/flows.json

@@ -698,6 +698,17 @@
         "name": "Engine Auth 8000",
         "url": "http://engine:8000"
     },
+    {
+        "id": "f7961bee80d8bcb5",
+        "type": "processcube-engine-config",
+        "name": "",
+        "url": "http://engine:8001",
+        "urlType": "str",
+        "clientId": "",
+        "clientIdType": "str",
+        "clientSecret": "",
+        "clientSecretType": "str"
+    },
     {
         "id": "b7ddfedf82d8120f",
         "type": "externaltask-error",

package/dataobject-instance-query.html

@@ -0,0 +1,120 @@
+<script type="text/javascript">
+    RED.nodes.registerType('dataobject-instance-query', {
+        category: 'ProcessCube',
+        color: '#02AFD6',
+        defaults: {
+            name: { value: '' },
+            engine: { value: '', type: 'processcube-engine-config' },
+            query: { value: 'payload' },
+            query_type: { value: 'msg' },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'processinstance_query.svg',
+        label: function () {
+            return this.name || 'dataobject-instance-query';
+        },
+        oneditprepare: function () {
+            $('#node-input-query').typedInput({
+                default: 'msg',
+                types: ['msg', 'json'],
+            });
+
+            $('#node-input-query').typedInput('value', this.query);
+            $('#node-input-query').typedInput('type', this.query_type);
+        },
+        oneditsave: function () {
+            (this.query = $('#node-input-query').typedInput('value')),
+            (this.query_type = $('#node-input-query').typedInput('type'));
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="dataobject-instance-query">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-engine"><i class="fa fa-tag"></i> Engine-URL</label>
+        <input type="text" id="node-input-engine" placeholder="http://engine:8000" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-query"><i class="fa fa-tag"></i> Query</label>
+        <input type="text" id="node-input-query" />
+    </div>
+</script>
+
+<script type="text/markdown" data-help-name="dataobject-instance-query">
+A node to query dataobject instances on the ProcessCube Engine.
+
+## Inputs
+
+: 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
+
+: dataObjectInstances (Array) : The dataobject instances that matched the query.
+: totalCount (number) : The number of matches.
+
+### Query fields
+
+**Summary**:
+
+**Description**: Gets all DataObjectInstances that match the given query.
+
+#### Parameters:
+- Name: `offset` Required: `false`
+  - Type: number
+  - Description: The index of the first DataObjectInstance to include in the result set.
+- Name: `limit` Required: `false`
+  - Type: number
+  - Description: The maximum number of DataObjectInstances to return.
+- Name: `dataObjectId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myDataObjectId_12345678
+    - Array&lt;string&gt;: myDataObjectId_12345678,myDataObjectId_87654321
+    - object:
+  - Description: Filter by the ID of the DataObject.
+- Name: `flowNodeInstanceId` Required: ``
+  - Type: Array&lt;string&gt; | string | SearchQuery
+    - string: myFlowNodeInstanceId_12345678
+    - Array&lt;string&gt;: myFlowNodeInstanceId_12345678,myFlowNodeInstanceId_87654321
+    - object:
+  - Description: Filter by the ID of the FlowNodeInstance that wrote to the DataObject.
+- 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 DataObjectInstances 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 DataObjectInstances belong to.
+- Name: `embeddedProcessModelId` 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 EmbeededProcessModel that the DataObjectInstances belong to.
+- 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 created date of the DataObjectInstances to include in the results.
+
+### 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/dataobject-instance-query.js

@@ -0,0 +1,32 @@
+module.exports = function (RED) {
+    function DataobjectInstanceQuery(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.on('input', function (msg) {
+            let query = RED.util.evaluateNodeProperty(config.query, config.query_type, node, msg);
+
+            node.engine = RED.nodes.getNode(config.engine);
+            const client = node.engine.engineClient;
+            const isUser = !!msg._client?.user && !!msg._client.user.accessToken;
+            const userIdentity = isUser ? { userId: msg._client.user.id, token: msg._client.user.accessToken } : null;
+
+            if (!client) {
+                node.error('No engine configured.', msg);
+                return;
+            }
+
+            client.dataObjectInstances
+                .query(query, { identity: userIdentity })
+                .then((matchingInstances) => {
+                    msg.payload = matchingInstances;
+
+                    node.send(msg);
+                })
+                .catch((error) => {
+                    node.error(`Dataobject Instance Query failed: ${error.message}`, msg);
+                });
+        });
+    }
+    RED.nodes.registerType('dataobject-instance-query', DataobjectInstanceQuery);
+};

package/examples/Dataobject-Instance-Query-Sample.json

@@ -0,0 +1,109 @@
+[
+    {
+        "id": "8b280114f8ac9c23",
+        "type": "tab",
+        "label": "Dataobject Instances Query Sample",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "be0d703c70d1687b",
+        "type": "group",
+        "z": "8b280114f8ac9c23",
+        "style": {
+            "stroke": "#999999",
+            "stroke-opacity": "1",
+            "fill": "none",
+            "fill-opacity": "1",
+            "label": true,
+            "label-position": "nw",
+            "color": "#a4a4a4"
+        },
+        "nodes": [
+            "8687cdf9bf6c4d7d",
+            "74773491693b7f22",
+            "29e796ef38867f2a"
+        ],
+        "x": 74,
+        "y": 79,
+        "w": 632,
+        "h": 82
+    },
+    {
+        "id": "8687cdf9bf6c4d7d",
+        "type": "dataobject-instance-query",
+        "z": "8b280114f8ac9c23",
+        "g": "be0d703c70d1687b",
+        "name": "Query 5 DataobjectInstances",
+        "engine": "7de3086e71c028f9",
+        "query": "{ \"limit\": 5}",
+        "query_type": "json",
+        "x": 400,
+        "y": 120,
+        "wires": [
+            [
+                "74773491693b7f22"
+            ]
+        ]
+    },
+    {
+        "id": "74773491693b7f22",
+        "type": "debug",
+        "z": "8b280114f8ac9c23",
+        "g": "be0d703c70d1687b",
+        "name": "Log",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 610,
+        "y": 120,
+        "wires": []
+    },
+    {
+        "id": "29e796ef38867f2a",
+        "type": "inject",
+        "z": "8b280114f8ac9c23",
+        "g": "be0d703c70d1687b",
+        "name": "Trigger",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payload": "",
+        "payloadType": "date",
+        "x": 170,
+        "y": 120,
+        "wires": [
+            [
+                "8687cdf9bf6c4d7d"
+            ]
+        ]
+    },
+    {
+        "id": "7de3086e71c028f9",
+        "type": "processcube-engine-config",
+        "name": "",
+        "url": "http://engine:8000",
+        "urlType": "str",
+        "clientId": "",
+        "clientIdType": "str",
+        "clientSecret": "",
+        "clientSecretType": "str"
+    }
+]

package/externaltask-input.js

@@ -214,7 +214,7 @@ module.exports = function (RED) {
 
                     try {
                         externalTaskWorker.start();
-                        node.showStatus();
+                        node.setUnsubscribedStatus();
                     } catch (error) {
                         node.error(`Worker start 'externalTaskWorker.start' failed: ${error.message}`, {});
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@5minds/node-red-contrib-processcube",
-    "version": "1.8.2",
+    "version": "1.8.3-feature-829069-m7nhmav6",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "scripts": {
@@ -36,6 +36,7 @@
         "version": ">=3.1.9",
         "nodes": {
             "checkAuthorization": "check-authorization.js",
+            "DataobjectInstanceQuery": "dataobject-instance-query.js",
             "EndEventFinishedListener": "endevent-finished-listener.js",
             "externaltaskInput": "externaltask-input.js",
             "externaltaskOutput": "externaltask-output.js",