@5minds/node-red-contrib-processcube 1.1.4-feature-bc1698-m0kn1ci4 → 1.1.4-feature-db7b89-m14muv3d

package/externaltask-error.html

@@ -8,6 +8,7 @@
         },
         inputs: 1,
         outputs: 1,
+        align: 'right',
         icon: 'externaltask_error.svg',
         label: function () {
             return this.name || 'externaltask-error';

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-event-listener.js

@@ -31,27 +31,21 @@ module.exports = function (RED) {
             }
 
             async function subscribe() {
-                const eventHandlers = {
-                    created: () =>
-                        client.notification.onExternalTaskCreated(externalTaskCallback('created'), {
+                switch (config.eventtype) {
+                    case 'created':
+                        return await client.notification.onExternalTaskCreated(externalTaskCallback(), {
                             identity: currentIdentity,
-                        }),
-                    locked: () =>
-                        client.notification.onExternalTaskLocked(externalTaskCallback('locked'), {
+                        });
+                    case 'locked':
+                        return await client.notification.onExternalTaskLocked(externalTaskCallback(), {
                             identity: currentIdentity,
-                        }),
-                    unlocked: () =>
-                        client.notification.onExternalTaskUnlocked(externalTaskCallback('unlocked'), {
+                        });
+                    case 'unlocked':
+                        return await client.notification.onExternalTaskUnlocked(externalTaskCallback(), {
                             identity: currentIdentity,
-                        }),
-                };
-
-                const handler = eventHandlers[config.eventtype];
-
-                if (handler) {
-                    return await handler();
-                } else {
-                    console.error('No such event: ' + config.eventtype);
+                        });
+                    default:
+                        console.error('no such event: ' + config.eventtype);
                 }
             }
 

package/externaltask-input.html

@@ -6,6 +6,7 @@
             name: { value: '' },
             engine: { value: '', type: 'processcube-engine-config' },
             topic: { value: '' },
+            workerConfig: { value: '', type: 'json' },
         },
         inputs: 0,
         outputs: 1,
@@ -13,6 +14,15 @@
         label: function () {
             return this.name || 'externaltask-input';
         },
+        oneditprepare: function () {
+            $('#node-input-workerConfig').typedInput({
+                default: 'json',
+                types: ['json'],
+            });
+        },
+        oneditsave: function () {
+            this.workerConfig = $('#node-input-workerConfig').typedInput('value');
+        },
     });
 </script>
 
@@ -29,6 +39,10 @@
         <label for="node-input-topic"><i class="fa fa-tag"></i> Topic</label>
         <input type="text" id="node-input-topic" placeholder="Topic of ExternalTask" />
     </div>
+    <div class="form-row"></div>
+        <label for="node-input-workerConfig"><i class="fa fa-tag"></i> Worker Config</label>
+        <input type="text" id="node-input-workerConfig" />
+    </div>
 </script>
 
 <script type="text/markdown" data-help-name="externaltask-input">
@@ -37,9 +51,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/externaltask-input.js

