.. include:: ../../variables.rst
.. _ReportsLink:

Reports
=======

A **Report** in |APPNAME| is a saved definition that tells the system
what to produce, how often, and in what format. Once you set a
report up, |APPNAME| runs it on a schedule (generally just after
midnight) so the latest version is always waiting for you. You can
also run a report by hand at any time to get a fresh copy
immediately.

Every report definition carries:

* A **name** — how the report is shown everywhere in |APPNAME|.
* A **report type** — what the report is actually measuring (for
  example, a compliance trend, an anatomy breakdown, or a facility
  summary).
* A **format** — ``PDF``, ``CSV``, ``XML``, ``HTML``, ``PNG``, or
  ``Excel``.
* A **period** — a dynamic time range such as ``Last Month``,
  ``This Quarter``, ``Fiscal Year``, or ``Last 90 Days``.
* A **scope** — the facility, patient care area, program, or unit
  the report covers.
* An **owner** — the |APPNAME| user responsible for the definition.

Because the period is dynamic, a report defined once keeps producing
meaningful output month after month without anyone having to edit
it.

To open the list, go to :blue:`Reports` | :blue:`Reports`.

The Reports Page
----------------

Summary cards across the top of the page show:

* **Total Reports** — how many report definitions exist on the
  account.
* **PDF Reports**, **CSV Reports**, **Excel Reports** — counts by
  output format.
* **Report Formats** — the number of distinct formats in use.
* **Updated <1hr** — how many reports finished refreshing in the
  last hour.
* **Unique Types** — how many different report types are in use.
* **Stale Reports** — reports whose last-run date is older than the
  cadence the system expects.
* **Running Reports** — reports currently generating. While any
  reports are running the chip turns red so you can see at a glance
  that work is in progress.

Page Header Buttons
^^^^^^^^^^^^^^^^^^^

* ``Actions`` — opens a menu with:

  * ``Update Selected`` — re-runs the ticked reports.
  * ``Update All`` — re-runs every report on the account.
  * ``Clone Selected Reports`` — makes a copy of each ticked
    report, ready to be renamed and tweaked.

* ``Export`` — opens a menu with ``Export to HTML``,
  ``Export to CSV``, and ``Export to Excel``. The export contains
  whatever rows are currently visible after searching and
  filtering.
* ``New Report`` — opens the report editor with a blank form so you
  can define a new report.

Searching and Filtering
^^^^^^^^^^^^^^^^^^^^^^^

The toolbar above the table holds the search box and a row of
filter drop-downs:

* **Search box** — matches on the report name.
* **All Facilities** — narrow to a single facility.
* **All Patient Care Areas** — narrow to a patient care area inside
  the selected facility.
* **All Owners** — narrow to a specific owner.
* **All Report Types** — narrow to one type of report.
* **All Report Formats** — narrow to one output format (``PDF``,
  ``CSV``, ``Excel``, and so on).
* **All Periods** — narrow to a specific time period.
* **All Categories** — narrow to a user category.
* **All Reports** — filter by status: ``Running`` (generating right
  now) or ``Completed``.

A refresh button on the right reloads the page from the server.

Table Columns
^^^^^^^^^^^^^

* ``Report Name`` — the name of the definition. Click the heading
  to sort.
* ``Owner`` — the user who owns the report.
* ``Report Type`` — the kind of report being produced.
* ``Report Format`` — the output format.
* ``Period`` — the time range the report covers.
* ``Lang`` — the language the report is rendered in.
* ``Age`` — how long ago the report was last refreshed.
* ``Size`` — the size of the most recent generated file.

Tick the checkbox at the left of a row to select it; tick the
header checkbox to select every row on the page. Selecting rows
lights up the ``Actions`` and ``Export`` buttons.

Row Actions
^^^^^^^^^^^

Click the three-dot button at the end of a row to open the row
menu:

* ``Refresh`` — re-runs just this report so the latest numbers are
  ready.
* ``View Report`` — opens the most recent copy of the report.
* ``Edit`` — opens the report definition in the editor.
* ``Clone Report`` — makes a copy of the definition you can
  rename and tweak.
* ``Delete`` — removes the report definition after a confirmation
  prompt.

The rest of this chapter covers the pieces that make up a report
definition — the logo, the definition fields, dynamic report-name
tags, the anatomy of a report, legends, how to handle empty
periods, the report request policy, report styles, the Keyword
Manager, distribution lists, the archive, and report groups.

.. include:: logo.rst
.. include:: definitions.rst
.. include:: dynamic.report.name.tags.rst
.. include:: anatomy.rst
.. include:: legends.rst
.. include:: included.in.edition.rst
.. include:: no.data.rst
.. include:: report.request.policy.rst
.. include:: styles.rst
.. include:: key.word.manager.rst
.. include:: distribution.rst
.. include:: archive.rst
.. include:: groups.rst
.. include:: sharing.rst