MindSphere FAQs

General

How can I download the MindSphere certificates?

1. Use chrome to go your MindSphere tenant.
2. Press Key "F12"
3. Click on the tab "Security".
4. Click on "View certificate".
5. Click on tab "Certification path".
5a. Click on "QouVadis Root CA 2 G3" and "View certificate".
5b. Click on tab "Details" and "copy to file".
6. Repeat 5a and 5b for the "QouVadis Enterprise Trust CA 2 G3" and "Siemens Issuing CA Internet Server 2017" certificate.

MindConnect

MindConnect Nano / IOT 2040

How to get (extended) Logfiles from your MindConnect device

You can run diagnostic and maintenance USB commands on your MindConnect Elements. Those files are mandatory for error analysis via the Mindsphere Support.

All necessary steps can be found in the „Getting Connected to MindSphere“ documentation in the chapter "Mounting and installing MindConnect Elements" -> "USB commands":
https://documentation.mindsphere.io/resources/html/getting-connected/en-US/index.html

Prerequisites:
• USB stick (fat32 formatted)
• ConBox_Commands.json file with a special content

Factory Reset of MindConnect Device

A factory reset is only necessary for MindConnect Elements that were already connected to MindSphere V2 (SAP).

Instead it is recommended if the MindConnect should be switched from on Tenant to an other Tenant.

You will find the necessary steps in the „Getting Connected to MindSphere“ documentation in the chapter "Manual firmware update of MindConnect Element":
https://documentation.mindsphere.io/resources/html/getting-connected/en-US/120162351627.html

Prerequisites:
• USB stick (fat32 formatted)
• ConBox_Commands.json file with a special content and
• the newest firmware version of your MindConnect Device

How to get the latest Firmware for your MindConnect device

The latest firmware of the MindSphere MindConnect Elements can be found in the SIOS (Siemens Industry Online Support) web-portal:

• MC IoT2040: https://support.industry.siemens.com/cs/document/109745562

• MC Nano: https://support.industry.siemens.com/cs/document/109745561

