@flatfile/plugin-automap
When embedding Flatfile, this plugin should be deployed in a server-side listener. Learn more
Parameters
The accuracy parameter match columns either by ‘confident’ (> 90% match) or
‘exact’ (100% match).
The debug parameter lets you toggle on/off helpful debugging messages for
development purposes.
The defaultTargetSheet parameter takes the exact sheet name to import data
to.
The matchFilename parameter takes a regular expression to match specific
files to perform automapping on.
The onFailure parameter takes a callback function to be executed when plugin
bails.
The targetWorkbook parameter specifies destination Workbook id or name.
API Calls
api.files.getapi.files.updateapi.jobs.createapi.jobs.executeapi.jobs.getExecutionPlanapi.workbooks.listapi.workbooks.get
Imported NPM Packages
@flatfile/api@1.5.11+is the official Flatfile SDK for JavaScript.@flatfile/common-plugin-utils@1.0.1+is a utility library for Flatfile plugins.@flatfile/listener@0.3.15+is a library for listening to Flatfile events.@flatfile/utils-debugger@0.0.3+is a utility debugger designed to facilitate the tracking, logging and debugging of various events, issues and processes in your application.remedaoffers a set of utility functions for functional programming and data manipulation in JavaScript, providing a convenient way to work with arrays and objects.
Usage
For automation workflows, upload a file using the files endpoint. For testing, you import via the Files area in the UI and use the debug config property.
npm i @flatfile/plugin-automap
import { automap } from "@flatfile/plugin-automap";
listener.use(
automap({
accuracy: "confident",
defaultTargetSheet: "Contact",
matchFilename: /test.csv$/g,
onFailure: (event: FlatfileEvent) => {
// send an SMS, an email, post to an endpoint, etc.
console.error(
`Please visit https://spaces.flatfile.com/space/${event.context.spaceId}/files?mode=import to manually import file.`
);
},
})
);