PREREQUISTES
Admin permissions are required to configure this integration. (See Step 0).
Please whitelist the following IP addresses for inbound and outbound communication:
54.84.138.6054.84.66.109
Verify your Unity instance public IP and port. Please whitelist the port alongside the above IPs.
Envoy does not support self-signed SSL/TLS certificates. Envoy requires a certificate that chains to a public root CA.
To use Workplace auto sign-in, Envoy must connect with your Transaction database. You'll need to open a Transaction port on your ACM Appliance and create credentials to access it. For more information, see Avigilon's support center.
Overview - How does Avigilon work with Envoy?
Visitors
Envoy will record every visitor who signs in on the iPad in the Avigilon event log and automatically create an identity for each new visitor.
You can configure Envoy to apply a certain identity type, site location, building, and/or role to your visitor records. Then you can use all of Avigilon’s features for your visitors, including badge provisioning, security alerts, and more.
Employees
You can automatically collect employee badge data via Envoy Workplace, making it easy to track current occupancy and attendance. Learn more about employee auto check-in.
Setup
Step 0: Create an admin account in Avigilon
To connect Envoy with Avigilon Unity Access, the account you use must have the Super Admin role assigned in Avigilon.
⚠️ Note: Without Super Admin access, the integration will not function properly.
Step 1: Info - Whitelist IP addresses
Navigate to Integrations > All Integrations.
Under Access Control, find Avigilon. Click Install to begin the process.
For the integration to work and connect to your Avigilon instance, please allowlist the following IP addresses:
54.84.138.6054.84.66.109
Click Next Step once complete.
Step 2: Login
Enter your Avigilon username under Username.
Enter your Avigilon password under Password.
Provide your Avigilon instance URL, including the port if used.
Click Next Step.
Step 3: Visitors
Not using Visitor functionality? Click the Skip button to proceed to workplace settings.
You can automatically provision access to your visitors by sending their sign-in information to Avigilon Unity. This step determines how visitors will be assigned Identities in Avigilon.
To enable:
(Optional) Site location: Add your Site, if used.
(Optional) Building: Add your Building, if used.
Visitor Types: Choose which sign-in flow/visitor type you would like to grant access credentials and the corresponding Avigilon role. You can assign multiple flows to the same Avigilon role.
Log Only: You can check this option if you only want your visitors to be logged in Avigilon. No tokens will be activated if this is checked.
Invite required: You can check this option to require invites before issuing credentials in Avigilon.
Early Access: If you want to issue access to visitors before their scheduled arrival time, you can set the duration here.
Access Duration: Set how long your invited guests will receive access for.
Select a credential type: Select a credential type used for your visitors, Card or PIN. These have different setup requirements.
Card: Select the card credential type you will be using - Badge or QR Code.
Badge: Set the card number minimum and maximum.
QR Code: Set the card number minimum, maximum, and facility code.
PIN: Set the card number minimum and maximum.
Once you've provided the required information for the credential type, click Next Step.
Step 4: Set up Employee Options
Not using Workplace functionality? Click the Skip and Complete button to finish setting up your integration.
Auto Check in with badge swipe (most common)
Envoy offers the option to have employees automatically checked in to Envoy when they swipe their badge with Avigilon Unity. Employees will appear in the Employee log as they enter the building.
This data is then populated into our Occupancy Dashboard to provide valuable insight into the optimization of your specific workplace environment.
To use auto check-in, you cannot use any employee registration flows.
For more information about Transaction Connect Ports, please see Avigilon Unity's documentation.
To enable:
Select Auto check-in with badge swipe.
Doors: Select which doors to monitor for employee entries. These are pulled from your Avigilon system.
(Optional) Exclude Employees: Select any employees to be excluded from Workplace auto check-in.
Login Credentials: You might have a separate set of login credentials, depending on your Unity configuration. If you have the same credentials used in Step 2, check Use Login Credentials. If not, provide -
Database Username:
Database Password:
Database Port:
Once all fields are filled out, click Complete Setup to save the configuration.
Check-in required for access
Alternatively, you can only grant employees access in Avigilon Unity when they check in to the Envoy Workplace, ensuring that only approved employees can access the workplace.
To restrict employee access to the workplace:
Select Check-in required for access.
Doors: Select which doors to monitor for employee entries. These are pulled from your Avigilon system.
Exclude Employees: This option allows you to select employees to entirely exclude from Envoy Workplace functionality. Suggested for employees who need 24/7 access to the building.
Enable During Sign-In: This option enables employee badges after they sign in to Workplace via Envoy.
Disable During Sign-Out: This option disables employee badges during sign-out in Workplace.
Click Complete Setup to save the configuration.
What do visitor entries look like in Avigilon Unity?
It's always recommended to do a test run of your configuration to confirm that everything is working as intended.
Sign in as a test visitor to ensure your visitor entry is logged in the Avigilon event log.
Log into your Avigilon instance.
Your test visitor record will appear in the event log.
Note: Visitor name will appear in the source column, and the last name and first name columns correspond to your Avigilon admin name.
You can search for all of your visitors based on the identity type.
You can also examine and adjust each visitor’s individual identity.
