Keep in mind: This module can only be used when using Workplace Analytics

1 1. Workplace Analytics integration in general
2 2. What is this module about
- 2.1 3 Choices to be made within the module
3 4. How to activate this module
4 5. Additional reports
5 6. Additional settings and options after enabling
6 7. Additional information
- 6.1 7.1 Technical background information
7 8. User manual
8 9. Q&A

1. Workplace Analytics integration in general

This module activation is used to setup the integration between Workplace Management (WPM) and Workplace Analytics (WPA) for using the reservation dashboards in WPA.

This article only focuses on setting up this integration for the Workplace management side. For more information about the actual dashboards in WPA, see the relevant articles in Workplace Analytics.

2. What is this module 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 forwarding the relevant integration information to the Workplace Analytics team is required. This article focuses on setting up the Workplace Management part of the integration.

3 Choices to be made within the module

There are no relevant choices to be made.

4. How to activate this module

As for every new module, use the ‘Module activation’ option on the administrator startboard (only available for level 2 and level 3 admins). For more general information about these 'Module activation' options, see Module activation

4.1 Prerequisites before activating this module

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.

4.2 Module activation

Before starting this specific module activation, no settings need to be determined:

By starting the module activation, the External app and a dedicated web-service user are created and configured, necessary 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 Analytics and use the button:

4.3 Data imports

For this module activation, no data imports are relevant. For more information on data imports in general, see: Data imports

4.4 System groups

When a module is activated, system groups can be assigned to user profiles. These system groups give users access to (a subset of) navigation menu options, startboard tabs, and tasks in the relevant workflow(s).

Since this module is only about the integration of the Reservation data from Workplace Management towards Workplace Analytics, no additional system groups are relevant.

For more general information on user profiles, system groups, users, and the user profile dashboard, see: Authorizing users

4.5 Navigation menu and startboard options

Since this module is only about the integration of the Reservation data from Workplace Management towards Workplace Analytics, no navigation menu or startboard options are relevant.

5. Additional reports

Since this module is only about the integration of the Reservation data from Workplace Management towards Workplace Analytics, no additional reports are relevant.

However, what is relevant to mention is that the Workplace Analytics uses the following two reports to automatically fetch the reservation data from Workplace Management:

Qlik_Reservables_01 For data related to the reservable objects
Qlik_Reservations_01 For data related to the actual reservations

6. Additional settings and options after enabling

Since this module is only about the integration of the Reservation data from Workplace Management towards Workplace Analytics, no general settings or options are relevant.

The only relevant settings are automatically set via the external app that can be found via the module settings → (Integrations) → Workplace Analytics.

If there are any issues with this integration, make sure to check the necessary settings in the external app. For more information, see: External app

7. Additional information

Via the module activation in Workplace Management, all the relevant configuration is done automatically. If however this needs to be debugged, setup in a non workplace Tenant or more technical background information is needed for other reasons, see the following technical background information:

7.1 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

8. User manual

Since this module is only about the integration of the Reservation data from Workplace Management towards Workplace Analytics, no user manual is relevant.

9. Q&A

Waiting for questions to answer

Workplace Knowledge Base (support.spacewell.com)

Workplace Analytics integration module activation and information

Analytics