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). For more information about these dashboards: 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 work is on the Workplace Analytics side. In Workplace Management, only the integration setup via an External app and related information needed by the Workplace Analytics side to set up the integration is required. This article focuses on setting up this part of the integration (Workplace Management side).
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 WPM side, the following Prerequisites are needed:
The reservation module is activated (The integration is based on reservable objects and reservations)
Incoming web services, including the use of a registration key, are enabled in the WMP client. This is done via ‘Access rules' and can be found via the client settings → Authentication tab, include 'Access rules’. This include should show the following 4 lines:
If this is not the case, you will get an error about this when trying to activate the module activation for this integration. in this case, you will need to contact customer support as they can add these access rules.
How to enable the integration on the WPM side
Simply use the ‘Module activation’ option on the administrator startboard to select 'Workplace Analytics integration':
In this module activation, the external app and related technical requirements including a dedicated user for this integration are created in the background. Once you start this module activation, you will receive a pop-up with the information that you will need to provide to the Analytics team:
As shown in the pop-up:
Make sure you use a client-specific URL (fmd.axxerion.com instead of axpr17.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 Analytics team again. To do this, go to the Module settings, tab ‘'Workplace Analytics’ (under 'integrations), and use the button there:
Technical background information
The following information describes the technical details of setting up the integration on the WMP 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