An installation guide can be found in the "Getting Connected to MindSphere documentation" (https://documentation.mindsphere.io/resources/html/getting-connected/en-US/index.html) in the chapter "Firmware update":

In general, there are two different ways to perform a firmware update:

• Manual firmware update of MindConnect Element

• Automatic Firmware update in Asset Manager

What data types and ranges are available?

You can find detailed information about the the Data Types and Structures in the link below:

Link: https://documentation.mindsphere.io/resources/html/getting-connected/en-US/index.html

In the documentation, navigate to the protocol you want to use.

How can you onboard a MindConnect Element

https://documentation.mindsphere.io/resources/html/getting-connected/en-US/103386314379.html

The following steps describe how you can onboard a MindConnect Nano and how to configure the Data Mapping in the Asset Manager. By doing so, we basically connect the Datasource (Plant) with the Aspects (MindSphere). For this example we use the S7 protocoll and read out an Integer variable from a SIMATIC S7-1500.

Create new Asset and configure MindConnect Agent (Menu “Asset” on the left)
Create new asset based on “core.mcnano” and give a name (e.g. Asset_NanoAgent)
Insert unique box ID and configure Web- and Plant-Interfaces (as shown in the image)
Optional: update Firmware if necessary
Download config file and onboard Nano Box

Which Error-Codes/Quality-Codes can occure?

An overview over all possible quality codes based on the OPC UA standard can be found in the “Getting Connected to MindSphere” documentation under the chapter appendix:
https://documentation.mindsphere.io/resources/html/getting-connected/en-US/index.html (search for Quality codes)

MindConnect Library

What data types and ranges are available?

A detailed information about the the Data Types and Structures you can find here in the link below:

Link:
https://developer.mindsphere.io/resources/mindconnect-lib/doxygen/html/annotated.html

How you can refresh the MCLib Key/Token?

There are two functions an agent must call at some specific periods to be able to send data for long periods.

mcl_communication_get_access_token – 30 minutes

mcl_communication_rotate_key – 7 days

If the agent does not call these functions it will fail to send data after some time.

And here is an example code for Key Rotation:

// If everything is successful so far, exchange the store which contains timeseries.

if (MCL_OK == code)

{

printf("Uploading timeseries: ");

code = mcl_communication_exchange(communication, store, NULL);

// If exchange returns unauthorized, then get new access token.

if (MCL_UNAUTHORIZED == code)

{

printf("Getting new access token: ");

code = mcl_communication_get_access_token(communication);

// If getting new access token is successful, then try exchange again.

if (MCL_OK == code)

{ printf("Retrying exchange: "); code = mcl_communication_exchange(communication, store, NULL); }

else if (MCL_BAD_REQUEST == code)

{

// If get access token call returns bad request error then rotate key and try exchanging again.

printf("Calling rotate key: ");

code = mcl_communication_rotate_key(communication);

// If key rotation is successful, then retry exchange.

if (MCL_OK == code)

{ printf("Retrying exchange: "); code = mcl_communication_exchange(communication, store, NULL); }

}

What Error Codes does the MCLib have?

You can have a look at the link for more information:
https://developer.mindsphere.io/resources/mindconnect-lib/doxygen/html/index.html

Error Codes:
https://developer.mindsphere.io/resources/mindconnect-lib/doxygen/html/mcl__common_8h.html#acbb627504e693369c88e62fe00946674

You can also have a look in the files. It's inside "include/mcl/mcl_common.h" and look for "typedef enum E_MCL_ERROR_CODE" line .

Mindsphere Standard Applications

Asset Manager

Developer Cockpit

Why you don't see the delete Button from your App in Developer Cockpit?

An app can only be deleted if it is de-registered and its state is “In Development”.

If the state of your application is in “Preparation in Progress”, the delete button is hidden. This state indicates that an upload has already been initiated, e.g. the manifest file has already been uploaded.

To delete the app, the upload must be discarded:

Open your application in Developer Cockpit
Click on “Manage Uploads” button (top right corner)
Discard the upload and confirm

Result: State changes to “In Development” and delete button is available.

The Upload of your App failed. How can you start a new handover?

Once an upload of an app has been initiated, this element or version cannot be edited any more. This is true for both successful and failed upload.

To start a new upload, a new version is created, and the process can start over. See documentation for creating a new version: https://documentation.mindsphere.io/resources/html/developer-cockpit/en-US/124342198027.html.

Why does the upload of your app take so long?

By uploading your application via Developer Cockpit, you confirm having evaluated and tested the application with respect to its technology, functionality, performance, security, and user interface. You agree that your application complies with the documentation and any other requirements set out in the MindSphere Master Agreement (MMA) or the respective order form.

Please also check the documentation "Get your Application Ready for Productive Use":
https://developer.mindsphere.io/howto/howto-app-publication.html

After uploading the application the preparations and verifications of the productive release will be started. Usually this takes only a few days and should not exceed 5 days. Developers should consider this period in their planning. This process cannot be accelerated. Therefore, please do not send any requests to the MindSphere Support. An email notification is sent to the primary and secondary e-mail address as soon as the application is available for productive use.

Fleet Manager

Operator Cockpit

How can you check if your App in Operator Tenant has Token Manager Service activated?

This information will be found in the metadata.json file. The metadata.json is included in the application package, which can be downloaded from your Operator Cockpit.

In the metadata.json, check for the entry "serviceCredentialTypes". This states either none for no credentials or the type of credentials issued.

The picture below shows where you can download the Application files, which include the metadata.json file.

How can you obtain ClientID and ClientSecret for your App on the Operator Tenant?

Once your application is registered on Operator Cockpit, the two following variables are added to the env variables for all components of your App:

MDSP_KEY_STORE_CLIENT_ID: "clientID"

MDSP_KEY_STORE_CLIENT_SECRET: "ClientSecret"

When testing your code on the Developer Plan Tenant, we recommend adding those two env variables using the credentials for your Dev Tenant. This way, you will create the same behavior as the one you will find on the productive system.

See Documentation for Operator Cockpit: https://documentation.mindsphere.io/resources/html/operator-cockpit/en-US/120367607947.html.

Settings

Upgrade

Usage Transperacy

Additional Mindsphere Applications

Agent Diagnostic

Data Exploration

MC Edge Analytics

MC IOT Extension

How can you activate MC IOT Extension App on your tenant?

Requirements to be able to activate MC IOT Extension App on your tenant:

You have a MindAccess IOT Value Plan or MindAccess Developer Plan
You are TenantAdmin on the tenant.

Hint: MC IOT Extension is not available for TRIAL Tenants and MindAccess Operator Plans.

There are three ways to activate MC IOT Extension on your tenant.

You have the Welcome email of your tenant. There is MC IOT Extension Activation mentioned and you can use the provided link to get MC IOT Extension App activated.
You write an email to provisioning@mindsphere.io.
You write a support ticket from your tenant in the top right corner with click on Mindsphere > Support.

With option 2 and 3 please use the following template to provide the necessary information:

Email Template to order IOT Extension via Mindsphere Provisioning or Support

Subject: Activate MindConnect IoT Extension - Tenant: <Tenant Name>

Email Body:

Dear MindSphere User

MindConnect IoT Extension is a connectivity layer that expands the number of protocols that can communicate with MindSphere. Various field protocols are supported along with an increased range of hardware connectivity agents that create direct connection to assets in the production environment. Use the complete environment to create and manage agents and devices. MindConnect IoT Extension is included in the MindAccess offerings with upgrades available for increases in data ingestion based on solution requirements.

First Name:

Last Name:

Email (User Name):

Instructions: Please provide the following information to request activation of MindConnect IoT Extension for your tenant <Tenant Name> and send the email.

Company:

Phone:

Country:

How you can enable Cloud Fieldbus / OPC UA Server for MC IoT Extension

The Cloud Fieldbus feature is enabled by default on all MC IoT Extension Tenants. The prerequisite for use is that you have registered a gateway or industrial PC in the MC IoT Extension Tenant. See "Connecting OPC UA servers" in the associated documentation:

https://documentation.mindsphere.io/resources/html/mindconnect-iot-extension/en-US/index.html

“To connect an OPC UA server to MindConnect IoT Extension, you need a gateway or industrial PC running the MindConnect IoT Extension OPC UA agent”.

To install the OPC UA Server / Agent you can use the following documentation:

https://cumulocity.com/guides/devices/opcua#configuration

Your Login for MindConnect IOT Extension does not work?

Note that the accounts for your Tenant and IOT Extension are different. Each of those two systems has its own user management. Thus, you will need to have two accounts when working with both tools (Tenant and IOT Extensions).

For IOT Extensions, the tenant owner is initially given a password upon creation. He can then invite more users. We would ask you to speak to your Tenant Owner in order to invite you to the accounts.

MC IOT Integrations

Your Login for MindConnect Integration does not work?

Note that the accounts for your Tenant and MindConnect Integration are different. Each of those two systems has its own user management. Thus, you will need to have two accounts when working with both tools (Tenant and Integration).

For Integration, the tenant owner is initially given a password upon creation. He can then invite more users. We would ask you to speak to your Tenant Owner in order to invite you to the accounts.

Predictive Learning

Product Intelligence

Visual Analyzer

Visual Explorer / Connector

Why am I getting the following message “You reached the limit of your booked offering.” for the Visual Explorer?

Note that there is a quota enforcement for this App, which limits the number of users: https://documentation.mindsphere.io/resources/html/visual-explorer/en-US/123394822795.html.

See Visual Explorer Offering for the number of users available for each Plan Size: https://www.dex.siemens.com/mindsphere/applications/visual-explorer?viewState=DetailView&cartID=&portalUser=&store=&cclcl=de_DE

To get access to the App, there are two Options:

a. Get a Plan Upgrade (M allows more users than S)

b. Free licenses by creating a support ticket and indicate which users should be removed

Visual Flow Creator

Custom Development

Mindsphere API

How to authenticate requests to the Mindsphere API?

Mindsphere offers 3 different ways to authenticate requests to the Mindsphere API.

Prerequisites:

- Mindsphere Developer Tenant

- Traffic Outbound Upgrade (only for Service Credentials)

1. Application Credentials (recommended)

Application Credentials consist of a client_id and a client_secret. Both can be requested from the Developer Cockpit's Authorization Management, after the application has been created.

https://documentation.mindsphere.io/resources/html/developer-cockpit/en-US/124342226699.html

Those credentials can then be used to request an application access token from the Token Management Service.

https://developer.mindsphere.io/apis/exchange-tokenmanager/api-tokenmanager-overview.html

Applications which use application credentials for the API authorization are automatically able to authenticate at the API's of the Operator Tenant and IOT Value Plan Tenant, after the application has been provisioned to those tenants.

2. Service Credentials

Service Credentials also consist of a client_id and a client_secret but act like a technical user (shadow user). They offer a static way for authentication to the API, because they can only be used at Developer Plan Tenants. The most common use case is for CI/CD pipelines or Self-Hosted applications (application which is not deployed to Cloud Foundry).

https://developer.mindsphere.io/howto/howto-local-development.html#create-service-credentials

3. Session Stealing (Recommended for Postman)

After logging in to a Mindsphere Tenant, the user receives a Session cookie which keeps the current browser session active. This cookie can be used for authenticate requests to our API. The Cookie and its value can be read out via the browser console. The console can be opened with "F12". The exact place where the cookie can then be found depends on the used browser:

Chrome: -> Application -> Cookies

Firefox: -> Storage -> Cookies

The roles and scopes of the cookie depend on the application from where the cookie was received. Example: The AssetManager combines all roles and scopes for the Asset Management API. A Cookie will have all those roles and scopes when using the Cookie from this application: https://{{Tenant_Name}}-assetmanager.{{region}}.mindsphere.io

The same counts for every application which provides this cookie.

Useful Links:

https://developer.mindsphere.io/howto/howto-local-development.html#accessing-mindsphere-apis-using-session-cookies

https://learning.getpostman.com/docs/postman/sending-api-requests/cookies/

How can you modify TimeSeries Data in Mindsphere?

There are different options to modify TimeSeries data:

1. Visual Flow Creator: https://documentation.mindsphere.io/resources/html/visualflow-creator/en-US/index.html. This application enables you to read, modify and write TimeSeries Data with graphical Flow Elements.

2. IoT Timeseries API: https://developer.mindsphere.io/apis/iot-iottimeseries/api-iottimeseries-api-swagger-3-4-0.html. There are several Options to manipulate data. This depends on your use case and if you want to do it once or continuously

a. From your own Programm running in MindSphere

b. Postman

In both cases, you need an access (Bearer) Token to call Mindsphere API. Again, there are two options depending on your use case:

- Get a Token to call MindSphere APIs from your Application: https://developer.mindsphere.io/concepts/concept-authentication.html#get-a-token-to-call-mindsphere-apis-from-your-application

- For Background Processes and an external source there is the Token Manager Service: https://developer.mindsphere.io/apis/exchange-tokenmanager/api-tokenmanager-overview.html

Are there some limits for IoT Time Series Service?

You can find the description for the IoT Time Series Service limitations via the following link.

https://developer.mindsphere.io/apis/iot-iottimeseries/api-iottimeseries-overview.html#limitations

Cloud Foundry

How can I login to MindSphere Cloud Foundry?

Once the CF CLI is set up, you can access MindSphere Cloud Foundry using the following command:

cf login -a https://api.cf.{region}.{mindsphere-domain} --sso

Cloud Foundry will point out a link where you can obtain a passcode to complete the login process using your MindSphere Webkey Credentials.

Developer Documentation:

https://developer.mindsphere.io/paas/index.html

Why are you not able to create a service in the Operator Org?

Note that the standard offering of the Operator Plan does not include any Backing Services for its Cloud Foundry Org. See offering overview: https://www.dex.siemens.com/mindsphere/mindaccess/mindaccess-devops-plan.

To buy a service for you Operator Plan, we would ask you to contact your sales partner or visit the store directly: https://siemens.mindsphere.io/en/store.

How do you get access to your Cloud Foundry Org?

The Mindsphere user roles (e.g.: Tenant Admin) and the Cloud Foundry role refer to two different accounts.
When the Tenant is created, only the Tenant Owner will be assigned a role in the tenant and in the Cloud Foundry Org.

The Tenant Owner is able to assign tenant admin role in the tenant to other users. In Cloud Foundry, like in the tenant, the Tenant Owner has to invite users and create Spaces and assign roles to the Org/Spaces.

In order to get your role in cloud foundry, you need to contact the Tenant Owner.

Please find here the documentation of how your Tenant Owner can add a new user to Cloud Foundry https://developer.mindsphere.io/paas/paas-cloudfoundry-howtos.html

What are the most important Cloud Foundry CLI commands?

The most important Cloud Foundry CLI commands can be found:

• in the MindSphere Developer Documentation in the chapter "Cloud Foundry How Tos":
https://developer.mindsphere.io/paas/paas-cloudfoundry-howtos.html

• in the corresponding Cloud Foundry documentation:
http://cli.cloudfoundry.org/en-US/cf/

Please note that not all commands can be executed with the OrgManager role. In some cases the SpaceDeveloper role is necessary, e.g. to start or stop apps. You can find a complete overview at the following link:
https://docs.cloudfoundry.org/concepts/roles.html

Why the invitation to Cloud Foundry failed with message: User could not be found?

Prerequisites:
You want to invite a new user to your MindSphere Cloud Foundry Organization (Org) with the command cf set-org-role and see the following error:

FAILED:
Server error, status code: 404, error code: 20003, message: The user could not be found: <Email address of the user>

Solution:
Please note the "Add a New User" description in the MindSphere "Cloud Foundry How Tos" documentation:
https://developer.mindsphere.io/paas/paas-cloudfoundry-howtos.html#add-a-new-user

Prerequisites for adding a new user:
• The new user has access to a DevOps Plan.
• The new user has logged into the Cloud Foundry once before (see Connecting to Cloud Foundry via CF CLI).

How you check if CF buildpacks support a specific version of a programming language?

Login to MindSphere Cloud Foundry
Check with the command "cf marketplace" which buildpacks currently supported
Go to https://github.com/cloudfoundry and search for the specific CF buildpack version
Under the chapter “Packaged binaries” you can find the information which programming language versions are supported within this CF buildpack.
You can use ^ ~ inside the package.json file to install a compatible or similar version.

Which Backing Service Type should you use for productive environment

Mindsphere recommends to use Backing Service M to use for productive environments. You have the following advantages:

More Harddisk/ more Memory
Redundancy
No downtime during updates in CloudFoundry

Mindsphere Resources

Fleet Manager Plugin SDK

MindSphere OS Bar

MindSphere SDK V2 for Java

MindSphere SDK for Node.js

MindSphere Web Components

Open Edge Device Kit

MindSphere SDK for Python

General

Which IP addresses are there to access application server/firewall settings?

The IP addresses for your firewall settings in order to enable access to your application server can be found here:

https://developer.mindsphere.io/howto/howto-selfhosted-integration.html#testing-the-application

Note that there can be temporary situations where the IP addresses provided are not reachable (e.g. in case of a fallback). Any permanent change will be updated in the documentation as provided above.

The IP address mention in document is not sufficient

35.156.223.10

18.194.162.141

18.194.195.1

Mendix

How you get support for Mendix apps on MindSphere?

Mendix is supported by the community. If you have questions or problems with Mendix apps on MindSphere you can post it in the Mendix and MindSphere Community:

https://developers.mendix.com

https://community.plm.automation.siemens.com/t5/MindSphere/ct-p/MindSphere

How to solve Mendix error "The given CockpitApplicationName Change%20me was not found in the provided authorization information"

The constant (CockpitApplicationName) must be set to the "Internal Name" of the app under which the app was registered in the Developer Cockpit. This can either be done directly in the app by overwriting the value or better than Cf environment variable via manifest:

env:
MX_MindSphereSingleSignOn_CockpitApplicationName: NAME_OF_THE_APP

NOTE: Make sure to "Commit" your changes in the Mendix Modeler before publishing your application to Mindsphere

Configure App Name

Application Examples

MindConnect Function Block S7-1500 (MCFB)

Support

How to provide Logfiles or Screenshots to the MindSphere Support Team?

Siemens Customers:

Log files or screenshots can be provided to the MindSphere Support Team by attaching those files to the reply of the welcome email (IR Has Been Created) of the previously created support ticket.

External Customers:

After the IR has been created, log files con be provided by uploading them to the following URL:

https://download.industrysoftware.automation.siemens.com/upload.php