A Macro allows PhixFlow to define and retain functions (macros) can be called repeatedly.
For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. For a full list of all the PhixFlow property tabs and windows, see Property Tabs.
| Field | Description |
|---|---|
| Name | The name of the macro. This name is also how the macro will be invoked (called) from elsewhere in PhixFlow |
| Minimum Parameters | The minumum number of parameters that must be passed to the macro when it is invoked. |
| Maximum Parameters | The maximum number of parameters that may be passed to the macro when it is invoked. |
| Expression | |
| Expression | The script that evaluates to a value based on the input parameters. |
| Description | |
| Description | Optional: a description of the macro. |
Example
This sample macro is called padCost. It takes 1 parameter - a numeric value. It checks to see if the numeric value is missing a 0 before a decimal point. If so, it adds the 0 and returns the string. It can be called anywhere in phixflow that an expression can be entered (for example) with :
padCost(".977")
do(
$val = $args[1],
if( startsWith($val, "."),
// if the cost is positive, add a zero onto the beginning
"0" + $val,
// ELSE
if( startsWith($val, "-."),
//if the cost is negative, replace the -. with a -0.
"-0." + substring($val,3),
//ELSE
$val
)
)
)
Macros