Capital Connector

Last modified: September 29, 2025

Introduction

The Siemens Capital electrical and electronics (E/E) software tools help design and develop electrical and electronic systems, including system architecture, communication networks, and embedded software.

The Mendix Capital connector consists of microflows that help you authenticate with Capital, effortlessly get Capital data into your Mendix app, and build custom implementations tailored to your needs.

Licensing

The Capital connector is licensed under the Apache V2.0 License.

Prerequisites

  • Studio Pro version 10.24.3 or above
  • A Capital instance

Dependencies

You must have the following Marketplace modules installed:

Installation

Follow these steps to install the Capital connector in your Mendix app:

  1. Install the modules listed in the Dependencies section.
  2. Follow the instructions in Using Marketplace Content to import the Capital connector into your app.

Configuring the Connection to Capital

Follow these steps to configure a connection to your Capital instance:

  1. Open your app in Studio Pro.

  2. In the App Explorer, double-click Settings. The App Settings window is displayed.

  3. On the Configurations tab, double-click your configuration. The Edit Configuration window is displayed.

  4. On the Constants tab, fill in the following details:

    • In the CapitalConnector.CONST_Username field, enter your Capital username. For security reasons, make sure this is set to private.
    • In the CapitalConnector.CONST_Password field, enter your Capital password. For security reasons, make sure this is set to private.
    • In the CapitalConnector.CONST_AuthenticationBaseURL field, enter the URL used to authenticate with the Capital Service.
      This URL typically has the following format: {protocol}://{host}:{port}/capital/login.
    • In the CapitalConnector.CONST_BaseURL field, enter the base URL for retrieving data from the Capital Service.
      This URL typically has the following format: {protocol}://{host}:{port}/capital/rest/v1.
    • Adjust the value in the CapitalConnector.CONST_CapitalSession_ExpirationInSeconds field if your Capital instance has a custom session timeout.

Using the Connector

You can find the available operations in the microflow toolbox or in the _USE ME folder.
The operations are ready to be dragged into your implementation microflows once you have set up the necessary credentials for authentication.

Building Filters

Some Capital REST operations support filtering capabilities. In the connector, these operations have an optional filter parameter of type string.
In the Filtering category of the toolbox, you can find microflows that allow you to build a filter. For guidance on how to implement these microflows, go to the App Explorer and check the example microflow in the Filtering folder.

For details on defining a filter, refer to the REST API documentation of your Capital instance. This is available by accessing {protocol}://{host}:{port}/restapidocs/.

Capital object IDs

Some operations take an object ID as parameter. Many Capital objects have a BaseID attribute. For those that do not have this attribute, please use the ID getter microflow available in the toolbox. This takes the link attribute available on the associated metadata object, and returns the ID of the parent object.

Resources

For information about the Capital REST API, please refer to the REST API documentation of your Capital instance. This is available by accessing {protocol}://{host}:{port}/restapidocs/.