Skip to content

Configuring the Data Report

Configuring the Data Report

For general information about the data report, see the corresponding section in the article about Generating Reports. A separate article is dealing with the Structure of the Data Report.

Before you  Generate a Data Report for the entire project or individual sections of a project, you can specify what information will be included in the data report.

As long as you do not make a selection, the preset configuration applies.

In order to make your own selection of which data are recorded in the data report, there are two possibilities: firstly, the Report configuration and secondly, the context menus of the parameters. Both setting options are shown in the following figure.

Switch on the configuration mode using the Report configuration button in the Forms group of the Home ribbon. When the Report configuration mode is enabled, the button is highlighted in gray, and checkboxes appear in the Project explorer in front of the project tree elements (including the components) and in the forms in front of the identifiers of the individual data.

Check marks are already set in the check boxes for the data to be exported by default. To change the setting, you can remove these check marks and put check marks in other places. Clicking on a check mark removes it. By clicking in an empty checkbox, you place a checkmark again and thus activate the output in the data report.

Selection in Project Explorer

In the Project explorer, individual components, the Schemes, the nodes of Simulation, Variant analysis, Variant comparison, and Parameter study can be selected for the data report by ticking the check boxes.

If you select an element in the project tree, e.g., a component, all elements above this element are automatically added to the data report.

If you select a parent element without already selecting subordinate elements, all subordinate elements are selected automatically. You can then remove individual components, the entire scheme with all components, or the Simulation node from the data report by unchecking them.

As long as a component is selected, the corresponding scheme is automatically selected for export.

Selection in the Forms

In the forms, if the Report configuration is enabled, you can assign each individual identifier (parameter) to the data report with a check mark in the check box.

Alternatively, as shown above, you can specify the output in the data report using the context menu of the identifier with the Add to report function (see the figure above). This option is available both with the Report configuration enabled and disabled.

Special Features of the Report Configuration

If no data are assigned to the data report in the form of a component, this component is not output in the data report even if it is selected in the Project explorer.

The identifiers selected in the forms only appear in the data report if the corresponding element in the Project explorer also has a check mark for the data report.

If you only change the selection in the Project explorer, the default export settings are applied for the identifiers of the selected elements as long as no own specification is made in the forms.

Some elements cannot be output in the data report. This includes the model description, the Simulation results and the diagrams. The linked article describes how you still export these data.

Closing the Report Configuration

When you have selected all desired elements for the data report, close the Report configuration view as you opened it: via the the Forms group in the Home ribbon with the Report configuration button. Then the checkboxes are hidden, the button is no longer highlighted in gray.

The selected configuration remains until the next change.

Setting: Automatic Assignment of New and Changed Values

In addition to the report configuration described in the previous section, there is the setting Output changed data values in the data report in the Advanced settings (see the following figure).

If this option is activated with a check mark, a value is automatically included in the data report whenever its input value has been changed or entered for the first time. After updating the form window (e.g., by changing the tab within the form or when leaving the component), a check mark appears automatically in front of the corresponding identifier.

Data Report Template

The template for the data report TOP-Energy-Report-Template-en.dotm is typically located in the user directory:

C:\program files\TOP-Energy$version$\program\modules\efdoc\ini.

On this basis, you can create your own template by adapting the logo and formatting. No changes may be made to the macro.

You can change and customize everything before the table of contents as well as the header and footer. You can also insert as many pages as you want before the table of contents.

Everything after the heading “Contents” you must not change, because macros access it.

Step by step guide

  • Save the original TOP-Energy-Report-Template-en.dotm template from the C:\program files\TOP-Energy$version$\program\modules\efdoc\ini folder to another location so that you can copy it back if you need to restore the original template.
  • Make another copy of this file in any other location.
  • Be sure to open the copied TOP-Energy-Report-Template-en.dotm file using the context menu displayed by right-clicking on the file name in Windows Explorer. Select Open in the context menu.
  • Make the desired changes in the TOP-Energy-Report-Template-en.dotm file opened in Microsoft Word: add text, change the logo, or edit the header and footer.
  • Save the modified file in Microsoft Word.
  • Copy or move the changed file to the TOP-Energy installation folder with the path C:\program files\TOP-Energy$version$\program\modules\efdoc\ini and overwrite the original file located there, which you have previously saved in another location.
  • Now all data reports will be created using the template of your design.
  • As an alternative to overwriting the standard template, specify in the settings that your own report template is to be used and enter the corresponding file path there (see following figure).
Back To Top