Introduction
The Principal Toolbox offers Excel reporting on multiple levels throughout the application. These reports can be set up by using field references and listings. Apart from reporting these
Configure the view
The first step in setting up the report is to configure the view (listing) which will provide the basis for the report. For every item in the view the report will generate a separate tab in the Excel report.
Please note that it is required to at least add the following columns in the view:
- ID (folderID of the items in the view)
- Name (this can be any field and will used to distribute names to the Excel tabs)
Download the report template
Download the report template from the location where the report will be located.
Enable the Advanced options (Excel template)
Open the Excel report template, downloaded the previous step and accept the (optional) warning by pressing Enable Editing.
Next (before clicking the Enable Content warning) click on the Info tab in the Excel lint.
In the Info section, click on Properties and open the Advanced Properties section.
The Advanced Properties section will open in a pop up screen. Look for the AdvancedOptions in the properties listing and alter the value from false to true. Next click on Ok.
The last steps is Enabling the Macros for Excel, by clicking Enable Content in the warning bar.
In the PTB tab in the Excel lint two new button will appear, which are required in the next step(s).
Set up the Report template tab
After the enabling the advanced setting in the template the actual report can be set up. First start with creating a template sheet. This sheet will be used for creating the detail page for every item present in the main listing (which will be created at the next step).
First create a new worksheet in Excel and name the worksheet (in the example the name Template is used).
The next step is setting up the template sheet itself by pasting the desired keywords for fields and views.
Optional: Import Existing Report
Instead of creating the template sheet from scratch an existing report can also be imported. For example when there is a project highlight report that can be used a basis for the template sheet in the multi instance report, the report can be imported into the multi instance template report.
This can be done by clicking the button Import Existing Report. Select the source file with the report to be imported and click on OK.
The imported report will now be shown in a newly added worksheet.
Set up the listing
Open the template report file and insert the listing in the report.
After inserting the view, right-click on the field with the remark symbol (red corner) and select Show Remarks.
When the remark field is enlarged the following set of optional settings will be visible:
<optional hideTemplateRows='true|false' copyRowCount='nn' addRowOnChange='nn' processTemplate='true|false' templateSheet='sheet name' idColumn='header name' nameColumn='header name' hideTemplate='true|false (optional)' parseRTF='true|false'>In order to activate the multi instance functionality please add the highlighted options to the keyword name part of the remarks (see screen below)
The following table shows how to configure:
| Keyword option | Values to be used | Description |
| processTemplate= | ‘true’ | Setting the true value will enable the multi instance functionality |
| templateSheet= | ‘[Templatesheet name]’ | Determines which of the worksheets will be used to create the detail pages of the item in the main listing |
| idColumn= | ‘ID’ | The ID column required in the main listing should be |
| nameColumn= | ‘[Any Column in listing] ‘ | The setting determined the name given to the created detail pages. Normally it would be the advised to use the Name-field (if available) for this setting. |
Running the report
When the multi instance report template has been completed, the report can be added to de desired location.
Next click on the report link and run the report. The result should be a below, where for every item in the main listing a detail worksheet should be created.
On the worksheets which are created per listing item the report will show all detailed information as configured in step 4.
