Macro Functions

Parameter values that must be specified are marked with an *. However, this is limited to parameters for which an explicit check is performed internally in the program, and which trigger a processing error if a value is missing.

For many parameters, a missing value is technically permissible. The macro in question nevertheless returns a valid value. For example, a macro that is supposed to search for a string in a text will return "FALSE" in a technically correct manner, even if the parameter for the search string is not specified or has an empty value.

Parameters that support the use of an encrypted value or partial value in the syntax <§>… </§> are marked with a (§).

Default values for optional parameters are given in the description text. However, this does not apply to those types of parameters that are not mandatory from a technical point of view but should always be specified from a business point of view. Depending on the data type, such parameters will implicitly receive the following default values if they are missing:

If a parameter list is not specified for a macro function, that function will have no parameter, nor will it require further parameterization.

As a rule, macros are executed in the context of processing a concrete document. Macros that access properties or file attachments of a document therefore always refer to the document that is currently being processed.

Some field macro functions return an empty value if the functions do not calculate a concrete result or do not find a searched element. If the return value is of a fixed data type, the empty value will correspond to this type (e.g., 0 as an empty numeric value). However, if the return type is variable and cannot be determined from the current processing context, an empty text value will be returned because a string is the default data type.

All macro functions that search or compare characters or strings are case-insensitive unless this is explicitly configurable by parameter.