> 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-installation/enrolment-wizard-and-templates/using-the-enrolment-wizard.md).

# Using the Enrolment Wizard

### Introduction

Enrolment Wizards allow you to search for and identify a cardholder, then encode and print a card specific to that cardholder. The Wizards work in conjunction with Photo ID, which determines the layout of the card type. Refer to Photo ID for further detail.

### Before you begin

* An Enrolment Template must be configured first. See [Configuring Enrolment Templates](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/enrolment-wizard-and-templates/configuring-enrolment-templates.md) for the procedure.

  Each Enrolment Template created will have a separate entry on the **Wizards** menu, which when selected starts the Enrolment Wizard with the associated Template options applied.\
  **Note:** If you do not configure the Enrolment Template prior to using the Enrolment Wizard you will not be given any Enrolment Wizard options in the **Wizards** menu.
* For Enrolment Wizard entries to display on the **Wizards** menu you must have the "View Cardholders" operator privilege and the associated Enrolment Template must be within your Division.

### Procedure

1. Click **Wizards** from the menu bar.

   Each Enrolment Template that has been created will show as an entry in the **Wizards** menu.
2. Click the appropriate **Enrolment Wizard** entry.

   The **Welcome** screen of the Enrolment Wizard displays, indicating which Enrolment Template is being used in the Name field and in the Title bar of each screen of the wizard.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-23b9a5a2343899929ed37501932933f16b9e2369%2Fenrolwizard_welcome.png?alt=media)
3. Click the **Next** button.

   The **Identify Cardholder** screen of the Enrolment Wizard displays.

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

   This screen can be used to search for and identify the cardholder for which a card will be printed.
4. To locate the cardholder, enter the First and/or Last Names of the Cardholder, and/or the PDF which was selected as the 'Primary ID' in the Enrolment Template. In the case of the example screen above, the 'Primary ID' PDF is **Personal Data Field**.

   **Notes:**

   * If no data is entered in a particular field, that field will be excluded from the search.
   * If the Primary ID is a numeric PDF, wild card searches will not work. Instead, the exact number must be entered.
   * The search is not case sensitive.
5. Click the **Search** button.
6. If the search retrieves more than one cardholder, highlight the required Cardholder record. This can be done by either moving the pointer to the correct record and clicking the mouse, or by using the arrow keys to move up or down within the list.

   **Note:**

   Only the first one hundred matches are returned.
7. Click the **Next** button.

   The **Update Cardholder Data** screen of the Enrolment Wizard displays.

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

   Details of the identified Cardholder populate this screen along with an Image PDF if defined in the Template.
8. Update any Cardholder data that is incorrect or incomplete.

   **Notes:**

   * This is only possible for fields that have been configured as editable in the Enrolment Template.
   * For “text - list” Personal Data Fields you can highlight the PDF and make a selection from the drop-down list (pressing < **Alt** >+< **DownArrow** > expands the drop-down list).
9. Is the existing Image PDF displayed the one you wish to use, or would you like to update the existing Image PDF?

   <table><thead><tr><th width="228">If you wish to...</th><th>then...</th></tr></thead><tbody><tr><td>use the Image PDF displayed</td><td>go to Step 15.</td></tr><tr><td>update the existing Image PDF</td><td>click the <strong>Capture Image</strong> button.<br>The <strong>Capture Image</strong> window displays. It will be blank if it is the first time you have captured or loaded an image on this workstation, otherwise it will default to the last method of capturing you used.</td></tr></tbody></table>
