test 5.x user manual.doc · web viewthe dig smart client makes it easy to view more than one data...

44
Version 5.x December 2013

Upload: others

Post on 20-Mar-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

TABLE OF CONTENTS

Launching Page 3 - 4

Version 5.x

December 2013

Prepared By: Del Davis 12/10/2013

Page 2: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

DIG Smart Client Interface Page 5

Main Toolbar, Searches, Views, Data SourcesFavorites/History Lists Page 5 - 6

SEARCHING

- The DIG Smart Client Page 7- Using the Global Search Page 8 - 12- Wild Cards and Number & Dates Page 13 - 14- Selecting Data Sources Page 15 – 16- Using History/Favorites List Page 16 - 18- Running a Search from the History List Page 16- Running a Search from Favorites List Page 17- Using the Batch Query Page 19

Searching from a Fixed Width Text File Page 19 - 21 Searching from a Delimited Text File Page 21 - 23 Searching from a Results List Page 23 - 24

SEARCH RESULTS

- Viewing Search Results Page 24 Viewing Search Results as a Table Page 25 Result Types Page 26 - 27 Viewing Details from a Previous Search Page 27

- Working with Tables Page 27- The Navigation Toolbar Page 28- Sorting Data Page 28- Selecting Data Page 29 - Clearing Data Selection Page 29- Copying Data Page 29- Sending Data to the Batch Query Page 30 - Exporting Data (Overview) Page 30- Selecting Data to Export Page 30 - Exporting to XML and CSV Page 31

ALERTS Page 32 – 36

E-MAIL NOTIFICATIONS Page 35 – 36

2

INITIAL SCREEN WHEN SIGNING ON

Page 3: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

3

To LAUNCH DIG

Use Administrator Issued USER NAME and PASSWORD

Page 4: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

4

To Sign On

Page 5: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

The DIG Smart Client InterfaceThe DIG Smart Client is divided into five sections:

Main Toolbar

Available Searches

The View

Data Sources

Favorites/History List

Main ToolbarThe Main Toolbar consists of the following features:

Query - Lists all the available searches and displays the search criteria area

Alerts - Displays the Alerts Notification window

Results - Displays the search results yielded from executing a search. You can view the search results as a table or a report.

Help - Displays the help documentation for the DIG Smart Client

Available SearchesThe Available Searches area lists all the searches that are available for general use to users logged in to the DIG Server. All users have access to the Global Search, which enables you to perform a search on data sources that were previously

5

QueryBatch QueryAlertsServer ViewResultsOptionsHelpAbout

Choice of Servers to search

Set-up Alerts

History

Page 6: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

indexed by the DIG administrator. Search Objects represent the available data fields you can query. They enable you to search all data sources with similar data fields.

The ViewThe View area is dynamic and changes depending on the activity you are currently performing in the DIG Smart Client. When you want to perform a search, the View will display an area where you can enter your search criteria into the fields provided.

From the View, you can:

Enter or change your search criteria

Add, change or delete an alert notification

Work with search results

Data SourcesThere are three options for selecting data sources:

My DIG Server (Local Sources) - Lists only the local data sources available from the DIG Server you are currently connected to

All DIG Servers (All Sources) - Lists all the available data sources, including those available from the DIG Server you are currently connected to and those on remote servers connecting to the local DIG Server

Custom Selection of DIG Server & Sources - When selected, the Data Sources area refreshes with selectable checkboxes next to all the local and remote DIG Servers and their data sources. This option enables you to manually select the data sources you wish to query.

Favorites/History ListAfter you execute a search, DIG automatically saves the information to your History list. Items on the History list will remain so through a specified number of searches. The number of searches saved in the History list is determined by your DIG administrator.

After the search criteria is added to the History list, you then have the option to save it to your Favorites list to be used again. Items will remain on the Favorites list until you manually remove it

6

Page 7: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Searching the DIG Smart Client

The DIG Smart Client enables you to perform a global search.

The global search enables you to perform a basic search by typing the information directly into the Global Search text area and clicking on the Start Search button.

The global search lets you search:

Indexed database sources

Your DIG Administrator can elect to index fields within a database source. Indexed database sources display with an icon in the Data Sources tree. A text search on these sources will search all indexed fields.

Text-based sources

All text-based sources are fully indexed. A text search on these sources will search each of the documents/files in their entirety.

The DIG Smart Client also enables you to use more complex search functionalities such as Phonetic or Synonym searching techniques on all form searches.

You can clear your search criteria by clicking on the button located in the Search toolbar.

7“HOW TO” QUERY USING A GLOBAL

SEARCH

Page 8: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Using the Global Search

8

Search Parameters are entered here, as:

All of the WordsAny of the WordsThe Exact PhraseBoolean

Select:My DIG ServerAll DIG ServersCustom Selection

Page 9: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

