> 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/running-a-macro.md).

# Running a Macro

### Introduction

While macros can be scheduled to run at specific dates/times, an operator can run a macro at any given time.

Operators need the "Run Macros" or "Schedule & Run Macros" operator privilege within a division in order to run a macro in that division.

### Procedure

#### Running Macros from Site Plans or Status Viewer

On the Site Plan or Status Viewer, either:

* **Right click** on the macro icon ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-d975733ca458d14420bb7d5e01f910719b1ddfa4%2Fmacroicon.png?alt=media) and select **Run Macro**.

Or:

* **Double click** the macro icon ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-d975733ca458d14420bb7d5e01f910719b1ddfa4%2Fmacroicon.png?alt=media).

#### Running Macros from the Context Menu

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

   The **Macro** List Window opens.
2. Highlight the macro you want to run.
3. **Right click** the mouse button, and select **Run Macro**.

### Result

If the macro has the "Operator confirmation required when run manually" option selected (on the **Operator Confirmation** tab of the Macro's properties), then the following dialog will display:

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

**Note:** This screen shot shows the "default" message. However, the message may differ if a different message has been specified on the **Operator Confirmation** tab of the Macro's properties.

Click the **Yes** button.

The Macro icon changes image for several seconds ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-38b176e99a1a9a16511015c8ac69a4168227d388%2Fmacrorunicon.png?alt=media) as an indication the macro has run.

**Notes:**

* Regardless of which method an operator uses to run a macro, an "Operator Ran Macro" event will be generated.
* When a macro runs it is possible that some of its actions cannot be carried out, (e.g. when a macro is set-up a relay may support pulse overrides, however when the macro runs this could have been changed). In such cases, if the macro was run (from a schedule or by an operator), then an event is generated indicating which item(s) and action(s) could not be carried out.
* If the server goes offline at the time a macro is scheduled to run, the macro will only run if the server comes back online within one minute of the scheduled run time. If it is not run, when the server comes back online an event will be generated.


---

# 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/running-a-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.
