Install a solution

A ready solution reaches your organisation in one of two ways: you apply its board and flow templates yourself, or the whole solution is installed for you. This page explains both, what each creates, how a full installation is kept up to date and how to remove a solution.

Templates or a full installation

	Templates (you apply them)	Full installation
Who starts it	Any member who may create dashboards (board template) and flows (flow template)	The platform. There is no install page in the console: ask Hermetry support.
Device profiles, alarm rules, commands	Not created. You pick your own profiles when you apply the template.	Created, with every telemetry key, alarm rule and catalog command
Sites, zones, relations	Not created	Created: the solution’s site, its zones, regions or shelters, devices placed in them, and typed relations (CONTROLS, FEEDS)
Devices	Your own	Sample devices with their limit attributes
Board	A board built from the template, with the cards a template can carry	The full board, including cards that read relations or run a compute script
Flows	A new flow from each template you use	The solution’s flows; notification flows stay switched off until a person turns them on

Start with the templates if your devices already exist. Ask for a full installation if you want to see the complete application working before you build your own.

Apply the board template

1. Open Dashboards and select New dashboard.
2. Under Start from, pick the solution’s template: Water site, Remote sites, Weather stations, Sensor regions or Personnel tracking. The preview shows its pages and cards.
3. Answer the template’s questions. A template holds no device or site of any organisation, so it asks you to pick, for example, the device profile whose devices it shows and the site it covers.
4. Enter a Title and select Create.

A template cannot carry everything the full board has:

Left out or replaced	Why	Examples
Cards that read a relation between devices or assets	A template cannot know your relations	The pump stations a tank controls, the UPS that feeds a site, the cameras of a site
Cards that run a compute script	A template card carries no script	The weather readings table, the tracker’s route map
Cards replaced by a plain form	A simpler form of the card still works	The sensor regions map coloured by temperature instead of alarm state; the remote sites map coloured by the door state; alarm counts of the whole organisation instead of the board’s devices

If a widget is not available to you, the new board says how many widgets were left out. See Templates and board files.

Apply a flow template

1. Open Automation and select the Templates tab, or start New flow on the IoT host and choose a template under Start from.
2. Pick one of the solution flows:

Template	What it does
Water site: alarm notifications	Tells the Admin role when an alarm of a tank or pump station opens or clears
Remote sites: alarm notifications	The same for site controllers and UPS gateways
Remote sites: UPS root	A profile root: stores the readings like the default root and raises a warning when a UPS unit stops reporting for 5 minutes
Sensor regions: alarm notifications	The same as the water site flow, for sensors and the weather station
Personnel tracking: alarm escalation	Tells the Admin role when a tracker’s alarm opens, when an operator acknowledges it and when it clears

1. Open the Device message block and pick your profiles under profiles. An empty list means every profile, so a notification flow left that way tells people about every alarm of the organisation.
2. Check the recipients of each Notify block, then deploy.

See Flow templates.

What a full installation creates

Part	Details
Device profiles	One per device kind, named <Solution> · <kind>, for example Water site · Tank. Each has its telemetry keys with labels, units, decimals and ranges, its alarm rules and its catalog commands.
Assets	The solution’s site and its zones (water site), shelters (remote sites), regions (sensor regions), the weather network, or the campus with its zones (personnel tracking)
Devices	Sample devices placed in those assets, each with its limit attributes as server attributes
Relations	Tank CONTROLS pump station; UPS FEEDS site controller
Board	The solution’s board with all its pages
Flows	On the IoT host. A flow made only of low-risk blocks is turned on; a flow that notifies people is stored switched off until a person enables it. The UPS root of remote sites is turned on and bound to the UPS profile.

What is created depends on the modules your organisation has. Without alarms, there are no alarm rules and no alarm cards; without commands, no catalog commands and no control cards; without sites and assets, no assets, placements or relations; without automation, no flows. The device profiles, devices, telemetry and dashboards modules are needed for anything to be created.

Sample devices

A full installation can include sample devices, for example six tanks and six pump stations for the water site. They let you see the board’s layout, its pages and its rules. A sample device is a record only: no real device sends data for it in your organisation, so it stays offline and its cards stay empty. Replace the sample devices with your own devices (see Adapting a solution to your devices), then delete them. Each one counts toward your plan’s device limit while it exists.

Updates and running it again

A full installation finds what already exists by its natural key (a profile by its name, a device by its name, an asset by its code, a rule by its profile and type, a board and a flow by their address) and creates only what is missing. So:

• Running it again changes nothing you changed in profiles, rules, commands, attributes or relations.
• A flow you deleted is never brought back.
• When Hermetry updates a solution’s board, the board is brought up to the new form: cards that carry one of the solution’s card titles are written again, and cards the solution renamed or dropped are deleted. Cards you added under titles of your own are kept.

Remove a solution

There is no uninstall button. Remove the parts by hand, in this order:

1. Flows. Delete the solution’s flows in Automation. A profile root must be unbound or replaced before it can be deleted; see Hosts, the root flow and profile root flows.
2. Boards. Delete the board in Dashboards. Export it first if you may need it again.
3. Devices. Delete the sample devices.
4. Profiles. Delete the profiles. Deleting is refused while devices, alarm rules or commands still use a profile (“Still used by …: move or remove them first.”).
5. Assets. Delete child assets first, then the site. An asset with child assets cannot be deleted.

Troubleshooting

Symptom	Cause
The template is not offered under Start from	Your organisation does not have the IoT add-on, or you may not create dashboards
The new board is missing cards	The template leaves out cards that read relations or run scripts; a widget of a module you do not have is left out
A notification flow tells nobody	It was stored switched off: turn it on in Automation
A notification flow tells about every device	Its profiles list is empty: pick the solution’s profiles
Cards stay empty	The devices send other keys, or they are sample devices that never connect. See A dashboard shows no data.

Related

• Start from a ready solution
• Adapting a solution to your devices
• Flow templates