Skip to content

MindSphere Operations Insight Plugin SDK – Interfaces and References

This page gives an overview about the functions and parameters which are provided by the plugin sdk.

Input Parameters provided by Operations Insight

Parameter & Type Description
actionList: Observable<PluginDetailedAction[]> Provides the current action list.
active: Observable<boolean> Indicates whether the plugin is currently active (if true, the plugin tab is currently active and visible).
activationInfo: Observable<ActivationInfo> Provides the activation status and activation reason information.
asset: Observable<Asset> Provides information about the currently selected asset.
assetId: Observable<string> Provides id of the currently selected asset.
assetList: Observable<Asset[]> Provides a list of the available assets in the Operations Insight Main Frame.
dateRange: Observable<DateRange> Provides observer for the date range, which contains the start / end date and the timezone.
language: Observable<string> Provides the current language setting.
routingInfo: Observable<string> Provides observer for the routingInfo.
settings: Observable<Settings> Provides the settings from Operations Insight main frame.
viewList: Observable<PluginDetailedView[]> Provides the current view list.

Requests received by Operations Insight

Requests & Type Description
enableDateTimeRangePicker(): void Requests Operations Insight to enables the date time range picker in asset context.
disableDateTimeRangePicker(): void Requests Operations Insight to disable the date time range picker in asset context.
navigate(navigationOptions: NavigationOptions): void Triggers a navigation inside Operations Insight.
refreshAssetList(): void Requests Operations Insight to refresh the asset list.
requestActionExecution(actionId: string, payload?: string): void Requests Operations Insight to execute an action with an optional given payload.
sendNotification(notification: Notification): void Send a notification which is displayed in the Operations Insight main frame. Different notification types can be used like warning or alert.
setAppInfoI18n(appInfoI18n: AppInfoI18n): void Requests Operations Insight to set the application data and the legal information.
setAssetId(assetId: string): void Requests Operations Insight to set an assetId.
setBusyState(busy: boolean): void Requests Operations Insight to set the environment busy status.
setDateRange(dateRange: DateRange): void Requests Operations Insight to set a date range.
setRoutingInfo(routing: string, replaceUrl?: boolean): void Requests Operations Insight to set the routing info.
setSettings(settings: Settings): void Requests Operations Insight to save settings for the plugin.

Date Time Range Picker

In asset context a date time range picker is available for custom plugins and can be activated using the command enableDateTimeRangePicker() if required. User selections are provided to the plugin using the dateRange parameter.

Plugin Information

The plugin information is provided using the appInfoI18n parameter. Configurable information are the plugin name, copyright information and/or links. The appInfoI18n parameter is an object literal that contains the appInfo in one or more languages. The default language is English (en) and must always be provided. The appInfo must be provided in the format defined in the OS Bar documentation.

Info

If the appInfo does not use the correct format an exception is thrown while loading the SDK and the plugin information will be empty.

Plugin Roles

The plugin is loaded in an iframe and has its own URL and security context. The required roles for accessing the plugin have to be configured in Developer Cockpit as for normal MindSphere web applications.

Plugin Settings in Developer Cockpit

Plugins can be configured to be displayed in different containers. For that the plugin settings in Developer Cockpit have to be used.

Example Settings:

{"views":[{"container":"appBar.explore","displayName":{"default":"Sidebar Plugin","en":"Sidebar Plugin"},"icon":"demo","id":"demo.home","navigationMode":"default","type":"default","url":"/"}]}

The following containers are supported.

Asset context:

  • appBar.explore.assets

Tenant context:

  • appBar.explore
  • appBar.configure
  • appBar.analyze

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.


Last update: November 18, 2021