.. include:: ../variables.rst
.. _menu:

Main Menu
=========

The |APPNAME| web interface has two persistent menus. The
**top bar** runs along the very top of every screen and holds the
product branding, system-wide controls, and your profile. The
**sidebar** runs down the left-hand side and is your launch pad for
every feature in |APPNAME|. Between the two, you can reach anything
in the application in one or two clicks.

.. figure:: /images/web/top.menu.png
   :align: center
   :width: 100 %

|br|

The Top Bar
-----------

.. figure:: /images/web/top.menu.png
   :align: center
   :width: 100 %

|br|

Reading the top bar from left to right:

* **Hamburger button** (``☰``) — collapses the sidebar to a narrow
  icon strip so you have more room for the dashboard on smaller
  screens. Click it again to expand the sidebar back out.
* **Product logo and slogan** — a click on the logo returns you to
  the main :ref:`Dashboard<dashboard>` from anywhere in the
  application.
* **LIVE badge** — a quick indicator that the current page is
  wired up to the live data feed rather than a static or cached
  view.
* **Theme toggle** (sun / moon) — flips the whole interface
  between light and dark themes. Your choice is remembered per
  device.
* **Mobile-mode switch** (phone icon) — jumps into the
  streamlined :ref:`Mobile Mode<mobile.mode>` layout. Handy for
  tablets when you want the auditor-friendly view without signing
  in on a phone.
* **Profile button** — shows your initials on an avatar, your
  user name, and your role. Click it to open the profile dropdown
  described below.

The Profile Dropdown
^^^^^^^^^^^^^^^^^^^^

.. figure:: /images/web/top.menu.profile.png
   :align: center
   :width: 100 %

|br|

Clicking the profile button opens a dropdown that pulls together
the things you are most likely to need next:

* A summary card showing your avatar, user name, email address,
  and a coloured ``Administrator`` / ``Manager`` / ``Auditor``
  role badge.
* A ``Status`` row showing whether your account is **Active**,
  **Suspended**, or **Expired**.
* ``My Profile`` — opens your user profile where you can update
  your name, password, notifications, and two-factor settings.
* ``Dashboard`` — a one-click shortcut back to the main
  :ref:`Dashboard<dashboard>`.
* ``Help & Support`` — opens this help site in a new tab.
* ``Sign Out`` — ends your session and returns you to the sign-in
  screen.

The Sidebar
-----------

.. figure:: /images/web/side.menu.png
   :align: center
   :width: 100 %

|br|

The sidebar is grouped into labelled sections so similar tasks sit
together. Depending on which edition of |APPNAME| you have, and
which features your administrator has enabled, some items may be
hidden or disabled.

.. list-table::
   :widths: 20 80
   :header-rows: 1
   :align: center
   :width: 100 %

   * - Section
     - What's inside

   * - **MAIN**
     - Your home base: the :ref:`Dashboard<dashboard>`.

   * - **ACCOUNT**
     - Everything about **who** is in the system and **where** they
       work: :ref:`Accounts<accounts>`,
       :ref:`Facilities / Floors / Units<facility.list>`, Groups &
       Programs, Users, and Custom Audits. The Advanced sub-menu
       below it adds Regions, :ref:`Notes<observation.notes>`,
       :ref:`Targets<targets>`, Health Care Providers, XML
       Compliance Data, Reminders, Keyword Manager, Audit Devices,
       Color Ranges, Digital Signage, and the
       Incentives sub-group (:ref:`Challenges<challenges>`,
       Badges, and Points Ledger).

   * - **AUDITS**
     - The day-to-day auditing view: live **Custom Audit Sessions**
       and **Hand Hygiene Sessions**.

   * - **REPORTS**
     - Everything to do with reports: the
       :ref:`Reports<ReportsLink>` list, :ref:`Distribute<distributionlists>`,
       Archive, and :ref:`Report Groups<report.groups>`.

   * - **SYSTEM**
     - Administrative tools — Alerts, Help, and :ref:`About<about>`.

Sidebar Controls
^^^^^^^^^^^^^^^^

* **Section labels** (``MAIN``, ``ACCOUNT``, ``AUDITS`` …) — not
  clickable; they only group the items beneath them.
* **Top-level menus** — click to expand or collapse the items
  inside. A chevron on the right of each menu points right when
  collapsed and down when expanded.
* **Sub-group menus** — some sections (for example ``Users`` or
  ``Incentives``) contain a further level of nested items. Click
  the sub-group header to expand or collapse it.
* **Footer** — your avatar, user name, and role are pinned to the
  bottom of the sidebar for quick reference. A sign-out icon sits
  on the right of that row.

.. note::

   If a menu item appears dimmed, your role does not currently
   have rights for it. Speak to your |APPNAME| administrator if
   you need access; they can grant it from the Roles editor
   without you losing your place.

.. tip::

   You can navigate |APPNAME| entirely from the sidebar, but
   every page also has shortcuts for common next steps — row
   menus on tables, action buttons in page headers, and tabs on
   detail pages. If a task takes more than one sidebar click to
   reach, there is usually a faster route already built into the
   page you are on.