Customizing Reports

⭐ This is a premium feature. Please click here for more information.

Custom reports can be created and uploaded to LabHQ to suit the content and layout you require.

You can customize all aspects of a report based on your use case and needs.

The standard report templates are a .docx file that are editable in most modern word processing programs.

Contents

Downloading Standard Templates

Editing Templates

Uploading Templates

Validating Custom Templates

Previewing Custom Templates

Deleting Custom Templates

Downloading Standard Templates

1. Select Administration > Report Settings   to open the Report Settings page.
2. Select the tab for the type of standard report you wish to download.
3. Click the [ Download Standard Template ] button to download the default LabHQ template.

Editing Templates

A report can be fully customized, including templating, formatting and styling.

📒 The default LabHQ logo is included in the standard template by default. This can be replaced with your organization’s specific logo by changing the image in the document.

Data on the report can also be modified to include or exclude data, or insert additional data points. The reports use data tags that will be substituted with real values upon report generation.

To see a list of allowed data tags for each report, see here.

To familiarize yourself with the reporting syntax, see here.

ℹ️ It is advisable to download a provided LabHQ standard report template as a starting point to make your changes.

Uploading Templates

Once you have constructed your custom report, you can upload the template to LabHQ for use.

1. Select Administration > Report Settings    to open the Report Settings page.
2. Select the tab for the type of your custom report.
3. Click the [ Upload ] button and select your file.

4. Once uploaded, your custom template will be shown in the table below.

You can download your custom template if you wish to make further changes.

📒 Custom reports must be one of the following file formats: .docx, .odt.

The maximum file size for uploads is 50MB.

Product Default Templates

Uploaded sample certificate templates can be set as product default templates. Re-uploading a modified custom sample certificate template with the same name will keep it linked as a product's default template.

Validating Custom Templates

Upon uploading a custom template, LabHQ performs a validation check to ensure the file is free of template errors.

If any issues are detected, the file upload will be prevented and an error dialog will be displayed outlining details of the error(s).

You can make necessary corrections to your template based on the provided error messages and re-upload the file for another validation check. By doing this, you can ensure a successful print when printing the report for use.

Previewing Custom Templates

Users can preview custom report templates before they are used in the lifecycle. This makes it easy to check that your report layout, formatting and data tokens are working correctly using real system data, without having to complete an entire lifecycle first.

Previews are available for the following report types:

• Job Certificates
• Sample Certificates
• Workbooks

Opening a Report Preview

Go to Administration > Report Settings .

Uploaded templates are listed under their relevant report type tab.

Next to each template, you will see a Preview icon. Select the preview icon to open the preview window.

Previewing a Job Certificate

To preview a Job Certificate template:

1. Open the Job Certificate tab.
2. Select the Preview icon beside the template you want to check.
3. Select a Job ID from the list.
4. Select Generate Preview.

The preview is generated using real job data from the system, allowing you to confirm that report fields populate correctly, branding and layout appears correctly and the report is formatted as expected.

Users can also search the list to quickly find the job they wish to use.

Preview a Sample Certificate

To preview a Sample Certificate template:

1. Open the Sample Certificate tab.
2. Select the Preview icon beside the template you want to check.
3. Select a Sample ID from the list.
4. Select Generate Preview.

The report preview uses live sample data so you can validate the final appearance of the certificate before using it to release certificates to clients.

Previewing a Workbook

To preview a Workbook template:

1. Open the Workbook tab.
2. Select the Preview icon beside the template you want to check.
3. Select a workbook from the list.
4. Select Generate Preview.

Workbook previews use live workbook data so that users can confirm that workbook sections, formatting and tables display correctly.

Preview Watermark

All generated preview reports include a PREVIEW watermark so that they can be clearly identified as test documents and not final released reports.

If No Data Is Available

If there are no eligible jobs, samples or workbooks available to preview, the system will display a message to users that no data is currently available and recommend that users submit or progress data that can be used for report checking.

Deleting Custom Templates

1. Select Administration > Report Settings    to open the Report Settings page.
2. Select the tab for the report type you wish to delete.
3. In the custom templates table, select the three dots menu icon and select [ Delete ].
4. A confirmation box will appear to confirm your deletion.