Keylocker

Keylocker Integration

Overview

Integriti Keylocker Integrations allow managing keylocker users and monitoring 3rd party keylocker systems directly from the Integriti software suite, providing a single head-end for day-to-day management and system monitoring.

Key features:

• User Synchronisation — Create and update users on the 3rd party keylocker system directly from Integriti, easing administration and mitigating data entry inconsistencies.
• Event Monitoring — Pull events and alarms from the keylocker system into Integriti Review, leveraging Integriti’s alarm management and reporting capabilities.

Prerequisites

Licensing

• Check the individual integration’s Release Notes for any required licenses.
• Sufficient Integriti Version License for the integration version.

System Requirements

Refer to the individual integration’s manual for specific pre-requisites and system requirements.

Version Matching

The same version of the integration must be installed on both the Integriti Integration Server and all client workstations.

Step-by-Step

Installation

1. Close all Integriti software instances and stop all running Integriti services.
2. Download and run the Integriti Keylocker Integration installer on all Integriti servers first, then on all client workstations.
3. After installation, restart all previously stopped services.
4. If downgrading, uninstall the current version before installing an earlier version.

Enrolment

1. In Integriti System Designer, select New Integrated Device from the System tab.
2. Select the keylocker integration from the list and press Ok.
   • If the integration does not appear, ensure both 32-bit and 64-bit Integriti Integration Servers are running.
3. Give the new device a Name and optionally Notes.
4. Set Persisted Connection Run Mode:
   • Automatically Maintain Connection on Any Single Server (recommended) — ensures one server always connected; auto-failover in HA systems.
   • Maintain Connection on the Specified Server — use if only one server can connect.
   • Simultaneously Maintain Connection on All Servers — may cause duplicate Review records.
   • Disabled — use only if event/state monitoring is not required.
5. On Device Properties tab, configure Connection Configuration — connection details to the 3rd party keylocker system.
6. Under Events/Alarms, configure the desired review categories/transitions that will generate Review.
7. Click Save.
8. Click Refresh Device (if available) to load system objects like keylockers from the 3rd party system.
9. Save and close — a persisted connection will start automatically.

User Synchronisation

Preparing Users to Synchronise

Keylocker Integrations use custom fields on Integriti users to control synchronisation:

1. A checkbox custom field indicates whether a user should be synchronised to the keylocker system.
2. Additional custom fields may be required for keylocker-specific information (e.g., permission assignments). Check the integration’s manual for specifics.
3. Fill in all required custom fields, tick the synchronisation checkbox, and save the user.
4. On first save, the user is created on the keylocker system. Subsequent saves automatically synchronise updates.
5. Validation errors are logged in Integriti’s Log Viewer — correct the issue and re-save.

Accessing Custom Fields Without a Property Grid

Some entity editors (e.g., Permission Groups) lack a property grid, hiding custom fields. To expose them:

1. Click the layout customisation button or right-click the editor and select Customise Layout.
2. In the Hidden Items tab, find the custom fields.
3. Drag desired custom fields onto the editor layout.
4. Click Save to Current Set to persist the layout.

Removing Users

• Untick the synchronisation checkbox custom field, or
• Delete the user from Integriti while the checkbox is ticked.

Either method removes the user from the keylocker system and stops future synchronisation.

Event Monitoring

Once enrolled (persisted connection enabled), events/alarms from the keylocker system automatically generate Review Records in Integriti, with the integration name prepended in square braces.

Filtering Events:

• Connection Configuration — may offer checkboxes/dropdowns to enable/disable specific event types.
• Generate Review Transitions — select Categories to generate Review; unselected categories are not monitored. Configured on the enrolled Integrated Device.

Keylocker Events as Triggers

Use keylocker events to trigger Scheduled Tasks and Alerts:

1. Add a Review Trigger to the Alert/Scheduled Task.
2. Set grouping type to And (not Or).
3. Add a Category Equals row, selecting the Integration Review Category/ies.
4. Optionally add a Text Contains [<IntegrationName>] row to filter by a specific keylocker integration.
5. Save — matching keylocker events will activate the trigger.

Anti-passback Access Revoking Using Keylocker Review

Prevent users from accessing certain doors/areas while they hold unreturned keys:

1. Create an Integer Custom Field on Users to track the number of keys held.
2. Create a Credit Qualification:
   • Increment on Key Removal events.
   • Decrement on Key Return events.
3. The Qualification is Valid when value > 0, Invalid when value ≤ 0.
4. On a permission, set When to this Qualification and Is to Invalid — the permission is only active when the user holds zero keys.

Invoking Commands

(Supported integrations only)

• Right-click the keylocker integrated device and select Invoke Integrated Device Command.
• Choose the command, configure options, and press Ok.
• Refer to the individual integration’s manual for available commands and options.

Verification

1. After enrolment, verify the connection to the keylocker system is active.
2. Prepare a test user with required custom fields, tick the synchronisation checkbox, and save — confirm the user appears on the keylocker system.
3. Update the user’s details in Integriti and verify changes propagate to the keylocker system.
4. Generate a keylocker event (e.g., key removal) and confirm a Review Record appears in Integriti.
5. Set up a Review Trigger on a keylocker event category and confirm alerts/scheduled tasks fire correctly.
6. Test the anti-passback pattern: take a key, verify the user’s qualification becomes Valid and the restricted permission becomes inactive.

Troubleshooting

Issue	Resolution
Plugin does not appear in ‘New Integrated Device’ list	Ensure both 32-bit and 64-bit Integriti Integration Servers are running. Restart both servers and System Designer.
User not synchronising to keylocker system	Verify the synchronisation checkbox custom field is ticked. Check all required custom fields are filled. Look for validation failure logs in Integriti’s Log Viewer.
Custom fields not visible	Customise the editor layout — drag hidden fields from the Hidden Items tab onto the layout and save.
Events not generating Review Records	Verify Persisted Connection Run Mode is not Disabled. Check Generate Review Transitions — ensure desired categories are selected.
Commands not available	Not all integrations support Invoke Command — check the integration’s capabilities guide.

Related Pages

• Integriti Communication Handlers
• Integriti Comms Tasks Automation