> 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/personal-data-fields/creating-a-new-personal-data-field.md).

# Creating a new Personal Data Field

### Introduction

This procedure details how to create a Personal Data Field.

***

### Configuration

1. Click **Configure** from the menu bar, then **Personal Data Fields**.

   The **Personal Data Field** 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\...Personal Data Field**.

   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).
4. Click each tab in turn to configure a Personal Data Field:

<details>

<summary>Type tab</summary>

1. Click the **Type** tab.

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

   This tab determines the type of data to be entered against the PDF.

   By default "Text" populates the **Data Type** field.
2. Click within the **Data type** field and select the appropriate type from the drop-down list.

   **Note:** With the exception of the **Numeric** type, each type has additional information that must be entered, some of which is common to all types, while other information is specific to individual types, as follows:

   <table><thead><tr><th width="192">If you select...</th><th>the...</th></tr></thead><tbody><tr><td>Text, or any contact PDF types, (i.e. Address, Phone, Email or Mobile)</td><td>following additional fields display:<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-8f0024d0804b4f27dfb0d5db35d5cb53b6f9e7e6%2Fpdftext_contact.png?alt=media" alt=""><br>The <strong>Use Regular Expression</strong> feature is for text and contact type PDF data validation to allow the enforcement of text values. It allows you to write a regular expression that will force PDF entered values to obey the rules of the expression. If values are entered that break the expression, then an error message displays detailing the expression requirements.<br>See <a href="https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/personal-data-fields/creating-a-new-personal-data-field/regular-expression-settings.md">Regular Expression Settings</a> for further detail on entering information into this section.<br><br><strong>Note:</strong> If the <strong>Data type</strong> is either 'Mobile' or 'Email', there is an additional <strong>Default Notifications</strong> checkbox which is used by the Visitor Management application. If you want hosts to be able to send invitations to visitors this checkbox must be ticked.<br>When checked, it also determines whether or not the <strong>Notifications</strong> checkbox is checked when an Access Group with that PDF is added to a Cardholder, or the Cardholder added to the Access Group.</td></tr><tr><td>Text - List</td><td>following additional fields display:<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-7d84ce6632960b876e51f6dea3481ee1ecd42ed3%2Fpdftextlist.png?alt=media" alt=""><br>These fields allow you to define a set of entries that may be selected from, when entering data against a cardholder. To do this, enter a value in the 'List Values' field, then click the <strong>Add</strong> button.<br>When the 'Restrict to List' option is enabled the <strong>Default value</strong> must be one of the list values or blank. If 'Restrict to List' is not enabled, free text entries can be entered against a cardholder.</td></tr><tr><td>Image</td><td>following additional fields display:<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-809f1ef94d5a0cdbee9c0601e88b9fdb3e24377c%2Fpdfimage.png?alt=media" alt=""><br>These fields allow you to specify details about the image that is saved to the database.<br>The <strong>Image Type</strong> can be JPEG, Bitmap or PNG.<br>Check the <strong>Profile Image</strong> checkbox if you want this Image PDF (containing the cardholder photo) to be shown on the Mobile Client Details screen.<br><br><strong>Note:</strong> Only one Image PDF will be used for each cardholder. If a cardholder has more than one Image PDF captured and they all have the <strong>Profile Image</strong> checkbox enabled, the image with the lowest sort order will display.<br>Refer to <a href="https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/personal-data-fields/capturing-an-image.md">Capturing an Image</a> for the procedure on how to capture images for an Image Personal Data Field.</td></tr><tr><td>Date</td><td><strong>Default value</strong> field changes to a Date control:<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-c14e3621adb4c026d97e2a237313a1b60f3772b2%2Fpdfdate.png?alt=media" alt=""><br>Leave the checkbox unchecked if you do not want a default.<br>The following additional fields also display:<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-f2d4e3e8ed069ebb5de1d9afc22b65647b61478a%2Fpdfdatelimits.png?alt=media" alt=""><br>A lower and/or upper date range may be specified to control the dates entered into the PDF.<br><br><strong>Note:</strong> The dates will display on-screen and in reports in the date format specified in the workstation settings.</td></tr></tbody></table>
3. Check the following boxes as necessary:

   <table><thead><tr><th width="192">If...</th><th>is checked, then...</th></tr></thead><tbody><tr><td>Required Field:</td><td>Data for the Personal Data Field will be mandatory when editing a cardholder.</td></tr><tr><td>Unique Values:</td><td>an operator will be prevented from entering the same value across multiple cardholders (although the system will allow a "no data" value to be entered multiple times).<br>The <strong>Default Value</strong> field is disabled.</td></tr></tbody></table>

   **Note:**

   "Unique Values" is disabled for **Text - List** type, **Image** type and **Date** type.
4. Click within the **Default accessibility** field and select the appropriate privilege (i.e. type of access), from the drop-down list.

   This determines the base operator rights for this Personal Data Field.

   <table><thead><tr><th width="192">If you select...</th><th>then...</th></tr></thead><tbody><tr><td>Edit (default)</td><td>operators with the "View Cardholders" privilege in a division can view the Personal Data Field value but not create or edit it.<br>Operators with the "Edit Cardholder Personal Data" privilege in a division can create or edit the Personal Data Field values of a cardholder in that division.</td></tr><tr><td>Hidden</td><td>operators who do not have the "Advanced User" privilege will not see the cardholder information recorded for this Personal Data Field for cardholders in this group's Divisions, or even see that it exists.</td></tr><tr><td>Revealable</td><td>operators with the "View Cardholders" privilege in a division can view the Personal Data Field value (from the <strong>Personal Data</strong> tab of the Cardholders properties), by clicking on the <strong>Reveal</strong> button.<br>Operators with the "Edit Cardholder Personal Data" privilege can view the Personal Data Field value by clicking on the <strong>Reveal</strong> button, but not create or edit it.</td></tr><tr><td>View Only</td><td>operators with the "View Cardholders" privilege in a division can view the Personal Data Field value.<br>Operators with the "Edit Cardholder Personal Data" privilege can view the Personal Data Field value, but not create or edit it.</td></tr><tr><td>Revealable and Editable</td><td><p>operators with the "View Cardholders" privilege in a division can view the Personal Data Field value (from the <strong>Personal Data</strong> tab of the Cardholders properties), by clicking on the <strong>Reveal</strong> button, but not create or edit it.<br>Operators with the "Edit Cardholder Personal Data" privilege in a division by clicking on the <strong>Reveal</strong> button can create or edit the Personal Data Field value of a cardholder in that division.<br><br><strong>Notes:</strong></p><ul><li>Revealable and Editable PDFs are not available in REST or Mobile Client.</li><li>Personal Data Fields with either "Revealable" or "Revealable and Editable" accessibility display a <strong>Reveal</strong> button on the Personal Data tab of the Cardholder properties.</li><li>Revealable or revealable/editable PDFs that are included will not log the new access event when a report is run, a search via REST is made, or there has been an operator event.</li></ul></td></tr></tbody></table>

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

   Every time a **Reveal** button is pressed, there is an Operator Event in the form of *Operator "View Site, VS" revealed the value of the "Address R\&E" field for "Configure Site, CS"*, from the "Source" of the Workstation that the operator was logged into.

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

   **Notes:**

   * The **Default Notifications** checkbox will be revealed when the **Reveal** button is pressed, (i.e. it is a blank space until that happens).
   * The system operator does not have the reveal option visible, as they can see everything anyway.
   * A field which is not editable will have its title rendered in grey.
5. Alter the **Sort Order** field if necessary. This controls the order in which PDF records are shown in the cardholder property page.

   **Note:**

   The lower the number, the higher up the list it will display, (e.g. 1 will display the PDF at the top of the screen, 100 will put it at the bottom, and if all are set to the same number they will display in alphabetical order).

</details>

<details>

<summary>Group Membership tab</summary>

1. Click the **Group Membership** tab.
2. Click **Manage** from the menu bar, then **Access Groups**.

   The **Access Group** List Window opens.

   Select those Access Group(s) appropriate for this Personal Data Field.

   Drag and drop them into the **Group Membership** tab.

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

</details>

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

   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 Personal Data Field.

   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

A new Personal Data Field is created.

**Note:**

Once a Personal Data Field has been created and data has been recorded against it, the ability to alter its Data Type will not be available.

For recording cardholders personal data against PDFs, see [Editing a Cardholders PDF data](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/cardholders/editing-a-cardholders-pdf-data.md) for the procedure.

***

### Editing and Deleting Personal Data Fields

Refer to [Editing items](https://help.security.gallagher.com/knowledge-hub/configuration-client/introduction-to-command-centre/knowing-your-way-around/generic-properties-configuration/editing-items.md) and [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 procedures on how to edit and delete Personal Data Fields.

**Note:** Deletion of a Personal Data Field is only allowed if it is not currently assigned to be used anywhere in the system, except if it is saved against a report.

***

### Hints

{% hint style="info" %}
**Copy and Paste**

An alternative to the drag and drop method is to use the copy and paste method.
{% endhint %}

{% hint style="info" %}
**Group Membership details**

The Access Group(s) you added to this Personal Data Field (in Step 11) will now have this PDF displayed in the **Personal Data** tab of their Properties screen.
{% endhint %}

### In This Section

* [Regular Expression Settings](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/personal-data-fields/creating-a-new-personal-data-field/regular-expression-settings.md)
* [Common Regular Expressions](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-management/personal-data-fields/creating-a-new-personal-data-field/common-regular-expressions.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/personal-data-fields/creating-a-new-personal-data-field.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.
