Asset classes

Making a class¶

An asset class is a kind of asset — Pump stations, Valves, Networks — with the attributes each of its assets carries. In Hyz Portal › Hyz Assets, New asset class:

1. Enterprise — one where you may manage assets.
2. Name — in English and Arabic (at least one).
3. Each asset is — a point, a line or an area.
4. Its attributes — the class's own form: text, number, choice, yes/no or date fields, each with a label in both languages. A key is lower-case letters, digits and _, starting with a letter. The platform's own columns (asset_id, parent_id, service_status, last_edited_at, last_inspected_at) cannot be attributes: every asset layer has them already.
5. Make the class.

Making it makes the class's asset layer: a data item of the enterprise built from that form, with editing switched on, and served from the start as a private, editable Hyz Service of the enterprise. That service is the class's, not the plan's: it does not count against the Hyz Services limit — the asset classes limit bounds it — and it cannot be unpublished, nor the data item deleted on its own, while the class exists. Renaming the class renames its layer and its service.

The enterprise's limits on data items and on editable layers still apply.

Measurements and the live layer¶

Measurements are what a class measures, each with its unit — Temperature in °C, Pressure in bar. On the class's page, Measurements › Edit measurements: a key (the same rule as an attribute's), a name in both languages, a unit and a type — Number, Whole number or Yes / no. Up to 50. Five keys are the live layer's own and cannot be measurements: asset_id, reading_at, alert_state, open_events, last_event_at.

The first measurement makes the class's live layer — a data item named after the class (Pump stations — live layer), one point per asset (a line asset's middle, an area's centroid), with the columns:

Column	Holds
asset_id	the asset
one per measurement	its newest value
reading_at	the time of the newest reading
alert_state	normal, alerting, stale or none — see Readings
open_events	how many of its events are open
last_event_at	when its latest event began

Nobody edits a live layer: the platform writes it from the readings. It is served as a private, read-only Hyz Service, not counted against the plan either. Maps and dashboards use it like any layer.

Changing the measurements later:

• A name or a unit changes the list and nothing else.
• A key added or removed re-makes the live layer's table with every asset's row carried over. The data item, its layer and its service stay the same, so a map or dashboard bound to it stays bound; a widget or a style that named a removed measurement loses that column, as on any layer.
• A measurement a sensor maps, or a rule watches, cannot be removed — the refusal names them; change those first.
• Removing every measurement keeps the live layer, with its own columns only.

Readings expected every¶

The class's Settings › Readings expected every — 5 minutes, 15 minutes, 1 hour, 6 hours, 1 day, 7 days or 30 days (30 days unless you choose). A switched-on sensor that has sent nothing for longer reads Stale, and so does its asset; a rule on A sensor goes quiet uses this same interval. See Readings › Stale.

Deleting a class¶

Delete the class on its page. Before anything goes the dialog says what will: its assets, its sensors, their readings (and how many of them its events keep), the rules on the class, and its events. It offers Save as version and download — a copy of the asset layer to keep — and asks for the class's name, typed. Deleting takes the asset layer and every asset, the live layer, the sensors with their keys and readings, the rules on the class and its events. The audit trail keeps one row with the counts.

What a class's page holds¶

• Assets — a table of its assets with their service status and alert state, each opening its page.
• Measurements and Sensors (once it measures something) — see Sensors.
• Inspection campaign — the Hyz Field campaign a task on one of these assets is opened in: one whose task layer is this class's asset layer. Choose one of yours aimed at the layer, or Make a campaign (a draft, aimed and linked — add its form and its people on its page), or unlink it.
• Its layers — Open the asset layer, Open the live layer.
• Connections — the class at the head of its chain: class → sensors → data items → service → data rooms → maps → dashboards, with the rules that watch it and the campaigns that work on its asset layer beside it. A class with more than five sensors shows them as one card — how many there are and how many are stale, off or switched off by Haiyz; open it to list those that need attention first.
• Settings — the name and Readings expected every.