Use Excel report templates

Analytics supports the use of Excel templates for data extraction. Usage involves both creating templates based on report configurations and exporting data to Excel documents. This is relevant for ongoing data extraction that must be presented in a specific format. Templates typically match one specific configuration, as column names in the spreadsheet must match the columns selected in the report configuration.

Report templates are set up the same way as other document templates in F2 and are saved as part of report configurations from the "F2 Analytics" window. Therefore, the process described here requires two privileges: "Template administrator" and "F2 Analytics administrator". The sections below describe the setup process. The use of templates as part of report configurations is described in Configuration management.

Create template based on report

It is beneficial to create an Excel template based on the report configuration it is intended for. This ensures that the correct columns appear in the right order. Additionally it lets you set up relevant formulas, graphs, or pivoting based on relevant sample data. Download the file while working on the configuration or by selecting an existing configuration in the window’s overview.

Set up the template layout

Excel templates for Analytics must contain a tab entitled "xData". Reports downloaded from the "F2 Analytics" window are created with this tab, and here all the data is found. When drawing reports based on a template, data is written to this tab, which means that data uploaded with the template may be overwritten. If you create a template manually, it is necessary to create the "xData" tab. Here you must also enter the column names in the first row in the same order as they appear in the report configuration in F2.

After the column names are entered, you can adjust the Excel file to your desired layout. This may include setting up pivot tables open external.

Import the template to F2

Go to F2’s main window, select the "Settings" tab, and click on Document templates. Choose the "Report templates" folder and create a new template from the ribbon (1) or the context menu (2).

image
Figure 1. Create new template for Analytics

Click on Browse and select an Excel file on your computer to serve as the template. Give it a meaningful name. All Excel templates are visible when you are working with any report configuration, so it may be advantageous to include the original configuration’s name in the template’s name. Then click OK to add the template to F2.