> 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/creating-a-new-report/evacuation-report.md).

# Evacuation Report

### Introduction

The Evacuation Report provides a list of cardholders present on a site. This can be used in an evacuation situation, such as a fire, and allows better management of evacuation situations and improved cardholder safety.

**Note:** In a multi-server system that uses Visitor Management (a licensable feature), visit data does not get replicated between servers. Therefore, the Evacuation Report cannot report on remote visitors.

Evacuation Reports can be set up to generate automatically via an Action Plan or a scheduled macro. These are referred to as 'Auto-Evacuation' Reports, and are triggered by an event or alarm. For further detail see [Automatically Generated Reports](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/automatically-generated-reports.md) and [Configuring Report Scheduling](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/automatically-generated-reports/configuring-report-scheduling.md).

***

### Prerequisite

The Evacuation Report relies on cardholder location information, and is therefore only effective at sites where **all** cardholders swipe their cards **every** time they enter or exit an [*Access Zone*](https://help.security.gallagher.com/knowledge-hub/configuration-client/glossary-of-terms.md#access-zone).

***

### Operator Privileges

To create a new Evacuation Report, or to delete or edit the properties of an Evacuation Report an operator must have the "Edit Evacuation Report" operator privilege in the Evacuation Report's Division.

To view the properties of and/or run an existing saved Evacuation Report, an operator must have the "View Events and Alarms" operator privilege in the Evacuation Report's Division. An operator will still be able to see all the properties, (i.e. items like PDFs, Access Zones, etc.) even if the report contains items that the operator has no privileges for.

Having different privileges for creating and running Evacuation Reports ensures that operators who are able to run and print pre-configured Evacuation Reports (when there is an emergency), are prevented from changing their configuration.

***

### Report Wizard

The Evacuation Report wizard contains a number of pages which prompt you to enter certain information to create the report.

**Follow the instructions displayed.**

<details>

<summary>Report Style page</summary>

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

On this page you are prompted for the following:

* Decide on the method for choosing Access Zones to include:
  * **Select Access Zones by their Division** - This option provides a quick and easy method if you know the parts of the site you want to include.
  * **Select specific Access Zones** - This option allows for finer definition than the Division the zone belongs to, by selecting specific Access Zones.

The option you select will determine which wizard page displays next, (i.e. either the "Select Divisions" page or the "Select Access Zones" page).

* Decide how to sort the information. Either by:
  * Division, Access Zone and Cardholder (records will be grouped by Access Zone)
  * Cardholder name
  * Division and Cardholder (records will be grouped by Division)
  * Access Zone and Cardholder (records will be grouped by Access Zone)
  * Personal Data Field and Cardholder

    **Note:** The drop-down list box next to **Personal Data Field** is only enabled if the **Personal Data Field** radio button is selected.

    You can elect whether to include a Personal Data Field in the report (because cardholder names are not always unique, you may wish to include a unique PDF to distinguish between those cardholders with the same name, e.g. 'Date of Birth' PDF)

    Operators can only select PDFs available to them.
* You can optionally set the report to ignore location information older than a certain age.

  (Default = set to ignore location information more than 24 hours old. Maximum allowed is up to 999 hours.)
* You can optionally **Schedule this report to run at specified times**.
* If your site is licensed for the Visitor Management feature, there is also an option to "Include all on-site visitors" (checked by default).

  If selected, a new section is added to the end of the report listing all On-Site, Due to Leave and Overdue Visitors and Tour Groups.

  **Note:** All visitors are included in the report, regardless of the Divisions or Access Zones selected, and Tour Groups will indicate the number of visitors and a contact name for the Tour.

</details>

<details>

<summary>Select Divisions page</summary>

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

This page only displays if the "Select Access Zones by their Division" option is selected.

The grid on the left displays the current operator's "Available Divisions". The available Divisions are all Divisions in which the operator has "View Site" or "Edit Site" privilege.

Drag and drop the Division(s) you want included in the Evacuation Report from the list of available Divisions (the grid on the left), to the grid on the right.

If you have opened an existing saved Evacuation Report the Divisions that were originally selected for inclusion in the report display in the grid on the right. These display regardless of the current operator's privileges in these Divisions. An operator can remove a "Selected Division" from the list if they have "View Site" or "Edit Site" privilege in that Division.

</details>

<details>

<summary>Select Access Zones page</summary>

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

This page only displays if the "Select specific Access Zones" option is selected.

The grid on the left displays the current operator's "Available Access Zones". The available Access Zones are all Access Zones in which the operator has "View Site" privilege.

Drag and drop the Access Zone(s) you want included in the Evacuation Report from the list of available Access Zones (the grid on the left), to the grid on the right.

If you have opened an existing saved Evacuation Report the Access Zones that were originally selected for inclusion in the report display in the grid on the right. These display regardless of the current operator's privileges. An operator can remove a "Selected Access Zone" from the list if they have "View Site" privilege in the Access Zone's Division.

</details>

<details>

<summary>Select PDFs page</summary>

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

This page allows you to optionally include up to six Personal Data Fields in the report output. Using the arrow buttons, place the Personal Data Fields that you require from the **Available PDF's** grid to the **Selected PDF's** grid.

Once you have the Personal Data Fields you require in the **Selected PDF's** grid on the right, the up and down arrows to the side can be used to change the order of them, (i.e. Select the PDF you want to move and click either the up or down arrow to move it).

</details>

<details>

<summary>Column Widths page</summary>

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

This page allows the operator to configure the layout of the report. You can resize the width of the columns, as follows:

1. Move the mouse pointer to a column separator.
2. When the mouse pointer changes to a double-ended arrow ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-7a956876208764eb7a1fe7dda7f305e2ab531fb8%2Farrow_cross.png?alt=media), drag the column separator in the required direction to achieve the desired column width.

</details>

<details>

<summary>Regional Settings page</summary>

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

This page allows a time zone and/or language to be selected for the report. These options are specifically provided to support the Auto-Evacuation Report, (i.e. when the report is run via a macro on the server). Selection of a time zone is optional, as it is only required for Command Centre sites that span time zones. Selection of a language is also optional as it is only required for sites that have multiple languages.

If no time zone is selected, the report uses the time zone of the Command Centre server, only if the report was initiated from a macro which was triggered by an Action Plan, or a macro that was run from its schedule. In all other cases, the report uses the time zone on the workstation of the operator who has run the report, or the time zone on the workstation of the operator who ran the macro that triggered the report.

If a time zone is selected, when the report is run, all dates and times within the report will display in the selected time zone. Any dates and times configured within the report are assumed to be within the selected time zone (rather than the time zone on the configuring operator's workstation).

</details>

<details>

<summary>Report Scheduling page</summary>

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

This page only displays if the "Schedule this report to run at specified times" checkbox is checked on the **Report Style** page. It allows run times and repetition properties to be defined for the report.

Multiple explicit times for the report to be run can be configured, as follows:

1. Click the **Run at** radio button.
2. Enter a date and time, and click the **Add** button.

   The date and time appears in the **Next Scheduled Run Times** grid.
3. Repeat Steps 1-2 for each explicit time you require.

   **Note:** If you click the **Repeats** radio button, then the explicit additions are removed from the **Next Scheduled Run Times** grid.

Repeat times for the report to be run can be configured, as follows:

1. Click the **Repeats** radio button.
2. Select the 'initial' **From** date and time.
3. Select an **Until** date and time if required.

   **Note:** If no **Until** date is entered, the report will repeat indefinitely.
4. Select the regularity for the report to be run, (i.e. **Every** one or many **Hours**, **Days**, **Weeks** or **Months** ).

   **Note:** When **Weeks** is selected from the drop-down list, the days of the week display with an ability to select one or multiple days, (e.g. Monday and Thursday).

   The next five dates and times appear in the **Next Scheduled Run Times** grid.

</details>

<details>

<summary>Report Generation and Saving page</summary>

This wizard page is the same for all report types, and provides the same options. Refer to [Report Generation and Saving](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report.md) in the **Creating a new report** procedure for further detail.

</details>

**Recommendation:**

It is strongly recommended that sites perform trial runs of the Evacuation Report to ensure the reports are:

* configured correctly
* will be printed on the correct printer from all workstations.

**Disclaimer:**

The following disclaimer appears in the report:

**"The information presented in this report is dependent on system and report configuration. Gallagher does not accept responsibility for sites relying on this Evacuation Report."**

***

### Quick Method of Printing

In an emergency situation, operators with the 'View Events and Alarms' operator privilege can print a pre-configured Evacuation Report quickly and easily. Use the following procedure in this situation:

1. Click **Report** from the menu bar, then **Report Descriptions**.

   The **Report Description** 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. Highlight the required report.
3. **Right click** and select **Print**.

   The **Report Generation and Saving** page of the report wizard opens.
4. Click the **Printer** radio button (if not already selected) and click the **Next** button.

   The Evacuation Report prints to the printer pre-configured in the report. If this printer is not available to the operator generating the report, then the printers that are available to the operator are listed, and the operator is prompted to select one.


---

# 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/creating-a-new-report/evacuation-report.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.
