file · Web viewUsing the speech training wizard. 35. 3.3.6. Using the mic training...

SmartSQL User Manual

User Manual

Faculty of Engineering ScienceSoftware Engineering Program

Fourth Year Engineering Project

SmartSQL


Table of Contents

1. INTRODUCTION............................................................................................................................ 7

2. TRAINING..................................................................................................................................... 8

THE MAIN SCREEN ON STARTUP.......................................................................................................................82.1. ADMINISTRATION MODULE..............................................................................................................92.1.1. DATABASE MANAGER....................................................................................................................102.1.2. SQL SERVER CONNECTION CONFIGURATION IN DATABASE MANAGER...................................................112.1.3. USER MANAGER...........................................................................................................................122.1.4. GLOSSARY - KEYWORDS.................................................................................................................132.1.5. GLOSSARY – QUERY TYPES..............................................................................................................142.1.6. GLOSSARY – CONVERSION TABLES FOR TABLES AND FIELDS OF THE DATABASE......................................152.1.7. GLOSSARY – FIELDS VALUES............................................................................................................172.2. SQLBUILDER – CONSTRUCTING SQL QUERIES USING GRAPHICAL INTERFACE...........................................182.2.1. SELECT QUERY – CHOOSING TABLES AND JOIN PARAMETERS BETWEEN THEM...........................................182.2.2. SELECT QUERY – CHOOSING OF FIELDS TO USE IN THE QUERY................................................................202.2.3. SELECT QUERY – ASSIGNING DIFFERENT SQL FUNCTIONS TO SELECTED FIELDS.........................................212.2.4. CONSTRUCTION OF CREATE/ALTER/DROP QUERIES (TABLES MANIPULATIONS)........................................222.2.5. INSERT/UPDATE/DELETE QUERIES CONSTRUCTING (RECORDS MANIPULATIONS).......................................232.3 NLP ANALYZER.................................................................................................................................232.3.1 NEW QUERY.................................................................................................................................252.3.1.1 NEW QUERY TOOLBAR..............................................................................................................262.3.1.2 NEW QUERY OPTIONS..............................................................................................................272.3.2 QUERY RESULT.............................................................................................................................282.3.3 OPEN SAVED QUERY......................................................................................................................29

3. REFERENCES............................................................................................................................... 30

3.1 ADMINISTRATION....................................................................................................................... 30

3.1.1 ADDING MS ACCESS DATABASE TO THE SYSTEM.....................................................................30

3.1.2 ADDING SQL SERVER DATABASE TO THE SYSTEM....................................................................30

3.1.3 REMOVE DATABASE FROM SYSTEM........................................................................................30

3.1.4 UPDATE SYSTEM’S GLOSSARY XMLS.......................................................................................30

3.1.5 ADD USER.............................................................................................................................. 30

3.1.6 REMOVE USER........................................................................................................................ 31

3.1.7 UPDATE OF “KEYWORDS” GLOSSARY......................................................................................31

3.1.8 UPDATE OF “QUERY TYPES” GLOSSARY...................................................................................31


3.1.9 UPDATE OF “CONVERSION TABLES” GLOSSARY.......................................................................31

3.1.10 UPDATE OF “FIELD VALUES” GLOSSARY..............................................................................32

3.2 SQL BUILDER............................................................................................................................... 33

3.2.1 BUILDING “SELECT” QUERY USING GRAPHICAL INTERFACE......................................................33

3.2.2 BUILDING “CREATE” QUERY USING GRAPHICAL INTERFACE.....................................................33

3.2.3 BUILDING “ALTER” QUERY USING GRAPHICAL INTERFACE.......................................................33

3.2.4 BUILDING “DROP” QUERY USING GRAPHICAL INTERFACE.......................................................33

3.2.5 BUILDING “INSERT” QUERY USING GRAPHICAL INTERFACE.....................................................33

3.2.6 BUILDING “UPDATE” QUERY USING GRAPHICAL INTERFACE....................................................34

3.2.7 BUILDING “DELETE” QUERY USING GRAPHICAL INTERFACE.....................................................34

3.3 NL ANALYZER.............................................................................................................................. 35

3.3.1 CREATING A NEW QUERY....................................................................................................... 35

