You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »


Introduction

Export As CSV/Excel plugin lets user export any of their data lists into CSV/Excel. Plugin configurations allows changing delimiters (for csv), adding headers and footers, data selection, and renaming file. To start using the plugin, from the List Builder, from the 'Actions' section, drag and drop the 'Download CSV/Excel' column into the workspace.

This plugin source code is available in JogetOSS repository at https://github.com/jogetoss/export-csv-or-excel.

You may download it from https://github.com/jogetoss/export-csv-or-excel/releases/.


Plugin Information

Plugins Available in the Bundle:

  1. Download CSV or Excel

This plugin bundle is compatible with Joget DX 8.


Expected Outcome

Export As CSV/Excel plugin lets user export any of their data lists into CSV/Excel.

Figure 1: Download CSV or Excel button to download file


Get Started

Steps

1. You can obtain the jar file by the latest release at https://github.com/jogetoss/export-csv-or-excel/releases/.

2. Upload the plugin jar file in Joget by going to Settings → Manage Plugins.

3. Go to List Builder you would like to add the plugin to.

Figure 2: List Builder 


4. Drag the Download CSV or Excel element from the Actions section.

Figure 3: Drag the Download CSV or Excel Action


5. Configure the plugin by referring to Download CSV or Excel Action Properties.

Figure 4: Fill in the plugin configurations


6. Save and preview the list.

Figure 5: Save the datalist



Download CSV or Excel Action Properties

Configure Download CSV or Excel Action

FieldDescription
LabelField to be displayed on the button
Download As *The type of file that will be downloaded. Being either CSV or Excel
Delimiter (CSV only)

Symbol to be used as delimiter for CSV files (if left blank, will default to a (,) comma)

Include Footer (Column) *Inclusion of the footer column in the file
Confirmation MessageDefault joget plugin configuration. Is not used in this plugin.


FieldDescription
Custom Header *Allows the changing of header row names
Custom Footer *Allows the addition of footer row
Export All Records When None SelectedDownload all records when user does not select any record


FieldDescription
Rename FileRenames the generated file name, Defaults into "report.extension"
Download In Background (Excel only)

Allows the generation and downloading of excel files to run in the background.

This config is useful for when users would like to download large data lists as it will maintain a connection to the server while generating large files.

If this config is not turned on when generating/downloading large excel files. There might be a risk of server timing out.



  • No labels