The DIG Global Search is a free-text search engine - similar to Internet search engines like Google™, Yahoo® and the like. It allows you to search for specific words, a few characters, or entire phrases. The Global Search also supports Wild Cards for more advanced searching.

To perform a global search:

Step

Action

1If necessary, click the Query icon in the Main Toolbar.

2 In the Available Search list on the left, make sure the Global Search item is selected.

3 In the Global Search field, type the characters, word, or words you want to search for.

You can type a few characters, a full word, or a phrase.

To search for multiple search terms, use the connectors and advanced search functionally described in step 4.

To search for an exact phrase (e.g., most wanted), enclose the search criteria in quotation marks (e.g., "most wanted").

9

“BOOLEAN”

To search for “2452 FAIRHILL”

ENTER“2452 w/3 fairhill”

“ANY or ALL of the Words”

Search for “2452 FAIRHILL”

ENTER“2452 fairhill”

But choose ALL v. Boolean

Page 10: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

To apply advanced search techniques (e.g., phonetic matching), use the Wild Cards (described below).

If you use no connectors or wild cards, DIG searches for the text exactly as entered.

4 To search for multiple search terms, use one of the following connectors:

Note:  You will need to use the drop down menu to select Boolean in the search toolbar.

Connector Does Example

AND Returns only results that match both criteria

apple AND pearreturns only records or documents that contain both words

OR Returns any result that matches either criteria

apple OR pear returns any record or document that contains either word

AND NOT Omits results that contain the second word

apple NOT pear finds all records or documents containing apple, then omits those that also contain pear

W/x Returns only results where the second word is within "x" number of words of the first

apple W/5 pearreturns only records or documents that contain the word pear within 5 words of the word apple

NOT W/x Returns only results where the second word is NOT within "x" number of words of the first

apple NOT W/5 pear returns only records or documents in which the word pear is more that 5 words away from the word apple

W/x XFIRSTWORD

Returns only results where the word occurs within the first "x" number of words

apple W/5 XFIRSTWORD returns only results in which apple occurs within the first 5 words

W/x XLASTWORD

Returns only results where the word occurs within the last "x" number of words

apple W/5 XLASTWORD returns only results in which apple occurs within the last for words

When using more than one connector, use parenthesis to distinguish the search strings. For example, "apple and pear or orange juice" could mean "(apple and pear) or orange juice," or it could mean "apple and (pear or orange) juice."

Note:  Noise words, such as "if" and "the", are ignored in searches.

10

Page 11: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

 

5 To apply advanced text search functionality, select one of the following:

To search for

Do this Example

Only items matching all of the search terms entered

In the search toolbar, use the drop down menu to select All of the Words.

apple pear orangereturns only records or documents that contain all of the words Apple, Pear and Orange.

Items matching any of the search terms entered

In the search toolbar, use the drop down menu to select Any of the Words.

apple pear orangereturns records or documents that contain any of the words Apple, Pear or Orange.

Exact matches only

In the search toolbar, use the drop down menu to select The Exact Phrase.

applereturns only records or documents that contain the word Apple.

Multiple terms using Boolean logic to define the connection

In the search toolbar, use the drop down menu to select Boolean.

apple AND pearreturns only records or documents that contain the words as linked by the connector. In this example, both of the words Apple and Pear must be present.

Terms that sound the same

In the search toolbar, select Phonetic.

smithreturns records or documents that contain the words

11

Page 12: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Smith, Smythe or Smithe.

Terms with similar meanings

In the search toolbar, select

Synonyms.

fastreturns records and documents that contain the words Fast and Quickly.

All items containing the characters or words entered within a certain distance.

In the search toolbar, select

Fuzzy.

applereturns records or documents that contain the words Apple and Appple.

Grammatical variations of a root word

In the search toolbar, select

Stemming.

fishreturns records or documents that contain the words Fish and Fishing.

 

6 Set the data sources you want to search:

To search Do this

All local data sources

In the toolbar above the Data Sources tree, use the icon to select My DIG Server (Local Sources).

All data sources available

In the toolbar above the Data Sources tree, use the icon to select All DIG Servers (All Sources).

Specific data sources

In the toolbar above the Data Sources tree, use the icon to select Custom Selection of DIG Servers & Sources.

Result: The Data Sources tree refreshes to show checkboxes for each data source in the list.

Click to select and/or de-select data sources.

All selected (checked) data sources will be searched.

 

7 Click the Start Search button to execute your search.

12

Page 13: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Wild CardsThese operations can also be applied to individual values in your search string. Use the appropriate wild card to apply these operations to individual values:

Wild Card

Does Example

? Matches any single character.

r?dmatches red, rid, rod

? is a one-for-one wild card character. In other words, for each ? you enter in your search string, the results can vary one character. For example:

cat? returns cats

cat???? returns cats and catches

cat????? returns catches and catching.

* Matches any number of characters.

r*dmatches round, read, road, red, rid, rod

* is a one-to-any wild card character. This wild card matches any number of varying characters. For example:

