Versions Compared

Old Version 4

changes.mady.by.user Smita Nair

Saved on

compared with

New Version Current

changes.mady.by.user Nisha Shantilal

Saved on

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

...

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 BrowserbrowserExcel
Markup Shortcut{excel}

...

Parameters

...

Note

Image Removed

Parameters

titleParameters removed

Macro specific parameters

Macro Editor LabelDefaultDescriptionMacro Parameter
Output formathtml

Specify how the output is

treated

displayed. The options are as follows:

  • html - data is
entered as standard HTML directly in the macro bodyxhtml
  • rendered as an HTML table
  • wiki - data is
treated as XHTML and rendered with the Confluence XHTML renderer prior to displaywiki - data is surrounded by a noformat macro. This is a very special case.
  • rendered in a table with wiki markup
  • unrenderedWiki - data is rendered as text with wiki markup
output
Page
of
for attachmentCurrent page

Enter the location

of data. If specified, the included data follows the body data (if any).^attachment

where the Excel files are available. The following locations are supported:

  • page - Data is read from an attachment to the
current page.page^attachment - Data is read from an attachment to the page name provided
  • page specified here; provided that page is in the same space as the page with the macro.
  • space:
page^attachment
  • page - Data is read from an attachment to the specified page
name provided
  •  that is in the specified space
indicated
  • .
page
Name of attachmentMost recent Excel file uploaded to the current page

Enter the name of the attachment.

By default, the attachment is presumed

Note
  • If the Page for attachment is empty, the attachment specified here is considered to be on the current page.
  • If this field is left empty and if Profile or URL to Excel file are not specified, the macro renders data from the most recent Excel file that was uploaded to the current page. 


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

other applications such as GitHub or GitLab. Contact your administrator to know more about the profiles used in your instance. 

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. 

Info

To know more about how profiles are configured, refer to this

link

page.


profile
URL to Excel file

Enter the

relative path to the Markdown

URL of the Excel file(s) to be displayed.

 If

 If you enter a valid path

is entered here

, the macro accesses the given location

and processes

and renders the content

accordingly

from the specified Profile and URL.

A profile comprises a base URL and other credentials that are required to access a specific application. These details point to the actual location where the required Markdown file(s) are available. The contents are then accessed and displayed through the macro.

NoteIf an absolute URL is entered here, the macro reads
  • 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.
If a profile is also specified, the macro ignores the given profile and processes content through the given URL.urlURL userEnter the user name for URL access that requires basic authentication.userURL user passwordEnter the user password for URL access that requires basic authentication.password
  •  
  • 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.
Note

It is recommended to use Profile and provide the relative path to the actual location of the Excel file(s) in the field, URL to Excel file.


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
. Use the sheets parameter to control what sheets are to be shown
. The parameter value can be a comma
-
separated list of sheet names (case sensitive) or sheet numbers (1-based counting).sheets
Columns to show
Comma-

Enter a comma separated list of column numbers

. Defaults to

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.

Column

Note

Rearrangement of columns, that is, column ordering is not supported. (XL-63)

.


columns
Show hidden sheets, rows, and columns
Enable
falseEnable this option to show hidden elements of the worksheet.showHidden
Show sheet name before the tablefalseEnable this option to display the worksheet name before the table.showSheetName
Use cell properties for formattingfalseEnable 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,
 formatColumn can
  •  the Use column information from Excel sheet parameter can be used. Another alternative is to use
columnAttributes Use column information from Excel sheetDisable to not use the column formatting information from the Excel sheet. By default, the format for a column is used to apply formatting for all cells in the column. Note that this parameter is ignored if formatCell=true or columnAttributes are specified.formatColumn
  • Column attributes from 
Common Table Capabilities.formatCell
formatCell
Show non-formatted version of generated wikifalseEnable 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 charactersfalseEnable 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 hyperlinkstrue

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.

Anchor
XLCLD_commontableparameters
XLCLD_commontableparameters
Common table parameters

Include Page
info:WIP:_CommonTableCapabilitiesParametersXLCldCopyCommonTableCapabilitiesParametersXLCld
info:WIP:_CommonTableCapabilitiesParametersXLCldCopyCommonTableCapabilitiesParametersXLCld

inclu

Screenshot

Image Removed

Compatibility with other macros

...

Image Added

Helpful resources