Skip to content

Last updated:

Getting Started

Logging in

Open the Admin Panel address in your browser. The login screen appears with the heading Log in to your account and a short description, "Enter your username and password below to log in."

  1. Type your Username in the first field.
  2. Type your Password. Click the eye icon at the right end of the field to show or hide what you typed.
  3. Optionally tick Remember me to stay logged in on this device between sessions.
  4. Click Log in.

If your credentials are wrong, an error message appears next to the relevant field. Check what you typed and try again.

After a successful login you land on the Dashboard.

Forgot your password?

If you can't remember your password, click Forgot password? on the login screen. You'll reach the Forgot password screen.

  1. Enter your Email address and click Email password reset link. The system sends a reset link to that address.
  2. Open the link in the email. You'll arrive at the Reset password screen, which shows your email address (read-only) and asks for a Password and a Confirm password.
  3. Enter and confirm your new password, then click Reset password. You're returned to the login screen.

A green status message appears at the top of the Forgot password screen once the link has been sent.

Email verification

If your account requires email verification and your address is not yet verified, you'll see the Verify email screen after login. Click Resend verification email to send another link, or click Log out to sign out and return to the login screen.

Confirm password

Some sensitive actions (such as enabling two-factor authentication) ask you to re-enter your password in a Confirm password prompt before proceeding, even if you're already logged in. Enter your current password and continue.

Two-factor authentication challenge

If two-factor authentication (2FA) is enabled on your account, a second screen appears after your username and password are accepted. By default it shows the heading Authentication Code and asks for the 6-digit code from your authenticator app, displayed as six individual input slots.

  • Enter the six digits — the form submits automatically.
  • If you don't have access to your authenticator app, click login using a recovery code at the bottom of the screen. The heading changes to Recovery Code and a single text field appears. Enter one of your saved recovery codes and click Continue.
  • You can switch back to the code entry mode by clicking login using an authentication code.

The screen layout

Once you're in, every page shares the same frame.

The sidebar runs down the left side of the screen. It can be collapsed to icon-only view to give the main content more room — click the toggle at the top of the sidebar or use the keyboard shortcut if your browser supports it.

At the top of the sidebar is the application logo, which is also a link back to the Dashboard.

Below the logo are four navigation groups:

  • Dashboard — a single link to the Dashboard (requires dashboard.access).
  • Management — links to reference-data screens: Services, Branches, Bill Items, Suppliers, Payment Methods, Bill Item Categories, and Print Templates. The entire group requires admin.access; individual items additionally require their own permissions.
  • Administration — links to user-management and operational tools: Users, Roles, Audit Logs, Trashed Records, and Database Backups. The group also requires admin.access.
  • Data Migration — links to historical-data tools: Legacy Import, Patient Duplicates, Import History, and Data Mappings. Unlike Management and Administration, this group has no group-level permission; each item is gated by its own permission and the group is visible to anyone holding at least one of them.

All three groups — Management, Administration, and Data Migration — are collapsible. Click the group label to expand or collapse the list. They default to expanded.

You only see the items your permissions allow. If a section doesn't appear in your sidebar, your account doesn't have access to it. Contact a super-administrator or refer to Roles & Permissions.

At the bottom of the sidebar (the footer area) you'll find:

  • Dev Docs — a link to the developer documentation site (opens externally).
  • API Docs — a link to the interactive API reference.
  • Your user menu — shows your name and avatar; click it to open a small dropdown (see below).

Header and breadcrumbs

Across the top of the content area is a header bar. It contains breadcrumbs that show where you are in the application hierarchy — for example, "Admin > Branches" on the branch list page. Breadcrumb items are links; click any segment to navigate back to that level.

Main content area

The rest of the screen is the main content area. Each admin page loads its content here. Most pages have a heading at the top, followed by filters or search controls, and then a table or form.


Your account menu

Click your name or avatar in the bottom-left corner of the sidebar to open the user dropdown. It shows your name and email address at the top, then two options:

  • Settings — goes to Your Account where you can update your profile, change your password, switch theme, or manage two-factor authentication.
  • Log out — ends your session and returns you to the login screen.

Common patterns across admin screens

Most admin list screens share the same set of interface conventions. Once you know them, you can use any screen in the panel without re-learning the layout.

Search and filters

Near the top of every list page is a search box. Typing in it filters the table in real time (with a short debounce to avoid unnecessary requests). Some screens also offer a status filter — a button or dropdown that lets you show only Active records, only Inactive records, or all records.

Sortable column headers

Table column headers that are underlined or show a sort icon are clickable. Clicking a column header sorts the table by that column ascending; clicking it again sorts descending; a third click returns to the default order. An arrow icon indicates the current sort direction.

Status badges

Every record has a Status column. Active records show a solid badge labelled Active; inactive records show a muted badge labelled Inactive. On most screens you can click the badge directly to toggle the record's status — a confirmation dialog appears before the change is saved.

Row action menu

Each row has an Actions column on the right with a button showing a horizontal three-dots icon (⋯). Clicking it opens a small dropdown with options such as:

  • View Details — opens the record's detail page.
  • Edit — opens an edit dialog for that record.
  • Delete — opens a delete confirmation dialog.

The options available depend on the screen and your permissions.

Confirmation dialogs

Any destructive or significant action — deleting a record, toggling a status — requires confirmation in a dialog before it takes effect. The dialog describes what will happen and offers a Cancel button and a Confirm (or Delete) button. You must click Confirm for the action to proceed.

Flash messages

After a successful action (creating, updating, or deleting a record), a brief message appears at the top of the page. Success messages appear in green; error messages appear in red. These messages disappear on their own after a few seconds.

CPR - Clinical Patient Records