Skip to main content

Importer Configuration

This property can be used to configure the <NuvoImporter> so that the importer is tailor-made for your importing process. With this property, you can adjust the design, the display mode, enable or disable certain features and by using the columns property, you can define your preferred output schema. The <NuvoImporter> instance must have settings and licenseKey as properties to launch. A target data model (columns) and an identifier (identifier) must be defined within settings. Otherwise, the component cannot be launched.

identifier

Typestring
Required
DescriptionThe identifier helps to identify different imports. For example, you have defined one target data model for a customer import and one target data model for a product import. With the identifier option, you can distinguish between the "customer" and the "product" import.

columns

Typeobject
Required
DescriptionUse columns to define the target data model you want to use within your application. columns is an array of objects. Each object is a new column which contains at least the keys label and key. For more information, check out our columns documentation.

title

Typestring
Default"Upload"
DescriptionThis can be used to change the pre-set title currently seen as “Upload” inside the "Upload"-Step when the nuvo importer is started. For instance, the title could be set to “Upload your product data here”. In this case, you would see the following screen:
info

When embedUploadArea equals true, the title won't be displayed.

setting-banner


developerMode

Typeboolean
Defaultfalse
DescriptionThis value is supposed to be true when using the nuvo importer in development or staging environments. The nuvo importer will display a "developer mode"-Banner at the top, and these imports will be marked as test imports, which means that they will not count against your contingent.

Typeboolean
Defaulttrue
DescriptionThis option controls whether the nuvo importer is implemented as a button or as a full page view. Your users will be guided through the workflow within a modal by default. When set to false, the users will go through the process on the implemented page without any modal occurring.
info

Please note the minimum screen width for the nuvo Importer to work:

  • If modal is set to true, the minimum required screen width is 901px.
  • If modal is set to false, the minimum required screen width is 948px.

embedUploadArea

Typeboolean
Defaultfalse
DescriptionThis option enables you to implement the nuvo importer as an embedding area. The nuvo importer is shown as an embedding area when embedUploadArea equals true, and when it is set to false, the nuvo importer is displayed as a button.
info

When modal equals false, embedUploadArea has no effect.

embedUploadArea = falseembedUploadArea = true

automaticHeaderDetection

Typeboolean
Defaultfalse
DescriptionThis option enables you to let your users skip the header selection of the import process. When this option is set to true, your users are automatically forwarded to the matching step of the import process after selecting the correct spreadsheet(s).

maxEntries

Typeint
Defaultnull
DescriptionDefine the highest amount of entries that can be imported. Note that the header row will not be taken into account. When a user's upload exceeds the defined amount of maxEntries, an error message is displayed, and your user cannot continue further.

max-entries-modal


disableTemplates

Typeboolean
Defaultfalse
DescriptionThis option enables you to disable the "Download Template"-functionality for your users. When this option is set to true, the "Download Template"-Button/Tile won't be displayed inside your application, and your users, therefore, can't download the target data model template as CSV or as .XLSX.

disableSuccessModal

Typeboolean
Defaultfalse
DescriptionThis option defines whether the "Successful Upload"-Modal is shown at the end of the importing process or not. If it is set to true, no modal is displayed after the user clicks on the "Complete Import"-/"Submit"-Button within the "Review Entries"-Step.

allowManualInput

Typeboolean
Defaultfalse
DescriptionDefines if the upload page contains a "Manual Entry"-Button or not. If set to true and the user clicks on the button, the user is directly forwarded to the "Review Entries"-Step and can add its values manually. For customizing the button's styling, please check out the following part of our documentation ((link)).

manual-input-button


completeImportAction

Type"discard", "submit" or "block"
Default"discard"
DescriptionThis property lets you define how rows with errors are handled inside the “Review Entries”-Step. Apart from discarding ("discard") all rows with an error from the result array object or submitting every row ("submit"), you also have the option to block the “Complete Import”-Button if the data contains at least one error ("block").
info

The allowInvalidEntries property is deprecated since React version 1.14.3, Angular version 1.6.5, Vue.js version 1.0.2 and vanilla JavaScript version 0.3.3. Please use completeImportAction instead. If you have used allowInvalidEntries equals true, you need to set completeImportAction to "submit".

completeImportAction = "block"completeImportAction = "discard"completeImportAction = "submit"

allowInvalidEntries (deprecated)

Typeboolean
Defaultfalse
DescriptionThis option enables you to allow users to submit entries with at least one error. If set to true, the entries which include an error will also be submitted.
info

The allowInvalidEntries property is deprecated since React version 1.14.3, Angular version 1.6.5, Vue.js version 1.0.2 and vanilla JavaScript version 0.3.3. Please use completeImportAction instead. If you have used allowInvalidEntries equals true, you need to set completeImportAction to "submit".


enableMassiveErrorAlert

Typenumber
Defaultnull
DescriptionThis option enables you to display an error message to your users as a pop-up after there are more than x cells with an error. This error message tells the user that the user can either continue to correct its data within the application or that the user can download the matched data as .XLSX to continue the work within Excel.

massive-error-alert


onlyMappedColumns

Typeboolean
Defaultfalse
DescriptionThis option defines if the user sees all target data model columns within the "Review Entries" -Step or just the mapped ones. If this prop is set to true, only the mapped target data model columns are shown and imported.
info

Note that the result array object does not contain the keys of the unmapped columns.


enableExamples

Typeboolean
Defaultfalse
DescriptionThis option enables you to display examples for each column of the target data model within the last step of the import process. When it is set to true, you can define the example property for each object of the columns array. These values are displayed within the table of the last step of the import process.

enable-example-equals-true


i18nOverrides

Typeobject
Defaultnull
DescriptionThis option allows you to overwrite every UI text inside the nuvo importer with your text. With this setting, you can support multiple languages.
info

You can use the i18nOverrides property to translate and customize every UI text of the nuvo importer. Visit our multi-language support documentation for more details. If you require an i18n file for a specific language, we can provide you a template of your preferred language so that you do not need to invest time in translating it by yourself. Please contact us via [email protected].


style

Typeobject
Defaultnull
DescriptionThe style setting enables you to customize the style of the nuvo importer. You can adjust the theme for the importer to match your branding.
info

Please notice that using your own CSS to override ours can lead to bugs. To avoid that, please use our provided style option. Visit our style documentation for more details on our styling options.


multipleFileUpload BETA

Typeboolean
Defaultfalse
DescriptionThis option enables you to allow users to upload multiple files and to select multiple sheets. Enable this option to show the "Join Sheets"-Step to your users within the importing process where they can select the key columns for joining data from multiple sheets.
info

Currently, we support uploading a maximum of 5 files in one importing process. All files must have the same identifier/key column to join them together in one table.