3.3.2 OPENING A QUERY................................................................................................................. 35

3.3.3 REMOVING A QUERY FROM SAVED QUERIES LIST...................................................................35

3.3.4 CHANGING SPEECH PROFILE...................................................................................................35

3.3.5 USING THE SPEECH TRAINING WIZARD...................................................................................35

3.3.6 USING THE MIC TRAINING WIZARD.........................................................................................35

4. LIMITATIONS.............................................................................................................................. 36

5. Index...................................................................................................................................................37


1. Introduction

SmartSQL provides an access to databases using natural language queries.The SmartSQL system is designed to make it easier on the user. By using the system, the user doesn’t have to know the way the data is represented, stored and how to refer to the database in order to retrieve the desired information. The interface is simple and easy to use and doesn’t require any special training. In addition, the system interacts with WordNet, which is a semantic lexicon for the English language that provides additional functionality and many more possibilities to understand the user NL queries.

Furthermore, the SmartSQL NL interface is combined with a speech recognition interface which provides the ability to query with free speech. Another option is to turn on a voice command tool in order to navigate between the system windows by voice.

SmartSQL provides an ability to build SQL queries using graphical interface. With this interface, the user can build a SQL query by choosing elements on the screen. In any given moment, the state of the query is given – whether it’s valid or not and how it looks until now. The interface is intuitive and very easy to use, such that no previous SQL knowledge is required.

SmartSQL provides the administrator module. Through it the administrator can define all the parameters of the NL interface, the current working database, users of the system, dictionary constructing and updating.


2. Training

Installation & Running

1. Run the file “SmartSQL_Install.exe”2. Follow the instructions during the installation process.3. Open the folder you have chosen for placing “SmartSQL” and run

“SmartSQL.exe” to use the software.

During the installation process following software will be installed if not installed:a. .Net Framework 2.0b. WordNetc. Microsoft Speech SDK


The main screen on startup

This screen is opened right after the user runs the executable of the application.This screen allows the user to enter main three modules: Administration, SQL Builder, NLP Analyzer.

Setting this option enables the user to

navigate application windows using voice.

Exiting from the application.


2.1. Administration Module

This is the main screen of the Administration module. The user can choose from one of the three modules:

Manage Databases: add, remove or update databases with which the system works.

Manage Users: add or remove authorized users of the Smart SQL Application.

Manage Glossaries: update and change system’s glossaries and dictionaries.

Adding, removing or updating databases.

Adding or removing the users of Smart

SQL.

Change system’s glossaries and dictionaries.


2.1.1. Database Manager

This screen allows you to add new working database to the system or to remove current working database with help of ADD or REMOVE buttons accordingly. On the left list box are presented all the DBs that available for choosing. Browsing is done by using the 2 radio buttons:

SQL server – find and display all the SQL Server based databases on this computer.

MS Access – find and display all the MS access databases on this computer.

By clicking on the combo box on the right, you can choose current working database from the list, which was added previously.The Update DB Structure XML button allows updating all the supporting XMLs.

Choose current working database.

Find and display all MS Access databases.

List of the available Databases.

Add or Remove Databases.

Find and display all SQL Server databases.

Update all supporting XMLs.


2.1.2. SQL Server Connection Configuration in Database Manager

This screen allows checking and changing all needed SQL Connection string properties, such as:SQL Server name, initial catalog, integrated security, persist security info, user id, user password, connection timeout.The Default button returns all properties to default values.Check boxes allow including (or excluding) specific property to (from) connection string.


2.1.3. User Manager

This screen allows you to add new User to the system or to remove user with help of ADD USER or REMOVE USER buttons accordingly. On the right list box all the system’s user are placed.You can add new user with any login and password and with one of two defined states: Administrator or User. They have different access levels to the System (User can’t access the Administration module).

New user data submission (Login,

password).

Choose new user status(Admin or simple user).

List of all system’s users.


2.1.4. Glossary - Keywords


The Keywords screen allows you to manage the words that are used to identify various operators and operations in the query.In the “Keywords List” section you can see the list of all keywords that the system will recognize. When you select the word in the list, all the values associated with selected word will be shown in the right section - “Values List”.

List of all keywords that the system can

