@5minds/node-red-contrib-processcube 1.5.6 → 1.5.7-develop-10cfa5-m3qdjs6o

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. package/doc_generator/README.md +6 -0
  2. package/doc_generator/_process_instances_query.md +121 -0
  3. package/doc_generator/generator.js +41 -0
  4. package/doc_generator/generator_with_swagger.js +89 -0
  5. package/doc_generator/outputs/.gitkeep +0 -0
  6. package/doc_generator/package-lock.json +176 -0
  7. package/doc_generator/package.json +15 -0
  8. package/doc_generator/query_template.mustache +20 -0
  9. package/doc_generator/swagger.json +4110 -0
  10. package/endevent-finished-listener.js +18 -8
  11. package/externaltask-event-listener.js +13 -2
  12. package/externaltask-input.html +16 -1
  13. package/externaltask-input.js +120 -100
  14. package/nodered/flows.json +108 -1
  15. package/package.json +1 -1
  16. package/process-event-listener.js +17 -4
  17. package/process-terminate.html +3 -2
  18. package/processcube-engine-config.js +14 -6
  19. package/processdefinition-query.html +121 -0
  20. package/processinstance-delete.html +9 -9
  21. package/processinstance-query.html +115 -1
  22. package/usertask-event-listener.html +121 -0
  23. package/usertask-event-listener.js +15 -3
  24. package/usertask-input.html +119 -0
  25. package/wait-for-usertask.html +119 -0
  26. package/wait-for-usertask.js +38 -35
package/processdefinition-query.html CHANGED
@@ -76,6 +76,127 @@ Only models can be queried by setting the `models_only` flag.
76
76
  : processDefinitions / models (Array) : The processDefinitions / models that matched the query.
77
77
  : totalCount (number) : The number of matches.
78
78
 
