> 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/command-centre-client/configuring-command-centre/creating-reports/configuring-a-report-layout.md).

# Configuring a Report Layout

**Note:** This procedure is the same for all report types except the Summary Activity Report and Z20 Tuning Report. See [Configuring a Summary Activity Report Layout](https://help.security.gallagher.com/knowledge-hub/command-centre-client/configuring-command-centre/creating-reports/configuring-a-summary-activity-report-layout.md) or [Configuring a Z20 Tuning Report Layout](https://help.security.gallagher.com/knowledge-hub/command-centre-client/configuring-command-centre/creating-reports/configuring-a-z20-tuning-report-layout.md) as appropriate for the procedure.

1. Click the **Configure Layout** button that appears over the Report Preview in the Configuration Panel.

   The Report Layout Configuration pop-up displays.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-13007c28534e1bd8713faffafa7ba7d5bb41a00b%2Freportlayoutconfig_popup.png?alt=media)

   **Note:** This is how the Report Layout Configuration pop-up looks for an Activity, Cardholder or Time Report (Overview). For an Evacuation, Access or detailed Time Report there will be an additional **Show top level group on new page** checkbox at the bottom of the pop-up. For a Voltage Report there will be additional **Display graph** and **Display data table** checkboxes at the bottom of the pop-up.

   This pop-up is used to select, sort, group, order and size columns, as well as set page layout options, (i.e. page size and orientation).

   **Note:** The **Restore Default Configuration** button allows you to restore everything on this page to how it was when you first opened it. Even if you have saved your configuration settings, and reopen the Report Layout Configuration pop-up, clicking this button will still restore the default settings.

### Selecting Columns

2. Select another category from the **Column filter** drop-down if necessary. The options are:

   * All Columns
   * Cardholder Access and Operator Groups
   * Cardholder Base Details
   * Cardholder Card Details
   * Cardholder Card History Details
   * Cardholder Competencies
   * Cardholder Personal Data Fields
   * Cardholder Roles
   * Event Details

   **Note:** If another category is selected, the list of possible column names will change accordingly.
3. If necessary, search for the column(s) you want to include in the Report by entering search criteria in the **Search** field.
4. Click the checkbox next to each Column name you want to include, or click the **Select All** button if you want to include all Columns.

   As columns are selected, they appear in the **Column Configuration** section in the lower part of this pop-up (in the order you select them). The only exception to this is if you select any 'Cardholder Competencies' or 'Card Serial Number (CSN)'. For either of these, additional 'Display' options appear, as follows:

   * For each selected Competency, one or more attributes can be selected for column name(s), (i.e. 'Status', 'Expiry Warning Date', 'Expiry Date', 'Re-enable Date' and 'Comment').
   * When selecting the 'Card Serial Number (CSN)' column, one or more CSN formats can be selected for the CSN column(s), (i.e. 'Hexadecimal', 'Decimal', Hexadecimal Reverse bytes' and Decimal Reverse bytes').

### Sorting and Grouping Columns

Sorting, grouping and counting are configured at column level, in the **Column Configuration** section (in the lower part of this pop-up), as follows:

5. Click on the ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-65bdd58253f73d243ca718ca08533cf8ff2f68f0%2Freport_unsortedcolumnicon.png?alt=media) icon beside a column name.

   **Note:** This ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-65bdd58253f73d243ca718ca08533cf8ff2f68f0%2Freport_unsortedcolumnicon.png?alt=media) icon is the default that appears before an unsorted column name.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-2454f6f0f1f035212e0fcd478afe4d0f562d38a4%2Freport_sort%26groupoptions.png?alt=media)
6. From the context menu, select the required option.

<details>

<summary>Click here for a description of what each option does</summary>

<table><thead><tr><th width="166">Option</th><th>Function</th></tr></thead><tbody><tr><td>Sort ascending</td><td>This option sorts a column in ascending order, (i.e. A-Z, 1-9, etc.), and is indicated by a <img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-9afe64aa7ff24c680ed0f280dff4f3a187cafa49%2Freport_ascendingcolumnicon.png?alt=media" alt=""> icon beside the column name.</td></tr><tr><td>Sort descending</td><td>This option sorts a column in descending order, (i.e. Z-A, 9-1, etc.), and is indicated by a <img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-93343bfb3258684bd8f09fcb9ba22aa4a72effff%2Freport_descendingcolumnicon.png?alt=media" alt=""> icon beside the column name.</td></tr><tr><td>Group by this column</td><td>This option moves a column to become the next level (either first or successive) group-by column, as shown:<br><img src="https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-1542b02757859c7c7041745189f0835f02adc778%2Freport_groupbycolumn1.png?alt=media" alt=""><br>When one or more columns are grouped a <strong>Show top level group on new page</strong> checkbox appears at the bottom of the configuration pop-up, allowing you to have the top-level group start on a new page in the report output.</td></tr><tr><td>Remove this column</td><td>This option removes the column from the report selection.</td></tr></tbody></table>

</details>

