.. include:: ../variables.rst

.. _scheduling:

Scheduling
==========

The Scheduling page is where you plan your audit coverage. A
*schedule* is a target observation count for a single facility, unit,
shift, and time period — for example, "100 hand-hygiene observations
on 1 South, dayshift, May 2026." Schedules feed the
:ref:`audit.progress` heatmap so you can see at a glance whether your
team is on pace to meet its Leapfrog or accreditation targets.

To open the Scheduling list, go to :blue:`Account` |
:blue:`Advanced` | :blue:`Scheduling`.

.. _scheduling.list:

Schedule List
-------------

.. figure:: /images/lightmode/audit-schedule-list.png
   :align: center

|br|

The list groups schedules by facility, then by unit, so you can
fold an entire site away when you only need to look at one area.
Click the chevron on any facility or unit header to collapse or
expand its schedules.

Stat Cards
^^^^^^^^^^

Cards across the top give you a rollup of the filtered list:

* ``Schedules`` --- the total number of schedules that match the
  current filters.
* ``Active`` --- schedules currently turned on. Inactive schedules
  are kept for the audit trail but do not appear in
  :ref:`audit.progress`.
* ``Pending Assignments`` --- the total number of unfilled
  observation assignments across all listed schedules.

Page Header Actions
^^^^^^^^^^^^^^^^^^^

The blue ``Schedule`` button opens a small menu:

* ``Build a Full Schedule`` --- opens the
  :ref:`scheduling.build` workspace, which generates one schedule
  per active unit per remaining month of the current fiscal year
  using each unit's monthly Leapfrog target. This is the fastest
  way to populate a fresh account.
* ``New Schedule`` --- opens the :ref:`scheduling.editor` to
  create a single schedule by hand.

Filtering
^^^^^^^^^

* ``Search facility or unit…`` --- match text anywhere in the
  facility or unit name.
* ``Active`` / ``Inactive`` / ``All`` --- restrict the list to
  schedules in a particular state (defaults to ``Active``).
* Refresh --- reload the list.

Row Columns
^^^^^^^^^^^

Schedules are grouped by facility, then by unit. Each schedule row
shows:

* ``Status`` --- ``Active`` (green) or ``Inactive`` (grey).
* ``Month`` --- the start and end dates the schedule covers; click
  the link to open the editor.
* ``Period`` --- ``Weekly`` or ``Monthly``.
* ``Shift`` --- ``All``, ``Day``, ``Evening``, or ``Night``.
* ``Target`` --- the number of observations planned for the
  period.
* ``Pending`` --- how many of the planned assignments are still
  unfilled.
* ``Assignees`` --- who is responsible for the observations. A
  pill shows the assigned auditor's name, the number of observers
  when more than one is assigned, or ``Unassigned`` when nobody is
  yet attached.

Row Action Menu
^^^^^^^^^^^^^^^

Click the three-dot icon at the end of any row:

* ``Edit`` --- opens the :ref:`scheduling.editor`.
* ``Delete`` --- removes the schedule and all of its assignments
  after confirmation.

.. _scheduling.editor:

Schedule Editor
---------------

.. figure:: /images/lightmode/audit-schedule-detail.png
   :align: center

|br|

The schedule editor opens as a modal dialog. Fill in the scope and
target, then ``Save``:

* ``Facility`` --- the facility the schedule applies to.
* ``Unit`` --- the unit within that facility. Choose ``(any
  unit)`` to apply the schedule across the whole facility.
* ``Moment`` --- restrict the schedule to a single WHO moment, or
  choose ``All moments`` to score every moment.
* ``Period`` --- ``Weekly`` or ``Monthly``.
* ``Shift`` --- ``All shifts``, ``Day``, ``Evening``, or
  ``Night``.
* ``Target observations`` --- the planned number of observations
  for the period. Click ``Recommend`` to fill this from the unit's
  Leapfrog target if one is configured.
* ``Starts`` and ``Ends`` --- the date range the schedule covers.
* ``Active`` --- ``Yes`` to include this schedule in
  :ref:`audit.progress`, or ``No`` to keep it for history without
  counting it toward coverage.

When you edit an existing schedule, a red ``Delete`` button appears
in the footer for one-click removal.

.. _scheduling.build:

Build a Full Schedule
---------------------

.. figure:: /images/lightmode/audit-schedule-build.png
   :align: center

|br|

The ``Build a Full Schedule`` workspace generates a complete year
of monthly schedules in one step. For every active unit in the
chosen account, |APPNAME| creates one schedule per remaining month
of the current fiscal year, sized to the unit's monthly Leapfrog
target.

How to use it
^^^^^^^^^^^^^

1. Pick an account from the ``Account`` dropdown. The build plan
   summary updates to show how many units would be touched and how
   many monthly schedules would be created.
2. Click ``Preview`` to see exactly which units and months would
   be created or updated, without making any changes.
3. Click ``Build`` to commit the schedules to the database.

What is preserved and what is replaced
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

* Existing schedules for the same unit and month are **updated in
  place** — the new target replaces the old.
* Pending assignments under those schedules are **replaced**. Use
  Build at the start of the year, before observers start picking
  up assignments.
* Completed and accepted assignments are **preserved**. You will
  not lose any audit work that has already been done.