cat* returns cats, catches and catching

r*d returns such values as rid, road and round.

% Performs a Fuzzy Search on a word.

arrest AND %crimefinds any document containing arrest AND variants of crime such as crome and crims.

# Performs a Phonetic Search on a word.

#smith AND #chrisfinds any document containing variants of smith such as smyth, smith, smythe AND variants of chris such as kris.

~ Performs Stemming on a word.

indicted AND fire~finds any document containing indicted AND variants of fire such as firearms.

& Performs a Synonym Search on a word.

arrest AND document&finds any document containing arrest AND variants of document such as file, record and text.

All text-based searches support wild cards. These are characters that you insert to replace unknown or possibly interchangeable characters in your string. For example, to search for Smith and Smyth at once, you could use the ? wild card (sm?th) to retrieve all data with a variation of smXth where the X could be any character at all.

13

Page 14: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Numbers and DatesThese operations should be applied when searching for a number or date.

Format Description Example

$NUMBER(value) Returns any result that matches the number criteria.

$NUMBER(3)

returns any record or document that contains the number 3.

$Date(value)

 

Returns any result that matches the date or time criteria.

$Date(1996/11/30)returns any record or document that contains the date November 30, 1996. Must use the YYYY/MM/DD format.

$Date(12:34:00)returns any record or document that contains the time 12:34:00. Must use the HH:MM:SS format.

$Date(1996/11/30 12:34:00)returns any record or document that contains the date November 30, 1996 and the time 12:34:00.

ColumnName $NUMBER(value)

 

Returns any results that match the number criteria within the designated column.

PersonID $NUMBER(3)returns any record from the PersonID column that contains the number 3.

ColumnName $DATE(value)

 

Returns any results that match the date criteria within the designated column.

BirthDate $DATE(1996/10/30) (EXACT DOB)returns any record from the BirthDate column that contains the date October 30, 1996.

~~

(2200 Block Tulip)

Best search for “Hundred Block” is:

(Boolean)

2200~~2299 w/3 tulip

Specifies a numeric range. Boolean must be selected in the search toolbar.

 

$Number(3)~~$Number(8)returns any record or document that contains the numbers 3 through 8, including 4, 5, 6 and 7.

$DATE(1996/11/30)~~$DATE(1996/12/05)returns any record or document that contains the dates November 30, 1996 through December 5, 1996, including December 1st, 2nd, 3rd and 4th.

PersonID $NUMBER(3)~~$NUMBER(8)returns any record from the PersonID column that contains the number 3 through 8, Including the numbers 4, 5, 6 and 7.

BirthDate $DATE(1996/11/30)~~$DATE(1996/12/05)returns any records from the BirthDate column that contains the

14

Page 15: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

dates November 30, 1996 through December 5, 1996, including December 1st, 2nd, 3rd and 4th.

Note:  Commas are ignored if the data source has the data type listed as a number.  For example, “-123,456.78” is interpreted as: “-123456.78”.

EXAMPLE: Search for “Malcolm Simmons” with a DOB of “08/24/93”. Search Boolean for:

Malcolm w/3 simmons and $Date(1993/08/01)~~$Date(1993/08/31)

Selecting Data SourcesWhenever you build a search, you can select the data sources you want to search. A data source can be any number of things including a database, document or web site. Whenever you build a search, you can select the specific data sources you want to search.

By default, DIG will search all of the available data sources. You can choose to search only the sources on your local DIG Server or manually select individual data sources.

The Data Sources tree lists all of the data sources  –  databases, documents, and web sites, that your DIG Administrator has set up for your use.

There are three options for selecting data sources:

My DIG Server (Local Sources) - Searches only the local data sources available from the DIG Server you are currently connected to.

All DIG Servers (All Sources) - Searches all the available data sources, including those available from the DIG Server you are currently connected to and those on remote servers connecting to the local DIG Server. This is the default setting.

Custom Selection of DIG Servers & Sources - When selected, the Data Sources area refreshes with selectable checkboxes next to all the local and remote DIG Servers and their data sources. This option enables you to manually select the data sources you wish to query.

Types of Data SourcesA search can be narrowed down by choosing the type of data source you wish to search. By default, DIG searches all available data sources. You can de-select sources that you do not want to search, or select sources that you previously de-selected.

The different types of data sources are shown using a variety of icons.

Icon Represents Description

All database sources on a particular DIG Server

Selecting or de-selecting this source selects or de-selects all database sources on the DIG Server.

An individual database on a DIG Server

Selecting or de-selecting this source selects or de-selects all subordinate subsets.

A subset of data within a database These are the individual "Views" (or logical grouping) of data fields in the database. There may be several Views defined for each database source.

All text-based sources (files, documents, web sites, and e-mail archives) on a particular DIG Server

Selecting or de-selecting this source selects or de-selects all text-based sources on the DIG Server.

