Scripted Variables
Using Scripted Variables in JavaScript:
Scripted Variables let you run scripts to create custom variables for your web actions. These variables can be used anywhere in your setup, like in URLs or post bodies, with the Mustache format {{ variable-name }}
.
How to Create a JavaScript Variable:
Navigate to the Variables tab.
Switch to 'Javascript Variables'.
Click "Add".
Name your variable in the "MyVar" field.
Enter your JavaScript code in the "Script" field.
Important Points about the Script:
The script should always return a value.
This returned value is what gets saved as the variable. You can use it in your setup with Mustache syntax. Example: {{ MyVar }}
Built-in Variables and Functions for Your Script:
response: The raw text response from the previous action.
jsonResponse(): Converts the 'response' into a JSON object.
context: Basic details of the action like its name, URL, method, headers, payload or any full scope variable, etc. Use dot notation to access the variable.
jsonContext : JSON representation of the context
path(anyObject, jsonpath): Fetches specific parts of a JSON object.
getIssue(): Retrieves the issue in JSON format. If there's no issue, it returns null.
domParser: an implementation of https://www.npmjs.com/package/xmldom
Example:
The action is a child action to another action. Let's say the child receives the following input data:
{
“name”: “Donald Duck”,
“email”: “donald@cartoonducks.com”
}
To create a scripted variable that transform the name
property to lowercase, the code would be:
return jsonContext.payload.name.toLowerCase();