2. About This Guide

This clearPath guide is written for two audiences: general users — the people who run audits, read reports, and watch the dashboards — and network administrators responsible for deploying and maintaining the clearPath server. It covers deployment guidelines, the overall system architecture, and the web management interface. A glossary of terms is included in the Appendix.

The guide is organised by workflow rather than by technology, so you can jump straight to the task you are working on — starting a session, building a report, configuring a facility — without having to read the chapters in order.

2.1. Other Help Formats

If you would prefer a PDF version of this help, please contact support@clearpathhealthsolutions.com and we will send you the latest build.

2.2. Notation Conventions

clearPath pages follow a handful of simple conventions so that the same kind of information always looks the same, no matter which topic you are reading. Spending a minute with the legend below will make the rest of the guide quicker to skim.

2.2.1. Admonitions

Coloured callout boxes highlight short pieces of information that sit outside the main prose. clearPath uses six of them, each for a specific purpose:

Note

A note provides additional information that is not essential to understanding the topic but may be helpful for readers who want more detail.

Tip

A tip points out a faster, easier, or less obvious way of doing something you have just read about.

Hint

A hint offers a suggestion, a pointer to further reading, or a clue about why a detail matters.

Warning

A warning flags a limitation, caveat, or side effect to be aware of before you use a feature.

Error

An error describes an error message or error condition you might see in clearPath, and what it usually means.

Attention

An attention box draws the eye to a topic that is easy to overlook, or illustrates a point that deserves emphasis.

2.2.2. UI Conventions

When a topic refers to something on the screen, the typography tells you what kind of thing it is:

Double-backtick text is used for UI labels — button names, field names, menu items, column headings, and the exact text of options in a drop-down. The text inside the backticks matches the label on screen, capitalisation included.
Blue text is used for menu paths. A menu path is read left to right through the sidebar, for example “go to :blue:`Reports` | :blue:`Report Groups`”.
Bold text is used for short emphasis on a new term the first time it appears, or for a key word in a bulleted list.
Italic text marks a quoted message, an example phrase, or placeholder text you are expected to replace with your own value.

2.2.3. Typographic Conventions

The rest of the typographic rules used in the guide:

Substitutions — product, company, and contact details are injected from a shared variables file, so a brand change ripples through every page without a manual search. Throughout the guide, clearPath always means the main product, cp2go the auditing client that runs in the field, and support@clearpathhealthsolutions.com / sales@clearpathhealthsolutions.com our inboxes.
Code blocks — multi-line commands, JSON, SQL, or other verbatim content appears in a monospaced box with its own background colour, for example:
```
https://siteid.cphs.cloud/index?doc=...
```
Keyboard shortcuts — individual keys are shown in plain text (for example, press Enter), and chorded shortcuts join keys with a + (for example, Ctrl+S).
Screenshots — every UI topic has a screenshot above the prose that describes it, captured in light mode at the current clearPath version. If a screenshot drifts from what you see on your screen, the help has fallen behind the product — please let us know at support@clearpathhealthsolutions.com.

2.2.4. Cross-References

Cross-references are rendered as clickable links in blue. When you click a cross-reference, you jump to the page or section it names and your browser’s back button brings you back to where you were. The glossary in the Appendix is cross-referenced from every term that uses it, so you can always jump out to a definition and back without losing your place.