@5minds/node-red-contrib-processcube
Version:
Node-RED nodes for ProcessCube
204 lines (189 loc) • 8.85 kB
HTML
<script type="text/javascript">
RED.nodes.registerType('usertask-event-listener', {
category: 'ProcessCube Events',
color: '#02AFD6',
defaults: {
name: { value: '' },
engine: { value: '', type: 'processcube-engine-config' },
usertask: { value: '', required: false },
eventtype: { value: '', required: true },
query: { value: '{}' },
query_type: { value: 'json' },
},
inputs: 0,
outputs: 1,
icon: 'usertask_event_listener.svg',
label: function () {
return this.name || (this.eventtype ? `usertask: ${this.eventtype}` : 'usertask-event-listener');
},
oneditprepare: function () {
$('#node-input-query').typedInput({
default: 'json',
types: ['json'],
});
$('#node-input-query').typedInput('value', this.query);
$('#node-input-query').typedInput('type', this.query_type);
},
oneditsave: function () {
if ($('#node-input-query').typedInput('value') == '') {
$('#node-input-query').typedInput('value', '{}')
}
(this.query = $('#node-input-query').typedInput('value')),
(this.query_type = $('#node-input-query').typedInput('type'));
},
});
</script>
<script type="text/html" data-template-name="usertask-event-listener">
<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-usertask"><i class="fa fa-tag"></i> Usertask</label>
<input type="text" id="node-input-usertask" placeholder="ID of Usertask" />
</div>
<div class="form-row">
<label for="node-input-eventtype"><i class="fa fa-sliders"></i> Event</label>
<select id="node-input-eventtype" style="width: 70%;">
<option value="new">new</option>
<option value="finished">finished</option>
<option value="reserved">reserved</option>
<option value="reservation-canceled">reservation-canceled</option>
</select>
</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="usertask-event-listener">
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.
### Query fields
**Summary**:
**Description**: Filter result for 'UserTask Event Listener'
#### 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<string> | string | SearchQuery
- string: myCorrelationId
- Array<string>: myCorrelationId1,myCorrelationId2
- object:
- Description: Filter by the CorrelationId of the ProcessInstances.
- Name: `processInstanceId` Required: ``
- Type: Array<string> | string | SearchQuery
- string: myProcessInstance_12345678
- Array<string>: myProcessInstance_12345678,myProcessInstance_87654321
- object:
- Description: Filter by the ID of the ProcessInstances.
- Name: `processDefinitionId` Required: ``
- Type: Array<string> | string | SearchQuery
- string: myProcess_12345678
- Array<string>: myProcess_12345678,myProcess_87654321
- object:
- Description: Filter by the ID of the ProcessDefinition that the ProcessInstances belong to.
- Name: `processModelId` Required: ``
- Type: Array<string> | string | SearchQuery
- string: myProcessModel_12345678
- Array<string>: myProcessModel_12345678,myProcessModel_87654321
- object:
- Description: Filter by the ID of the ProcessModel that the ProcessInstances belong to.
- Name: `processModelName` Required: ``
- Type: Array<string> | string | SearchQuery
- string: My Process Model
- Array<string>: 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<string> | string | SearchQuery
- string: 12345678
- Array<string>: 12345678,87654321
- object:
- Description: Filter by the hash of the ProcessModel that the ProcessInstances belong to.
- Name: `ownerId` Required: ``
- Type: Array<string> | string | SearchQuery
- string: 12345678
- Array<string>: 12345678,87654321
- object:
- Description: Filter by the ID of the User that owns the ProcessInstances.
- Name: `state` Required: ``
- Type: Array<string> | string | SearchQuery
- string: running
- Array<string>: running,finished
- object:
- Description: Filter by the state of the ProcessInstances.
- Name: `parentProcessInstanceId` Required: ``
- Type: Array<string> | string | SearchQuery
- string: myParentProcessInstance_12345678
- Array<string>: myParentProcessInstance_12345678,myParentProcessInstance_87654321
- object:
- Description: Filter by the ID of the parent ProcessInstance.
- Name: `embeddedProcessModelId` Required: ``
- Type: Array<string> | string | SearchQuery
- string: myModel1
- Array<string>: myModel1,myModel2
- object:
- Description: Filter by the ID of the embedded process model.
- Name: `terminatedByUserId` Required: ``
- Type: Array<string> | string | SearchQuery
- string: 12345678
- Array<string>: 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<string> | 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<string> | 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<string> | 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<string> | 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© Developer Network](https://processcube.io) - All documentation for the ProcessCube© platform
- [ProcessCube© LowCode Integration](https://processcube.io/docs/node-red) - LowCode integration in ProcessCube©
</script>