Versions Compared

Key

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

...

Cloud specific parameters

Macro Editor LabelDefaultDescriptionMacro Parameter
Output formathtml

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

  • html - data is
entered directly in the macro body
  • rendered as an HTML table
  • wiki - data is
surrounded by a noformat macro. This is a very special case.unrenderedWiki
  • rendered in a table with wiki markup
  • unrenderedWiki - data is rendered as text with wiki markup
output
Page of attachmentCurrent page

Enter the location of data.

If specified, the included data follows the body data (if any).
  • ^attachment - Data is read from an attachment to the current page.
  • page^attachment

    The following locations are supported:

    • page - Data is read from an attachment to the page name provided in the same space as the attachment.
    • space:
    page^attachment
    • page - Data is read from an attachment to the page name provided in the space indicated.
    page
    Name of attachmentLatest Excel file on the current pageEnter the name of the attachment.
    By default, the attachment is presumed
    If the Page of attachment is empty, the attachment specified here is considered to be on the current page.name
    Profile

    Enter a profile name. Administrators set up profiles to connect to other remote locations.

    Contact your administrator to know more about the profiles used in your instance. To know more about how profiles are configured, refer to this link.

    profile
    URL to Excel file

    Enter the relative path to the Excel file(s) to be displayed. If a valid path is entered here, the macro accesses the given location and processes the content accordingly.

    A profile comprises a base URL and other credentials that are required to access a specific

    application

    location. These details point to the actual location where the required Excel file(s) are available. The contents are then accessed and displayed through the macro.

    Note

    If an absolute URL is entered here, the macro reads content from the specified URL. If a profile is also specified, the macro ignores the given profile and processes content through the given URL.


    url
    URL user
    Enter the user name for URL access
    that requires
    through basic authentication.user
    URL user password
    Enter the user password for URL access
    that requires
    through basic authentication.password
    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. 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.

    Defaults to

    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 columnsfalseEnable to show hidden elements of the worksheet.showHidden
    Show sheet name before the tablefalseEnable to display the worksheet name before the table.showSheetName
    Use cell properties for formattingfalseEnable 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 capabilities.
    formatCell
    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
    Show non-formatted version of generated wikifalseEnable 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 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 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 for the Excel file, the input provided using URL to Excel file takes precedence.

    ...

    Include Page
    info:WIP:_CommonTableCapabilitiesParametersXLCld
    info:WIP:_CommonTableCapabilitiesParametersXLCld

    Screenshot

    ...

    Image RemovedImage Added

    Compatibility with other macros

    ...