GoBright View can display data and information from external sources through custom integrations. These integrations can be developed to connect with third-party systems and display their content within GoBright View.
If you are interested in developing a custom integration, please read the following article carefully for more information.
How it works
Within GoBright View, all content is displayed using Widgets. Widgets that display dynamic or external data receive their information from a Data Source.
To display data from external systems within GoBright View, custom integrations can be developed by GoBright. These integrations connect a Data Source to GoBright View, allowing information from third-party applications and services to be displayed through widgets.
Data source
A Data Source retrieves data from an external source, formats it, manages caching, and makes the data available for use by a Widget. Data Sources are developed in JavaScript and can be linked to one or more widgets.
By default, a Data Source retrieves updated data from the external API every 5 minutes. Once retrieved, the data is processed and cached before being made available to the connected widgets.
The relationship between these components is as follows:
A Data Source retrieves and provides the data.
A Widget displays the data from the Data Source.
A Slide contains one or more widgets.
A Playlist contains one or more slides.
The playlist is scheduled on one or more devices, such as reception displays or information screens.
Each player or display independently retrieves and caches the data through the Data Source. This ensures that devices can continue displaying the most recently available data, even if the external source is temporarily unavailable.
Widget
A Widget is responsible for visualizing data within GoBright View. Widgets are built using HTML, CSS, and JavaScript. HTML is always required, while CSS and JavaScript are optional depending on the functionality and design requirements.
A Widget can be linked to zero or one Data Source, but never to more than one Data Source.
Examples
-
A weather Data Source can be connected to multiple Widgets. For example, one Widget may display the current temperature, while another displays the weather forecast for the coming days.
-
A Data Source providing table data can be linked to multiple table Widgets. Each Widget can use a different design or layout while displaying the same underlying data.
-
A QR code Widget is an example of a Widget that does not require a Data Source. All required logic is contained within the Widget itself, and no external data is needed.
When GoBright develops a custom integration with an external data source, at least one Data Source and one Widget are created. This is included in article number GB-VIEW-EXTAPIQUERY-GENERAL.
Depending on the requirements of the integration, additional Data Sources and/or Widgets may be needed. Extra Widgets can be ordered separately using article number GB-VIEW-EXTAPIQUERY-WIDGET.
A common use case for custom integrations is the creation of a dashboard that presents information from one or more external systems. These dashboards often consist of multiple Widgets displayed together on a single slide or across multiple slides. In GoBright View, a template is typically created to contain and organize these Widgets.
The exact number of Data Sources and Widgets required depends entirely on the complexity of the integration, the available data, and the customer's requirements.
Requirements for developing a custom integration
Data
When GoBright develops a custom Widget and Data Source to visualize customer data within GoBright View, access to the underlying data is required.
In most cases, this data is provided through an external API. Since GoBright is typically not familiar with the structure or contents of third-party systems, the customer or integration partner must provide the necessary technical information and access.
GoBright expects the supplied data to be well-structured, reliable, and consistently available. Data can be provided through an API in formats such as JSON or XML.
The following prerequisites must be met:
Complete API documentation must be provided.
-
A technical contact must be available, preferably a product owner or technical specialist from the third-party system. This contact should be able to:
Explain the API structure and available data.
Clarify the provided documentation.
Answer technical questions during the implementation process.
Assist with troubleshooting and testing when required.
Functional Requirements
Once the data source has been defined, the requirements for displaying the data must be established. For example:
Should the data be filtered before it is displayed?
Should the data be sorted in a specific way?
Are there any display rules or calculations that need to be applied?
What information should be shown to end users?
Only data that is available through the API can be displayed within GoBright View. If specific information is required but not exposed by the API, please contact the API provider to determine whether this data can be made available.
Note: GoBright View does not store historical data for extended periods. If historical information needs to be displayed, it must be provided by the API whenever the Data Source retrieves the data. Each data collection cycle should therefore include any historical data that the integration requires.
Design Requirements
In addition to the technical requirements, GoBright requires a clear visual design of how the data should be presented on the digital signage displays. This can be provided as a sketch or design document created by the customer.
The design should illustrate how the data will be displayed within the Widget, including the layout, styling, and the information that should be visible to end users. As mentioned earlier, only data that is available through the API can be displayed within GoBright View.
Configurable Parameters
To make a Widget more flexible and reusable, GoBright also requires a written description of any configurable parameters that should be available within the Widget.
Parameters allow the behavior or appearance of a Widget to be adjusted without requiring code changes. These settings can be configured when the Widget is added to a slide.
For example, a school timetable Widget could include a parameter that allows the user to choose whether to display schedules for students or teachers. This could be configured through a dropdown list. Based on the selected value, the Widget would retrieve and present the relevant data in a different way.
Ordering a custom integration
Development of a custom integration can only begin once GoBright has received a confirmed order and all prerequisites described in this article have been met.
At a minimum, the order must include article GB-VIEW-EXTAPIQUERY-GENERAL. This article covers the development of:
- One Data Source
- One Widget
Depending on the project requirements, additional Data Sources and/or Widgets may be needed. In such cases, these must be included separately in the order.
Additional Widgets can be ordered using article number GB-VIEW-EXTAPIQUERY-WIDGET.
Once the order has been placed and all technical, functional, and design requirements have been provided, GoBright can start the development process.
Note: Development cannot begin until all required information, including API documentation, access to sample data, design requirements, configurable parameters, and a technical contact, has been provided.
For pricing, licensing, and ordering information, please contact your GoBright reseller.
Timeline
Once Phase 2 has been completed and approved by the GoBright developer, confirming that all required information has been received, the estimated development time is approximately 8 weeks.
The development process consists of the following phases:
| Phase | Description |
|---|---|
| Phase 1 |
Order Confirmation and Data Collection GoBright receives the purchase order and all required technical information, documentation, and sample data. |
| Phase 2 |
Review and Planning The provided requirements, data, and documentation are reviewed. Any missing information is identified, and the project scope is validated. Development can only start once this phase has been completed and approved. |
| Phase 3 |
Widget Design A visual design of the Widget is created and provided as an image (JPG or PNG) for review and approval. |
| Phase 4 |
Data Source Development The Data Source is developed. |
| Phase 5 |
Widget Development The Widget is developed based on the approved design and connected to the Data Source. |
| Phase 6 |
Internal Testing GoBright performs functional and technical testing to verify that the integration works as intended. |
| Phase 7 |
Customer Environment Testing The integration is deployed to the customer's environment for validation and acceptance testing. |
| Phase 8 |
Final Delivery After successful testing and approval, the integration is delivered and made available for production use. |
Note: The estimated development time of approximately 8 weeks starts only after Phase 2 has been completed and all required information, documentation, data access, and design requirements have been approved by GoBright. Delays in providing the required information or feedback during the project may affect the overall timeline.
Update of Widget & datasource after delivery
Please note that custom Widgets and Data Sources are developed using JavaScript, HTML, and CSS. If you have the required development expertise, you can modify and maintain the delivered Widget and Data Source yourself after the project has been completed.
If you prefer, GoBright can also perform modifications and further development on your behalf. This may include design changes, additional functionality, support for new API endpoints, or other enhancements. For pricing and availability, please contact your GoBright reseller.
Note: Changes made after delivery are not included in the original development project and may require a separate quotation.
To see examples of custom integrations and Widgets developed by GoBright, take a look at the following article: Custom widgets