Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Div
idProductTOC

On this page

Table of Contents
maxLevel1
excludeOn this page
typeflat
separatorpipe

Overview

Excerpt

The Excel macro displays 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
  • Compatible with the Chart macro to create charts
  • Sheet selection - one or more or all
  • Column selection - any of the columns including hidden columns
  • Supports Common Table CapabilitiesSupports Common table capabilities including sorting, auto numbering, auto total, and styling
  • Enables conversion of spreadsheets to native tables
  • Enabled for CMSP to allow control of url and profile parameters. See Macro Security Managed Macros.
  • Supports most Excel formulas - when 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 BrowserExcel
Markup Shortcut{excel}

Screenshot

Parameters

Table plus
highlightColor#ffffec
rowStylesbackground:#f0f0f0;color:#222;font-size:14px;border-bottom:black 2px solid;border-top:black 2px solid;,
multiplefalse
stylebackground-color:white;
autoNumbertrue


Parameter
Default
Macro Browser Label
Description
outputhtmlOutput format

Determines how the output is formatted. Use wiki to have the data in the table rendered by the wiki renderer.

pageCurrent pagePage for attachmentSpecifies the page for attachment from the same space or different space.  Since 6.6.0. 
nameLatest 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 pathSpecify the name of the attachment in confluence home/script directory. Since 6.6.0. 
url
URL to Excel fileSpecifies 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 timeoutAllows setting the wait time for URL access for slower connections. Time in milliseconds.
encoding
File encodingFile encoding for an external file if different from the system default handling. Since 4.1.0. Example: UTF-8More ...
language
Language for number and date formatsIf providedspecified, the language and country specification will be is used to provide number and date formats to be used for data conversion. This specification will be is used before the default languages automatically used. Valid values are 2 character character ISO 639-1 alpha-2 codes.
country
CountryUsed in combination with the language parameter. Valid values are 2 character ISO 3166 codes.
sheets
Sheets to importBy default, each sheet in the workbook will produce produces a table. Use the sheets parameter to control what sheets will are to be shown. The parameter value can be a comma-separated list of sheet names (case sensitive) or sheet numbers (1-based counting).
columns
Columns to showComma-separated list of column numbers. Defaults to all non-hidden columns in existing order. Columns are enumerated starting at 1. If columns are specified, even hidden columns will be are shown. Column ordering is not supported (XL-63).
showHiddenfalseShow hidden sheets, rows, columnsUse true Enable to show hidden elements.
showSheetNamefalseShow sheet name before the table
formatCellfalseUse cell properties for formattingUse true Enable 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, formatColumn can be used. Another alternative is to use columnAttributes from  from Common Table Capabilities.
formatColumntrueUse column information from excel Excel sheetDisable to not use the column formatting information from the Excel sheet. By default, the format for a column will be is used to apply formatting for all cells in the column. Use false to not use the column formatting information from the excel sheet. Note that this parameter is ignored if formatCell=true or columnAttributes are specified.
hyperLinkstrueInclude cell hyperlinks
ignoreTrailingBlankRowstrueIgnore trailing blank rowsDisable to show these blank rows. A row is considered blank if all the columns selected by the column parameter are blank. Use false to show these blank rowsfor all columns are blank.
ignoreTrailingBlankColumnstrueIgnore trailing blank columns
showWikifalse

Show non-formatted version of the generated wiki

Use true Enable 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 Confluence markup by cut and paste.
escapefalse

Escape special wiki characters

When wiki Enable to allow special characters to be escaped so that formatting is not affected. This is in case wiki output is requested (output=wiki) , and some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table. Use true to allow these special characters to be escaped so that it will not affect the formatting. The default is false so that data that has wiki markup will be is handled correctly.



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

...

table parameters

Include Page
info:_CommonTableCapabilitiesParameters
info:_CommonTableCapabilitiesParameters

Compatibility

...

with other macros

  • Chart - this macro can be used to supply data for a chart
  • GVIZ - this macro can be used to supply data for the Graph from table macro