Macros

Macros are trigger queries that have been saved and can be use with other triggers.

The Macros page lists all the macros that have been added to the system and can be accessed from left menu pane of the Triggers page. If you do not see the left menu pane, swipe to the left browser edge to show the menu.

• Macros
• Sort macro details
• Create
• Edit
• Duplicate
• Copy macro to a different project
• Delete

Sort macro details

• Click on the far right to show or hide headings that are relevant to you.
  • Select Toggle density to change the amount of spacing in each row.
• Click a heading to sort the list by that heading.
• Click and drag a heading to move the column left or right.
• Click any macro row to expand and show the list of triggers that use the macro.

Create

You can create macros in a couple ways: while you add or edit a trigger, from the Triggers page or the Macrospage.

While adding or editing a trigger

1. After you build the query for a trigger, click Save as macro.
2. In the following dialog, enter a key for the macro.

   A macro key is the string that would be used to call the macro.

   The macro key is always prefixed with macro_ and must be unique.

3. Click Yes.
4. The query for the trigger is replaced with the new macro.

The new macro is automatically added to the Macros page, and uses the key as the name of the macro. If you need this macro to be available across projects, you will need to edit the macro and enable the Global setting.

From Triggers page

1. On the Triggers page, locate the trigger that uses a query that you want to save as a macro.
2. At the right-end of the row, select > Create macro.

   The Macro details page is displayed and the Macro query area is populated with the CQL query from the original trigger.

3. Enter a name for the macro.

   By default, the name of the macro is used to populate the key.

4. If you want the key to be different from the name, enter a different value into the Key field.
5. Enter a description for the macro.
6. If the macro needs to be available across all projects in the system, click to enable the Global setting.

   This setting is disabled by default.

7. In the Macro query area, make any changes that may be required.
8. Click Save.

The new macro is added to the Macros page.

From Macros page

1. On the Triggers page, click Macros from the left menu pane.

   If you do not see the left menu pane, swipe to the left browser edge to show the menu.

2. In the top-right corner of the Macros page, click Add macro.
3. On the following page, enter a name and key for the macro.
4. Enter a description for the macro.
5. If the macro needs to be available across all projects in the system, click to enable the Global setting.
6. In the Macro query area, enter the CQL values for the macro.
Enter manually

• Click the bar to select the starting query. Use the auto-complete prompts to further narrow your query.

  For more information about the available CQL values, see CQL values.

• Click to use the search query as any of the following:
  • Sources — select this option to add the search query as a filter for the Sources page. For more information, see Source filters.
  • Insights — select this option to create a new report from the search query. For more information, see Creating a report.
  • Triggers — select this option to use the search query as the base of a new trigger. For more information, see Adding a trigger.
Use the builder

• On the left, click the heading titles to show the condition properties that are available.

  For more information about the listed properties, see CQL values.

• Click All to select if All or Any of the tree conditions need to be true to activate the trigger actions.
• Add a property to the tree then assign the required values. You can add a property in any of the following ways:
  • Click a property from the provided list.
  • Drag and drop any property from the list to the tree.
  • Click Add property.
  • Hover over any property in the tree then click .
• Click Add group to create a subgroup of condition properties.
• From the left end of each property branch, drag and drop the property to change it's position in the tree.
• To delete a property from the tree, click .
7. Click Save.

Edit

1. On the Macros page, open the Macro details page.
   • Click the macro name.
   • At the right-end of the macro row, select > Edit.
2. On the following page, make any required changes.
3. Click Save.

Duplicate

NOTE: Not available for Global macros.

1. On the Macros page, locate the macro you want to duplicate.
2. At the right-end of the row, select > Copy macro.
3. In the following dialog box, select the current project.
4. Click Copy macro.

A copy of the macro is added to the Macros page. The date and time it was copied is appended to the macro name.

Copy macro to a different project

NOTE: Not available for Global macros.

1. On the Macros page, locate the macro you want to copy.
2. At the right-end of the row, select > Copy macro.
3. In the following dialog box, select the project you want to copy the macro to.
4. Click Copy macro.

A copy of the macro is added to the selected project's Macros page. The date and time it was copied is appended to the macro name.

Delete

You cannot delete a macro unless there are no triggers using it.

1. On the Macros page, locate the macro you want to delete.
2. Click a macro to expand the row to show the list of triggers that are using the macro.

   Tip: If the macro does not expand, there are no triggers using the macro.

3. Remove the macro from each of the listed triggers.

   To remove a macro from a trigger, edit the trigger and remove the macro listed in the Trigger query builder.

4. When there are no more triggers listed under the macro, select > Deletee.
5. When the confirmation dialog is displayed, click Yes.