recognize

List of all values associated with

selected keyword


2.1.5. Glossary – Query types

The “Query types and parts” screen allows you to manage the special words that the system will use to identify the type and content of SQL query that need to be built.In the drop-down ‘Types, parts of query” combo-box you will see the list of SQL queries supported by the system (select, update, delete, insert, create, alter, drop) and special “where part”.When you select word from the combo-box, the list of associated values is shown in the ‘Keywords” list section. Those are words that the system searches to identify the type of query to build.When “where part” is selected, the “Keywords” section will show the list of values that the system will search to add the “WHERE” clause to the SQL query.

List of all keywords associated with

selected query type or part


2.1.6. Glossary – Conversion tables for Tables and Fields of the database.

List of all alternative values associated

with selected name

List of tables or fields names

List of values suggested by

WordNet glossary for selected name


The “Conversion tables” screen allows you to manage the information related to connected database – table names and fields names. It allows adding values with the same meaning to chosen table or field name. So when the query is analyzed, the system will look for these values and will associate them with right tables and fields from the database. When the ‘Tables” radio button is checked, in the “Names” list you will see the list of all tables name in the connected database. When the “Fields” radio button is checked, the “Select table” combo-box will allow you to choose table name and in the “Names” list you will see the list of all fields in the chosen table. When you select the name in the Names list, the list of values associated with chosen name will be shown in the “Alternatives” list. Also in the “WordNet Alternatives” you will see all the synonyms that were found in WordNet for selected name.


2.1.7. Glossary – Fields values

The “Fields Values” screen allows you to manage the words that the system will associate with specific fields in the database’s tables. To understand queries that include names of things – cities names, people’s names etc. the system has to now which names are there in the tables. This screen allows you to bind specific values to specific field – automatically by extracting unique values from the tables or manually by typing the value and inserting it to the list. When you select table name from “Select Table” combo-box, the list of all fields of this table is presented in the “Field Name” section. When you select specific field – the list of all words associated with this name is presented in the “Values” section.If you press the “Load values from DB field” button – the system will search and extract all unique values from selected field in the database and will add these values to the “Values” section.

List of all values associated with selected field

List of all tables in database

List of all fields in selected table


2.2. SQLBuilder – constructing SQL queries using graphical interface.

Main window of SQLBuilder, from this screen you can navigate to specified screens according to the desired query type. In each corresponding screen you can build your queries using graphical interface.


2.2.1. Select query – choosing tables and join parameters between them

This screen allows you to add tables to the query and connect between them by “Join” parameters.In the right list – the list of the tables, you can see all the tables in the database. By choosing one of them and pressing the “Add” button, you add the chosen table to the left list and by that to the system.If more than one table was added, then you should configure for each added table its join connection parameters to one of the previous added tables.

Query execution. By pushing this button query result will be shown provides the

query is “valid”

Resets the system, all the tables and fields

will be removed from the system execution

memory

Generated SQL query.Query validity status. Visual validity indication


2.2.2. Select query – choosing of fields to use in the query.

In this screen you choose fields to be used in the query for different manipulations.

Choose Table from the list and it fields will be

displayed


2.2.3. Select query – assigning different SQL functions to selected fields.

In this screen you can choose a field and set it for different SQL functions.

Choose Field from the list for assigning

different functions to it


2.2.4. Construction of Create/Alter/Drop queries (tables manipulations)This screen allows you to build Create/Alter/Drop queries.First choose query type:1. Create query:

a. Enter new table name.b. Add fields to the table.c. Execute query.

2. Alter query:a. Select table to alter from the list.b. Set alter type.c. According to alter type: select filed to alter or add new field.d. Execute query.

3. Drop query:a. Select table to drop from the list.b. Execute query.

Setting a query type

Selecting table to alter or to drop.

Adding new field parameters

New fields list

Add a field to the new fields list


2.2.5. Insert/Update/Delete queries constructing (records manipulations)This screen allows to build Insert/Update/Delete queries.First choose query type:1. Insert:

a. Select table from the list.b. Select fields and insert their values.c. Execute query.

2. Update query:a. Select table from the list.b. Select fields and insert their values.c. Set where condition if needed.d. Execute query.