An individual index on a DIG Server Selecting or de-selecting this source selects or de-selects all subordinate indexes.

15

Page 16: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

A subset of data within the index These icons represent the actual index for the source.

To manually set which sources will be searched:

Step

Action

1 In the Data Sources panel's toolbar, click the icon to display the options.

2 Select the Custom Selection of DIG Servers & Sources option.

3 Use the and signs to expand and collapse the source tree as necessary.

4 Click in the checkbox next to a particular data source to select or de-select it.

Using the History/Favorites ListWhenever you execute a search, DIG automatically saves it to your History list. You can then add it to your Favorites list to be used again.

You can also use your search criteria to create an Alert.

The History List is... The Favorites List is...

Updated every time you execute a search

Note:  If you execute the same search multiple times, the search will be stored in your History list just as many times.

Updated manually

Note:  Only you can add searches to your Favorites list. Searches are added manually to the Favorites list from the History list.

Both lists can be configured by your DIG Administrator to store as many searches as you want.

Using the History ListFrom the History List, you can:

Click an item to execute the search again

Add a search to your Favorites List

Create an Alert from your search criteria

16

Page 17: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Running a Search from your History ListWhen you select a search in the History List, DIG automatically populates the search criteria in the Global Search feature query), where you can execute the search again or modify it to create a new search.

Adding a Search to your Favorites ListWhen you execute a search that you may need to use again, you can save the search to your Favorites List for future use.

To add a search to your Favorites List:

Step

Action

1 If necessary, select the History tab.

2 In the History List, click once on the search you want to save.

3 In the panel's toolbar, click the Add button to add the search to the Favorites List.

Result: The search is added to your Favorites List where you can simply click it to execute the search again.

Clearing your History ListYou can manually clear your entire History List at any time.

To clear your History:

Step

Action

1 If necessary, select the History tab.

2 In the panel's toolbar, click the Clear History button to remove all the items from your History List.

Using the Favorites ListFrom the Favorites List, you can:

Click an item to execute the search again.

Create an Alert from your search criteria

Running a Search from your Favorites ListWhen you select a search in your Favorites List, DIG automatically populates the search criteria in the Global Search, where you can execute the search again or modify it to create a different search.

Items on your Favorites list will remain there until you manually remove them.

17

Page 18: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Removing a Search from your Favorites ListYou may elect to remove one or all your saved searches from the Favorites list.

To remove a previously saved search from your Favorites List:

Step

Action

1 If necessary, select the Favorites tab.

2 What do you want to delete?

To delete Do this

A single stored search Click once on the search you want to delete.

In the panel's toolbar, click the Remove button.

All stored searches In the panel's toolbar, click the Remove All button.

 

Adding an Alert from the History or Favorites ListYou can create an Alert from an executed query directly from either the History or Favorites list.

To create an Alert:

Step

Action

1 From either the History or Favorites list, select the search you want to add to your Alerts.

2Click on the Add button to create an Alert.

Result: The Alert details displays with the Alert Criteria field already populated.

18

Page 19: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Using the Batch QueryThe DIG Batch Query lets you search multiple values at once and import search values from a text file.

The text file:

Should contain only the values that you want to include in your search. You cannot remove values from the query once the text file is imported.

May contain values for one or  more database columns (fields).

Must be:

Fixed width (i.e., columns are aligned and separated by space)

Delimited (i.e., columns are separated by commas, tabs, semicolons, etc.)

DIG XML (i.e., values exported to XML from DIG search results)

Can include column headings.

You may also initiate a Batch Query from a search results list.

This tool lets you choose which data sources you want to search and creates a new Results tab listing the matches found.

Searching from a Fixed Width Text FileUse the following procedure to import search values from a fixed width text file. A fixed width text file uses white space to separate columns.

Step

Action

1 In the Main Toolbar, click the Batch Query icon.

Result: The Batch Query settings display.

2 Click the Import Delimited option.

Result: The Import Delimited Text Files for Batch Query window displays.

3 Next to the Choose the input file field, click the button.

Result: A standard file browse window opens.

19

Page 20: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

4 Navigate to and double-click the text file name.

Result: The content of the file is displayed in the Preview area at the bottom of the window.

5 If necessary, in the Choose the format that most correctly describes your data options, select Fixed Width.

6 Click the Next button.

Result: A new window displays allowing you to set format options.

7 Set the fixed width text file specifications:

Click in the first row of the Field Name column to type the name of the column that will be searched for the values in field 1.

This restricts the search to particular data fields (columns) in your database sources.

Use the remaining rows to specify the column names for fields.

Use the Field Size cell to indicate the length of each of the columns.

If the file you've selected contains the column headings in the first row, click to select the First Row Contains Field Names option.

Click the Next button.

Result: A new window displays allowing you to set or change field headings and data types.

8 If necessary, set the column names and/or data types.

To create a column name or reset a column name:

Click on the column in the preview grid.

In the Field Name text box, type the name of the column to be searched for the values in the column.

