Advanced Report Design
Go beyond the basics with HTML templates, advanced findings configuration, and professional report styling in the WYSIWYG Report Designer.
Using HTML Templates in Reports
HTML templates are reusable content blocks that you can insert into your reports. They allow you to create custom-formatted sections that go beyond the standard text and heading elements.
How HTML Templates Work
- Create an HTML template with your custom content and formatting
- In the Report Designer, add an htmlTemplate element
- Select the HTML template you want to use
- The template renders inline within your report
HTML templates are part of the broader template system. You can create personal templates or, as a Key User or Admin, share them as company templates.
Tip
HTML templates are ideal for standardized sections like legal disclaimers, methodology descriptions, or company-specific formatting that you reuse across multiple reports.
Configuring the Findings Table
The findingsTable element displays your inspection findings in a structured table format within the report. It can be configured to show exactly the data you need.
Column Configuration
Select which finding fields to display as columns in the table. Available fields include:
- Description
- Status (Open, To be reviewed, Closed, Accepted as is, Cancelled, Shipyard confirmed rectification)
- Priority
- Due date
- Corrective measures
- Location
- System category
- Photos
- GPS coordinates
- Comments
Filtering Findings
Configure the findings table to show only a subset of findings based on criteria such as status or priority. This is useful when you want separate tables for open vs. closed findings, or when you need to highlight only critical items.
Note
The findingsTable element spans across multiple pages automatically when there are many findings. It is not rendered purely inline -- it uses a multi-page layout to accommodate large datasets.
Executive Summary Customization
The executiveSummary element provides a high-level overview section in your report. Configure it to summarize key findings, overall assessment, and recommendations.
Place the executive summary near the beginning of your report (after the cover page and table of contents) to give readers a quick overview before they dive into the details.
Report Styling
Company Branding
Company accounts can configure branding that applies to all reports:
- Company logo -- displayed in report headers and cover pages
- Company colors -- used for accents, headings, and table styling
- Custom header/footer -- company name, contact information, and other details that appear on every page
Configure branding from the Profile tab under your company settings.
Fonts and Colors
The Report Designer allows you to customize:
- Font selection for text and heading elements
- Text colors and sizes
- Background colors for elements
- Table border and cell styling
Headers and Footers
Configure persistent headers and footers that appear on every page of your generated PDF. These typically include:
- Company logo and name
- Report title
- Page numbers
- Date information
Page Layout Options
Paper Size
The Report Designer supports the following paper sizes:
- A4 -- international standard (210 x 297 mm)
- Letter -- US standard (8.5 x 11 inches)
- A3 -- larger format (297 x 420 mm)
Margins
Configure page margins to control the spacing between your content and the edge of the page. Adjust margins in the report or template settings.
The 13 Report Element Types
For reference, the Report Designer supports these element types:
| Element | Purpose |
|---|---|
| text | Body text content |
| heading | Section headings |
| image | Single image |
| htmlTemplate | Reusable HTML content block |
| divider | Horizontal line separator |
| table | Data table |
| tableOfContents | Auto-generated ToC from headings |
| coverPage | Professional cover page |
| findingsTable | Structured findings data |
| executiveSummary | High-level summary section |
| signatureBlock | Signature capture area |
| imageTable | Grid of images with captions |
| productInfoTable | Product/asset information |
Tip
Use the undo/redo feature in the Report Designer to experiment with different layouts. You can always revert changes if the result does not look right.
Template System
Report Templates
Report templates define the full structure of a report. There are two types:
- System templates -- provided by the app, available to all users
- Company templates -- created by Key Users or Admins, shared with the team
HTML Templates
HTML templates are reusable content blocks (as described above) that can be inserted into any report via the htmlTemplate element.
Template Picker
When creating a new report, the Template Picker lets you browse and select from available templates. Use the report type filter to narrow down the list to templates relevant to your inspection type.
Warning
Changes to a company template do not retroactively update reports that were already created from that template. Only new reports will use the updated template.
Need more help? See Common Issues or contact support at support@quickinspect.me.