| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
On this page
|
Overview
...
The Excel macro displays one or more Excel worksheets on a Confluence page. The following features are included:
...
Supports many Excel formats:
xls format from Excel 95, 97, 2000, XP, and 2003 workbooks
xlsx format from Excel 2007 and later (available starting with Release 5.0)
...
Flexible location of the Excel file
- Attachment
- URL
- File system of Confluence server
...
Features
- Convert your Excel spreadsheets into tables
- Access data from Excel files from attachments on any Confluence page, URLs or pre-configured profiles
- Download Excel table data as a CSV file
- Display and format one or more worksheets in your Excel files
- Format any of the columns, including the hidden ones, with your own styles
- Work with common table capabilities including sorting, column totals, and row numbering
Displays results of most Excel formulas
Info If a cell value cannot be calculated due to an unknown formula, the cell displays #N/A in the resulting table. Only cell values with known calculation results are displayed in the table.
Basic
...
use
This macro can be deployed using one of the following methods:
| Selected from the Macro Browserbrowser | Excel |
|---|---|
| Markup Shortcut | {excel} |
Screenshot
...
Parameters
| Table plusnote | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Parameter | Default | Macro Browser Label | Description | |||||||
| output | html | Output format | Determines how the output is formatted. Use wiki to have the data in the table rendered by the wiki renderer. | |||||||
| page | Current page | Page for attachment | Specifies the page for attachment from the same space or different space. Since 6.6.0. | |||||||
| name | Latest Excel file in the Current page | Name of attachment | Allows you to select the name of the attachment from the available list. Since 6.6.0. | filename | Name of attachment in the path | Specify the name of the attachment in confluence home/script directory. Since 6.6.0. | url | URL to Excel file | Specifies the URL of an Excel file. Use of this parameter may be restricted for security reasons. See your administrator for details. | user | URL user | Username for URL access via basic authentication. | password | URL user password | User password for URL access via basic authentication. | timeout | URL connection timeout | Allows setting the wait time for URL access for slower connections. Time in milliseconds. | encoding | File encoding | File encoding for an external file if different from the system default handling. Since 4.1.0. Example: UTF-8. More ... | language | Language for number and date formats | If provided, the language and country specification will be used to provide number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes. | country | Country | Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes. | sheets | Sheets to import |
|
|
Macro specific parameters
| Macro Editor Label | Default | Description | Macro Parameter | ||
|---|---|---|---|---|---|
| Output format | html | Specify how the output is displayed. The options are as follows:
| output | ||
| Page for attachment | Current page | Enter the location where the Excel files are available. The following locations are supported:
| page | ||
| Name of attachment | Most recent Excel file uploaded to the current page | Enter the name of the attachment.
| name | ||
| Profile | Enter a profile name. Contact your administrator to know which profiles are available for use in your instance. 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.
| 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 |
| Columns to show |
...
Enter a comma separated list of column numbers |
...
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 before the table. | showSheetName | |
| Use cell properties for formatting |
...
| false | Enable this option to process each cell for special properties. Currently, supported properties are:
|
...
|
...
Show non-formatted version of the generated wiki
...
| formatCell | |
| 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 by cut and paste. |
...
| 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 |
| Note |
|---|
When you provide all the parameters listed in the editor window for the Excel file, the input provided using URL to Excel file takes precedence. |
Common Anchor XLCLD_commontableparameters XLCLD_commontableparameters
...
table parameters
| Include Page | ||||
|---|---|---|---|---|
|
Compatibility With Other Macros
...
|
Screenshot
Helpful resources
- Tutorials for examples on app usage