Download Database Extract Tool (DeTL)

CSI Solutions
Database extract Tool (DeTL)
Database extract Tool (DeTL)
Run Book
CSI Solutions
Document control and Version History
Technical Design
Table of Contents
1. Document control and Version History .......................................................... 3
2. Database Extract Tool (DeTL) Overview ......................................................... 3
3. Document scope ............................................................................................ 4
4. Technical Overview ....................................................................................... 4
5. DeTL Install configuration .............................................................................. 4
5.1. Prerequisites ...................................................................................................................... 4
5.2. DeTL Download and Install ................................................................................................ 4
1.
Download Detl executable from www.csisoftwares.com ......................................................................4
5.3. Prerequisites (Oracle client) .............................................................................................. 6
6. DeTL Main Window/Connectivity .................................................................. 7
6.1. Main options ...................................................................................................................... 7
6.1.1.
Create New DB connection ‘New’..........................................................................................................7
6.1.2.
Connect database ‘Connect’ ..................................................................................................................9
6.1.3.
Save DB connection ‘Save’ .....................................................................................................................9
6.1.4.
Delete DB connection ‘Delete’ .............................................................................................................10
7. Query Menu - User Query............................................................................ 11
7.1. User Query Window ........................................................................................................ 11
7.1.1.
Create a New query .............................................................................................................................11
7.1.2.
Save Query ‘Save’ ................................................................................................................................12
7.1.3.
Delete Queries .....................................................................................................................................13
7.1.4.
Browse or View Saved Queries. ...........................................................................................................13
CSI Solutions
Document1
5/6/2017
Page 2 of 14
CSI Solutions
1.
Document control and Version History
Technical Design
Document control and Version History
The document control section describes the version history and summary of changes made in document. It will
serve as version control for the content of the document.
Document location
The source of the document
Revision History
Revision
Number
1.
Revision Date
07-July-2016
Summary of Changes Made
Initial Draft
Changed By
Vijay and Krishna
2.
3.
4.
5.
2.
Database Extract Tool (DeTL) Overview
Database eXtract Tool (DeTL) is a windows based desktop application those who wants to extract the database
table data into flat files. The application will provide a GUI which can configure and extract the table data into files.
This is comprehensive tool for all data extract needs from databases.
The traditional tool has limited features on file export. The traditional tool exported data not been useful until you
did some manual modification. The DeTL is a best tool who wants the table data into files. The tool is useful for
database tester, ETL developer, Report generator and Hadoop data exports. The tradition tool does not suitable
real time data extract, DeTL is best tool real time data extract and Active data warehouse purpose.
DeTL is also act like database browser and where you can browse the database objects and view and export data
into files. The tool will allow you to save your queries that you want reuse the file extract.
DeTL is also provides scheduler which you can schedule your file extract/query. DeTL is also can use like ODBC/API
for ETL tool like informatica, Data stage and others. The tool can plug in you ETL tool.
The main feature of tools is…

Database various database connection creation and test connection on window.

Create a simple and complex queries .Save queries and execute and browse various saved queries.

Preview the partial/full saved queried data and export data

Quick search on saved queries and export the data.

Browse database objects across saved databases

Schedule the saved queries.
The following features not available in trail version

File Scheduler

Command line/API for third party Tool ( Informatica/Datastage)
CSI Solutions
Document1
5/6/2017
Page 3 of 14
CSI Solutions
3.
Document scope
Technical Design
Document scope
The main purpose of this document is to provide operational documentation for the DeTL application. It will
facilitate the management of application in the most efficient manner and thereby maximize the value of
application of Detl.
4.
Technical Overview
5.
DeTL Install configuration
5.1.
Prerequisites
In order to install DeTL in your desktop the follow prerequisites has to be fulfilled.



