Excel

{excel}

Output format

html

Specify how the output is displayed. The options are as follows:

• html - data is rendered as an HTML table

• wiki - data is rendered in a table with wiki markup

• unrenderedWiki - data is rendered as text with wiki markup

output

Page for attachment

Current page

Enter the location where the Excel files are available. Since 6.6.0. The following locations are supported:

• page - Data is read from an attachment to the page specified here; provided that page is in the same space as the page with the macro.

• space:page - Data is read from an attachment to the specified page that is in the specified space.

page

Name of attachment

Most recent Excel file uploaded to the current page

Enter the name of the attachment. Since 6.6.0. 

name

Name of attachment in the path

Specify the name of the attachment in the Confluence home/script directory. Since 6.6.0. 

filename

Profile

The Profile drop-down contains a list of all configured profiles for this instance. Available from version 7.2.

Choose a profile name from the Profile drop-down. Administrators set up profiles to connect to external sources to render Excel data across multiple pages so that sensitive information like passwords and access tokens can be secured and hidden from view. A profile usually contains the base URL and other credentials that are required to access a specific location.

Enter the relative path to the actual location of the Excel files in the field, URL to Excel file.

profile

URL to Excel file

Enter the URL of the Excel file(s) to be displayed. If you enter a valid path, the macro accesses the given location and renders the content from the specified Profile and URL.

• Use a Profile configured with an absolute URL and valid User and Password to access the Excel data from private sources. The macro reads the content from the specified URL in the profile. 

• Use a Profile configured with an absolute URL to access the Excel data from public sources, or provide the publicly hosted absolute URL in the URL to Excel file field. Authentication is not required to access the Excel data from public sources, and the macro reads the content from the specified URL. 

• Use a Profile configured with a base URL and valid User and Password. Enter the relative path to the actual location of the Excel file(s) in the field URL to Excel file field. The macro appends the URL given here with the URL specified in the profile configuration to access the location and render the required Excel data.

url

URL connection timeout

Enter time in milliseconds such that URL connections do not timeout before getting data. Use this to increase the access time needed for slow connections. Note that if a zero is given, the connection may wait infinitely.

timeout

Sheets to import

Enter a comma separated list of sheet names to be shown in the order specified here. By default, each sheet in the workbook produces a table. The parameter value can be a comma separated list of sheet names (case sensitive) or sheet numbers (1-based counting).

sheets

File encoding

Enter a file encoding for an external file if different from the default encoding. If left empty, default Confluence file encoding is used. Refer to this article for more information. Since 4.1.0.

Example: UTF-8.

encoding

Language for number and date formats

Enter a language specification to use the respective number and date formats for data conversion. This specification is used before the default languages are automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.

language

Country for number and date formats

Enter a country specification to use the respective number and date formats for data conversion. Used in combination with the Language for number and date formats parameter. Valid values are 2 character ISO 3166 codes.

country

Columns to show

Enter a comma separated list of column numbers to be displayed in the order specified here. By default, all non-hidden columns are displayed in its existing order. Columns are enumerated starting at 1. If columns are specified, even hidden columns are shown. 

columns

Show hidden sheets, rows, and columns

false

Enable this option to show hidden elements of the worksheet.

showHidden

Show sheet name before the table

false

Enable this option to display the worksheet name above the table.

showSheetName

Use cell properties for formatting

false

Enable this option to process each cell for special properties. Currently, supported properties are:

• html - Alignment, font, and background color.

• wiki - None at this time for individual cells. For columns, the Use column information from Excel sheet parameter can be used. Another alternative is to use Column attributes from common table parameters.

formatCell

Use column information from excel sheet

true

Disable this option to ignore the column formatting information specified in the Excel sheet. By default, the format for a column specified in the Excel sheet is used to apply formatting for all cells in the column.

formatColumn

Show non-formatted version of generated wiki

false

Enable this option to show a non-formatted version of the wiki table following the formatted table. This is used to help resolve formatting issues. It can also be used to convert Excel to Confluence markup with cut and paste method.

showWiki

Escape special wiki characters

false

Enable this option to allow these special characters (like '|', '[', ']', '{', '}') to be escaped so that the table format remains unaffected. This option works when a wiki output is requested (Output format is wiki) as some special characters in data can cause incorrect table formatting. The default is false so that the data that has wiki markup can be handled correctly.

escape

Include cell hyperlinks

true

Disable this option to display any hyperlinks in the data as normal text. By default, any hyperlinks in the data are retained as is.

hyperlinks

Ignore trailing blank rows

true

Disable this option to show blank rows; a row is considered blank if all the columns specified in Columns to show parameter are blank.

ignoreTrailingBlankRows

Ignore trailing blank columns

true

Disable this option to show blank columns.

ignoreTrailingBlankColumns