This topic describes the settings that apply to the entire workbook.
Figure 7: Workbook settings
Element |
Attribute |
Possible values |
|---|---|---|
<workbooks> |
|
|
<workbook> |
id |
|
<settings> 1) |
|
|
<reportsheet> 2) |
|
|
type |
file |
|
<drilldowndefinition> |
|
template ID |
type |
file |
|
<hide_zerorows> |
|
true, false (default) |
<refreshaftersave> |
|
true, false (default) |
<print> |
|
|
<destination> |
|
|
<path> |
|
|
<filename> |
|
|
<trdefcumulative> |
|
file name |
type |
file |
|
<trdefperiodical> |
|
file name |
type |
file |
1) This element must be used in drill-down and TR templates. In other types of templates the element must be used if the template is stored in the data directory.
2) Required if reporting columns, areas, or worksheets are included.
Elements, attributes, and possible values
Path: <workbook><settings> Contains settings that apply to all sheets of a workbook. |
Path: <workbook><settings><reportsheet> Defines the name of the Excel file (for example, report 12 periods-example.xlsx). Note! This element must be used in drill-down and TR templates. In other types of templates the element must be used if the template is stored in the data directory. The element is not necessary if the template is stored in the database. Attributes type: Defines the name of the Excel file (for example, report 12 periods-example.xlsx). Possible values: •file |
Path: <workbook><settings><drilldowndefinition> Defines the name of the drill-down definition file. In input template definitions the element is required only if reporting columns, areas, or worksheets are included. Possible values: •template ID Attributes type: Type of the drill-down definition. Possible values: •file |
Path: <workbook><settings><hide_zerorows> Defines whether the account rows that contain no data in any data column, or the value in the cell is 0, are hidden on the report or input template. Possible values: •true •false (default) Note! The XML definition file setting overrides the option selected by a user when opening the input or report template. The setting in the drill-down or TR drill-down sheet definition file is the strongest and overrides the report definition file setting. If no setting is defined for the TR drill-down sheet, the setting is inherited from the drill-down sheet. If no setting is defined for the TR drill-down or the drill-down sheet, the setting is inherited from the report to both. If no setting is defined for the TR drill-down sheet, drill-down sheet, or the report, the option selected by a user when opening the input or report template is applied to all. |
Path: <workbook><settings><refreshaftersave> Defines whether the workbook is refreshed after saving (except when closing a modified workbook). Possible values: •true •false (default) |
Path: <workbook><settings><print> Not in use. |
Path: <workbook><settings><print><destination> Not in use. |
Path: <workbook><settings><print><path> Not in use. |
Path: <workbook><settings><print><file> Not in use. |
Path: <workbook><settings><trdefcumulative> Defines the transparent reporting definition file that is used when the figure in the report is cumulative. Possible values: •file name, for example, tr-cumulative.xml Attributes type: Type of the transparent reporting sheet. Possible values: •file |
Path: <workbook><settings><trdefperiodical> Defines the transparent reporting definition file that is used when the figure in the report is periodical. Possible values: •file name, for example, tr-definition.xml Attributes type: Type of the transparent reporting sheet. Possible values: •file |