To set the data type for a column (field):

In the preview at the bottom of the window, select the column.

From the Data Type drop-down, choose the correct data type:

String - Use for text data fields.

Integer - Use for numeric data fields.

Double - Use for numeric data fields with decimals.

Date/Time - Use for data fields containing dates and/or times.

Use the File Handling Options area to specify whether the entire file should be processed in a single query or batched:

Select the Batch Mode option to process a specific number of lines at once.

This significantly reduces the strain on system resources when working with very large text files. Use the text field to specify the number of lines to processed at once.

De-select Batch Mode to process the entire file at once.

9 Click the Finish button.

Result: You return to the Batch Query settings. The columns and values in the file are displayed on the left.

10 Set the filter criteria:

By default, DIG returns only items with a 90% or higher relevancy score - as determined by the matches found in each item. To retrieve as many matches as possible, you may want to

20

Page 21: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

lower the minimum relevancy score percentage.

By default, DIG limits the number of results loaded to 1,000 - making viewing results more manageable. To retrieve more or less, adjust the setting in the Load a maximum of this many results field.

11 Set the search range.

To search only the specified columns for the selected values, leave the Ignore Column Headers and Perform a Global Search option unchecked.

To search across all fields, as well as text-based data sources, select the Ignore Column Headers and Perform a Global Search option.

12 Set the data sources you want to search:

To search Do this

All local data sources

In the toolbar above the Data Sources tree, use the icon to select My DIG Server (Local Sources).

All data sources available

In the toolbar above the Data Sources tree, use the icon to select All DIG Servers (All Sources).

Specific data sources

In the toolbar above the Data Sources tree, use the icon to select Custom Selection of DIG Servers & Sources.

Result: The Data Sources tree refreshes to show checkboxes for each data source in the list.

Click to select and/or de-select data sources.

All selected (checked) data sources will be searched.

 

13 Click the Run Batch Counts button to execute your search.

Searching from a Delimited Text FileUse the following procedure to import search values from a delimited text file. A delimited text file uses a specific character to separate columns.

Step

Action

1 In the Main Toolbar, click the Batch Query icon.

Result: The Batch Query settings display.

2 Click the Import Delimited option.

Result: The Import Delimited Text Files for Batch Query window displays.

3 Next to the Choose the input file field, click the button.

Result: A standard file browse window opens.

21

Page 22: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

4 Navigate to and double-click the text file name.

Result: The content of the file is displayed in the Preview area at the bottom of the window.

5 If necessary, in the Choose the format that most correctly describes your data options. select Delimited.

6 Click the Next button.

Result: A new window displays allowing you to set format options.

7 Set the delimited text file specifications:

Use the Choose a delimiter to separate your fields options to specify the character used to separate data fields in your text file.

DIG makes a best guess of the delimiter used. The table at the bottom of the page displays a preview of the data using the selected delimiter.

Click to select the correct delimiter or select Other and type the correct character in the text box.

Use the First Row Contains Field Names option to specify whether the first line of the text field contains column (field) names.

When selected, the values in the first line are displayed as column headings in the preview.

Use the Text Qualifier drop-downs to specify the character used to indicate text (string) type data fields.

Tip: You can use the Back button to preview the content of the file to view the text field qualifier.

Click the Next button.

Result: A new window displays allowing you to set or change field headings and data types.

8 If necessary, set the column names and/or data types.

To create a column name or reset a column name:

Click on the column in the preview grid.

In the Field Name text box, type the name of the column to be searched for the values in the column.

To set the data type for a column (field):

In the preview at the bottom of the window, select the column.

From the Data Type drop-down, choose the correct data type:

String - Use for text data fields.

Integer - Use for numeric data fields.

Double - Use for numeric data fields with decimals.

Date/Time - Use for data fields containing dates and/or times.

Use the File Handling Options area to specify whether the entire file should be processed in a single query or batched:

Select the Batch Mode option to process a specific number of lines at once.

This significantly reduces the strain on system resources when working with very large text files. Use the text field to specify the number of lines to be processed at one time.

De-select Batch Mode to process the entire file at once.

22

Page 23: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

9 Click the Finish button.

Result: You return to the Batch Query settings. The columns and values in the file are displayed on the left.

10 Set the filter criteria:

By default, DIG returns only items with a 90% or higher relevancy score - as determined by the matches found in each item. To retrieve as many matches as possible, you may want to lower the minimum relevancy score percentage.

By default, DIG limits the number of results loaded to 1,000 - making viewing results more manageable. To retrieve more or less, adjust the setting in the Load a maximum of this many results field.

11 Set the search range.

To search only the specified columns for the selected values, leave the Ignore Column Headers and Perform a Global Search option unchecked.

To search across all fields, as well as text-based data sources, select the Ignore Column Headers and Perform a Global Search option.

12 Set the data sources you want to search:

To search Do this

All local data sources

