Skip to main content

Set up report type

How to create report types, link them to document templates and manage context, inclusion/exclusion and failure criteria

Written by Teresa Bui

Setup

You will need the following permission in your security group: Can change site configuration settings.

Click here to learn about permissions and security groups.


When adding a default document template from the Uptick Library, the report type is created automatically which can be adjusted. For blank templates intended as reports, create a report type and link it to the template.

How to create or edit a report type

1. Navigate to Control Panel > Report types, then click +Create or Edit the existing type.

2. Provide Name, Short name and select Template.

3. Scroll down and click Save Report Type.

Available fields on a report type

Report details

  • Name: The name of the report type.

  • Short name: Used for backend summary displays.

  • Template: Required unless setting report type context to EXTERNAL.

  • Annual certification: Do reports of this type satisfy the Annual Certification requirement for the state or territory.

  • Active: Making the report type inactive will prevent users from creating new reports of this type.

Report Configuration

This section allows you to configure when this report should appear on tasks.

  • Context: Changes which assets get pulled into this report, either just the assets on the "task" or the entire "property". "External" reports let you upload, dispatch, and store reports outside of Uptick.

  • Expect report creation on tasks: Enable this to prompt staff to create this report for all tasks by default. To limit the tasks this applies to, set further conditions below.

    • Client: Select clients you wish to limit this report to.

    • Category: Select task categories you wish to limit this report to.

    • Routine: Select routine maintenance tasks you wish to limit this report to.

Applicable Routines

This section allows you to filter which routines should be included in the report.

  • Applicable Routine Services: If selected, report will only include assets which were serviced under this routine.

Applicable Assets

This section allows you to filter which assets should be included in the report. Select any asset types, asset type tags, asset tags that this report can be applied against, or make this report applicable to all assets.

  • All assets: Is this report applicable to all assets? (Select this if you plan on excluding assets.)

  • ESM items only: Restrict to ESM items.

  • Included Asset types: Report can specifically include these Asset Types.

  • Included Asset tags: Individual assets can be tagged and be included in this report.

  • Included Asset type tags: Asset types can be tagged to be included in this report.

Excluded Assets

Select any asset types, asset type tags, asset tags that this report should exclude from the report.

  • ESM items excluded: Exclude all ESM items.

  • Excluded Asset types: Specific Asset Types can be excluded from this report.

  • Excluded Asset tags: Individual assets can be tagged and be prevented from showing up in the report.

  • Excluded Asset type tags: Asset types can be tagged and be prevented from showing up in the report.

Applicable Contractors

This section allows you to filter assets by the contractor on that asset. Select any contractors that this report can be applied against, or make this report applicable to all contractors.

  • All Contractors: Should this report use all assets maintained by any contractor? (Select this if you plan on excluding contractors.)

  • Applicable Contractors: Only use assets which these Contractors are maintaining.

Excluded Contractors

Select any contractors that this report should exclude from the report.

  • Excluded Contractors: Don't report on assets which these Contractors are maintaining.

Report Failure Criteria

This section allows you to set under what conditions you want the report to fail.

  • Failure Criteria: Select the condition under which this report should be marked as failed (e.g. Any items are non-compliant).


Understanding Key Concepts

  • Compliance Status: Assets in Uptick display a compliance status—Compliant (green), Non-compliant (red), or Not Tested (grey)—based on their last service result. This status is visible on asset lists and floorplans, providing an at-a-glance view of a property's condition.

  • Report Failure Criteria: This setting on a report type determines what makes a report "fail," which in turn can mark an asset as non-compliant. You can set a report to fail if, for example, any items have a "critical remark".

  • Expected vs. Available Reports:

    • Expected Reports are automatically suggested for a task when the task's routines match the report type's configuration.

    • Available Reports are not automatically selected but can be manually added to a task.


How to set the naming pattern for reports

Navigate to Control Panel > Reports and update the Naming pattern for report PDFs field using tokens like {property_ref}, {task_ref}, {short_name}, {id}, and others. Then click Save.


Recommended steps

Did this answer your question?