> For the complete documentation index, see [llms.txt](https://help.security.gallagher.com/knowledge-hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/macros/creating-a-new-macro.md).

# Creating a new Macro

### Introduction

This procedure details how to create a new macro in Command Centre. To perform this procedure operators need the following operator privileges:

* The "Edit Macros" privilege within a macro's division.
* To be able to configure the actions for the item(s) you have included, you also require another privilege, as indicated below:

  <table><thead><tr><th width="216">For...</th><th>you also require the...</th></tr></thead><tbody><tr><td>Outputs, Access Zones and Interlock Groups</td><td>"Override" privilege</td></tr><tr><td>Alarm Zones</td><td>"Override" privilege, and the "Bulk Process Alarms" privilege if you intend selecting an Alarm Processing option</td></tr><tr><td>Logic Blocks</td><td>"Maintenance Override" privilege</td></tr><tr><td>Doors</td><td>"Override - Open Door" privilege</td></tr><tr><td>Bulk Changes</td><td>"Bulk Change" privilege</td></tr><tr><td>Guard Tours</td><td>"Manage Guard Tours" privilege</td></tr><tr><td>Controllers</td><td>"Configure Site" and "View Site" privilege</td></tr><tr><td>Exception Reports</td><td>"View Events and Alarms" OR "View Site" privilege</td></tr><tr><td>Cardholder Reports</td><td>"View Cardholders" and the "Edit Report Descriptions" privilege</td></tr><tr><td>Activity and Guard Tour Reports</td><td>"View Events and Alarms" privilege</td></tr><tr><td>Evacuation Reports</td><td>"Edit Evacuation Report" privilege</td></tr><tr><td>Workstations</td><td>"Disable Workstation" or "Enable Workstation" privilege, depending on which override action you configure.</td></tr></tbody></table>

***

### Configuration

To create a new Macro, perform the following procedures in Gallagher Configuration Client:

1. Click **Configure** from the menu bar, then **Macros**.

   The **Macro** List Window opens (in [grid view](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/list-windows/grid-view.md)).
2. **Right click** and select **New\...Macro**.

   By default the **General** tab displays.
3. Complete the fields as required.

   For further detail see [General tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/general-tab.md).
4. Click the **Event Response** tab, and configure as required.

   For further detail see [Event Response tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/event-response-tab.md).
5. Click the **Alarm Instructions** tab, and configure as required.

   For further detail see [Alarm Instructions tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/alarm-instructions-tab.md).
6. Click each tab in turn and configure the Macro properties as required:

<details>

<summary>Actions tab</summary>

1. Click the **Actions** tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-fb28a934f63b7376515b11080f8311faf837dbea%2Fnewmacro_actionstab.png?alt=media)
2. Drag and drop the Command Centre items you want to perform actions on for this macro into the **Name** grid.

   **Note:**

   Only Command Centre items that can be supported by macros, and to which you have the correct privilege(s), can be dragged into this field, (i.e. Outputs, Access Zones, Alarm Zones, Interlock Groups, Logic Blocks, Doors, Broadcast Notifications, Bulk Changes, Guard Tours, Controllers, Fence Zones, Macros, Morpho Biometric Readers, Workstations, Evacuation Reports, Exception Reports, Activity Reports, Guard Tour Reports and Cardholder Reports).

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-fb79fecafe80f3aa7ab60d1f8c207138512cea52%2Fnewmacro_actionstab2.png?alt=media)

   These Command Centre items need to have actions configured for them.

   **Note:**

   **Right clicking** on an item in the **Name** grid displays a context menu. This allows you to view the items Properties or you can remove the item by selecting **Remove from List**.
