The MindSphere Onboard tab lets you configure the MindSphere connection between the gateway and the MindSphere Service. You can also obtain the status of the MindSphere connection and several key statistics. The MindSphere feature uses the MindConnect LIB to connect to MindSphere. For more information, see https://developer.mindsphere.io/resources/mindconnect-lib/resources-mclib-overview.html.
The MindSphere application and its associated accounts are required in order to use this feature.
Parameter descriptions
| Parameter | Description |
|---|---|
|
State |
Can be Onboarded or
Offboard. In order for the MindSphere connection to be successfully established between the gateway and the MindSphere Service, the State parameter must be Onboarded and the Status parameter must be Connected. |
| Status | Can be Inactive, Connected, or Disconnected. |
| S&F Status | Can be No profile defined, Forwarding, Storing, Standby, Ready to store, Storing - forced, or Ready to store - forced. In order for Store and Forward to be active, a Profile must be defined. Once a Profile is defined, the S&F state will then rely on the State parameter or Toggle Forced Storing button. |
| Boarding Configuration | Boarding configuration generated by MindSphere web portal during the onboarding process, see https://documentation.mindsphere.io/resources/html/asset-manager/en-US/117388947083.html. Once a boarding configuration is generated, it can be copied and pasted from the web portal into this parameter. |
| User Agent | User agent string which is used in the User-Agent header of HTTP requests together with MCL's version string as prefix. This parameter is mandatory and limited to a maximum 256 characters. |
| Max HTTP Payload Size | Maximum payload size in bytes which will be used for all HTTP requests by MCL. With this parameter, you can adopt the size of HTTP requests to use depending on system limitations. The default value is 16384. Minimum value to set is 400 and maximum value to set is 10485760. |
| HTTP Request Timeout(Sec) | Timeout value for HTTP requests in seconds. This is an optional parameter with a default value of 300 seconds. |
| Proxy |
If Proxy is set to True, additional input parameter become available. |
| Proxy Host Name | Displayed when Proxy = True. |
| Proxy Port | Displayed when Proxy = True. |
| Proxy Type |
Displayed when Proxy = True. The proxy type can be:
|
| Proxy Username | Displayed when Proxy = True. |
| Proxy Password | Displayed when Proxy = True. |
| Proxy Domain | Displayed when Proxy = True. |
|
Client ID |
The Client ID to access the MindSphere services from outside the MindSphere platform. Providing service credential enables deviceWISE to enumerate datasources/datapoints for certain actions (eg Time Series Action). See https://developer.mindsphere.io/howto/howto-selfhosted-api-access.html on creating Service Credentials. |
| Client Secret | The Client Secret to access the MindSphere services from outside the MindSphere platform. |
Editing parameter values
To change parameter values, the MindSphere connection must be in a Stopped State except for Client ID and Client Secret (see "Change API Credential" under Button descriptions section). After any parameters have been changed, the current values should be saved using the Onboard button to retain them and to attempt to establish the MindSphere connection.
Button descriptions
| Button | Description |
|---|---|
| Onboard | Save all parameters on the panel and connect to MindSphere Service. |
| Offboard | Disconnect from MindSphere and reset Configuration Object. Gateway that is offboarded will need to re-generate a new Configuration Object to connect again. |
| Toggle Forced Storing | Used to force store S&F capable data while the value of Status is Connected, and a Profile is defined. |
| Change API Credential | The button is used to change Client ID and Client Secret after gateway is onboarded. |
| Refresh | Used to refresh all values on the MindSphere Onboard tab. |