The widget allows technicians to track maintenance within an editable registry.

The Add Maintenance Work button on the top left allows adding a new maintenance entry within the registry.

By clicking on a row it is possible to see the maintenance work details (e.g. Description and Outcome). Moreover, when the row is expanded it is possible to modify or delete the maintenance work from the registry through the bottom right icons.

By default, the maintenance registry displays the maintenance date, the type, the user email, and the duration. By clicking on the row, the maintenance work is expanded displaying the remaining properties, like the description and the outcome.

You can redefine the displayed properties by using the <property> nested tag (see the sample code below).

These are the properties you can use in the widget.

PROPERTY

DESCRIPTION

endTimestamp

The timestamp the maintenance completes.

description

The maintenance description.

duration

The maintenance duration, which is calculated as the difference between the end and start timestamps.

outcome

The optional maintenance outcome.

startTimestamp

The timestamp the maintenance begins.

thingName

The name of the thing the maintenance work is associated with. It is available only in case the widget is placed into the Location details template.

type

The maintenance type (see Administration / Settings -> Maintenance).

userEmail

The email of the user who performed the maintenance.

You can customize the maintenance types by entering the Administration / Settings page and then the Maintenance tab. You can find some predefined types, but you are free to define your own types or remove them as you need. If no maintenance types are defined, the Type radio button is omitted within the maintenance editing popup, and the type column is not displayed.

Sample code

<maintenance-registry-widget [title]="'Maintenance Registry'">
   <property name="startTimestamp"></property>
   <property name="description"></property>
   <property name="userEmail"></property>
   <property name="duration"></property>
</maintenance-registry-widget>

code_blocksDesign View

In the template editor, you can find the Maintenance Registry icon under the Maintenance and Support 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 label and current value must be rendered into the maintenance table. Other properties will be automatically included into the maintenance details
Below are references to the properties that can be configured for this widget.
For more details on how to manage properties, you can refer to this article.

code_blocksCode View

Template Syntax

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

<maintenance-registry-widget [title]="'Maintenance'">
       <property name="startTimestamp"></property>
       <property name="thingName"></property>
       <property name="description"></property>
       <property name="userEmail"></property>
       <property name="type"></property>
       <property name="outcome"></property>
       <property name="endTimestamp"></property>
       <property name="duration"></property>
</maintenance-registry-widget>

Component Reference

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

Maintenance Registry <maintenance-registry-widget>

PROPERTIES

CSS Class

The name(s) of the CSS class used to customize the widget layout.
Type: STRING | Optional
class="my-custom-class"

Title

The title displayed on the top part of the widget box.
Type: STRING | Optional
[title]="'Details'"

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 label and current value must be rendered into the maintenance table. Other properties will be automatically included into the maintenance details
Multiple | Optional

<property name="serialNumber"></property>

Property <property>

PROPERTIES

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"

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"

Show Header

The flag indicated whether the header is visible.
Type: BOOLEAN | Optional | Values:

true

false

[showHeader]="true"