3. Delete query:a. Select table from the list.b. Set where condition if needed otherwise all table’s records will

be deleted.c. Execute query.

Selecting a table you want to change

Selection of query type.

Assign this check box if you want to

insert/update a value to the chosen field

Assign this checkbox if you want to add where condition to the query for the selected field


2.3 NLP Analyzer

Press this button to enter the new nl query editor.

Press this button to enter the saved nl query list.


2.3.1 New query

Quick Buttons – The save, execute, clear and start speech buttons right beyond the text editor to perform the common operations quickly.

Quick Buttons

New Query Toolbar

Text Editor

Choice Window

Information Bar

Status Bar

Back Button


2.3.1.1 New Query Toolbar

Save and New buttons – Press the save button the save the executed query. Please note that the query can be saved only after you execute it.

Press the new button if you want the query you have already typed to be deleted from the text area and the system memory.

Undo, Redo buttons – Press the undo button if you want to undo the last operation. Press the redo button if you want to redo the last operation.

Cut, Copy and Paste buttons – Press the cut button to cut a part of the sentence or the whole sentence on the text area.

Press the copy button to copy a part or the whole sentence on the text area.

Press the paste button to paste the saved text on the text area.

Check spelling button – Press the check spelling button to check the spelling of your typed text.

Execute Query button – Press the execute button to execute your typed nl query.

Start Speech button – Press the start speech button to insert your query by speech.

Query button

Speech button

Save and New buttons.

Undo, Redo buttons

Cut, Copy and Paste buttons

spelling button


2.3.1.2 New Query Options

User Training Wizard – Choose this option in order to train your speech recognition profile so that it can understand your free speech and commands better.

To select this option: Tools → Customize → User Training Wizard. Or Right mouse click on the text area → User Training Wizard.

Mic Training Wizard – Choose this option in order to adjust your microphone in a best way it can perform.

To select this option: Tools → Customize → Mic Training Wizard. Or Right mouse click on the text area → Mic Training Wizard.

Change User Speech Profile – Choose this option in order to choose your previously saved speech profile.

To select this option: Tools → Customize → Mic Training Wizard. Or Right mouse click on the text area → Mic Training Wizard.

Note! Each one of these options also can be accessed by clicking right mouse button on the text area screen.


2.3.2 Query Result

This screen appears after the query is written or chosen from the saved list and executed.The screen displays the query result (Only for queries of “Select” type), the written NL query and the generated SQL query.There is also an option to preview and print the result shown on the screen.

To print the presented result:Choose File → Print.

To preview the shown result:Choose File → Print Preview.

Query Result Menu

Query Result Screen

The natural language query selected by user

The corresponding SQL query generated by the

system


2.3.3 Open saved query

Quick Buttons – The save, execute, clear and start speech buttons right beyond the text editor to perform the common operations quickly.

The same functionality can be obtained by click the toolbar or the Query option in the top menu.

Open Query Menu

The remove button deletes the selected

query from the saved queries list

The list of the previously saved queries

Quick Buttons

Back Button

The execute query button executes the

selected query from the list and shows the reults


3. References

3.1 Administration

3.1.1 Adding MS Access database to the system.

Select the “Administration” option → “Manage Databases”. Click the MS Access radio button. Chose access database file (or files) and click Open. In Database list box on the left part of the screen, all your chosen files appear. Select the desired database from the list box and push the ADD button. As a result, this database was added to the combo box of current database, which appears on the right side of the screen. Choose this database from the list and press the Update DB Structure XML.

3.1.2 Adding SQL Server database to the system.

Select “Administration” option → “Manage Databases”. Click the SQL Server radio button and the SQL Server Connection Configuration window will show up.If there are changes to be done with the connection string properties, type your changes. Click the OK button and all the SQL Server databases will appear in the Database list box on the left of the screen. Select the desired database on the list and press the ADD button. As a result, the database was added to the combo box of current databases. Choose this database from the list and press the Update DB Structure XML.

3.1.3 Remove database from system.

Select “Administration” option → “Manage Databases”. Choose, in the current db combo box, database that you prefer to remove. Select this database and push the REMOVE button. A confirmation window will show up. If you really want remove this db – click YES. As a result, this database is removed from the system.

