Overview
The Envoy + Protege GX integration provides a range of options for managing access for both visitors and employees.
For Visitors, access can be granted to your guests with either invites or sign-ins, and Envoy will create user records in Protege GX accordingly.
For Workplace, Envoy can import badge event activity and sign-in employees based on badge swipes. This data will populate in the Employee log and be used in the Occupancy and Attendance reports.
Requirements
PREREQUISITES
Admin permissions are required on your Protege GX system to complete this installation. Please contact your IT team or the manager of your Protege GX account if you need this access.
For on-premise systems to work with Envoy’s cloud solution, the internal IP address for the instance must be NAT’d from a publicly accessible IP address or URL. Alternatively, a DMZ or proxy service may be used to ensure the instance is accessible to Envoy.
The following IPs must be whitelisted for inbound and outbound communication:
18.204.164.109
52.6.210.64
52.86.90.108
The following ports must be whitelisted for inbound and outbound communication:
443 (if you plan to use HTTPS) - HTTPS requires an SSL Cert
Installation
Step 1: Set up API Access and connect Site
Navigate to Apps > All Apps and search for ProtegeGX in our app store. Click Install to begin the configuration process.
Click Authorize to allow the integration to access the data from your Envoy account.
Enter your ProtegeGX instance URL, username, and password to login to your account.
Select the site you wish to use with this location of Envoy, the click Next Step.
Step 2: Configure your Visitors settings
Decide how you'd like to allow Visitors access to your workplace.
(Optional) If you want to restrict access to walk-ins, check the box next to Only Allow Invited Guests. If you leave this unchecked, all flows will be provisioned access in Protege GX.
Set any early access limits. Limits are from 15 minutes to 8 hours prior to their scheduled arrival.
Set the access duration for your visitors. Limits are from 1 to 24 hours.
Envoy Visitor Types: Choose which sign-in flow/visitor type you would like to grant access credentials and the corresponding Protege GX Access levels.
The admin for GX will need to create (in advance) an appropriate access level(s) to be assigned during this configuration step.
Once you've added your visitor types and credential levels, click Next Step.
Step 3: Configure your Workplace settings
To use Protege GX with Envoy Workplace, you'll need to create the following:
Event Filter (detailed setup instructions on p.138 of ICT's setup guide)
Event Report (detailed setup instructions on p.151 of ICT's setup guide)
Event filters sort and categorize event and alarm data. The Envoy integration looks for events to which access is granted.
Navigate to the Events menu to create a filter.
Click Add to select the event types that will be included by the filter. The event types are sorted into categories. You can select event types and categories by highlighting them and clicking OK or by dragging and dropping them into the main window.
Once you have an event filter set, you can create an event report that returns all events with the relevant filter applied.
Navigate to the Reports | Setup menu. Create a new report.
Click Add to select the event filter configured in the previous step.
Configure auto-sign-in, which will populate your employees' data into the Employee log when they enter the workplace using their Protege GX credentials.
Select the Event report created that includes employee email information.
Select the controller you wish to use for Auto sign-in.
The admin of your GX system will need to inform you of which GX controller Envoy will be monitoring badge events.
(Optional) Select any exempt employees.
Click Complete setup to finish and save.