User Manual

User Manual Orion OConverter Sponsered by Baker Hughes Inc

Date Sunday, November 02, 2008

Reason for change(s) First Draft

Author(s) Samira Hemrajani.

CHAPTER 1: Overview of OConverter OConverter is the Administration module for the Orion GIS project. This module allows the Admin to: 1. 2. 3. 4. 5.

Download files from the Internet Sources Import Files into the Internal Data Store(Location_info schema) Download Feature Class files from the sources when present Import Feature classes into the Internal Data Store(Feature_Class) schema This module automatically identifies the Data source if already present in the Internal Data store and alerts the user accordingly 6. This module also allows the user to configure the number of Data Sources and content of the Internal Data store with the help of a configuration file We will start by introducing the user to: • • •

How to create and manage the Configuration file giosource.conf Next we Explain How to Use Download Manager Utility and the Unzip Utility Next we introduce the Main Application which is the OConverter Import Utility which allows the user to import files from External sources (Internet) into the Internal Data Source (Database schema Orion which supports OGC standard).

2

CHAPTER 2: How to create a configuration file? The configuration file has a simple easy to ready text file. This file can be prepared by a nontechnical user. Single Source Information Between: [start] and [end] tags

3

Figure 1: Configuration File Content

The configuration file consists of the following tags: Tag #single line comment Source information: [start] …..[end] tags :separator tag :names tag :fields tag :mandatoryfields tag :mandatoryfeatures tag :featureseparator tag

Brief Explanation user can write a comment starting with the # sign The [start] and [end] tags comprise of one source This tag lists the separator This tag contains the name of the source This can lists the names of all the fields Maps the Mandatory fields from source to database Maps the Mandatory features from source to database This tags lists the separator for feature class file

Figure 2: Tag and Brief Description for Configuration file

Configuration File Tags Explained in Detail: 1. #single line comment The configuration file may contain a single line comment starting with the ‘#’ sign. Example: #I am a comment. However, the comment line should begin with a ‘#’ sign It is Illegal to have a comment in the middle of a line Example: I am not comment #but what follows me is This is WRONG! 2. Source information: [start] …..[end] tags The configuration file contains the information for a specific source within the [start] and [end] tags. 3. :separator tag This tag will contain the separator which is used to separate fields within the data sources fields Example: TX.txt file from the geonames.org source has a tab “ ”as a separator However, the TX.txt file from GNIS source has a pipe “|” separator 4. :names tag This tag contains the names of the source Example: geonames.org GNIS US

4

GNIS ROW and so on. 5. :fields tag This file contains administrative information i.e. it contains all the field names and their data type. This information may be used to identify the correctness of the data source. 6. :mandatoryfields tag This tag contains a mapping between the mandatory fields in the source file and the mandatory fields in the database in the location_info table.

Mandatory Field from database name feature class county state(province) country latitude longitude elevation description(source name)

Mapped to following field from geonames.org 1: name 7: feature code 11: admin2 code 10: admin1 code 8: country code 4 : latitude 5: longitude 15: elevation Geonames.org

Figure 3: Mandatory field mapping for fields in geonames.org to location_info table

7. :mandatoryfeatures tag This file contains a mapping between the mandatory fields in the feature class source and the database table feature_class. Mandatory Field from database class description reserved1 reserved2 data_source_id

Mapped to following field from geonames.org 0: Field 0 : Feature code 1: Field 1: Feature class description 2: Field 2: Feature class detailed description NULL NULL

Figure 4: Mandatory field mapping for fields in features.txt from geonames.org to feature_class table

8. :featureseparator tag This tag shows the separator within the feature class file For example: the Feature class file from geonames.org featureCodes.txt has the tab “ ” separator.

5

Chapter3: File Download File and Unzip utility: When the user clicks the “Run Download Manager” button on the Main Window, it will invoke the Download Manager utility. Opens Download Manager Utility

6

The Download Manager allows you to Save it to a Destination path.

7

Opens File Select Dialog box

download a file from the source and

It also allows you to Pause, Resume and Cancel a Download. Unzip Utility: We can invoke the Unzip utility once the file has been downloaded. This allows you to automatically unzip the file to a destination folder. Clicking on the BROWSE button opens a File Choose Dialog box which allows you to select a destination location on your computer.

8

The user can select the location to which he wants to save the unzipped file The Unzip Utility shows the contents of the Zip folder. The user may check mark a fiel he wanted to be unzipped

Choose location/destination to save unzipped file Select File to be Unzipped Accept OR Cancel Unzip

9

Chapter 4: OConverter File Import: This is the key module of the Orion GIS project and the OConverter Application. The File Import allows the user to select the file downloaded from the various sources and import them into the database; he can do this by clicking the browse button. He also has to select the name of the source and hit the “Accept” button to start the download.

Choose the source file to be imported

Choose the name of the source

The “File Import” shows a progress bar for the duration when the file is being imported

When the Import is completed successfully it alerts the user regarding the same.

10

Chapter 5: OConverter Feature Class Import: The Feature Class Import allows the user to select the feature class file and import it into the database; he can do this by clicking the browse button. He also has to select the name of the source and hit the “Accept” button to start the import. He additionally has to select the “Checkbox” to identify that he is importing feature classes.

Opens File Select Dialog box Opens File Select Dialog box Opens File Select Dialog box

Opens File Select Dialog box

11