Use JavaScript expressions to assign values to variables.
\nHIRO contains a full JavaScript engine that can be used to manipulate data.
\n| \n\n | \n\nThe JavaScript interpreter does not support the use of external 3rd party libraries.\n | \n
JavaScript Engine | \nGoogle V8 (Version 7.7.299.13-node.16) | \n
Script Standard | \nECMAScript 2019 | \n
Executed on | \nNode 12 | \n
The JavaScript element allows processing data within a Knowledge Item.\nThe final \"result\" returned by the element will be stored in the Variable specified in the StoreTo field.
If the JavaScript expression returns, for example, a list of filenames it will store this list as a single long value. You can use further\nprocessing of the output to store the results as separate values for each line/each entry in an array or a map of \"Key:Value\" pairs (see examples below).
\nexit: LOCAL::EXIT\nresult: LOCAL::RESULT = javascript(\"<js-script>\")Default timeout for javascript execution is 5 seconds, but can be extended upto 600 seconds by providing the 2nd optional argument:
\nexit: LOCAL::EXIT\nresult: LOCAL::RESULT = javascript(\"<js-script>\", 20)Also named options are supported:
\nexit: LOCAL::EXIT\nresult: LOCAL::RESULT = javascript(timeout: 30, code: \"<js-script>\")If specified timeout is more than 10 minutes, timeout is reset back to default (5 seconds).
\n| Position | \nKeyword | \nRequired | \nDescription | \n
|---|---|---|---|
1 | \n:code | \nX | \nScript to be evaluated | \n
2 | \n:timeout | \n\n | Timeout in seconds (max: 600, default: 5) | \n
| Tag | \nDescription | \n
|---|---|
result | \nResult of the script evaluation | \n
exit | \nNumeric Exit-Code of the operation, 0 = success, 1 = failure | \n
You can use this functionality to write multiple return values as values into a variable by simply splitting your output.
\nFor example: You return a list of filenames as single lines that is stored in the variable \"result\":
\n/opt/myfiles/abc.txt\n/opt/myfiles/def.txt\n/opt/myfiles/hij.txtYou would then split this output using the \"newline separator\" (\\n)\nwith the following JavaScript snippet:
result: LOCAL::OutputVariable = javascript(\"${result}.split('\\n')\")This will split the contents of result after each \"newline\"-character\n(\\n) and save it into separate values of \"OutputVariable\". You would\nthen see something like this in your Issue:
\"/OutputVariable\": [\"/opt/myfiles/abc.txt\", \"/opt/myfiles/def.txt\", \"/opt/myfiles/hij.txt\"]You can use CSV input by using \"${result}\".split(\",\") in your call in\na similar way.
If you require multiple return values, these can be encoded in a simple\nJSON map and afterwards be accessed by the JSON map accessor from a\nVarString:
\nresult: OutputVariable = javascript('\n var result = {};\n result[\"ValueOne\"] = new Date;\n result[\"ValueTwo\"] = \"this is just some string\";\n JSON.stringify(result);\n')This way you end up with a JSON object looking like this:
\n {\"ValueOne\":\"Wed Dec 09 2015 14:11:45 GMT+0100 (CET)\",\"ValueTwo\":\"this is just some string\"}Which you can then freely access by using VarString in the format ${VARIABLE#value_in_object} like in this example ${OutputVariable#ValueOne}.\nPlease note that VarString only allows accessing the object directly,\nif you have a JSON structure that contains lists or other objects as values, you need to parse the structure to be able to easily access all elements.
If you wish to set Values and their respective keys at the same time you need to directly map them. To do so you will use a JavaScript call to\nset a list of \"Key:Value\" pairs which then are stored as separate entries in a variable.
\nHere we store two values with different keys to the variable SampleMap.
result: SampleMap = javascript('\n var result = {};\n result[\"SomeKey\"] = \"SomeValue\"\n result[\"2ndKey\"] = \"OtherValue\"\n result\n')Note that we did not use a JSON.stringify() this time but actually return the map directly. This will create a data structure consisting of the specified variable containing \"Key:Value\" pairs as individual values and will look like this in the Issue:
\n{\n \"/SampleMap\": [\n {\n \"value\": \"SomeValue\",\n \"key\": \"SomeKey\"\n },\n {\n \"value\": \"OtherValue\",\n \"key\": \"2ndKey\"\n }\n ]\n}| \n\n | \n\n\"Escaped characters\" The JavaScript handling for HIRO automatically escapes special characters for Variables.\nThis means JSON data in a variable will be \"invalid\" because of the escaped quotes (\") to use JSON data stored this way you must use ''JSON.parse()''\nto read the Variable and transform it back to \"proper\" JSON.\n | \n
Here we have a simplified version of a Zendesk ticket in JSON (retrieved via API).\nWe want to extract the description and store it in a variable to react further.
\n{\n \"ticket\": {\n \"url\": \"https://itautopilot.zendesk.com/api/v2/tickets/2289.json\",\n \"id\": 2289,\n \"external_id\": null,\n \"via\": {\n \"channel\": \"web\",\n \"source\": {\n \"from\": {},\n \"to\": {},\n \"rel\": null\n }\n },\n \"created_at\": \"2016-01-14T13:19:35Z\",\n \"updated_at\": \"2016-01-14T14:03:34Z\",\n \"type\": null,\n \"subject\": \"Test Ticket - Please ignore and don't close\",\n \"raw_subject\": \"Test Ticket - Please ignore and don't close\",\n \"description\": \"Just testing some stuff.\",\n }\n}We have already retrieved the JSON data and stored it in a variable ZendeskTicketJSON.\nWe then parse the Variable into an object called obj. Then we access the value in the JSON structure.
const obj = JSON.parse('${ZendeskTicketJSON}');\nobj.ticket.descriptionThis will return the value of \"description\" as a string and store it to\nthe specified \"StoreTo\" Variable.
\n| \n\n | \n\n \n \nHIRO uses Javascript ES 2019. Make sure the elements you are trying to use are compatible with this script version. \n | \n