Installation & User Guide

Transcription

1 SharePoint Search String Highlighter Installation & User Guide

2 Copyright 2005 KWizCom LTD. All rights reserved. Company Headquarters P.O. Box #38514 North York, Ontario M2K 2Y5 Canada Web site: Sales Telephone: +1- (412)

3 Table of Contents Introduction... 4 Overview 5 Key Features & Benefits 6 What's new for MOSS/WSS 2007? 7 Installation... 8 Software prerequisites 8 Installation Procedure 8 Post Installation 9 Component Localization Component Activation User's Guide SharePoint Search String Highlighter Configuration Utility FAQ How do I use the SharePoint Search String Highlighter? 17 Does it work on SPS, WSS, both? 17 Does it work on the new MOSS 2007? 17 I searched for a word, and it is not highlighted 17 How do I get the words to be highlighted in the documents I go to from the search? 18 Ichangedsomesetingsusingtheconfigurationutility,butitdoesn t have any effect 18 I did something wrong and the Highlighter stopped working 18 Do I have to install anything on my company's client-pcs? 18 What happens with non-office 2003 documents? 19 Which MS Office versions are supported? 19 What about PDF documents? 19 Version Release Notes Version History 20 This Version's Known Issues/Limitations 20 Technical Support

4 Introduction KWizCom SharePoint Search String Highlighter is an add-on to Microsoft SharePoint that adds word highlighting to the default search page of the SharePoint portal (SPS 2003/MOSS 2007) and SharePoint team sites (WSS 2003/2007). When the user searches for a word, the string marker highlights the word in the search results if it is found in the result document sdescription. The String Highlighter also marks the words that were searched for inside documents of various formats:.doc,.rtf,.txt,.html,.pdf. This document provides all the information needed to install, evaluate and deploy this KWizCom product: Product overview Installation guide Component localization Component activation User guide FAQ Version release notes 4

5 Overview When a user searches for some string in SPS/WSS, the searched string is marked on the search results page: When the user clicks a document, it is opened with the searched phrase marked inside: 5

6 Key Features & Benefits Google -like highlighting, with bold font and yellow background. Provides for free-text searches, a more clear result page with highlighting of the searched phrase. Supports both SharePoint portal (SPS) and SharePoint Services (WSS) search. Installation required only on the SharePoint server (no installation required on client machines) Supports highlighting the searched words in document formats that can be displayed using Microsoft Word (.doc.rtf.txt.htm extensions) and.pdf format. Causes hyperlinks to word documents (or any other type that can be viewed with MS WORD) to open in Microsoft Word (instead of in Internet Explorer) Configuration utility allows the system administrator to change the behavior of key functions of the highlighter. 6

7 What's new for MOSS/WSS 2007? MOSS 2007 enhanced Search includes search results highlighting as displayed hereunder: The searched string is displayed in bold format by MOSS 2007 However, MOSS 2007 does not provide string highlighting inside documents. The new KWizCom Search String Highlighter version keeps providing the highlighting inside documents functionality both for WSS and MOSS

8 Installation Software prerequisites Server Requirements 1. Microsoft Office SharePoint Portal Server 2003 (SPS) + SP2 OR 2. Microsoft Windows SharePoint Services (WSS) + SP2 OR 3. WSS/MOSS 2007 Client PC Requirements 1. Microsoft Windows XP - SP2 OR 2. Microsoft Windows Vista 3. Microsoft Office SP1 OR 4. Microsoft Office Microsoft Internet Explorer 6+ SP1 OR 6. Microsoft Internet Explorer 7 Installation Procedure 1. Log in to your SharePoint server as a local admin. 2. Unzip the KWizCom SharePoint Search String Highlighter.zip file on your SPS Windows 2003 Server. 3. Double-click the.msi file in order to begin the web installation. 4. When the installation process is complete, you need to restart the IIS Server: Open the Command Prompt on your server. Type iisreset 8

9 Post Installation 1. After completion of the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing 4 programs: About SharePoint Search String Highlighter Display general information about the component. Activate SharePoint Search String Highlighter This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. SharePoint Search String Highlighter Configuration Utility this utility enables you (the SharePoint Administrator) configure the highlighter module preferences (please review details in the "User guide" section). SharePoint Search String Highlighter User Guide Link to this user guide document. Please review the next sections for further details about component localization and activation. 2. Before users can use the new offline feature added to your existing SharePoint sites, they will have to configure the following Internet Explorer settings: Empty Internet Explorer's cache. This is done by selecting "Tools->Internet Options" on the Internet Explorer menu bar. 9

10 Set the SharePoint server as a Trusted Site. This is done be selecting "Tools->Internet Options->Security", and adding the SharePoint server's URL to the Trusted sites list. On the "Internet Options" dialog click the "Delete Files" button, and then click "OK". Component Localization SharePoint Search String Highlighter is multi-lingual and requires no localization actions. It works on SharePoint Portal Server regardless of the portal's language. 10