3.1.4 Update system’s glossary XMLs.

Select “Administration” option → “Manage Databases”. (If the current database wasn’t set, choose the current working db by selecting one in the current db combo box.) Press the Update DB Structure XML button. Now all appropriate XMLs of this database was updated.


3.1.5 Add user

Select “Administration” option → “Manage Users”. Enter user’s login, password and confirm the password. Choose user mode (Administrator or simple user), by checking appropriate radio button. Click the ADD USER button. A confirmation window will show up. If you really want to add this user – click YES and this user will be added to the user’s list box (on the right) and to the system.

3.1.6 Remove User

Select “Administration” option → “Manage Users”. Select in the users list box the user that you want to remove. Click the REMOVE USER button. A confirmation window will show up. If you really want to remove this user – click YES and this user will be removed from the system user’s list (on the right).

3.1.7 Update of “Keywords” glossary.

To add new keyword to the system, you should enter two things – the “Subject” that describes the operator or operation and the “Sign” – the operator itself or the operation as word. For example, you want to add equal sign to the system: you should enter the word “EQUAL” as Subject and the sign “=” as Sign. When both fields are filled – press Add button to store new keyword in the system.To remove a keyword and all associated values from the list and the system, select chosen value and press the “Remove selected” button under the “Keywords List” section.To add new value that will be associated with specific keyword, select this keyword from the “Keywords List”, type new value in the text field under the “Values List” title and press Add right to text field.To remove a value from the “Values List” section, select chosen value and press “Remove selected” button under the “Values List” section.

3.1.8 Update of “Query types” glossary.

To add new value to the list – choose desired “query type” or “where part” from the drop-down list, enter new value in the text filed to the right to “Keywords” section and press Add button.To remove a value from the list – choose desired query type or “where part” from the drop-down list, select the value and press the “Remove selected” button below.


3.1.9 Update of “Conversion tables” glossary.

To add new alternative value to the table’s name – check the “Tables” radio button, select the desired table’s name from the “Names” list. Now you have two options – to add new value by typing it in the text field above “Alternatives” list and pressing “Add” button or you can select the value from “WordNet alternatives” list and press “Add” button to the right of “Alternatives” list.To add new alternative values to the field’s name – check the “Fields” radio button, choose the name of the table in the “Tables” combo-box and then select the desired name of the field. After that you have the written above options to ad new value that will be associated with chosen field. To remove alternative value from the list of alternatives associated with table or field name – select the value you want to remove from the “Alternatives” list and press “Remove” button to the right of the list.To save all the changes you have made to the conversion tables – press “Update and Save” button in the bottom of the screen.If you switch to another screen without pressing this button – all the changes you have made will be lost.

3.1.10 Update of “Field values” glossary.

To add new value to the field – select the field’s table name from the ‘Select table” combo-box, then select the field’s name from the “Field Name” section. Here you have two options – by typing new value in the “New Value” text field and pressing “Add” button or by pressing the “Load values from DB field” button – all the unique values that where extracted from selected field in the database will be added to the “Values” section.To remove value from the field’s values list - select the field’s table name from the ‘Select table” combo-box, then select the field’s name from the “Field Name” section, after that select the desired value from the “Values” section and press “Remove selected” button.To save all the changes you have made to the Fields values – press “Update and Save” button in the bottom of the screen.If you switch to another screen without pressing this button – all the changes you have made will be lost.


3.2 SQL Builder

3.2.1 Building “Select” query using graphical interface.

Select “SQL Builder” option, select “Select” query. Choose tables first to use in the query and then set “join” parameters between them. Select fields you want to use in the query from the tables that have been chosen before. Set the chosen fields to the desired SQL functions. For query execution press “Execute” button.

3.2.2 Building “Create” query using graphical interface.

Select “SQL Builder” option, select “Create/Alter/Drop” query. By entering the “Create/Alter/Drop” screen choose “Create” query, enter new table’s name. Insert new fields parameters and by finishing press “ADD” button. For query execution press “Execute” button. The execution status will be shown whether the execution succeeded or failed.

3.2.3 Building “Alter” query using graphical interface.

