FAST InStream BMCP User Guide 4ftpdocs.broadcom.com/cadocs/0/g015231e.pdfFAST Sentimeter, FAST Scope...

FAST InStreamversion 4.3BMCP User Guide

Document Number: INS1045, Document Revision: A, May 5, 2006

Copyright© 1997-2006 Fast Search & Transfer ASA (“FAST”). Some portions may be copyrighted by FAST’s licensors. All rights reserved. The documentation is protected by the copyright laws of Norway, the United States, and other countries and international treaties. No copyright notices may be removed from the documentation. No part of this document may be reproduced, modified, copied, stored in a retrieval system, or transmitted in any form or any means, electronic or mechanical, including photocopying and recording, for any purpose other than the purchaser’s use, without the written permission of FAST. Information in this documentation is subject to change without notice. The software described in this document is furnished under a license agreement and may be used only in accordance with the terms of the agreement.

TrademarksFAST ESP, the FAST logos, FAST mSearch, FAST InStream, FAST AdVisor, FAST Marketrac, FAST ProPublish, FAST Sentimeter, FAST Scope Search, FAST Live Analytics, FAST Contextual Insight, FAST Dynamic Merchan-dising, FAST SDA, FAST MetaWeb, FAST InPerspective, GetSmart, NXT, LivePublish, Folio, and other FAST product names contained herein are either registered trademarks or trademarks of Fast Search & Transfer ASA in Norway, the United States and/or other countries. All rights reserved. This documentation is published in the United States and/or other countries.

Sun, Sun Microsystems, the Sun Logo, all SPARC trademarks, Java, and Solaris are trademarks or registered trade-marks of Sun Microsystems, Inc. in the United States and other countries.

Netscape is a registered trademark of Netscape Communications Corporation in the United States and other coun-tries.

Microsoft, Windows, Visual Basic, and Internet Explorer are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Red Hat is a registered trademark of Red Hat, Inc.

UNIX is a registered trademark of The Open Group in the United States and other countries

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

AIX and IBM Classes for Unicode are registered trademarks or trademarks of International Business Machines Corporation in the United States, other countries, or both.

HP and the names of HP products referenced herein are either registered trademarks or service marks, or trade¬marks or service marks, of Hewlett-Packard Company in the United States and/or other countries.

Remedy is a registered trademark, and Magic is a trademark, of BMC Software, Inc. in the United States and/or other countries.

XML Parser is a trademark of The Apache Software Foundation.

All other company, product, and service names are the property of their respective holders and may be registered trademarks or trademarks in the United States and/or other countries.

Restricted Rights LegendThe documentation and accompanying software are provided to the U.S. government in a transaction subject to the Federal Acquisition Regulations with Restricted Rights. Use, duplication, or disclosure of the documentation and software by the government is subject to restrictions as set forth in FAR 52.227-19 Commercial Computer Soft-ware-Restricted Rights (June 1987).

Contents

FAST Support......................................................................................v

About this Guide................................................................................ vii

Chapter 1 Introducing the BMCP 1The BMCP and its Individual Areas.....................................................2

User Management..........................................................................3Rank Tuning (optional) ...................................................................3Query Reporting .............................................................................3

Accessing the BMCP...........................................................................4

Chapter 2 Preparing the BMCP for the Business User 5Determining the URL to the BMCP......................................................6Logging into the BMCP for the First Time ...........................................6

Overview ........................................................................................6Important Note................................................................................6Creating the Root User...................................................................7Editing the Root User .....................................................................8

Chapter 3 User Management 11User Management Main Screen........................................................12Creating Users...................................................................................14Creating Groups ................................................................................19

Chapter 4 Rank Tuning 25Licensing Issues................................................................................26

Important Note..............................................................................26

iii

FAST InStream

Terms to Know .................................................................................. 28Basic Concepts of Rank Tuning........................................................ 30

Relevancy Types ......................................................................... 30Rank Adjustment Mechanism Types ........................................... 30

Create Saved Query............................................................... 31Create Document Boost ......................................................... 31

Guidelines for Overriding Rank Boosting Mechanisms ............... 32Create Query Boost................................................................ 32Time required for any boost to take effect .............................. 32

The Rank Tuning Methods Provided by the BMCP ..................... 32 Create Saved Query ....................................................................... 33Managing Saved Queries ................................................................. 41Creating & Editing Document Boosts................................................ 45Direct Input........................................................................................ 53

Chapter 5 Query Reporting 59Basic Concepts of Query Reporting.................................................. 60

Available Data Views: .................................................................. 60Core Features:............................................................................. 60Available Report Time Periods: ................................................... 61

Using the BMCP Reporting Feature ................................................. 62

Index 65

iv

FAST Support

WebsitePlease visit us at:

http://www.fastsearch.com/

Contacting FASTFast Search & Transfer, Inc.Cutler Lake Corporate Center117 Kendrick Street, Suite 100Needham, MA 02492 USA Tel: +1 (781) 304-2400 (8:30am - 5:30pm EST)Fax: +1 (781) 304-2410

Technical Support and Licensing ProceduresTechnical Support for customers with active FAST Maintenance and Support agreements,

E-mail: [email protected] obtaining FAST licenses or software, contact your FAST Account Manager or

E-mail: [email protected] evaluations, contact your FAST Sales Representative or FAST Sales Engineer.

Product TrainingE-mail: [email protected]

SalesE-mail: [email protected]

v

mailto:[email protected]




FAST InStream

vi

About this Guide

Purpose of this GuideThis guide describes how to manage the Business Manager’s Control Panel (BMCP) for FAST InStream.

AudienceThis guide provides information for:

Business ManagersFAST InStream Administrators

ConventionsThis guide uses the following textual conventions:

Terminal output, contents of plaintext ASCII files will be represented using the following format:Answer yes to place the node in the known_hosts file.

Terminal input from operators will be in the same but bold format:chmod 755 $HOME

Input of some logic meaning, will be enclosed in <> brackets:setup_<OS>.tar.gzwhere <OS> represents a specific operating system that must be entered. URL’s, directory paths, commands and the names of files, tags, and fields in paragraphs appear in the following format:The default home directory is the C:\DataSearch directory.User Interface page/window texts, buttons, and lists appear in the following format:Click Next and the License Agreement screen is displayed.

$FASTSEARCH (UNIX) or %FASTSEARCH% (Windows) refer to an environment variable set to the directory where FAST InStream is installed.

vii

FAST InStream

viii

Chapter 1

Introducing the BMCPAbout this ChapterThis chapter introduces you to the Business Manager’s Control Panel referred to as the BMCP.

It includes:

The BMCP and its Individual AreasAccessing the BMCP

FAST InStream

The BMCP and its Individual AreasThe Business Manager's Control Panel (BMCP) is a tool that allows you to control the ranking of individual documents in your FAST InStream installation, and to monitor your end-users' query behavior. In addition, it allows you to manage user accounts for access rights to the individual parts of the BMCP.

The following screen shows the BMCP main page. It consists of the following links:

Home - This link enables the user to return to this main page from anywhere in the BMCP Administration GUI.Rank Tuning - This link takes you into the Rank Tuning features of the BMCP.Query Reporting - This link takes you into the Query Reporting features of the BMCP.User Management- This link takes you into the User Management features of the BMCP.

2

BMCP User Guide - Introducing the BMCP

User ManagementThe User Management area of the BMCP allows you to manage user accounts associated with access rights to the individual parts of the BMCP.

For details see Chapter 3 User Management.

Rank Tuning (optional) The rank tuning screen allows you to control the rank order of documents in a result set. Rank tuning consists of query boosts and document boosts.

This section explains the basic concepts of relevancy and rank adjusting, the basic ranking mechanisms applied in FAST InStream and the possibilities you have to change the ranking behavior of individual documents. It also describes the query reporting feature and what its capabilities are.

For details see Chapter 4 Rank Tuning.

Query ReportingThe query reporting screen allows you to track the frequency of which queries are being searched on.

Choose between different time periods.Each period keeps track of all the top queries, top queries producing no hits and top referring IP- addresses.

For details see Chapter 5 Query Reporting.

3

FAST InStream

Accessing the BMCPYou can access the BMCP through your standard Web browser. Ask your system adminis-trator for the correct URL.You will be prompted for a user name and password. If you do not have any username and password yet, ask your system administrator to provide you with a user name and pass-word.

Note! If you are a system administrator and are logging into the BMCP for the first time, refer to Chapter 2 Preparing the BMCP for the Business User.

4

Chapter 2

Preparing the BMCP for the Business UserAbout this ChapterThis chapter describes what a system administrator needs to do to set up the BMCP so that it is available for business users.

It includes:

Determining the URL to the BMCPLogging into the BMCP for the First Time

