To create a custom macro

On a flowchart page in Edit mode, click the Options icon and select Custom Macros.

The Custom Macros dialog appears, displaying existing custom macros.

Click New Item.

From the Save Under drop-down list, select the folder location to which you want to save the custom macro.

In the Name field, enter a name and declaration for the custom macro so that it can be referenced, using the following syntax:

MacroName(var1,var2,...)

Only the name of the custom macro (which must be unique) and the list of variables need to be expressed.

The MacroName must be alphanumeric. You cannot use spaces in the MacroName string, but you can use underscores (_).

If a custom macro has the same name as a built-in macro, the custom macro will take precedence. As a best practice, to avoid confusion, do not name custom macros with operator names or names that are the same as those of built-in macros in Campaign. The exception would be if you specifically want the new custom macro to always be used, and the built-in macro to be inaccessible.

The variable names must match the variable names in the custom macro definition in the Expression window, and they must be expressed as a comma-separated list within parenthesis.

From the Security Policy drop-down list, select a security policy for the new custom macro.

Optionally, use the Note field to enter any notes for the new custom macro, providing a clear explanation of what the custom macro is designed to do and what each variable represents.

From the Expression Type drop-down list, select the type of custom macro you are creating.

If you select Raw SQL Selecting ID List, you must also select a database from the drop-down list in the Database field.

If you select Raw SQL Selecting ID + Value, you must also select a database from the drop-down list in the Database field and select the value type of the field from the Value Type drop-down list. Ensure that the value type you select here is correct. Otherwise, when you later attempt to profile this query, you will get a "Mismatched Type" error.

If you selected Text as the value type, specify the width of the value type in bytes in the Width (# Bytes) field. You must obtain this width in bytes information from the database. If you do not have access to the database or are unable to obtain the information, enter 256, the maximum width.

Click inside the Expression field to open the Specify Selection Criteria window.

Create your query expression. You can use as many variables as you like. Variable syntax is alphanumeric, and the variable must be enclosed in open and closed angle brackets (<>). Operands (values and strings) and operators might be variables.

Do not use flowchart user variables in custom macro definitions, since custom macros are global and flowchart user variables are not.

Example: Custom macro that uses raw SQL selecting an ID and a value

10.

Click Save to save the custom macro.

The custom macro is then stored, and can be accessed by its name.

11.

Click Close to exit the Custom Macros dialog.