Livetable Exporter Macro
Usage
Where "my-livetable" is your livetable's name.
Parameters
Name | Description | Mandatory | Default |
---|---|---|---|
livetable | The livetable where you want to add the file export. | Yes | |
withPageName | Set to "true" for adding a column containing the wiki page name. | No | true |
withPageURL | Set to "true" for adding a column containing the wiki page URL. | No | true |
withAllFields | Set to "true" for forcing the export of all the fields of the class of the livetable (if any class is selected), instead of just the ones displayed as columns in the displayed livetable. | No | false |
filename | The output filename (without extension), to which the results will be exported. | No | |
customResults | Name of a custom page generating the results, if different than the default. | No | Macros.LivetableExporterResults |
format | Export format to be used: "excel" (default), "csv" or "json". | No | excel |
label | Label of the export button. | No | |
limit | Sets a higer limit to the number of entries that can be exported. This parameter was introduced in particular for avoiding to load the server too much in case of very large exports, which require the macro script to load each page. Leave empty or to "0" for exporting all result entries. | No | 0 |
displayLimitMessage | Whether the message mentioning the export limit should be displayed or not. Defaults to "true" if a limit is set. | No | |
async | Run the export in async mode if "true" | No | false |
customDownload | No | Macros.LivetableExporterResultsAsyncDownload |
Credits
- For this macro, see the page on XWiki Extensions site.
- This macro is based on a patch by Ludovic Dubost.