FAST InStream

Determining the URL to the BMCPThe URL from which the BMCP is accessible has the following structure:

<basic URL of your FAST InStream installation>:<baseport of your FAST InStream installation + 3089>/bmcp

Note! Both basic URL and baseport for your FAST InStream installation are specified during the installation process.

For example:

If the basic URL of your FAST InStream installation is

http://mydatasearch.mydomain

and the baseport is 23000, then the BMCP URL is

http://mydatasearch.mydomain:26089/bmcp

Logging into the BMCP for the First Time

OverviewWhen you log into the BMCP for the first time, you need to log in with the already estab-lished user name root and an empty string as a password.

It is recommended and you will be reminded that it is important to change the password after your first log in to protect the root account against abuse. You do this by editing the root user in the User Management section of the BMCP.

Important NoteTo ensure that all tabs of the BMCP can be used and seen on each individual’s terminal the screen settings must be set to a minimum of 1024 x 768.

6

BMCP User Guide - Preparing the BMCP for the Business User

Creating the Root UserWhen you log into the BMCP for the first time, the Edit Root User password screen will display. While this is a one time setup screen, meaning that this screen will display with the first use of the BMCP, the Root User can be edited at any time by choosing Adminis-trator on the Users Screen seen under the heading Editing the Root User, seen below.

7

FAST InStream

Editing the Root UserThe following section describes how to set up the root user for managing the system. This user cannot be deleted and will have access to all users, groups, collections and roles. While this is a one time setup screen occurring only at start up, the root user can be edited at any time by choosing Administrator on the Users Screen seen below.

Clicking on Administrator will display the following screen.

8

BMCP User Guide - Preparing the BMCP for the Business User

1 Enter a new password for the User ID root and confirm the password.

Note! The password must not match the Display Name or the User ID. It also must be longer than four characters and can be alphanumeric.

Note! You cannot change access levels for the Root User in those boxes marked with a lock.

2 Select the Save Changes button.3 Your changes are confirmed with the following Confirmation screen.

9

FAST InStream

4 You are now set up as the Administrator for the BMCP.

10

Chapter 3

User ManagementAbout this ChapterThis chapter explains the basic concepts of user management and the options provided by the user management part of the BMCP.It includes:

User Management Main ScreenCreating UsersCreating Groups

Desired WorkflowCreate all Users firstCreate the Groups for assigning access to collections

FAST InStream

User Management Main ScreenThe following screen is the User’s or the User Management Main Screen.

12

BMCP User Guide - User Management

From this screen you are able to create or delete users. The pull-down tab at the top right, next to View allows you to switch screens to either Users, Groups, Collections, or Roles.

Users - This screen lists the available users and the Roles and Groups that they are associated with. You are also able to create/edit/delete Users from this screen.Groups - This screen lists the available groups and the users and collections associated with them. You are also able to create/edit/delete Groups from this screen. Groups are useful if you want multiple users to have access to different collections without creating a user for each collection.Collections - This screen lists the collections available to the User that is currently logged on. If a user does not have rights to a collection, then the collection will not be visible.Roles - There are four different types of Roles in the User Management section of the BMCP. They are:

Admin - Has Administrator privileges over the BMCP.Rank Tuning - Has the right to perform any tasks associated with the Rank Tuning section of the BMCP.Reporting - Has the right to perform any tasks associated with the Reporting section of the BMCP.UserManagement - Has the right to perform any tasks associated with the User Management section of the BMCP.

13

FAST InStream

Creating UsersUse the following procedure to create users for the BMCP.1 Confirm that the pull-down tab on the right hand side of the screen displays the word

Users. 2 Click on the Create User button in the lower right.

14


3 The following Create Users screen appears. Enter the necessary user information in the area provided. Also choose which Roles and Groups you want this user to perform. Click the Save Changes button upon completion.

Note! The password must not match the Display Name nor the User ID. The password must be a minimum of four characters and can be alphanumeric.

Note! If, for any reason the password is considered invalid, the following error message will display.

15

FAST InStream

16


4 The following confirmation screen will appear, confirming the user just created along with their respective Roles and Groups, if any.

5 You will be taken to the Users screen. Here you will note that the User ID EricC was created.

17

FAST InStream

6 You can continue adding all the desired users to the system. You may also edit existing users by clicking on their User Name.

7 At any time an individual user can change their own password. Enter a new password for the User ID root and confirm the password.

