PROCESS TO INTEGRATE SHAPENET WITH BRIVO

PROCESS TO INTEGRATE SHAPENET WITH BRIVO

1. Client fills out PDF form and submits to Brivo.

2. Brivo will send Brivo API credentials to ShapeNet Support.

Here is an example email:
"Bruce and Eric,
I have not received the API credentials from Brivo for Figure by Faith. Did you send the Brivo OnAir API Account Access Authorization Agreement to Deb? She needs to fill out the form and submit it to Brivo so that I can get the API credentials needed to integrate her Brivo account with ShapeNet.
The form is attached.
Thanks."

3. Ask the dealer or installer to create a Brivo Senior Admin account for ShapeNet SysAdmin to use.

Here is an example email:

"Hi JW,
When you have the opportunity, would you please create a senior admin account for me in the Figure by Faith Brivo system?
Thanks."

4. The installer should also create a Senior Admin/Master Admin account in the Brivo portal for the client.

**As an alternative, ask the client to provide access to the client's Brivo portal so that ShapeNet sys admin can create a Brivo senior admin account.

Here is a model email for creating Senior Admin Brivo account for Integration:

"Hi Cari,
I will be handling the integration of your ShapeNet system with Brivo.
In order to accomplish this, we need to create an additional Senior Administrator account in your Brivo portal. This new account will be used to link your ShapeNet system with your Brivo portal.
Would you please give me your Brivo portal credentials so that I can log on to create the new Senior Admin account.
Thanks."

5. Verify that client's cards/fobs will work with the Brivo card reader installed. Discuss this with installer and client.

If ShapeNet sells the cards to the client, the Brivo installers need to be made aware in advance of the cards the ShapeNet sales reps sell to the clients so that the installers can confirm compatibility with the card readers installed and populate the card bank. ShapeNet sales reps will know if the client purchased cards from ShapeNet.

Coordinate and communicate with the Brivo installer to ensure that cards are loaded in Brivo without assigning the card IDs to any user name. Brivo should only load card numbers -- no names assigned to the card IDs. Cards in Brivo should NOT be assigned to Members they should remain Unassigned. Card IDs loaded in the Brivo card bank should match the number range of the physical cards purchased.

Ask Brivo to confirm device (door) IDs at the client's facility.

Here is an example email sent to richard.crowder@brivo.com, edwin.reyes@brivo.com, and baudel.reyes@brivo.com:
"Would you please confirm the device (door) IDs for two mutual clients:
Client Name: Leverne Carlson Fitness Center. Address: 215 N Broadway Ave., Alden Minnesota 56009
Client Name: Fit 24. Address: 109 N. Jefferson, Minneota Minnesota 56264
Thanks."

In Brivo

All Brivo clients must be on Brivo OnAir API:

Log on to the system to be configured for Brivo OnAir
Go to Tools > System Settings > Door Access Control Settings
Select Brivo OnAir
Populate the fields with the relevant information
Click the button "Verify Brivo OnAir" to determine the Site ID and Card Format ID
Click "Save" button

7. UID and Password: these fields are populated with the credentials of a Senior Admin in the client's Brivo portal. This Senior Admin account can be created by the installer, the client, or by the ShapeNet sys admin if the Brivo Master Admin credentials for the client's Brivo portal are known.

How to create a Brivo Senior Admin account:

1. Obtain the Brivo master or senior admin credentials from the Brivo/ShapeNet client
2. Log on to the Brivo portal (brivo.com) with the master or senior admin credentials
3. Navigate to Setup>Account>Administrators
4. Click "New" in the line with Senior Administrators.
5. Complete all fields on the New Senior Administrator Page.
*The Admin Password field is the Customer's administrator password.
*This process needs to be done by the master administrator or by a senior administrator with the permissions to add other administrators.

Device Id(s): these are the the Brivo door reader (scanner) device IDs. They are provided by Brivo. Send an email to richard.crowder@brivo.com, edwin.reyes@brivo.com, and baudel.reyes@brivo.com asking them to confirm the device (door) IDs for the Brivo client. Multiple IDs are separated by pipe (deviceID1|deviceID2).

Generate file for system: field value is NONE.

Hour offset: default value is 5. This may be changed if ShapeNet shows the incorrect check-in times compared to the Brivo portal time.

API Key: this value is unique to each Brivo client. The API keys are created by Theo Higgins (theo.higgins@brivo.com). If a key is missing, ask Theo to create it. The API keys are found in the Brivo developer portal. Log on to https://developer.brivo.com/apps/mykeys (username: awang@shapenetsoftware.com, password: ShapeBrivo123!).

Client Id and Client Secret: these values are generated on the client's Brivo portal. Log on to the client's Brivo Portal > Setup > Account > Account Settings. Input the client's account name and the words "Brivo OnAir" in the Application Name and Description fields. Click the Password radio button. Leave the Redirect URI blank. Click the Create Application button to generate the Client ID and Client Secret.