79
+
80
+ ### Query fields
81
+
82
+ **Summary**:
83
+
84
+ **Description**: Filter result for 'ProcessInstance Query'
85
+
86
+ #### Parameters:
87
+ - Name: `offset` Required: `false`
88
+ - Type: number
89
+ - Description: The index of the first ProcessInstance to include in the result set.
90
+ - Name: `limit` Required: `false`
91
+ - Type: number
92
+ - Description: The maximum number of ProcessInstances to return.
93
+ - Name: `correlationId` Required: `false`
94
+ - Type: Array<string> | string | SearchQuery
95
+ - string: myCorrelationId
96
+ - Array<string>: myCorrelationId1,myCorrelationId2
97
+ - object:
98
+ - Description: Filter by the CorrelationId of the ProcessInstances.
99
+ - Name: `processInstanceId` Required: ``
100
+ - Type: Array<string> | string | SearchQuery
101
+ - string: myProcessInstance_12345678
102
+ - Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
103
+ - object:
104
+ - Description: Filter by the ID of the ProcessInstances.
105
+ - Name: `processDefinitionId` Required: ``
106
+ - Type: Array<string> | string | SearchQuery
107
+ - string: myProcess_12345678
108
+ - Array<string>: myProcess_12345678,myProcess_87654321
109
+ - object:
110
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
111
+ - Name: `processModelId` Required: ``
112
+ - Type: Array<string> | string | SearchQuery
113
+ - string: myProcessModel_12345678
114
+ - Array<string>: myProcessModel_12345678,myProcessModel_87654321
115
+ - object:
116
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
117
+ - Name: `processModelName` Required: ``
118
+ - Type: Array<string> | string | SearchQuery
119
+ - string: My Process Model
120
+ - Array<string>: My Process Model,My Other Process Model
121
+ - object:
122
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
123
+ - Name: `processModelHash` Required: ``
124
+ - Type: Array<string> | string | SearchQuery
125
+ - string: 12345678
126
+ - Array<string>: 12345678,87654321
127
+ - object:
128
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
129
+ - Name: `ownerId` Required: ``
130
+ - Type: Array<string> | string | SearchQuery
131
+ - string: 12345678
132
+ - Array<string>: 12345678,87654321
133
+ - object:
134
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
135
+ - Name: `state` Required: ``
136
+ - Type: Array<string> | string | SearchQuery
137
+ - string: running
138
+ - Array<string>: running,finished
139
+ - object:
140
+ - Description: Filter by the state of the ProcessInstances.
141
+ - Name: `parentProcessInstanceId` Required: ``
142
+ - Type: Array<string> | string | SearchQuery
143
+ - string: myParentProcessInstance_12345678
144
+ - Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
145
+ - object:
146
+ - Description: Filter by the ID of the parent ProcessInstance.
147
+ - Name: `embeddedProcessModelId` Required: ``
148
+ - Type: Array<string> | string | SearchQuery
149
+ - string: myModel1
150
+ - Array<string>: myModel1,myModel2
151
+ - object:
152
+ - Description: Filter by the ID of the embedded process model.
153
+ - Name: `terminatedByUserId` Required: ``
154
+ - Type: Array<string> | string | SearchQuery
155
+ - string: 12345678
156
+ - Array<string>: 12345678,87654321
157
+ - object:
158
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
159
+ - Name: `createdBefore` Required: ``
160
+ - Type: string
161
+ - Description: The maximum created date of the ProcessInstances to include in the results.
162
+ - Name: `createdAt` Required: ``
163
+ - Type: Array<string> | string
164
+ - string: 2021-01-01T00:00:00.000Z
165
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
166
+ - Description: The minimum created date of the ProcessInstances to include in the results.
167
+ - Name: `createdAfter` Required: ``
168
+ - Type: string
169
+ - Description: The minimum created date of the ProcessInstances to include in the results.
170
+ - Name: `updatedBefore` Required: ``
171
+ - Type: string
172
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
173
+ - Name: `updatedAt` Required: ``
174
+ - Type: Array<string> | string
175
+ - string: 2021-01-01T00:00:00.000Z
176
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
177
+ - Description: The exact updated date of the ProcessInstances to include in the results.
178
+ - Name: `updatedAfter` Required: ``
179
+ - Type: string
180
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
181
+ - Name: `finishedBefore` Required: ``
182
+ - Type: string
183
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
184
+ - Name: `finishedAt` Required: ``
185
+ - Type: Array<string> | string
186
+ - string: 2021-01-01T00:00:00.000Z
187
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
188
+ - Description: The exact finished date of the ProcessInstances to include in the results.
189
+ - Name: `finishedAfter` Required: ``
190
+ - Type: string
191
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
192
+ - Name: `triggeredByFlowNodeInstance` Required: ``
193
+ - Type: Array<string> | string | SearchQuery
194
+ - string: myFlowNodeInstance_12345678
195
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
196
+ - object:
197
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
198
+
199
+
79
200
  ### References
80
201
 
