Skip to content

MindSphere Web Components
Rule View

The Rule View displays rules of a specific asset and allows users to create new rules using a wizard, activate / deactivate or delete rules.

A triggered rule is marked in the overview table with the color of the configured severity.

Examples

Rule Overview

Rule-View

Rule Wizard

Rule-View

Interface

Selector

1
<mdsp-rule-view></mdsp-rule-view>

Properties

Name Type Corresponding attribute Default Description Allowed Values
assetId string asset-id Configures the asset whose rules are displayed using its asset ID.
context string context Configures the context of the component. See also here.
errorNotification boolean error-notification Enables error control if an error is thrown. This can be used for debug purposes.

For productive use, the error event should be caught and handled in the application. See also here.
locale string locale Specifies the locale in which the component is displayed.
The locales en and de are provided by default.
See also here.
localeManager LocaleManager Returns a LocaleManager object.

This can be used to add locales or to get the locale settings. See also here.
model IDataModel Returns an object for data model handling, refer to IDataModel model.
view IViewModel Returns an object for view handling, refer to IViewModel model.

Events

Name Type Description
connected EventEmitter<any> Triggered after the component is created, initialized and appended to the DOM tree.
error EventEmitter<MdspUiError> Triggered when an error occurs in the component or while accessing APIs. See also here.

Models

IDataModel
1
2
3
4
interface IDataModel {
    // forces reload of data, e.g. re-loading the rules
    refresh(): void;
}
IViewModel
1
2
3
interface IViewModel {
  refresh(): void;
}

Remarks

Info

The Rule View is currently only supported in region Europe 1.

  • One concurrent active rule is free in all plan sizes. For an extension please contact your assigned Account Executive or Customer Success Manager.

Roles

  • mdsp:core:tsm.full-access (for full access like create and delete)
  • mdsp:core:tsm.read-only (read only)

Snippets

Refresh the Rule View

The data model of the Rule View can be refreshed to get the latest list of rules, for example to update the view cyclically.

1
ruleViewComp.model.refresh();

Any questions left?

Ask the community


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