> 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/cardholder-report.md).

# Cardholder Report

### Introduction

The Cardholder Report allows the operator to print a listing of Cardholder information. The operator specifies a report style, (i.e. detailed or summary), and a set of cardholders as criteria.

Operators must have the "View Cardholders" and the "Edit Report Descriptions" privileges to create, save, edit and delete Cardholder Reports.

This report can be scheduled to run automatically at regular times (via Action Plans or scheduled Macros). For further information refer to [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).

***

### Report Wizard

The Cardholder Report wizard contains a number of pages which prompt you to enter certain information to create a 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-5f049dbe48344354ef78a574463251ee38c5d923%2Fchold1.png?alt=media)

This is the first page of the Cardholder Report wizard. It allows the operator to select either a **detailed** or **summary** version of the report.

**Detailed reports** include the Cardholder's name, the date they were created and last modified, the operator that last modified them and optionally one or more of the following information:

* Personal Data Fields
* Card Details (includes card status, i.e. whether cards are active or not)
* Access Groups

  **Note:** If you include Access Groups, for each Access Group that a cardholder belongs to, the report will show their temporary Access Group membership 'start' and 'end' dates/times. If they remain blank in the report, then the cardholder is a permanent member of the Access Group.

  Temporary membership records that have expired, but have not been deleted from the system, will also appear in the report.
* Operator Groups
* Notes, (i.e. entries recorded on the **Notes** tab of a Cardholder).
* Competency Details

  **Note:** If you want to include Cardholder Competency details in the report, see [Reporting on Cardholder Competencies](https://help.security.gallagher.com/knowledge-hub/configuration-client/licensable-features/cardholder-competencies/reporting-on-cardholder-competencies.md) for further details.
* Cardholder Role Details

  **Note:** Selecting this option will list cardholders that fill each role defined for each cardholder selected in the report. It will not show the relationship from the parent cardholder's perspective, (i.e. it will not show all cardholders that a cardholder is "responsible for"). Only a **Summary** Report will show the "responsible for" directional relationship.

**Notes:**

* If your site is licensed for Biometric Integration there will also be an **Include Biometric Details** checkbox, that can be turned off/on as required.
* If your site if licensed for the Notifications feature there will also be an **Include Notification Details** checkbox, that can be turned off/on as required.
* **Detailed** Cardholder Reports can also be run from the Cardholder List Window.

  See [Running a Cardholder Report from a Cardholder](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/cardholders/running-a-cardholder-report-from-a-cardholder.md) for further detail.

The detailed report may be configured to start each Cardholder on a new page. The report's sort order is fixed to the Cardholder's last and first names in ascending order.

**Summary Reports** provide no additional options on the first wizard page. Instead, configuration settings for the summary report are included on the next wizard page.

An **operator comment** may be entered for both report styles, which will be shown in the main header of the report. Comments are limited to a maximum of 200 characters.

You can optionally **Schedule this report to run at specified times** for both report styles.

</details>

<details>

<summary>Report Content page</summary>

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

This page only displays if the Summary Report style is selected.

**Note:** If Detailed Report is selected, the wizard moves directly to the **Select Cardholders and Operators** page.

The summary report always includes the Cardholder's first and last names, but in addition to this, the operator may select up to eight additional Cardholder fields (by marking them with a tick), from the list provided.

**Notes:**

* Two options available in the list are "Access Group Activation" and "Access Group Expiry". By selecting these, your report will show a cardholder's temporary Access Group membership 'start' and 'end' dates/times. If these columns remain blank in the report, then the cardholder is a permanent member of the Access Group.

  Temporary membership records that have expired, but have not been deleted from the system, will also appear in the report.
* One of the options available in this list is "User Code". This is the only way that you can filter on who has a user code, but the actual codes will not be disclosed in the report.

The order of the information in the summary report can be controlled through the setting of sort options against one or more of the shown fields. A field can be sorted in ascending or descending order, or may have no sort option applied.

Check the **Suppress repeated values in sorted columns** checkbox to control how the report will display repeated values in your summary cardholder report, (e.g. in a report that shows Access Group as the first column, it will display unique Access Groups as headers without repeating the Access Group name on each line).

</details>

<details>

<summary>Report Layout page</summary>

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

This page allows the operator to configure the layout of the report.

You can determine the position of the columns horizontally across the page, as follows:

1. Move the mouse pointer to the column header you want to reposition.

   The mouse pointer changes to a hand symbol.
2. Click and hold down the mouse button.

   The hand changes indicating it is grabbing the header.
3. Move the hand (and hence the column header) to the desired new position.
4. Release the mouse button.

You can also 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.

**Note:**

If **Card**, **Access Group** or **Operator Group** details are included as the first column in the report, then the names of the Cardholders that are members of multiple groups, or have multiple cards, will appear more than once in the report. Alternatively, if the Cardholder's name is the first column, then a Cardholder's name will appear only once even if they have multiple **Cards**, **Access Groups** or **Operator Groups**.

</details>

<details>

<summary>Select Cardholders and Operators page</summary>

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

This page provides a list of Cardholders that an operator may include in the report. Cardholders shown here are restricted to those under the Division of the operator.

The Find Tool may be used to locate Cardholders, which can then be dragged and dropped onto this page. Alternatively, you can open the **Access Group** List Window and drag and drop those Access Groups you require onto this page.

**Note:**

Only cardholders that are currently active within an Access Group will be reported on. Therefore, if you want the report to include 'expired' Access Group members, you need to select cardholders rather than Access Groups.

The "Automatic removal of expired members" from Access Groups will alter the information in the report depending on when the report is run.

Should you wish to delete a Cardholder or Access Group from your list on the right, **right click** on the item and click **Remove from List**.

</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-2390fadd6a1b5cde8f3e4fe96034cb3d29e1dc32%2Fchold8.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 Cardholder 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-32d4b02754113f15d9ea4424d381c5370ba926d8%2Fchold9.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.

The **Division** selection grid allows the report to be scheduled for specific divisions.

**Note:** Only Divisions to which you have the appropriate editing privilege will appear in the drop-down list.

</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>


---

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