Insights Hub How Tos - Manual - Insights Hub How Tos - This section provides all the information that you need to quickly start using Insights Hub - Application Development - Industrial Operations X - Insights Hub - Connectivity - Insights Hub Howtos - User Management
Portfolio
Insights Hub
Product
Insights Hub How Tos
Language
en-US (original)
Overview
Overview
Application Development
User Management
Connectivity
System Tools
System Tools Tutorials
System Tools Tutorials
Asset Manager
Create aspects, variables, types and a new asset in Insights Hub
Create a new asset by selecting a type with aspects and variables
Create a new asset type with the previous created aspects and variables
Share assets with other tenants using Cross-Tenancy
Create a Collaboration
Direct access to Visual Flow Creator and Insights Hub Monitor
Application Development
Overview
Application Development Tutorials
Create your App
Develop, Deploy, Register and Release an application
Develop, Deploy, Register and Release an application
Application Development
Developing Angular Application with Web Components
Prerequisites
Procedure
Developing Java Backend application with Industrial IoT SDK
Prerequisites
Adding Industrial IoT SDK as application dependencies
Configuring the manifest file
Defining random routes and explicit routes
Directory Structure
Registering an application
Prepare the Application for Release
Prerequisites
Handover the Application to the Operator environment (Tenant)
Assign the Operator
Get your Application Ready for Productive Use - Step-by-Step
Get your Application Ready for Productive Use – Step-by-Step
Upload the Application to an Operator Tenant
Prerequisites
Prepare the Application Upload
Preparations for Self-Hosted Applications
Approve the Application Upload
Assign the Operator
Prepare an Application for Productive Use
Prerequisites
Provide Access to the Application
Offer the Application in the Industrial IoT Store (optional)
Developing Mendix Apps for Insights Hub
Developing Mendix Apps for Insights Hub
App name
Authorizing Industrial IoT REST Calls
Perform Rest Calls in Mendix
Authorizing Industrial IoT REST Calls from within 'Scheduled Events'
Local Testing
Commit Changes
Credentials
Application Credentials
Service Credentials
Configuration
User Roles
Corporate Proxy
Mendix App Licensing
Mendix Password Policy
Insights Hub Icons
Multi-Tenancy
Access Control by Industrial IoT Gateway
Control within a Mendix App
Roles and Scopes
Pre-configured Roles in the Starter App
Validation
Limitations
Binary File Storage
Logout from Insights Hub
Roles and Scopes
Native Mobile
Related Links
Accessing Industrial IoT APIs during Local Development
Accessing Industrial IoT or external APIs during Local Development
Accessing Industrial IoT APIs using Application credentials
Prerequisites
Create Application credentials
Generate the Access Token
Postman Example
Accessing Industrial IoT APIs using Session Cookies
Prerequisites
Generate User Credentials
cURL Example
Postman Example
Accessing Industrial IoT /Token APIs
Prerequisites
Procedure
Accessing Industrial IoT APIs from self-hosted Applications
Accessing Industrial IoT APIs from self-hosted applications
Prerequisites
Application Credentials
Generating a Token
Postman Example
Calling Industrial IoT Endpoints
Code Example (Python3)
Accessing 3rd party APIs from application within or outside Insights Hub
Related Links
Receiving Insights Hub Notifications
Receiving Insights Hub Notifications
Notifications sent by Insights Hub
Registering a subscription
Tenant Context
HTTPs Endpoint
Getting the user tenant details
Notifications sent by the Industrial IoT Services
Prerequisites
General considerations
Deleting a subscription
Client Secret Rotation
OAuth Client Secret Rotation
Introduce a new Secret
Update Clients with the new Secret
Remove the old Secret
Developing Subtenancy-Aware Applications
Developing Subtenancy-Aware Applications
Using Subtenant Impersonation
Subtenant Impersonation via User Tokens
Subtenant Impersonation via Application or Service Credentials
Guidelines
Subtenancy-Aware Industrial IoT Services
Related Links
Developing Cross-Tenancy-Aware Applications
Developing Cross-Tenancy-Aware Applications
Make shared resources visible
Shared modus information of a resource
Related Links
Developing Mobile Apps for Insights Hub
Developing Mobile Apps for Insights Hub
Prerequisites
Registering a Mobile App in Developer Cockpit
Android App Links and Universal Links
Accessing Industrial IoT APIs
Acquiring an Authorization Code
Getting an Access Token
Using refresh token in mobile application
Accessing Industrial IoT APIs
Related Links
Developing Mobile Apps with Mendix for Insights Hub
Developing Mobile Apps with Mendix for Insights Hub
Setup Development Environment
Registering your Mobile App in Developer Cockpit
Start Developing your App with Mendix Studio Pro
Building your Own Development App
Try out your application
Next steps
Authorize your Industrial IoTAPI calls
Extend your application registration with Industrial IoT API roles
Module Details
Authentication
Industrial IoT APIs and Token Handling
Additional User Role Home Pages
Host your App
Cloud Foundry
Setting up CI/CD pipeline using CF credentials
Setting up CI/CD pipeline using CF credentials
Prerequisites
Deploying Mendix Apps to Insights Hub
Deploy and register Mendix Apps
Prerequisites
Preparing the Mendix App for Insights Hub
Option A: Using the Insights Hub Starter App
Option B: Integrating the Insights Hub Theme Pack and Modules
Configuring the Modules
Configuring the Insights Hub Single Sign-On
Configuring the App Information (optional)
Deploying the Mendix App
Option A: Deploy with Mendix Studio to the Mendix Cloud
Configuring the Mendix App in Insights Hub
Option A: Use the Auto Registration process - recommended if your app is deployed to the Mendix Cloud
Option B: Configuring the Mendix App in the Developer Cockpit
Configuring the Mendix App Roles & Scopes
Registering the Mendix App
Assigning the Mendix App Roles
Related Links
Self Hosted
Integrating Self-Hosted Applications
Self-Hosted Application – Integration into Insights Hub
Requirements for Self-Hosted Applications
Preparing the Application
Prerequisites
Deploying the application
Configuring your Self-Hosted Application in the Developer Cockpit
Prerequisites
Creating the Application
Registering the Application
Testing the Application
Submitting your Self-Hosted Application to the Industrial IoT Store
Prerequisites
Prepare Release
Approve Upload
Integrate and provide your App
Develop, Deploy, Register and Release an application
Develop, Deploy, Register and Release an application
Application Development
Developing Angular Application with Web Components
Prerequisites
Procedure
Developing Java Backend application with Industrial IoT SDK
Prerequisites
Adding Industrial IoT SDK as application dependencies
Configuring the manifest file
Defining random routes and explicit routes
Directory Structure
Registering an application
Prepare the Application for Release
Prerequisites
Handover the Application to the Operator environment (Tenant)
Assign the Operator
Get your Application Ready for Productive Use - Step-by-Step
Get your Application Ready for Productive Use – Step-by-Step
Upload the Application to an Operator Tenant
Prerequisites
Prepare the Application Upload
Preparations for Self-Hosted Applications
Approve the Application Upload
Assign the Operator
Prepare an Application for Productive Use
Prerequisites
Provide Access to the Application
Offer the Application in the Industrial IoT Store (optional)
Integrating Applications into your Native Mobile App
Integrating Applications into your Native Mobile App
Prerequisites
Example: Opening the Launchpad of a Tenant
Integrating API application to the UI application
Integrating API application to the UI application
Deploy, Register and Test a Stand-Alone API application
Differences between API and other application types
Testing the API application
Configuration of API application with UI application
New versions and revisions of existing Applications
Creating New Versions
Rules for API versions
Creating New Revisions
Rules for API revisions
API application dependency to standard application
Add API Dependency to Standard Applications
Third Party API roles
App Credentials
Configuring Content Security Policy
Configuring Content Security Policy
Configuring the Content Security Policy of your Application
Prerequisites
Changing the CSP Configuration
Related Links
Get your Application Ready for Productive Use - Checklist
Get your Application Ready for Productive Use – Checklist
Checklist
Related Links
Accessing integrated Insights Hub Monitor Plugin application in Insights Hub Monitor
Accessing Integrated Insights Hub Monitor Plugin Application in Insights Hub Monitor
Prerequisites
Procedure
Result
User Management
Overview
User Management Tutorials
Providing Access for New Users
Providing Access for New Users
Adding a User to your environment
Prerequisites
Creating the User Account
Assigning a Role
Using Subtenancy
Using Subtenancy
Example Scenario
User Interface Customization
Languages
Regions
Subtenant User Management
Prerequisites
Creating a New Subtenant
Creating a New Subtenant User
Assigning the Subtenant Role to a Subtenant User
Assigning an Asset to the Subtenant
Changing the Subtenant Assignment of a Subtenant User
Deleting a Subtenant
Related Links
Apps and Solutions
Apps and Solutions Tutorials
Apps & Solutions Tutorials
Visual Flow Creator
Immediately access your data with Visual Flow Creator - Create a flow for visualization
Add an analytics node to the flow
Calculate a KPI on Visual Flow Creator
Create a basic flow
Add a function and filter node with an email sender
Insights Hub Business Intelligence
Create a dashboard and publish to your tenant
Access the dashboards via Dashboard Viewer or Fleet Manager
Insights Hub Business Intelligence (Visual Explorer)
Defining data sources to start Insights Hub Business Intelligence (Visual Explorer) - Create a new Data Source
Dashboarding with Insights Hub Business Intelligence (Visual Explorer) - Create a Workbook
Create calculation in a new Worksheet
Create Dashboard
Insights Hub Monitor
Monitor the status of your assets using different views
Monitor
Insights Hub Monitor
Monitor the status of your assets using different views
Business Intelligence
Insights Hub Business Intelligence
Create a dashboard and publish to your tenant
Access the dashboards via Dashboard Viewer or Fleet Manager
Insights Hub Business Intelligence (Visual Explorer)
Defining data sources to start Insights Hub Business Intelligence (Visual Explorer) - Create a new Data Source
Creating a Workbook in Insights Hub Business Intelligence (Visual Explorer) for Dashboarding
Create calculation in a new Worksheet
Create Dashboard
Connectivity
Overview
Connectivity Tutorials
MindConnect API/LIB
Onboarding an Agent
Onboarding an Agent
Provisioning an agent
Getting the boarding configuration
Registering an agent
Agents with a Shared Secret security profile
Agents with an RSA 3072 security profile
Refreshing a registration
Agent states and token handling
Related Links
Acquiring an Agent Access Token
Acquiring an Agent Access Token
Token Request
Self-Signed JWT
Header
Payload
Signature
Construction of Self-Signed JWT
Related Links
Uploading Agent Data
Uploading Agent Data
Preparing Data Upload
Creating a Data Source Configuration
Creating a Data Point Mapping
Creating Event Mapping
Uploading Data
Uploading Time Series Data
Uploading Files
Uploading Events
Uploading Compressed Data
Python Example
JavaScript Example
Replaying an Exchange Request
Diagnosing Data Upload
Related Links
Developing Device Agents
Developing Device Agents
Onboarding Devices
Registering the Device
Onboarding the Device using the Open Edge Device Kit
Synchronizing the Device Clock with Insights Hub
Uploading Time Series Data
Creating the Data Source Configuration
Applying the Data Source Configuration
Uploading Time Series Data
Caching Data
Accessing Logging Data
Reading Diagnostic Data
Stopping Data Upload
Offboarding Devices
Stopping the Agent
MindConnect Software Agent
Performing data ingestion with MindConnect Software Agent
Performing data ingestion with MindConnect Software Agent
Pre-requisites
Hardware: PC System requirements
Networking requirements
Firewall rules
Technical Overview of MindConnect Software Agent
Configuration Workflow
Asset Manager/MCSA plugin
Installation of MCSA
Connecting to Local Web UI
Entering onboarding configuration
Onboarding configuration and verify in Local Web UI and Asset Manager
Entering Data Source and Data Point configuration in Agent asset
Data Modelling
Example to configure pressure and temperature with data type as double
Perform Mapping between Agent Asset and Data Asset and then Download
Verify Data in Insights Hub Monitor
MindConnect MQTT
Overview of MindConnect MQTT
Overview of MindConnect MQTT
1. Authenticate your MindConnect MQTT Agent
2. Generate an Agent Certificate and Onboard
3. Create Data Model
4. Send Data
5. Send Data to Agent from Insights Hub
Managing CA Certificates using UI
Managing CA Certificates using UI
Overview
Prerequisites
Registering CA Certificate
Managing CA Certificates using MindConnect MQTT API
Managing CA Certificates using MindConnect MQTT API
Overview
Prerequisites
Abbreviations
Registering CA Certificate
Create Tenant CA certificate
Upload Tenant CA certificate
Tenant CA Certificate verification
Onboarding MindConnect MQTT Agent
Onboarding MindConnect MQTT Agent
Overview
Prerequisites
Agent Onboarding
EU1
Private Cloud
Credential based connection
MQTTX Agent Onboarding Example
Certificate based connection
Creation Example
Obtaining Auto-Generated Agent Certificate
Obtaining Auto-Generated Agent Certificate
Obtaining auto-generated agent certificate from API
Prerequisites
Storing private key and public key in separate files
Obtaining auto-generated agent certificate from UI
Agent Connection
MQTTX Connection Example
Creating V4 Data Model from MQTT Agent
Creating V4 Data Model from MQTT Agent
Overview
Prerequisites
Preparation
Mqtt Connection
Agent Connection
Create and Instantiate Asset Model
Subscribe to Get Asset Model Instantiation Status
Create Asset Model
Get Instantiated Model
Subscribe to Get Instantiated Model
Send Message to Get Instantiated Models**
Get Resource with Reference Id
Subscribe to Get Specific Resource Definition with Reference Id
Send Message to Get Specific Resource Definition with Reference Id
Update Resources Defined in the Model
Send Message to Update Resources Defined in the Model
Delete Resources with Reference Id
Send Message to Delete Specific Resource with Reference Id
Add New Mapping and Variable
Send Message to Add New Variable and Mapping**
Limitations
Creating Data Model from MQTT Agent
Creating Data Model from MQTT Agent
Overview
Limitations
Prerequisites
Preparation
MQTTX Create and Instantiate Model
EU1
Creating Parameterized DataModel Examples
Tenant Independent Data Model
Name Parameterized Data Model
Adding New Variable to Created Aspect Type and Mapping Created Asset
MindConnect MQTT Commanding
MindConnect MQTT Commanding
Overview
Prerequisites
Limitations
Getting Started
Using Commanding APIs
Creating a delivery job
Listing all delivery jobs
Filtering Delivery Jobs
Managing delivery jobs
Filtering Delivery Job Commands
Using Async APIs
Subscribing for Commands
Publishing Command Execution Status
Related Links
Sending Data from MindConnect MQTT Agent
Sending Data from MindConnect MQTT Agent
Prerequisite
Sending Time Series Data
Defining Time Series Data Message for Sample Use Case
Topic structure for sending time series
Check Uploaded Time Series Data From Insights Hub Monitor
Sending Events
Topic structure for sending event
Check Uploaded Event Data from Insights Hub Monitor
Sending Files
Topic structure for file upload
Check Uploaded File Data from Insights Hub Monitor
Related Links
Acquiring an Agent Access Token via MindConnect MQTT Agents
Acquiring an Agent Access Token via MindConnect MQTT Agents
Preparation
Getting Agent Access Token
Transition to Asset Modeler V4 Model
Transition to Asset Modeler V4 Model
Overview
Prerequisites
Preparation
1. Check Your Mappings from UI
2. Get Your Latest Model
Get Instantiated Model
Send Message to get Instantiated Model
Add New Mappings to your Model via V4
Check Newly added Mappings from UI
MindConnect MQTT Broker Certificate Expiration
MindConnect MQTT Broker Certificate Expiration
Python Sample
Java Sample
Bring your data using custom data service
How to bring your own data format
Introduction
Architecture
How to ingest Custom Data via API
Topic Registration & Mapping
Creating Custom Topics
Example Request Body
Example Response
Creating Custom Data Mappings
Example Request Body
Example Response
Data Ingestion through MindConnect MQTT
FAQs
FAQs
MindConnect MQTT Broker Certificate Expiration
Videos
Overview
Videos