8 User Names or User Ids can be resorted by clicking on the links at the top.

Note! An Administrator or a User Manager can edit all the user’s passwords.Therefore, if a regular user forget his/her password it can be reset by contacting the Administrator or a User Manager.

Note! An Administrator can reset all passwords.

Note! A User Manager can reset all passwords but the Administrator’s password.

18


Creating GroupsThe following procedure describes how to add users to groups in the system.1 Select Groups from the View: pull-down menu, located at the top left of the screen.

The following screen appears. Click on the Create Group button.

19

FAST InStream

2 The following Create Group screen appears. 3 From the Group Owner IDs, pull-down menu, select a group owner for the new

group. Click on the owner of choice.

All users can be selected to own a group. They must be in an Administrative role or User Management Role to promote a group owner for a group. If a user is a group owner he/she has special rights, they can Add/Remove users from their group and they can Add/Remove collections from their group.

4 Next, select the users you want as part of the group and the collections that you want this group to have access to. Click on the User(s) of choice and click Add. Click on the Collection(s) of choice and click Add. When you are done with your selection click on Save Changes. If you click on Cancel, you will return to the Group Overview screen.

20


21

FAST InStream

5 The following Saved Group confirmation screen will appear.

6 The screen will refresh and return you to the User Management Groups screen.

22


7 You can continue adding all the desired groups and the collections to your system. You may also edit existing groups by clicking on their group name.

23

FAST InStream

24

Chapter 4

Rank TuningAbout this Chapter

This chapter explains the basic concepts of relevancy and rank adjusting, the basic ranking mechanisms applied to FAST InStream and the possibilities you have to change the ranking behavior of individual documents using the Rank Tuning part of the BMCP.

It includes:Licensing IssuesBasic Concepts of Rank TuningCreate Saved QueryManaging Saved QueriesCreating & Editing Document BoostsDirect Input

FAST InStream

Licensing Issues

Important NoteA valid Rank Tuning License Property File is required if the Rank Tuning application is to be used on your installation. By clicking on Rank Tuning from any location within the BMCP, the following License screen will display if your current license is not valid. 1 From the Home page select the Rank Tuning link.

26

BMCP User Guide - Rank Tuning

The following License screen will display if your current license is not valid.

When you receive your license for the Rank Tuning installation you will need to place the license in

$FASTSEARCH/j2ee/server/vespa/conf$/ranktuninglicense.properties.

An example license is:

winnie@cheerio6:/ld/work/detroit/datasearch/j2ee/server/vespa/conf$ more ranktuninglicense.properties ranktuning.license=li00lk0abcykk3ppg47Gzu812

(for example)

27

FAST InStream

Terms to Know Boost Points - - A value added to a document that increases relevancy relative to other documents returned in a set of search results. The create query boost, manage query boost and create document boost helps you to create and manage boost points in a search result set.

Create Saved Query - A way to add a dedicated result set to a specific query. You can determine which order the documents are going to be displayed, within the search result set. It's also possible to block a document from a specific query. The blocked document will not appear in the search result set for this specified query.

Manage Saved Queries - A Managed Query contains a query string and at least one doc-ument that is in the Top Ten List or has Query Boost Points added to it. Once the query is created, you can add, delete or block documents to this query.

Top Ten List - - A set of documents that can be positioned in one of ten reserved places that will be returned at the top of the results list. The Top Ten List appears only in Query boost, not in Document boost. The document set is connected to one specific query.

Create & Edit Document Boosts - Adding Document Boost Points to a document will boost that document for all queries. These points are always active for any query. It is also possible to add negative boost points to a document.

Natural Rank - - The natural rank for a document is determined by various factors (key-words, title, body, etc.). The natural rank is a number that is generated on the various factors of the search without any influence. Depending on the relevance of your query against the search, a result set is returned in order of highest ranking first. This is where a document will be positioned in the result set based on it’s natural rank. By boosting or decreasing this natural rank, a user has the control to position a document where they desire in the result set.

Direct Input - This is a method allowing a user to create saved queries and add boosts to documents not necessarily in the searchable index. The Direct Input screen allows imme-diate entry of the URL or document ID along with either a Preset Boost or a Specific Boost Value. No searching takes places, the information is stored until needed.

Absolute Query Boost - Supposing you want a document always to be displayed at posi-tion 1 in the result list, when a user is searching with a specific query. Then you can specify a document-query-combination and assign a fixed absolute ranking position that the specified document is to get within the result list, whenever a user is searching with the specified query.

