XML Import - field descriptions

Fields are presented in the order that they are presented in a form. Click a link to see the field descriptions for the form.

Overview

Use this page to create import definitions for use with XML Listener and to import XML data to Optiva. For example, you can use this form to import Optiva data from a test database into a production database.

Main tab

Description
Enter a description for the import definition.

Symbols tab

Use this tab to create the import definition. You can add more than one row and you can specify different symbols for each row.

The detail codes and the option choices can be different for each symbol. This criteria will be used to process the data in the XML file and integrate it to the Optiva database.

Detail Codes

Select the detail codes for the symbol that you wish to import.

In Object Explorer, you can select one value or multiple values.

If you enter the detail codes manually instead of using Object Explorer, you must insert a semi-colon in between each value.

Line
Shows a system-assigned line number.
Option

Select the method that will be used to import data from the XML file. See Import Option Choices below.

Symbol
Select a symbol from the list.

Import Option Choices

Do Not Import
  • Header data is updated for existing objects.
  • Detail data is not updated for existing objects.
  • New objects are not created.
Replace existing data and Merge with existing data
Both choices will:
  • Add new records to the Optiva database.
  • Modify Header data as defined in the XML file.

Detail data is processed differently depending upon your selection. See the Formula example.

Formula example

Suppose a formula exists in the Optiva database that has 8 lines in the Item Lines grid.

  • Line 2: There is a different item code and quantity in the XML file.
  • Line 3: This item is in the formula, but it is not in the XML file.
  • Line 9: This item does not exist in the formula, but it is in the XML file.

For Line 2 and 9, the Replace existing data and Merge with existing data choices will process the XML file the same way:

  • Line 2 of the formula will be updated.
  • Line 9 will be added to the formulla.
Line 3 will be processed differently.
Option Choice Description
Replace existing data

Removes line 3 from the formula because it is missing from the XML file.
Merge with existing data Retains line 3 in the formula.

Importing an XML file

  1. Specify the criteria for the import in the Symbols tab.
  2. Click Import XML.
  3. Specify the XML file to import in the File to Import field.
  4. Click Import to begin the import process. The import process can take a while.

When the import is complete, the Messages dialog box is displayed with the results. The View Log and View Result buttons are shown in the toolbar.

Viewing the results

  1. Click View Result. The results are shown in the Messages dialog box.
This is the order in which the results are shown:
Key
Shows the imported object
Line Number

Shows the line and column where this object begins in the file.

Status
  • 0 = Rejected. The file was not imported successfully.
  • 1 = Imported. The import succeeded.