Documentation
Table of Contents
1 Macro functions
Overview
Macro functions offer the ability to customize macro values.
Sometimes a macro may resolve to a value that is not necessarily easy to work with. It may be long or contain a specific substring of interest that you would like to extract. This is where macro functions can be useful.
The syntax of a macro function is:
where:
- <macro> - the macro to customize (for example {ITEM.VALUE})
- <func> - the function to apply
- <params> - a comma-delimited list of function parameters. Parameters must be quoted if they start with '' '' (space),
"or contain),,.
For example:
Supported macro functions
| FUNCTION | ||||
|---|---|---|---|---|
| Description | Parameters | Supported for | ||
| regsub (<pattern>,<output>) | ||||
| Substring extraction by a regular expression match (case sensitive). | pattern - the regular expression to match output - the output options. \1 - \9 placeholders are supported to capture groups. \0 returns the matched text. If pattern is not a correct regular expression 'UNKNOWN' is returned. |
{ITEM.VALUE} {ITEM.LASTVALUE} |
||
| iregsub (<pattern>,<output>) | ||||
| Substring extraction by a regular expression match (case insensitive). | pattern - the regular expression to match output - the output options. \1 - \9 placeholders are supported to capture groups. \0 returns the matched text. If pattern is not a correct regular expression 'UNKNOWN' is returned. |
{ITEM.VALUE} {ITEM.LASTVALUE} |
||
If a function is used in a supported location, but applied to a macro not supporting macro functions, then the macro evaluates to 'UNKNOWN'.
If a macro function is applied to the macro in locations not supporting macro functions then the function is ignored.
Examples
The ways in which macro functions can be used to customize macro values is illustrated in the following examples containing log lines as received value:
| Received value | Macro | Output |
|---|---|---|
123Log line |
{{ITEM.VALUE}.regsub(^[0-9]+, Problem)} |
Problem |
123 Log line |
{{ITEM.VALUE}.regsub("^([0-9]+)", "Problem")} |
Problem |
123 Log line |
{{ITEM.VALUE}.regsub("^([0-9]+)", Problem ID: \1)} |
Problem ID: 123 |
Log line |
{{ITEM.VALUE}.regsub(".*", "Problem ID: \1")} |
''Problem ID: '' |
MySQL crashed errno 123 |
{{ITEM.VALUE}.regsub("^([A-Z]+).*([0-9]+)", " Problem ID: \1_\2 ")} |
'' Problem ID: MySQL_123 '' |
123 Log line |
{{ITEM.VALUE}.regsub("([1-9]+", "Problem ID: \1")} |
*UNKNOWN* (invalid regular expression) |