> 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-management/reports/automatically-generated-reports/configuring-report-scheduling.md).

# Configuring Report Scheduling

### Introduction

Activity, Cardholder, Exception and Evacuation Reports can be set to generate automatically. There are a number of ways report scheduling can be configured, as the following two examples demonstrate.

**Example 1:**

An Evacuation Report is usually produced in an emergency situation. We recommend that an Action Plan be set up on the Door's Emergency Release input so that an alarm is created when the input is turned on. One way to automatically produce the Evacuation Report when the Doors Emergency release is turned on, is to add a macro to the Action Plan, where the macro’s action is to print a report to a certain location.

**Example 2:**

A Schedule can be set up instructing a Virtual Output to switch on at a certain time or date. When the output switches on it uses an Action Plan which will run a macro, where the macro’s action is to produce the report, (i.e. if you set up the Schedule to turn the output on every 8 hours at shift change, a report will be automatically produced every 8 hours).

Example 2 has been expanded with more detail, and is split into three parts, in the order they should be performed:

* Configuring a Macro for a Report
* Configuring Report scheduling options
* Configuring Report Macro triggers

When necessary, this procedure refers to separate step-by-step procedures that are detailed elsewhere in this online help.

***

### Example 2

<details>

<summary>1. Configuring a Macro for a Report</summary>

1. Create a new macro, or modify an existing macro from the **Macro** List Window.

   Refer to [Creating a new Macro](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/macros/creating-a-new-macro.md) for the generic procedure for creating macros, or **right click** on an existing macro and select **Properties**.
2. Click the **Actions** tab.
3. Drag the Report you require for scheduling from the **Report Description** List Window, and drop it into the **Name** grid.
4. Click on the Report in the **Name** grid.

   The settings that have been saved for the report display in a **Settings** panel to the right of the **Name** grid.

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

   **Notes:**

   * The report 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 and Cardholder Reports, a **Select divisions you wish to include** grid displays also. You need to select the report in the **Name** grid in order for its Division to be selected automatically.
5. Click the **Schedule** tab.
6. One or more entries can be added for one-off report scheduling.

   Refer to [Scheduling a Macro](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/macros/scheduling-a-macro.md) for the procedure.
7. Click the **OK** button to save the Macro.

</details>

<details>

<summary>2. Configuring Report scheduling options</summary>

1. Configure Day Categories and Default Calendar as necessary.

   Refer to [Adding a new day category](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/day-categories/adding-a-new-day-category.md) and [Viewing/Editing the Default Calendar](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/calendars/viewing-editing-the-default-calendar.md) for the procedures.
2. Create a new Schedule.

   Refer to [Creating a new Schedule](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/schedules/creating-a-new-schedule.md) for the procedure.
3. Add the Day Category(s) appropriate for the type of schedule you are configuring, as indicated below:

   <table><thead><tr><th width="456">For a...</th><th>then add the...</th></tr></thead><tbody><tr><td><strong>Daily</strong> based schedule, (e.g. every day at 8am and 4pm)</td><td>Day Categories covering every day, (e.g. Weekday and Weekend).</td></tr><tr><td><strong>Day of the week</strong> based schedule, (e.g. every Monday at 8am and 4pm)</td><td>Day Category representing Monday.</td></tr><tr><td><strong>Days of the week</strong> based schedule, (e.g. every Monday to Friday at 8am and 4pm)</td><td>Day Categories covering from Monday to Friday, (e.g. Weekday).</td></tr></tbody></table>
4. Click the **OK** button to save the Schedule.

</details>

<details>

<summary>3. Configuring Report macro triggers</summary>

The steps involved in configuring report macro triggers include the following:

* [ ] Configuring an Event Trigger, (i.e. a Virtual Output)
* [ ] Linking the Virtual Output to the Controller
* [ ] Creating an Alarm Zone specifically for the Virtual Output
* [ ] Configuring an Action Plan

1. Configure the event trigger by creating a new Virtual Output.

   **Note:** For repeating report scheduling, it is recommended to use Virtual Outputs as triggers when the Output’s state changes, such as from **OFF** to **ON**.

   Refer to [Creating Inputs and Outputs](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/hardware/creating-inputs-and-outputs.md) for the generic procedure for creating Outputs.
2. Click the **OK** button to save the Virtual Output.
3. From the **Hardware** List Window, open the Controller that the Virtual Output is to be linked to.
4. Click the **Virtual Outputs** tab.
5. Drag the Virtual Output (already configured at Step 12) and drop it into the grid.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-ceed596e284c8b6007dc7c7fae257df193677526%2Frptsch_scrn3.png?alt=media)
6. Click the **OK** button to save the change to the Controller.
7. Create a new Alarm Zone specifically for the Virtual Output.

   **Note:** Minimal configuration is needed as this is not a ‘real’ zone.
8. Click the **Connections** tab.
9. Select the Controller that the Virtual Output has been linked to from the **Controller** drop-down list.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-2155b9a7ed12a063df70943b1c1cadcfab1f871c%2Frptsch_scrn4.png?alt=media)
10. Click the **OK** button to save the Alarm Zone.
11. Create a new Action Plan, or modify an existing Action Plan from the **Action Plan** List Window.

    Refer to [Creating a new Action Plan](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/action-plans/creating-a-new-action-plan.md) for the generic procedure for creating Action Plans, or **right click** on an existing Action Plan and select **Properties**.
12. Click the appropriate tab that represents the status of the Alarm Zone.

    The **Disarmed** tab is selected on the example screen below.
13. Drag the reporting macro (already configured in Step 1) into the **Cameras, Macros, and External System Items** grid.

    ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-fc2c32b38ef20bb2ba12fe6056e6895cd732cb43%2Frptsch_scrn5.png?alt=media)
14. Click the **OK** button to save the Action Plan.
15. Re-open the Virtual Output created in Step 12.
16. Click the **Event Response** tab.
17. Select the Event Group “Closed/On”, and change its Action Plan to the one configured in Step 22 above.

    This will trigger the Report Macro to run when the Output state changes from **OFF** to **ON**.
18. Select the **Alarm Zone** (already created in Step 18) from the drop-down list.

    ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-fdab88a8d32799cfed69662508ab7f6d345795c8%2Frptsch_scrn6.png?alt=media)
19. Click the **Advanced** tab.
20. Select the reporting Schedule (already configured at Step 9), from the **Schedule for output activation** drop-down list.

    ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-3dfc819a719d2585eb53713bd0c2880b5822a7c0%2Frptsch_scrn7.png?alt=media)
21. Click the **OK** button to save the changes to the Virtual Output.

</details>


---

# 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-management/reports/automatically-generated-reports/configuring-report-scheduling.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.