7. Repeat Steps 5 - 6 for each column.

   **Note:** You can change the option selected for a column if necessary.
8. Did you select the **Group by this column** option, which moved a column to the next level group-by column?

   If **yes**, go to Step 9.

   If **no**, go to Step 11.
9. Click on the triangle icon beside the group name.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-b204d8b49ef2483df6a717b921344f4c94689ab0%2Freport_groupbycolumn2.png?alt=media)
10. From the context menu, select the required option(s).

<details>

<summary>Click here for a description of what each option does</summary>

<table><thead><tr><th width="184">Option</th><th>Function</th></tr></thead><tbody><tr><td>Sort ascending</td><td>This option sorts the group in ascending order. In the example at Step 9, Zone A would become before Zone B.</td></tr><tr><td>Sort descending</td><td>This option sorts the group in descending order. In the example at Step 9, Zone B would become before Zone A.</td></tr><tr><td>Show count</td><td>This option returns a count of records returned for each item in this group.</td></tr><tr><td>Ungroup by this column</td><td>This option removes the column as a group-by column and returns the column to the data grid.</td></tr><tr><td>Remove this column</td><td>This option removes the column as a group-by column and removes the column from the report selection.</td></tr></tbody></table>

</details>

11. Check the **Display Total Report Count** checkbox if required.

    If checked it will return a total count of records in the report regardless of whether or not grouping is used in the report. In the report output the 'Total Count' will display at the end of the report.

### Ordering and Sizing Columns

12. Reorder the columns if necessary, by clicking on the column title and dragging it to the required position.
13. Resize the columns if necessary, as follows:
    1. Hover over the column divider until the mouse pointer changes to a "double-ended" arrow.

       ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-4f6b99320666dd350aff5cb0e6d20fb771200a66%2Fresize_reportcolumns.png?alt=media)
    2. Click and hold down the mouse button.
    3. Move the mouse in the required direction until the column is the required size.

### Changing the page layout

Change the default Page Layout options if necessary, (i.e. **Page Size** and **Page Orientation** ), as follows:

14. Change the **Page Size** if required.

    **Note:** The page size defaults to the last page size used by the operator (via operator preference) or to A4 if this is the first use of reports for an operator.
15. Select 'Landscape' from the **Page Orientation** drop-down list if you want the orientation of the report layout to be 'Landscape' rather than the default of 'Portrait'.
16. **Note:** If page size and/or orientation changes are made, the **Column Configuration** section (in the lower part of this pop-up), changes to show the new aspect ratio of the page size selected, and column widths automatically adjust to fit the new orientation.

### Configuring Headers, Footers and Cover page

17. Click the **Configure Header/Footer/Cover Page** button.

    The Header, Footer and Cover Page pop-up displays.

    ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-abec43b65667943bb7436fd8802c43fa13252e1f%2Freport_headerfootercover.png?alt=media)
18. Tick the relevant checkboxes for what you want to display on the report, (i.e. a Cover page, headers and footers).

    **Notes:**

    * The **Display Header** and **Display Footer** options are selected by default.
    * Evacuation Reports ALWAYS display the following disclaimer as a Footer, regardless of the whether or not **Display Footer** is checked:

      *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.*
19. Do you want to upload a logo for the cover page and/or header on the report?

    If **yes**, go to Step 20.

    If **no**, go to Step 23.
20. Click the **Upload Logo** button.

    A **Select Image to Upload** dialog displays.
21. Path your way to the required image file.

    **Note:** Only BMP, JPG, PNG and GIF image files, less than 5MB in size, are supported formats for report logos.
22. Click the **Open** button.

    The dialog closes and the **Upload Logo** button changes to the name of the image file you selected.
23. Do you want to upload a disclaimer or other appropriate details for the report?

    If **yes**, go to Step 24.

    If **no**, go to Step 27.

    **Note:** If you upload a disclaimer file and do NOT select the **Display Cover Page** option, the disclaimer file contents will replace the cover page. However, if the **Display Cover Page** option is selected then the disclaimer file contents will be appended to the cover page contents.
24. Click the **Upload Disclaimer** button.

    A **Select File to Upload** dialog displays.
25. Path your way to the required image file.

    **Note:** Only RTF and TXT files, less than 5MB in size and no bigger than approximately 20 pages, are supported formats for report disclaimers.
26. Click the **Open** button.

    The dialog closes and the **Upload Disclaimer** button changes to the name of the file you selected.
27. Click the **OK** button.

    The Header, Footer and Cover Page pop-up closes, and returns you to the Report Layout Configuration pop-up.
28. Click the **OK** button.

    The Report Layout Configuration pop-up closes. The following message may display above the Report Preview in the Configuration Panel:

    ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-152b56e2d2cc9e289f4ea86c9d4ff08187386035%2Freportconfig_refresh.png?alt=media)

    If so, click the **Refresh** button. The Report Preview updates to reflect the configuration options selected.


---

# 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/command-centre-client/configuring-command-centre/creating-reports/configuring-a-report-layout.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.
