1. General
From the administrator startboard and the ‘Admin’ navigation menu, the Integrations landing page can be opened. This dedicated startboard is designed to centralize all general and integration-specific configuration options and overviews in a single location.
The Integrations landing page consist of several button bars and an recent error overview:
- General
- Active integrations
- Other settings and overviews
- Recent errors (event log)
General
The ‘General’' button bar contains an ‘Information’ button that links to the general knowledge base page for integrations. It also includes the ‘Module activation’ option, which can be used to activate and configure additional integrations that are not yet enabled.
Active integrations
The ‘Active integrations’ button bar displays all integrations that are currently activated (this is based on an API connector being available). This includes the standard integrations between Spacewell Asset and other Spacewell applications, such as Workplace, Asset App, and Maintenance Planning, as well as the standard Outlook (Calendar) integration. Any custom integrations that have been configured using custom API Connectors are also displayed in this overview.
Other settings and overviews
The 'Other settings and overviews' contains several addition options relevant for integrations:
- Web services: Default and custom web services for outgoing web services to other applications
- Access rules: Access rules must be configured to enable incoming web services and to generate the encryption keys required for authentication in API Connectors. For more information about the prerequisites, see the API documentation.
- Recent errors (event log): This overview is similar to the ‘Recent errors (event log)’ overview shown on the landing page (next header), but provides more advanced filtering options. By default, the overview displays error events from yesterday until the current time. Using this page, you can search across a custom date range and apply additional filters, such as specific error descriptions, to more easily locate and investigate integration issues.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues across the active integrations.
For more advanced filtering, the ‘Recent errors (event log)’ option in the ‘Other settings and overviews’ button bar can be used. This page allows you to search over a custom date range and filter on specific error messages or descriptions.
2. Active integrations
The ‘Active integrations' overview displays only integrations that have been activated. When an integration is enabled through Module activation, the corresponding API Connector is automatically created and preconfigured. As soon as the API Connector is available in the client environment, the integration is displayed as a button in the ‘Active integrations’ overview.
2.1 Workplace
The Workplace integration dashboard consist of several button bars and an recent error overview.
General
- Information: This button navigates to the Workplace knowledge base page.
- Settings: This button provides access to applicable configuration settings applicable to the Workplace integration.
- Search in event log: This button allows users to search event logs related to the Workplace integration for troubleshooting and debugging purposes.
- Reports: Overview of the reports used by the APIs for the integration.
- User export: This export can be used to export Asset users and import them directly in Workplace Studio.
- Debugging: This dashboard van be used to debug the integration setup and show client customization on the integration reports.
- QR codes areas: Overview and the option to view and print QR codes of areas/ workplaces. See down below for more information.
- Area pictures: Easiest way to upload/link pictures to single or multiple areas in bulk.
- Asset pictures: Easiest way to upload/link pictures to single or multiple assets in bulk.
- Catering pictures: Easiest way to upload/link pictures to single or multiple catering items in bulk.
API Connectors
Selecting the Workplace button opens the corresponding Workplace API Connector. If multiple API Connectors are configured for the Workplace integration, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the Workplace integration.
2.2 Asset App
The Asset App integration dashboard consist of several button bars and an recent error overview.
General
- Information: This button navigates to the Asset App knowledge base page.
- Settings: This button provides access to applicable configuration settings applicable to the Asset App integration.
- Search in event log: This button allows users to search event logs related to the Asset App integration for troubleshooting and debugging purposes.
- Asset App forms: Overview of forms created in the Asset App backend which can be used to forward work orders to the Asset App.
- Missing Dispatch IDs: Overview of work orders not successfully forwarded to the Asset App. Via this report the work orders can be resend to the Asset App.
API Connectors
Selecting the Asset App button opens the corresponding Asset App API Connector. If multiple API Connectors are configured for the Asset App integration, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the Asset App integration.
2.3 Space Management
The Space Management integration dashboard consist of several button bars and an recent error overview.
General
- Information: This button navigates to the Space Management knowledge base page.
- Settings: This button provides access to applicable configuration settings applicable to the Space Management integration.
- Search in event log: This button allows users to search event logs related to the Space Management integration for troubleshooting and debugging purposes.
- Export reports: Overview of export reports which can be used to export data from Asset and directly import in the Space Management application.
- Import log: Search for import log which show synced data from the Space Management application and Asset
API Connectors
Selecting the Space Management button opens the corresponding Space Management API Connector. If multiple API Connectors are configured for the Space Management integration, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the Space Management integration.
2.4 Calendar
The Calendar integration dashboard consist of several button bars and an recent error overview.
General
- Information: This button navigates to the Calendar integration knowledge base page.
- Settings: This button provides access to applicable configuration settings applicable to the Calendar integration.
- Search in event log: This button allows users to search event logs related to the Calendar integration for troubleshooting and debugging purposes.
- Debugging: This dashboard van be used to debug the integration setup.
API Connectors
Selecting the Calendar button opens the corresponding Calendar API Connector. If multiple API Connectors are configured for the Calendar integration, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the Calendar integration.
2.5 Maintenance Planning
The Maintenance Planning integration dashboard consist of several button bars and an recent error overview.
General
- Information: This button navigates to the Maintenance Planning integration knowledge base page.
- Settings: This button provides access to applicable configuration settings applicable to the Maintenance Planning integration.
- Search in event log: This button allows users to search event logs related to the Maintenance Planning integration for troubleshooting and debugging purposes.
API Connectors
Selecting the Maintenance Planning button opens the corresponding Maintenance Planning API Connector. If multiple API Connectors are configured for the Maintenance Planning integration, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the Maintenance Planning integration.
2.6 SCIM
The SCIM integration dashboard consist of several button bars and an recent error overview.
General
- Information: This button navigates to the SCIM integration knowledge base page.
- Settings: This button provides access to applicable configuration settings applicable to the SCIM integration.
- Search in event log: This button allows users to search event logs related to the SCIM integration for troubleshooting and debugging purposes.
API Connectors
Selecting the SCIM button opens the corresponding SCIM API Connector. If multiple API Connectors are configured for the SCIM integration, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the SCIM integration.
2.7 QR code requests (Spacewell Scan)
The QR code requests integration dashboard consist of several button bars and an recent error overview.
General
- Settings: This button provides access to applicable configuration settings applicable to the QR code requests integration.
- Search in event log: This button allows users to search event logs related to the QR code requests integration for troubleshooting and debugging purposes.
- QR code configurations: Manage QR code configurations linked to areas and assets.
- Print QR codes: Report which can be used to print the QR codes.
API Connectors
Selecting the QR code requests button opens the corresponding QR code requests API Connector. If multiple API Connectors are configured for the QR code requests integration, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the QR code requests integration.
2.8 Custom
The Custom integration dashboard consist of several button bars and an recent error overview.
General
- Search in event log: This button allows users to search event logs related to the Custom integration for troubleshooting and debugging purposes.
API Connectors
Selecting the Custom button opens the corresponding Custom API Connector. If multiple API Connectors are configured for Custom integrations, an overview of the available connectors is displayed first, allowing the user to select the appropriate API Connector.
Recent errors (event log)
The 'Recent errors (event log)' overview displays all integration-related error events from yesterday until the current time by default. This provides a quick overview of any recent issues in the Custom integrations.