Skip to content

Haiyz Console Community Status

Start Products Data Hyz AI Sharing and teams Developers Enterprise Tools platform

Start
Products
Data
Hyz AI
- Hyz AI
- Prompt cookbook
Sharing and teams
Developers
Enterprise
Tools platform
- Tools platform
- Quotas and fair use
Community authoring
Reference
- Plans and limits
- Docs Changelog

Docs

Documentation

Documentation

How every part of Haiyz works — the products, the data behind them, the API, and the rules that decide who sees what.

What do you want to do?

Use a productWorkspace, Maps, Dashboards, Field and Hyz Desktop — one guide each.
Get data inUpload a file, bundle a data room, or point at a live source.
Call the APIBase URL, authentication, every endpoint with a request you can copy.
Share with peopleRoles on every object, groups, projects and the public Catalog.

Everything, by section

Start

Getting startedFrom an empty account to a published map and a dashboard built on it, in about ten minutes.
How the Platform WorksHaiyz is one geospatial platform an organization runs — on the desktop, in the browser, in the field, and through an API — organised in three categories. This guide covers the shape of the platform, then the model everything published on it follows.
GlossaryEvery term this documentation uses, in English and Arabic, next to the thing it names.

Products

Hyz WorkspaceThe browser GIS workbench: bring data in, run tools, inspect and style layers on a live map, and share what you made.
Hyz MapsSaved, self-contained interactive maps you publish from the workspace and share with named people.
Hyz LayoutA printable sheet about one to five things from a data item: arrange it, let the small maps show where they are, save it as a template, and export the PDF.
Sheet referenceEvery block you can place on a layout, page setup, the three extent modes, document numbers, map series and publishing a template.
Hyz DashboardsOperational dashboards over your data items, portals and groups — widgets that filter each other, stored on the server, shared by person, group, link or publicly.
Hyz FieldField data collection: design a form, send collectors out with their phones — offline included — and get clean GeoJSON back, or write approved records straight into an editable layer.
Hyz DesktopThe native desktop workbench — local compute on your own machine, signed into the same platform, with Hyz Layers checked out for offline editing. In development; early access by invitation.
ProjectsWhere one piece of work lives: the data, maps, dashboards and field campaigns that belong together, and the people working on them.
WorkbenchYour operations home: one card per product showing what you own, how much of your plan is left, and what you touched last.

Data

Data overviewThe four data surfaces — items, rooms, live sources and open data — and which one a piece of work belongs on.
Kinds of dataItems, versions, layers, tables, hosted and published layers, editable layers, linked items, hard copies, snapshots and rooms — what each is, and one table saying what each can do.
Life of a data itemThe states a data item moves through — uploaded, scanned, hosted, published, editable, snapshotted, replaced, deleted — and what each state allows.
Editable or notThe one question people ask most, settled: what can be made editable, what cannot and why, what to do instead, and what is read-only on purpose.
Data ItemsHosted data with versions: uploading, validation, virus scanning, sharing, data rooms and storage quotas.
Data RoomsA named bundle of data items you hand to a client or a team, pinned at a version and governed by roles.
ServicesOne path for data on Haiyz: a file becomes a data item, a data item becomes a service — read-only or editable — and the service is what maps, field campaigns and dashboards use.
Live sourcesPoint Haiyz at a portal layer instead of uploading a file — and freeze a hard copy the day you need one.
Open DataA library of open geospatial sources — documented once, searchable in Arabic and English — from which signed-in members pull data into their own items.
Published layersReference a published layer in a workspace, copy it when you need a snapshot, and present it at a pinned revision — when to do which.
Editable layersSwitch editing on for a Hyz Layer, set the rules and locks, edit in the browser or offline in Hyz Desktop, and keep history as snapshots.
Who may editThe two questions every edit must pass, the six editing permissions, which roles carry them on the item and in the organization, what always wins, and how feature locks work.
Editing rulesAllowed operations, geometry, editable and required fields, own features only, the editing area, locked-by-default features and the conflict policy — each with the refusal it produces.
Editing in the browserThe Edit, Rules, Locks, History and Snapshots tabs, the map modes, how a save is answered per change, and what the panel says when it is not there.
Editing in Hyz DesktopWhat a checkout is, how to take one, editing within the server's capabilities and locks, syncing, resolving conflicts, renewing a checkout and checking in as a copy.
Feeding a layer from FieldPoint a campaign at an editable point layer, approve records, and get features created by the collector through the same checks as every other edit; build a review queue from three settings.
History and snapshotsThe edit log and its retention, snapshots as versions, what restore does step by step, why uploads are blocked while editing is on, and what is deliberately not remembered.
Why an edit was refusedWhole-request refusals and per-change outcomes in the words the clients show, what each means, what to do, and in what order the server checks them.

Hyz AI

Hyz AIA drafting assistant for dashboards, map symbology and data item descriptions. Only the schema leaves the platform — field names and types, never your rows.
Prompt cookbookPrompts that work, grouped by the job — styling a map, writing popups, building a dashboard, drafting a report.

Sharing and teams

Sharing and rolesWho can see what, on every object: the three ways to share and the role each one grants.
GroupsA named set of people you grant things to once, instead of inviting the same five names to every room.
CatalogPublish a dashboard, a map, a data room or a layout for everyone — and copy anyone else's into your own space.
Account and devicesSign-in without a password, the sessions your account is carrying, and how to end one.

Developers

Hyz APICall the same geoprocessing engine the browser products use, from your own systems, with an organization key.
API referenceBase URL, authentication, the response envelope, and every endpoint with a copy-pasteable request.
API tool referenceEvery tool the catalog exposes, with its wire fields, accepted formats and engine ceilings.
Errors and limitsWhat each failure code means, when its window clears, and how much a call costs you.
WebhooksThe contract your endpoint is written against: what we send, how it is signed, how long you have to answer, and what happens when you do not.
Hyz MCPConnect Claude, ChatGPT, Cycls or any MCP client, and what an agent may and may not do in your name.

Enterprise

OrganizationsWhat an organization changes: seats, the console, shared templates and entitlements.
Haiyz EnclaveThe same platform running inside your own network, and the handful of things that behave differently there.
Products and user typesEvery Haiyz product, and exactly what each user type may do with it — generated from the platform's own roles.

Tools platform

Tools platformThe catalog, who may run what, what a run produces and where its output lands.
Quotas and fair useThe ceilings a run meets: file sizes, rates, windows and what each plan includes.

Community authoring

How to Use StudioStudio is where contributors write. This guide covers the whole path: opening a draft, writing it in blocks, filing it under the taxonomy, and submitting it for review.
Become a ContributorContributors write the GIS knowledge on Haiyz. This is who can apply, how the application works, and what the role actually involves.
Content Rules & ReviewThese are the rules a reviewer applies to your submission. They are published so that you can apply them first.
How Haiyz WorksOne article, end to end: written by a verified contributor, filed under a scientific GIS taxonomy, and delivered to the readers who follow that subject.

Reference

Plans and limitsWhat each plan includes, which ceilings you can meet, and what happens when you reach one.
Docs ChangelogWhat changed in the documentation, newest first. API contract versioning lives in the OpenAPI document itself; this page records documentation changes.

Recently updated

2026-09-21Data RoomsData
2026-09-21ServicesData
2026-09-21Hyz MCPDevelopers
2026-09-21Haiyz EnclaveEnterprise
2026-09-21Products and user typesEnterprise

Not what you were looking for?

These guides cover the platform itself. Three other places answer the questions they do not.

SupportHelp articles, contact, and enterprise support.
PricingWhat each plan includes across the three categories.
Join the communityCreate an account, or apply to write.