Overview

The "IIH Connector Test UI" module serves as:

• A quick, Swagger-like frontend to interact with your IIH Essentials data structures via the IIH Essentials Connector directly from your Mendix app for testing purposes.
• A sample implementation showcasing the interaction between the microflows and entities of the IIH Essentials Connector and another external module with separate microflows and UI entities accessible on a page.

This module is built to be compatible with the IIH Essentials Connector V 1.0.0, which implements the IIH Essentials V 1.8.0 OpenAPI.

Documentation

Introduction & Overview

The "IIH Connector Test UI" module serves as:

• A quick, Swagger-like frontend to interact with your IIH Essentials data structures via the IIH Essentials Connector directly from your Mendix app for testing purposes.
• A sample implementation showcasing the interaction between the microflows and entities of the IIH Essentials Connector and another external module with separate microflows and UI entities accessible on a page.

This module is built to be compatible with the IIH Essentials Connector V 1.0.0, which implements the IIH Essentials V 1.8.0 OpenAPI.

Typical usage scenario

• Provide a user-friendly, visual tool within your Mendix app to better understand the REST resources, operations, and returned data structures provided by the IIH Essentials API.
• Quickly test if your IIH integration works from within your Mendix app deployed in Studio Pro or even on the Industrial Edge device.
• Display, filter, and modify IIH data structures directly within your Mendix app without the need for and configuration of other tools like Swagger or Postman.
• Gain inspiration and guidance on building your own Mendix application that leverages the IIH Essentials Connector.

Features and limitations

Only the following operations are currently implemented:

Adapters

• GET: all adapters

Aspects

• GET: Get all aspects
• GET: Get single aspect by id
• POST: Create an aspect
• PUT: Update an aspect
• DELETE: Delete an aspect
• GET: Get size of aspects folder
• POST: Create a set of aspects
• POST: Update a set of aspects
• DELETE: Delete a set of aspects

Assets

• GET: Get all assets
• POST: Create an asset
• GET: Read a single asset
• PUT: Update an asset
• DELETE: Delete an asset
• GET: Get the root asset
• GET: Read all child assets
• GET: Read all breadcrumbs
• GET: Get the asset tree
• GET: Get used disk space by assets
• POST: Create a set of assets

Calculate

• POST: Calculate an aggregated value
• POST: Calculate a trend of aggregated values

Data

• GET: Read data of multiple variables
• POST: Write data of multiple variables
• DELETE: Delete data of multiple variables
• POST: Get timeseries data of multiple variables (bulk)
• GET: Read data of a single variable
• POST: Write data of a single variable
• DELETE: Delete data of single variable
• GET: Return the size of the internal database
• GET: Get data size
• GET: Count data for a single variable
• POST: Get data delta

Variables

• GET: Get all variables

Dependencies

Ensure the following dependencies are installed from the Mendix Marketplace:

• Mendix Studio Pro V 10.6.11 or higher
• Atlas Core V 3.13.0 or above (not included in the Blank Starter App template. Update this if you’re receiving “design property spacing not supported by your theme” errors )
• Industrial Edge - Device API Connector and its dependency, the Encryption module
• Industrial Edge - IIH Essentials Connector

Installation

1. Follow the instructions in Using Marketplace Content to import this module and its dependencies listed above to your app project.
   1. Note: If you receive “the definition of this widget has changed” errors, right click on the error and “update all widgets”. This will use the data widgets V 2.23.0 used by this module.
2. Configure the Device API Connector according to its documentation. Do not forget to set an encrpytion key for the Encryption module and add your device certificate in the app settings if you want to test locally from Studio Pro.
3. Configure the IIH Connector Test UI Module in Studio Pro
   1. Navigation: Add the navigation microflow NAV_IIHTestUI to your Navigation. This opens the microflow retrieves the first connected device that you configured in the Device API connector. Implement your own navigation microflow if you want to pass a different device to the IIHTestUI_Overview page.
   2. Security: Add the module role “User” to one of your app user roles

Configuration

In the running Mendix app

• Setup a device using the Device API connector on which your IIH Essentials app is installed.
• Open the resource overview page by clicking on the navigation item you created at Installation Step 3a. This will take you to a page where all implemented resources are listed alphabetically. Click on the desired resource to see the available operations and fllow the instructions listed on the page to see what input parameters are required to get a response.