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.
If you see this arrow, click to expand for more information!
If you see this arrow, click to expand for more information!
We will add additional information and images under these arrows.
How to create or edit a report type
1. Navigate to Control Panel > Report types, then click +Create or Edit the existing type.
1. Navigate to Control Panel > Report types, then click +Create or Edit the existing type.
2. Provide Name, Short name and select Template.
2. Provide Name, Short name and select Template.
3. Scroll down and click Save Report Type.
3. Scroll down and click Save Report Type.
Available fields on a report type
Require fields (Name, Short name, Weight, Context, Failure criteria)
Require fields (Name, Short name, Weight, Context, Failure criteria)
Name: The name of the report to appear in drop-down lists when selecting a report type to generate.
Short name: Used for backend summary displays.
Weight: The weight will determine the list order of the report in lists and combined PDFs.
Context: Determines where it will appear for selection: Task, Property, External (can be raised on tasks or properties for reports created outside of Uptick to be shared with clients).
Failure criteria: Select when a report should be marked as non-compliant:
Any items are non compliant - The report is compliant only if all assets are serviced and passed the inspection. No Test results are considered non-compliant.
Any items have a critical remark - The report is compliant only if no assets have a critical remark. It is not recommended, as it treats all remarks below critical (including non-critical defects) as compliant.
Not applicable (not recommended) - The report is always compliant.
Recommended fields (Template)
Recommended fields (Template)
Template: Select the document template to be used for this report type.
Optional fields (Annual certification, Active, Main service report, Suggest this report (and limit items) for these routines, Applicable Assets, Excluded Assets, Applicable Contractors, Excluded Contractors)
Optional fields (Annual certification, Active, Main service report, Suggest this report (and limit items) for these routines, Applicable Assets, Excluded Assets, Applicable Contractors, Excluded Contractors)
Annual certification: Tick this box if the report type complies with annual certification requirements.
Active: Toggles the report type active/inactive. Reports of this type cannot be generated if inactive.
Main service report: Ticking this box will make the report type the default service report that will be sent upon dispatch.
Suggest this report (and limit items) for these routines: Leave blank to apply the report to all routine service types, or select specific types to apply it to (multiple can be selected).
Applicable Assets
All assets: Tick this box to apply the report to all assets.
ESM items only: Ticking this box restricts the report to ESMs only.
Included Asset types: Leave blank to include all assets or select only some asset types.
Included Asset tags: Leave blank to include all assets or select only some asset tags.
Included Asset type tags: Leave blank to include all assets or select only some asset type tags.
Excluded Assets
ESM items excluded: Tick this box to exclude all ESM items from the report.
Excluded Asset types: Select asset types to exclude from the report.
Excluded Asset tags: Select asset tags to exclude from the report.
Excluded Asset type tags: Select asset type tags to exclude from the report.
Applicable Contractors
All contractors: Tick this box to apply the report to all assets maintained by any contractor.
Applicable Contractors: Leave blank to include all assets, or select contractors to include only assets maintained by them.
Excluded Contractors
Excluded Contractors: Leave blank to include all assets, or select contractors to exclude assets maintained by them.
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.
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
◀ Previous | Next ▶ |