Register Reports

How to register Office reports in Vertec

Product line

Standard

|

Expert

Operating mode

CLOUD ABO

|

ON-PREMISES

Modules

Services & CRM

Budget & Phases

Purchases

Resource Planning

Business Intelligence

Created: 23.04.2007
Machine translated
Updated: 31.07.2024 | Link fixed and screenshots renewed.

This article explains how to register Office Reports (Word, Excel, PDF).

To view a report in Vertec from the Print menu, it must be registered. To register a report, go to the Settings > Reports & Scripts > Report Templates folder and select Neu > Office-Bericht:

Name

Name under which the report appears in the Print menu.

Active

Only active reports appear in the menus, so if you don’t want to use a report, you can simply deactivate it here.

Grouping / single index

With many different reports, the Print menu for a particular entry can quickly become cluttered. To remedy this, reports can be grouped and sorted during registration. This way, several reports can be combined into a group, which can then be separated from the other reports by a separator.

Grouping is activated by entering a group number in the Grouping field on the report. All reports with the same group number are grouped in the menu. The different groups are displayed in the order of their group number.

By default, the reports within a group are sorted alphabetically. If you want a different sorting, you can do this by inserting numbers in the Single Index field.

Classes

Specify for which objects the report is registered in Vertec (e.g. projects or addresses). The report will then appear in the Print menu.

Condition

You can specify a display condition, when the report should be shown in the Print menu and when not.
This is done via OCL expression. Clicking on the button with the three dots opens the OCL expression editor.

The result of this expression must return a Yes/No (Boolean) value. If the condition is met, the report will be shown in the Print menu, otherwise it will not. For list reports, the report will only be shown if the condition is met for all items in the list.

Output format

The output format can be selected between Word, Excel and PDF.

  • Word and PDF always use the Word template
  • Excel always uses the Excel template

If the selected output format does not match the registered templates – e.g. if Excel is selected if only one Word template is stored – an error message will appear.

Single report / list report

Specifies whether the report can be run on a single object or on a list of objects of the specified data type (class).

Outlook App email template From Vertec 6.7. Specifies whether the report can be used as an Email template in outlook app .
Automatic saving
File name

Field in System Setting Document Storage = Internal (from version 6.7)

A file name must be entered in order to open, edit and save documents saved on an activity (see further down ).

Path

Field in System Setting Document Storage = file system or DMS (from version 6.7)

Path to save the report document. The value %dokpfad% uses the document path (value of the “dokpath” attribute) of the object on which the report is run.

In addition to fixed texts, OCL expressions (included with %) can be used to print the report. Within the placeholders, any OCL expression can be used based on the up-to-date object of the report, e.g. %dokpfad%\%nummer% on an invoice report.

If the Restrict Filesystem Access option is activated in the Restricted Filesystem Access configuration file (default for cloud subscription customers), the reports behave as follows:

  • The reports are stored on the client side
  • No saving of reports in the web app
  • Error message when running a report with a configured save path via web app. In this case, no document can be saved and no activity can be created.
Regarding

document subject. Here, too, OCL can be specified, with % framed.

The subject can still be adjusted on the Print Dialog if it is shown (see next point).

In the document, the subject is displayed as a Context Variable subject available.

The subject can also be used in the path (see above). The expression is %betreff%.

In addition, the subject is used as the title of the activity if one is created (see below).

Show dialog

If Ja, a print dialog is shown before running the report, in which the memory path, remarks, and other options can still be changed.

Create Activity

If Ja, running the report creates an activity where the document is saved. It opens in the appropriate editor and can be edited directly.

If the System Setting Internal setting is Internal, the created activity is automatically shown in a new tab. The opened document is shown in the corresponding editor, can be further edited directly, and the button below the document preview is called Bearbeiten beenden. For this, a File Name must be entered. All information about documents on activities can be found here . With Vertec 6.7.0.7 this behavior has been adapted for PDFs: They are only shown, but are not located in Bearbeitung.

Link to main object

The activity is linked to the object from which it is started.

Link to address

The activity is linked to the address to which the document is sent.

Type of activity

Here you can assign an Activity Types to the generated activity.

Document templates

Under Document Templates, the appropriate template document is selected. For Word reports, it is a Word document with the file extension .docx, for Excel reports, it is an Excel document with the file extension .xlsx.

Since the Excel and Word templates share the code base, both can be registered simultaneously in the same registration:

Download

To edit a template, you can download it via the Download button.

Uploading

With Upload, a customized template can be loaded into Vertec.

This process also copies the built-in report code from Vertec 6.6 onwards and copies it to the Customization tab if it is still empty (see Report Definition section below).

Reset/Delete

If the customer-specific template overwrites an existing Vertec resource (i.e. customizing a Vertec standard report), the button reads Reset. This allows the customer-specific template to be removed and the Vertec standard can be restored.

Resetting not only restores the template to the default, but also removes the associated report code from the Customization tab as of Vertec 6.6. So if you have customized the code and need it later, copy it out first before clicking Reset.

If a customer-specific template is registered from scratch, the button is Delete. This allows a customer-specific template to be removed again.

  • The font is black if it is a standard template supplied by Vertec.
  • The font is green if it is a custom template.
Activate translation in project language

When activated, this has the following effects:

  • Reports that are executed on individual objects that have a defined relationship to a project (e.g. invoices or project evaluations) are translated into this project language (or all labels provided with translation).
  • Reports that run on multiple objects (list reports) are translated up to date into the Vertec interface language.

The translations of the reports into the different languages are done by the Vertec translation mechanism.

Report Definition

Office reports consist of a combination of a Word or Excel template for the layout and a report definition in the form of Python code for the content. See the Articles about office reports (word, excel, pdf) .

The Report Definition page contains the Python Code for the specified template.

The internal name refers to the code supplied by Vertec, which is shown under the tab Eingebaut.

Under the tab Anpassung, the supplied code can be overwritten. As soon as the code is available under Customization, only this is valid. To change something, you have to copy the complete code from Built-in and then change it under Customization.

Office reports created by the customer or commissioned by the customer do not have a built-in code or internal name, but the code is inserted directly into the Anpassung field.

If extended user rights are needed in the Python code, e.g. for SQL access, the check mark Erweiterte Berechtigungen must be set below the report definition.