Versions Compared

Key

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

Table of Contents

Video Demo

View file
nameDownload CSV or Excel Plugin.mp4
height250

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.

Source Code

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

Plugin Download

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


Setting up the plugin

  1. Go to List Builder you would like to add the plugin to
  2. Drag the Download CSV or Excel element from the Actions section
  3. Save and preview the list
  4. Configure the plugin


Plugin Configurations



FieldDescription
LabelField to be displayed on the button
Download AsThe 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 HeaderAllows the changing of header row names
Custom FooterAllows 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.

The server will lose connection after 30 seconds and will fail to generate the excel fileTarget (Excel only)Lets user choose where the generation and downloading process take place. It is recommended to set the target to a new window to see the progress

There might be a risk of server timing out.