Rules

When this happens, do these¶

A rule names one thing to watch and what follows when it happens. Rules belong to an enterprise and come with the platform for every enterprise; the three triggers on assets need Hyz Assets. They are in Hyz Console › Licenses and apps › Rules, beside the webhook endpoints they can deliver to. Every member reads them; owners, administrators and members given Rule manager make and change them. Each rule reads as a sentence on its card — When Temperature of every asset of Pump stations is above 80 °C for 3 readings in a row — with its actions, its state, its open events and when it last fired.

What it watches¶

Trigger	Watches
A reading passes a limit, or a position leaves a zone	a class — every asset of it, one found by name, or the assets where an attribute of the class has a value (the boxes whose Hub is Yes) — and either a measurement against a limit (above, at or above, below, at or below a value; a yes/no measurement is watched for being on or off instead) or a position against a zone, for N readings in a row (1 to 100)
A sensor goes quiet	a class, one asset, or the assets where an attribute has a value: no reading for longer than the class's Readings expected every, shown on the form with a link to the class's settings
An asset's service status changes	a class: from one status to another, or any
A Hyz Field record is approved	a campaign collecting into the enterprise's data, or whose tasks are about it
A Field task is overdue	a campaign whose tasks are about the enterprise's data: a task past its due date and not done, found every five minutes and recorded once

N readings in a row is the debounce: a value that goes past the limit and back before N in a row opens nothing.

What it does¶

A rule lists one or more actions, at most one of each:

• Notify in the app — a notification to the people the rule names: roles of the enterprise, its groups, or members.
• Send an e-mail — the same message by e-mail, to the same kind of audience: people with an account in the enterprise, each in their own language, with a link to stop such mail. Never an address outside it.
• Send to a webhook — the event to the enterprise's signed webhook endpoints: every endpoint that subscribes to it, or one the rule names. This is the only way a rule calls out: there is no other address, header or body.
• Open a Hyz Field task — on a trigger about assets: a task on the asset the event is about, in a campaign whose task layer is the class's asset layer (the class page's Inspection campaign), for a member of that campaign or — unclaimed, for any of its collectors — a group, due so many hours later, with the rule's name as its reason. One task when the condition begins; none when it clears; and while that task is not done, a new episode on the same asset opens no second one. The collector records on the phone, the reviewer approves, and the asset changes — its service status, its Last inspected — as the reviewer's own edit.

Also when it clears runs the actions again when the condition ends by itself — a reading back within the limit, a quiet sensor reporting again — never when a person, a switch or a deletion closed it.

Who hears what: a crossing, a zone left and a quiet sensor are told only through the rule's own actions. A service status changed and a record approved are told to their usual audience anyway; a rule on them adds its actions to that same notification, and nobody is told twice. A person's own notification settings win over any rule: in-app off, e-mail off or an unsubscribe holds.

The zone check¶

A position against a zone names one of the enterprise's Tool APIs that runs the inside check, and whether to fire when a reading's position fails the check or passes it. Every positioned reading of a request is checked in one evaluation against the Tool API's bound layer — read live, so an edit of the zone counts at once. The check is the platform's own work: it is not a call of the Tool API — no key, nothing counted against the enterprise's API requests or the Tool API's rate, no call record, no traffic.

When the Tool API is switched off — by the enterprise, by Haiyz, or its tool — the zone check judges nothing, and the rule says Zone check paused; switching a Tool API off warns first, naming the rules that use it.

Changing a rule¶

• A new name, new actions, or also when it clears leaves its open events open.
• A change of what it watches — the trigger, the class or asset, the measurement, the comparison, the limit, N, the zone, the statuses, the campaign — closes its open events (Closed when its rule was switched off or changed) and judges only the readings that come after.
• Switch off closes its open events; switched on, it starts afresh. Delete leaves its events on the events list, under the rule's name.
• A measurement a rule watches cannot be taken from its class until the rule is changed or deleted.

The ceiling¶

A rule whose actions ran more than 60 times in an hour has its actions paused — the card reads Actions paused, and the enterprise's owners, administrators and Rule managers are told. Detection goes on: events still open and close, their readings are still kept, alert state still follows. Resume runs the actions again and counts the hour afresh. (60 is a platform setting; a self-hosted instance sets its own.)

What it fired¶

What it fired on a rule's card lists each firing, newest first: Started, Cleared or Fired, each action with its outcome — done, no one to reach, held by Haiyz, paused, not available here or failed — and Open the event. Firings are kept 90 days. The asset's page shows the same under What rules did.

When Haiyz holds them¶

Haiyz can switch off an enterprise's rules, or its whole Hyz Assets. Either way detection goes on and every action of the rules concerned reads held by Haiyz; the rules page says so, with the reason. See Holds and limits.