> 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/archives-backups-and-restores/configuring-archives.md).

# Configuring Archives

### Introduction

All archive configuration is performed from the Archive property pages. The properties mandatory to configuring an archive are the archive paths and user account. Those properties are covered in the first eight steps of this procedure, while the remaining steps are optional parameters.

This procedure describes how to configure an Archive. To perform this procedure you must have the "View Site", "Configure Site" and "Backup and Archive" operator privileges. Note that the "Configure Site" operator privilege is only given to high level administrators.

If you wish to configure an archive that removes data from the database without archiving the events you need the "Advanced User" operator privilege. Note that the "Advanced User" operator privilege is only allocated to extremely high level administrators.

**Note:** The system only allows one archive to be configured.

***

### Configuration

To configure an archive, perform the following procedures in Gallagher Configuration Client:

1. Click **File** from the menu bar, then **Archives**.

   The **Archive** 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. **Right click** and select **New\...Archive**.

   By default the **General** tab displays.
3. Complete the fields as required.

   For further detail see [General tab](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/general-tab.md).

   **Notes:**

   * The Division you select here will determine who will be able to see the archive.
   * All data for all Divisions is always archived. You cannot archive individual Divisions data separately.
4. Click each tab in turn to configure an archive:

<details>

<summary>Paths tab</summary>

1. Click the **Paths** tab.

   This tab allows you to specify a server's archive and restore locations.

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

   The fields on this tab are described below:

   <table><thead><tr><th width="228">Field</th><th>Description</th></tr></thead><tbody><tr><td>Archive paths</td><td>These specify the paths to which archive files will be written. All archive files will be written to both locations. Always ensure the 'relative to Command Centre server' is appropriate.<br>Maximum length = 260 characters.<br><br><strong>Note:</strong> The Archive paths require "Network Service" permissions to write.</td></tr><tr><td>Additional restore path</td><td>The system searches the current archive paths for archive files when reporting on archived activity. This allows an additional path to be specified which will be searched for archive files when reporting, but will not be written to, (e.g. a CD-ROM drive).<br>Maximum length = 260 characters.</td></tr><tr><td>User account for accessing network shares</td><td>The name and password of the user account to use when accessing archive and restore locations on network shares. If this is left blank, the archive and restore locations will be accessed using the logon account the FT Command Centre Service has been configured to use (Local System account by default).<br>Maximum = 50 characters.</td></tr></tbody></table>

   The **Validate** buttons check that the archive or restore location can be accessed by the server.

   **Note:**

   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 should check the User Account on this tab has sufficient privileges.

</details>

<details>

<summary>Schedule tab</summary>

Configuration on this tab is only required if you want to schedule this archive so it happens automatically.

1. Click the **Schedule** tab.

   This tab allows you to specify a simple repeating schedule for automated archives.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-1bd799e7f2c0bef89049e32be2294456ad83a6f0%2Farchive_scheduletab.png?alt=media)
2. Check the **Schedule this archive** checkbox to enable automated archives.

   **Note:**

   The other fields on this tab are disabled until this checkbox is checked. (Default = Off)

   The fields on this tab are described below:

   <table><thead><tr><th width="228">Field</th><th>Description</th></tr></thead><tbody><tr><td>Every [count] [units]</td><td>Specifies the interval between the start of each scheduled archive. The count can be between 1 and 99, and the units can be minutes, hours, days or weeks.<br>Therefore the minimum is 1 minute and the maximum is 99 weeks.<br>(Default = 1 day)</td></tr><tr><td>Starting at [date] [time]</td><td>This specifies when the repeating schedule will start.<br>Default = Midnight of day after Archive item's creation date.</td></tr></tbody></table>

   **Note:**

   The archive schedule (start time and interval) is specified in local time relative to the central server. This means the interval between archives can vary if it crosses a daylight savings transition.

   Example:

   If an archive is scheduled to occur every 6 hours from midnight. Archives will occur at midnight, 6am, midday and 6pm local time, even if there is only 5 hours between midnight and 6am due to a daylight savings transition.

</details>

<details>

<summary>Advanced tab</summary>

This tab allows you to specify if the data will be archived and how much will be kept online (in the database).

1. Click the **Advanced** tab.

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

   <table><thead><tr><th width="228">Field/Checkbox</th><th>Description</th></tr></thead><tbody><tr><td>Remove events older than:<br>AND<br>Remove image sequences older than:</td><td>The archive process ARCHIVES all unarchived event/images and then removes events/images older than xxxx days. Unarchived events/images are NOT removed.<br>The minimum is 0 days and the maximum is 9999 days.<br>(Default = 90 days)</td></tr><tr><td>Disable event archiving and delete unarchived events<br>AND<br>Disable image sequence archiving and delete unarchived sequences</td><td>The archive process DELETES all (archived/unarchived) events/images that are more than xxxx days old.<br>The minimum is 0 megabytes and the maximum is 999,999 megabytes.<br>The "Advanced User" operator privilege is required to make this field active.<br>(Default = unticked)</td></tr></tbody></table>

   **IMPORTANT:**

   We do not recommend the disabling of event/image archiving. It may be useful if you do not want to keep or report on data older than xxxx days.

   UTC date standards determine what data is to be removed from the database. Calculating 90 days using standard time may vary by a day.

   0 days removes all data

   1 day removes todays data

   90 days converts standard time to UTC time and removes all data 90 days and older

   |                               | <p><br><br><strong>Events & Images</strong><br><strong>'Archive Enabled'</strong></p> | <p><br><br><strong>Events & Images</strong><br><strong>'Archive Disabled'</strong></p> | <p><strong>Events</strong><br><strong>'Archive Enabled'</strong><br><strong>Images</strong><br><strong>'Archive Disabled'</strong></p> | <p><strong>Events</strong><br><strong>'Archive disabled'</strong><br><strong>Images</strong><br><strong>'Archive Enabled'</strong></p> |
   | ----------------------------- | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
   | **Events newer than xx days** | Archived                                                                              | No Archive                                                                             | Archived                                                                                                                               | No Archive                                                                                                                             |
   | **Events older than xx days** | Archived and removed                                                                  | No Archive and removed                                                                 | Archived and removed                                                                                                                   | No Archive and removed                                                                                                                 |
   | **Images newer than xx days** | Archived                                                                              | No Archive                                                                             | No Archive                                                                                                                             | Archived                                                                                                                               |
   | **Images older than xx days** | Archived and removed                                                                  | No Archive and removed                                                                 | No Archive and removed                                                                                                                 | Archived and removed                                                                                                                   |

</details>

5. Click the **Custom Fields** tab if you want to add and assign a custom field value to this archive.

   For further details regarding the **Custom Fields** tab, see [Custom Fields](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/custom-fields.md).
6. Click the **Notes** tab if you want to add a note(s) about this archive.

   For further details regarding the **Notes** tab, see [Notes](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/notes.md).
7. Click **OK** to exit and save your changes.

   Click **Cancel** to exit without saving your changes.

   Click **Apply** to save your changes and stay in this window.

### Result

An Archive item has been configured.


---

# 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/archives-backups-and-restores/configuring-archives.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.
