Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Automatically translated by Lango

...

Worum geht es in diesem Artikel?

Workplace Analytics is the product in which comprehensive dashboards can be made available to a customer regarding reservation data from ist das Produkt, in dem einem Kunden umfassende Dashboards zu den Buchungsdaten aus Workplace Management (WPM) . More information about these dashboards can be found herezur Verfügung gestellt werden können. Mehr Informationen zu diesen Dashboards finden Sie hier: Dashboards.

To set up these dashboards for a Um diese Dashboards für einen 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:

  1. The reservation module needs to be activated (the integration is based on reservable objects and reservations)

  2. 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:

    Image Removed

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 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 teamKunden einzurichten, muss eine Integration zwischen dem Workplace Management Client und dem Workplace Analytics Client hergestellt werden. Der größte Teil dieser Integrationsarbeit findet auf der Workplace Analytics-Seite statt. Im Workplace Management ist nur die Einrichtung der externen App und die Weiterleitung der relevanten Integrationsinformationen an das Workplace Analytics-Team erforderlich. Dieser Artikel konzentriert sich auf die Einrichtung des Workplace Management Teils der Integration.

Wer sollte diesen Artikel lesen?

Dieser Artikel ist geschrieben für Implementierungsberater.

Voraussetzungen vor dem Einrichten der Integration

Bevor Sie die Integration auf der Seite des Workplace Management einrichten, sind folgende Voraussetzungen wichtig:

  1. Das Reservierungsmodul muss aktiviert werden (die Integration basiert auf reservierbaren Objekten und Reservierungen)

  2. Eingehende Webdienste und die Verwendung eines Registrierungsschlüssels müssen aktiviert werden. Dies kann über Client-Einstellungen → Registerkarte "Authentifizierung" → Include "Zugriffsregeln" erfolgen. Dieses Include sollte die folgenden vier Zeilen enthalten:

    Image Added

Wenn dies nicht der Fall ist, erhalten Sie eine Fehlermeldung, wenn Sie versuchen, die Modulaktivierung für Workplace Analytics zu aktivieren. Kontaktieren Sie den Kundensupport (support@spacewell.com), wenn die Zugriffsregeln nicht korrekt eingerichtet sind.

So aktivieren Sie die Integration auf der Workplace Management-Seite

Verwenden Sie einfach die Option "Modulaktivierung" auf dem Administrator-Startboard, um "Workplace Analytics Integration" auszuwählen:

...

Über die Modulaktivierung werden die externe App und ein dedizierter Webservice-Benutzer erstellt und konfiguriert, die für die Integration erforderlich sind. Sobald Sie diese Modulaktivierung starten, erhalten Sie ein Pop-up mit den Informationen, die Sie dem Workplace Analytics-Team zur Verfügung stellen müssen:

...

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#FFFAE6

As shown in the popWie im Pop-up gezeigt:

  • Make sure you use a client-specific URL Stellen Sie sicher, dass Sie eine mandantenspezifische URL verwenden (fmd.axxerion.com instead of anstelle von 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

...

titleTechnical 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

...

  • , da dies sicherstellt, dass die Integration auch dann noch funktioniert, wenn der Kunde auf einen anderen Cluster umzieht.

  • Der geheime Schlüssel muss von Ihnen über die Schritte im Pop-up-Fenster offengelegt werden. Dazu müssen Sie das Partner-Passwort für Ihren Benutzer aktiviert haben.

Nach der Aktivierung des Moduls ist es immer noch möglich, die vom Workplace Analytics-Team benötigten Informationen anzufragen. Gehen Sie zu Moduleinstellungen → Integrationen → Workplace Analystics und verwenden Sie die Schaltfläche.

...

Technische Hintergrundinformationen

Expand
titleTechnische Hintergrundinformationen

Die folgenden Informationen beschreiben die technischen Details der Einrichtung der Integration auf der Seite des Workplace Managements ohne die Verwendung der Modulaktivierung. Diese werden alle automatisch in der Modulaktivierung erledigt. Dies ist daher nur als technische Hintergrundinformation relevant und kann zur Fehlersuche verwendet werden, falls die Einrichtung nicht richtig funktioniert.

Navigieren Sie zu den Client-Einstellungen, "Setup", und notieren Sie sich die Client-Referenz

Image Added

Klicken Sie auf die Registerkarte 'Authentifizierung':

Image Added

Scrollen Sie nach unten und klicken Sie auf die Registerkarte "Externe Anwendungen":

Image Added

Klicken Sie auf "Analyse erstellen":

Image Added

Notieren Sie sich den Verweis auf die externe App und setzen Sie die Provision auf "Aktiv":

Image Added
  • Öffnen Sie die Registerkarte 'Vertrauensbeziehungen'.

  • Notieren Sie sich die 'Access ID'.

  • Vergewissern Sie sich, dass der "Schlüsseltyp" auf "Integrationsgeheimschlüssel" eingestellt ist, ändern Sie ihn gegebenenfalls.

  • Prüfen Sie, ob der "Autorisierte Systembenutzer" auf einen aktiven Benutzer mit Zugriff auf Analysedaten eingestellt ist, ändern Sie ihn gegebenenfalls.

  • Klicken Sie auf 'passwortgeschützt'.

Wenn "passwortgeschützt" nicht angezeigt wird, stellen Sie sicher, dass Ihr Benutzer Mitglied der Gruppe "Lizenz-Editor" ist.

Image AddedImage Added
  • Klicken Sie auf 'Geheimschlüssel aufdecken'.

  • Geben Sie Ihr Passwort ein. Beachten Sie, dass die Verwendung des Partner-Passworts derzeit nicht unterstützt wird, wenn Ihr Benutzer ein Partner-Benutzer ist. Das bedeutet, dass Sie ein persönliches Passwort für Ihren Benutzer erstellen müssen. Dies wird ab der Januar-Version unterstützt, so dass Sie ab diesem Zeitpunkt das Partner-Passwort verwenden können.

Image Added

Jetzt haben Sie alle Informationen, die Analytics für die Verbindung benötigt, und leiten diese Informationen an sie weiter:

  1. Server: die Axxerion-Subdomäne, die der Kunde verwendet (zum Beispiel 'myclient.axxerion.com')

  2. Kundenreferenz: die eindeutige Kennung der Axxerion-Umgebung des Kunden (z. B. "clientabc")

  3. externe App-ID: siehe Anmerkungen oben

  4. Zugangskennung: siehe Anmerkungen oben

  5. geheimen Schlüssel: siehe Anmerkungen oben