In the toolbar above the Data Sources tree, use the icon to select My DIG Server (Local Sources).

All data sources available

In the toolbar above the Data Sources tree, use the icon to select All DIG Servers (All Sources).

Specific data sources

In the toolbar above the Data Sources tree, use the icon to select Custom Selection of DIG Servers & Sources.

Result: The Data Sources tree refreshes to show checkboxes for each data source in the list.

Click to select and/or de-select data sources.

All selected (checked) data sources will be searched.

 

13 Click the Run Batch Counts button to execute your search.

Searching from a Results ListUse the following procedure to start a Batch Query from values selected in a previously run search results list.

Step

Action

1 In the results list, select the values you want to search.

2 Click the Copy to Batch Query option.

Result: The Batch Query settings display. The values you selected are displayed on the left.  

3 Set the filter criteria:

By default, DIG returns only items with a 90% or higher relevancy score - as determined by

23

Page 24: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

the matches found in each item. To retrieve as many matches as possible, you may want to lower the minimum relevancy score percentage.

By default, DIG limits the number of results loaded to 1,000 - making viewing results more manageable. To retrieve more or less, adjust the setting in the Load a maximum of this many results field.

4 Set the search range.

To search only the specified columns for the selected values, leave the Ignore Column Headers and Perform a Global Search option unchecked.

To search across all fields, as well as text-based data sources, select the Ignore Column Headers and Perform a Global Search option.

5 Set the data sources you want to search:

To search Do this

All local data sources

In the toolbar above the Data Sources tree, use the icon to select My DIG Server (Local Sources).

All data sources available

In the toolbar above the Data Sources tree, use the icon to select All DIG Servers (All Sources).

Specific data sources

In the toolbar above the Data Sources tree, use the icon to select Custom Selection of DIG Servers & Sources.

Result: The Data Sources tree refreshes to show checkboxes for each data source in the list.

Click to select and/or de-select data sources.

All selected (checked) data sources will be searched.

 

6 Click the Run Batch Counts button to execute your search.

Viewing Search ResultsWhen you execute a search, DIG populates the results in a table with information obtained from the data source you select. The data source list shows all the databases that have returned results from your query and the exact number of hits for each of the available data sources.

Once you perform a query, you can do any one of the following:

Choose to view information from another available data source.

View the details of a previously performed search from your current session.

Copy information from a row and paste it into a word processing program such as Microsoft Word or a plain-text program like Notepad or WordPad.

Export the search details to a Microsoft Excel spreadsheet or an XML document.

Select all or none of the data in the table.

24

Page 25: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Viewing Search Results as a TableThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select as many data sources as you want from the available data source list. While the current information remains in the view, the results returned from the other data sources can be easily selected by clicking on the tabs located on the bottom of the View. One click of the mouse lets you view all your relevant data at one time.

 

To view information from an available data source:

Step

Action

1 Click on the appropriate database source from the data source list.

Database sources with available results will display in the list with a icon next to the data source name.

25

Page 26: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Text-based sources with available results will display in the list with a icon next to the data source name.

Result: The results display the requested data in the View.

Result TypesSearch results are displayed in one of two ways depending on the type of source from which they were retrieved.

Database and text-based data source results vary considerably in how they appear and what information each generates.  A text-based data source is information received from either files, documents, web sites, or email archives located on the DIG Server. The search results of a text-based data source includes useful information such as a copy of the original document and its file location (with a hyperlink for easy access), an HTML version of the data, and a document summary with a list of preferred search terms.

26

Page 27: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Database sources are displayed in the form of a table. You can select all the columns and rows, copy and paste your data and view your search results in the form of a report. You can also view an HTML version of the data (if available for the source).

Viewing Details from a Previous SearchThe DIG Smart Client lets you view search results returned from previous queries you performed during your current login session.

To view results from another search:

.

Step

Action

1 Click on the first drop-down menu at the top of the data source list.

2 Select a search from the list provided.

Result: The View will populate with the selected search results.

Working with Tables

27

Page 28: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Search results retrieved from database sources are, by default, displayed in a tabular, or table, format. The table format mimics the layout of the data in the database. This allows you to view values based on columns (fields).

The Navigation ToolbarThe Navigation toolbar provides a number of tools that let you move through the search results.

This Tool Does

Displays the first page of the search results.

Displays the previous page of the search results.

Displays the current page number of the available search results you are viewing in the table.

Displays the next page of the search results.

Displays the last page of the search results.

Lets you enter a specific page of the search results that you want to display.

Displays the number of results you will see per page. This option lets you display anywhere from 10 to 100 results per page.

Closes the table displaying the current search results.

Sorting the Data The DIG Smart Client lets you sort the data based on values in any one data field.

To sort the data:

Step

Action

1 Click on a column heading in the table.

Result: DIG sorts the results based on the values in the field. By default, the values are sorted in ascending order.

2 To reverse the sort (ascending to descending), click the column heading again.

