Historical Alert List

  • 3 minute(s) read

Displays the list of occurred historical alerts considering the navigation context.

Historical Alert List

Details Navigation

Clicking on a row opens the event details popup. Optionally the alert details can be opened in a full page (see Details Mode option).
The header of the alert details popup contains the alert name, description, and a breadcrumb that provides the context of the alert, and whose tokens can be clicked to quickly jump to related objects (e.g. Customer, Location, Thing).

The alert details body is generated through a template which by default reports the event main information (e.g. timeline, technical description), but in the alternative you can redefine the template within the event definition page.  

On the alert list rows, you can also click directly on specific information to jump to the alert related objects:

  • Customer Name / Code ā†’ Customer details page

  • Location name ā†’ Location details page

  • Thing Name / Serial Number ā†’ Thing details page

In all other case the alert details popup/page is opened.  

Template Syntax

Below you can find some examples of how to use the component within a template. 


<historical-alert-list-widget-v2 pageSize="50">
	<property name="severity" [showHeader]="false" filter="severityIcon"></property>
	<property name="date" [label]="'Date Time'"></property>
	<property name="title" [label]="'Alert'"></property>
	<property name="description" [label]="'Alert Details'"></property>
	<property name="duration"></property>
</historical-alert-list-widget-v2>

Component Reference

Here is a comprehensive list of all the elements and properties that can be used to configure the component.

Historical Alert List <historical-alert-list-widget-v2>

Click On Row Behaviour/

The expected behaviour when a row is clicked.

Type: ENUM | Optional

Values: OPEN_DETAILS, OPEN_CONTEXT_OBJECT

DEPRECATED

clickOnRowBehaviour="OPEN_DETAILS"

Details Mode

The way the details page is opened when the details icon is clicked. If non the details icon is not present.

Type: ENUM | Optional

Values: PAGE, POPUP, NONE

Default Value: POPUP

detailsMode="PAGE"

Empty Message

The blank message to be displayed in the widget in case no item was found. To manage translations, you can define a label and use the key as the value of the property.

Type: STRING | Optional

emptyMessage="No customer found"

Export Enabled

The boolean flag indicating whether the data export is enabled.

Type: BOOLEAN | Optional

Default Value: true

[exportEnabled]="false"

Include Sub Things Alerts

The flag indicating whether sub-things alerts must be included when this widget is placed in a thing dashboard.

Type: BOOLEAN | Optional

Default Value: false

[includeSubThingsAlerts]="true"

Page Size

The number of items to load on each page.

Type: INTEGER | Optional

Default Value: 50

pageSize="100"

Query

The array of conditions filtering out items. For instance: [query]='[{'property': 'connectionStatus', 'predicate': 'eq', 'value': '1'}]'  Predicates: eq, beginsWith, like, notLike, isEmpty, isNotEmpty, gt, gte, lt, lte.

Type: QUERY | Optional

Predicates: beginsWith, eq, neq, gt, gte, isEmpty, isNotEmpty, lt, lte, like, notLike

[query]="[{property:'prop1', predicate: 'eq', value: 'foo'}, {property:'prop2', predicate: 'in', value: ['bar', 'baz']}]"

Query Variable

The id of the page's <things-filter-field> used for searching.

Type: STRING | Optional

queryFieldRef="query-1"

Title

The title displayed on the top part of the widget box.

Type: STRING | Optional

[title]="'Details'"

Rendering

CSS Class

The name(s) of the CSS class used to customize the widget layout.

Type: STRING | Optional

class="abc"

Sub Elements

Property

The property whose value must be displayed within the alert detail row or box.

Composite Part

The composite part whose value must be displayed within the alert detail row or box.

Property <property>

Description

The property description.

Type: STRING | Optional

description="abc"

Export Only/

The boolean flag indicating whether the property value should be included only in the export and not visible within the page.

Type: BOOLEAN | Optional

Default Value: false

DEPRECATED

Use Include in Export.

[exportOnly]="true"

Filter

The name of the filter used to transform and display values.

Type: FILTER | Optional

filter="fooBarFilter"

Label

The property alternative label.

Type: STRING | Optional

label="Temperature"

Name

The property whose value must be loaded by the widget.

Type: PROPERTY | Required

name="serialNumber"

Advanced

Column CSS Class

The name(s) of the column CSS class used to customize the table column.

Type: COLUMN_CSS | Optional

columnClass="my-column-custom-class"

Show Header

The flag indicated whether the header is visible.

Type: BOOLEAN | Optional

Default Value: true

[showHeader]="false"

Visibility Condition

The expression that allows you to reduce the visibility of the element.

Type: STRING | Optional

*ngIf="getUser().organizationId != null"

Composite Part <composite-part>

Description

The composite-part description.

Type: STRING | Optional

description="abc"

Filter

The filter applied on the composite-part to transform or display its value.

Type: FILTER | Optional

filter="fooBarFilter"

Label

The label displayed by the widget.

Type: STRING | Optional

label="abc"

Name

The composite-part name.

Type: STRING | Optional

name="abc"

Advanced

Column CSS Class

The name(s) of the column CSS class used to customize the table column.

Type: COLUMN_CSS | Optional

columnClass="my-column-custom-class"

Show Header

The flag indicated whether the header is visible.

Type: BOOLEAN | Optional

Default Value: true

[showHeader]="false"

Visibility Condition

The expression that allows you to reduce the visibility of the element.

Type: STRING | Optional

*ngIf="getUser().organizationId != null"

Sub Elements

Property

The property whose value must be loaded within the composite-part.

Property <property>

Name

The property whose value must be loaded by the widget.

Type: PROPERTY | Required

name="serialNumber"