81
202
  - [The ProcessCube© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
package/processinstance-delete.html CHANGED
@@ -45,19 +45,19 @@
45
45
  </script>
46
46
 
47
47
  <script type="text/markdown" data-help-name="processinstance-delete">
48
- Delete old instances of a process model in the ProcessCube.
48
+ Delete old instances of a process model in the ProcessCube.
49
49
 
50
- ## Inputs
50
+ ## Inputs
51
51
 
52
- : payload.time (number): The number of given time periods.
53
- : payload.time_type ('hours' | 'days'): The type of time period to use.
52
+ : payload.time (number): The number of given time periods.
53
+ : payload.time_type ('hours' | 'days'): The type of time period to use.
54
54
 
55
- ## Outputs
55
+ ## Outputs
56
56
 
57
- : payload (string[]): The ids of the processinstances that were deleted.
57
+ : payload (string[]): The ids of the processinstances that were deleted.
58
58
 
59
- ### References
59
+ ### References
60
60
 
61
- - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
62
- - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
61
+ - [The ProcessCube Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
62
+ - [Node-RED Integration in ProcessCube&copy;](https://processcube.io/docs/node-red) - Node-RED integration in ProcessCube&copy;
63
63
  </script>
package/processinstance-query.html CHANGED
@@ -50,13 +50,127 @@ A node to query process instances on the ProcessCube Engine.
50
50
 
51
51
  ## Inputs
52
52
 
53
- : payload (Object | JSON) : Will be used as the input for the query or can be directly set as JSON.
53
+ : 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.
54
+ : query (Object) : The query that was used.
54
55
 
55
56
  ## Outputs
56
57
 
57
58
  : processInstances (Array) : The process instances that matched the query.
58
59
  : totalCount (number) : The number of matches.
59
60
 
61
+ ### Query fields
62
+
63
+ **Summary**:
64
+
65
+ **Description**: Gets all ProcessInstances that match the given query.
66
+
67
+ #### Parameters:
68
+ - Name: `offset` Required: `false`
69
+ - Type: number
70
+ - Description: The index of the first ProcessInstance to include in the result set.
71
+ - Name: `limit` Required: `false`
72
+ - Type: number
73
+ - Description: The maximum number of ProcessInstances to return.
74
+ - Name: `correlationId` Required: `false`
75
+ - Type: Array&lt;string&gt; | string | SearchQuery
76
+ - string: myCorrelationId
77
+ - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
78
+ - object:
79
+ - Description: Filter by the CorrelationId of the ProcessInstances.
80
+ - Name: `processInstanceId` Required: ``
81
+ - Type: Array&lt;string&gt; | string | SearchQuery
82
+ - string: myProcessInstance_12345678
83
+ - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
84
+ - object:
85
+ - Description: Filter by the ID of the ProcessInstances.
86
+ - Name: `processDefinitionId` Required: ``
87
+ - Type: Array&lt;string&gt; | string | SearchQuery
88
+ - string: myProcess_12345678
89
+ - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
90
+ - object:
91
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
92
+ - Name: `processModelId` Required: ``
93
+ - Type: Array&lt;string&gt; | string | SearchQuery
94
+ - string: myProcessModel_12345678
95
+ - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
96
+ - object:
97
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
98
+ - Name: `processModelName` Required: ``
99
+ - Type: Array&lt;string&gt; | string | SearchQuery
100
+ - string: My Process Model
101
+ - Array&lt;string&gt;: My Process Model,My Other Process Model
102
+ - object:
103
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
104
+ - Name: `processModelHash` Required: ``
105
+ - Type: Array&lt;string&gt; | string | SearchQuery
106
+ - string: 12345678
107
+ - Array&lt;string&gt;: 12345678,87654321
108
+ - object:
109
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
110
+ - Name: `ownerId` Required: ``
111
+ - Type: Array&lt;string&gt; | string | SearchQuery
112
+ - string: 12345678
113
+ - Array&lt;string&gt;: 12345678,87654321
114
+ - object:
115
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
116
+ - Name: `state` Required: ``
117
+ - Type: Array&lt;string&gt; | string | SearchQuery
118
+ - string: running
119
+ - Array&lt;string&gt;: running,finished
120
+ - object:
121
+ - Description: Filter by the state of the ProcessInstances.
122
+ - Name: `parentProcessInstanceId` Required: ``
123
+ - Type: Array&lt;string&gt; | string | SearchQuery
124
+ - string: myParentProcessInstance_12345678
125
+ - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
126
+ - object:
127
+ - Description: Filter by the ID of the parent ProcessInstance.
128
+ - Name: `terminatedByUserId` Required: ``
129
+ - Type: Array&lt;string&gt; | string | SearchQuery
130
+ - string: 12345678
131
+ - Array&lt;string&gt;: 12345678,87654321
132
+ - object:
133
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
134
+ - Name: `createdBefore` Required: ``
135
+ - Type: string
136
+ - Description: The maximum created date of the ProcessInstances to include in the results.
137
+ - Name: `createdAt` Required: ``
138
+ - Type: Array&lt;string&gt; | string
139
+ - string: 2021-01-01T00:00:00.000Z
140
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
141
+ - Description: The minimum created date of the ProcessInstances to include in the results.
142
+ - Name: `createdAfter` Required: ``
143
+ - Type: string
144
+ - Description: The minimum created date of the ProcessInstances to include in the results.
145
+ - Name: `updatedBefore` Required: ``
146
+ - Type: string
147
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
148
+ - Name: `updatedAt` Required: ``
149
+ - Type: Array&lt;string&gt; | string
150
+ - string: 2021-01-01T00:00:00.000Z
151
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
152
+ - Description: The exact updated date of the ProcessInstances to include in the results.
153
+ - Name: `updatedAfter` Required: ``
154
+ - Type: string
155
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
156
+ - Name: `finishedBefore` Required: ``
157
+ - Type: string
158
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
159
+ - Name: `finishedAt` Required: ``
160
+ - Type: Array&lt;string&gt; | string
161
+ - string: 2021-01-01T00:00:00.000Z
162
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
163
+ - Description: The exact finished date of the ProcessInstances to include in the results.
164
+ - Name: `finishedAfter` Required: ``
165
+ - Type: string
166
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
167
+ - Name: `triggeredByFlowNodeInstance` Required: ``
168
+ - Type: Array&lt;string&gt; | string | SearchQuery
169
+ - string: myFlowNodeInstance_12345678
170
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
171
+ - object:
172
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
173
+
60
174
  ### References
61
175
 
62
176
  - [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
package/usertask-event-listener.html CHANGED
@@ -74,6 +74,127 @@ A node which listens for events triggered by usertasks
74
74
  : action (string): The event that occured.
75
75
  : type (string): The target of the event.
76
76
 
77
+
78
+ ### Query fields
79
+
80
+ **Summary**:
81
+
82
+ **Description**: Filter result for &#39;UserTask Event Listener&#39;
83
+
84
+ #### Parameters:
85
+ - Name: `offset` Required: `false`
86
+ - Type: number
87
+ - Description: The index of the first ProcessInstance to include in the result set.
88
+ - Name: `limit` Required: `false`
89
+ - Type: number
90
+ - Description: The maximum number of ProcessInstances to return.
91
+ - Name: `correlationId` Required: `false`
92
+ - Type: Array&lt;string&gt; | string | SearchQuery
93
+ - string: myCorrelationId
94
+ - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
95
+ - object:
96
+ - Description: Filter by the CorrelationId of the ProcessInstances.
97
+ - Name: `processInstanceId` Required: ``
98
+ - Type: Array&lt;string&gt; | string | SearchQuery
99
+ - string: myProcessInstance_12345678
100
+ - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
101
+ - object:
102
+ - Description: Filter by the ID of the ProcessInstances.
103
+ - Name: `processDefinitionId` Required: ``
104
+ - Type: Array&lt;string&gt; | string | SearchQuery
105
+ - string: myProcess_12345678
106
+ - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
107
+ - object:
108
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
109
+ - Name: `processModelId` Required: ``
110
+ - Type: Array&lt;string&gt; | string | SearchQuery
111
+ - string: myProcessModel_12345678
112
+ - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
113
+ - object:
114
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
115
+ - Name: `processModelName` Required: ``
116
+ - Type: Array&lt;string&gt; | string | SearchQuery
117
+ - string: My Process Model
118
+ - Array&lt;string&gt;: My Process Model,My Other Process Model
119
+ - object:
120
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
121
+ - Name: `processModelHash` Required: ``
122
+ - Type: Array&lt;string&gt; | string | SearchQuery
123
+ - string: 12345678
124
+ - Array&lt;string&gt;: 12345678,87654321
125
+ - object:
126
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
127
+ - Name: `ownerId` Required: ``
128
+ - Type: Array&lt;string&gt; | string | SearchQuery
129
+ - string: 12345678
130
+ - Array&lt;string&gt;: 12345678,87654321
131
+ - object:
132
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
133
+ - Name: `state` Required: ``
134
+ - Type: Array&lt;string&gt; | string | SearchQuery
135
+ - string: running
136
+ - Array&lt;string&gt;: running,finished
137
+ - object:
138
+ - Description: Filter by the state of the ProcessInstances.
139
+ - Name: `parentProcessInstanceId` Required: ``
140
+ - Type: Array&lt;string&gt; | string | SearchQuery
141
+ - string: myParentProcessInstance_12345678
142
+ - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
143
+ - object:
144
+ - Description: Filter by the ID of the parent ProcessInstance.
145
+ - Name: `embeddedProcessModelId` Required: ``
146
+ - Type: Array&lt;string&gt; | string | SearchQuery
147
+ - string: myModel1
148
+ - Array&lt;string&gt;: myModel1,myModel2
149
+ - object:
150
+ - Description: Filter by the ID of the embedded process model.
151
+ - Name: `terminatedByUserId` Required: ``
152
+ - Type: Array&lt;string&gt; | string | SearchQuery
153
+ - string: 12345678
154
+ - Array&lt;string&gt;: 12345678,87654321
155
+ - object:
156
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
157
+ - Name: `createdBefore` Required: ``
158
+ - Type: string
159
+ - Description: The maximum created date of the ProcessInstances to include in the results.
160
+ - Name: `createdAt` Required: ``
161
+ - Type: Array&lt;string&gt; | string
162
+ - string: 2021-01-01T00:00:00.000Z
163
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
164
+ - Description: The minimum created date of the ProcessInstances to include in the results.
165
+ - Name: `createdAfter` Required: ``
166
+ - Type: string
167
+ - Description: The minimum created date of the ProcessInstances to include in the results.
168
+ - Name: `updatedBefore` Required: ``
169
+ - Type: string
170
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
171
+ - Name: `updatedAt` Required: ``
172
+ - Type: Array&lt;string&gt; | string
173
+ - string: 2021-01-01T00:00:00.000Z
174
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
175
+ - Description: The exact updated date of the ProcessInstances to include in the results.
176
+ - Name: `updatedAfter` Required: ``
177
+ - Type: string
178
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
179
+ - Name: `finishedBefore` Required: ``
180
+ - Type: string
181
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
182
+ - Name: `finishedAt` Required: ``
183
+ - Type: Array&lt;string&gt; | string
184
+ - string: 2021-01-01T00:00:00.000Z
185
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
186
+ - Description: The exact finished date of the ProcessInstances to include in the results.
187
+ - Name: `finishedAfter` Required: ``
188
+ - Type: string
189
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
190
+ - Name: `triggeredByFlowNodeInstance` Required: ``
191
+ - Type: Array&lt;string&gt; | string | SearchQuery
192
+ - string: myFlowNodeInstance_12345678
193
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
194
+ - object:
195
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
196
+
197
+
77
198
  ### References
78
199
 
79
200
  - [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform
package/usertask-event-listener.js CHANGED
@@ -4,6 +4,19 @@ module.exports = function (RED) {
4
4
  var node = this;
5
5
  node.engine = RED.nodes.getNode(config.engine);
6
6
 
7
+ let subscription;
8
+
9
+ const eventEmitter = node.engine.eventEmitter;
10
+
11
+ eventEmitter.on('engine-client-dispose', () => {
12
+ node.engine.engineClient.userTasks.removeSubscription(subscription, node.engine.identity);
13
+ });
14
+
15
+ eventEmitter.on('engine-client-changed', () => {
16
+ node.log('new engineClient received');
17
+ register();
18
+ });
19
+
7
20
  const register = async () => {
8
21
  let currentIdentity = node.engine.identity;
9
22
 
@@ -14,13 +27,12 @@ module.exports = function (RED) {
14
27
  return;
15
28
  }
16
29
 
17
- let subscription;
18
30
  const query = RED.util.evaluateNodeProperty(config.query, config.query_type, node);
19
31
 
20
32
  function userTaskCallback() {
21
33
  return async (userTaskNotification) => {
22
34
  if (config.usertask != '' && config.usertask != userTaskNotification.flowNodeId) return;
23
-
35
+
24
36
  const newQuery = {
25
37
  flowNodeInstanceId: userTaskNotification.flowNodeInstanceId,
26
38
  ...query,
@@ -84,7 +96,7 @@ module.exports = function (RED) {
84
96
  currentIdentity = identity;
85
97
 
86
98
  subscription = subscribe();
87
- })
99
+ });
88
100
 
89
101
  node.on('close', async () => {
90
102
  if (node.engine && node.engine.engineClient && client) {
package/usertask-input.html CHANGED
@@ -65,6 +65,125 @@ A node which sends a payload to a usertask in the ProcessCube.
65
65
  : force_send_array (Boolean) : Will be used to force the payload to be sent as an array.
66
66
  : multisend (Boolean) : Will be used to send one output of each usertask input.
67
67
 
68
+ ### Query fields
69
+
70
+ **Summary**:
71
+
72
+ **Description**: Filter result for &#39;UserTasks Input&#39;
73
+
74
+ #### Parameters:
75
+ - Name: `offset` Required: `false`
76
+ - Type: number
77
+ - Description: The index of the first ProcessInstance to include in the result set.
78
+ - Name: `limit` Required: `false`
79
+ - Type: number
80
+ - Description: The maximum number of ProcessInstances to return.
81
+ - Name: `correlationId` Required: `false`
82
+ - Type: Array&lt;string&gt; | string | SearchQuery
83
+ - string: myCorrelationId
84
+ - Array&lt;string&gt;: myCorrelationId1,myCorrelationId2
85
+ - object:
86
+ - Description: Filter by the CorrelationId of the ProcessInstances.
87
+ - Name: `processInstanceId` Required: ``
88
+ - Type: Array&lt;string&gt; | string | SearchQuery
89
+ - string: myProcessInstance_12345678
90
+ - Array&lt;string&gt;: myProcessInstance_12345678,myProcessInstance_87654321
91
+ - object:
92
+ - Description: Filter by the ID of the ProcessInstances.
93
+ - Name: `processDefinitionId` Required: ``
94
+ - Type: Array&lt;string&gt; | string | SearchQuery
95
+ - string: myProcess_12345678
96
+ - Array&lt;string&gt;: myProcess_12345678,myProcess_87654321
97
+ - object:
98
+ - Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
99
+ - Name: `processModelId` Required: ``
100
+ - Type: Array&lt;string&gt; | string | SearchQuery
101
+ - string: myProcessModel_12345678
102
+ - Array&lt;string&gt;: myProcessModel_12345678,myProcessModel_87654321
103
+ - object:
104
+ - Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
105
+ - Name: `processModelName` Required: ``
106
+ - Type: Array&lt;string&gt; | string | SearchQuery
107
+ - string: My Process Model
108
+ - Array&lt;string&gt;: My Process Model,My Other Process Model
109
+ - object:
110
+ - Description: Filter by the name of the ProcessModel that the ProcessInstances belong to.
111
+ - Name: `processModelHash` Required: ``
112
+ - Type: Array&lt;string&gt; | string | SearchQuery
113
+ - string: 12345678
114
+ - Array&lt;string&gt;: 12345678,87654321
115
+ - object:
116
+ - Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
117
+ - Name: `ownerId` Required: ``
118
+ - Type: Array&lt;string&gt; | string | SearchQuery
119
+ - string: 12345678
120
+ - Array&lt;string&gt;: 12345678,87654321
121
+ - object:
122
+ - Description: Filter by the ID of the User that owns the ProcessInstances.
123
+ - Name: `state` Required: ``
124
+ - Type: Array&lt;string&gt; | string | SearchQuery
125
+ - string: running
126
+ - Array&lt;string&gt;: running,finished
127
+ - object:
128
+ - Description: Filter by the state of the ProcessInstances.
129
+ - Name: `parentProcessInstanceId` Required: ``
130
+ - Type: Array&lt;string&gt; | string | SearchQuery
131
+ - string: myParentProcessInstance_12345678
132
+ - Array&lt;string&gt;: myParentProcessInstance_12345678,myParentProcessInstance_87654321
133
+ - object:
134
+ - Description: Filter by the ID of the parent ProcessInstance.
135
+ - Name: `embeddedProcessModelId` Required: ``
136
+ - Type: Array&lt;string&gt; | string | SearchQuery
137
+ - string: myModel1
138
+ - Array&lt;string&gt;: myModel1,myModel2
139
+ - object:
140
+ - Description: Filter by the ID of the embedded process model.
141
+ - Name: `terminatedByUserId` Required: ``
142
+ - Type: Array&lt;string&gt; | string | SearchQuery
143
+ - string: 12345678
144
+ - Array&lt;string&gt;: 12345678,87654321
145
+ - object:
146
+ - Description: Filter by the ID of the User that terminated the ProcessInstances.
147
+ - Name: `createdBefore` Required: ``
148
+ - Type: string
149
+ - Description: The maximum created date of the ProcessInstances to include in the results.
150
+ - Name: `createdAt` Required: ``
151
+ - Type: Array&lt;string&gt; | string
152
+ - string: 2021-01-01T00:00:00.000Z
153
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
154
+ - Description: The minimum created date of the ProcessInstances to include in the results.
155
+ - Name: `createdAfter` Required: ``
156
+ - Type: string
157
+ - Description: The minimum created date of the ProcessInstances to include in the results.
158
+ - Name: `updatedBefore` Required: ``
159
+ - Type: string
160
+ - Description: The maximum updated date of the ProcessInstances to include in the results.
161
+ - Name: `updatedAt` Required: ``
162
+ - Type: Array&lt;string&gt; | string
163
+ - string: 2021-01-01T00:00:00.000Z
164
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
165
+ - Description: The exact updated date of the ProcessInstances to include in the results.
166
+ - Name: `updatedAfter` Required: ``
167
+ - Type: string
168
+ - Description: The minimum updated date of the ProcessInstances to include in the results.
169
+ - Name: `finishedBefore` Required: ``
170
+ - Type: string
171
+ - Description: The maximum finished date of the ProcessInstances to include in the results.
172
+ - Name: `finishedAt` Required: ``
173
+ - Type: Array&lt;string&gt; | string
174
+ - string: 2021-01-01T00:00:00.000Z
175
+ - array: 2021-01-01T00:00:00.000Z,2021-01-02T00:00:00.000Z
176
+ - Description: The exact finished date of the ProcessInstances to include in the results.
177
+ - Name: `finishedAfter` Required: ``
178
+ - Type: string
179
+ - Description: The minimum finished date of the ProcessInstances to include in the results.
180
+ - Name: `triggeredByFlowNodeInstance` Required: ``
181
+ - Type: Array&lt;string&gt; | string | SearchQuery
182
+ - string: myFlowNodeInstance_12345678
183
+ - array: myFlowNodeInstance_12345678,myFlowNodeInstance_87654321
184
+ - object:
185
+ - Description: Filter by the ID of the FlowNodeInstance that triggered the ProcessInstance.
186
+
68
187
  ### References
69
188
 
70
189
  - [The ProcessCube&copy; Developer Network](https://processcube.io) - All documentation for the ProcessCube&copy; platform