28

Page 29: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Selecting DataThe DIG Smart Client lets you select all or some of the data in a table.

Step

Action

1 With a results list displayed:

Click  the Select All button to select all available results displayed on the screen

~or~

Click on a cell and drag across a range of cells

Result: All the selected cells are highlighted.

Clearing Data SelectionsThe DIG Smart Client lets you de-select all of the data you previously highlighted in a table.

Step

Action

1 In the Results panel's toolbar, click the Select All menu's drop-down icon.

2 Choose the Select None option.

Result: All the highlighted items are de-selected.

Copying DataThe DIG Smart Client lets you copy data from the table and paste it into numerous formats, such as a text file, Microsoft Word document, and Microsoft Excel spreadsheet. This option allows you to select any data from the table quickly and put it in a format that best suits your needs.

If you copy the information you selected and pasted it into a Microsoft Word document, the data pastes into an unformatted table. Pasting the data into Excel will result in the information being pasted into individual cells, based on the original table's rows and columns.

To copy and paste data from a table:

Step

Action

1 Select the data you want to copy:

Click  the Select All button to select all available results displayed on the screen

~or~

Click on a cell and drag across a range of cells

Result: All the selected cells are highlighted.

2 Click the Copy to Clipboard button.

3 Open the program you wish to copy the data to.

4 Use Ctrl + V or right-click and select Paste to paste the data into the space provided.

29

Page 30: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Result: The data appears in the proper format, separated into easy to read columns and rows.

Sending Data to the Batch QueryOnce you have selected one or more values in a results table, you can invoke a Batch Query based on those values.

To send values to the Batch Query:

Step

Action

1 Select the data you want to search:

Click  the Select All button to select all available results displayed on the screen

~or~

Click on a cell and drag across a range of cells

Result: All the selected cells are highlighted.

2 Click the Copy to Batch Query button.

3 Continue with step 3 of Searching from a Results List.

Exporting DataThe DIG Smart Client lets you export your search results to a number of formats:

XML

Comma Separated Values (CSV)

You can also simply copy the data you want and paste it into another application.

Before attempting to export data, you must select the information you want to export. When no items are selected, the Export menu is disabled.

Selecting Data to ExportYou must select the data you want to export. All of the data must reside in the same results list.

To select data for exporting:

Step

Action

1 Display a result list.

Execute a search and display its Results.

~or~

Click the Results icon to display results from previous searches.

2 If necessary, select a data source from the list.

3 Select the data you wish to export:

30

Page 31: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

To select Do this

All of the data in the results list

Click the Select All button.

The values in a group of cells

Click in a cell and drag to select the cells

A single row Click on the row selector (the box to the left of each row)

Multiple rows Click on a row selector and drag to select consecutive rows

~or~

Hold down the Ctrl key and click on row selectors to select non-consecutive rows

Tip: To copy the selected data into another application, simply click the Copy to Clipboard button and then use the application's paste command.

Exporting to XMLTo export your search results to an XML document, select the records and use the following procedure.

Step

Action

1 From the Export to... menu, choose XML .

Result: A browser window opens to display the XML file .

2 Use the browser's Save As command to save the XML file locally.

Exporting as a Comma Separated Value (CSV)To export your search results as a CSV document, select the records and use the following procedure.

Step

Action

1 From the Export to... menu, choose CSV .

Result: A Save As window appears.

2 Use the browser's Save As command to save the CSV  file locally.

3 Export is complete. Click the OK  button.

An Alert notification informs users of additions made to specific data sources. An e-mail message is sent to the designated user whenever the Alert criteria matches these changes. This feature tracks new data using a well-organized, easy-to-use interface.

31

Page 32: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

The DIG Smart Client's Alert feature lets you create as many notifications as you need. You can set the priority, expiration date, and notification parameters for each Alert you create.

Creating an Alert

Alerts are created from previous searches stored in your History or Favorites List.

To create an Alert:Step

Action

1 Once you have executed a search you'd like to make an Alert:

In the Main Toolbar, click the Query icon.

~or~

In the Main Toolbar, click the Alerts icon.

Both of these options give you access to your History and Favorites lists, on the bottom, right side of the window.

2 Click on the History or Favorites tab.

3 Click to select the appropriate search criteria from the History or Favorites list.

4Click the   Add button to add the search criteria to the Alerts area.

Result: The Alerts area populates with the search information in the Alert Criteria box. This information cannot be modified.

5 If desired, change the name for the Alert in the Friendly Name field.

By default, this field will populate with the first 10 characters of the search criteria.

6 Select an expiration date from the calendar provided in the Expires on this Date field.

7 Enter any comments in the Notes field.

8 Enter a valid e-mail address in the Email Notification field.

Note:  This field will auto-populate if any email addresses have been previously entered in this field, for either the current Alert or another Alert saved on the DIG Server.

9Click the button to add the email address to the Email Notification list.

