Calendar Driver
How to Configure the Calendar Driver on PlaceOS
The PlaceOS Calendar Driver connects to Microsoft Graph API (365) or Google Workspace.
The Calendar Driver and the Bookings Driver work together to get resource calendar events.
The Calendar Driver can also make ad-hoc bookings from kiosks or room booking panels.
To configure and deploy the Calendar Driver for Microsoft 365 where Delegated Access has been used, please refer to this page related to configuring PlaceOS Calendar Driver for 365.
Prerequisites
Administrator access to your PlaceOS Backoffice
PlaceOS Drivers Repository Configured in Backoffice
Systems have a valid calendar resource address from Microsoft 365 or Google Workspace
Add Driver
Before we can use the PlaceOS Calendar Driver we must instantiate it as a driver.
Navigate to the Drivers tab
Click the
+
icon to add a new driverSelect
PlaceOS Drivers
RepositorySelect the
drivers > place > calendar.cr
Driver BaseSelect the latest commit
Click Save
Add to System
You need to instantiate a single instance of the PlaceOS Calendar Driver.
We recommend instantiating the driver in a generic system e.g. *Tracking
.
That module is then added to each system that requires booking or calendar functionality.
Instantiate the Driver
Navigate to the system you will instantiate the driver in
Select the
Modules
tabClick
Add New
Search for the PlaceOS Calendar driver
Click Save
Configure Driver
For Google Integration, we recommend creating a Service User on Google Workspace.
Service Users are the same as a regular Users Accounts with a descriptive name e.g. placeos-service-user@yourdomain.com
For testing, you can use your own Google Workspace Account.
The driver is now instantiated as a module, we need to configure the API Credentials.
Navigate to the Drivers tab
Select the Calendar Driver
In the Settings view select
unencrypted
tabDelete all the example configuration provided by the driver
If using Google Calendar API, paste this configuration into the
encrypted
tab:If using Office 365, paste this configuration into the
encrypted
tab:
Add Module to Systems
You can now add the module to other systems as required.
Navigate to an existing system
Select the
Modules
tabFrom the drop down, select the Calendar Module
Click
Add Existing
Test Module
You can test by creating a booking or inspecting the state of the Calendar Driver.
Inspecting State should return a valid response.
This should return:
You can also execute a function on the module and view the response.
As a test, executing the list_users
function should return a list of users if connected properly.
Last updated