28


As the position of the document is always on top, but linked to a specific query, this rele-vancy boosting mechanism is called Absolute Query Boosting.

Relative Query Boost - Supposing you want to make it very likely that a document is displayed in the result list, but only when a user is searching for a specific query. For all other queries, the ranking position of the document shall not be impacted by any boost. Thus, you specifiy a document-query-combination and assign an amount of ranking points with which the document’s overall ranking value is to be increased whenever a user is searching with the specified query.

As the position of the document is to be relative to the position of other documents, but linked to a specific query, this relevancy boosting mechanism is called Relative Query Boosting.

29

FAST InStream

Basic Concepts of Rank Tuning

Relevancy TypesOverall ranking of values relies on two types of relevancy:

The absolute boost of the document relates to the fixed relevancy position the document has within its document group. It is based on numerical properties of the document that are independent of any query. Examples of such properties are priorities that the author of a document may have assigned to the document, the document’s modification date, or combinations of these. This relevancy value is called static because it forms a permanent attribute of the document.The relative boost of the document is based on the document’s rank value relative to the query. It is calculated based on the number of occurrences of words in the document relative to the whole document collection. The dynamic relevancy is further determined by what section of the document the match occurs in. The basis for this calculation is the splitting of the document text into different sections, logical areas of the text such as body or title, or meta-data about the text such as author or date.

Both the absolute boost and the relative boost of a document help to determine its ranking. Together, they form the final overall ranking value of a document for a specified search.

Rank Adjustment Mechanism Types When you search a group of documents using a search system like FAST InStream, the search most often returns many document hits. Looking for information, you want the most important document to be listed first. Which of the resulting documents is the most important with respect to your search is determined by its relevancy. The relevancy of a document in turn is expressed by its overall ranking value.

The BMCP allows you to override these ranking mechanisms for specified documents.

Possible mechanisms are:

Create Saved Query

Create Document Boost

30


Create Saved QuerySupposing you want to make it very likely that a document is displayed in the result list, but only when a user is searching for a specific query. For all other queries, the ranking position of the document shall not be impacted by any boost. Thus, you specify a docu-ment-query-combination and assign an amount of ranking points with which the docu-ment’s overall ranking value is to be increased whenever a user is searching with the specified query.

As the position of the document is to be relative to the position of other documents, but linked to a specific query, this relevancy adjustment mechanism is called Create Saved Query.

Create Saved Query has three methods associated with it:

Top TenAdd boost pointsBlock from query

Create Document Boost

Supposing you want to make sure that a certain document always displays among the first twenty documents in the result list, no matter which query a user is searching with. But you do not want to assign a fixed result list position to the document. Therefore, you specify that the overall ranking value of a document you want to be ranked higher be increased with a certain amount of ranking points.

As this way of promoting the document is relative to the positions of other documents in the query result list, but independent of any query, this relevancy adjustment mechanism is called Create Document Boost.

31

FAST InStream

Guidelines for Overriding Rank Boosting MechanismsWhen applying one of the rank boosting mechanisms described in the previous subsection, keep the following guidelines in mind:

Create Query BoostIf there is already a relative query boost applied to a certain query and you apply a new relative query boost to this query, this boost will replace the former relative boost.If there is already an absolute query boost applied to a certain query and you apply a new relative query boost to this query, this boost will replace the former absolute boost. That means, the document which is boosted for this query will lose its fixed position and be ranked relatively instead.

Time required for any boost to take effectNormally, a query boost will take effect in less than 15 minutes, but the exact latency will depend on variables such as query traffic, document size or machine load. A document boost may take longer.

The Rank Tuning Methods Provided by the BMCPThe Rank Tuning section of the BMCP gives you the ability to increase or decrease the rank value of an individual document or remove a document from the result set. By adding or decreasing boost points, you can influence the way a document is seen in a result. There are four methods associated with Rank Tuning.

Create Saved QueryManaging Saved Queries Creating & Editing Document Boosts Direct Input

These methods allow you to either create a saved query or document boost and manage these boosts after they are created.

The top of the Rank Tuning page displays your user name and information about the collection you are working on. You can log out and/or change the current collection (after choosing one collection) by using this menu.

32


Create Saved Query This Create Saved Query method allows you to increase, decrease or block the result set of a collection for the query that is being searched on. The three methods associated with Create Saved Query are:

Top Ten - This choice will enable you to include the desired document into a Top Ten list that regardless of ranking will always return in the top ten hits in a result list.Query Boost - This choice will enable you to add boost points to a document. The points when added to the document’s natural rank will determine where in a result list this document will be returned.Block - This choice will enable you to block a desired document. When blocked the document is not shown in the result set.

Use the following procedure to create a saved query.

1 From the Home page select the Rank Tuning link.

33

FAST InStream

2 The Choose Collection screen appears. Highlight the collection that you want to apply a query boost to and click the Use Collection button.

Note! By default the first collection is chosen. If you want to change the current collection, simply click on the collection name you want to work on.

34


3 The Collection Overview appears. This screen shows the Collection Statistics, Most Recent Changes and Actions pertaining to the collection. It also displays the last five deployed boosts and modified date. Select the Create Saved Query menu tab.

4 The Input Saved Query Text screen appears. As the steps are completed they are shown in the sidebar at the left. If needed, when you are done with a step, you can go back and edit it by clicking on the lines in side bar. Enter the query that you want to boost and click Search.

5 The following screen will appear if the selected query produces no results.

35

FAST InStream

36


6 The View Unmodified Result screen appears. Shown are all the document(s) applicable to the query that you entered. Associated to each document is a Natural Rank number. This is the order that a result set would be returned for the query you entered. Click the Next button.

7 The documents are now ready to be boosted. Edit the document rank by using one of the options below:

Add to Top Ten - This will add that document to the Top Ten list.Add Query Boost - This will enable you to add a numeral boost to a document. Ensure that the boost, when added to the Natural Rank of a document, is greater than the document you want this result placed in front of in the result set.Block from Query - This will block that particular document from appearing in the result set.

Choose the option you want to enact and click the Preview button.

37

FAST InStream

8 The Preview Boost screen will appear. Check to ensure that the ranking options you have applied are correct to this specific query. If you want to change some of your choices, do so, and click the preview button once more to ensure that your result set is displayed correctly. When you are satisfied, click the Save button.

Symbol explanation:

38


9 The Finished screen appears. Click the Collection Overview button to return to the collection screen or the Manage Saved Query button to manage one of your saved queries.

Caution! For the changes to take effect you must deploy them.

10 Select Collection Overview from the screen above. This will take you to the Collection Overview screen. Note that the Collection Statistics and Most Recent Changes may be altered. Click on the Deploy Now button and the changes will take affect.

39

FAST InStream

11 The Collection Overview screen displays once again with information after deployment, for example, # of boosts, deployed by whom or what user, and the date and the time of deployment. Clicking on Delete All deletes all the applied boosts. The user must press the Deploy Now button to delete all the boosts from the index.

40


Managing Saved QueriesThe Manage Saved Queries method allows you to delete or edit the rank of a saved query.1 The Manage Saved Queries screen is shown below. It contains information about the

last 5 recently created queries and the last 5 edited queries. If you click on one of the links, you will have the opportunity to delete the query rank attached to that query or add boosts to or block documents. You may also use the search feature on the sidebar. The sidebar gives you the choice to enter a saved query or search for it by starting with a specified string or containing the string entered. For this example we will click on the Query web.

41

FAST InStream

2 The boost for web appears in the Manage Saved Queries screen. Select the Delete Rank box next to the boosted query and click the Save button.

42


3 A confirm box will appear. Click on OK in order to confirm the change.

4 The Manage Saved Queries screen will appear. This completes using the Manage Saved Queries method to delete a rank boost.

5 You may now continue to manage another query boost or return to the main screen.

43

FAST InStream

6 The Manage Saved Queries screen will appear. This completes using the Manage Saved Queries method to delete a rank boost.

7 You can now continue to manage another query boost or return to the home screen.

44


Creating & Editing Document BoostsThis method allows a user to boost a document regardless of what query is entered into the search. 1 From the Choose Collection screen, choose the collection that you want to boost on

and click the Use collection button.

Note! By default the first collection is chosen. If you want to change the current collection, simply click on the collection name you want to work on.

45

FAST InStream

2 The Collection Overview screen will appear. Choose the Create & Edit Document Boosts link.

46


3 The Locate a Document to Add Boost screen will appear. As the steps are completed they are shown in the sidebar. If needed, when you are done with a step, you can go back and edit it by clicking links in the side bar. There are several ways to submit a document to be boosted.

