Data Imports Screen

Overview

From this screen you can import data from a csv or columnar file into the system. Whatever you wish to bulk import can be done from here, rates, accounts, general ledger codes, countries, etc. Data is manipulated and mapped to the appropriate fields in the system based on data profiles. Data can be imported in a one-off fashion or the import configuration can be saved to be run again at a later date. This guide will walk you through setting up and running a data import.

Prerequisites

Data profiles need to be configured before data imports can be setup.

Data Imports Panel

The Data Imports panel towards the left of this screen allows you to select data import configurations that have been saved. When you select an existing data import on the left the import settings will be shown in the Edit Data Import panel to the right. Actions are also available in this panel which are shown as icons to the right of the Data Imports panel heading. The available actions are described below.

Actions

Icon	Description

Icon	Description
Open	Deletes the selected data import
Open	Adds a new data import

Edit Data Import Panel

The information in this panel reflects the currently selected data import. From here you can change import details (Fields will display a red left border if a value is required and purple text if the field is read-only and cannot be modified).

Actions are also available in this panel in the upper right, these are described below:

Actions

Data Import Fields and Options:

• Name: a descriptive name that details the data that is imported

• Data Profile: the data import configuration. Specifies the import target and destination fields in the system along with the import file type, amongst other settings. See the data profile help for more information

• File To Import: the file that will be imported. Added via the upload  file action button

• Envelopes Per Request: the number of json envelopes per request

• Patches Per Envelope: the number of patch requests to include in each envelope

• Stop On Error: if set the import process will be halted when an error occurs. If left unchecked the import will continue to execute despite import errors

Visual Map Tab

This tab will display the imported fields (on the left) and the system fields that the imported value will map to (on the right). If the data imported is being modified the action or 'transform' being performed will also be displayed here in between the source field from the import file and the target field in the system.

Transforms are used to modify or generate imported data and are configured on the data profile screen.

Input Sample Tab

This tab will only appear when the data import fields are populated along with supplying the import file. This tab shows the source file contents.

Target Sample Tab

This tab will only appear when the data import fields are populated along with supplying the import file. This tab shows the target data that will be imported once the import is executed.

Import Results Tab

This tab appears when an import is run. It will detail the progress of the import and list any import failures should they occur.

Guides

Adding/Running a Data Import

1. At the top of the Data Imports panel click the  action button

2. Populate the fields as desired

3. When you upload the import file using the  action button two new tabs will load:

   • Input Sample: displays the data and the fields from the import file

   • Target Sample: displays the data that will be imported (after any transforms) and the target fields that the data will be written to

4. To validate that there are no issues with the data being imported click the  action button

5. To run the import click the  action button

6. An Import Results tab will load after running the import. This will display a summary of the data import configuration as well as the import progress

7. If you wish to save the import configuration (to run it again later) click Save

Editing a Data Import

1. Select the import from the list in the Data Imports panel

2. In the Edit Data Import panel on the right modify the values as needed

3. If you wish to run the import at this time upload an import file and click the  action button

4. If you wish to save your changes to the import click Save

Deleting a Data Import

1. Select the import from the list in the Data Imports panel

2. Click the  action button

3. Click Yes on the confirmation pop-up that appears