> 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/universal-card-format/adding-a-new-universal-card-format.md).

# Adding a new Universal Card Format

### Introduction

An operator wishing to add a new Universal Card Format must have the "Configure Site" privilege and be in the same Division (or parent Division) as the Controller.

The following procedure describes how to create a new Universal Card Format and add it to the list of active formats.

### Before you begin

The structure and format of any Wiegand or ABA (American Banking Association) cards will need to be known before a Universal Card Format can be configured. If this is not known then it is recommended that Gallagher Group Limited is contacted. A variety of cards will be required with card numbers having as wide a range as possible. The facility codes, card numbers and issue numbers (if used) for the cards supplied, must be known.

**Note:**

Some card formats do not have [Facility codes](https://help.security.gallagher.com/knowledge-hub/configuration-client/glossary-of-terms.md#facility-code). The following procedure describes what action to take in this situation.

### Procedure

1. Click **Configure** from the menu bar, then **Universal Card Format**.

   The **Universal Card Format** 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\...Universal Card Format**.

   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 the **Format** tab.

   ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-87af19eb94e3ad69606ecc908741f423ecc1d9d0%2Fucfformat.png?alt=media)
5. Click the appropriate radio button for the format you require, (i.e. Wiegand or ABA).

   See the note at the end of this topic for examples.

   <table><thead><tr><th width="102">Format</th><th>Description</th></tr></thead><tbody><tr><td>Wiegand</td><td>Wiegand card data is stored on the card as a binary representation of the card details. The size and position of these fields, (e.g. Facility code, Issue Number, etc.) can vary from one card to another.<br><strong>Important:</strong><br>The Least Significant Bit (LSB) is referred to as bit 1, not bit 0.</td></tr><tr><td>ABA</td><td>American Banking Association (ABA) cards are handled quite differently to Wiegand format cards. Rather than a binary representation, ABA card data is handled as a series of decimal digits. The various fields are extracted from the card data string as real numbers and are handled normally from then onwards. All fields read will have any leading 0's stripped, (e.g. Facility code "0000730" will become "730").</td></tr></tbody></table>
6. Complete the parameters to describe the data on the cards to be supported.

   **WIEGAND FORMAT FIELDS:**

   <table><thead><tr><th width="192">Field</th><th>Description</th></tr></thead><tbody><tr><td>Number of Bits</td><td>(2 - 65535)<br>This must be the exact number of data bits contained on the card (including parity bits)</td></tr><tr><td>Bits in Facility Code</td><td>(1 - 20)<br>The number of bits comprising the Facility code.<br><br><strong>Note:</strong><br>Not all card formats have Facility codes. If this is the case, enter 0. You should then select a valid Facility code to be assigned to this format from the <strong>Facility Code</strong> drop-down list at the bottom of the tab. If you do not, the first Facility code for the site will be used.</td></tr><tr><td>First Bit of Facility Code</td><td>Start reading bits from this position for the Facility code.<br><strong>Important:</strong><br>The structure of Facility codes in Command Centre is in the following format:<br><strong>Region Code:</strong> &#x3C;A - P> &#x3C;upper 4 bits><br><strong>Fac Code:</strong> &#x3C;1 - 50,000> &#x3C;lower 16 bits><br>Any card data exceeding these values will generate an unrecognised card event. If 16 or less bits are used then the region code will always be 'A', e.g.<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-7c215d1ec8f4629a1a774f63a68c3a7275c84096%2Fregioncodes.png?alt=media" alt="Region Codes"></td></tr><tr><td>Bits in Card Number</td><td>(1 - 2000)<br>The number of bits comprising the Card number.</td></tr><tr><td>First Bit of Card Number</td><td>Start reading bits from this position for the Card number.</td></tr><tr><td>Bits in Issue Number</td><td>(0 - 4)<br>The number of bits comprising the Issue number.</td></tr><tr><td>First Bit of Issue Number</td><td>Start reading bits from this position for the Issue number.</td></tr><tr><td>Bits to Sum for Even Parity</td><td>(1 - 65535)<br>The number of bits (including the parity bit) to add up for the Even parity check.</td></tr><tr><td>First Bit to Sum for Even Parity</td><td>Start reading bits for the Even parity check from this bit position.</td></tr><tr><td>Bits to Sum for Odd Parity</td><td>(1 - 65535)<br>The number of bits (including the parity bit) to add up for the Odd parity check.</td></tr><tr><td>First Bit to Sum for Odd Parity</td><td>Start reading bits for the Odd parity check from this bit position.</td></tr></tbody></table>

   **ABA FORMAT FIELDS:**

   <table><thead><tr><th width="192">Field</th><th>Description</th></tr></thead><tbody><tr><td>Minimum Number of Digits</td><td>(2 - 107)<br>The minimum number of digits that a card may have for it to be a candidate for this Universal Card Format.</td></tr><tr><td>Maximum Number of Digits</td><td>(2 - 107)<br>The maximum number of digits that a card may have for it to be a candidate for this Universal Card Format.</td></tr><tr><td>Digits in Facility Code</td><td>(1 -7)<br>The number of digits comprising the Facility code.<br><br><strong>Note:</strong><br>Not all card formats have Facility codes. If this is the case, enter 0. You should then select a valid Facility code to be assigned to this format from the <strong>Facility Code</strong> drop-down list at the bottom of the tab. If you do not, the first Facility code for the site will be used.</td></tr><tr><td>First Digit of Facility Code</td><td>The position of the first digit in the Facility code.<br><strong>Important:</strong><br>The major difference is that the ABA Facility Code digit 'string' will be converted to binary first and then handled in exactly the same manner as described for Wiegand format cards. If, when converted to a binary representation, the number of bits exceeds 20, then the card will automatically be passed through as an 'unrecognised card' and no further match attempts will take place, e.g.<br><img src="https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-ea18f94e9c6c334acc32ac7efe32be9bf282a557%2Fabafacility.png?alt=media" alt="ABA Facility Codes">, etc.</td></tr><tr><td>Digits in Card Number</td><td>(0 - 107)<br>The number of digits comprising the Card Number.</td></tr><tr><td>First Digit of Card Number</td><td>The position of the first digit in the Card Number.</td></tr><tr><td>Digits in Issue Number</td><td>(0 - 2)<br>The number of digits comprising the Issue Number.</td></tr><tr><td>First Digit of Issue Number</td><td>The position of the first digit in the Issue Number.</td></tr></tbody></table>

   **COMMON FIELDS:**

   <table><thead><tr><th width="192">Field</th><th>Description</th></tr></thead><tbody><tr><td>Card Number Offset</td><td>(0 - 16777216)<br>This is to be used when combining multiple existing card bases into one system would cause duplicate card numbers. The system administrator will choose to offset one set of cards by a fixed amount to stop clashes. This applies to both Wiegand and ABA card formats. This offset is added to the card number of any valid cards matching this Universal Card Format, e.g.<br>A card is badged/swiped and is matched to a Universal Card Format. The card number is 24377 with the offset set to 420000. These are added together to give a card number of 444377.<br>This new value is the card number that will be used for transaction attempts made by this card. To the rest of the system, this modified value is the actual card number and must be treated as such, (e.g. when assigning cards to a cardholder the value 444377 would be used, not 24377).<br><strong>Important:</strong><br>By changing the Card Number Offset of a Universal Card Format after cards (matching this Universal Card Format) have been assigned to various users, then the card configuration for each user will also have to change to reflect the new Card Number Offset.</td></tr><tr><td>Issue Level Offset</td><td>Some cards with issue levels encode the first level as 0, while others encode the first level as 1. Command Centre issue levels always start at 1.</td></tr><tr><td>Facility Code</td><td>When a Wiegand or ABA card is badged the facility code is the first field to be extracted from the card data. If a facility code has been specified and the facility code read from the card is different to that found in the Universal Card Format, then the Controller will attempt to match the card data with the next Universal Card Format in the list until a matching facility code is found. This will continue until a match has been attempted with all available Universal Card Formats. If no matches are made then the card is passed on as an 'unrecognised card format'. If a facility code has not been specified in a Universal Card Format, then the Controller will attempt to match the cards facility code with any valid facility code used anywhere in the system. Specifying a facility code severely limits the chances of an incorrect Universal Card Format match. There may be cases where this is desirable though, so this feature has been left optional.</td></tr></tbody></table>
7. Click **OK** to exit and save your changes.

   The new Universal Card Format displays in the **Universal Card Format** List Window.
8. From the **Hardware** List Window, open the properties for the Controller you wish to transfer the Universal Card Format to.
9. Click the **Card Formats** tab.
10. Highlight the Universal Card Format and drag and drop it into the **Card Formats** tab of the Controller.

    ![](https://3000903572-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCvaxj3suxNBzdwQndVT%2Fuploads%2Fgit-blob-af0093109bc0d5d81066498fca0737d2ce4d4047%2Fucfintoftc.png?alt=media)
11. Click the **Custom Fields** tab if you want to add and assign a custom field value to this Universal Card Format.

    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).
12. Click the **Notes** tab if you want to add a note(s) about this Universal Card Format.

    For further details regarding the **Notes** tab, see [Notes](https://help.security.gallagher.com/knowledge-hub/configuration-client/site-installation/server-properties/notes.md).
13. 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 Universal Card Format has been created and the Controller has been configured to recognise the new format.

**Note:**

The following screen shows an example of the Alarm/Event Properties page when an unknown format card is badged:

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

The following screen shows an example of the Alarm/Event Properties page when an unknown Wiegand format card is badged:

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

The following screen shows an example of the Alarm/Event Properties page when an unknown ABA format card is badged:

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

### Hint

{% hint style="info" %}
**Editing Universal Card Formats**

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) for the procedure on how to edit a Universal Card Format.
{% endhint %}


---

# 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/universal-card-format/adding-a-new-universal-card-format.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.
