OpenBOS
The OpenBOS App enables the integration and synchronization between BuildingPro Suites and ABB Ability™ Building Edge (using the OpenBOS software).
Overview
This manual provides instructions for configuring, installing, and using the OpenBOS App to manage resources and synchronize data between BuildingPro Suites and OpenBOS Edge.
For the guided setup sequence, see Configure the Building Edge and Connect via OpenBOS.
Prerequisites
Before configuring the OpenBOS App, make sure that:
the Building Edge has been preconfigured and its organization is connected to the required cloud portfolio;
the Edge has a working network connection, including a gateway address and DNS server;
the Edge is connected to cloud services and has valid cloud and oBaaS licenses;
the project contains asset instances, not only asset and device templates;
the required API Subscriptions are active for the attributes and points that should be delivered to BuildingPro Suites;
the Building Edge has been connected to a site in ABB Ability BuildingPro;
the openBOS as a Service and openBOS Capacity licenses have been assigned to the Building Edge;
a valid BuildingPro Suites license is available; and
the OpenBOS App is installed and activated in the tenant.
The Edge checks below are the minimum checks for a BuildingPro Suites connection. For complete Edge configuration instructions, use the User Manual - Edge Editor.
Required Steps in the OpenBOS Building Edge
The complete documentation for using the Edge Editor, a tool integrated into the Building Edge for configuration, is available in the User Manual - Edge Editor.
Topology and Services
Building data is captured by the Building Edge, assigned to assets, and sent to the ABB Ability Cloud. From there, the assets are retrieved via the BuildingPro Suites app and automatically created.
Initial Installation
The following configurations must be made during the initial installation:
Local configuration
As soon as the Building Edge is switched on, it can be accessed via a browser via LAN port 1 or 2.
Follow the local setup steps in the User Manual - Edge Editor.
Cloud configuration
For the Edge to connect to cloud services, it must be on a network with internet access. Configure the active IP port with a valid IP address, gateway address, and DNS server.
[A] Gateway address and primary DNS server: Confirm that both values are configured for the active IP port. Without these settings, the Edge cannot reliably reach cloud services.
To access the ABB Cloud, create a personalized login and follow the cloud connection steps in the User Manual - Edge Editor.
[B] Cloud connection status: Confirm that the status shows that the Building Edge is connected to the cloud and that the Edge time is compliant with the internet browser.
Organization connection
Make sure that the organization on the Edge is connected to the cloud portfolio that you want to use in BuildingPro.
[C] Organization: Confirm that a cloud icon is displayed next to the organization. The icon indicates that the organization is connected to the cloud portfolio.
License check
Confirm that the Edge has both the required cloud license and the oBaaS license.
[D] License Administration: Open the license administration view to review the license status and effective licenses.
[E] License details and event history: Confirm that the cloud and oBaaS license entries are present and valid. The event history shows when the licenses were mapped.
The Edge must be licensed before it can provide data to BuildingPro Suites. If a required license is missing or expired, resolve the licensing issue before continuing.
General setup
Check the general settings and complete the Edge configuration according to the User Manual - Edge Editor.
Integration of field data
To retrieve data points from a bus system, a new network for the corresponding protocol must be created under "Field Network."
The Ability Cloud is accessible at: https://buildings.ability.abb
Follow the field network setup steps in the User Manual - Edge Editor.
Adding devices and data points
To add devices and data points, the CSV import can be used. It is recommended to first export an (empty) CSV file and fill it with data.
Asset instances
Make sure that the project contains asset instances, not only asset and device templates. Assets must be used in the project before their data can be synchronized to BuildingPro Suites.
[F] Assets: Open the Assets view in BuildingPro Vision.
[G] Asset instances: Confirm that the asset list contains the assets used in the project.
If no assets are listed, return to the BuildingPro Editor and place the required assets on the floor plans. Meters are an exception: meters only need to be added to the Meters panel.
Activate API Subscriptions
For BuildingPro Suites to receive regular updates, activate an API Subscription for every attribute or point that should be delivered through the client API. An inactive subscription does not necessarily remove the point from the API, but the Edge fetches its value only when the client requests it, which can increase the response time.
In the BuildingPro Editor, open the asset that contains the required attribute or point.
Open the API Subscriptions tab.
Activate the required point.
Configure the frequency and deadband if required.
Save the API Subscription settings.
[H] Active API Subscription: Activate the switch for every attribute or point whose data should be regularly fetched and delivered to BuildingPro Suites.
Enable API access for the Edge
To connect BuildingPro Suites with the OpenBOS Edge, the Edge must be configured to allow API connections. Contact ABB support for current provisioning requirements. Provide the public API URL of BuildingPro Suites when requested: https://{your-bprosuites-domain.io}/apps-public/open-bos.
Installation
Open the OpenBOS App through Platform Core -> Connect Hub -> Edge/App Marketplace for plug-ins & extensions -> openBOS and activate it before configuring a site.
Configuration in BuildingPro Suites
Use this procedure to configure the connection between a Building Edge site and BuildingPro Suites. First retrieve the Edge Identification Number from ABB Ability BuildingPro, then configure the Edge connection and the tree structure in the OpenBOS App.
Get the Edge Identification Number
Retrieve the Edge Identification Number from the BuildingPro site before configuring the site in the OpenBOS App.
Select the portfolio that contains the required Building Edge under [A].
Open Building Pro Vision [B].
Click on the required Building Edge or site under [C].
Copy the Edge Identification Number [D]. ◈ You need this number in the Edge Configuration section of the OpenBOS App site configuration.
Configure the Edge connection
Open Sites Config in the OpenBOS App. Then configure the Edge connection and select the data that should be synchronized.
[1]
Edit Edge Configuration
Enables editing of the Edge Configuration section.
[2]
Edge Identification Number
Enter the Edge Identification Number copied from BuildingPro.
[3]
Save
Saves the Edge Identification Number.
[4]
BuildingPro Edge trees
Shows the trees and data available from the Building Edge.
[5]
Refresh
Refreshes the tree from the Building Edge.
[6]
Search
Searches the Building Edge tree. Only the part of the tree that matches the search is displayed.
[7]
Replicate filtered tree
Copies the filtered tree from the Building Edge to the BuildingPro Suites tree.
[8]
Use all data points
Mirrors the complete Building Edge tree in the BuildingPro Suites tree.
[9]
Drag and drop
Moves individual assets from the Building Edge tree to the BuildingPro Suites tree. Drag and drop can also be used in the BuildingPro Suites tree to change its structure.
[10]
BuildingPro Suites trees
Shows the trees configured for BuildingPro Suites.
[11]
Expand and collapse
Expands or collapses the tree on either side.
[12]
Delete
Removes an individual asset from the BuildingPro Suites tree.
[13]
Discard
Discards the current tree configuration and removes unsaved changes.
[14]
Save
Saves the tree configuration.
Click [1] to edit the Edge Configuration. ▷ The Edge Identification Number field becomes editable.
Enter the copied Edge Identification Number under [2].
Click [3] to save the Edge Identification Number.
Review the tree available from the Edge under [4].
Click [5] to refresh the tree from the Building Edge. ▷ The current tree structure from the Building Edge is loaded.
Enter a search term under [6] to search the Edge tree. ▷ Only the part of the tree that matches the search is displayed.
Click [7] to replicate the filtered tree. ▷ The filtered tree is copied to the BuildingPro Suites tree.
Activate [8] to use all data points. ▷ The complete Edge tree is mirrored in the BuildingPro Suites tree.
Drag individual assets from the Edge tree to the BuildingPro Suites tree under [9]. ◈ You can also use drag and drop in the BuildingPro Suites tree to change the structure of the tree.
Review the configured BuildingPro Suites trees under [10].
Use [11] to expand or collapse the tree on either side.
Click the delete control at [12] to remove an individual asset from the BuildingPro Suites tree.
Click [13] to discard the current tree configuration. ▷ Unsaved changes to the tree configuration are removed.
Click [14] to save the tree configuration. ▷ The configured tree is saved.
After the tree configuration is saved, the OpenBOS App creates the required asset types and assets in BuildingPro Suites according to the mirrored tree. The assets receive the data sent by the Building Edge.
Reload the page to display the newly created asset types and assets in BuildingPro Suites.
Follow Open openBOS config and Configure OpenBOS for the step-by-step GUI procedure.
Continuous Asset Creation
After the Edge connection and tree configuration are saved, the app starts Continuous Asset Creation (CAC) for the selected tree content.
The GUI supports the following tree-selection methods:
Replicate a filtered tree: Search the Edge tree and copy the filtered result to the BuildingPro Suites tree.
Use all data points: Mirror the complete Edge tree in the BuildingPro Suites tree.
Drag and drop: Copy individual assets from the Edge tree, or change the structure of the BuildingPro Suites tree by moving assets within it.
At least one tree selection must be saved for assets to be created. Recognized resources are automatically created as asset types and assets in BuildingPro Suites, and the user who configured the app is informed through the BuildingPro Suites notification system.
Structuring Assets
After creation, the assets in BuildingPro Suites are organized in the same structure as in OpenBOS. This structure remains synchronized, and changes in BuildingPro Suites (e.g., renaming an asset or moving a room to another building) are overwritten with the next ontology update.
The only exception are the root assets. These are created in the top-level directory and correspond to the top level of the OpenBOS location structure. As a rule, there is one "Site" in this role. Another root asset is the "OpenBOS unassigned", which contains unassigned assets and data points.
You can rename or move the root assets as you wish, whereby the entire ontology is also moved.
It is not possible to change GAIs in BuildingPro Suites for assets.
Asset Types
Asset types are automatically created and synchronized from the OpenBOS asset templates.
Asset type
Asset template
Attribute - Input
Data point with direction "Feedback"
Attribute - Output
Data point with direction "Command" or "CommandAndFeedback"
Attribute - Info
Property
Limits
Min/Max
Unit
Unit
Value mapping
Enums
Complex data types from OpenBOS are split into separate attributes in BuildingPro Suites.
Orphaned Data Points
If an asset is deleted in OpenBOS but an alarm is still linked to this data point, this data point is retained in the ontology. BuildingPro Suites adopts this behavior and assigns such data points to the "OpenBOS unassigned" asset.
Alarms
Alarms triggered in OpenBOS are synchronized with BuildingPro Suites. They are created in BuildingPro Suites as alarm rules of the type "External" and are controlled by updates from OpenBOS. When an alarm is triggered in OpenBOS, it also appears in BuildingPro Suites and is removed accordingly when it ends in OpenBOS.
External Alarms are alarms that are not managed by BuildingPro Suites. Alarm rules are displayed so that users can tag and categorize them, but BuildingPro Suites is not responsible for checking whether an alarm should be triggered. An external system (in this case, OpenBOS) is responsible for alarm control.
If an alarm requires an acknowledgment, it can be acknowledged in BuildingPro Suites, and this acknowledgment is synchronized with OpenBOS.
Monitoring the App Status
Along with asset creation, an asset named OpenBOS app is also created. It serves to inform users about the status of the app - it signals whether the app is running (asset status -> Active/Inactive) and what its status is - the status attribute. If the app status is not "OK", this means that the app may not be functioning correctly. If the error status persists, please let us know by submitting an error report.
Last updated