1 introduction - university of texas at dallaschung/sa/presentations/fall-2015/ka… · web...
TRANSCRIPT
USER MANUAL
For CyberMiner Phase 2
CS/SE 6362.001
Fall 2015
Submitted to
Dr. Lawrence Chung
Associate Professor,
Department of Computer Science,
The University of Texas at Dallas,
Richardson, TX -75080
Team:
Vaidehi Jariwala
Karthik Kannambadi Sridhar
Ramakrishnan Sathyavageeswaran
Team Website:
http://utdallas.edu/~rxs142530/cyberminer/readme.html
Document status overview
Document title: User manual
Identification: User manual 2.1docx
Author:
Ramakrishnan Sathyavageeswaran,
Karthik Kannambadi Sridhar
Vaidehi Jariwala
Document status: Final
Version
Primary Author(s)
Description of Version
Reason of Change
Date
1.0
Karthik, Ram, Vaidehi
DRAFT
Documentation
10/14/2015
1.1
Karthik,Ram,Vaidehi
Phase 2 Added in the Features
Add and Update details in Documentation
11/8/2015
2.0
Karthik, Ram, Vaidehi
Draft updates
Fixed document heading
11/10/2015
2.1
Karthik, Ram, Vaidehi
Phase 2 Final Update
Adding screenshots
11/30/2015
Table of Content1 INTRODUCTION42 Help-Guidance42.1 Screen Images52.1.1 Home Page52.1.2 Add URL62.1.3 Search URL62.1.3.1 OR Search:92.1.3.2 AND Search:102.1.3.4 NOT Search:122.1.4 Delete URL132.1.5 User Config15
1 INTRODUCTION
The Cyberminer is a web search engine , mimicking the popular search engines like Google, Bing and Yahoo, but in a smaller environment where the web-links to be searched are part of a local database, and depending on the search keywords, the corresponding entries are shown to the user, from within the indexed database.
The Cyberminer uses KWIC system to store information in the Database in order to do efficient search.
2 Help-Guidance
The user interface (UI) is web-based which provides easy way to create KWIC index, and the search capabilities. The user interface consists of a text input box, and multiple internal window panes, which displays the URL and description. The interface is intuitive for users to understand every functionality. Appropriate tool tips shall be provided for various functionalities.
2.1 Screen Images 2.1.1 Home Page
Here, in the following home page below buttons are provided
add url
search url
delete url and
user config
Add URL:
It is used when user wants to add new URL to database.
Search URL:
This option is used when user wants to search URL which is already stored in database.
Delete URL:
It is used when user wants to delete the outdated URL.
User Config:
It is helpful when user wants to filter out words/symbols which are not meaningful to the users.
Figure Home Page 2.1.1
2.1.2 Add URL
Steps:
To add URL, user needs to click on add URL button.
After clicking on it, it will load 2 text boxes. One for adding URL and second for description
User needs to type URL and description in appropriate text box fields.
Figure 2.1.2 Add URL
2.1.3 Search URL
Steps:
To search URL, user needs to type a string. After hitting on search button, search result will be displayed with the help of elastic search.
User can perform three types of search.
Search Advanced Settings:
1. Autofill:
To support search and to avoid typographic errors during search we are using multiline Autofill during the search
Figure 2.1.3 Autofill Screenshot
2. Sort Search results:
We can sort the search results based on the following options
Ascending order based on description
Descending order based on description
Hitrate rate
Low Hitrate
Fig 2.1.4 Search results without sort
Fig 2.1.5 Search results without ascending discerption sort
Fig 2.1.6 Search results without ascending discerption sort
2.1.3.1 OR Search:
OR Search returns results of all possible combination of keywords.
How to perform OR search:
Search input format: Keyword1 keyword2 keyword3 keyword4
For Example: If we search with keywords code hdfc website. The system will search in database and retrieve the resulting document which matches the user input.
Figure 2.1.7 OR Search URL Input
Figure 2.1.8 OR Search Response
2.1.3.2 AND Search:
AND Search returns those results containing all the keywords given by the user.
How to perform AND search:
Search input format: Keyword1 && keyword2 && keyword3 && keyword4 (it is ok have space between && symbol and keywords)
For Example: If we search with keywords hdfc&&is. The system will search in database and retrieve one result which matches it.
Figure 2.1.9 AND Search Input
Figure 2.1.10 AND Search Response
Scenario 2:
If we search with keywords hdfc&&code. The system will search in database and retrieve no result since both keywords are not present in single document.
Figure 2.1.11 AND Search Response
2.1.3.4 NOT Search:
NOT search returns results exclusive of the keywords given by the user.
How to perform OR search:
Search input format: !Keyword1
For Example: If we search with keywords !hdfc. The system will search in database and returns results exclusive of the keyword given by the user.
Figure 2.1.12 NOT Search Response
2.1.4 Delete URL
Delete URL will allow user to delete the Out-to-date URL from the database.
How to perform Delete URL:
For this facility, user just needs to click on delete button. After clicking on it, it will prompt user an alert box for conformation and by clicking yes URL will be deleted from the system.
Figure 2.1.13 Delete URL Page
Figure 2.1.14 Delete URL Page alert box
Figure 2.1.15 Delete URL Page after deleting hdfc bank record from DB
2.1.5 User Config
Here, first user needs to enter word/symbol in the input box and click on Add button. For example $ or noise word. Once the user has saved the filter word to the filter list, during the search if these words are part of the URL/description then it will not show up on the search result.
View button will show the list of user configuration words
This is generally used when user needs to hide some words which annoy or abuse them.
Figure 2.1.16 User Config Page
Fig 2.1.17 User Config View filters
Fig 2.1.18 User Config Add filters
Fig 2.1.19 User Config View filters after adding
pg. 10