11 Component Activation KWizCom components are available for evaluation prior to purchase. This way you can try our components and verify that they indeed meet your needs. An evaluation version for each KWizCom component contains all features of the component's production version. The only difference is that an evaluation version is time-limited, and will operate for a period of one month. Once you decide to order a KWizCom component, you will need to follow the following steps: 1. Order The component on the KWizCom website 2. Send us the installed evaluation version's product Code (you will see the product Code on the "About" product page: Product Code 11

12 Please use the Activation Request web form, on KWizCom web site to send us your product code. 3. Get the component activation key this key will be sent to you by once your order is processed. 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> Activate SharePoint Search String Highlighter Copy the received activation key into Activation Code text field, and press Activate Product button. That's it! Your product is fully operational. 12

13 User's Guide Well..there's nothing much really to explain. Once the component is installed, users will notice that when they search the SharePoint portal or a SharePoint team site, the search results page will appear a bit different, as in the following example: User searches for the word "kwizcom" The searched string is highlighted in the search results 13

14 User Clicks a document link. The searched string is also marked inside the document. 14

15 SharePoint Search String Highlighter Configuration Utility The configuration utility is a Windows Application that is installed on the SharePoint server as a part of the component installation. This utility allows you to change the Highlighter's behavior. Using this utility you can: Set the HTML code that is used to highlight (use this to change the color or background color of the highlight) Set the list of ignored characters. These characters will not be highlighted in the search results. It is not recommended to change the default setting. Set the list of file extensions whose links will be modified to be opened with Microsoft Word. This means that you can also cause the highlighter mark search results in non-office documents such as text files (.txt). 15

16 Set the minimum number of characters for a word to be highlighted. Define if highlighting should be done in the SharePoint search results page (You may not want it to be active on MOSS 2007, since MOSS 2007 already displays the searched string in bold format). Define if highlighting should be done inside documents. Set if errors in the application will be shown to user in message boxes. The administrator can choose not to show the errors, and enable this only to debug. 16

17 FAQ How do I use the SharePoint Search String Highlighter? Simply open your SharePoint portal search page and write some words to search for. The words you write will be highlighted in the search results. Does it work on SPS, WSS, both? SharePoint Search String Highlighter supports both SPS and WSS. Does it work on the new MOSS 2007? Yes. SharePoint Search String Highlighter supports both SharePoint 2003 and MOSS I searched for a word, and it is not highlighted 1. Make sure the word you searched for is more than 2 characters long. 2. Please note that special characters are ignored. If your query contained special characters such as! (for example) it may be the cause of the problem.tryrunningasimplersearch(forexample sharepoint or page )andverifythatthesharepointsearchstringhighlighterworks. 3. Try clearing your Microsoft Internet Explorer 6 cache. This is done by closing all instances (windows) of Microsoft Internet Explorer and then opening Control Panel>Internet Options and on the General tab presingthe DeleteFiles buton. 17

18 How do I get the words to be highlighted in the documents I go to from the search? The SharePoint Search String Highlighter supports highlighting the searched words in Microsoft Word documents opened from the search page. For this to work, you must have the portal registered as a safe site in the Internet Explorer options in the client machines. I changed some settings using the configurationutility,butitdoesn thaveany effect Try clearing your Microsoft Internet Explorer 6 cache. This is done by closing all instances (windows) of Microsoft Internet Explorer and then opening Control Panel>Internet Options and on the General tab pressing the DeleteFiles buton. I did something wrong and the Highlighter stopped working To reset the highlighter to its starting state, open the configuration utility (Start>Program>KWizCom> SharePoint Search String Highlighter> SharePoint Search String Highlighter Configuration Utility) and press ResettoDefaults Do I have to install anything on my company's client-pcs? No. KWizCom SharePoint Search String Highlighter is a server installation. Once you install it on your SharePoint server, all users can start using it. 18

19 What happens with non-office 2003 documents? The document marking is done using Office Word 2003 API. However, there are additional document types besides ".doc" that can be viewed using MS Word (for example:.rtf,.txt). So, for the SharePoint Search String Highlighter to mark non-ms Office files you should define these types in the configuration utility. Which MS Office versions are supported? Office 2003 and Office What about PDF documents?.pdf files are also supported. When you click a.pdf file from the search results page, it'll be opened in Search format, showing all searched phrase occurrences. 19

20 Version Release Notes Primary Software Version Base version Release date November Sub-Modules Module Version Configuration Utility Version History CR # Description Add support for MOSS Cancel the 15 days expired message Fix bug: User doesn't see highlighting when he has the white default highlight color in MS word. Now when the user open the word he has yelow highlight color as default Fix bug: Sometimes there's a Javascript code load error in run time Fix Bug: Resolve ATL install problem Support highlighting in WSS search results page Support.PDF files This Version's Known Issues/Limitations CR # Description Writing the combination closing parenthesis + space + closing parenthesis will stop the application from recognizing any words after that combination. For example, searching for helo))world will only highlighttheword helo andnottheword world Some special characters cause the highlighter not to function properly. It is recommended that you do not change the settings in the configuration utility and you should avoid using either of the following characters:!@#$%^&*()-=_+{}[]:; <>,.?/in your search query. 20

21 Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at contains the most updated valuable information, including: Answers to frequently asked questions (FAQ's) about our products usability and technical questions. Product updates, which provide you with bug fixes and new features. The Web Form For technical support through the Internet, please fill in our support web form on our web site For more information on technical support, please review our support programs page. 21