If you want to delete an email address, click on the button.

10 Click on the Priority drop-down menu to change the alert priority status.

All High priority items will be queried first, followed by Normal and Low alerts.

Note: The default is set to High priority.

11 Click on the Notification Timing drop-down menu to change the Alert notification frequency.

Immediately - Notifies the user as soon as changes made to the specified data source(s)

32

Page 33: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

and matching the Alert criteria are saved.

Once a day - Notifies the user daily if changes made to the specified data source(s) match the Alert criteria.

Once a week - Notifies the user weekly if changes made to the specified data source(s) match the Alert criteria.

Note: The default is set to immediately notify the appropriate users via e-mail.

12 Click the Save button to save the Alert.

Working with AlertsThe DIG Smart Client lets you edit, delete, or refresh an existing Alert.

Editing an AlertTo edit an Alert:

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Click on the Alert you wish to edit from the My Alerts tree, located on the left side of the Alert area.

Note: If you do not see the Alert you wish to edit, you may need to expand any additional folders that exist in your My Alerts tree.

Result: The Alert information is populated.  

3 Make any necessary changes to the Alert.

Note:  You cannot make changes to the Alert name or the original Alert criteria. If you wish to change either of these fields, you must delete the current alert and create a new one.

4 Click the Save button to save any changes.

Deleting AlertsTo delete an alert:

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Click on the Alert you wish to delete from the My Alerts tree, located on the left side of the Alert area.

Note: If you do not see the Alert you wish to delete, you may need to expand any additional folders that exist in your My Alerts tree.

Result: The Alert information is populated.  

33

Page 34: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

3 Click on the Delete button.

Result: Depending on your settings, a delete confirmation message may appear.

4 If the delete confirmation message appears, click Yes to delete the alert.

Result: The alert is removed from the Alert window.

Changing your Delete Confirmation PropertiesThe DIG Smart Client lets you change your settings so that the delete confirmation message does not appear when you delete an Alert or Alert category folder. If you disable this option, the Alert or folder will automatically be removed from your My Alerts tree as soon as you click on the Delete button.

To change your delete confirmation message settings:

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Click on the Delete drop-down icon.

3 Click on the Confirm Deletions option.

If the icon is highlighted in orange, a delete confirmation message appears when you try to delete an Alert. Otherwise, the message will not be displayed.

Refreshing Alert InformationWhile making changes or adding information to an Alert, you can refresh the alert to see your updated Alert in real time before you save it.  

To do so, click on the Refresh button.

E-mail NotificationsTo add an e-mail address to a specific alert:

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Click on the Alert you wish to add the e-mail address to by selecting it from the My Alerts tree, located on the left side of the Alert area.

Note: If you do not see the alert you want to change, you may need to expand any additional folders that exist in your My Alerts tree.

Result: The Alert information is populated.  

3 Enter the e-mail address in the Email Notification text box.

Note:  This field will auto-populate if any e-mail addresses have been previously entered in this field, for either the current Alert or another Alert saved on the DIG Server.

34

Page 35: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

4Click the button to add the e-mail address to the Email Notification list.

5 Click the Save button to save the Alert.

To delete an e-mail address for a specific alert:

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Click on the Alert you wish to delete the e-mail address from by selecting it from the My Alerts tree, located on the left side of the Alert area.

Note: If you do not see the alert you wish to change, you may need to expand any additional folders that exist in your My Alerts tree.

Result: The Alert information is populated.  

3 Click on the e-mail address you want to delete from the Email Notification list.

4Click on the button.

5 Click the Save button to save the Alert.

Grouping AlertsAlerts can be grouped together in folders created by users. Grouping Alerts can be beneficial for separating Alerts created by multiple users accessing the same DIG Server.

Adding a CategoryTo add a new Alert category:

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Click the Add Category button to add a new category.

3 Add a category name to the new folder.

Organizing AlertsOnce a new folder has been created, you can organize your Alerts for easy access and mobility. If your Alerts are grouped, you can delete them as a whole instead of individually.

To move Alerts under a category:

35

Page 36: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Select an existing alert and drag and drop it onto the appropriate folder.

Result: The Alert appears under the selected folder.

Deleting an Alert FolderTo delete a folder containing one or more Alerts:

Step

Action

1In the Main Toolbar, click the   Alerts icon.

Result: The Alerts area appears.

2 Select the Alert you wish to delete.

3 Click on the Delete button.

Result: Depending on your settings, a delete confirmation message may appear.

4 If the delete confirmation message appears, click Yes to delete the Alert.

Result: The Alert is removed from the Alert window.

Note: See Changing your Delete Confirmation Properties for information on how to turn on and off the delete confirmation message.

36

Page 37: test 5.x User Manual.doc · Web viewThe DIG Smart Client makes it easy to view more than one data source for your search without having to re-query the DIG Server. You can select

THIS PAGE INTENTIONALLY LEFT BLANK

37