.. _auto_dataset_excel_downloader:

*DATASET EXCEL DOWNLOADER*
==========================

Converts one or more named datasets into a multi-sheet .xlsx file using PHPExcel and makes the file available for download. Use this worker whenever a workflow needs to export tabular data as a formatted Excel workbook.

When to use
-----------

Tagged: ``dataset``, ``download``, ``excel``, ``export``, ``multi-sheet``, ``phpexcel``, ``xlsx``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Sheets
     - sheets
     - dataset
     - —
     - ✓
     - Array of sheet descriptors, each containing a 'name' string and a 'data' array of row arrays; drives the number and content of worksheets in the output .xlsx file.
   * - Filename
     - filename
     - text
     - —
     - ✓
     - Base filename for the generated Excel file (e.g. 'results'); the worker appends '.xlsx' automatically if the extension is absent. Defaults to 'export.xlsx' when left blank.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Output File
     - output_file
     - file
     - Server-side path to the generated .xlsx workbook; the platform renders it as a direct download link via the file-explorer API.

Disciplines
-----------

- data.dataset.transform
- data.io.excel

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=dataset_excel_downloader <https://www.d3view.com/api/workflow/example?id=dataset_excel_downloader>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>dataset_excel_downloader</code>. Schema hash: <code>75fe95f1d0a0</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>