Documentation
Installation
As any app for Confluence Cloud, you can install the app via the Confluence admin menu.
Log into your Confluence instance as an admin.
Click on “Apps > Manage apps” in the header menu.
Click on “Find new apps” on the right navigation.
Search for “Data Tables for Confluence” and select it.
Click on “Try it free” to install the app.
Usage
Data Tables for Confluence provides macros to create powerful tables.
Data Tables: This macro uses regular Confluence tables or the macro “Page Properties Report” as data source.
Data Tables CSV: This macro uses local CSV data (defined in the macro body) as data source.
Data Tables CSV (Attachment): This macro uses CSV data from a file attached to the same Confluence page as data source.
Data Tables CSV (Remote): This macro uses remote CSV data (defined via a remote URL) as data source.
Data Tables Attachments: This macro uses the attachments of a Confluence page as data source and renders a table with information such as the file name and file size.
To make use of one of the macros click the “Insert” / “+” Button in the edit mode, select one of the macros and follow the macro specific instructions below.
All macros support the table state saving and restoring feature which enabled by default (see macro option “Disable state saving“ below to disable this functionality). The table state information is stored for 7 days in the client’s browser and is used to restore the user specific table state after a page reload. Please note that for this functionality requires “third-party cookies” to be enabled in the client’s browser (see our FAQ page for more details).
Macro “Data Tables”
The “Data Tables” macro uses regular Confluence tables or the “Page Properties Report” as data source. After inserting the macro, add a regular Confluence table or a “Page Properties Report”” as macro body and change the macro settings appropriately.
The macro supports the following options:
Enable paging: Enable the paging functionality.
Page sizes: Comma separated page sizes (number or “all”) to override default sizes if paging is enabled where the first entry is used as default page size; “all,50,100” for example shows options “50 / 100 / all” and “all” is selected by default
Enable searching: Enable the (global) searching functionality.
Enable column filtering: Enable column filtering.
Exclude columns from search: Comma separated column to exclude from searching.
Enable column selector: Enable a button that allows to toggle visibility of individual columns.
Enable copy to clipboard: Enable a button that copies the table data to the clipboard.
Enable Excel export: Enable a button that exports the table data as .xlsx file.
Enable CSV export: Enable a button that exports the table data as .csv file.
Enable PDF export: Enable a button that exports the table data as .pdf file.
Enable printing: Enable a “print” button.
Order columns: Comma separated column numbers to order by initially (use “!” to order descending); “2!;1” for example uses column 2 (descending) as primary order column and column 1 (ascending) as second order column.
Fixed order columns: Number of columns defined in option “Order columns” for which the order is unchangeable.
Footer row: Comma separated functions (“min” / “minimum”, “max” / “maximum”, “avg” / “average”, “sum”, “count”, “md” / “median” or empty) to be used in the footer row.
Data locale: Defines the locale that should be used to parse numbers.
Grouping columns: Comma separated column numbers to group; “2;3” for example groups by column 2 and then by column 3.
Detail column: Number of the column that contains the information that will be rendered as expandable/collapsible detail row.
Detail column format: Defines if the detail column should be rendered as expandable detail row (default option “DetailRow“) or as overlay (option “Overlay”).
Show information: Show dataset information such as number of records.
Disable state saving: Disable automatic table state saving and restoring.
Macro “Data Tables CSV”
The “Data Tables CSV” macro uses (local) CSV data as data source. After inserting the macro, add the CSV data macro body and change the macro settings appropriately.
On pages using the “Legacy Editor” experience, the macro editor overlay shows a preview (if available) and you can enter the CSV data in the macro body after closing the editor by clicking “Insert” or “Save”.
The macro supports the following options:
CSV header row: Use the first row as column header.
CSV quote: Define the character that is used as CSV quote, leave empty if no quote us used.
CSV delimiter: Define the character that is used as CSV delimiter.
Column format: Comma separated format (empty, “html”, “link” or “date” in format YYYY-MM-DD) to be used for rendering the column, whereas “html” supports the tags <a>, <em> and <strong> and “link” renders the data as hyperlink.
Enable paging: Enable the paging functionality.
Page sizes: Comma separated page sizes (number or “all”) to override default sizes if paging is enabled where the first entry is used as default page size; “all,50,100” for example shows options “50 / 100 / all” and “all” is selected by default
Enable searching: Enable the (global) searching functionality.
Enable column filtering: Enable column filtering.
Exclude columns from search: Comma separated column to exclude from searching.
Enable column selector: Enable a button that allows to toggle visibility of individual columns.
Enable copy to clipboard: Enable a button that copies the table data to the clipboard.
Enable Excel export: Enable a button that exports the table data as .xlsx file.
Enable CSV export: Enable a button that exports the table data as .csv file.
Enable PDF export: Enable a button that exports the table data as .pdf file.
Enable printing: Enable a “print” button.
Order columns: Comma separated column numbers to order by initially (use “!” to order descending); “2!;1” for example uses column 2 (descending) as primary order column and column 1 (ascending) as second order column.
Fixed order columns: Number of columns defined in option “Order columns” for which the order is unchangeable.
Footer row: Comma separated functions (“min” / “minimum”, “max” / “maximum”, “avg” / “average”, “sum”, “count”, “md” / “median” or empty) to be used in the footer row.
Data locale: Define the locale that should be used to parse numbers.
Grouping columns: Comma separated column numbers to group; “2;3” for example groups by column 2 and then by column 3.
Show information: Show dataset information such as number of records.
Disable state saving: Disable automatic table state saving and restoring.
Macro “Data Tables CSV (Attachment)”
The “Data Tables CSV (Attachment)” macro uses a CSV file attached to the same Confluence page as data source. After inserting the macro, the attached file to load the CSV data from and all other CSV and table options can be defined in the macro settings. As the CSV data is loaded “on demand”, the table always reflects the data defined in the (attached) CSV file.
The macro supports the following options:
Attachment: Define the CSV file attached to the Confluence page to load the CSV data from.
CSV header row: Use the first row as column header.
CSV quote: Define the character that is used as CSV quote, leave empty if no quote us used.
CSV delimiter: Define the character that is used as CSV delimiter.
Column format: Comma separated format (empty, “html”, “link” or “date” in format YYYY-MM-DD) to be used for rendering the column, whereas “html” supports the tags <a>, <em> and <strong> and “link” renders the data as hyperlink.
Enable paging: Enable the paging functionality.
Page sizes: Comma separated page sizes (number or “all”) to override default sizes if paging is enabled where the first entry is used as default page size; “all,50,100” for example shows options “50 / 100 / all” and “all” is selected by default
Enable searching: Enable the (global) searching functionality.
Enable column filtering: Enable column filtering.
Exclude columns from search: Comma separated column to exclude from searching.
Enable column selector: Enable a button that allows to toggle visibility of individual columns.
Enable copy to clipboard: Enable a button that copies the table data to the clipboard.
Enable Excel export: Enable a button that exports the table data as .xlsx file.
Enable CSV export: Enable a button that exports the table data as .csv file.
Enable PDF export: Enable a button that exports the table data as .pdf file.
Enable printing: Enable a “print” button.
Order columns: Comma separated column numbers to order by initially (use “!” to order descending); “2!;1” for example uses column 2 (descending) as primary order column and column 1 (ascending) as second order column.
Fixed order columns: Number of columns defined in option “Order columns” for which the order is unchangeable.
Footer row: Comma separated functions (“min” / “minimum”, “max” / “maximum”, “avg” / “average”, “sum”, “count”, “md” / “median” or empty) to be used in the footer row.
Data locale: Define the locale that should be used to parse numbers.
Grouping columns: Comma separated column numbers to group; “2;3” for example groups by column 2 and then by column 3.
Show information: Show dataset information such as number of records.
Disable state saving: Disable automatic table state saving and restoring.
Macro “Data Tables CSV (Remote)”
The “Data Tables CSV (Remote)” macro uses CSV remote data as data source. After inserting the macro, the URL to load the CSV data and all other CSV and table options can be defined in the macro settings. As the CSV data is loaded “on demand”, the table always reflects the data defined under the remote URL.
The macro supports the following options:
URL: Define the URL to load the remote CSV data from.
CSV header row: Use the first row as column header.
CSV quote: Define the character that is used as CSV quote, leave empty if no quote us used.
CSV delimiter: Define the character that is used as CSV delimiter.
Column format: Comma separated format (empty, “html”, “link” or “date” in format YYYY-MM-DD) to be used for rendering the column, whereas “html” supports the tags <a>, <em> and <strong> and “link” renders the data as hyperlink.
Enable paging: Enable the paging functionality.
Page sizes: Comma separated page sizes (number or “all”) to override default sizes if paging is enabled where the first entry is used as default page size; “all,50,100” for example shows options “50 / 100 / all” and “all” is selected by default
Enable searching: Enable the (global) searching functionality.
Enable column filtering: Enable column filtering.
Exclude columns from search: Comma separated column to exclude from searching.
Enable column selector: Enable a button that allows to toggle visibility of individual columns.
Enable copy to clipboard: Enable a button that copies the table data to the clipboard.
Enable Excel export: Enable a button that exports the table data as .xlsx file.
Enable CSV export: Enable a button that exports the table data as .csv file.
Enable PDF export: Enable a button that exports the table data as .pdf file.
Enable printing: Enable a “print” button.
Order columns: Comma separated column numbers to order by initially (use “!” to order descending); “2!;1” for example uses column 2 (descending) as primary order column and column 1 (ascending) as second order column.
Fixed order columns: Number of columns defined in option “Order columns” for which the order is unchangeable.
Footer row: Comma separated functions (“min” / “minimum”, “max” / “maximum”, “avg” / “average”, “sum”, “count”, “md” / “median” or empty) to be used in the footer row.
Data locale: Define the locale that should be used to parse numbers.
Grouping columns: Comma separated column numbers to group; “2;3” for example groups by column 2 and then by column 3.
Show information: Show dataset information such as number of records.
Disable state saving: Disable automatic table state saving and restoring.
Macro “Data Tables Attachments”
The “Data Tables CSV Attachments” uses the list of attached files to that Confluence table as data source. After inserting the macro, the table options can be defined in the macro settings.
The macro supports the following options:
Enable paging: Enable the paging functionality.
Page sizes: Comma separated page sizes (number or “all”) to override default sizes if paging is enabled where the first entry is used as default page size; “all,50,100” for example shows options “50 / 100 / all” and “all” is selected by default
Enable searching: Enable the (global) searching functionality.
Enable column filtering: Enable column filtering.
Enable column selector: Enable the a button that allows to toggle visibility of individual columns.
Enable copy to clipboard: Enable a button that copies the table data to the clipboard.
Enable Excel export: Enable a button that exports the table data as .xlsx file.
Enable CSV export: Enable a button that exports the table data as .csv file.
Enable PDF export: Enable a button that exports the table data as .pdf file.
Enable printing: Enable a “print” button.
Show columns: Select the columns to be included in the table.
Group column: (Optional) column to group the data.
Order columns: Comma separated column numbers to order by initially (use “!” to order descending); “2!;1” for example uses column 2 (descending) as primary order column and column 1 (ascending) as second order column.
Fixed order columns: Number of columns defined in option “Order columns” for which the order is unchangeable.
Show information: Show dataset information such as number of records.
Disable state saving: Disable automatic table state saving and restoring.