This allows the user to specify a user defined function that can be called from a Function Workflow Action. It allows the user to define a group of Workflow actions that may occur in a Workflow many times once. Define the Event, setup the input and output variables that will be required, and set up the name. Then call this function from the same or other workflows. In order for the Custom Function to be viewable inside the Function->Workflow the Workflow must be saved. Then the user can continue to edit and use the function.

 

Also, if a Custom Function is defined as being only useable within a Workflow it is possible to provide an alternative implementation of a global function, even one provided with the system, but in order to do that, the CustomFunctionWorkflowEvent must be created with both a matching function name and also matching input and output names as well. In other words, the names of the inputs and outputs are seen as an integral part of the function-matching system.

Event Properties

As well as the standard properties that can be set on all events, the following properties can be set on this type of event:

 

Property

Description

Function name

The name the function should have. This must be set, and it must be unique.

Display Category

When you create a Function Workflow Action, you can find functions in a drop-down where functions are grouped by category. The "Display Category" is your chance to customise the category used when your custom function is added to this drop-down

Hide From Other Workflows

Indicates whether the custom function should be hidden from other workflows, so it's only usable from within the workflow that defines it. Alternatively, it can be used from any workflow.

Inputs

These are the values that you require when your custom function is called. There is no concept of optional inputs - they must all be provided. You can define them to be of any type, and provide a name for them.

Outputs

These are the values that you will set up as outputs generated by the custom function. As for inputs, you specify their name and type. Anybody calling your function will then be able to access those outputs.

 

Properties Available for Child Actions To Use

The following properties are available for use in any child or descendant action:

 

Properties

Notes

inputs

A biskit whose properties represent all the inputs defined to exist on the custom function event.

outputs

A biskit whose properties represent all the outputs defined to exist on the custom function event.