DTS Import Module User Guide

Version 1.1

 

Introduction

 

The DTS Import Module for the DTS Editor provides a way to “package” multiple Import Wizard load operations to accommodate more complex importing procedures. These packages, called Actions can then be easily executed using a simplified Import Module GUI.

 

The following assumes that the reader has a basic understanding of the DTS Import Wizard plug-in module.

 

 

Installation

 

Extract the files in ImportModule-1.1.zip into your DTSInstall directory. Be sure the Use folder names box is checked. This will place all the Import Module files into the appropriate folders:

 

Folder                                                  Files

DTSInstall\lib\modules                        importmodule.jar

                           PluginUtils.jar

DTSInstall\docs                                   importmoduleuserguide.pdf

DTSInstall\docs\help                           importmoduleuserguide.htm

 

Note: To operate the Import Module, the full Import Wizard Module must also be loaded.

 

 

Operation

 

The Import Module plug-in exposes two DTS Editor floating panels, an Import Action panel used to define Import Actions and an Import panel used to run the resulting Actions. Both panels are available from the DTS Editor Tools menu in the menu bar. The sections below describe the operation of the two panels

 

 

Import Action Panel

 

The Import Action panel is used to create and manage Import Actions: “packages” of multiple Import Wizard specifications that can be run together. Actions provide a simple process by which a complex set of imports can be executed by DTS Editor users.

 

The Import Action panel (see below) consists of an upper area for selecting the desired Action, a central edit panel for creating and modifying the content of the Action, and a bottom button panel for managing Actions themselves. The central edit panel contains areas for Action-wide parameters, the list of ImportWizard Step parameters that constitute the Action, and a lower button panel for editing operations.


Action Manage
 

Action Edit
 

Action Select
 

 

 

Editing Actions

 

Actions are persisted as values in the Import Module configuration file: DTSInstall/bin/editor.importconfig.xml. To edit an existing Action, select the Action name from the Import Action dropdown box. To create a new Action, click on the New button and enter the new Action’s name in the subsequent dialog. A new Action with a blank Step will be loaded into the panel. Note that this Action will not be saved to the Action folder until the Save button in the bottom button panel has been pressed (see Managing Actions below).

 

An Action consists of two Action parameters and a list of Import Wizard operations called Steps. The Action parameters are shown at the top of the edit panel:

 

Test File Delimiter     Enter the delimiter used by all the import data files (all import data files must use the same delimiter). Use the string (tab) for tab.

 

Includes Header              Check the Includes Header checkbox if all the import data files contain a header line as the first record.

 

Steps define Import Wizard import operations. When an Action is executed, each Step is performed sequentially in the order given in the Action. Any error in a Step will terminate the Action, i.e., subsequent Steps will not be performed. Progress and errors are reported in the Import Action panel status area (see Import Panel below).

 

The Action’s Steps are displayed in the edit panel’s Step list. Each Step has three elements: Name, Import File and Spec File (see the screen shot above). Values for all three elements are required.

 

The Name is a descriptive string used to label the Step when the Action is run. Double click in the Name‘s Value cell to enter/edit the Name. 

 

 The Import File is the data file used in the Step’s import. Double click in the Import File‘s Value cell to enter/edit the name and location of the Import File or click the Browse button to open a file browser. 

 

The Spec File is the Import Wizard Specification file used in the Step’s import. Double click in the Spec File‘s Value cell to enter/edit the name and location of the Spec File or click the Browse button to open a file browser. 

 

A number of Action edit buttons are available below the Step list (some buttons may not be available under certain conditions):

 

Up                    Moves the selected Step up one position in the list.

 

Down               Moves the selected Step down one position in the list.

 

Add        Adds a new, empty Step below the selected Step. If no Step is currently selected, adds the new Step at the beginning of the Step list.

 

Remove     Removes the selected Step from the list. No confirmation dialog is shown.

 

Clear             Opens the Confirm Clear dialog. After confirmation, all Steps are removed from the Action definition.

 

 

Managing Actions

 

The following Action management buttons are available at the bottom of the panel (some buttons may not be available under certain conditions):

 

Save               Validates the active Action definition, and if valid, saves the Action in DTSInstall/bin/editor.importconfig.xml.  If any errors are found, they are reported in the Action Error dialog.

 

Rename           Opens the Rename Action dialog. Enter a new name for the Action and press OK. The newly-named Action is loaded into the panel.

 

Copy       Opens the Copy Action dialog. Enter a new Action name and press OK. The current Action definition will be saved under the new name. The new Action is loaded into the panel.

 

Reload     Reloads the definition of the active Action from its saved file, i.e. all pending modifications are lost. A confirmation dialog is shown if the panel has modifications.

 

Delete           Opens the Delete Action dialog. After confirmation, the active Action file is deleted.

 

Cancel           Closes the Import Action panel. If modifications are pending, a confirmation dialog is shown.

 

 

Import Panel

 

The Import panel is used to run previously-defined Actions (perform imports). The panel (see below) consists of an Import Action selection dropdown at the top, two panel operation buttons, and the Import messages area.

 

 

To run an import Action, select the Action from the Import Action dropdown and press the Import button. The Close Button will change to Stop and the import will start immediately. Status and progress messages during the import will be reported in the Messages area. If any Step throws an error, the error will be reported in the area and processing of the Action will terminate.

 

Clicking on the Stop button while the import is running will also terminate the import.

 

To exit the Import panel without performing any operation, press the Cancel button.

 

 

Revision History

 

Version 1.0                  Initial release.

 

Version 1.1                  Update for DTS V4.1.