@@ -16,7 +16,7 @@ module.exports = function (RED) {
         var node = this;
         var flowContext = node.context().flow;
 
-        const engine =  RED.nodes.getNode(config.engine);
+        const engine = RED.nodes.getNode(config.engine);
 
         const client = engine.engineClient;
 
@@ -32,82 +32,84 @@ module.exports = function (RED) {
             eventEmitter = flowContext.get('emitter');
         }
 
-        client.externalTasks
-            .subscribeToExternalTaskTopic(config.topic, async (payload, externalTask) => {
-                const saveHandleCallback = (data, callback) => {
-                    try {
-                        callback(data);
-                    } catch (error) {
-                        node.error(`Error in callback 'saveHandleCallback': ${error.message}`);
-                    }
-                };
+        const etwCallback = async (payload, externalTask) => {
+            const saveHandleCallback = (data, callback) => {
+                try {
+                    callback(data);
+                } catch (error) {
+                    node.error(`Error in callback 'saveHandleCallback': ${error.message}`);
+                }
+            };
 
-                return await new Promise((resolve, reject) => {
-                    const handleFinishTask = (msg) => {
-                        let result = RED.util.encodeObject(msg.payload);
+            return await new Promise((resolve, reject) => {
+                const handleFinishTask = (msg) => {
+                    let result = RED.util.encodeObject(msg.payload);
 
-                        node.log(
-                            `handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* ${externalTask.processInstanceId} with result ${result} on msg._msgid ${msg._msgid}.`,
-                        );
+                    node.log(
+                        `handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* ${externalTask.processInstanceId} with result ${result} on msg._msgid ${msg._msgid}.`
+                    );
 
-                        if (externalTask.flowNodeInstanceId) {
-                            delete started_external_tasks[externalTask.flowNodeInstanceId];
-                        }
+                    if (externalTask.flowNodeInstanceId) {
+                        delete started_external_tasks[externalTask.flowNodeInstanceId];
+                    }
 
-                        showStatus(node, Object.keys(started_external_tasks).length);
+                    showStatus(node, Object.keys(started_external_tasks).length);
 
-                        //resolve(result);
-                        saveHandleCallback(result, resolve);
-                    };
+                    //resolve(result);
+                    saveHandleCallback(result, resolve);
+                };
+
+                const handleErrorTask = (msg) => {
+                    node.log(
+                        `handle error event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' on *msg._msgid* '${msg._msgid}'.`
+                    );
 
-                    const handleErrorTask = (msg) => {
-                        node.log(
-                            `handle error event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' on *msg._msgid* '${msg._msgid}'.`,
-                        );
+                    if (externalTask.flowNodeInstanceId) {
+                        delete started_external_tasks[externalTask.flowNodeInstanceId];
+                    }
 
-                        if (externalTask.flowNodeInstanceId) {
-                            delete started_external_tasks[externalTask.flowNodeInstanceId];
-                        }
+                    showStatus(node, Object.keys(started_external_tasks).length);
 
-                        showStatus(node, Object.keys(started_external_tasks).length);
+                    // TODO: with reject, the default error handling is proceed
+                    // SEE: https://github.com/5minds/ProcessCube.Engine.Client.ts/blob/develop/src/ExternalTaskWorker.ts#L180
+                    // reject(result);
+                    //resolve(msg);
+                    saveHandleCallback(msg, resolve);
+                };
 
-                        // TODO: with reject, the default error handling is proceed
-                        // SEE: https://github.com/5minds/ProcessCube.Engine.Client.ts/blob/develop/src/ExternalTaskWorker.ts#L180
-                        // reject(result);
-                        //resolve(msg);
-                        saveHandleCallback(msg, resolve);
-                    };
+                eventEmitter.once(`handle-${externalTask.flowNodeInstanceId}`, (msg, isError = false) => {
+                    node.log(
+                        `handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}' and *isError* '${isError}'`
+                    );
 
-                    eventEmitter.once(`handle-${externalTask.flowNodeInstanceId}`, (msg, isError = false) => {
-                        node.log(
-                            `handle event for *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}' and *isError* '${isError}'`,
-                        );
+                    if (isError) {
+                        handleErrorTask(msg);
+                    } else {
+                        handleFinishTask(msg);
+                    }
+                });
 
-                        if (isError) {
-                            handleErrorTask(msg);
-                        } else {
-                            handleFinishTask(msg);
-                        }
-                    });
+                started_external_tasks[externalTask.flowNodeInstanceId] = externalTask;
 
-                    started_external_tasks[externalTask.flowNodeInstanceId] = externalTask;
+                showStatus(node, Object.keys(started_external_tasks).length);
 
-                    showStatus(node, Object.keys(started_external_tasks).length);
+                let msg = {
+                    _msgid: RED.util.generateId(),
+                    task: RED.util.encodeObject(externalTask),
+                    payload: payload,
+                    flowNodeInstanceId: externalTask.flowNodeInstanceId,
+                };
 
-                    let msg = {
-                        _msgid: RED.util.generateId(),
-                        task: RED.util.encodeObject(externalTask),
-                        payload: payload,
-                        flowNodeInstanceId: externalTask.flowNodeInstanceId,
-                    };
+                node.log(
+                    `Received *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}'`
+                );
 
-                    node.log(
-                        `Received *external task flowNodeInstanceId* '${externalTask.flowNodeInstanceId}' and *processInstanceId* '${externalTask.processInstanceId}' with *msg._msgid* '${msg._msgid}'`,
-                    );
+                node.send(msg);
+            });
+        };
 
-                    node.send(msg);
-                });
-            })
+        client.externalTasks
+            .subscribeToExternalTaskTopic(config.topic, etwCallback, config.workerConfig)
             .then(async (externalTaskWorker) => {
                 node.status({ fill: 'blue', shape: 'ring', text: 'subcribed' });
 

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-feature-bc1698-m0kn1ci4",
+    "version": "1.1.4-feature-db7b89-m14muv3d",
     "license": "MIT",
     "description": "Node-RED nodes for ProcessCube",
     "scripts": {
@@ -41,6 +41,7 @@
             "externaltaskError": "externaltask-error.js",
             "externaltaskEventListener": "externaltask-event-listener.js",
             "processStart": "process-start.js",
+            "processTerminate": "process-terminate.js",
             "processEventListener": "process-event-listener.js",
             "processcubeEngineConfig": "processcube-engine-config.js",
             "ProcessinstanceQuery": "processinstance-query.js",

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

@@ -0,0 +1,45 @@
+<script type="text/javascript">
+    RED.nodes.registerType('process-terminate', {
+        category: 'ProcessCube',
+        color: '#02AFD6',
+        defaults: {
+            name: { value: '' },
+            engine: { value: '', type: 'processcube-engine-config' },
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'font-awesome/fa-sign-in',
+        label: function () {
+            return this.name || 'process-terminate';
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="process-terminate">
+    <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="Engine-URL" />
+    </div>
+</script>
+
+<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
+-   [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
+
+</script>

package/process-terminate.js

@@ -0,0 +1,27 @@
+module.exports = function (RED) {
+    function ProcessTerminate(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.on('input', function (msg) {
+            const engine = RED.nodes.getNode(config.engine);
+            const client = engine.engineClient;
+
+            if (!client) {
+                node.error('No engine configured.');
+                return;
+            }
+
+            client.processInstances
+                .terminateProcessInstance(msg.payload, engine.identity)
+                .then(() => {
+                    node.send(msg);
+                })
+                .catch((error) => {
+                    node.error(error);
+                });
+        });
+    }
+
+    RED.nodes.registerType('process-terminate', ProcessTerminate);
+};

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

package/usertask-event-listener.js

@@ -46,23 +46,25 @@ module.exports = function (RED) {
             }
 
             async function subscribe() {
-                const eventHandlers = {
-                    new: () => client.userTasks.onUserTaskWaiting(userTaskCallback(), { identity: currentIdentity }),
-                    finished: () =>
-                        client.userTasks.onUserTaskFinished(userTaskCallback(), { identity: currentIdentity }),
-                    reserved: () =>
-                        client.userTasks.onUserTaskReserved(userTaskCallback(), { identity: currentIdentity }),
-                    'reservation-canceled': () =>
-                        client.userTasks.onUserTaskReservationCanceled(userTaskCallback(), {
+                switch (config.eventtype) {
+                    case 'new':
+                        return await client.userTasks.onUserTaskWaiting(userTaskCallback(), {
                             identity: currentIdentity,
-                        }),
-                };
-
-                const handler = eventHandlers[config.eventtype];
-                if (handler) {
-                    return await handler();
-                } else {
-                    console.error('no such event: ' + config.eventtype);
+                        });
+                    case 'finished':
+                        return await client.userTasks.onUserTaskFinished(userTaskCallback(), {
+                            identity: currentIdentity,
+                        });
+                    case 'reserved':
+                        return await client.userTasks.onUserTaskReserved(userTaskCallback(), {
+                            identity: currentIdentity,
+                        });
+                    case 'reservation-canceled':
+                        return await client.userTasks.onUserTaskReservationCanceled(userTaskCallback(), {
+                            identity: currentIdentity,
+                        });
+                    default:
+                        console.error('no such event: ' + config.eventtype);
                 }
             }
 

package/usertask-output.html

@@ -10,6 +10,7 @@
         },
         inputs: 1,
         outputs: 1,
+        align: 'right',
         icon: 'usertask_output.svg',
         label: function () {
             return this.name || 'usertask-output';
@@ -55,7 +56,6 @@ A node which sends the result of a usertask to the ProcessCube.
 
 ### References
 
-- [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
-- [Node-RED Integration in ProcessCube©](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube©
-
+-   [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
+-   [Node-RED Integration in ProcessCube©](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube©
 </script>