How to Create an Import Plan
This lesson explains how to select a pre-existing import plan and set up a new import plan. The import plan is associated with a data view and file type and contains the mapping from the source data (the file/database connection) to the table in the local database.
Choosing an Import Plan
Existing import plans are listed in the Import Plan dropdown menu. If no import plans have been created yet, then this drop down menu will be empty.
- Once an import plan is selected the import mapping that is associated with that plan will automatically show next to the Import Mapping label.
- After selecting an import plan with an associated mapping is the user may change the plan values for ‘Import from row’ and ‘Ignore last rows’ in order to alter the range of data imported if they choose ‘Import Now’.
Import Settings
- Once the user selects a Source File and Import Plan they can click Import Now to import the source data into the local database immediately.
1. Creating an Import Plan
The user can create a new Import Plan by selecting the New Import Plan button. This will bring up the Import Wizard that will guide the user through the steps of creating an import plan and mapping.
The first step is Define Import Plan where the user defines the source of information that will be imported as well as the name of the import plan:
- Import Data View: The data view that the user is importing into will be displayed here.
- Import Data Format: The format of the source files is chosen here. The lesson for importing from a database connection is here.
- Import Plan Name: The user will enter the unique name of the plan in this textbox.
- Click Next.
2. Source Data Processing
The next step is Source Data Processing:
- Delimiter: This is the character that separates the values in the source file. For example, .csv files are comma delimited.
- Text Identifier: This is the character used to enclose text values.
- Header Row: The number of rows that count as the header and will not be imported.
- Import From Row: The number of the first row that will be imported.
- Ignore Last Row: The number of rows from the end of the file that will
- Data Preview: The data preview will show the data as formatted with the settings mentioned above.
- Click Next to continue, or click Reset to clear out the Source Data Processing form.
3. Creating a Map
Note: This step will go over the basic parts of the mapping stage. For a more detailed review on how to make a mapping, go to this lesson.
After confirming that the data is displayed correctly, the user can move onto the next step which is Create Map. This is where the user can create a mapping between the information in the source file (Source Data) and the fields in the database table (table column tree and Target Attributes).
The Target Attributes and their descriptions are listed in the table below:
- Table Label (Name): Label and Name of the metadata table currently selected in the tree.
- Part of Main (Table Label) Lookup: This checkbox indicates whether the column or related table has been selected as a lookup key used in determining a unique record in the main or parent table for data import.
- Lookup Record Not Found: Option to choose whether to add new records or skip importing the row for when no records matching specified lookup keys are found in the database. This selection must be made for every table that has a mapping.
- Unique Index: This Checkbox indicates whether the column is part of a unique index. Table columns with a unique index are preselected as keys and cannot be unselected.
- Column Label (Name): Column label and name of selected tree item.
- Part of Table Lookup: This checkbox indicates whether the column has been selected as a lookup key for its table.
- Data Type: Data type of the table tree item selected.
- Required: This checkbox indicates whether the tree field is a required database attribute.
- Click Next to continue, or Reset to clear out the Create Map form.
Once the user creates the mapping they can continue to the next tab in the wizard labeled Verification which allows them to verify that the information that they have entered is in the correct format and matches up with the correct columns.
Potential Warning Message
This warning message can appear if the user maps fields from a related table without also mapping the required fields for that related table. The user is able to proceed to the next step, however duplicate records might be made on the related tables.
4. Verification
This section allows you to verify that the intended mappings match up with the expected columns and data types. If something does not look correct at this stage, click the Back button to go back and make changes. Click Next to continue.
5. Review and Save
After doing this, the user can continue to the last section of the wizard labeled Review and Save which allows them to review their settings once more and then save the import plan and mapping that they have created. The user has two options:
- Save and Run: This will save the import plan and use it to import the file that was used during the creation of the import plan. This is the same file that the user had to enter on step 1. Creating and Import Plan
- Save and Finish: This will save the import plan and NOT import the file that was used during the creation of the import plan.
Finished Importing
Once the Import is finished and ran, the import results will be displayed to the user.
- The results display the new records created in the tables, the records that were updated based on the matching keys in both the source file and the Asset Vision table, and the skipped records. Records can be skipped if the information in the table is the same as the information in the source file.
- The user is given the option to download the log file for the import transaction. If the user runs into errors while importing, the log file can be useful for troubleshooting purposes.