Displays a list of all noteworthy events that have occurred or that are still active.
The widget is aware of the page context, and so can load events over multiple customers, locations and machines.
When placed in a page, you must choose whether to show events that are finished and therefore historical, or show events that are still active.
Active or Historical Events
By changing the Event Status property you select whether active or historical events must be displayed.
If the Event Status property is left blank, the widget will allow selecting whether to display the active or historical events.
Details Navigation
Clicking on a row opens the event details popup. Optionally the event details can be opened in a full page (see Details Mode option).
The header of the event details popup contains the event name, description, and a breadcrumb that provides the context of the event, and whose tokens can be clicked to quickly jump to related objects (e.g. Customer, Location, Thing).
The event 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 event list rows, you can also click directly on specific information to jump to the event 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 event details popup/page is opened.
Advanced Search
The advanced search allows filtering events by:
Text Key: text which is searched into the name, title and description of each event.
Customer: a customer can be selected, in the case of a user belonging to an organization or partner.
Severity: the severity of the event, one of Failure, Major Anomaly, Minor Anomaly and Operation.
Period: the time period used to filter events by start timestamp.
Thing Definition or Product Model: one or more thing definitions or product models.
Type: type of event, choosing one or more definitions.
By clicking the Export button, all events that meet the search criteria can be downloaded through a CSV file.
User Reported Events
User reported events can be created by clicking on the 3-dots icon and the Report Event.
A popup request the user to select the event to register, and optionally provide some additional notes for technicians.
Configuration
Template Syntax
Below you can find some examples of how to use the component within a template.
<event-list-widget [pageSize]="10" [title]="'Events'">
<property name="eventSeverity" label="Type" filter="eventSeverity"></property>
<property name="date" [label]="'Date Time'"></property>
<property name="thing.serialNumber" label="Thing"></property>
<property [name]="'customer.name'" [label]="'Customer'" *ngIf="getUser()?.organizationId || getUser()?.partnerId"></property>
<property [name]="'location.name'" [label]="'Location'"></property>
<property name="title" [label]="'Alert'"></property>
<property name="description" [label]="'Details'"></property>
<property name="duration" [label]="'Elapsed Time'"></property>
</event-list-widget>
Component Reference
Here is a comprehensive list of all the elements and properties that can be used to configure the component.
Event List <event-list-widget>
| The expected behaviour when a row is clicked. Type: ENUM | Optional Values: OPEN_DETAILS, OPEN_CONTEXT_OBJECT
|
Controls Enabled | The boolean flag indicating whether controls (e.g. Search, Export) are enabled on the widget. Type: BOOLEAN | Optional Default Value: true
|
Details Mode | The way the alert details is opened if in a POPUP, in a dedicated PAGE or NONE to disable details. Type: ENUM | Optional Values: POPUP, PAGE, NONE Default Value: POPUP
|
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
|
Event Status | The status of the event to display. Type: ENUM | Optional Values: ACTIVE, CLOSED
|
Export Enabled | The boolean flag indicating whether the data export is enabled. Type: BOOLEAN | Optional Default Value: true
|
Include Sub Things Events | The flag indicating whether sub-things events must be included when this widget is placed in a thing dashboard. Type: BOOLEAN | Optional Default Value: false
|
Initial Sorting | The array of property names and criteria to use for sorting (e.g. ['name','asc','serialNumber','desc']). Type: SORT_PROPERTIES | Optional
|
Page Size | The number of items to load on each page. Type: INTEGER | Optional Default Value: 50
|
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 Variable | The id of the page's <things-filter-field> used for searching. Type: STRING | Optional
|
Title | The title displayed on the top part of the widget box. Type: STRING | Optional
|
Rendering | |
CSS Class | The name(s) of the CSS class used to customize the widget layout. Type: STRING | Optional
|
Advanced | |
Id | The id of the widget. Type: STRING | Optional
|
Sub Elements | |
The property whose value must be displayed for each event row. | |
The composite part whose value must be displayed within the event row. | |
Property <property>
Description | The property description. Type: STRING | Optional
|
| 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
|
Filter | The name of the filter used to transform and display values. Type: FILTER | Optional
|
Label | The property alternative label. Type: STRING | Optional
|
Name | The property whose value must be loaded by the widget. Type: PROPERTY | Required
|
Advanced | |
Column CSS Class | The name(s) of the column CSS class used to customize the table column. Type: COLUMN_CSS | Optional
|
Display Mode | The way the column is displayed. Type: ENUM | Optional Values: VISIBLE, INITIALLY_HIDDEN, ALWAYS_HIDDEN Default Value: VISIBLE
|
Include in Export | The boolean flag indicating whether the property value should be included in the export even when not visible within the page. Type: BOOLEAN | Optional Default Value: false
|
Show Header | The flag indicated whether the header is visible. Type: BOOLEAN | Optional Default Value: true
|
Visibility Condition | The expression that allows you to reduce the visibility of the element. Type: STRING | Optional
|
Composite Part <composite-part>
Description | The composite-part description. Type: STRING | Optional
|
Filter | The filter applied on the composite-part to transform or display its value. Type: FILTER | Optional
|
Label | The label displayed by the widget. Type: STRING | Optional
|
Name | The composite-part name. Type: STRING | Optional
|
Advanced | |
Column CSS Class | The name(s) of the column CSS class used to customize the table column. Type: COLUMN_CSS | Optional
|
Display Mode | The way the column is displayed. Type: ENUM | Optional Values: VISIBLE, INITIALLY_HIDDEN, ALWAYS_HIDDEN Default Value: VISIBLE
|
Show Header | The flag indicated whether the header is visible. Type: BOOLEAN | Optional Default Value: true
|
Visibility Condition | The expression that allows you to reduce the visibility of the element. Type: STRING | Optional
|
Sub Elements | |
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
|