Site Id and Card Format Id: the values for these fields are generated by clicking on the "Verify Brivo OnAir" button after all other fields are filled in.

In Shape

On the client's ShapeNet website, log on as shapeadmin and go to the Brivo Event Subscriptions page (Tools > Security > Manage Brivo Events). Click on the "Create Subscription(s)" button in the "Brivo OnAir Subscription Information" section. The system will display the confirmation that "Your system IS capturing Brivo check-ins!"

Do NOT create a subscription in the "Brivo DataSync Subscription Information" section.
Only the "Brivo OnAir Subscription Information" section should have an active subscription.

Click on the "View Members" button > Search > click on "Access Control" for any active member > make sure there is a BRIVOONAIR section.

NOTE: If a value in Door Access Control Settings has to be changed (because it's wrong, etc.), first remove the current subscription, then change the value in Door Access Control Settings, then create a new subscription. The new subscription will NOT require loading the users again (via clientURL/Users/BrivoLoadShapeUsers.aspx -- see below)

For the Client

Call or email the client to explain that the users in ShapeNet must have IDs assigned that match the Brivo card pool ID range. After this is done, ShapeNet sys admin can run the sync to bulk load the ShapeNet users into the Brivo card bank.

Here is an example email:
"Hi Jenny,
As a follow-up to our phone conversation, please let me know when you've assigned all your ShapeNet users card IDs that match the Brivo card bank range.
As soon as that's done, I will run the ShapeNet sync with Brivo to assign the users to their corresponding IDs in the Brivo card pool.
Thanks."

Here is another example email:
"Hi Deb,
Your Brivo and ShapeNet systems are integrated, which means that you can individually add new users in ShapeNet, and the users will appear in the Brivo card pool with the same ID that was assigned in ShapeNet. You can do this any time you want.
I can also run an initial sync to bulk-load your ShapeNet users into Brivo. This requires that all your ShapeNet users have IDs assigned that match the Brivo card pool ID range. The card IDs correspond to the physical cards that you have issued to your members. It also requires that the Brivo card pool is loaded with ID numbers only--no users are assigned to the Brivo card pool. The sync will automatically assign ShapeNet users to their corresponding IDs in Brivo, as long as those IDs are unassigned in Brivo. The initial sync only happens once when the ShapeNet and Brivo systems are first integrated. Subsequent user accounts are created individually in ShapeNet and automatically appear in Brivo.
If you have time, I can call you and show you what I mean."

Prerequisites for running the ShapeNet-Brivo sync:
*The Brivo installer confirms the Brivo hardware is installed and compatible
*The Brivo installer loads the Brivo card pool unassigned
*There are users in ShapeNet that have card IDs assigned that match the range in the Brivo card pool
*Brivo OnAir API is configured in the ShapeNet system
*The client specifies the Brivo group that the Shape members are assigned to

After the above requirements are met, do this to sync ShapeNet members to Brivo in bulk (which will assign the correct users to their respective IDs in the Brivo card pool):
1. Log on as shapeadmin
2. Navigate to the following URL: clientURL/Users/BrivoLoadShapeUsers.aspx (for example, https://shapetechnology.cshape.net/Users/BrivoLoadShapeUsers.aspx)
3. Select the Brivo group that Shape members will be assigned to (via checkbox). DO NOT RUN THE SYNC WITHOUT SELECTING A GROUP. If you do shape will have to be manually updated one member at a time.
4. Click the "Send Shape Users to Brivo" button.
This process will assign shape users to brivo with the same card id as what they have in shape.

Notify the client when the sync begins. Here is an example email:
"The sync is in progress. You can keep track of it in the System Audit Trail.
The automated sync bulk-loads only those ShapeNet users possessing Card IDs. These users will be added to the "Visitors" Brivo group, as requested."

Notify the client when the sync finishes. Here is an example email:
"System Audit Trail indicates the Brivo sync completed. There were some failures associated with users possessing card IDs outside the Brivo card pool range.
The automated sync bulk-loads only those ShapeNet users possessing Card IDs within the Brivo card pool range. These users were added to the "Visitors" Brivo group.
Now that ShapeNet is integrated with Brivo, you can use ShapeNet to manually add users to any Brivo group at any time, but this is done one user at a time."

OPTIONAL alternative to the ShapeNet-Brivo sync (add members to Brivo one at a time): Log on to the ShapeNet system > Functions > Users > Add User > Click the "Select Available Card Ids" link to choose an available ID from the Brivo card pool > Save > Access Control > Select the appropriate Brivo group, expiration date and click the "Update User" button.

Process is similar for adding an existing user to Brivo (edit user > assign card and access control as above)