What is this article about?
Workplace Analytics is the product in which comprehensive dashboards can be made available to a customer regarding reservation data from Workplace Management (WPM). More information about these dashboards can be found here: Dashboards.
To set up these dashboards for a Workplace Management customer, an integration needs to be established between the Workplace Management client and the Workplace Analytics client. Most of this integration work is on the Workplace Analytics side. In Workplace Management, only the setup of the External App and fowarding the relevant integration information to the Workplace Analytics team is required. This article focuses on setting up the Workplace Management part of the integration.
Who should read this article?
This article is written for implementation consultants.
Prerequisites before setting up the integration
Before setting up the integration on the Workplace Management side, the following prerequisites are important:
The reservation module needs to be activated (the integration is based on reservable objects and reservations)
Incoming web services and the use of a registration key need to be enabled. This can be done via Client settings → 'Authentication' tab → 'Access rules' include. This include should show the following four lines:
If this is not the case, you will get an error, when trying to activate the module activation for Workplace Analytics. Contact Customer Support (support@spacewell.com) if the access rules are not set up correctly.
How to enable the integration on the Workplace Management side
Simply use the ‘Module activation’ option on the administrator startboard to select 'Workplace Analytics integration':
Via the module activation, the External App and a dedicated webservice user are created and configured, necesarry for the integration. Once you start this module activation, you will receive a pop-up with the information that you will need to provide to the Workplace Analytics team:
As shown in the pop-up:
Make sure you use a client-specific URL (fmd.axxerion.com instead of axpr15.axxerion.com), as this will ensure that the integration will keep working in case the customer is ever moved to another cluster.
The secret key must be revealed by you via the steps in the pop-up. To be able to do this, you will need to have the Partner password enabled for your user.
Once the module activation is done, it is still possible to request the information needed by the Workplace Analytics team. Go to Module settings → Integrations → Workplace Analystics and use the button.
Technical background information
The following information describes the technical details of setting up the integration on the Workplace Management side without the use of the Module activation. These are all automatically taken care of in the module activation. This is therefore only relevant as technical background information and can be used for debugging, if the setup does not work properly.
Navigate to client settings, ‘Setup’ and make a note of the client reference
Click tab ‘Authentication’:
Scroll down, click tab ‘External apps’:
Click ‘Create analytics’:
Make a note of the External App reference and set commission to ‘Active’:
Open the tab ‘Trust relations’
Make a note of the ‘Access ID’
Make sure that the ‘Key type’ is set to ‘Integration secret key’, change if necessary
Check if the ‘Authorized system user’ is set to an active user with access to Analytics data, change if necessary
Click on ‘password protected’
If ‘password protected’ is not shown, make sure that your user is member of the group ‘license editor’.
Click ‘Reveal secret key’
Provide your password. Note that when your user is a partner user, using the partner password is currently not supported, which means that you need to generate a personal password for your user. This is supported from the january release onwards, so from that time on you can use the partner password.
Now you have all the information that Analytics needs to connect, forward this info to them:
server: the Axxerion subdomain that the client is using (for example ‘myclient.axxerion.com’)
client reference: the unique identifier of the client Axxerion environment, (for example ‘clientabc’)
external app ID: see notes above
access ID: see notes above
secret key: see notes above