Integration overview

2024-02-01

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.	What is ClearID?. How is ClearID different from traditional access control systems?. About workflows. Supported features list for ClearID. Supported languages.
2	Before installing the plugin, read the release notes to learn about the new features.	What's new in ClearID.
3	Familiarize yourself with the common terms and their equivalents in Security Center.	ClearID terminology.
4	Learn about the different components and how they connect.	How the integration works. About ClearID architecture. ClearID subprocessors list. About ClearID information security.
5	Learn about key features and understand the product.	ClearID videos.
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.	Compatibility. System requirements. Firewall ports.
2	Learn about the devices that are supported for use with ClearID.	Supported devices.
3	Familiarize yourself with deployment best practices.	Best practices. Setting up ClearID for a new Synergis system. Setting up ClearID with an existing Synergis system.
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.	Downloading and installing 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.	Creating the plugin role.
3	Connect Security Center to ClearID. Note: For environments with multiple systems, repeat these tasks for each system.	Connecting Security Center to ClearID. Reviewing cardholders and identities information. Adding a system. Downloading an activation file. Configuring connection settings.
4	Grant users the privileges they require to use the plugin. Note: Security Desk operators do not need special privileges to use this plugin.	Granting user privileges. Refer to the topic "Assigning privileges to users" in the Security Center Administrator Guide. For a list of all available privileges, refer to the Security Center privileges spreadsheet for your version.
5	Learn about system states.	About ClearID system states.
6	Learn about identity fields.	Identity fields.
7	Learn about custom fields.	About custom fields. Modifying custom fields. Custom fields relationships.
Manage identities and users
1	Create, view, or modify your identities.	Creating identities. Viewing identities. Modifying identities. Granting additional permissions for identities and roles. Granting additional permissions for supervisors. Viewing additional permissions. Modifying additional permissions. Deleting identities
2	Grant users or administrators access to the web portal.	Granting user access to the web portal. Granting administrator access to the web portal.
3	View your profile.	Viewing your profile.
4	View your site and area access.	Viewing your site and area access.
5	Learn about and submit access requests.	About access request workflow. Requesting access.
6	Add your supervisors.	Adding supervisors manually.
7	View and manage direct reports.	Viewing direct reports. Managing direct reports. Transferring direct reports.
8	Learn how to reset user passwords.	Resetting user passwords.
9	Learn about email notifications sent by ClearID.	About email notifications. Customizing the email banner for sites.
10	Learn about delegation.	About delegation. Delegating tasks to another user.
11	Understand the different user levels and what they can do.	User levels.
12	Learn about and submit identity requests.	About identity request workflow. Creating an identity template. Requesting identities. Requesting an identity. Requesting multiple identities using a CSV import. Canceling identity requests Approving identity requests About identity requests report Checking the status of identity requests
Manage your sites
1	Learn about sites.	About sites.
2	Create your sites in ClearID.	Creating sites.
3	Enable visitor management for sites.	Enabling visitor management for sites. Viewing sites where a user can invite visitors.
4	Grant users permission to access ClearID.	Granting access to the web portal.
5	Learn about access reviews.	About access reviews.
6	Set up access reviews.	Setting up area access reviews. Scheduling area access reviews. Setting up identity access reviews. Scheduling identity access reviews.
7	Learn about access reviews report.	About access reviews report.
8	Check the status of access reviews.	Checking the status of access reviews.
9	Complete an access review.	Completing an area access review (site owner). Completing an area access review (area approver or role manager). Completing an identity access review (supervisor).
10	Generate an access reviews report.	Generating an access review summary.
11	Learn about access requests report.	About access requests report.
12	Check the status of your access requests.	Checking the status of access requests.
13	Learn about site activity report.	About site activity report.
14	Learn about and manage webhook integrations.	About webhooks. Creating webhooks. Modifying webhooks. Viewing webhook logs.
Manage your areas
1	Learn about areas.	About areas.
2	Create your areas in ClearID.	Creating areas.
3	Add doors to areas.	Adding doors to areas.
4	Enable visitor management for your areas.	Enabling visitor management for areas.
5	Learn about nested areas and access rules	About nested areas Granting access to areas automatically
6	Add your area managers.	Adding area managers.
7	Add your area schedules.	Adding schedules to an area.
8	Grant people access to an area.	Granting access to an area.
9	Review who has access to your area.	Reviewing area access.
10	Approve requests for access to your area.	Approving area access requests.
11	Reject requests for access to your area.	Rejecting area access requests.
Manage your visitors
1	Learn about visit request workflows.	About visit request workflow. About visit request watchlist workflow.
2	Invite visitors.	Inviting visitors. Inviting visitors manually. Inviting visitors using a CSV import.
3	Review visit events.	Reviewing visit events.
4	Copy a visit event.	Copying a visit event.
5	Modify a visit event	Modifying visit events.
6	Learn about visitors report.	About visitors report.
7	View a visitors report.	Viewing a visitors report.
8	Learn about QR codes as a credential for visitors.	QR codes as a credential for visitors.
9	Import the custom card format (QR code credential).	Importing a custom card format (QR code credential) in Synergis.
10	Enable QR code credentials for visitors.	Enabling QR code credentials for visitors.
11	Configure Qscan barcode readers for ClearID.	Configuring Qscan devices for ClearID. Connecting a Qscan barcode reader to a Mercury Controller. Configuring Qscan barcode reader to support 40-bit hexadecimal QR codes.
12	Configure STid devices for ClearID.	Configuring STid devices for ClearID. About STid QR code readers. Creating an STid QR code reader configuration. Transferring your reader configuration to your STid QR code reader.
13	Configure macro for automatic check-in and access to a parking entrance or gated facility.	Automating visitor access and check-in using a macro.
Managing visitor watchlists
1	Learn about watchlists.	About watchlists.
2	Add your watchlist managers.	Adding watchlist managers.
3	Add your watchlists.	Adding watchlists. Adding an individuals watchlist entry. Adding a companies watchlist entry. Importing watchlist entries from a file. Exporting watchlist entries to a file. Testing watchlist entries.
4	Screen your visitors manually	Screening visitors manually.
5	Unblock visitors blocked by a watchlist.	Unblocking visitors blocked by a watchlist.
Managing role-based access control
1	Learn about role-based access control.	About role-based access control.
2	Add your roles.	Adding roles.
3	Add your role managers.	Configuring role managers.
4	Configure your role-based access control policies.	Configuring role-based access control policies.
5	Add custom provisioning attributes to an identity.	Adding custom provisioning attributes to an identity.
6	Add your role members.	Adding role members.
Connecting other systems
1	Learn how to authenticate non-user system connections.	Authenticating your connection.
2	Synchronize identity attributes using LDAP.	Synchronizing identities using LDAP. About ClearID LDAP Synchronization Agent. LDAP attributes to ClearID attribute mappings. Configuring the ClearID LDAP Synchronization Agent.
3	Synchronize identity attributes using an API.	Synchronizing identities using an API. About the ClearID API.
4	Synchronizing identity attributes using One Identity.	Synchronizing identities using One Identity. About the One Identity Synchronization Tool. About One Identity Synchronization Tool attribute fields. Installing the One Identity Synchronization Tool. Configuring the One Identity Synchronization Tool. Reviewing synchronization status. About One Identity Synchronization Tool logs. Viewing One Identity Synchronization Tool logs. Updating existing identities from an external data source.
Visitors self-service check-in
1	Learn about Genetec ClearID™ Self-Service Kiosk.	About ClearID Self-Service Kiosk. Self-Service Kiosk check-in. Self-Service Kiosk self registration.
2	Learn about the different ClearID Self-Service Kiosk options that are available.	Self-Service Kiosk options. Kiosk floor stand. Kiosk floor stand printer shelf. Kiosk tabletop stand.
3	Learn about the Identity Document (ID) types that the ClearID Self-Service Kiosk ID scanning function supports.	Identity document types.
4	Configure your ClearID Self-Service Kiosk.	Configuring the Self-Service Kiosk iPad. Customizing the Self-Service Kiosk configuration. Customizing the Self-Service Kiosk visitor badge logo. Configuring the Self-Service Kiosk label printer (Brother QL-820NWBc, QL-820NWB, or QL-810W). Configuring the Self-Service Kiosk label printer (Brother TD-4550DNWB ). Selecting a Self-Service Kiosk label printer. 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.	Printing a test badge from the Self-Service Kiosk.
6	Reset the ClearID Self-Service Kiosk mobile app (If required).	Resetting the Self-Service Kiosk mobile app.
Troubleshooting
1	Learn how to troubleshoot issues that might occur.	Plugin installed, but missing from Security Desk and Config Tool. Plugin role could not find file with certificate. Custom fields not displayed in Security Desk. No active account found for user. Visit email notifications not received by visitors. Visitor hosts fields in Security Desk are empty. Connectivity issues (One Identity Synchronization Tool). Data synchronization issues (One Identity Synchronization Tool). Self-Service Kiosk issues. Self-Service Kiosk label printer issues. Viewing webhook logs.