Macros

Overview

The following macros can be used in transition conditions or in the additional parameters of application type actions. They will be replaced by their associated value during process execution.

List of available macros

* field: See the next table.

See Examples of macros below for examples of values for the macros listed above.

User macro suffixes

Using macros

You can use macros in the transitions and additional notification conditions or in the action parameters to send the value of the macro to the parameter value by choosing one macro from the list or by concatenating several macro codes as a text value.

📌 Example 1

If you want to send the username of the requester in the action's REQUESTER_USERNAME field, you have to add an additional parameter with the following settings:

Parameter name: REQUESTER_USERNAME
Send the value of a macro: Requester.Username

📌 Example 2

If you want to send the first name and the last name of the requester in the action's REQUESTER_NAME field with a space in between the two, you have to add an additional parameter with the following settings:

Parameter name: REQUESTER_NAME
Send the value of a text: <WF_REQUESTER_FIRSTNAME> <WF_REQUESTER_LASTNAME>

File data macros

Access to the file properties

In transition or notification conditions, you can use the following macros on file type process data to access the file properties.

Syntax examples

The following examples assume you have a file type data called MY_FILE.

📌 Example 1

Rule: Check if the file name contains the keyword "report":
- Method: InStr(1,<MY_FILE.FILENAME>,"report",1) <> 0

📌 Example 2

Rule: Check if the file size is less than 1 MB:
- Method: <MY_FILE.SIZE> < 1024

📌 Example 3

Rule: Check if the file is a Microsoft Word document:
- Method: <MY_FILE.CONTENTTYPE> = "application/msword"

📌 Example 4

Rule: Check if the file was modified today:
- Method: <MY_FILE.DATELASTMODIFIED> > [Date]

Check if a file exists

You can also use the name of the data to check if the file exists in the process by using the IsNull() function.

📌 Example

If you have a FILE type data called MY_FILE, you can use the syntax below in a condition to check if the file exists:

IsNull(<MY_FILE>)

Examples of macros

The following table shows examples of the macros listed above.

Web configuration app settings macros

This feature helps to simplify the deployment of business processes in a multi-instance WorkflowGen environment by allowing you to define common data or instance-specific data as a key-value pair that can be used in your process by way of a macro in action parameters, in transition conditions to control the flow, and in action notifications instead of hard-coding these data in the process definition.

You can create your own macros by defining custom app settings in the WorkflowGen web configuration file.

You must use the EngineMacroAppSettings configuration parameter to define your custom macros. You can specify the exact key name, or use a prefix followed by * (asterisk) as shown in the example below, which adds the three custom macros (<WF_APP_SETTING_MySecretKey1>, <WF_APP_SETTING_MySecretKey2>, and <WF_APP_SETTING_MySecretKey3>).

📌 Example

The <WF_APP_SETTING_MySecretKey1>, <WF_APP_SETTING_MySecretKey2>, and <WF_APP_SETTING_MySecretKey3> macros will be available at design and runtime with the app setting below in the web.config:

<configuration>
  <appSettings>
    <add key="MySecretKey1" value="4n(#N$HT0$Bohv!" />
    <add key="MySecretKey2" value="9et9tzV{Hnn]EsDE" />
    <add key="MySecretKey3" value="e#8BHvXa8N*LvFaY" />
    <add key="EngineMacroAppSettings" value="MySecretKey1, MySecret*" />
  </appSettings>
</configuration>

PreviousCustom Notification Templates NextWorkflowGen URLs

Last updated 3 years ago