A report allows you to generate a Microsoft Word file or a PDF file that is automatically populated with data from Relatics. A predefined report template is used in which the structure and corporate style of the generated report are defined.

Create a report template^*

A report template is a Microsoft Word document that contains one or more code blocks with syntax that refer to model objects in the workspace. When a user generates a report, the code blocks in the template are replaced by the corresponding data stored in the workspace.

1. In the type list, click on a type element to open the corresponding overview.
2. In the overview, select the My view, All elements, or a Use case tab.
3. In the selected view, use the model selector, filters, and sorting to obtain the desired data set.
4. On the selected tab, click on Open menu.
5. In the dropdown menu, click on Copy report script. As a result, the script is copied from the workspace.
6. Open a new Microsoft Word document.
7. In the Microsoft Word document, paste the script.
8. In the Microsoft Word document, apply report syntax to further improve the code blocks.
9. In the Microsoft Word document, update the structure and styling of the document as needed.
10. Save the Microsoft Word document as a .docx file.

Note:

• When pasted into Word, the table of the copied report script will show a maximum of 20 properties. If a report with more than 20 properties is generated, these will still be shown in the rest of the report.
• Use the Microsoft Word feature: “Embed fonts in the file” to minimize the risk of fonts changing when publishing the report to PDF.

Create a new report^*

1. In the workspace menu, click on Reports.
2. In the reports overview, click on New report. As a result, the dialog New report is opened.
3. In the dialog, for the field Name, enter a unique name that a user will recognize.
4. In the dialog, for the field Template (.docx), upload a report script.
5. In the dialog, for the field Output format, choose if the generated report should be a PDF file or a Word file. Please note that in both cases, the uploaded template must be a .docx file.
6. In the dialog, for the field Scope, choose any of the two following options:
   1. If the Scope is set to All, the generated report will address all the elements of a single type element.
   2. If the Scope is set to Specific, each generated report will address one specific element. Before generating the report, you can choose for which element(s) you want to generate a dedicated report.
7. In the dialog, for the field Subject, select the type element that the report primarily addresses.

Interpret error messages

Error messages may notify users of inconsistencies within the styling of the Word template or the Relatics syntax. If you are interested in reading about the specific errors you can see while creating a new report, please consider the following article about interpreting report errors.

* In the workspace, the user type of your user must be set to power user to enable this feature.