Windows OS
JRE
Oracle client
JRE – Java Runtime Environment 7.x version is required to run the DeTL application.
Oracle client - The DeTL is using oracle client to run the application.
On install if system does not find the JRE it will prompt you to download from oracle website.
5.2.
DeTL Download and Install
1.
Download Detl executable from www.csisoftwares.com
2.
Click on product menu and download DeTL executable,
3.
After download, Double click on Setup.exe.
4.
It will open security warning window, Click on Run.
CSI Solutions
Document1
5/6/2017
Page 4 of 14
CSI Solutions
DeTL Install configuration
Technical Design
5.
Select the Destination location of install. On default application will install under C:/Program
Files(x86)/DeTL. Click on Next
6.
Click on Install to install application.
7.
Click on Launch application and Finish.
CSI Solutions
Document1
5/6/2017
Page 5 of 14
CSI Solutions
5.3.
DeTL Install configuration
Technical Design
Prerequisites (Oracle client)
The oracle client must be installed in your desktop in order to run DeTL application.
To check whether you have installed oracle client or not
1.
Go to command prompt – Run ‘tnsping’ command with oracle server name
Ex: Tngping localhost
2.
Check name tnsname.ora (Below one is sample entry)
oraclexe\app\oracle\product\10.2.0\server\network\admin
XE =
(DESCRIPTION =
(ADDRESS = (PROTOCOL = TCP)(HOST = DESKTOP-AP5CO76)(PORT = 1521))
(CONNECT_DATA =
(SERVER = DEDICATED)
(SERVICE_NAME = XE)
)
)
Where
XE
Host
Port
-Sid
-DESKTOP-AP5CO76
-1521
Please note that above details would be using in ‘Database Connection’ creation.
CSI Solutions
Document1
5/6/2017
Page 6 of 14
CSI Solutions
6.
DeTL Main Window/Connectivity
Technical Design
DeTL Main Window/Connectivity
The DeTL Main window/Connectivity Window
This is the main window for application; this window will allow to create the new database connections to your
data extract and mange the existing database connection from the window.Database connection is name given for
database connection drivers. On default tool will use oracle driver.
Main options
6.1.
6.1.1. Create New DB connection ‘New’
1.
Click on Connectivity Menu
2.
Click On New , It will open window like below
CSI Solutions
Document1
5/6/2017
Page 7 of 14
CSI Solutions
DeTL Main Window/Connectivity
Technical Design
*Indicates that all fields should mandatory
The window shows the following fields in connectivity window
1.
2.
3.
4.
5.
6.
7.
DB Connection Name
Host Name
Port Number
SID
User Name
Password
Driver Type
DB Connection Name: Database connection Name is any valid Alphanumeric Name that user wish to
name the connection.
Hostname: Host Name of the database
Port number: Port number of the database
SID : is the database name or connection Name of Tnsnames.ora file
User name: Username of the database
Password : Password of the database
Driver Type: Drive type to connect the database
Default Oracle.jdbc.Oracle.Oracledrive
tnsnames.ora file references
3.
CSI Solutions
Document1
After entering the details can test connection by click on ‘Connect’ or save the connection by ‘Save’
option.
5/6/2017
Page 8 of 14
CSI Solutions
DeTL Main Window/Connectivity
Technical Design
6.1.2. Connect database ‘Connect’
The option is used to test the connection details that you wish to create before saving database connection. The
option will verify the connection is valid or not.
1.
After entering the click on ‘Connect’ button
2.
If details are valid it will print message ‘Connection Success’ else Connection unsuccessful.
6.1.3. Save DB connection ‘Save’
1.
Save the Database connection by click on ‘Save’ button on the window.
2.
The saved connection can see on Left side in List View.
3.
On successful connection save print info message ‘connected Saved’ and Log message :Saved
CSI Solutions
Document1
5/6/2017
Page 9 of 14
CSI Solutions
DeTL Main Window/Connectivity
Technical Design
6.1.4. Delete DB connection ‘Delete’
You can delete the saved connection from the list using Delete button.
1.
Click the save connection name from list and click on ‘Delete’ button.
2.
This will prompt ‘Are you sure to delete the saved configuration’ and click ‘Ok’
3.
On Successful deletion it print the information log ‘Deleted’.
CSI Solutions
Document1
5/6/2017
Page 10 of 14
CSI Solutions
7.
Query Menu - User Query
Technical Design
Query Menu - User Query
Query Menu is a second menu option in DeTL application, this menu has one has only one submenu i.e User
Query.
7.1.
User Query Window
The User Query window is for to create, execute and save your queries that you need to extract the data. In this
window you can save queries by using query name and db connection name and can refer in extract window.
The User Query window has below options
1.
Create a new query –‘New’
2.
Execute a query – ‘ Execute’
3.
Save query - ‘Save’
4.
Delete query – ‘Delete’
5.
You can switch the dbconnection using ‘Select DB file’
6.
You can view the saved queries in Available Queries in list view.
7.1.1. Create a New query
To create a new query
1.
Select DB connection from Select DB file drop down list. This will show the list of saved DB connection.
2.
Choose the ‘Select DB file’ from the dropdown list that you wish to create your queries.
CSI Solutions
Document1
5/6/2017
Page 11 of 14
CSI Solutions
Query Menu - User Query
3.
On ‘UserQuery’ textbox enter you query.
4.
Click on ‘Execute’ button.
a.
If query is valid it will print the Info log ‘xx rows selected’.
b.
If query is invalid it will print the error message “table or view does not exist”.
Technical Design
5.
7.1.2. Save Query ‘Save’
This option is used to save your tested/non tested queries. Once the query has saved it will display in Available
Queries list. To save a new or edited query.
1.
After adding or editing your query click on ‘Save’ option
2.
On successful save print message and info log - Query Save successfully.
3.
On Unsuccessful print the message and info ‘Query not saved’
CSI Solutions
Document1
5/6/2017
Page 12 of 14
CSI Solutions
Query Menu - User Query
Technical Design
7.1.3. Delete Queries
You can delete saved queries from list. To delete the query
1.
Click on Query name from ‘Available queries’ list.
2.
Click on ‘Delete’
a.
On successful delete print Log/Message ‘Query successfully deleted’.
b.
On Unsuccessful delete print Log/Message ‘Query does not deleted successfully’.
7.1.4. Browse or View Saved Queries.
You can browse or view saved queries in Available Queries list
CSI Solutions
Document1
5/6/2017
Page 13 of 14
CSI Solutions
Query Menu - User Query
CSI Solutions
Document1
Page 14 of 14
Technical Design
5/6/2017