Integration overview for the ClearID plugin - ClearID

Genetec ClearID™ User Guide

Applies to
ClearID
Last updated
2024-04-09
Content type
Guides > User guides
Language
English
Product
ClearID

You can integrate the Genetec ClearID™ web application with Security Center by installing and configuring the ClearID plugin and following a sequence of steps.

The following table lists the tasks required for the integration with Security Center, and how to verify that the integration is successful.
Step Task Where to find more information
Understand the prerequisites and key issues before deploying
1 Learn about what you can do using ClearID.
2 Before installing the plugin, read the release notes to learn about the new features.
3 Familiarize yourself with the common terms and their equivalents in Security Center.
4 Learn about the different components and how they connect.
5 Learn about key features and understand the product.
Deployment Preparation
1 Ensure that the plugin is installed on a server that meets the recommended system requirements and is running a compatible version of Security Center.
2 Learn about the devices that are supported for use with ClearID.
3 Familiarize yourself with deployment best practices.
Prepare Security Center
1 Verify that the Security Center license has a valid certificate for the plugin. Go to the Config Tool homepage, click About > Certificates, and confirm that the ClearID plugin is in the list.
  • Your license information is included in the license update email that we sent you. This email includes links to the download package and other license information.
  • To acquire a license, see License options.
2 To manage visitors in ClearID, verify that the Synergis™ visitor management module is enabled. Go to the Config Tool homepage, click About > Synergis™, and confirm that Visitors is in the list.
  • Your license information is included in the license update email that we sent you. This email includes links to the download package and other license information.
  • To acquire a license, see License options.
Deploy the plugin
1 On a Security Center server, download and install the plugin.
2 Create the plugin role.
IMPORTANT: Each plugin role can only connect to or communicate with one unique ClearID system name at a time. For environments with multiple systems, you must create a plugin role for each system.
3 Connect Security Center to ClearID.
NOTE: For environments with multiple systems, repeat these tasks for each system.
4 Grant users the privileges they require to use the plugin.
NOTE: Security Desk operators do not need special privileges to use this plugin.
5 Learn about system states.
6 Learn about identity fields.
7 Learn about custom fields.
Manage identities and users
1 Create, view, or modify your identities.
2 Grant users or administrators access to the web portal.
3 View your profile.
4 View your site and area access.
5 Learn about and submit access requests.
6 Add your supervisors.
7 View and manage direct reports.
8 Learn how to reset user passwords.
9 Learn about email notifications sent by ClearID.
10 Learn about delegation.
11 Understand the different user levels and what they can do.
12 Learn about and submit identity requests.
Manage your sites
1 Learn about sites.
2 Create your sites in ClearID.
3 Enable visitor management for sites.
4 Grant users permission to access ClearID.
5 Learn about access reviews.
6 Set up access reviews.
7 Learn about access reviews report.
8 Check the status of access reviews.
9 Complete an access review.
10 Generate an access reviews report.
11 Learn about access requests report.
12 Check the status of your access requests.
13 Learn about site activity report.
14 Learn about and manage webhook integrations.
Manage your areas
1 Learn about areas.
2 Create your areas in ClearID.
3 Add doors to areas.
4 Enable visitor management for your areas.
5 Learn about nested areas and access rules
6 Add your area managers.
7 Add your area schedules.
8 Grant people access to an area.
9 Review who has access to your area.
10 Approve requests for access to your area.
11 Reject requests for access to your area.
Manage your visitors
1 Learn about visit request workflows.
2 Invite visitors.
3 Review visit events.
4 Copy a visit event.
5 Modify a visit event
6 Learn about visitors report.
7 View a visitors report.
8 Learn about QR codes as a credential for visitors.
9 Import the custom card format (QR code credential).
10 Enable QR code credentials for visitors.
11 Configure Qscan barcode readers for ClearID.
12 Configure STid devices for ClearID.
13 Configure macro for automatic check-in and access to a parking entrance or gated facility.
Managing visitor watchlists
1 Learn about watchlists.
2 Add your watchlist managers.
3 Add your watchlists.
4 Screen your visitors manually
5 Unblock visitors blocked by a watchlist.
Managing role-based access control
1 Learn about role-based access control.
2 Add your roles.
3 Add your role managers.
4 Configure your role-based access control policies.
5 Add custom provisioning attributes to an identity.
6 Add your role members.
Connecting other systems
1 Learn how to authenticate non-user system connections.
2 Synchronize identity attributes using LDAP.
3 Synchronize identity attributes using an API.
4 Synchronizing identity attributes using One Identity.
Visitors self-service check-in
1 Learn about Genetec ClearID™ Self-Service Kiosk.
2 Learn about the different ClearID Self-Service Kiosk options that are available.
3 Learn about the Identity Document (ID) types that the ClearID Self-Service Kiosk ID scanning function supports.
4 Configure your ClearID Self-Service Kiosk.
NOTE: The Brother TD-4550DNWB printer is no longer available for purchase through Genetec. We now support and sell the Brother QL820NWBc (CD-KIOSK-PRINTER-NA-KIT).
5 Test your visitor badge printing.
6 Reset the ClearID Self-Service Kiosk mobile app (If required).
Troubleshooting
1 Learn how to troubleshoot issues that might occur.