Key Configuration Options

The Key Configuration Options page allows you to configure the Keys module to suit the needs of your organization. From this page you can configure key template types, key template statuses, key template requirements, and key copy statuses.

To open the Key Configuration Options page:

Open the Administration Menu page.
Under the KEYS ADMINISTRATION heading, click Key Configuration Options.

Key Template

A key template refers to the definition of a key, for example, the type, status, and features of a key. The actual physical keys that are created from this definition are referred to as key copies. The Key Template tab allows you to configure which types and statuses can apply to a key template and to specify which fields are required in the creation of a new key template.

To access key template configuration options, click the Key Template tab.

Key Template Type

A key template type determines the type or classification of a key template, for example, grand master or change key. The following key template types are available by default:

Grand Master – opens all locks
Master – opens a subset of all locks
Sub-Master – opens a subset of the locks that the master opens
Operation – opens a single lock

To create a new key template type:

In the New Key Template Type field, enter the name of the template type.
Click the Active toggle to set the desired status.

The new key template type status is active by default.
Click the Add button.

The new template type appears in the template type list.

You can do any of the following to configure existing template types:

To rearrange the key template type order, drag-and-drop the template types.

The order specified on this page controls the display order in the drop-down menu for the Key Type field on the Create Key page.
To configure whether a key template type is active or inactive, click the Active toggle.

Only active template types appear in the drop-down menu for the Key Type field on the Create Key page.
To edit a template type’s name:
1. Click the pencil button.
  
  The system highlights the name to allow edits.
2. Type the new template type name.
3. Click the green check mark to confirm the new template type name or click the red X to clear any changes to the name.
To delete a template type, click the trash can button. You can not delete a key template status that is currently in use.

Key Template Status

A key template status indicates whether a key template is active, inactive, retired, and so on. The default statuses available are Active and Inactive. Key templates cannot be deleted from the system. However, unneeded key can be made Inactive.

To create a key template status:

In the New Key Template Status field, enter the name of the template status.
Click the Active toggle to set the desired status.

The new key template status is active by default.
Click the Add button.

The new template status appears in the template status list.
Click Save.

You can do any of the following to configure existing template statuses:

To rearrange the key template status order, drag-and-drop the template statuses.

The order specified on this page controls the display order in the drop-down menu for the Status field on the Create Key page.
To configure whether a key template status is active or inactive, click the Active toggle.

Only active template statuses appear in the drop-down menu for the Status field on the Create Key page.
To edit a template status’s name:
1. Click the pencil button.
  
  The system highlights the name to allow edits.
2. Type the new template status name.
3. Click the green check mark to confirm the new template status name or click the red X to clear any changes to the name.
To delete a template status, click the trash can button. You can not delete a key template status that is currently in use.

Key Template Requirements

The fields listed in the Key Template Requirements pane further define a key template. You can set each field as Required or Not Required for the creation of a key template. By default, all the fields listed (other than the Name field) are set to Not Required. These requirements apply to all key template types; they cannot be set individually for particular key templates

The following fields are available:

Hook Number — the hook location of the key template
Keyway — the shape of the keyhole of the lock cylinder
Key Cut 1 — identifying information of the first key cut
Key Cut 2 — identifying information of the second key cut
Key Code — the value used to classify or group a set of keys
Increment — the depth of the key cut

To mark a field as a required field:

Click the Not Required toggle corresponding to the field.

The toggle switches to Required, indicating that the field is a required field on the Create Key page.
Click Save.

Key Copies

Key copies refer to the actual physical keys that are created from a key template. The Key Copies tab allows you to configure which statuses can apply to a key copy, for example, Issued, On Hand, or Destroyed.

To access key copy status configuration options, click the Key Copies tab. The following key copy statuses are available by default:

Issued – This value indicates that the key copy has been issued to a key holder.
On Hand – This value indicates that the key copy is on hand and has either not been issued to a key holder or was issued and returned.
Destroyed – This value indicates that the key copy was destroyed and is no longer in on hand.
Stolen – This value indicates that the key copy was reported stolen and is currently missing.

Important!

Do not delete, inactivate, or rename the Issued and On Hand statuses. These statuses are tied to other system functions which could be broken if the statuses were changed. The ability to rename these values will be available in a future release.

To create a key copy status:

In the New Key Copy Status field, enter the name of the key copy status.
Click the Active toggle to set the desired status.

The new key copy status is active by default.
Click the Add button.

The new status appears in the key copy status list.
Click Save.

You can do any of the following to configure existing key copy statuses: