Appearance
Preface
This manual describes how to configure and operate an Omaya organisation from the web-based admin console: signing in, describing a site, positioning tags, writing rules, reading the reports and keeping a record of who did what. Each chapter covers one area of the console. The final part, Menu reference, describes every item in the admin menu and is generated from the menu itself.
Intended audience
This manual is intended for:
- Building and facility administrators who set up sites, floors, rules and reports
- IT administrators and system integrators who connect gateways, sensors, identity providers and other systems to Omaya
- Support staff who answer questions about what a screen shows and why
Readers are expected to be familiar with the building they manage and with basic web-application concepts such as roles and permissions. No programming knowledge is required for any procedure in this manual.
Technical support
- The What's new page lists the changes in each release: What's new.
- The admin console is the authoritative source for what an organisation can see and change: return to Omaya.
- For a question this manual does not answer, contact the Omaya provider that operates your organisation, through the support channel agreed in your contract.
Conventions
| Convention | Meaning |
|---|---|
| Bold | A button, window, panel, tab, card, field, menu item or message shown on screen, for example Save, Indoor Positioning, Not Permitted. |
> | A path through a multi-level menu or through the cards and tabs of a page. "Choose System > Configuration > AI" means: open the System menu, choose Configuration, then click the AI card. |
Monospace | A value typed exactly as shown, a URL path in the console (/admin/config), a placeholder in a message template, or a permission name (manage-config-general). |
| Italic | The text of a message shown by the console, quoted exactly, for example Settings saved successfully. |
| (1) (2) (3) | The steps of a configuration roadmap, in the order they must be carried out. |
Menu paths are written from the admin side rail. A page that also opens from a card or a link is given by its menu path unless stated otherwise.
Structure of a configuration section
A section that configures a function is laid out in this order. A part that does not apply to the function is left out.
| Part | Content |
|---|---|
| Applicable versions / plans | A specification notice: the permission, module and device types the function requires. |
| Requirements | An example scenario and the goals the configuration meets. |
| Restrictions | Limits, prerequisites and values enforced by the product. |
| Configuration roadmap | The steps of the procedure, one line each. |
| Procedure | Numbered steps. Values are given in a Configuration Item | Value | Note table, in the order the fields appear on the form and with their exact labels. |
| Verification | What the console shows when the configuration has worked, and the messages it shows when it has not. |
Example organisation
Examples use a fictional organisation, Northwind Tower, an office building. Its staff appear only in the Requirements of a section, to set the scenario:
| Person | Role in the examples |
|---|---|
| Aisha Rahman | Facilities Manager; holds the Admin role |
| Ravi Kumar | Operations Lead; holds the Manager role |
| Daniel Lim | Technician; installs gateways, tags and sensors |
| Mei Ling Tan | Receptionist; uses Visitor Management and Meeting Room |
| Siti Nur | Cleaner; uses Toilet Hygiene |
| Hafiz Ismail | Security Guard; uses Security Watch and Roll Call |
| Kumar Selvam | Security Supervisor |
| Farah Aziz | HR & Safety Officer; runs Roll Call |
Names, rooms and figures in the examples are illustrative. Use the values of your own site.
Signs
The signs below are used throughout this manual. Each has one fixed meaning.
| Sign | Meaning |
|---|---|
| DANGER | An action that can cause physical injury, for example working at height to mount a gateway, or relying on a safety alert that may not be raised. |
| WARNING | An action that can cause the loss of data or damage to equipment, for example deleting history that cannot be restored, or sending a setting that disconnects a device. |
| CAUTION | A condition under which a function fails or works worse than expected if it is ignored. |
| NOTE | Supplementary information: a tip, a background explanation or a related setting. |
| SPECIFICATION | The products, versions, plans, modules, permissions or device types a section applies to. |
DANGER
Example of a danger notice.
WARNING
Example of a warning notice.
CAUTION
Example of a caution notice.
NOTE
Example of a note.
SPECIFICATION
Example of a specification notice.
Roles used in this manual
Permissions are granted to roles under System > Roles. Where a procedure needs a permission, its Applicable versions / plans notice names it. The roles an organisation is created with are Admin, Manager and Viewer; their permissions as shipped are listed in Roles and permissions.