Branding Excel and CSV Templates

SuperWEB2 users can download data from Table View in a variety of formats:

The Download Table drop-down box displaying the formats in which data can be downloaded

The templates for Excel and CSV downloads are located in <tomcat_home>\webapps\webapi\WEB-INF\templates:

File	Used For
Template.csv	CSV downloads from Table View.
Template.csvString	CSV string value downloads from Table View.
XLS_Template.xls	Excel 2003 downloads from Table View.
XLSX_Template.xlsx	Excel 2007 downloads from Table View.

See Branding SDMX Downloads for information about changes you can make to the SDMX download formats.

To use your own branding for CSV and Excel downloads, simply replace the existing template file with your own version, as follows:

CSV Templates

The two CSV templates are plain text files. They can contain any content you want, but must include the string #TABLE# (this will be replaced with the table contents).

For example:

TEXT

Customised SuperWEB2(tm) CSV Download File Format

#TABLE#

(c) Copyright WingArc Australia 2018

Excel Templates

The easiest way to create your own Excel templates is to use the existing version as a basis and then customise that, rather than starting from scratch.

Your completed template file must contain the following three work sheets:

Work Sheet

Description

Example

format

The contents of this work sheet do not appear in the downloaded file. It is used to define the formatting for the downloaded table.

For example, you can change the font, font size, as well as the background colours and borders:

Cell	Defines
A1	Formatting for the table heading.
A2	Formatting for field names.
A3	Formatting for column field labels.
A4	Formatting for row field labels.
A5	Formatting for cell data. You can use this cell to set the number format for cells (for example to configure use of the thousands separator).
A6	Formatting for the table footnote. By default, SuperWEB2 will insert the table footnote in the first cell in the row below the table. If the footnote is too long to fit in the cell it will appear on a single row, overflowing the edge of that cell. If you have a very long table footnote, you can configure SuperWEB2 to wrap the footnote text: enable Excel's Wrap text setting on cell A6 (right-click the cell and select Format Cells > Alignment > Wrap text) and SuperWEB2 will merge the cell containing the footnote across the width of the table and wrap the text (to minimum of four cells and maximum of seven cells). This setting can be used in conjunction with the annotation formatting options (cell A9).
B7	The number of decimal places and the format of RSE data.
B8	The comment author for the generated table.
A9	Formatting for annotations. By default, SuperWEB2 will insert all the annotations below the table, with the annotation symbols in column A and the corresponding descriptions in column B. If the descriptions are longer than the width of column B then the text will appear on a single row, overflowing the edge of that cell. If you have very long annotations, you may wish to change the formatting of this cell to instruct SuperWEB2 to wrap the text of the annotation descriptions instead: If you enable Excel's Wrap text setting on cell A9 (right-click the cell and select Format Cells > Alignment > Wrap text) then SuperWEB2 will merge the cell containing the annotation descriptions across the width of the table above and wrap the annotation text within those merged cells. The annotations will be merged across a minimum of three cells (even if your table contains fewer than three columns) and maximum of six (even if your table contains more than 6 columns). You can also adjust the height of cell A9 and this will be applied to each row of annotations.

The contents of the format tab within the XLS_Template.xls file

template_data

This work sheet will be used as the template for a standard table download. It can contain any content you like, but must include the string #TABLE# somewhere on the worksheet.

SuperWEB2 will replace #TABLE# and up to five rows after that with the table data and associated messages such as the table title and any annotations. If you want to include any messaging at the bottom of your download (such as a copyright statement or attribution) then you should make sure it is far enough down your template file so that it does not get overwritten by the table data.

The contents of the template_data tab within the XLS_Template.xls file

template_rse

This is an alternative template that will be used for the download if the Relative Standard Error (RSE) feature is enabled. In this case the RSE data will be included in the download in a separate work sheet.

As with the standard template it must include the string #TABLE# somewhere on the sheet. SuperWEB2 will replace this and up to the following five rows with the table data and messages.

The contents of the template_rse tab within the XLS_Template.xls file

Make sure you save your Excel templates using the correct file format. Use the File > Save As option in Excel, and select either the 2003 or 2007 file format from the Save as type drop-down list.