Index Server Search Plug-in Alterian Content Manager Corporate Edition 6.3 1 November 2010 www.alterian.com Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor or its representatives. Copyright © Alterian. All rights reserved. Documentation feedback and comments: [email protected] Alterian Content Manager and the Alterian Content Manager logo are trademarks of Alterian. Windows XP, SQL Server, ASP.NET, Visual Studio .NET and C# are trademarks of Microsoft Corporation. All other products named herein may be trademarks of their respective manufacturers and are hereby recognized. Trademarked names are used editorially, to the benefit of the trademark owner, with no intent to infringe on the trademark. www.alterian.com Document Control The following table details the revision history of this Installation and User Guide. It details significant changes to the text and the software version to which the changes apply. Version History Date Author Version Change reference November 10 Jordanka Balkanska 6.3 Initial Release Distribution List Who Position Jordanka Balkanska Technical Author Index Server Search Plug-in i of iii Table of Contents 1 Introduction ............................................................................................ 1 1.1 Overview ........................................................................................................................ 1 1.1.1 Sample Output 1 1.1.2 Query Syntax and Filtering 2 1.2 Known Issues .................................................................................................................. 2 2 Compatibility .......................................................................................... 3 2.1 Windows Server Compatibility ..................................................................................... 3 2.2 Multi-Language Compatibility ...................................................................................... 3 3 Installation .............................................................................................. 4 3.1 Pre-requisites ................................................................................................................. 4 3.2 Installation Overview ..................................................................................................... 4 3.3 Step 1 – Configuration of Website Folders .................................................................. 5 3.3.1 Overview 5 3.3.2 Configuration 5 3.4 Step 2 - Configuration of Windows Indexing Service ................................................. 5 3.4.1 Overview 5 3.4.2 Configuration 5 3.5 Step 3 - Installation of PDF IFilter and HTML IFilter on Server ................................... 8 3.5.1 Installation on Windows Server 2003 8 3.5.2 Installation on Windows Server 2008 8 3.6 Step 4 – Configure Alterian CMC to Create Index-able Web Pages ......................... 8 3.7 Step 5 - Configure Search Logging .............................................................................. 9 3.7.1 Create the Log File 9 3.7.2 Modify the Web.Config File 10 3.8 Step 6 - Configuring the Plug-in with the Editor ....................................................... 10 3.8.1 Adding the Plug-in to a Page 10 3.9 Step 7 - Finalization and Testing the Configuration .................................................. 14 3.9.1 Re-Index the Site 14 Index Server Search Plug-in ii of iii 3.9.2 Start Windows Indexing Service 15 3.9.3 Categorize Custom Catalog Properties 15 4 Appendix A – Detailed Plug-in Configuration ......................................... 17 5 Appendix B - Searching External Information or Sites ............................ 19 5.1 Custom Properties ....................................................................................................... 19 5.1.1 Multi-Site Searching 19 6 Appendix C – Resolving Configuration Issues ........................................ 20 7 Appendix D - Advanced Testing ............................................................ 21 Index Server Search Plug-in iii of iii 1 Introduction 1.1 Overview The Alterian CMC Index Server Search plug-in provides fast and accurate searching of your site*. It ranks pages by relevance and can limit searches based on categories and document content types. An optional advanced search mode enables searching by date last updated and also allows results to be ordered by relevance, date and title. The plug-in integrates with the Indexing Service facilities provided natively by Windows in order to index and locate documents. For link pages to be returned in search results, the configuration option Note needs to be enabled in the CMC Admin application, Configuration Indexing. 1.1.1 Sample Output Example output from the plug-in is shown in the screenshot, below: Index Server Search Plug-in 1 of 21 1.1.2 Query Syntax and Filtering A range of query filtering and syntax options are available in the Index Server Search plug-in to constrain the query results. Options include: • Constraining the query text to words, phrases and complete sentences • Boolean operators for document content or property values (such as AND, OR, NOT, AND NOT) • Restricting matches to a range of dates within which documents were last updated • Document types (such as only .DOC or .XLS) • Category-based search boundaries The plug-in includes the ability to search most common types of documents including Microsoft Office and PDF documents together with HTML pages from your website. Content is automatically re-indexed by the Windows Indexing Service whenever it is updated, meaning that minimal administration is required once setup and configuration is complete. 1.2 Known Issues Known issues exist within Index Server - in particular with its handling of multilingual content which uses foreign characters: • If a published HTML page contains content which uses a character different to the set used by the Index Server's machine locale, for example a Chinese title in an HTML page indexed on a server with an English locale, that data will be incorrectly indexed and results based on matching queries will show corrupt data, or may not show the corrupted page at all. • Foreign characters cannot be used as part of a search query unless the locale of the search is specifically set to the correct locale of the search characters. This means that queries containing mixtures of characters from different locales are not possible. Index Server Search Plug-in 2 of 21 2 Compatibility The Index Server Search plug-in applies to Alterian CMC 6.3. 2.1 Windows Server Compatibility The Index Server Search plug-in integrates with Windows Indexing Service for both Windows Server 2003 and Windows Server 2008. Configuration is slightly different on each server. This document highlights where different configuration is required. The default indexing service for Windows Server 2008 is Windows Search. This plug-in is applicable only to the Windows Indexing Service role service which is an alternative and optional service provided within Windows Warning Server 2008. It is important to note that the Windows Indexing Service cannot be installed side-by-side with the Windows Search – the two are mutually exclusive services. 2.2 Multi-Language Compatibility Note that version 6.3 plug-ins include multi-lingual capability for both the Editor-specific user- interface and the generated website output. All examples in this document are in English. The process of adding language translations to a plug-in are described in a Note separate document. Index Server Search Plug-in 3 of 21 3 Installation 3.1 Pre-requisites In order to configure the Windows Indexing Service additional files are required and are available in the following zip archive: • IndexServerSearch.zip For Windows Server 2008, if .pdf files are to be indexed, version 8.1.2 or Note above of Acrobat Reader should be installed. This is supplied on the Alterian CMC installation CD. 3.2 Installation Overview Seven key steps are involved in installing and configuring the system to support the Index Server Search plug-in. These steps are as follows: 1. Creation/configuration of folders to allow Windows Indexing Service to index required website files; 2. Configuration of Windows Indexing Service to identify the above folders for indexing including: a. Creation of a folder that Windows Indexing Service will use to manage its “Catalog” (a catalog being a specification of folders etc. that may be indexed); b. Specification of the different website folders which may be indexed; 3. Specification of the filters which allow non-default file-types to be indexed (for example .doc file types are indexed by default whereas .pdf and .htm files are not). 4. Configuring Alterian CMC so that it generates index-able web pages. 5. Configuring Search Logging. 6. Configuring the plug-in within the Editor; 7. Finalization and testing the configuration. The following sections explain the steps involved to complete the configuration process after which it should be possible to use the Index Server Search plug-in. This document does not explain the intricacies of Windows Indexing Service or how to administer it - merely, it describes how to configure it for use with the Index Server Search plug-in. Index Server Search Plug-in 4 of 21 3.3 Step 1 – Configuration of Website Folders 3.3.1 Overview Once configured, Windows Indexing Service will index folders you have specified for your site. Typically, these folders may contain documents