Configure ID Mask

Masks are used to extract values from specific positions of a badge ID. When you select a standard reader type from the [Mask type] drop-down, the corresponding ID mask is automatically applied when the badge ID is read.

*Celiveo uses HID Type B (OMNIKEY 5×27 CK) card reader.

To configure ID mask under Authentication Source Profile in Web Admin:

Select a reader card type to apply an appropriate ID mask or configure a custom mask.

Select reader type

At [Mask type], select a reader type and click [Save]. The relevant mask will be applied.

Configure custom ID mask

1. At [Mask type], select [Custom Mask].
2. At [Extraction Mask], Enter the extraction mask to apply to the badge number string.
   • The mask allows the extraction of a smaller value from a badge value. It can consist of values ‘1’ and ‘X’. ‘1’ retains the digit, ‘X’ removes the digit.
3. Select the alignment of the extracted mask.
4. Set the values of [Custom Extraction].
   • (for HID Prox badges only) Enter the first and last bit numbers for the site code followed by the first and last bit numbers of the badge number. This allows for the extraction of a range of bits from a badge. The mask is a ‘D’ followed by a 12-digit string D’aaabbbcccddd’ where:
     • ‘aaa’ is the first bit number for the badge site code
     • ‘bbb’ is the last bit number for the badge site code
     • ‘ccc’ is the first bit number for the badge number
     • ‘ddd’ is the last bit number for the badge number

Once settings are complete, click [Save].

HID Card Data Formats

Knowledge of the card format allows to properly decode the data. The 26-bit Wiegand standard format is the industry standard used globally. You can also learn more about HID Card Data formats in the article here.