3. Select the first item in the list.

   The pane to the right of the **Name** grid populates, and changes to reflect the currently configured action for that item.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-e081cee317c1ef16f92da455fef8fa5344783c16%2Fnewmacro_actionstab3.png?alt=media)

   **Notes:**

   * Some items only support one action, (e.g. for doors you can "Open Door", for bulk changes you can "Run Bulk Change", and for Controllers you can "Re-sync Databases"). However, for items that support more than one action, (e.g. items supporting override actions), then the default action is "None Selected".
   * For Alarm Zones, the **Alarm Processing** drop-down list (as shown on the above screen) only displays if you have the "Bulk Process Alarms" privilege. By selecting "Acknowledge All" or "Process All", all existing alarms for the Alarm Zone will be acknowledged or processed, respectively. By selecting "Auto-Acknowledge All", all subsequent alarms for the zone will be auto-acknowledged, up until the point where all alarms on the zone have been processed.

     **IMPORTANT:** These options bypass both mandatory alarm notes and the option to disalllow an operator from processing escalated alarms.
   * For Evacuation, Exception, Activity, Cardholder and Guard Tour Reports the settings that have been saved for the report display. These settings can be changed (if you have the operator privilege to edit the report in the report's Division), by right clicking on the Report in the **Name** grid and selecting **Properties**.
   * For Exception, Activity, Cardholder and Guard Tour Reports, you need to select the report in the **Name** grid in order for its Division to be selected automatically.
4. Click the **Override** field and select the appropriate status from the drop-down list.

   **Notes:**

   * If you do not configure actions for each of the items, or leave --None Selected-- in the **Override** field, the following message will display when you try to save the macro:

     *"One or more action items have no actions configured."*
   * The actions available from the **Override** drop-down list are identical to the overrides available via the **Status and Overrides** tab on the Properties for each Command Centre item.
   * Where an override is initiated from a macro the new override takes precedence over, (i.e. replaces) any existing override for that item.
   * Multiple overrides can be selected for items that support multiple simultaneous overrides, (e.g. Access Zones - the access mode can be overridden, Anti-passback forgive can be applied, the Zone Count can be set and the Access Zone can be overridden to "Lockdown" or "Cancel Lockdown").

</details>

<details>

<summary>Schedule tab</summary>

This tab allows you to schedule the macro now, if required.

See [Scheduling a Macro](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/macros/scheduling-a-macro.md) for a detailed procedure.

**Note:**

To be able to schedule a macro you need the "Schedule & Run Macros" operator privilege.

</details>

<details>

<summary>Operator Confirmation tab</summary>

This tab allows operators to be presented with a confirmation dialog prompt before the macro runs.

**Note:** Confirmation dialogs only display when macros are manually-triggered by an operator.

1. Click the **Operator Confirmation** tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-6feef0319a354409004a89ed150631244c2dd667%2Fnewmacro_opconfirmtab.png?alt=media)
2. Check the **Operator confirmation required when run manually** checkbox.

   The "Confirmation text" field is enabled.
3. Alter the confirmation text if you want something different from the default, (i.e. "Are you sure you want to run this macro?"), to appear on the confirmation dialog.

   **Note:**

   This field is limited to 200 characters, and while multiple lines are allowed, new lines take up two characters.

</details>

7. Click the **Icons** tab if you want to change the Icon Set for this macro.

   For further details regarding the **Icons** tab, see [Icons](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/icons.md).
8. Click the **Custom Fields** tab if you want to add and assign a custom field value to this macro.

   For further details regarding the **Custom Fields** tab, see [Custom Fields](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/custom-fields.md).
9. Click the **Notes** tab if you want to add a note(s) about this macro.

   For further details regarding the **Notes** tab, see [Notes](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/notes.md).
10. Click **OK** to exit and save your changes.

    Click **Cancel** to exit without saving your changes.

    Click **Apply** to save your changes and stay in this window.

### Result

A new macro has been created to perform a number of actions quickly with minimal operator interaction. This macro can now be placed on a Site Plan for future execution if required. See [Placing a Macro on a Site Plan](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/macros/placing-a-macro-on-a-site-plan.md) for the procedure.

**Note:**

If **OK** or **Apply** is clicked and the macro contains items and actions that you do not have sufficient privileges to save, then an error message will display informing you of the disallowed items, and the changes will not be saved.

***

### Deleting Macros

Refer to [Deleting items](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/deleting-items.md) for the procedure on how to delete a Macro.

**Note:** A macro cannot be deleted if it is on a Site Plan or is used in an Action Plan. Likewise, operators, workstations and site items that appear on a macro's **Schedule** or **Actions** tabs cannot be deleted from the system.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/macros/creating-a-new-macro.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
