Methods

Methods

Functions Page

The “Functions” page contains a collection of created functions that exist in the application. This collection of functions is a combination of provided functions, which tend to be commonly used, and customized functions which can be created by a user.

Functions are units of logic that perform a certain task. By creating functions that contain logic, this allows those functions to be used in the application in multiple places, without recreating the logic by hand. For example, if in a workflow there is a step containing logic to calculate shipping, a function to calculate shipping can be used.This way the same function with the same logic can be used across the entire application in different workflows while staying consistent.  

More information regarding functions and writing logic can be found in our Business Process User Guide.

At the top right corner of the page a “+” button exists which allows the user to create their own function.

Above the list of functions, the “Functions” page contains a series of filter options including filtering by search text, category, and subcategory. There are “Search” and “Reset” buttons to aid in the filtering process.

Below the filters, a table lists all functions by displaying the “Function Name/Description”, “Usage”, and three action buttons: “More Info”, “Add to Canvas” and “Try It”.

Functions page

More Info

“More Info” icon as seen on the “Functions” page

The “More Info” icon found on the “Functions” page will forward the user to a page containing more details regarding the function.

The “More Info” page for the “AddressBookExists” functions

The “More Info” page displays a basic description of the functionality, the input and the output of the function. This is followed by a “Usages” section which explains how the function is used and demonstrates what the input and output will look like when the function is run.

The top of the page also contains three action icons and a link to return to the “Functions” page.


The “Add To Canvas” icon will allow the user to add the current function to a logic canvas.

The “Logic Designer” icon will open up the logic canvas for the function. The user will only be able to make edits on this logic canvas if they have the function checked out.

The “Try It” icon will open the “Try A Function” window to test the function before adding it into any of their own logic.

Try It Feature

The “Try It” icon as seen on the “Functions” page

When the “Try It” icon is selected a “Try A Function” window is opened. The “Try A Function” window provides an opportunity for the  user to see how the function works before integrating it into their own logic.

“Try A Function” window


The “Try A Function” window has an “Example” dropdown where the example the user would like to try is selected. The window then lists a simple description of the function and a section where the user can manually enter an input and see what output results. The “Play” button will run the example and the “Refresh” button will reset it. Below the input and output, the logic canvas and the logs for the function are both displayed.

Add A Function

The “+” button at the top of the “Functions” page will open an “Add A Function” window to create a custom function.

“Add A Function” window

The “Add A Function” window has fields to hold the Name, Description, and Usage notes for the function. There is a checkbox to mark whether this function will loop and also a place to add Function Input and Output.

There are then two dropdowns to select the Category and Subcategory the function belongs to. There is also a checkbox to create this new function in “Placeholder Mode”.

Placeholder Mode

“Placeholder Mode” is a feature that allows a business user to create a function themself without needing the knowledge to build the logic on their own. A business user can create a “Placeholder” function which can have the name and description of how the function will work, and can have manual input and output values configured. This way the function can be used by the business user until an IT or tech user can build the function logic.