node-red-contrib-agilite
Version:
Node-RED nodes to integrate with Agilit-e cloud or Agilit-e on-prem
642 lines (635 loc) • 37.3 kB
HTML
<script type='text/javascript'>
var agiliteBpmFunctions = {
updateActionType:function(){
var value = $('#node-input-actionType option:selected').val()
switch(value){
case '1'://Register BPM Record
document.querySelector('#rowProfileKey').style.display = 'block'
document.querySelector('#rowCurrentUser').style.display = 'block'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'none'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'block'
document.querySelector('#rowIncludeStepOptions').style.display = 'block'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'block'
document.querySelector('#rowIncludeKeywords').style.display = 'block'
document.querySelector('#rowIncludeData').style.display = 'block'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'block'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
case '2'://Execute
document.querySelector('#rowProfileKey').style.display = 'block'
document.querySelector('#rowCurrentUser').style.display = 'block'
document.querySelector('#rowCurrentStep').style.display = 'block'
document.querySelector('#rowBpmRecordId').style.display = 'block'
document.querySelector('#rowOptionSelected').style.display = 'block'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'block'
document.querySelector('#rowIncludeStepOptions').style.display = 'block'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'block'
document.querySelector('#rowIncludeKeywords').style.display = 'block'
document.querySelector('#rowIncludeData').style.display = 'block'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'block'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
case '3'://Get Record State
document.querySelector('#rowProfileKey').style.display = 'none'
document.querySelector('#rowCurrentUser').style.display = 'none'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'none'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'block'
document.querySelector('#rowResponsibleUsers').style.display = 'block'
document.querySelector('#rowStepNames').style.display = 'block'
document.querySelector('#rowRelevantUsers').style.display = 'block'
document.querySelector('#rowIncludeHistory').style.display = 'block'
document.querySelector('#rowIncludeStepOptions').style.display = 'block'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'block'
document.querySelector('#rowIncludeKeywords').style.display = 'block'
document.querySelector('#rowIncludeData').style.display = 'block'
document.querySelector('#rowProfileKeys').style.display = 'block'
document.querySelector('#rowProfileKeys').style.display = 'block'
document.querySelector('#rowPage').style.display = 'block'
document.querySelector('#rowPageLimit').style.display = 'block'
document.querySelector('#rowSort').style.display = 'block'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'block'
document.querySelector('#rowRelevantRoles').style.display = 'block'
document.querySelector('#rowEventStamps').style.display = 'block'
document.querySelector('#rowEventStartDate').style.display = 'block'
document.querySelector('#rowEventEndDate').style.display = 'block'
break
case '4'://Get By Profile Key
document.querySelector('#rowProfileKey').style.display = 'block'
document.querySelector('#rowCurrentUser').style.display = 'none'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'none'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'none'
document.querySelector('#rowIncludeStepOptions').style.display = 'none'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'none'
document.querySelector('#rowIncludeData').style.display = 'none'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'none'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowIncludeKeywords').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
case '5'://Get Active Steps
document.querySelector('#rowProfileKey').style.display = 'block'
document.querySelector('#rowCurrentUser').style.display = 'none'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'none'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'none'
document.querySelector('#rowIncludeStepOptions').style.display = 'none'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'none'
document.querySelector('#rowIncludeData').style.display = 'none'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'block'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowIncludeKeywords').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
case '6'://Get Active Users
document.querySelector('#rowProfileKey').style.display = 'block'
document.querySelector('#rowCurrentUser').style.display = 'none'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'none'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'none'
document.querySelector('#rowIncludeStepOptions').style.display = 'none'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'none'
document.querySelector('#rowIncludeData').style.display = 'none'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'none'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowIncludeKeywords').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
case '7': // Assign Role
document.querySelector('#rowProfileKey').style.display = 'block'
document.querySelector('#rowCurrentUser').style.display = 'block'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'block'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'block'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'none'
document.querySelector('#rowIncludeStepOptions').style.display = 'none'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'none'
document.querySelector('#rowIncludeData').style.display = 'none'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'block'
document.querySelector('#rowISOLanguage').style.display = 'none'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowIncludeKeywords').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
case '8': // Get Assigned Roles
document.querySelector('#rowProfileKey').style.display = 'block'
document.querySelector('#rowCurrentUser').style.display = 'none'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'block'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'none'
document.querySelector('#rowIncludeStepOptions').style.display = 'none'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'none'
document.querySelector('#rowIncludeData').style.display = 'none'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'block'
document.querySelector('#rowISOLanguage').style.display = 'none'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowIncludeKeywords').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
case '9': // Lock Record
case '10': // Unlock Record
document.querySelector('#rowProfileKey').style.display = 'none'
document.querySelector('#rowCurrentUser').style.display = 'none'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'block'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'none'
document.querySelector('#rowIncludeStepOptions').style.display = 'none'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'none'
document.querySelector('#rowIncludeData').style.display = 'none'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'none'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowIncludeKeywords').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
default:
document.querySelector('#rowProfileKey').style.display = 'none'
document.querySelector('#rowCurrentUser').style.display = 'none'
document.querySelector('#rowCurrentStep').style.display = 'none'
document.querySelector('#rowBpmRecordId').style.display = 'none'
document.querySelector('#rowOptionSelected').style.display = 'none'
document.querySelector('#rowBpmRecordIds').style.display = 'none'
document.querySelector('#rowResponsibleUsers').style.display = 'none'
document.querySelector('#rowStepNames').style.display = 'none'
document.querySelector('#rowRelevantUsers').style.display = 'none'
document.querySelector('#rowIncludeHistory').style.display = 'none'
document.querySelector('#rowIncludeStepOptions').style.display = 'none'
document.querySelector('#rowIncludeVisibleObjects').style.display = 'none'
document.querySelector('#rowIncludeData').style.display = 'none'
document.querySelector('#rowProfileKeys').style.display = 'none'
document.querySelector('#rowPage').style.display = 'none'
document.querySelector('#rowPageLimit').style.display = 'none'
document.querySelector('#rowSort').style.display = 'none'
document.querySelector('#rowRoleNames').style.display = 'none'
document.querySelector('#rowISOLanguage').style.display = 'none'
document.querySelector('#rowRelevantRoles').style.display = 'none'
document.querySelector('#rowEventStamps').style.display = 'none'
document.querySelector('#rowIncludeKeywords').style.display = 'none'
document.querySelector('#rowEventStartDate').style.display = 'none'
document.querySelector('#rowEventEndDate').style.display = 'none'
break
}
}
}
RED.nodes.registerType('bpm', {
category: 'agilite',
inputs: 1,
outputs:1,
icon: 'bpm.png',
color: '#ffa4a2',
label: function () {
return this.name || 'BPM'
},
paletteLabel : 'bpm',
defaults : {
server: {
value : '',
required: true,
type: 'agilite-login'
},
actionType: {
value : '',
required : true
},
profileKey: {
value : ''
},
currentUser: {
value : ''
},
currentStep: {
value: ''
},
bpmRecordId: {
value : ''
},
optionSelected: {
value : ''
},
bpmRecordIds: {
value : ''
},
responsibleUsers: {
value : ''
},
stepNames: {
value:''
},
roleNames: {
value:''
},
relevantUsers: {
value:''
},
includeHistory: {
value: true
},
includeStepOptions: {
value: true
},
includeVisibleObjects: {
value: true
},
includeData: {
value: true
},
profileKeys: {
value:''
},
isoLanguage: {
value:''
},
page: {
value:''
},
pageLimit: {
value:''
},
sort: {
value:''
},
name: {
value:''
},
relevantRoles: {
value:''
},
eventStamps: {
value:''
},
includeKeywords: {
value:true
},
eventStartDate: {
value:''
},
eventEndDate: {
value:''
},
field: {
value: 'payload',
},
fieldType: {
value: 'msg'
},
failFlow: {
value: true
}
},
oneditprepare: function (){
$('#node-input-actionType').change(function(){agiliteBpmFunctions.updateActionType()})
agiliteBpmFunctions.updateActionType()
if (!this.fieldType) this.fieldType = 'msg'
$('#node-input-field').typedInput({
default: 'msg',
types: ['msg','flow','global'],
typeField: $('#node-input-fieldType')
})
}
})
</script>
<script type='text/x-red' data-template-name='bpm'>
<div class="form-row">
<label for="node-input-server"><i class="fa fa-server"></i> Server</label>
<input type="text" id="node-input-server" placeholder="Server"></input>
</div>
<div class="form-row" id="rowActionType">
<label for="node-input-actionType"><i class="fa fa-arrow-circle-right"></i> Action Type</label>
<select id="node-input-actionType" style="width:auto;">
<option value="1">Register BPM Record</option>
<option value="2">Execute</option>
<option value="3">Get Record State</option>
<option value="4">Get By Profile Key</option>
<option value="5">Get Active Steps</option>
<option value="6">Get Active Users</option>
<option value="7">Assign Role</option>
<option value="8">Get Assigned Roles</option>
</select>
</div>
<div class="form-row" id="rowProfileKey">
<label for="node-input-profileKey"><i class="fa fa-key"></i> Profile Key {{}}</label>
<input type="text" id="node-input-profileKey" />
</div>
<div class="form-row" id="rowCurrentUser">
<label for="node-input-currentUser"><i class="fa fa-user"></i> Current User {{}}</label>
<input type="text" id="node-input-currentUser" />
</div>
<div class="form-row" id="rowCurrentStep">
<label for="node-input-currentStep"> Current Step {{}}</label>
<input type="text" id="node-input-currentStep" />
</div>
<div class="form-row" id="rowBpmRecordId">
<label for="node-input-bpmRecordId"><i class="fa fa-edit"></i> BPM Record Id {{}}</label>
<input type="text" id="node-input-bpmRecordId" />
</div>
<div class="form-row" id="rowOptionSelected">
<label for="node-input-optionSelected">Option Selected {{}}</label>
<input type="text" id="node-input-optionSelected" />
</div>
<div class="form-row" id="rowBpmRecordIds">
<label for="node-input-bpmRecordIds"><i class="fa fa-edit"></i> BPM Record Ids {{}}</label>
<input type="text" id="node-input-bpmRecordIds" />
</div>
<div class="form-row" id="rowResponsibleUsers">
<label for="node-input-responsibleUsers"><i class="fa fa-user"></i> Responsible Users {{}}</label>
<input type="text" id="node-input-responsibleUsers" />
</div>
<div class="form-row" id="rowStepNames">
<label for="node-input-stepNames"><i class="fa fa-edit"></i> Step Names {{}}</label>
<input type="text" id="node-input-stepNames" />
</div>
<div class="form-row" id="rowRoleNames">
<label for="node-input-roleNames"><i class="fa fa-edit"></i> Role Name(s) {{}}</label>
<input type="text" id="node-input-roleNames" />
</div>
<div class="form-row" id="rowRelevantUsers">
<label for="node-input-relevantUsers"><i class="fa fa-user"></i> Relevant Users {{}}</label>
<input type="text" id="node-input-relevantUsers" />
</div>
<div class="form-row" id="rowProfileKeys">
<label for="node-input-profileKeys"><i class="fa fa-key"></i> Profile Keys {{}}</label>
<input type="text" id="node-input-profileKeys" />
</div>
<div class="form-row" id="rowRelevantRoles">
<label for="node-input-relevantRoles"> Relevant Roles {{}}</label>
<input type="text" id="node-input-relevantRoles" />
</div>
<div class="form-row" id="rowEventStamps">
<label for="node-input-eventStamps"> Event Stamps {{}}</label>
<input type="text" id="node-input-eventStamps" />
</div>
<div class="form-row" id="rowEventStartDate">
<label for="node-input-eventStartDate"> Event Start Date {{}}</label>
<input type="text" id="node-input-eventStartDate" />
</div>
<div class="form-row" id="rowEventEndDate">
<label for="node-input-eventEndDate"> Event End Date {{}}</label>
<input type="text" id="node-input-eventEndDate" />
</div>
<div class="form-row" id="rowISOLanguage">
<label for="node-input-isoLanguage">ISO Language {{}}</label>
<input type="text" id="node-input-isoLanguage" />
</div>
<div class="form-row" id="rowPage">
<label for="node-input-page"><i class="fa fa-key"></i> Page {{}}</label>
<input type="text" id="node-input-page" />
</div>
<div class="form-row" id="rowPageLimit">
<label for="node-input-pageLimit"><i class="fa fa-key"></i> Page Limit {{}}</label>
<input type="text" id="node-input-pageLimit" />
</div>
<div class="form-row" id="rowSort">
<label for="node-input-sort"><i class="fa fa-key"></i> Sort By {{}}</label>
<input type="text" id="node-input-sort" placeholder='e.g. "-createdAt" or "createdAt"' />
</div>
<div class="form-row" id="rowIncludeHistory">
<label for="node-input-includeHistory"><span data-i18n="template.label.property">Include History</span></label>
<input type="checkbox" id="node-input-includeHistory" style="width:initial;" /> Yes
</div>
<div class="form-row" id="rowIncludeStepOptions">
<label for="node-input-includeStepOptions"><span data-i18n="template.label.property">Include Step Options</span></label>
<input type="checkbox" id="node-input-includeStepOptions" style="width:initial;" /> Yes
</div>
<div class="form-row" id="rowIncludeVisibleObjects">
<label for="node-input-includeVisibleObjects"><span data-i18n="template.label.property">Include Visible Objects</span></label>
<input type="checkbox" id="node-input-includeVisibleObjects" style="width:initial;" /> Yes
</div>
<div class="form-row" id="rowIncludeKeywords">
<label for="node-input-includeKeywords"><span data-i18n="template.label.property">Include Keywords</span></label>
<input type="checkbox" id="node-input-includeKeywords" style="width:initial;" /> Yes
</div>
<div class="form-row" id="rowIncludeData">
<label for="node-input-includeData"><span data-i18n="template.label.property">Include Data</span></label>
<input type="checkbox" id="node-input-includeData" style="width:initial;" /> Yes
</div>
<div class="form-row">
<label for="node-input-field"><i class="fa fa-edit"></i> <span data-i18n="template.label.property">Output to</span></label>
<input type="text" id="node-input-field" placeholder="payload" style="width:250px;">
<input type="hidden" id="node-input-fieldType">
</div>
<div class="form-row">
<label for="node-input-failFlow"><i class="fa fa-exclamation-triangle"></i> <span data-i18n="template.label.property">Fail Flow on Error</span></label>
<input type="checkbox" id="node-input-failFlow" style="width:initial;" /> Yes
</div>
<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="Node Name" />
</div>
</script>
<script type='text/x-red' data-help-name='bpm'>
<p>A node to fetch and execute Agilit-e Business Processes based on various conditions</p>
<h3>Inputs</h3>
<h4>General</h4>
<dl class="message-properties">
<dt>Server (required)<span class="property-type">Configuration Node</span></dt>
<dd>The server configuration to connect to the relevant Agilit-e API Server. This is achieved by providing the API Server URL (required) and an API Key (optional). <b>NOTE:</b> If providing an API Key, be sure to click on the "Authenticate" button, to have Node-RED authenticate the API Key before the Server configuration is used by Nodes.</dd>
<dt>Include History<span class="property-type">Option</span></dt>
<dd>Include the History of the Process in the response</dd>
<dt>Include Step Options<span class="property-type">Option</span></dt>
<dd>Include the Step Options of the Process in the response</dd>
<dt>Include Visible Objects<span class="property-type">Option</span></dt>
<dd>Include the Visible Objects of the Process in the response</dd>
<dt>Include Keywords<span class="property-type">Option</span></dt>
<dd>Include the Keywords of the Process in the response</dd>
<dt>msg.payload<span class="property-type">object</span></dt>
<dd>Optional data to be passed to Agilit-e for Handlebars evaluations in the relevant module's Profile.</dd>
<br />
<p style="margin: 0 5px 0 5px"><b>NOTE:</b> Values can be provided manually in the Input Fields in this Node's UI Form, or programmatically using <a href="https://handlebarsjs.com/" target="_blank">Handlebars</a>, where the Input Field's Label includes <code>{{}}</code>. Labels with <code>{{}}</code> are <b>Handlebars-enabled</b> and evaluate prop values relative to the <code>msg</code> object (e.g. <code>{{profileKey}}</code> = <code>msg.profileKey</code>). A final note: The difference between using 2 curly braces vs 3, is that values evaluated using 2 curly braces are first encoded/escaped before evaluated, whereas values using 3 curly braces are not. It is usually safer to use 3 curly braces, but in most cases 2 will work fine.</p>
</dl>
<h3>Action Types</h3>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Register BPM Record</h4>
<dt>Profile Key<span class="property-type">string</span></dt>
<dd>The unique <b>key</b> of the BPM Profile to be used to register.</dd>
<dt>Current User<span class="property-type">string</span></dt>
<dd>The user registering the BPM Record.</dd>
<dt>ISO Langauge<span class="property-type">string</span></dt>
<dd>The ISO Language to Register the BPM Record with. (default: en)</dd>
</dl>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Execute</h4>
<dt>Profile Key<span class="property-type">string</span></dt>
<dd>The unique <b>key</b> of the BPM Profile to be used to register.</dd>
<dt>Current User<span class="property-type">string</span></dt>
<dd>The user registering the BPM Record.</dd>
<dt>Current Step<span class="property-type">string</span></dt>
<dd>The Current Step of the BPM Record that is being executed</dd>
<dt>BPM Record Id<span class="property-type">string</span></dt>
<dd>The <b>recordId</b> of the Registered BPM Record.</dd>
<dt>Option Selected<span class="property-type">string</span></dt>
<dd>The relevant BPM Process Step's Option key/name.</dd>
<dt>ISO Langauge<span class="property-type">string</span></dt>
<dd>The ISO Language to Register the BPM Record with. (default: en)</dd>
</dl>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Get Record State</h4>
<dt>BPM Record Ids<span class="property-type">string | comma separated</span></dt>
<dd>The BPM Record Ids of the BPM Records you want to return the current state for.</dd>
<dt>Responsible Users<span class="property-type">string | comma separated</span></dt>
<dd>Users Responsible for the BPM Record.</dd>
<dt>Step Names<span class="property-type">string | comma separated</span></dt>
<dd>The Step Names included in the BPM Record</dd>
<dt>Relevant Users<span class="property-type">string | comma separated</span></dt>
<dd>Users that are relevant to the BPM Record</dd>
<dt>Profile Keys<span class="property-type">string | comma separated</span></dt>
<dd>The BPM Profile Key(s) that the BPM Record is related to</dd>
<dt>Relevant Roles<span class="property-type">string | comma separated</span></dt>
<dd>Roles that are relevant to the BPM Record</dd>
<dt>Event Stamps<span class="property-type">string | comma separated</span></dt>
<dd>Event Stamps that are included in the BPM Record</dd>
<dt>Event Start Date<span class="property-type">string</span></dt>
<dd>When the event started</dd>
<dt>Event End Date<span class="property-type">string</span></dt>
<dd>When the event ended</dd>
<dt>ISO Langauge<span class="property-type">string</span></dt>
<dd>The ISO Language to Register the BPM Record with. (default: en)</dd>
</dl>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Get By Profile Key</h4>
<dt>Profile Key<span class="property-type">string</span></dt>
<dd>The unique <b>key</b> of the BPM Profile you want to return.</dd>
</dl>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Get Active Steps</h4>
<dt>Profile Key<span class="property-type">string</span></dt>
<dd>The unique <b>key</b> of the BPM Profile you want to return the active steps for.</dd>
<dt>ISO Langauge<span class="property-type">string</span></dt>
<dd>The ISO Language to return the Active Steps with. (default: en)</dd>
</dl>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Get Active Users</h4>
<dt>Profile Key<span class="property-type">string</span></dt>
<dd>The unique <b>key</b> of the BPM Profile you want to return the active users for.</dd>
</dl>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Assign Role</h4>
<dt>Profile Key<span class="property-type">string</span></dt>
<dd>The unique <b>key</b> of the BPM Profile you want to assign a role to.</dd>
<dt>BPM Record Id<span class="property-type">string</span></dt>
<dd>The BPM Record's Id that you want to assign a role to</dd>
<dt>Responsible Users<span class="property-type">string | comma separated</span></dt>
<dd>The Responsible Users of the BPM Record that you want to assign a role to</dd>
<dt>Role Name(s)<span class="property-type">string | comma separated</span></dt>
<dd>The Role Names of the BPM Record that you want to assign a role to</dd>
</dl>
<dl class="message-properties">
<h3 style="margin: 5px 5px 5px 5px">Get Assigned Roles</h4>
<dt>Profile Key<span class="property-type">string</span></dt>
<dd>The unique <b>key</b> of the BPM Profile you want to return the assigned roles for.</dd>
<dt>BPM Record Id<span class="property-type">string</span></dt>
<dd>The BPM Record's Id that you want to get the assigned roles for.</dd>
<dt>Role Name(s)<span class="property-type">string | comma separated</span></dt>
<dd>The Role Names of the BPM Record that you want to get the assigned roles for.</dd>
</dl>
<h3>Outputs</h3>
<dl class="message-properties">
<p style="margin: 0 5px 0 5px">By default, this Node will output the result to <code>msg.payload</code>. This can be changed in the Node UI Form's <b>Output To</b> Field</p>
</dl>
<h3>Additional Properties</h3>
<dl class="message-properties">
<p style="margin: 0 5px 0 5px">By default, if an error occurs, this Node will fail and stop the flow from continuing. This can be switched off in the Node UI Form's <b>Fail Flow on Error</b> Field. This allows one to manually manage the error by referencing the <code>msg.agilite.succcess</code> and <code>msg.agilite.errorMessage</code> prop values.</p>
<br />
<p style="margin: 0 5px 0 5px">The following properties can be set in the <code>msg.agilite</code> object:</p>
<dt>logProfileKey <span class="property-type">string</span></dt>
<dd>The unique <b>key</b> to the Batch Logging Profile used for custom logging.</dd>
<dt>apiKey <span class="property-type">string</span></dt>
<dd>The Agilit-e API Key used to authenticate the Agilit-e transaction. This is not required if you've set up a Configuration Node that already has an API Key which has been authenticated.</dd>
</dl>
</script>