10. If you have a blank Capture window, or you want to change the method of capture, click within the drop-down selection box and select the camera you want from the list of devices attached to the PC.
11. Click the **Capture...** button.
12. You can either load an existing image, or capture a new image.

    <table><thead><tr><th width="228">If you want to...</th><th>then...</th></tr></thead><tbody><tr><td>load a previously saved image</td><td><ul><li>Select <strong>Load from file...</strong> from the drop-down list.<br>The <strong>Select image to load</strong> window displays.</li><li>Path your way to the location of the image you require, and click the <strong>Open</strong> button.<br>The image displays in the <strong>Capture Image</strong> window.</li></ul><p><strong>Note:</strong><br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-e6fb9cbde3b24da20781602f23726c1346293b4f%2Fsavedimage.png?alt=media" alt="Saved Image"><br>To adjust the contrast and/or brightness of a saved image, right click and move the indicator as necessary.</p></td></tr><tr><td>capture a new image</td><td>depending on how the camera you are using has been installed on the PC, it may give you 'live' video, in which case if you are cropping you have to crop a moving image. Alternatively, the camera may display it's own window in which case you 'acquire' the image, which then brings it back to the <strong>Capture Image</strong> window as a static picture which you can then re-crop.<br><br><strong>Note:</strong><br>If you need to adjust the appearance of the image, right click with the image displayed, and click <strong>Configure</strong> <strong>Source</strong>. A window displays which enables you to adjust the image, (e.g. sharpness, brightness, colour, etc.)</td></tr></tbody></table>
13. Reposition the cropping frame.
14. Click the **OK** button.

    The **Capture Image** window closes.

    The captured image now displays in the **Update Cardholder Data** screen of the Enrolment Wizard.
15. Click the **Next** button.

    The **Confirm Card Details** screen of the Enrolment Wizard displays.

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

    The details of the card to be printed/encoded display on this screen.

    Depending on the settings configured on the **Card Details** tab of the Enrolment Template either:

    * one of the radio buttons will be enabled, (i.e. **Existing Card** or **New Card** ), or
    * neither radio button will be enabled if the cardholder has no existing cards and the Enrolment Template has not been set up for new cards to be created.
16. Confirm the details displayed, and change any that are incorrect.
17. Click the **Next** button.

    The **Print and Encode Card** screen of the Enrolment Wizard displays.

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

    A default reason for printing and/or encoding the card will be displayed if this was configured in the Enrolment Template.

    If there are other reasons for printing and/or encoding configured in Command Centre, you can select another one from the drop-down list or type in your own reason into the text field. The reason selected will be logged in the event details.
18. Select the required **Printer** from the drop-down list.

    **Note:**

    You can only select a printer/encoder that is appropriate for the action you are performing, (e.g. if your card has no encoding object, then no encoding printers will appear in the drop-down list).
19. If PINs have been enabled for the Card Type the **PIN** field and **Generate PIN** button will be enabled.

    Either:

    * manually type a PIN number into the **PIN** field.

      **Note:** The PIN will display as a row of X’s and as you enter a PIN the message *"PIN must be between \<number> and 8 digits"* appears, \<number> being the length set against the Card type. The maximum PIN length is 8 digits. There is no mechanism to reduce the maximum size. Hence if a site sets minimum at 4, the user can enter PIN length anywhere from 4 to 8 digits, OR
    * click the **Generate PIN** button to automatically generate a random PIN.

      **Note:** Generated PINs will only display while in the Print and Encode Card step of the wizard. If you have checked the **Store user PINs for later viewing** checkbox (on the **Card Security** tab of the Server Properties), the PIN will be stored and can therefore be re-viewed. Generated PINs will be of length equal to the minimum PIN length set against the Card type.
20. Select the **Print and Encode option**, (i.e. 'Print and Encode', 'Print Only' or 'Encode Only'), from the drop-down list provided.

    **Note:**

    This field will only appear if more than one of the Print and Encode options were selected in the Enrolment Template.
21. Click whichever of the following buttons is displayed:

    <table><thead><tr><th width="126">Button</th><th>The card...</th></tr></thead><tbody><tr><td><strong>Print/Encode</strong></td><td>is encoded and prints to the default printer.</td></tr><tr><td><strong>Print</strong></td><td>prints to the default printer.</td></tr><tr><td><strong>Encode</strong></td><td>is encoded by the default printer.</td></tr><tr><td><strong>Next</strong></td><td>and/or cardholder details are updated.</td></tr></tbody></table>

### Result

The Enrolment Wizard automatically returns to the **Identify Cardholder** screen, ready for another Cardholder to be identified.


---

# 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-installation/enrolment-wizard-and-templates/using-the-enrolment-wizard.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.
