Create report templates in Word and generate reports from assessments
The 6clicks assessment report generator allows you to define a custom Word report, then upload it into 6clicks and download assessment reports into Word using the template style.
To create a report template, head to a requirements-based assessment.
Then navigate to the Reports tab.
To create a template you will need to copy assessment fields into a Word document that will be populated with data once the report is generated. There are two categories of assessment data:
- Overview Data, which includes general assessment information, such as name, version and date published of the assessment.
- Response Data, which includes response data such as requirements, responses and comments.
The first step is to create your assessment template in a Word document. The second step is to then upload this template into 6clicks, and then the third step is to generate the report using this template.
Creating a report template
To add overview data to your report template, select overview data in the Reports side panel menu.
You will be navigated to the Overview Data tab where you can select general assessment data to paste into your report template. To select a specific data element placeholder, use the dropdown.
The value (1) and the placeholder (2) of the selected data element will appear below the dropdown. Copy the placeholder by clicking on the copy icon (3)
Then copy the placeholder into your Word report template.
Paste any of the assessment overview data into your report.
When the report is generated, the placeholders will be populated. See below how to generate the report.
Response data is the actual requirement, responses, comments and other related data. When copying response data into your template, you have two options:
- Table - this option allows you to define a table with assessment requirement placeholders. Assessment response data for each requirement is added to a requirement table, so each requirement has its own table.
- Pixel Perfect - this option allows you to map specific requirements placeholders to your report, which will be populated when the report is generated.
To use the table format, select the Table option.
Next, select whether you would like to use our default table to start with, or build from scratch. Select the table type (1) and then copy the table into your report.
The copied default table is formatted with placeholders and ready to go. Note the table below has been formatted slightly to align with the template's styling!
When the report is generated the table will be populated as per below.
You can also remove and add assessment fields depending on the assessment data you want to display. You can add additional field placeholders by using the Select Fields section. Select the field (1) you wish to copy into the table and copy the placeholder (2) into your table.
The Default table provides you will a barebones table with which you can add field placeholders, which will then be populated when the report is generated.
Lastly, you can also copy the issues and risks tables below your requirement table. This will populate the respective tables with any issues or risks linked to the requirement. To do this, open the Issues & Risks Tables section, and copy the issues (1) and/or risks (2) table and paste it into your document.
The table should be copied under the requirement table.
The data will populate as per below.
To use Pixel Perfect format, select the Pixel Perfect option.
Next, select the requirement (1) and then select the requirement field (2) you want to copy into your report template. Copy the field (3)
Copy the placeholder into your Word report template. You will need to copy fields for every requirement respectively.
When generating the report, the placeholders will be replaced with assessment response data as per below.
Uploading your report template
To upload your report template, scroll down to the Upload section in the side panel menu.
Browse for and then upload your report template.
Your report template will be added to the Template table.
Generating and download your report
To generate your report, click the Generate Report button for the uploaded template.
Once the report has been generated, the Report(s) badge will appear. Click on the badge to view the generated report.
Lastly, download the report.
You can also create and upload report templates at the assessment template level. When an assessment is created from the assessment template, the report template is copied automatically as well.