Macros are used to return data from the system in various formats, to test for conditions, map data from Admin Portal or bulk loader input to various elements in the system (in conjunction with configuration ltemplates) and to access data in workflow steps.

Note

You can view existing macros and add new macros via the Macros page. For details on creating macros, see the Advanced Configuration Guide.

Various macro functions are available. These serve as boolean operators or can be used to carry out various numeric functions, string manipulation functions, list functions, time functions, and hierarchy related functions.

Note

The following macro functions are only available to administrators with an Access Profile set to Full Access:

fn.request_get
fn.perform_http_get

Macros can be created for re-use, named and stored as an instance of the Macro data model. When re-used, the reference prefix syntax is of the format: macro.<macroname>.

Macros can be used to reference or access values in other models, to evaluate conditions and to execute macro functions. Commonly, macros generate values based on conditions and values elsewhere in the system. The Macro language includes functionality to call macro functions and access values in other models. When they are written or included in Configuration Templates of workflows, user input when calling the model instances can be referenced. Values in other models in the system can also be referenced and results based on the evaluation of conditions can be returned.

Model Details: data/Macro

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title	Description	Details
Name *	The name that is given to the Macro.	Field Name: name Type: String
Description	Description of the Macro.	Field Name: description Type: String
Macro *	The Macro content written in the syntax of the Macro language.	Field Name: macro Type: String

Model: data/Macro

Macros

Model Details: data/Macro