Web Components for Insights Hub and Industrial IoT
Rule Wizard

The Rule Wizard guides a user in the process of creating a rule for an asset type.
There are four steps which have to be configured.

Examples¶

Selecting the Asset Type, Variable and Asset(s) which shall be monitored¶

Rule-Wizard - Step 1

Configure the conditions - thresholds, hysteresis or debouncing times¶

Rule-Wizard - Step 2

Configure the actions the rule shall be triggering - events, emails etc¶

Rule-Wizard - Step 3

Configure the rule name ore generate an automatic name¶

Rule-Wizard - Step 4

Interface¶

Selector¶

<mdsp-rule-wizard></mdsp-rule-wizard>

Properties¶

Name	Type	Corresponding attribute	Description
assetId	`string`	asset-id	Can be used to preselect a specific asset id and its asset type
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.
ruleId	`string`	rule-id	Can be used to preselect a specific rule id which will automatically pre-fill the wizard with an existing configuration. This can be used to update an existing rule.

Events¶

Name	Type	Description
stateChanged	`EventEmitter<RuleWizardEvent>`
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

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

IViewModel

interface IViewModel {
  refresh(): void;
}

Remarks¶

The number of rules which can be activated simultaneously is limited and depends on the selected plan size.
To enhance the rule limit further "Rules Quota Upgrade" packages can be purchased in the Store. For latest information refer the IoT Value Plan product sheets or contact customer support.
The rule engine triggers only in case of state changes. If values are still violated the rules are not triggered again.

Example

A rule has been created to monitor a value greater 90.
Now the value changes from 89 to 91 - means a state change happens - and the rule will be triggered and perform the configured actions.
Next the value changes from 91 to 100 - here no state change happens, as the rule is already violated, it won't be triggered again.

Roles¶

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

Snippets¶

Displaying the rule wizard¶

<mdsp-rule-wizard>></mdsp-rule-wizard>

Updating a rule¶

For updating a rule, the ruleId should be set. This will load the existing configuration in the rule wizard.

ruleTableComp.ruleId = "1123653"

Rule-Wizard - Update

Last update: February 23, 2024

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

Web Components for Insights Hub and Industrial IoTRule Wizard