Glossary

How to read this¶

Haiyz names a small number of things precisely and reuses those names everywhere. The terms below follow the shape of the platform: data, the surfaces you work on, sharing, and what your plan allows.

Data¶

Term	What it is
Data item	One named piece of data you own, at /data/items. A container, not a file: the files sit inside as versions.
Version	One file inside a data item. Uploading again adds a version rather than overwriting the last; a snapshot of an editable layer is a version too.
Clean version	A version whose virus scan came back clean. Only a clean version is downloaded or copied into a map.
Scan status	Where a version stands with the scanner — pending, clean, infected or unsupported. A fresh upload starts at pending.
Data room	A named bundle of specific versions, shared as a unit with a client or team, with its own access log.
Live source	A layer on an external portal (Esri REST, WFS…) that Haiyz points at instead of storing. It moves when the portal does.
Hard copy	An ordinary data item taken from a live source at one moment — no connection, no refresh — so an analysis stops moving.
Hyz Layer	The copy of a clean version's geometry in the platform's spatial database, in the owner's own schema. What maps query, services publish and people edit. See Kinds of data.
Published layer	A ready Hyz Layer served as tiles, features and OGC endpoints under a stable reference, with a revision that moves when the data moves.
Editable layer	A ready Hyz Layer whose owner switched editing on. Its rows are the live truth; the upload stays as uploaded. See Editable layers.
Feature lock	A flag on one feature that refuses every change from everyone, the owner included, until someone with the lock permission clears it.
Editing area	A polygon set on an editable layer; new and moved features must fall inside it, and features outside it cannot be changed. Also called the fence.
Sync version	The editable layer's counter, one step per applied batch of edits. Hyz Desktop asks for "everything since" it; snapshots record it.
Snapshot	The live rows of an editable layer stored as a version of the item, marked Snapshot. Downloadable, shareable and restorable; never a layer of its own.
Checkout	Hyz Desktop's copy of an editable layer with a baseline, taken to edit offline and sync back. Expires after a set time or when the layer is restored.

Working surfaces¶

Term	What it is
Workspace	/workspace — where you load layers, run tools and read the attribute table. Work happens here, publishing elsewhere.
Layer	One data item drawn on a map, with its own style, order and visibility. Tool results arrive as new layers.
Session layer	A layer added to an open map and not yet saved into it. Visible only to you until you save.
Sketch	Geometry you draw by hand — a boundary, a note, a correction. It can become a layer of its own.

Maps¶

Term	What it is
Map	A saved, interactive publication of layers and styling, at /maps. The API calls it a presentation.
Basemap	The background the data sits on — satellite, street, light or dark. A map remembers which it opens on.
Symbology	Rules turning attribute values into appearance — colour by category, colour or size graduated across a range.
Popup	What a clicked feature shows: every field, a chosen set with your labels, a {field} text template, or nothing.
Label	Text drawn from a field onto the map, with its own size, colour, halo and zoom threshold.
Cluster	Nearby points drawn as one counted circle instead of a crowd, within a radius you set.
Layout template	A saved print sheet — blocks, positions, page setup — reusable across maps. Arrangement only, never data.

Dashboards and field work¶

Term	What it is
Dashboard	A saved set of pages and widgets built on your data, at /dashboards. It reads its sources, never copies them.
Widget	One element on a page — indicator, chart, table, map, selector. Selectors emit filters the other widgets obey.
Source binding	Where a widget's numbers come from: a data item, live source, Hyz Map, field campaign or static values. Unbound draws nothing.
Field campaign	A form and its assignments in Hyz Field, collected on a phone online or off. The API calls it a survey.
Submission	One filled-in record returned by a campaign, reviewable before it is used.

Sharing and teams¶

Term	What it is
Project	A named set of references to work that belongs together — items, rooms, maps, dashboards, campaigns, workspaces, groups. It owns none.
Group	A named set of people you grant access to as one — on dashboards and maps as well as data.
Grant	Access given to a group on one object, with a role — viewer or collaborator on a room, viewer or editor on a dashboard.
Share link	A tokenised link to an item or room, with an expiry, a scope and an optional login requirement. Revoking kills the link, not the data.
Catalog entry	The record publishing a dashboard, map, room or layout to the shelf at /tools. The entry is the visibility.

Plans and allowances¶

Term	What it is
Membership tier	Your own plan — Free, Basic, Plus or Enterprise. It decides what is included and how much you may hold.
Seat	An Enterprise entitlement: you own an active organization, or hold an active member row in one. Being listed in one is not a seat.
Entitlement	What the server says this account may do, resolved per request. A client renders it, never works it out.
Allowance	A counted ceiling — items, maps, dashboards, groups, rooms, workspaces, projects, storage. Operators tune them per tier.
Quota	One allowance reported with its current use, so a surface shows used of limit rather than refusing you at the wall.
Tool run	One execution of a GIS tool, metered on its own ledger, separately from storage — see Tool quotas.
Enclave	Haiyz running inside a customer's own network: every limit unlimited, every account Enterprise — see Haiyz Enclave.

Good to know¶

• "Presentation" and "map" are one object — the UI says map, the API says presentation. Nothing was renamed underneath.
• "Survey" and "field campaign" are one object too, for the same reason.
• "Project" is overloaded. The community portfolio at /community/projects is a different thing from a work project at /projects.
• A member row is not a seat — both read as "in the organization" on screen. See Enterprise.
• Objects are hidden, never forbidden. Something you cannot reach answers not found, so an id cannot probe what other people hold.