Help on Query Manager

DESCRIPTION:

The query manager window allows you to work with predefined queries from a central location.  In the query manager window, there is a listing of these predefined queries.  A number next to each query name in the list indicates the number of documents retrieved for the query during the current session.  If you are running TOPIC REAL-TIME, the retrieved indicator increases as newly-arrived documents are retrieved for the query.

The queries that appear in the query manager window typically are selected by your TOPIC database administrator and controlled by an entry in your preferences file.  The query manager window can list both profile queries, which are queries processed by the TOPIC REAL-TIME Central Profiler or the TOPIC Batch Profiler, and local queries, which are queries created from the user's desktop such as simple, form, and topic queries.     

To scroll this window to see more text, use the scrollbar.

To close this window, use the same procedure used to close a window in your graphical user interface.

OPENING A QUERY WINDOW:

To open a query window for a query listed in the query manager window, position the pointer over the desired query, then double-click with the mouse button.  The selected query is displayed within a query window, which can be scrolled up or down.  You can open a query window for each query listed in the query manager window by double-clicking on each query. 

You will notice that when you open the query manager window for the first time during a TOPIC session, the icons next to the query names listed in the window are filled.  Once you open a query window for a query, the icon becomes empty until new documents are retrieved for the query.  Thus, the icon next to a query named in a query manager window indicates whether newly-retrieved documents are ready for viewing.
 
USING A QUERY WINDOW:

Each query window consists of two panes.  The upper pane is used to display the query definition, in the case of a simple, form, or topic query, or the query name, in the case of a profile query.  The lower pane contains the Results List, which displays a list of retrieved documents associated with the query.  A slider bar is used to separate the two panes of the query window, and can be dragged up and down to expose more of the upper or lower pane, as needed. 

When you open a query from the query manager, TOPIC displays the retrieval results for the query.  If the query opened is a profile query, TOPIC displays the results as they become available from the TOPIC Central Profiler or the TOPIC Batch Profiler.  If the query is a local query and you are running TOPIC REAL-TIME, TOPIC displays the results as they become available. 

For a local query (i.e. simple, form, or topic query), you can alter the query definition by entering text in the simple query edit box, form query template, or the topic query editor, as appropriate.  For a profile query, the query definition, known as a profile, is defined by your TOPIC database administrator and it cannot be maintained from within the profile query window. 

The next few sections describe these activities you can perform using a query window:  merging results, viewing results, sorting results, deleting a document, saving a local query (note that you cannot save a profile query).

MERGING RESULTS:
If you select the Auto-merge Partitioned Retrievals option for your query, TOPICautomatically merges partitioned retrievals as they become available.  If this query option is not selected for your query, you must merge partitioned retrievals on demand as they become available.  To merge partitioned retrievals on demand, you can click on the Merge button, or you can select the "Merge Results" option from the Query menu.

For more information on using query options and merging partitioned retrievals, refer to the TOPIC User's Guide for your retrieval client.

VIEWING RESULTS:
To view a retrieved document which appears in the Results List, position the pointer over the desired document, then double-click with the mouse button.  The document is then displayed within a document window, which can be scrolled up or down.  You can display several documents at a time in separate document windows by double-clicking on each desired document.

SORTING RESULTS:
When your retrieved documents appear in the Results List, usually they are ranked by their score (their relevance to your query definition).  The ranking appears in descending sequence, meaning that the retrieved documents which are most relevant to your query definition appear at the top of the list, and those which are less relevant appear farther down the list.  The score appears as a numeric field, and is included with each retrieved document.

You can specify that your retrieved documents are sorted against a field other than the score field.  To specify another sorting order, select the "Sort" option from the View menu to display the Sort dialog box.  The Sort dialog box lists the current sort order by field in the Available Fields list.  To change the sort order in effect, click on a listed field to select it, then move it to the Sort By list.  You can also change the sort order from descending sequence to ascending sequence.  

To store your preferred sort order for a query's future retrievals, click on the OK button in the Sort dialog box.  To re-sort the retrieval results and store the preferred sort order for a query's future retrievals, click on the Re-sort button. 

DELETING A DOCUMENT:
As you review documents in the Results List after performing a retrieval, you may want to selectively remove some from the Results List to make it more manageable.  TOPIC provides two options for deleting documents:  Clear and Delete.  These options perform two different functions, as described below.

Clear: The "Clear" option is used to clear one or more documents from the Results List.  When documents are cleared, they will not appear again for the query you are currently using, but they remain in the TOPIC database so they can be searched over using another query definition.   To clear a document, click on the desired document in the Results List to highlight it, then select the "Clear" option from the File menu.

Delete:  The "Delete" option is used to delete one or more documents from the Results List as well as from your TOPIC database.  When documents are deleted, they will not be included in retrieval results for any other query definition.  Note that when you delete a document, it cannot be viewed by any other TOPIC user.  To delete a document, click on the desired document in the Results List to highlight it, then select the "Delete" option in the Edit menu.

SAVING A LOCAL QUERY:
To save a local query for future use, select the "Save Query" option of the File menu.  The query is saved using the name that appears in the upper portion of the query window, and is automatically appended with a .qry suffix.

TOPIC assumes that you want to save the revised query under the same name, and will overwrite the existing query.  To save a revised query under another name, use the "Save As ..." option of the File menu, then complete the information specified within the dialog box.