Skip to main content

Event List

Support
  • Updated

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.

 

Event List

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. By default, the widget loads the CLOSED events. 

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: one or more thing definitions.
  • 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.

 

Configuration

Design View

In the visual editor, you can find the Event List icon under the Events component palette group.

You can drag the widget into the grid and then configure the following sub-elements according to your needs:

Property: the property whose value must be displayed for each event row.

Composite Part: the composite part whose value must be displayed within the event row.

 

Code View

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>
PROPERTIES
CSS Class The name(s) of the CSS class used to customize the widget layout.
Type: STRING | single | Optional
class="my-custom-class"
Details Mode The way the alert details is opened if in a POPUP, in a dedicated PAGE or NONE to disable details.
Type: ENUM | single | Optional | Values:
POPUP
PAGE
NONE

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 | single | Optional
emptyMessage="No customer found"
Event Status The status of the event to display.
Type: ENUM | single | Optional | Values:
ACTIVE
CLOSED

status="CLOSED"
Export Enabled The boolean flag indicating whether the data export is enabled.
Type: BOOLEAN | single | Optional | Values:
true
false

[exportEnabled]="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 | single | Optional | Values:
true
false

[includeSubThingsEvents]="true"
Initial Sorting The array of property names and criteria to use for sorting (e.g. ['name','asc','serialNumber','desc']).
Type: JSON | single | Optional
[sort]="['name','asc','serialNumber','desc']"
Page Size The number of items to load on each page.
Type: INTEGER | single | Optional | Default: 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: JSON | single | Optional
[query]="[{'property': 'connectionStatus', 'predicate': 'eq', 'value': '1'}, {...}]"
Query Variable The id of the page's <things-filter-field> used for searching.
Type: STRING | single | Optional
queryFieldRef="query-1"
Title The title displayed on the top part of the widget box.
Type: STRING | single | Optional
[title]="'Details'"
Visibility Condition The expression that allows you to reduce the visibility of the element.
Type: STRING | single | Optional
*ngIf="getUser().organizationId != null"
SUB-ELEMENTS
Property The property whose value must be displayed for each event row.
multiple | optional

<property name="serialNumber"></property>
Composite Part The composite part whose value must be displayed within the event row.
multiple | optional

<composite-part>
  <property name="name"></property>
  <property name="severity"></property>
</composite-part>

 

Property <property>
PROPERTIES
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 | single | Optional | Values:
true
false

[exportOnly]="true"
Filter The name of the filter used to transform and display values.
Type: FILTER | single | Optional
filter="fooBarFilter"
Label The property alternative label.
Type: STRING | single | Optional
label="Temperature"
Name The property whose value must be loaded by the widget.
Type: PROPERTY | single | Mandatory
name="serialNumber"
Visibility Condition The expression that allows you to reduce the visibility of the element.
Type: STRING | single | Optional
*ngIf="getUser().organizationId != null"

 

Composite Part <composite-part>
PROPERTIES
Filter The filter applied on the composite-part to transform or display its value.
Type: FILTER | single | Optional
filter="fooBarFilter"
Label The label displayed by the widget.
Type: STRING | single | Optional
label="fooBar"
Name The composite-part name.
Type: STRING | single | Optional
name="fooBar"
Visibility Condition The expression that allows you to reduce the visibility of the element.
Type: STRING | single | Optional
*ngIf="getUser().organizationId != null"
SUB-ELEMENTS
Property The property whose value must be loaded within the composite-part.
multiple | optional

<property name="serialNumber"></property>
PROPERTIES
Name The property whose value must be loaded by the widget.
Type: PROPERTY | single | Mandatory
name="serialNumber"

 

Related articles

Comments

0 comments

Please sign in to leave a comment.