Overview

The Building X Connector for Mendix streamlines the creation of new business value using LowCode powered by Mendix and the Building X platform. This connector provides a domain model encompassing all core entities exposed by Building X. It also offers actions for retrieving, creating, updating, and deleting these entities, which become available in the Mendix toolbox upon installing the Connector. This document will guide you through the structure of the connector, enabling you to build innovative applications.

The following Building X APIs are supported:

• Building Structure API (Read and Write)
• Building Geometry API (Read)
• Building Operations API  (Read and Write)
• Point Value Ingest API  (Write)
• Building Energy API  (Read)
• Security Identities and Privileges API (Read)
• Activities API (Read)

Documentation

Typical Usage Scenario

The Building X Connector for Mendix is designed to help customers create innovative business applications with ease, leveraging the power of LowCode development in Mendix combined with the robust features of the Building X platform. Customers can use this connector to streamline operations, enhance building management, and improve energy efficiency. By integrating core Building X APIs, the connector allows for seamless interaction with building structure, geometry, operations, and energy data. This can solve problems related to data accessibility, real-time monitoring, and efficient resource management, making it useful in a wide range of scenarios, including smart building management, facility maintenance, and energy optimization.

Features and Limitations

Comprehensive domain model that includes all core entities exposed by Building X. Pre-defined actions for retrieving, creating, updating, and deleting entities, available directly in the Mendix toolbox. Simplifies the development process by providing ready-to-use components and actions.

Support for the following Building X APIs:

• Building Accounts API: Read capabilities
• Building Structure API: Read and write capabilities
• Building Geometry API: Read capabilities
• Building Operations API: Read and write capabilities
• Point Value Ingest API: Write capabilities
• Building Energy API: Read capabilities
• Security Identities and Privileges API: Read capabilities
• Activities API: Read capabilities

Limitations:

1. Requires an active Building X account and API subscriptions and access.
2. Performance may vary depending on the complexity of the operations and the volume of data being processed.

Dependencies

To ensure successful integration and usage of the Building X Connector in your Mendix applications, the following dependencies are required.

Dependencies:

1. Building X account and API subscriptions.
2. Appropriate machine user roles and permissions within your Mendix application to utilize the Connector's functionalities.

Installation

To install the Building X Connector for Mendix, follow these steps.

Steps:

1. Download the connector package from the Mendix App Store.
2. Open your Mendix project in Mendix Studio Pro.
3. Navigate to the App Store in Mendix Studio Pro and import the Building X Connector package.
4. Follow the on-screen instructions to complete the installation process.
5. Verify that the connector has been added to your project by checking the toolbox for new Building X components and actions.

Configuration

After installation, configure the Building X Connector by following these steps.

Steps:

1. Enter your Building X API credentials in the BX Authorize action to obtain a Token.
2. Configure the necessary machine user permissions and roles to ensure secure access to the Building X APIs.
3. Set up any additional parameters required for your specific use case, such as default customer and partition IDs.
4. Test the configuration by executing the Sample App to verify connectivity and data retrieval.

Known Bugs

Currently, there are no known bugs affecting the Building X Connector. However, should you encounter any issues, please refer to our support documentation or contact our support team for assistance.

Frequently Asked Questions

Q: Can I use the Building X Connector with any version of Mendix?

A: The connector requires Mendix Studio Pro version 10.8 or higher.

Q: How do I obtain Building X API credentials?

A: API credentials can be managed through the Accounts or API Manager apps within the Building X platform.

Q: Are there any usage limits for the Building X APIs?

A: Usage limits are determined by your Building X subscription plan. Please refer to the Building X datasheets for detailed information on API usage limits.

Q: How can I contact Siemens Customer Support?

A: For Siemens Customer Support, please visit the Siemens Industry Online Support (SIOS). There, you can find various resources, contact options, and support services to assist you.