@5minds/node-red-contrib-processcube 1.1.4-develop-80ad6a-m0l0wxfa → 1.1.4-develop-6d3478-m0m7vuis

Sign up to get free protection for your applications and to get access to all the features.
@@ -8,6 +8,7 @@
8
8
  },
9
9
  inputs: 1,
10
10
  outputs: 1,
11
+ align: 'right',
11
12
  icon: 'externaltask_error.svg',
12
13
  label: function () {
13
14
  return this.name || 'externaltask-error';
@@ -45,6 +45,11 @@ A node which listens for events triggered by externaltasks
45
45
 
46
46
  ## Outputs
47
47
 
48
+ : flowNodeInstanceId (string): The unique identifier for the flow node instance.
49
+ : externalTaskEvent (Object): An Object containing the event data returned by the engine.
50
+ : action (string): The event that occured.
51
+ : type (string): The target of the event.
52
+
48
53
  ### References
49
54
 
50
55
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
@@ -37,9 +37,9 @@ the connected ProcessCube Engine for processing.
37
37
 
38
38
  ## Outputs
39
39
 
40
- : payload (string) : Defines the input of the external task token
40
+ : payload (string) : The payload the external task was started with.
41
41
  : task (object) : The external task object
42
- : flowNodeInstanceId : The Id of the external task, which is needed to complete the task
42
+ : flowNodeInstanceId : The unique identifier of the external task, which is needed to complete the task
43
43
 
44
44
  ### Details
45
45
 
@@ -37,17 +37,17 @@
37
37
  </script>
38
38
 
39
39
  <script type="text/markdown" data-help-name="externaltask-input">
40
- A Message event to an intermediate message event can be triggert.
40
+ A node to trigger an event that will be send to the corresponding intermediate message event in the connected ProcessCube Engine.
41
41
 
42
42
  From the config the `messagename` and the `processInstanceId` must be set.
43
43
 
44
44
  ## Inputs
45
45
 
46
- : payload (Object) : Will sent to the event and used an new token payload.
46
+ : payload (Object) : The payload will be sent to the message event and be used as a new token payload.
47
47
 
48
48
  ### References
49
49
 
50
50
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
51
51
  - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
52
-
52
+
53
53
  </script>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@5minds/node-red-contrib-processcube",
3
- "version": "1.1.4-develop-80ad6a-m0l0wxfa",
3
+ "version": "1.1.4-develop-6d3478-m0m7vuis",
4
4
  "license": "MIT",
5
5
  "description": "Node-RED nodes for ProcessCube",
6
6
  "scripts": {
@@ -75,6 +75,95 @@ A node which listens for events triggered by processes
75
75
 
76
76
  ## Outputs
77
77
 
78
+ ### starting
79
+
80
+ : processInstanceId (string): The unique identifier for the process instance.
81
+ : processModelId (string): The id of the process model.
82
+ : processInstance (Object): An Object representing the process instance data.
83
+ : action (string): The event that occured.
84
+ : type (string): The target of the event.
85
+
86
+ ### started
87
+
88
+ : processInstanceId (string): The unique identifier for the process instance.
89
+ : processModelId (string): The id of the process model.
90
+ : flowNodeId (string): The id of the flowNode the process was started with.
91
+ : token (Object): The start token of the process instance.
92
+ : processInstance (Object): An Object representing the process instance data.
93
+ : action (string): The event that occured.
94
+ : type (string): The target of the event.
95
+
96
+ ### resumed
97
+
98
+ : processInstanceId (string): The unique identifier for the process instance.
99
+ : processModelId (string): The id of the process model.
100
+ : token (Object): The current token of the process instance.
101
+ : processInstance (Object): An Object representing the process instance data.
102
+ : action (string): The event that occured.
103
+ : type (string): The target of the event.
104
+
105
+ ### finished
106
+
107
+ : processInstanceId (string): The unique identifier for the process instance.
108
+ : processModelId (string): The id of the process model.
109
+ : flowNodeId (string): The id of the flowNode the process was finished with.
110
+ : token (Object): The end token of the process instance.
111
+ : processInstance (Object): An Object representing the process instance data.
112
+ : action (string): The event that occured.
113
+ : type (string): The target of the event.
114
+
115
+ ### terminated
116
+
117
+ : processInstanceId (string): The unique identifier for the process instance.
118
+ : processModelId (string): The id of the process model.
119
+ : token (Object): The current token of the process instance.
120
+ : processInstance (Object): An Object representing the process instance data.
121
+ : action (string): The event that occured.
122
+ : type (string): The target of the event.
123
+
124
+ ### error
125
+
126
+ : processInstanceId (string): The unique identifier for the process instance.
127
+ : processModelId (string): The id of the process model.
128
+ : token (Object): The current token of the process instance.
129
+ : processInstance (Object): An Object representing the process instance data.
130
+ : action (string): The event that occured.
131
+ : type (string): The target of the event.
132
+
133
+ ### owner-changed
134
+
135
+ : processInstanceId (string): The unique identifier for the process instance.
136
+ : processModelId (string): The id of the process model.
137
+ : processInstance (Object): An Object representing the process instance data.
138
+ : action (string): The event that occured.
139
+ : type (string): The target of the event.
140
+
141
+ ### instances-deleted
142
+
143
+ : processInstanceId (string): The unique identifier for the process instance.
144
+ : processModelId (string): The id of the process model.
145
+ : processInstance (Object): An Object representing the process instance data.
146
+ : action (string): The event that occured.
147
+ : type (string): The target of the event.
148
+
149
+ ### is-executable-changed
150
+
151
+ : processModelId (string): The id of the process model.
152
+ : action (string): The event that occured.
153
+ : type (string): The target of the event.
154
+
155
+ ### deployed
156
+
157
+ : processModelId (string): The id of the process model.
158
+ : action (string): The event that occured.
159
+ : type (string): The target of the event.
160
+
161
+ ### undeployed
162
+
163
+ : processModelId (string): The id of the process model.
164
+ : action (string): The event that occured.
165
+ : type (string): The target of the event.
166
+
78
167
  ### References
79
168
 
80
169
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -43,10 +43,15 @@ The `processModelId` and `startEventId` can be set in the message object to over
43
43
 
44
44
  ## Inputs
45
45
 
46
- : payload (Object) : Will be used as the input for the process.
46
+ : payload (Object) : Will be used as the start token for the process.
47
47
  : processModelId (String) : Will be used as the process model and override the configured `Processmodel`.
48
48
  : startEventId (String) : Will be used as the start event and override the configured `Startevent`.
49
49
 
50
+ ## Outputs
51
+
52
+ : processInstanceId (string) : The unique identifier of the started process instance.
53
+ : correlationId (string) : The unique correlation identifier of the started process instance.
54
+
50
55
  ### References
51
56
 
52
57
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -29,6 +29,14 @@
29
29
  <script type="text/markdown" data-help-name="process-terminate">
30
30
  Terminate an instance of a process model in the ProcessCube.
31
31
 
32
+ ## Inputs
33
+
34
+ : payload (string): The id of the processinstance that is going to be terminated.
35
+
36
+ ## Outputs
37
+
38
+ : payload (string): The id of the processinstance that was terminated.
39
+
32
40
  ### References
33
41
 
34
42
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -61,7 +61,7 @@
61
61
  </script>
62
62
 
63
63
  <script type="text/markdown" data-help-name="processdefinition-query">
64
- Query process definitions or process models from the ProcessCube engine.
64
+ A node to query process definition on the ProcessCube Engine.
65
65
 
66
66
  The `query` can be given a direkt query field from the configutation or a message property.
67
67
 
@@ -71,6 +71,11 @@ Only models can be queried by setting the `models_only` flag.
71
71
 
72
72
  : payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
73
73
 
74
+ ## Outputs
75
+
76
+ : processDefinitions / models (Array) : The processDefinitions / models that matched the query.
77
+ : totalCount (number) : The number of matches.
78
+
74
79
  ### References
75
80
 
76
81
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -46,12 +46,17 @@
46
46
  </script>
47
47
 
48
48
  <script type="text/markdown" data-help-name="processinstance-query">
49
- Query a process instance in the ProcessCube.
49
+ A node to query process instances on the ProcessCube Engine.
50
50
 
51
51
  ## Inputs
52
52
 
53
53
  : payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
54
54
 
55
+ ## Outputs
56
+
57
+ : processInstances (Array) : The process instances that matched the query.
58
+ : totalCount (number) : The number of matches.
59
+
55
60
  ### References
56
61
 
57
62
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -68,6 +68,12 @@ A node which listens for events triggered by usertasks
68
68
 
69
69
  ## Outputs
70
70
 
71
+ : flowNodeInstanceId (string): The unique identifier for the usertask instance.
72
+ : userTaskEvent (Object): An Object representing the event returned by the engine.
73
+ : processInstance (Object): An Object representing the process instance data.
74
+ : action (string): The event that occured.
75
+ : type (string): The target of the event.
76
+
71
77
  ### References
72
78
 
73
79
  - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
@@ -10,6 +10,7 @@
10
10
  },
11
11
  inputs: 1,
12
12
  outputs: 1,
13
+ align: 'right',
13
14
  icon: 'usertask_output.svg',
14
15
  label: function () {
15
16
  return this.name || 'usertask-output';
@@ -55,7 +56,6 @@ A node which sends the result of a usertask to the ProcessCube.
55
56
 
56
57
  ### References
57
58
 
58
- - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
59
- - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
60
-
59
+ - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
60
+ - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
61
61
  </script>