Javascript Functions
While many API automation tasks can be completed by invoking endpoints and passing identifiers from one service to another, many tasks require some data processing to correctly accomplish their goals. To assist in this ACP offers the ability to include user-written Javascript functions to handle these data manipulation tasks.
The Javascript Functions Management screen can be accessed from the left-hand menu by clicking on the pages icon, below User Management and above Generic Connectors.
The Javascript Functions Management screen contains a listing of all the Javascript Functions currently known by the system. When Workflows are exported, all used Javascript Functions are packaged in the Export bundle. When Workflows are imported, these packaged Functions are automatically included in the listing of Javascript Functions.
Each Javascript Function has a name, an optional category, and a description. The Management screen contains fields to search for a given Function by name and to filter the results by category. Click on an existing Function name to edit the Function.
New Javascript Functions can be defined by hitting the ‘Add Function’ button at the top of the screen.
This opens up a short window where you can give a name to the new function, provide a description, assign it a category, and provide the code.
All Javascript Functions take the following form:
return function() {
return "Hello World;"
}
Additional Function Information:
- Each Function can accept an unlimited number of arguments and produces exactly one return value.
- Each Function can be of unlimited length and contain whatever logic is required to accomplish the Function’s goals.
- All internal Javascript-native features are available, but no extensions or libraries.
- Javascript Functions are used wherever a variable is required in an ACP Workflow. They can be used to transform Required or Optional Input data, or in Conditions & Routing blocks, or anywhere else a variable type box is displayed.
To use a particular Javascript Function, open the variable type drop-down and pick ‘function.’ Click the ‘select function’ box to bring up the Function Picker.
The Function Picker allows you to filter the list of known Functions by name and category. Choose a function by clicking on it from the Function Listing on the left.
Once you have selected a Function the next step is to supply it with inputs. Click the “add argument” button to add the correct number of inputs for this Function. These arguments will be passed to the Function in-order from top to bottom when the Function is executed. Each argument comes with its own variable type picker and can consist of user-given data, workflow links, or default values.
Save the configuration by clicking the ‘add’ button at the bottom of the screen.
This variable will be now be populated with the results of the function whenever this step is run.
Additional Information
Continue on to additional User Guide pages for detailed information on working in ACP: