> 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.md).

# Creating a new report

### Introduction

Creating a new report is simple using the Reports wizard. You step through the report building process using the **Next** button to access each wizard page, accepting default settings/values or making custom choices. At any stage you can backtrack via the **Back** button, or stop the report generation process by choosing the **Cancel** button (which also exits the wizard without offering to save changes).

The information displayed to you when stepping through the Report wizard will vary depending on what report type you are creating.

You are given the option to save the report. This means it is available within the **Report Description** List Window to be used again and again.

### Procedure

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)).

   **Note:** All reports your site has set up are shown in this window.
2. **Right click** and select **New**.
3. From the displayed sub-menu, select which **type of report** you want to create.
4. The first screen of the appropriate report wizard displays.

   Click the **Next** and **Back** keys to step through the wizard.
5. Refer to the relevant topic for details relating to the particular **report type** you selected.

   Note: Those reports with "(Configuration Client)" after the name indicates there is an equivalent report in the Command Centre Client.

   [Cardholder Report (Configuration Client)](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/cardholder-report.md)

   [Activity Report (Configuration Client)](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/activity-report.md)

   [Evacuation Report (Configuration Client)](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/evacuation-report.md)

   [Access Group Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/access-group-report.md)

   [Access Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/access-report.md)

   [Exception Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/exception-report.md)

   [Time and Attendance Report (Configuration Client)](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/time-and-attendance-report.md)

   [Site Configuration Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/site-configuration-report.md)

   [Contact ID Assignment Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/contact-id-assignment-report.md)

   [Wiring Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/wiring-report.md)

#### Report Generation and Saving

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

The final wizard page (for all report types) is titled "Report Generation and Saving".

**Note:** The 'Report Generation Options' section of this page differs slightly from that shown for some report types, as follows:

* *Access Reports* have a drop-down box for selecting a file type beside the **File** option.
* *Cardholder, Activity, Evacuation* and *Exception Reports* have a drop-down box for selecting for selecting a file type beside the **File** option, and they also have an additional **Email** output option.

6. Type the report **Name**.
7. Type the report **Description**. For example, you may mention the report is printed to the screen.
8. Select the **Division** from the drop-down list that you want to save this report in, (i.e. only operators with access to the Division you select will be able to see the report).
9. Click the radio button corresponding to where you want the report to be generated:

   <table><thead><tr><th width="192">Click the...</th><th>to...</th></tr></thead><tbody><tr><td><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-eb225762f561d59227c3ef827e9e7e7923575fe4%2Ffile1.png?alt=media" alt=""> radio button</td><td><p>save the information <strong>to file</strong>, and type in the location and file name.<br>Alternatively, click the <strong>Browse</strong> button to select from the existing directory paths and type in the file name.<br><br><strong>Note:</strong> When reports are saved to file, they get saved as <strong>text</strong> files, with the exception of:</p><ul><li>Access Reports, as there is the option to save these as either <strong>Text</strong> or <strong>XML</strong> file types. <strong>XML</strong> output allows you to analyse the data using a variety of tools, (e.g. Excel 2003).</li><li>Cardholder, Activity, Evacuation and Exception Reports, as there is the option to save these as either <strong>Text</strong> or <strong>PDF</strong> file types.</li></ul></td></tr><tr><td><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-6d1c3dcd771c66d6ed8fe0ae98dd4d85ba1093ff%2Fprintprev.png?alt=media" alt=""> radio button</td><td>preview the information <strong>on screen</strong>.</td></tr><tr><td><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-22443ec304beee0af50b56eb214ca4f652531c56%2Fprinter1.png?alt=media" alt=""> radio button</td><td><p>print the information to a selected <strong>printer</strong>, and select a printer from the drop-down list of available printers, or type in the printer name.<br><br><strong>Notes:</strong></p><ul><li>In the case of Auto-Evacuation Reports, if the operator does not have access to the printer on which the report is to print to, it will not appear in the list of available printers. Instead, the operator can type in the path to the printer, in which case the <strong>Setup Printer</strong> and <strong>Next</strong> buttons become disabled. Auto-Evacuation Reports are run via the server, therefore they cannot be tested from individual workstations.</li><li>Via the <strong>Setup Printer</strong> button you can set information about the printer (for example; paper size and paper orientation).<br>The default paper orientation for reports is portrait. You can change the report orientation however, which can be useful for long names, (e.g. Cardholder names in the Evacuation Report).<br>See <a href="https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/customising-report-printouts.md">Customising Report Printouts</a> if you wish to produce a report this way.</li><li>By default, only one copy of the report will print to the printer, however you can set this to another amount if you require additional copies.</li></ul></td></tr><tr><td><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-d45f4a4317b40b820b0d9122f146093a38c75a05%2Femail.png?alt=media" alt=""> radio button<br><br><strong>Note:</strong> This option is only available on the Cardholder, Activity, Evacuation and Exception Reports.</td><td><p>select Cardholders for the Report to be emailed to, by dragging and dropping them into the grid, and selecting the appropriate file type for the report, (i.e. either <strong>Text</strong> or <strong>PDF</strong>).<br><strong>Notes</strong>:</p><ul><li>If a selected cardholder has more than one email address, the 'first' one displays, with the string ', …' (indicating they have more than one).</li><li>If a selected cardholder has no email address, then a warning message displays when the <strong>Next</strong> button is clicked.</li><li>Email addresses display here as 'Read-only'.</li></ul></td></tr></tbody></table>
10. To save this report and its settings, click the **Save Report** button ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-5987d856035263697e02f4b0183293f863ddfd4c%2Fsaverpt.png?alt=media).

    This report will now display within the **Reports Description** List Window, and the **Save Report** button becomes disabled and changes to **Report Saved**.

    **Note:**

    When an operator prints an existing report from the **Reports Description** List Window (i.e. a report that was saved), new data gets retrieved, as only the query was saved.

    The **Save Report As** button ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-f00472db11eff86bad56ecbad692e57e6da50043%2Fsaverptas.png?alt=media) allows multiple reports to be saved using the one wizard window.

    By opening an existing saved report and clicking the **Save Report As** button, the new report will display in the **Report Description** List Window, along with the original one.

    **Note:**

    If you open an existing saved report and click the **Save Report As** button without changing the report name a message displays indicating that the report already exists, and asks if you wish to replace it. By clicking **Yes** the original report is overwritten, and clicking **No** returns you to the "Report Generation and Saving" page, giving you the opportunity to change the file name for the report.
11. Click the **Next** button.

    A **Report Generation Progress** window displays. This provides feedback to the operator while data is retrieved from the server and formatted. An operator may choose to cancel the report by selecting the **Cancel** or **Back** button. No other functionality is available on this page.

    **Notes:**

    * Larger reports take longer to generate.
    * Two reports that access the same archive files can be run simultaneously. This can be done on two separate workstations, or on the same PC running two workstations.
    * You may receive the following error message when restoring files:

      *"Connection to the specified path \<pathname> has failed. Please check:*

      *- you have entered the path correctly*

      *- the Archiver User Account has the appropriate permissions to use this network resource."*

      If you do, you need to get the System Administrator who set up your archives to check that the User Account has sufficient privileges.
12. Click the **Finish** button.

### Result

The report is generated and sent to the specified destination (printer, on screen or saved to file).

### Hint

{% hint style="info" %}
**Deleting existing Reports**

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 an existing report.
{% endhint %}

{% hint style="info" %}
**One -off Reports**

You may be required to create a "one-off" report and print it. Because the report is not required again, do **not** click the button "Save Report". The report will print but will not be saved.
{% endhint %}

### In This Section

* [Cardholder Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/cardholder-report.md)
* [Activity Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/activity-report.md)
* [Evacuation Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/evacuation-report.md)
* [Access Group Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/access-group-report.md)
* [Access Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/access-report.md)
* [Exception Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/exception-report.md)
* [Time and Attendance Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/time-and-attendance-report.md)
* [Site Configuration Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/site-configuration-report.md)
* [Contact ID Assignment Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/contact-id-assignment-report.md)
* [Wiring Report](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/reports/creating-a-new-report/wiring-report.md)


---

# 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.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.
