Knowledge Base – 19. Report templates
In this article, you will learn about the following:
- Create or customise templates using the report template builder
- Configuration tabs
- Add, Delete and Edit tabs
- Limit access to projects
Report templates – How to use the report templates builder
The report template builder allows you to export project data to your exact requirements. Whether it be a site diary, a handover protocol, a fire safety report, a home inspection checklist or a handover checklist, you can flexibly report with ease.
To build a report template, you can start by selecting one of our pre-prepared templates and customise it to your needs. Otherwise, you can start a new template.
1. TEMPLATES OVERVIEW
The template builder is accessed in the Templates menu via the sidebar. Here is where you will see an overview of all existing templates.
You have the following quick edit options:
Copy a template
Delete a template
2. CREATE OR CUSTOMISE TEMPLATES USING THE REPORT TEMPLATE BUILDER
Click on the button “Create new report template” to start building or customising a report template. You can choose from our pre-built template (see Chapter 14 – Pre-built template in our Knowledge Base), or you can use our template builder. The template builder will give you the following options:
1. Choose one of our sample templates
2. Start new template
2.1. Sample templates
You’ll be able to choose one of our sample templates: site diary, fire safety report, safety audit report, home inspection checklist or handover checklist.
After choosing a template, to display your ticket data in the selected report, you will need to match the ticket fields you created with the corresponding report fields.
Click on “Show field mapping” to do this manually, or if you do not yet have a suitable ticket form, you can create the form and map the fields automatically by selecting “Create and map form”.
2.2. Start new template
Your second option will be “start new template”, which will let you build a new template with the help of our powerful toolbar.
The toolbar works in a similar way to Microsoft Word, to style your report inline with your company style.
3.1. Text style editor
For editing text:
- Bold text
- Font Family
- Font Size
- Text color
- Background color
- Inline class
- Inline style
- Clear formatting
3.2. Paragraph style editor
For editing paragraphs:
- Align Left
- Align Center
- Align Right
- Align Justify
- Ordered List
- Unordered List
- Paragraph Format
- Paragraph Style
- Line Height
- Decrease Indent
- Increase Indent
- Insert Horizontal Line
- Insert Image
- Insert Table
- Insert Link
- Page Break
3.3. Add attributes
- Add Ticket Attributes (only available within the tickets mask). Here you can choose from the ticket fields you have available in your forms.
- Add Project Attributes. Select the project level data you want to have displayed in your report export.
- Add Tickets Images. Include ticket photos in your export.
- Add Protocol. Adds ticket comments and journal history into your export.
- Add Plan View, to show the ticket position as an overview or a detailed view of each ticket.
- Add Documents, to include ticket documents.
- Add User Attributes into your report.
- Add Generic Attributes allow you to add the date and time that you export your data.
See here on how to ADD ATTRIBUTES
3.4. HTML-Code view
If you want to edit your template via html-code, you can do this as well over the “code view” button on the toolbar:
4. CONFIGURATION TABS
Upon opening a new report template, whether you chose to start with a sample template or create a new template, the first thing you’ll see will be the different configuration tabs, starting with the SETTINGS tab.
4.1. SETTINGS TAB
This is where you can set the style of your report and set the priority order of data that will be displayed. At the bottom of the page, you can create your own header and footer that can appear on every page of your report. This is where you can drag & drop your company logo into the template or add attributes such as project name and much more.
Note! The input field “Name” is mandatory
4.2. COVER / APPENDIX TAB
You can set the format for the start and end of your report via the cover and appendix page. On these pages you can add text, style paragraphs and add project data using the attribute icons.
You can also add the header and footer from the settings to each of those pages by checking the box.
4.3. TICKETS TAB
The core functionality of the report template lies within the Tickets page. This is where you can define the report data and the design.
All the project information you have gathered within PlanRadar is available for you to add as drag & drop attributes, which you can position anywhere on your report. This means that as you change and update project information within PlanRadar, it will automatically be updated within the contents of your report.
This lets you re-create standard regulatory forms such as site diaries, handover protocols or any other report according to your needs as well as automate them.
You can add contents to this page in two ways:
a) You can either copy & paste text or tables from sources, such as Excel spreadsheets or Word documents
b) create and edit the report template using the TOOLBAR
4.3.1. Copy & Paste from other sources
To add content to your template report, you can copy text or tables from word documents, excel sheets, PDFs, notes and paste it into the template builder.
When pasting copied content into the builder, PlanRadar will automatically recognise the source and ask you if you want to keep the source format or adapt it to the target format.
Once the content is pasted in, if you need to make any changes to the text, you can use the toolbar to help you adapt the text style and the paragraph style of the content.
4.3.2. Add attributes
To define where you want specific ticket content to appear in your report, click to expand the toolbar and select the attributes you need.
The attributes toolbar lets you add project- & ticket-attributes, such as notes, due dates, and other relevant project information, as well as images, plan sections and ticket journals that you have collected in PlanRadar. To add these attributes first, place your cursor to where you want the specific content to appear and select the attribute you need.
Note!Keep in mind that this layout will apply to each ticket you export!
Important! You can only add attributes from one form plus the static data fields. When you export the report, if you have added an attribue from a different form to the one you are exporting, the export will not contain the ticket field or the ticket data.
4.3.3. Expert mode
If your report needs to include ticket fields from two or more forms, you can use “expert mode”, which is located at the bottom of the tickets page.
Expert mode assigns different report layouts to different forms. When clicking on the button “enable expert mode”, the following options will appear:
a) Choose from your existing report layouts OR
b) choose “Add Report Layout” to create a new report layout
c) Select Form: Select a form to assign a new report layout for the form tickets. You will only be allowed to add the attributes from the form you choose here.
d) Report Layouts: Copy the content of the new report layout from an existing layout, so you do not need to build content from scratch.
As a result your report will include two different forms, with each having their own report layout.
Here is a practical example for further clarification:
Let’s say you have created tickets using the form that you named “Handover checklist”. With our template builder you can define in which style the information collected using this form, will be presented. In the following screenshot you will see the report layout for the form “Handover checklist”:
Note! Keep in mind, that the first ticket report layout will by default be called “Default”.
After having added an additional report layout for a different form, as mentioned in the steps above, you can now give it a different style (in this example we have added a report layout connected to a form named “PlanRadar(EN)”):
Now you have created a report layout connected to a different form. You can switch between them via the dropdown-menu.
4.3.4. Rich data attributes
You can add rich data to your report such as images or plan sections.
When you choose to add ticket images, you are adding a placeholder for the location that images will appear in your report. You can also define the percentage width size that images will be exported as in the final report.
When choosing to import the plan view, you can choose the detailed view to see the pin position or choose overview to show the area in which the pin is located.
4.3.5. User attributes
When adding user attributes, keep in mind that the export will only include the data of the user that you select in the export process. Keep in mind, that you can only select one user.
5. ADD, DELETE AND EDIT TABS/PAGES
Different reports require different structures. With PlanRadar’s report template builder you can add or delete pages and rearrange them however you need. From a standardised cover page, an additional signature page or any informational sheet, such as company guidelines.
5.1. Add pages
Choose if you want to add a blank page to edit or upload a pdf-file to include in your export.
5.2. Delete pages
5.3. Rearrange pages
Click on the “Rearrange pages” button
5.4. Rename pages
Double click on the tab name to rename your template page
6. LIMIT ACCESS TO PROJECTS
Generally, all report templates are available to all projects, but you can also choose to limit them to certain projects.
a) Just check the checkbox “Limit access to projects” and click on “Select projects”.
b) Select the project(s) you want the template(s) to be available for and click on save.
In the account-view, manuals and FAQs are available. If you have any further questions, suggestions for improvement or comments, please contact: [email protected]. Alternatively, click on “Support” in the web platform and send us your request.
Back to the Table of Contents.