Skip to main content

Custom Reports

How to use Principle's Custom Reports feature

Jordan Stokes avatar
Written by Jordan Stokes
Updated this week

Principles Custom Reporting feature allows you draw from over 700 data points recorded throughout the software to create any reports you need for your practice.

Getting Started with Custom Reporting

Accessing Custom Reporting

Head to the Custom Reports page under the Reporting section of the main menu.

The Custom Reports page is separated into 3 sections:

  • Saved Custom Reports: Configured and Published reports. Once created, these can be run periodically for any time period needed
    ​

  • Draft Custom Reports: Reports under construction and not yet Published. Return to these to add extra filters or charts before publishing. Saved Custom reports can be returned to Draft at any time to change the applied filters or Charts.
    ​

  • Managed Reports: Preset Reports configured by Principle, designed to export directly to CSV spreadsheets. (Speak to our Support team for more information on available Managed Reports)

Click 'Create Custom Report' to begin.

Understanding 'Data Sources'

In order to build a custom report, we first need to choose a data source.

The data source you choose to build your report from will dictate the type of results the report returns. For example: if we choose Appointments as our data source and select a data range, then our results will be all the appointments from those dates. We will also be given all the Appointment Filters from which we can begin to refine the report.

If instead we selected Patients as our data source; then the report would return all Patients that fit our criteria, as well as any relevant Patient Filters.

Some data sources will include the filters from other sources. For Example: If Appointments is selected, both Patient and Appointment Filters will be available for selection, as every appointment necessarily has a patient associated with it. Whereas if Patients is selected as the data source, only the Patient Filters will be available as not every patient necessarily has an appointment.

Using Prebuilt Report Templates

After clicking 'Create Custom Report' you will be presented with a series of options to get started. Some of these are preconfigured templates with filters already set for some commonly used Data Sources such as:

  • Invoice Tax Report (Invoice Data Source)

  • New Patients Appointments (Appointments Data Source)

  • Rebooking Rates (Appointments Data Source)

The can be identified by the 'πŸ”–Template' tag and will periodically be added to by the Principle team.

These templates can be used as is, or as your starting point to then further edit and customise to your needs.

Alternatively, select from the list of Data Sources available to begin building your report from scratch, identified by the 'πŸ”– Basic' tag:

Building Custom Reports

After clicking 'Create Custom Report' and selecting either a Template or Data Source as your starting point, you will be taken to the report building page. For this example, we have selected 'Appointments' as our starting point:

  1. Select a date range to refine your results while configuring your report. Once saved, the report can be run for any time period.

  2. Current filters applied and options to add further filters.

  3. Current Charts included and options to add more.

  4. Results of your report will be displayed here once the report is run.

Using and Adding Filters to Custom Reports

Filters are used in reports to refine down the results to the information required.

Most reports will start with a filter of: 'Data is Between: Selected Date Range'

Which just means that the report will include any results that fall within the range selected when 'Run':

This can be changed from 'is Between' to various other comparisons such as; 'Is Before', 'Is after', etc. depending on the needs of the report:

Depending on the nature of the Data Point, various Filter Options will be available:

For names such as practitioners, tags, treatment categories, etc.:

  • Is

  • Is Not

For dates:

  • Is

  • Is Before

  • Is After

  • Is Between

  • Is At least (relative)

  • Is At most (relative)

For numbers:

  • Equal To

  • Greater Than

  • Greater Than or Equal To

  • Less Than

  • Less Than or Equal To

For general strings:

  • Is Equal To

  • Contains

  • Does Not Contain

  • Starts With

  • Ends With

  • Is Exactly

In the 'Filters' section click '+ Add Filter' to begin refining the results of your report. For example, we might want to refine our results to a particular Treatment or Treatment Category:

Add as many filters as needed, These will work in conjunction with each other to further refine the results of your report.

Adding Charts to Reports

Various charts can be added to Custom Reports to give a visual representation of the refined results. These charts can act as active filters that can be used to select between various data sets within the one report.

As an example lets add a Treatment Category chart to the Appointment report:

Click + Add Chart:

  1. Select the Data Point to chart.

    1. Optional: Depending on the type of data point selected, some will have options to select only a few of the results within to be charted.

  2. Choose how to Group the results of the chart. Often the same selection as the chart data point is used here but in some cases one data point can be grouped by another.

  3. Choose the Label and Chart Type.

The values within these charts can be selected to further refine the results of the report once complete.

Customising the Results Table

The columns of data in the Results Table can be customised to display the most relevant information connected to the results.

  1. Click Edit Columns.

  2. Add or remove any related information.

  3. Use the drag icon to re-order the columns as needed.

  4. Click Save.

Once happy with the configuration of the Report, Charts, and the Table of Results, the report can be saved by clicking Publish. This will move the report from Draft Custom Reports to Saved Custom Reports. Once saved, reports can be reverted to draft at any time to edit filters, charts and results table.

Please reach out to us via the Support icon or your Principle representative if you need any assistance building Custom Reports for your practice.


​
​

Did this answer your question?