Enter Search Term(s) - Use this box to search for a document by a particular search term.Enter Content ID - Use this box to search for a document by its URL.

Add your input into either box and click on Search.

47

FAST InStream

4 The Add Boost Points screen will appear. Choose the documents you wish to boost and either Add a Preset Boost, add a Specific Boost or Remove a Boost. Preset boosts are fixed values you can add as boost points and specific boosts are values that you specify within a range. Click on Save.

48


5 The Document Boost Saved screen will appearing confirming the document entered. Note that the informational bar on the left hand side also indicates that your steps are Finished. Click either the Collection Overview button to return to the Collection Overview screen or click the View & Edit button to review, edit or delete the boost just entered.

6 If you click on the View & Edit button, the following View & Edit, Sort by Document ID screen will appear. Clicking on Edit will take you to the document where you can, again, modify the boost. This screen will show all document boosts and their associated boost values. From the sidebar you can choose to sort the boosts by Document ID, Modified Date or Deployed Date. Clicking on Delete, deletes the

49

FAST InStream

boost from the assignment.

50


7 Once again the Document Boost Saved screen will appearing confirming the document entered and any change you might have made. From here you can choose to return to the Collection Overview screen or the View and Edit screen again.

51

FAST InStream

8 This completes the Create & Edit Document Boosts procedure. Click on the Overview link. The Collection Overview screen will appear.

Caution! Remember, for the changes to take effect you must deploy them.

52


Direct InputThis method allows a user to create saved queries and add boost to documents not neces-sarily in the searchable index. The boosts are added directly for one or more documents at once. 1 From any point where the Direct Input tab appears choose the Direct Input tab.

2 The Direct Input Document Boost screen will appear. Confirm that the drop down box on the right hand side shows Document Boost. If not, click on the drop down to show it. Enter a document ID and then a Preset Boost or you may enter a Specific Boost Value. The screen will present 5 lines for the unique addresses along with their individual Preset Boosts or Specific Boosts. Therefore you can enter more than one documents. If you require mores lines than presented, click on the box +Add More.

53

FAST InStream

3 Click on the Cancel button and user returns to the Collection Overview screen without any changes being saved.

54


4 If you enter a document ID for an indexed document, changes take effect by clicking deploy. If you enter a document ID not in the index, click Save Changes and the boost will be saved until the document is fed into FAST InStream. Until the changes are fed to a live system, only user’s of Rank Tuning BMCP will see the boost take effect.

5 The Collection Overview screen appears showing all the new documents that have been boosted.

55

FAST InStream

6 Method number 2, choose the Direct Input tab and from the right hand drop-down box choose Saved Query.

56


7 The Direct Input Saved Query screen will appear. Enter either an already saved query or you may create an entirely new query and then a New Document ID whether in or not in the index, along with the required boost value. If you enter a document ID not in the index, the boost is saved and will take effect when the document is fed into FAST InStream. The screen will present 5 lines for the unique saved queries along with the required boost values. If you require mores lines than presented, click on the box +Add More.

8 Click on the Cancel button and user returns to the Collection Overview screen.9 Click on the Save Changes button if you are ready to have the saved queries just

entered saved until they are deployed. Until the changes are deployed, only user’s of Rank Tuning BMCP will see the boost take effect.

57

FAST InStream

58

Chapter 5

Query ReportingAbout this ChapterThis chapter explains the basic concepts of query reporting and the options provided by the query reporting part of the BMCP.

It includes:

Basic Concepts of Query ReportingUsing the BMCP Reporting Feature

FAST InStream

Basic Concepts of Query ReportingThe BMCP Query Reporting allows you to monitor the total query volume and the fre-quency of individual query terms.

Available Data Views:There are two types of views:

Total Volume – Displays total volume for the period numerically and in graph form. Also details the top 10 queries in the viewed period and graphs their volume (in pie chart form) relative to each other.Top Queries – Displays up to the top 50 successful queries and up to the top X queries producing no results. If less than 50 queries exist for the given period, only those queries are displayed. Also displays up to the top 5 referring IP addresses.

Within these Data Views you can navigate to other time periods ranging from hourly reports up to annual reports.

The default view shows a version of the Total Volume view but displays an overview of the last 24-hours only.

