node-red-contrib-agilite
Version:
Node-RED nodes to integrate with Agilit-e cloud or Agilit-e on-prem
186 lines (179 loc) • 8.89 kB
HTML
<script type='text/javascript'>
var agiliteTierStructuresFunctions = {
updateActionType:function(){
var value = $('#node-input-actionType option:selected').val()
switch(value){
case '1'://getTierByKey
document.querySelector('#rowTierKeys').style.display = 'block'
document.querySelector('#rowIncludeValues').style.display = 'block'
document.querySelector('#rowIncludeMetaData').style.display = 'block'
document.querySelector('#rowIncludeTierEntries').style.display = 'block'
document.querySelector('#rowSortValues').style.display = 'block'
document.querySelector('#rowValuesOutputFormat').style.display = 'block'
break
default:
document.querySelector('#rowTierKeys').style.display = 'none'
document.querySelector('#rowIncludeValues').style.display = 'none'
document.querySelector('#rowIncludeMetaData').style.display = 'none'
document.querySelector('#rowIncludeTierEntries').style.display = 'none'
document.querySelector('#rowSortValues').style.display = 'none'
document.querySelector('#rowValuesOutputFormat').style.display = 'none'
break
}
}
}
RED.nodes.registerType('tier-structures',{
category: 'agilite',
inputs: 1,
outputs:1,
icon: 'tier-structures.png',
color: '#ffa4a2',
label: function () {
return this.name || 'Tier Structures'
},
paletteLabel: 'tier structures',
defaults: {
server: {
value: '',
required: true,
type: 'agilite-login'
},
actionType: {
value: '1',
required : true
},
tierKeys: {
value: '',
required: true
},
includeValues: {
value: true
},
includeMetaData: {
value: false
},
includeTierEntries: {
value: false
},
sortValues: {
value:''
},
valuesOutputFormat: {
value: 'array'
},
name: {
value:''
},
field: {
value: 'payload',
},
fieldType: {
value: 'msg'
},
failFlow: {
value: true
}
},
oneditprepare: function(){
$('#node-input-actionType').change(function(){agiliteTierStructuresFunctions.updateActionType()})
agiliteTierStructuresFunctions.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='tier-structures'>
<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">Get Tier By Key</option>
</select>
</div>
<div class="form-row" id="rowTierKeys">
<label for="node-input-tierKeys"><i class="fa fa-key"></i> Tier Keys {{}}</label>
<input type="text" id="node-input-tierKeys" />
</div>
<div class="form-row" id="rowSortValues">
<label for="node-input-sortValues">Sort Values {{}}</label>
<select id="node-input-sortValues" style="width:auto">
<option value="">-Select-</option>
<option value="asc">Ascending by Label</option>
<option value="desc">Descending by Label</option>
<option value="asc_value">Ascending by Value</option>
<option value="desc_value">Descending by Value</option>
</select>
</div>
<div class="form-row" id="rowValuesOutputFormat">
<label for="node-input-valuesOutputFormat">Values Output Format {{}}</label>
<select id="node-input-valuesOutputFormat" style="width:auto">
<option value="array">Array</option>
<option value="json">JSON</option>
</select>
</div>
<div class="form-row" id="rowIncludeValues">
<label for="node-input-includeValues"><span data-i18n="template.label.property">Include Values</span></label>
<input type="checkbox" id="node-input-includeValues" style="width:initial" /> Yes
</div>
<div class="form-row" id="rowIncludeMetaData">
<label for="node-input-includeMetaData"><span data-i18n="template.label.property">Include Meta Data</span></label>
<input type="checkbox" id="node-input-includeMetaData" style="width:initial" /> Yes
</div>
<div class="form-row" id="rowIncludeTierEntries">
<label for="node-input-includeTierEntries"><span data-i18n="template.label.property">Include Tier Entries</span></label>
<input type="checkbox" id="node-input-includeTierEntries" 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="tier-structures">
<p>A node to fetch Agilit-e Tier Structures 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>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">Get Tier By Key</h4>
<dt>Tier Keys<span class="property-type">string | comma separated</span></dt>
<dd>The unique keys of the Nested Tiers you want to retrieve</dd>
<dd>Example: 'tier,tier1,tier2'</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>
</script>