The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!

Provide Feedback

Feedback sent

Thank you for your feedback!

Provide Feedback

Please log in to provide feedback
Skip to content
Siemens Xcelerator Marketplace
Join the community
Insights Hub and Industrial IoT

Insights Hub drives smart manufacturing through the industrial Internet of Things. Gain actionable insights with asset and operational data and improve your processes.

Explore subscription options

Insights Hub Monitor 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 Insights Hub Monitor

Parameter & TypeDescription
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 Insights Hub Monitor

Requests & TypeDescription
enableDateTimeRangePicker(): voidRequests Operations Insight to enables the date time range picker in asset context.
disableDateTimeRangePicker(): voidRequests Operations Insight to disable the date time range picker in asset context.
navigate(navigationOptions: NavigationOptions): voidTriggers a navigation inside Operations Insight.
refreshAssetList(): voidRequests Operations Insight to refresh the asset list.
requestActionExecution(actionId: string, payload?: string): voidRequests Operations Insight to execute an action with an optional given payload.
sendNotification(notification: Notification): voidSend a notification which is displayed in the Insights Hub Monitor main frame. Different notification types can be used like warning or alert.
setAppInfoI18n(appInfoI18n: AppInfoI18n): voidRequests Operations Insight to set the application data and the legal information.
setAssetId(assetId: string): voidRequests Operations Insight to set an assetId.
setBusyState(busy: boolean): voidRequests Operations Insight to set the environment busy status.
setDateRange(dateRange: DateRange): voidRequests Operations Insight to set a date range.
setRoutingInfo(routing: string, replaceUrl?: boolean): voidRequests Operations Insight to set the routing info.
setSettings(settings: Settings): voidRequests 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 Insights Hub 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
Contact us
2025