cogAdds CSV export functionality to Live Data.
TypeXAR
CategoryApplication
Developed by

Michael Hamann

Active Installs0
Rating
1 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

XWiki 14.4

Installable with the Extension Manager

Description

The Live Data exporter application allows exporting any Live Data to CSV.

Currently supported features:

  • Export of all Live Data instances to CSV.
  • Column ordering and visibility as configured in the displayed Live Data are respected.
  • Filters and sorting are respected.
  • Multiple exports can be created for a single Live Data, e.g., to export differently filtered data.
  • The selected properties, filters and sorting orders are displayed for each export.
  • The export is done as a background job which should allow for large exports without timeouts, the progress is displayed in the UI.
  • Exports are only accessible for the current user (even with a direct link).
  • Exports are stored as temporary files on the server that are deleted after 8 hours or on user request.

Limitations:

  • All columns are exported as-is in plain text, meaning that for example columns that contain HTML content are exported as HTML in the CSV.
  • Exports cannot be accessed after the page has been left or reloaded (or, in other words, you need to stay on the page until the export has been finished).
  • Progress display and error handling is basic and might need to be extended.
  • Only CSV format is currently supported but support for other formats can be implemented.

Usage

The export can be started by clicking on the "Export…" item in the menu at the top right of a Live Data instance ((1) in the screenshot below). This opens a new panel at the top of the Live Data instance ((2) in the screenshot below). In this panel, there is a "Start Export" button ((3) in the screenshot below). Clicking it starts an export with the current configuration as shown in the screenshot. A progress bar is displayed at the bottom of it. After the export has finished (progress bar reached the right end), the "Download" button ((4) in the screenshot below) is enabled and can be clicked to download the exported CSV file. A "Delete" button ((4) in the screenshot below) can be clicked to delete the export on the server (and in the list of exports). While the export is still running, the button is named "Cancel" and cancels the running export in addition to deleting it. In version 1.0, the button always had the "Delete" label but had the same behavior.

2022-06-01-LiveData-Exporter-with-boxes.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v1.1

v1.0

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-livedata-exporter-ui 1.1):

  • org.xwiki.contrib:application-livedata-exporter-api 1.1
Tags:
    

Get Connected