Select “SQL Builder” option, select “Create/Alter/Drop” query. By entering the “Create/Alter/Drop” screen choose “Alter” query and select table to alter from the list. Set alter type and according to alter type select field to alter or add new field parameters.For query execution press “Execute” button. The execution status will be shown whether the execution succeeded or failed.

3.2.4 Building “Drop” query using graphical interface.

Select “SQL Builder” option, select “Create/Alter/Drop” query. By entering the “Create/Alter/Drop” screen choose “Drop” query and select table to drop from the list. For query execution press “Execute” button. The execution status will be shown whether the execution succeeded or failed.

3.2.5 Building “Insert” query using graphical interface.

Select “SQL Builder” option, select “Insert/Update/Delete” query. By entering the “Insert/Update/Delete” screen choose “Insert” query and select table from the list. Select fields you want to assign them values, insert value for each field and assign check box for each field in order the changes to take place.


For query execution press “Execute” button. The execution status will be shown whether the execution succeeded or failed.


3.2.6 Building “Update” query using graphical interface.

Select “SQL Builder” option, select “Insert/Update/Delete” query. By entering the “Insert/Update/Delete” screen choose “Update” query and select table from the list. Select fields you want to assign them values, insert value for each field and assign check box for each field in order the changes to take place and set where condition if you want.For query execution press “Execute” button. The execution status will be shown whether the execution succeeded or failed.

3.2.7 Building “Delete” query using graphical interface.

Select “SQL Builder” option, select “Insert/Update/Delete” query. By entering the “Insert/Update/Delete” screen choose “Update” query and select table from the list. Set where condition if needed otherwise all table’s records will be deleted.For query execution press “Execute” button. The execution status will be shown whether the execution succeeded or failed.


3.3 NL Analyzer

3.3.1 Creating a new query with natural languageType your desired natural language query in the text area. You can perform check spelling before executing the query. If there are several possibilities to understand the query, the system shows the list of possible choices and the user should pick the most suitable for him.After everything is analyzed, the system shows the result if it is a “Select” type query or success/fail notification for other query types.

3.3.2 Opening a queryChoose the desired query from the list of previously saved queries and press the execute button. The system will show the result of the query by looking in its saved queries list.

3.3.3 Removing a query from saved queries listChoose the desired query from the list of previously saved queries and press the remove button. The system will ask for confirmation to remove and if the user confirms, the selected query is removed permanently from the list.

3.3.4 Changing speech profileOpen the Tools in the upper menu → Customize → Change user speech profile. A window with a list will be displayed. By choosing one of the users on the list, the profile is turned on.

3.3.5 Using the speech training wizardOpen the Tools in the upper menu → Customize → User Training wizard. A wizard will be displayed on the screen. The user should follow the instructions of the wizard in order to proceed.

3.3.6 Using the mic training wizardOpen the Tools in the upper menu → Customize →Mic training wizard. A wizard will be displayed on the screen. The user should follow the instructions of the wizard in order to proceed.


4. Limitations

4.1. Operation system

SmartSQL can run only on Windows operating system.

4.2. SQLBuilder limitations

Nested queries are not supported.

4.3. NL analyzer limitations

1. In NL analyzer the join between tables is limited to 2-3 tables.2. Nested queries are not supported.3. Microsoft Word should be installed on the system.


5. Index

A

Administration Module · 5, 6assigning different SQL functions · 18

C

choosing fields · 17choosing tables · 16constructing SQL queries · 15Construction of Create/Alter/Drop queries · 19Conversion tables · 12, 13

D

Database Manager · 7

F

Fields values · 14

I

Insert/Update/Delete queries constructing · 20Introduction · 4

K

Keywords · 10

M

Manage Databases · 6Manage Glossaries · 6Manage Users · 6MS Access · 7

N

New query · 22New Query Options · 24New Query Toolba · 23NLP Analyzer · 5, 21

O

Open saved query · 26

Q

Query Result · 25Query types · 11

S

SQL Builder · 5SQL server · 7SQL Server Connection Configuration · 8

U

User Manager · 9


Date post:	12-Mar-2018
Category:	Documents
Upload:	trinhanh
View:	212 times
Download:	0 times

file · Web viewUsing the speech training wizard. 35. 3.3.6. Using the mic training...

Documents