Export Lists Module

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

Export Lists is a complementary module for Dolibarr ERP/CRM that allows users to export the rows and columns currently visible in Dolibarr lists to CSV and XLSX formats.

The module takes into account the filters applied by the user as well as the displayed pagination. It therefore makes it possible to quickly export the currently visible data without having to create a dedicated export.

Information

Name Export Lists
Publisher DoliHub - ergoCogn sàrl
Version 1.0.1
License GNU General Public License v3.0 (GPL-3.0)
Dolibarr Version 21 or higher
PHP PHP 7.4 or higher
Languages English, French
Price Free
DoliStore https://www.dolistore.com/product.php?id=3389&title=export-listes&l=en
Source code https://github.com/ergocogn/dolibarr-exportlistes

Features

Export Lists adds an export action directly to Dolibarr list pages.

The module provides the following features:

  • export of visible rows to CSV;
  • export to XLSX when PhpSpreadsheet is available in Dolibarr;
  • automatic fallback to CSV when XLSX export is not available;
  • support for filters applied to the list;
  • export of currently visible columns only;
  • support for the pagination selected by the user;
  • configuration of the maximum number of exported rows;
  • configuration of the maximum export data size;
  • configuration of the CSV separator;
  • optional UTF-8 BOM for CSV files;
  • a dedicated permission to control access to the export feature.

The module does not replay the SQL queries used by Dolibarr lists. It uses the data currently displayed in the browser.

It does not create database tables, does not store exported files on the server and does not send data to any external service.

Installation

The module can be downloaded from DoliStore:

https://www.dolistore.com/product.php?id=3389&title=export-listes&l=en

It can also be downloaded from the GitHub releases page:

https://github.com/ergocogn/dolibarr-exportlistes/releases/latest

Install the module in the Dolibarr external modules directory, for example:

htdocs/custom/exportlistes

Then enable the module from:

Home → Setup → Modules/Applications

Search for Export Lists, enable the module and open its configuration page if necessary.

Usage

  1. Open a list page in Dolibarr.
  2. Apply the desired filters.
  3. Select the number of rows to display using Dolibarr pagination.
  4. Click the export button added to the list controls.
  5. Select CSV or XLSX depending on the formats enabled in the module configuration.

Only the rows and columns currently visible in the browser are exported.

Rows located on other pagination pages are not included in the export. To export more rows, first increase the number of rows displayed in the list.

Configuration

The configuration page allows an administrator to define:

  • the available formats: CSV, XLSX or both;
  • the maximum number of rows that can be exported;
  • the maximum size of export data;
  • the separator used for CSV files;
  • whether a UTF-8 BOM is added to CSV files.

Non-administrator users must have the module export permission.

Security and data

Export Lists runs locally within Dolibarr and does not send data to any external service.

The module uses:

  • Dolibarr authentication;
  • module permissions;
  • a POST request to trigger the export;
  • CSRF validation;
  • data size limits;
  • JSON data validation;
  • exported cell normalization;
  • protection against formula interpretation in CSV and XLSX files.

Development and source code

The project is developed publicly on GitHub:

https://github.com/ergocogn/dolibarr-exportlistes

The source code is distributed under the GPL-3.0 license.

Bug reports and feature requests can be submitted at:

https://github.com/ergocogn/dolibarr-exportlistes/issues

Publisher

DoliHub - ergoCogn sàrl

Dolibarr services:

https://www.dolihub.ch/

Company website:

https://www.ergocogn.ch/

External links