...
1. General
An external app is an object in Workplace Management that is used to configure and monitor the connection to an external system. An external app makes sure that the external system can access the Workplace Management environment to fetch all relevant data and input data, if applicable. The external app will also facilitate in the Workplace Management environment being able to access the external system.
...
1.1 Data
The data in Workplace Management which needs to be exposed to the external system can be linked to the external app. This makes sure that only the relevant data is exposed to the external system and irrelevant or personal data is not exposed or accessible via the external app.
1.2 Trust relation
Next to the objects, the external app also All the external apps that are configured for a tenant can be found via Client settings → Authentication → Page include ‘External apps’
...
This external apps are also used when setting up the integration between the Spacewell products (e.g. Workplace Experience and Workplace Analytics). Most of the configuration is done automatically when following the relevant module activation steps. However, some specific steps require manual actions and it can be relevant to know some details about the external app for debugging purposes. Therefor the next steps go into detail about the general settings and options that apply to every external app, as well as the specify details of the specific external apps for the native Spacewell products
1.1 Trust relation
Each external app should consists of a trust relation. A trust relation is used to configure the authentication needed to access the Workplace Management environment via the external app. The type of authentication is configured in the trust relation and is automatically determined by the external app type. A authentication type can be a username/password, two-way SSL certificate, a secret key, etc. Depending on the authentication type, the username/password or (access ID) key needs to be shared with the external system to be able to access the external app.
| Info |
|---|
Via the different applicable module activations, a dedicated ‘Spacewell Integration’ user is automatically linked to all trust relations as the default authorized system user. |
| Note |
|---|
Make sure that the Authorized system user linked to the trust relation is an active user that has administrator access, as this user is (automatically) used to perform the ‘administrator’ actions via the external application. If this user is not active or not allowed to perform the relevant actions (e.g. fetch certain master data), the integration will not work |
1.3 Operation mode
The operation mode of the external app determines on which server the external app is accessible. The operation modes Production, Backup, Test and Development are available and refer to the server of the Workplace Management environment (axpr, axbk, axts, etc. (Clusters and Servers)). If the operation mode is set to Production, then the external app will not be accessible via the backup or test server for the external system, for example. If the operation mode is empty, the external app is accessible on all servers (as soon as the external app is synced to all servers, which is daily for the backup and every 6-8 weeks for the test server).
...
When an external app is created, the category determines the external app type. The external app type determines which specific options and setting relevant for the specific external system the external app is exposed toused for. By default the following categories/types are available:
Workplace Experience
Analytics
Calendar integration
It is also possible to create an external app in the default category (via the ‘New’ button in the external app overview shown above). This can be used for setting up an external app (for authentication purposes) for a custom integration.
Next to the above mentioned general external app configuration, each type has addition of the 3 standard types has additional specific configuration. In the next chapters, the different types and additional configuration and options are described for each type.
...
It is possible to create a ticket via the Workplace App. More information about ticketing from the Workplace app can be found via the Workplace Experience integration: simple ticketing module activation and information.
...
2.2 Analytics
By activating the Analytics integration via the module activation, the external app is automatically created and configured correctly. There are no additional configuration options in the external app for Analytics apart from the general settings described above.
2.3 Calendar integration
...