@flatfile/plugin-export-workbook

The @flatfile/plugin-export-workbook plugin exports data in a Flatfile Workbook to a downloadable .xlsx file.

Event Type:
listener.on('job:ready')

Supported file types:
.xlsx

> When embedding Flatfile, this plugin should be deployed in a server-side listener. Learn more

Parameters

#### jobName - string - (optional)

The name of job that the plugin will fire on. If not provided, workbook:downloadWorkbook will be used.

#### excludedSheets - string[] - (optional)

An array of sheets to be excluded from the export

#### excludeFields - string[] - (optional)

An array of fields to be excluded from the export

#### excludeMessages - boolean - (optional)

If true, messages on records will be excluded from the exported data.

#### recordFilter - Flatfile.Filter - (optional)

Allows filtering exported records to valid or error. By default all records will be exported

#### includeRecordIds - boolean - (optional)

Includes the record's ID

#### autoDownload - boolean - (optional)

Automatically download the file after exporting

#### debug - boolean - (optional)

The debug parameter lets you toggle on/off helpful debugging messages for development purposes.

#### sheetOptions - Record - (optional)

A map of sheet slug to ExportSheetOptions instance providing sheet specific export options:

- skipColumnHeaders - boolean - (optional) - allows omitting column headers
- origin - number | SheetAddress - (optional) - allows offsetting the start of a sheet. The parameter is either a row number or an object with column and row.

Usage:

``typescript
listener.use(
exportWorkbookPlugin({
sheetOptions: {
SomeSheetSlug: {
// Start the sheet at 5
origin: 5,
// Omit column headers
skipColumnHeaders: true,
},
SomeOtherSheetSlug: {
// Start the sheet at row 10 column 2
origin: {row: 10, column: 2},
},
},
})
`

#### columnNameTransformer - ColumnNameTransformerCallback - (optional)

A callback function allowing changing how column names appear in the workbook. The function accepts two arguments: columnName and sheetSlug and returns a new column name.

Usage

An action with the operation name of "downloadWorkbook" must be configured on a Workbook (not a Sheet) in order for the plugin to be triggered.

#### workbook.config.json

`json workbook.config.json
// ... inside Workbook configuration
"actions": [
{
"operation": "downloadWorkbook",
"mode": "foreground",
"label": "Download Excel Workbook",
"description": "Downloads Excel Workbook of Data",
"primary": true
}
]
// ...
`

#### Install

`bash install
npm i @flatfile/plugin-export-workbook
`

#### listener.js

`ts listener.js
import type { FlatfileListener } from "@flatfile/listener";

import { exportWorkbookPlugin } from "@flatfile/plugin-export-workbook";

export default function (listener: FlatfileListener) {
listener.use(exportWorkbookPlugin());
}
``