...
See https://bmpi.atlassian.net/wiki/spaces/CRDOC/pages/3252125697/Working+with+Excel+Templates#Supported-Node-Types for the names to be assigned.
Style and Language Specific Cell Patterns
Whenever a pattern is searched for a node with a specific style, the following names are checked in order:
<style>.<pattern>.<reportLanguage>
<style>.<pattern>
<pattern>.<reportLanguage>
<pattern>
Example: the header
pattern when rendering a node with style MyStyle
in language de
will be the first existing one of MyStyle.header.de
, MyStyle.header
,header.de
, header
.
Stamping Cell Patterns
Cell patterns are stamped as follows:
The style of the pattern cells is copied to the stamped cells next rows (or columns for generic tables) in the Excel report. This includes format, font, row height and column width, alignment, wrapping, colors, conditional formatting, merging, etc.
Some patterns are optional. These are only rendered if defined in the template.
The content of the pattern cells is evaluated, then copied. All
${...}
expressions in the content will be treated as JavaScript expressions on report specificdata
. The expression can access the following identifiers:
Identifier | Description | Example |
---|---|---|
| The data to be rendered. This is e.g. a node, a row header, a table fact or a report specific data object. See https://bmpi.atlassian.net/wiki/spaces/CRDOC/pages/3252125697/Working+with+Excel+Templates#Supported-Node-Types for details. |
|
| Render inline language dependent content. Takes an |
|
| Formatter for dates and date periods, where the Excel formats cannot be used. |
|
Style and Language Specific Cell Patterns
Whenever a pattern is searched for a node with a specific style, the following names are checked in order:
<style>.<pattern>.<reportLanguage>
<style>.<pattern>
<pattern>.<reportLanguage>
<pattern>
...
Some patterns are optional. These are only rendered if defined in the template.
Templates
The template handling of the Excel channel is very similar to the Word Channel. Each Excel report needs at least a main template to render correctly:
...
For all supported nodes, the following cell patterns are may be rendered:
Pattern Name | Description | Optional | Content Example Data | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Rows at the top of a worksheet. Content data is taken from the node creating the new worksheet and the report.:
| ✔️ |
| ||||||||||
| Rows at the bottom of a worksheet. Content data is the same as for the | ✔️ | As for | ||||||||||
| Cell created when an issue is encountered (e.g. a missing mandatory pattern). Content data is the issue.:
| ❌ |
|
...
For all supported nodes, the following parameters are considered:
Parameter | Description | Content Example | |||||
---|---|---|---|---|---|---|---|
| The style to apply. Used as name prefix when looking for cell patterns, see https://bmpi.atlassian.net/wiki/spaces/CRDOC/pages/3252125697/Working+with+Excel+Templates#Style-and-Language-Specific-Cell-Patterns. |
| |||||
| Whether this node should be rendered at the top of a new worksheet. |
| |||||
| The Excel Channel rendering options. The supported options are: worksheetName : Name name of the worksheet if this node creates a new worksheet, i.e. it is the first node or has Note that Excel limits the length of worksheet names to 31 characters .repeatHeaders : Mark tableHeader and columnHeaders to be repeated on each page (VerticalTableNode only). If there are multiple VerticalTableNode s rendered into a single worksheet, only the headers of the last one with this option will be repeated.
|
|
Tables: VerticalTableNode
Not surprisingly, a VerticalTableNode
is rendered as rows and columns in Excel. There are two ways of rendering an table in Excel: styled templated and generic.
...
Templated Table Rendering
By specifying a style on the VerticalTableNode
If there is a columnHeaders pattern (maybe with matching style prefix and language suffix), the table will be rendered row by row. Each row, including the header row, corresponds to a cell pattern. Styled Templated rendering therefore allows full control over the layout in Excel and as well as subselection and reordering of columns.
Pattern Name | Description | Optional | Content Example | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Row(s) to be stamped for the column headers of the table, repeated if
| ❌ |
| ||||||||||
| Row(s) to be stamped for each data row in the table. A different cell pattern must be specified for each row importance ( Content data are the table facts by column id:
| ❌ |
| ||||||||||
| Row(s) to be stamped for each row group carrying a name. Content is the group name:
| ❌ |
| ||||||||||
| Rows to be stamped before the column headers, repeated if | ✔️ | See | ||||||||||
| Row to be stamped after the last table row. Content data is the same as for | ✔️ | See |
Generic Table Rendering
VerticalTableNode
s without a style
are If there is no columnHeaders
pattern, a VerticalTableNode
is rendered in a generic way. This mode of rendering is similar to the Word Channel: each column is rendered individually, depending on its value type. Typical value types are text
, amount
, count
, date
. The basic idea is that the style of a column (particularly format and alignment) depends on its value type.
Column related pattern names therefore contain the value type:
Pattern Name | Description | Optional | Content Example | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Row(s) and column(s) to be stamped for the column headers. A different cell pattern must be specified for each value type. Repeated if Content data is the header text:
| ❌ |
| ||||||||||
| Row(s) and column(s) to be to be stamped for each fact in the table. A different cell pattern should be specified for each value type ( Content data is the fact value:
| ❌ |
| ||||||||||
| Row(s) and column(s) to be stamped for the row name, if set. Content data is the row name:
| ❌ |
| ||||||||||
| Same as [] | ❌ | See above. | ||||||||||
| ✔️ | See | |||||||||||
| ✔️ | See |
Note |
---|
Generic tables can only be rendered if there is no |
VerticalTableNode
Parameters
Parameter | Description | Example | |||||
---|---|---|---|---|---|---|---|
| Mark If there are multiple |
| |||||
| The total width (in Excel units, see e.g. https://learn.microsoft.com/en-us/office/troubleshoot/excel/determine-column-widths) of all columns of the generic table. This width will be distributed among the columns according to their For templated tables, this parameter is ignored. |
|
Worksheets: SectionNode
A SectionNode
renders its titles, and may start a new worksheet.
...