Skip to content

Importing

All import pages have the same three options:

  1. File to import: Field where you attach the file you want to import
  2. Import file format: Drop down to select the format you are uploading
    • This field will auto select the format when you attach the file
  3. Preview unchanged rows: Option to show unchanged rows in the preview/confirm page

Permissions

Import actions required the same permissions which would be required to change items in the UI.

For example, when importing Locations:

  • Role::Locations::Create is required to import new Locations
  • Role::Locations::Update is required to change existing Locations
  • Role::Locations::Delete is required to delete existing Locations

Creating and Updating

ID Column/Field

When exporting a list of items, each item will include an ID column/field. This field identifies the individual item.

If a value is not provided for the ID column on an import, the system assumes you are wanting to create a new item. In order to update an existing item, you must include its ID number in the ID column.

In short:

  • Create New = Empty/No ID
  • Update Existing = Populated ID
ID Name
1234 Updated Item Name
New Item Name

Project Column/Field

The Project field is included in all exports as a convenience to the user. However, this field gets ignored on import. You can only import data for the project you are accessing with the import page.

Deleting

It is possible to delete items using an import.

To do this, add a "Delete" column/field to your data set and add any value to that column for rows you want to delete.

ID Name Delete
1234 Updated Item Name
New Item Name
5678 Deleted Item Name X

Preview Page

Once you've attached your file, click the Preview Import button to validate the changes in the file and see a preview page of what will be modified.

Data Errors

If there are any errors in your data, you will likely see a "Row Validation Errors" page. It will provide you with a validation error and details about the problem including which rows caused the problem.

Changes Preview

If there are no errors in the data, you will get a preview page. In this page you will see a summary at the top which lists the number of each type of change to be made (# of New Items, # of Updates, etc)

You will also see a detailed preview table which will look similar to the below. The preview table will highlight the changes for each row to indicate what is being changed.

Action ID Name
Update 1234 Old Item Name New Item Name
New A New item
Delete 5678 Deleted Item Name
Cascade Delete 4321 Item Type Details about the item

Acknowledge Deletions

If any deletions are being performed in this import you will get a notification banner with an acknowledgement checkbox. You must check that acknowledgement box before you can continue.

To complete the import and commit the changes, click on the Confirm Import button.

Events

Import activity will generate events in the event log which records changes to the project. A large number of import actions will add a large number of events to the event log.