Core Features:Query Content Oriented – The system displays up to 25 hit/no hit and 25 failed queries for a given time period in the Top Queries data view.Calendar Based Navigation – Users will be able to navigate to the day, week, month or year report views using the easily understood calendar navigation widget. Summarizing Graphs – show query volume trends and relative weight of top queries to total volume in a period.Clickable Volume Graphs – Drill down to selected sub periods in the Total Volume data view to get a more detailed report.Continuous Background Log Processing – The system processes and updates the digests at 10 minute intervals thus no user intervention is required to process query logs.

Note! In order to see the continual updates, refresh of the screen is required.

60

BMCP User Guide - Query Reporting

Available Report Time Periods:There are six available time report periods available. They are as follows:

HourlyDailyWeeklyMonthlyYearly

61

FAST InStream

Using the BMCP Reporting FeatureUse the following procedure to use the BMCP reporting feature.1 From the BMCP User Interface screen choose the Reporting menu tab or click on the

reporting picture.

2 The Reports screen appears. There are two menu tabs associated with this screen, Total Queries and Top Query Reports. By default the Total Queries screen is displayed.

62

BMCP User Guide - Query Reporting

3 The Total Queries screen lists information related to queries entered into the search. The sidebar enables the user to collect query information by choosing a calendar date. This date is displayed in the main screen. This screen has three main parts:

Total Daily Volume (this could be hourly, weekly, monthly, etc.) - This appears as a bar graph. The user is able to see the query volume in the amount of queries against the time period chosen. By putting the cursor on an individual graphic line, you can drill down with information. If applicable, the Total Hourly Volume is shown. An example is shown below.

Detailed Statistics - This shows detailed information about the queries entered for the specified time period. The following statistics are noted here:

Total Volume - Total number of queries submitted to the FAST InStream system.Total Unique Queries - Total number of unique queries submitted to the FAST InStream system.Maximum Volume - The maximum volume of queries within the specified time period.Average Volume - The average volume of queries within the specified time period.Minimum Volume - The minimum volume of queries within the specified time period.Futile Query Volume - Queries not giving any results (results=0).

63

FAST InStream

Futile Query Percent - Percent of total queries that give no results.

Top Queries -

This shows the query term and how many times it was searched for (maximum of ten top queries). It also gives the percentage that this query was searched for against the other top queries.

The user is then able to drill down on the Total Daily Volume graph down to the hour. The user also has the choice of using the arrow links to navigate through to the reports.

The Top Query Reports screen enables a user to keeps track of all the top queries, top failed queries and top referring IP- addresses. The user has the ability to navigate through the calendar on the side bar or through the arrow links to a desired date.

64

Index

BBasic Concepts of Query Reporting 60Basic Concepts of Rank Tuning

absolute boost 30relative boost 30

Boost Points 28terms to know 28

CChoose Collection

screen 34Collection Overview

screen 35Create Document Boost

description 31Create Query Boost

Add boost points 31Block from query 31description 31overridding 32Top Ten 31

Create Saved Query 33How to 33

Creating & Editing Document BoostsHow to 45

Creating Groups 19Creating the Root User 7Creating Users 14

How to 14

DData Views

Top Queries 60Total Volume 60

Detailed StatisticsAverage Volume 63Futile Query Percent 64Futile Query Volume 63Maximum Volume 63Minimum Volume 63Total Unique Queries 63Total Volume 63

EEditing the Root User 8

GGroup Owner IDs 20Guidelines for Overriding Rank Boosting Mechanisms 32

IImportant Note

screen size 1024 x 768 6Introducing the BMCP 1

LLicensing Issues 26Locate a Document to Add Boost

screen 47

65

FAST InStream

MMain Screen

Home 2Rank Tuning 2Reporting 2User Management 2

Ppassword information 15Preparing BMCP for the Business User 5

QQuery Reporting 3

Calendar Based Navigation 60Clickable Volume Graphs 60Continuous Background Log

Processing 60How to use 62Query Content Oriented 60Summarizing Graphs 60

RRank Tuning 25Rank Tuning Methods Provided by the BMCP 32Reports

screen 62

SScreen

Input Saved Query Text 35

TTime required for any boost to take effect 32Top Query Reports

screen 64Total Daily Volume

63

UUser Management 3, 11

Collections 13Groups 13Roles 13Users 13

66

FAST InStream BMCP User Guide 4ftpdocs.broadcom.com/cadocs/0/g015231e.pdfFAST Sentimeter, FAST Scope...

Documents

Transcript of FAST InStream BMCP User Guide 4ftpdocs.broadcom.com/cadocs/0/g015231e.pdfFAST Sentimeter, FAST Scope...