IR WIKI

Scanner

5 min read

Overview

Integriti Scanner Integrations enable 3rd party scanner devices to capture identification data and prefill Integriti Users and Visitors. This streamlines enrolment by automatically populating user details from scanned IDs such as passports, smart cards, and other identification documents.

Key differences from other Integriti integrations:

  • Client-side operation — Scanner integrations run on the client process, not on Integriti Integration Servers. Scanner devices are typically connected locally to the client machine.
  • Auto-loading devices — Scanner devices are automatically loaded and made available when the “Add User Details From Scanner” dialog opens. No manual Refresh Child Devices is required.
  • No persisted connections — Scanner integrations do not maintain persistent connections. Device state monitoring, alarms, and events are not supported.

Prerequisites

Licensing

  • Integriti Version License — A specific version of Integriti must be licensed. The installer warns if not met; the integration is disabled until sufficient licensing is added.
  • Feature Licenses — Some integrations require additional licenses. See the individual integration’s Release Notes.

System Requirements

Refer to the individual integration’s manual for specific requirements. If none are mentioned, the integration shares requirements with the minimum supported Integriti version or installs prerequisites via its own installer.

Hardware

  • A supported scanner device connected to the client PC and powered on.
  • Scanner integrations must be installed on both the Integriti Integration Server and client workstations.

Step-by-Step

1. Installation

  1. Close all instances of the Integriti software suite on the target PC.
  2. Stop all running Integriti services (if installing on the Integriti server).
  3. Download and run the Integriti Scanner Integration installer on all Integriti servers first, then on all client workstations that will interact with the integration.
  4. Restart all services that were stopped.

If reverting to an earlier version, uninstall the currently installed version first.

2. Enrolment

  1. In Integriti System Designer, select New Integrated Device from the System tab.
  2. Select the scanner integration from the list and press Ok.
  3. Give the device a Name and optionally Notes.
  4. Connection Configuration — Under the Device Properties tab, configure integration-specific properties for connecting to the scanner/3rd party system. Refer to the individual integration’s manual.
  5. Click Save.

The same version of the integration must be installed on both the Integration Server and the client workstation. If it does not appear in the list, ensure both 32-bit and 64-bit Integration Servers are running.

3. Entity Import Mappings

Entity import mappings specify what ID properties are retrieved from the scanner. Complete this before creating Users or Visits.

  1. Create all required User Custom Fields first (see System Configuration Handbook, Section 19.5 Custom Fields). Custom fields not created beforehand will not be available for mapping.
  2. In the scanner integration editor, configure import mappings to map scanner data properties (name, surname, DOB, expiry date, address, etc.) to Integriti fields.
  3. Save the integrated system and close the editor.

4. Create User Workflow

  1. Create Custom Fields — As needed for ID properties not covered by standard Integriti User fields.
  2. Enrol Integration — Install and enrol per the Configuration section above. Ensure the scanner is connected and powered on.
  3. Entity Import Mappings — Configure per the section above.
  4. Create User — Navigate to the Users entity list (Intruder tab) and click Add New. In the user editor:
    • a. Click Scan User Identification to open the “Add User From Scanner” dialog. If the button is not available, no scanner integrations are installed.
    • b. Select Integration — Choose the scanner integration from the dropdown.
    • c. Select Scanner Device — Choose the scanner device from the dropdown (devices auto-load when the dialog opens).
    • d. Select ID Type — Choose the ID/document type to scan (e.g., passport, smart card).
    • e. Scan Identification — Click to start scanning. Follow prompts for dual-sided scanning if applicable.
    • f. Verify User Info — Review and edit the scanned data (photo on left, user info on right). The displayed fields correspond to entity import mappings.
  5. Click Ok to populate the new user, then click Save on the user editor.

5. Create Visitor Workflow

Scanner integrations work with Integriti’s Visitor Management features. The workflow mirrors Create User above, except:

  • In step 4, open the Visitor Manager Visit dialog and press the Scan Visitor ID button instead of opening from the User editor.
  • The dialog populates both the visitor’s user record and visit settings (First Name, Second Name, and custom fields).

Refer to the “Guide — Visitor Management” and “Adding Visits” section for full details.

Verification

  • The scanner integration appears in the New Integrated Device dropdown after installation.
  • The Scan User Identification button appears in the User editor.
  • Scanner devices auto-populate in the “Add User From Scanner” dialog dropdown.
  • Scanned ID data correctly maps to user fields per entity import mappings.
  • Users and Visitors are successfully created with scanned data.

Troubleshooting

IssueChecks
Plugin doesn’t appear in New Integrated Device listAre both 32-bit and 64-bit Integriti Integration Servers running? Restart both servers and the System Designer client.
Scan User Identification button doesn’t appear in User editorIs a scanner integration installed? Install one and try again.
Scanner device not appearing in dropdownEnsure the scanner is connected to the PC and powered on. Verify the integration is correctly installed.
User fields not populating correctlyCheck Entity Import Mappings — ensure custom fields exist before mapping. Verify the correct ID Type is selected.

Graph View

Backlinks