Configuring an Import

Configuring an import involves defining what needs to be imported, where it needs to go and how frequently it needs to occur. The following sections describe the process in detail.

Prerequisites

Prerequisites

You must have the Policy: Maintain Events/Imports/System Settings assigned to your Role to:

  • configure imports
  • manually initiate imports

To configure an Import

  1. From the menu, select Designer Menu path separator Imports Menu path separator Data Import.
  2. Click New. A new Import Configuration record opens.
  3. Complete the fields according to the descriptions below.

To configure a lookup import please see Import of Lookups.

import_config_details

Tab: Import Details

Field

Description

Notes

Import Name

The name given to the import by the Designer.

Should be unique. This is necessary if you wish to initiate an import manually.

Note: may not contain colons (:)

Import to run on completion

Any import selected here will be run directly after the current import has completed successfully.

Allows users to 'chain' two or more imports, which need to run in a particular sequence, for example 'Persons' and 'Users'.

Note 1: if one of the imports in a chain fails, any subsequent imports will not be run.

Note 2: 'chained' imports can only be run from the server, or via a schedule. They will not be invoked when an import is run locally (i.e. 'Select File Now').

Destination Component

The component into which the imported data will be stored.

Component name must include the string:

'obj.com.bmssolutions.COMPONENT.<component id>'

Certain system components may use a different naming convention, such as:

bms_users; obj.com.bmssolutions.security.bms_Users

For Users import, always use the latter naming convention.

Form PublishID

Identifier for the business process form related to the Destination Component.

This is used to display a URL link to the created record in the notification email and logs.

The Publish ID can be obtained from the Designer Panel.

Type of Import

Select the type of Import.

Select

Enable Analytics Rules for each Record?

When ticked the system will run Analytics rule(s) (for that component) after each row/record is imported

The analytics rule will run after each row is imported

Run AR on Completion

The selected Analytics Rule will run AFTER the last row/record has been imported.

Only "scheduled" rules can be selected.

Rollup Table(s)

Define at which point during an import of hierarchical data the rollup table(s) need to be rebuilt.

Do not rebuild: the rollup table will not be rebuilt after the import is finished.

You will need to perform a manual rebuild at some point, so that rollup filters continue to work.

Rebuild at the end of the import: this is the recommended setting.

Rebuild after each record: under certain conditions, this setting is necessary. But be aware that the import process may take significantly longer than with the previous option.

  1. When you have completed this section, click Save.
  2. Complete the relevant CSV.
  3. Complete the Mappings sections, as required.
  4. Finally, complete the Schedule settings.

In This Section

CSV File

Rest API

Email Responder

Import of Lookups

Mappings

See Also

Importing Data

Importing Data: Overview

Importing Users, Attachments and Lookups

Initiating an Import

Log Files

Example: Importing into the File Storage Component (Attachments)