iusserver 8 5 sp3 admin en

7/26/2019 IUSServer 8 5 SP3 Admin En

http://slidepdf.com/reader/full/iusserver-8-5-sp3-admin-en 1/118

iManage

iManage Universal

Search Server ™

Administration Guide

Version 8.5 SP3Document Revision 0

18 July 2013



Notice

This documentation is a proprietary product of Autonomy and is protected by copyright laws and international treaty. Information in thisdocumentation is subject to change without notice and does not represent a commitment on the part of Autonomy. While reasonable efforts havebeen made to ensure the accuracy of the information contained herein, Autonomy assumes no liability for errors or omissions. No liability isassumed for direct, incidental, or consequential damages resulting from the use of the information contained in this documentation.

The copyrighted software that accompanies this documentation is licensed to the End User for use only in strict accordance with the End UserLicense Agreement, which the Licensee should read carefully before commencing use of the software. No part of this publication may bereproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means,electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner.

This documentation may use fictitious names for purposes of demonstration; references to actual persons, companies, or organizations arestrictly coincidental.

Trademarks and Copyrights

Copyright 2013 Autonomy Corporation plc and all its affiliates. All rights reserved. Audit Center, Autonomy Consolidated Archive, AutonomyExpress Search, Autonomy iManage ConflictsManager, Autonomy iManage RecordsManager, Autonomy Interaction Control Element (ICE),

Autonomy Message Manager, Autonomy Notification Server, Autonomy Records Manager, Autonomy Windows Extension, DeskSite,Connected, Digital Safe, Digital Supervisor, EAS On-Demand, EAS, Enterprise Archive Solution, FileShare, FileSite, iManage WorkSite MP,iManage WorkSite, iManage, Interwoven, Introspect, LiveVault, Meridio, OffSite, Scrittura, WorkDocs, WorkPortal, WorkRoute, WorkSite MP,WorkSite, WorkTeam, Zantaz, and all related titles and logos are trademarks of Autonomy Corporation plc and its affiliates, which may beregistered in certain jurisdictions.

Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, SharePoint, and other Microsoft products referencedherein are trademarks of Microsoft Corporation.

UNIX is a registered trademark of The Open Group.

AvantGo is a trademark of AvantGo, Inc.

Epicentric Foundation Server is a trademark of Epicentric, Inc.

Documentum and eRoom are trademarks of Documentum, a division of EMC Corp.

FileNet is a trademark of FileNet Corporation.

Lotus Notes is a trademark of Lotus Development Corporation.

mySAP Enterprise Portal is a trademark of SAP AG.

Oracle is a trademark of Oracle Corporation.

Adobe is a trademark of Adobe Systems Incorporated.

Novell is a trademark of Novell, Inc.

Stellent is a trademark of Stellent, Inc.

Android is a trademark of Google Inc.

All other trademarks are the property of their respective owners.

Notice to Government End Users

If this product is acquired under the terms of a DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as setforth in subparagraph (c)(1)(ii) of 252.227-7013. Civilian agency contract: Use, reproduction or disclosure is subject to 52.227-19 (a) through(d) and restrictions set forth in the accompanying end user agreement. Unpublished-rights reserved under the copyright laws of the United States.

Autonomy, Inc., One Market Plaza, Spear Tower, Suite 1900, San Francisco, CA. 94105, US.

Acknowledgements

RSA Data Security, Inc. MD5 Message-Digest Algorithm; zlib general purpose compression library, Jean-loup Gailly and Mark Adler; Info-ZIP,more information at f tp : / / f tp . i nf o- z i p. org/pub/ i nf oz i p/ l i cense. html ; HTML-to-RTF Pro DLL 1.8 © 2002-2007 SautinSoft.

18 July 2013

Copyright Notice



iManage Universal Search Server Administration Guide 3

•

•

•

•

•

•

Contents

Figures ............................................................................................................................................. 7

Tables ............................................................................................................................................... 9

About This Document ...............................................................................................................11

Documentation Updates...............................................................................................................11

Related Documentation............................................................................................................... 12

Conventions ................................................................................................................................ 13

Notational Conventions ........................................................................................................ 13

Command-line Syntax Conventions ..................................................................................... 14

Notices ................................................................................................................................. 15

HP Autonomy Product References.............................................................................................. 15

HP Autonomy Customer Support ................................................................................................ 15

Contact HP Autonomy................................................................................................................. 16

Chapter 1Introduction ................................................................................................................................ 17

iManage Universal Search Server ............................................................................................... 17

HP Autonomy’s IDOL Platform.................................................................................................... 19

IUS Architecture.......................................................................................................................... 19

Components ........................................................................................................................ 19

Additional Components ........................................................................................................ 20

Index and Query .................................................................................................................. 20

Security ................................................................................................................................ 20Text Queries .................................................................................................................. 21

Agent, Profile and Category Queries ............................................................................. 21

Community Queries ....................................................................................................... 21

IUS Features............................................................................................................................... 21



Contents

4 iManage Universal Search Server Administration Guide

•

•

•

•

•

•

Chapter 2Plan an IUS Installation ........................................................................................................... 23

Size the Installation ..................................................................................................................... 23

IUS System Requirements ......................................................................................................... 24

Basic Requirements ............................................................................................................. 24

Software Requirements ........................................................................................................24

Supported Platforms ............................................................................................................ 25

Hardware Guidelines ............................................................................................................ 25

Other Planning Guidelines .......................................................................................................... 26

Licenses ...................................................................................................................................... 27

Antivirus Processes .................................................................................................................... 28

Overview of IUS Server Databases ............................................................................................. 28

Chapter 3Install IUS Server ....................................................................................................................... 31

Turn Off User Account Control ....................................................................................................31

Install IUS Server ........................................................................................................................ 32

Install and Configure the Java JRE ...................................................................................... 32

Install the IUS Server ........................................................................................................... 33

Uninstall IUS Server ................................................................................................................... 34

Chapter 4Configure IUS Server ............................................................................................................... 35

Configure IUS in the Indexer Deploy Tool ................................................................................... 35Configure IUS Server ........................................................................................................... 36

Deploy IUS Server and WorkSite Indexer ............................................................................ 38

Configure Components ........................................................................................................44

Deploy Components and Configuration Files ....................................................................... 46

Move IUS Server or WorkSite Indexer Services .........................................................................47

Create ODBC Connections to WorkSite Libraries .......................................................................47

Encrypt the Connection String in the Configuration File .......................................................48

Create an ODBC System Data Source ................................................................................. 49

Perform Additional Configuration ................................................................................................53

Chapter 5IUS Server Operations ............................................................................................................ 55

Install IUS Services .................................................................................................................... 55

Install All Services ................................................................................................................ 55

Install Individual Services .....................................................................................................56

Install Individual Services Manually ...................................................................................... 56



Contents


•

•

•

•

•

•

Start the IUS Services ................................................................................................................ 56

Disable AlertTask ................................................................................................................. 56

Start All Services ................................................................................................................. 57

Start Individual Services ...................................................................................................... 58

Start Individual Services Manually ....................................................................................... 58

Stop IUS Services ...................................................................................................................... 58

Install and Configure WorkSite Indexer Services ........................................................................ 60

Configure WorkSite Server .................................................................................................. 60

Chapter 6IUS Server Advanced Configuration ................................................................................. 61

WorkSite Taxonomy Tree ........................................................................................................... 61

Identify Best Practice Workspaces ....................................................................................... 62

Re-Index Best Practice Files ................................................................................................ 63Configure IUS Web .............................................................................................................. 64

E-mail Alerts ............................................................................................................................... 66

User E-mail Addresses ........................................................................................................ 66

Templates ............................................................................................................................ 67

Create a Custom Template ........................................................................................... 67

Configure IUS to use a custom template ....................................................................... 68

Spotlight Documents .................................................................................................................. 69

Find the Documents to Spotlight .......................................................................................... 69

Create the iqlrules. File ........................................................................................................ 70

Highlight Search Terms .............................................................................................................. 72

Statistics Server ......................................................................................................................... 72

Configure IUS Web to Use Statistics Server ........................................................................ 73

Install Statistics Server Service ............................................................................................ 73

Start and Stop Statistics Server ........................................................................................... 73

Statistics Server Operations ................................................................................................ 73

Define Additional Events to Track ........................................................................................ 74

Taxonomy .................................................................................................................................. 74

Enable the Category Component ......................................................................................... 75

Set LanguageDirectory Path ................................................................................................ 76

Chapter 7IUS Server Maintenance......................................................................................................... 77

Back Up the Index on a Schedule .............................................................................................. 78

Find the Number of Documents Indexed ....................................................................... 78

Track the Rate of Change ............................................................................................. 79

Example Backup Scenario ............................................................................................ 79



Contents


•

•

•

•

•

•

Backup Schedule Considerations ......................................................................................... 79

Back Up IUS Server Configuration Files on a Schedule .......................................................80

Back Up the Content Index on a Schedule ........................................................................... 81

Back Up the Index Manually .......................................................................................................83

Back Up IUS Server Configuration Files ...............................................................................83

Back Up the Index Data .......................................................................................................84

Send the DRESYNC Index Action .................................................................................84

Send the DREBACKUP Index Action ............................................................................. 84

Verify the Backup ................................................................................................................. 86

Back Up the Index Dynamically ..................................................................................................87

Back Up the Index Data .......................................................................................................87

Send the DREFLUSHANDPAUSE Index Action ............................................................ 87

Restore the Index ....................................................................................................................... 87

Restore the IUS Server Configuration Files ..........................................................................88Restore the Index Data ........................................................................................................88

Verify the Restore Process ................................................................................................... 89

Restoration Considerations .................................................................................................. 90

Reindex IUS Data .......................................................................................................................91

Export Users, Roles, Agents, and Profiles ................................................................................... 93

Import Users, Roles, Agents, and Profiles ................................................................................... 94

Back Up Categories, Taxonomies, and Cluster Jobs................................................................... 95

Restore Categories, Taxonomies, and Cluster Jobs.................................................................... 96

Compact the Index ..................................................................................................................... 96

Important Considerations .....................................................................................................97

Compact the Index Data on a Schedule ...............................................................................98

Manually Compact the Index Data ....................................................................................... 99

Chapter 8Troubleshoot IUS .................................................................................................................... 101

IUS Server Log Files ................................................................................................................. 101

IUS IDOL Logs ................................................................................................................... 101

IUS Content Logs ............................................................................................................... 102

IUS OGS Logs ................................................................................................................... 102

IUS DiSH Logs ................................................................................................................... 103

Glossary ...................................................................................................................................... 105

Index ..............................................................................................................................................111




•

•

•

•

•

•

Figures

Figure 1 Edit System Variable dialog box ................................................................................ 33

Figure 2 Deploy Tool................................................................................................................ 36

Figure 3 Add Library Configuration dialog box......................................................................... 39

Figure 4 Indexer Deploy options .............................................................................................. 40

Figure 5 Deploy Tool: Components tab ................................................................................... 44

Figure 6 Deploy Tool: configure component host and path ..................................................... 45

Figure 7 IUS Server deployment progress............................................................................... 46

Figure 8 ODBC Data Source Administrator, System DSN tab................................................. 49

Figure 9 Create a New Data Source to SQL Server dialog box............................................... 50

Figure 10 Create a New Data Source to SQL Server, logon information .................................. 51

Figure 11 Microsoft SQL Server DSN Configuration, default database information.................. 51

Figure 12 Microsoft SQL Server DSN Configuration, language settings ................................... 52

Figure 13 ODBC Microsoft SQL Server Setup summary ........................................................... 53

Figure 14 Taxonomy Information on the Best Practice Tab ...................................................... 62



Figures


•

•

•

•

•

•




•

•

•

•

•

•

Tables

Table 1 Required databases.................................................................................................... 28

Table 2 Optional deployed databases ..................................................................................... 29

Table 3 Deploy Tool options on the General tab ..................................................................... 37

Table 1 Deploy Tool options on the Indexer tab ...................................................................... 38

Table 4 IUS IDOL log files ..................................................................................................... 101

Table 5 IUS Content log files ................................................................................................. 102

Table 6 OGS log files............................................................................................................. 102

Table 7 DISH Log Files.......................................................................................................... 103



Tables


•

•

•

•

•

•




•

•

•

•

•

•

About This Document

This guide contains information about installing and customizing IUS Server (IUS).It is intended for the system administrators who install and manage IUS.

Documentation Updates

Related Documentation Conventions

HP Autonomy Product References

HP Autonomy Customer Support

Contact HP Autonomy

Documentation Updates

The information in this document is current as of iManage Universal SearchServer version 8.5 SP3. The content was last modified 18 July 2013.

You can retrieve the most current product documentation from HP Autonomy’sKnowledge Base on the Customer Support Site.

A document in the Knowledge Base displays a version number in its name, suchas IDOL Server 7.5 Administration Guide. The version number applies to theproduct that the document describes. The document may also have a revisionnumber in its name, such as IDOL Server 7.5 Administration Guide Revision 6.The revision number applies to the document and indicates that there wererevisions to the document since its original release.

It is recommended that you periodically check the Knowledge Base for revisionsto documents for the products your enterprise is using.



About This Document


•

•

•

•

•

•

To access HP Autonomy documentation

1. Go to the HP Autonomy Customer Support site at

https://customers.autonomy.com

2. Click Login.

3. Enter the login credentials that were given to you, and then click Submit.

The Knowledge Base Search page opens.

4. In the Search box, type a search term or phrase. To browse the KnowledgeBase using a navigation tree only, leave the Search box empty.

5. Ensure the Documentation check box is selected.

6. Click Search.

Documents that match the query display in a results list.

7. To refine the results list, select one or more of the categories in the Filter By pane. You can restrict results by

Product Group. Filters the list by product suite or division. For example,you could retrieve documents related to the iManage, IDOL, Virage orKeyView product suites.

Product. Filters the list by product. For example, you could retrievedocuments related to IDOL Server, Virage Videologger, or KeyView Filter.

Component. Filters the list by a product’s components. For example, youcould retrieve documents related to the Content or Category component inIDOL.

Version. Filters the list by product or component version number.

Type. Filters the list by document format. For example, you could retrievedocuments in PDF or HTML format. Guides are typically provided in bothPDF and HTML format.

8. To open a document, click its title in the results list.

To download a PDF version of a guide, open the PDF version, click the Saveicon in the PDF reader, and save the PDF to another location.

Related DocumentationFor IUS deployments that connect to WorkSite Indexer, refer to the followingguides for more information about configuring and administering WorkSiteIndexer:

WorkSite Indexer Administrator’s Guide

https://customers.autonomy.com/




Conventions


•

•

•

•

•

•

Conventions

The following conventions are used in this document.

Notational Conventions

This document uses the following conventions.

Convention Usage

Bold User-interface elements such as a menu item or button.

For example:

Click Cancel to halt the operation.

Italics Document titles and new terms. For example: For more information, refer to the IDOL Server

Administration Guide.

An action command is a request, such as a query or

indexing instruction, sent to IDOL Server.

monospace f ont File names, paths, and code. For example:

The Fi l eSyst emConnect or. cf g file is installed in

C: \ Pr ogr am Fi l es\ Fi l eSyst emConnect or \ .

monospace bold Data typed by the user. For example:

Type run at the command prompt.

In the User Name field, type Admin.

monospace italics Replaceable strings in file paths and code. For

example:

user UserName



About This Document


•

•

•

•

•

•

Command-line Syntax Conventions

This document uses the following command-line syntax conventions.

The use of punctuation—such as single and double quotes, commas, periods—

indicates actual syntax; it is not part of the syntax definition.

Convention Usage

[ opt i onal ] Brackets describe optional syntax. For example:

[ - creat e ]

| Bars indicate “either | or” choices. For example:

[ opt i on1 ] | [ opt i on2 ]

In this example, you must choose between opt i on1

and opt i on2.

{ r equi r ed } Braces describe required syntax in which you have a

choice and that at least one choice is required. For

example:

{ [ opt i on1 ] [ opt i on2 ] }

In this example, you must choose opt i on1, opt i on2,

or both options.

r equi r ed Absence of braces or brackets indicates required

syntax in which there is no choice; you must type the

required syntax element.

variable

<var i abl e>

Italics specify items to be replaced by actual values. For

example:

- mer ge filename1

(In some documents, angle brackets are used to denote

these items.)

. . . Ellipses indicate repetition of the same pattern. For

example:

- mer ge filename1, filename2 [ , filename3

. . . ]

where the ellipses specify, filename4, and so on.





•

•

•

•

•

•

Notices

This document uses the following notices:


This document references the following Autonomy products:

WorkSite Indexer

Autonomy Intelligent Data Operating Layer (IDOL) Server

HP Autonomy Customer Support

HP Autonomy Customer Support provides prompt and accurate support to helpyou quickly and effectively resolve any issue you may encounter while using HP

Autonomy products. Support services include access to the Customer Support

CAUTION A caution indicates an action can result in the loss

of data.

IMPORTANT An important note provides information that is

essential to completing a task.

NOTE A note provides information that emphasizes orsupplements important points of the main text. A note supplies

information that may apply only in special cases—for example,

memory limitations, equipment configurations, or details that

apply to specific versions of the software.

TIP A tip provides additional information that makes a task

easier or more productive.



About This Document


•

•

•

•

•

•

Site (CSS) for online answers, expertise-based service by HP Autonomy supportengineers, and software maintenance to ensure you have the most up-to-datetechnology.

To access the Customer Support Site, go to

https://customers.autonomy.com

The Customer Support Site includes:

Knowledge Base: The CSS contains an extensive library of end userdocumentation, FAQs, and technical articles that is easy to navigate andsearch.

Case Center : The Case Center is a central location to create, monitor, andmanage all your cases that are open with technical support.

Download Center : Products and product updates can be downloaded and

requested from the Download Center.

Resource Center : Other helpful resources appropriate for your product.

To contact HP Autonomy Customer Support by e-mail or phone, go to

http://www.autonomy.com/content/Services/Support/index.en.html

Contact HP Autonomy

For general information about HP Autonomy, contact one of the following

locations:

Europe and Worldwide North and South America

E-mail: [email protected]

Telephone: +44 (0) 1223 448 000

Fax: +44 (0) 1223 448 001

Autonomy Corporation plc

Cambridge Business Park

Cowley Rd

Cambridge CB4 0WZ

United Kingdom

E-mail: [email protected]

Telephone: 1 415 243 9955

Fax: 1 415 243 9984

Autonomy, Inc.

One Market Plaza

Spear Tower, Suite 1900

San Francisco CA 94105

USA



mailto:[email protected]









•

•

•

•

•

•

CHAPTER 1

IntroductionThis section provides an overview of iManage Universal Search Server (IUS) andits capabilities.

iManage Universal Search Server

HP Autonomy’s IDOL Platform

IUS Architecture

IUS Features

iManage Universal Search Server

iManage Universal Search Server (IUS) is a search user interface. IUS enablesend users to quickly sift through massive amounts of unstructured and structuredcontent in WorkSite and external repositories to find the most relevant resultsthrough the use of natural language queries.

IUS Server is the server component of IUS, which:

collects data from the configured repositories.

indexes the data into IDOL server.

retrieves data in response to user queries.

IUS Server is powered by IDOL Server, providing faster and more efficientindexing capabilities than previous releases of IUS.



Chapter 1 Introduction


•

•

•

•

•

•

IUS provides the following IDOL server capabilities:

Fast Indexing Speed and Search Response time. IUS can quickly indexextremely large repositories, and provide rapid responses to queries againstmultiple large repositories.

Concept searching. IUS can recognize concepts, and it can use concepts toidentify and relate similarities between different pieces of information.

Automatic Hyperl inking . IUS can automatically link concepts in a documentto those in another file, video or voicemail with hyperlinks.

Automatic Query Guidance (AQG). Simple keyword queries of between oneand three words frequently fail because they do not provide enough context.

AQG automatically provides suggestions to help you find the most relevantdocuments.

Alerts. IUS allows you to monitor specific topics and alerts you to newinformation as it appears.

Real Time Predic tive Query (RPQ). IUS provides type-ahead suggestions asyou type search keywords in the Search box.

Connector Support. IDOL supports over 1000 file formats and connects to

over 400 content repositories.

The following additional packs are available:

Classifi cation and Categorization. This package allows you to deriveprecise categories from concepts found in unstructured text, ensuring that alldata is classified in the correct context with the utmost accuracy. You canmaintain existing taxonomies from other systems, or you can enrich them withcontextual understanding. You can also build new taxonomies.

Community Conceptual and Expertise Networks. This package builds anunderstanding of the relationships between experts and the content that theyinteract with. It forms a conceptual understanding of user interaction with

information as users consume and create it. It automatically clusters similarpeople and resources into related group. The package includes Profiles, Agents, Location-based Expertise, and Recommendations.

Visualization and Advanced Analytics. Visualization of clusters enables theunprecedented visibility of the information and knowledge stored in theenterprise by creating real-time maps of the concepts and their relationships. Itidentifies the areas and ideas that attract the most attention as well as areas

NOTE Your license determines which of the following operations your IUS

installation can perform.





•

•

•

•

•

•

that do not. This package includes 2D Clustering, Spectrograph,Communications Tracer, and Communication Link Map.

Rich Media. This package enables you to automatically capture, encode andindex video and audio content, and to generate highly granular metadata. Thisprocess ensures that you can fully search all rich media and link it with otherstructured and unstructured information.

Global Language Support. IDOL currently supports 106 languages. HP Autonomy can also easily add support for additional languages, because thetechnology is fundamentally language independent.


At the core of IUS Server is HP Autonomy’s Intelligent Data Operating Layer (IDOL).

IDOL gathers and processes unstructured, semi-structured, and structuredinformation in any format from multiple repositories using IDOL connectors and aglobal relational index. It can automatically form a contextual understanding of theinformation in real time, linking disparate data sources together based on theconcepts contained in them. For example, IDOL can automatically link conceptscontained in an e-mail message to a recorded phone conversation, which can beassociated with a stock trade. This information is then imported into a format thatis easily searchable, adding advanced retrieval, collaboration, and personalizationto an application that integrates the technology.

For more information on IDOL, refer to the IDOL Getting Started Guide.

IUS Architecture

This section describes the architecture of IUS Server.

Components

IUS Server includes the following services:

IUS IDOL. This service acts as a distribution layer for multiple IUS Contentservices. IUS IDOL includes the following subservices:

DAH (Distributed Action Handler). DAH distributes ACI (AutonomyContent Infrastructure) actions to multiple IUS Content services, providingfailover and load balancing.





•

•

•

•

•

•

DIH (Distributed Index Handler). DIH distributes the indexing of documentsinto multiple IUS Content services, providing failover and load balancing.

Community. Community stores information about users and their roles

and permissions in IDOL, and manages user authentication.

Agentstore. Agentstore manipulates, stores, and retrieves agents andprofiles for users.

IndexTasks. IndexTasks manipulates the index files and IDX files (forexample, it can add additional fields relevant to the content) before itpasses the data to Content for indexing.

View Server . The View server converts documents to HTML format forviewing in a Web browser.

IUS Content. This service indexes all the content and serves search requests.

IUS OmniGroup Server (OGS). This service collects and aggregates userand group security information from a variety of repositories.

IUS Web component. An IIS Web application that serves the IUS searchinterface.

Distributed Service Handler (DiSH). This service controls the licensing of allIUS functionality.

IDOL Statist ics Server . This service is a complete reporting platform that canrecord any requested data for any specified time frame.

Additional ComponentsIUS requires one or more Connector services to collect data from externalrepositories (for example, a WorkSite database, a Web site, or a file server).

Index and Query

You can index documents in Autonomy IDX format or in XML format into IUSServer (directly or using a Connector). IUS Server stores the concepts of thedocument. In response to queries, agents, profiles, or content it returns a link tothe result document as well as a percentage weighting, which indicates howrelevant this result document is to the original query. It returns results in XML(even if the document was not in XML format when it was indexed).

Security

It is often necessary to ensure that users can access or retrieve only data thatthey are authorized to view. IUS Server enables you to set permissions for usersor groups of users, to protect information, and ensure only the correct people canaccess it.



IUS Features


•

•

•

•

•

•

Text Queries

IUS Server contains data that has been aggregated from one or morerepositories. In this example each of the repositories has its own group server,

which stores the user names and groups that users belong to. IUS Serveraggregates this security information from the group servers.

When a user logs on to a client, the client sends the authentication details to IUSServer, which returns the user security details. The client stores these details untilthe user logs off or the session times out. Every time the user sends a text query,the client attaches the security details to the query string that it sends to IUSServer.

IUS Server uses the security information in the query string to check if the userhas permission to access the documents that match the query. It matches thesecurity string against the document Access Control Lists (ACLs), and returns all

matching documents that the user has permission to see.

Agent, Prof ile and Category Quer ies

IUS Server contains data that has been aggregated from one or morerepositories. In this example each of the repositories has its own group server,which stores the user names and the groups that these users belong to. IUSServer aggregates this security information from the group servers.

When the client sends an agent, profile, or category query to IUS Server, IUSServer matches the agent, profile or category against the documents it contains.IUS Server uses the security information it has received from the group servers, tocheck if the user has permission to access the documents that match their agent,

profile, or category. It returns all matching documents that the user has permissionto see.

Community Queries

IUS Server stores the agents and profiles of users, so that you can match them incommunity queries (that is, any type of query that requests agents or profiles asresults).

When a client sends a community query to IUS Server, IUS Server matches itagainst the agents and profiles it stores. It returns matching agents and profiles tothe client.

IUS Features

For more information about the unique features provided by IUS, refer to the IUSWeb Administration Guide.





•

•

•

•

•

•




•

•

•

•

•

•

CHAPTER 2

Plan an IUS InstallationThis section describes considerations and recommendations for IUS Server.

Size the Installation

IUS System Requirements

Hardware Guidelines

Other Planning Guidelines

Licenses

Antivirus Processes

Overview of IUS Server Databases

Size the Installation

Before deploying IUS, contact the HP Autonomy Sizing Service [email protected] or HP Autonomy iManage Technical Support. The SizingService asks you to complete a questionnaire with information about your

environment, such as the number, size, and location of your documents, averagedocument size, and hardware specifications. The sizing service then providesrecommendations for settings and network architecture for your IUS deployment.



Chapter 2 Plan an IUS Installation


•

•

•

•

•

•


This section describes the software and hardware requirements for your IUSServer installation.

Basic Requirements

IUS must be installed by an administrative user (a user who is a member ofthe local Administrators group). The user account must have the privilege to

Act as a part of Operating System and Log on as a service.

Your network must support TCP/IP.

You must install IUS Server on a dedicated Microsoft Windows server. Followthe specific directions in the Sizing Questionnaire.

You must disable User Account Control (UAC) before installing on WindowsServer 2008 or 2008 R2 to ensure that IUS services deploy correctly. See“Turn Off User Account Control” on page 31.

You cannot run IUS with restricted file system permissions (for example diskquotas, file handle limits or memory limits).

Your file system must permit file locking (for example, you cannot run IUS onan NFS mount).

Software Requirements

IUS Server has the following software dependencies and requirements:

Microsoft .NET Framework version 3.5 SP1. The IUS Server installerautomatically checks for this component, and installs it if necessary.

You can also download this package from the Microsoft download center:

32-bit: http://www.microsoft.com/download/en/details.aspx?id=5638

64-bit: http://www.microsoft.com/download/en/details.aspx?id=18471

Microsoft Visual C++ 2005 Redistributable Package ATL Security Update.This update is required by IUS IDOL, IUS Content, WorkSite IDOL, WorkSiteContent, and the WorkSite Active Content services. The installer automaticallychecks for this component and installs it if necessary.

IMPORTANT When installing on a 64-bit system, both the

32-bit and 64-bit versions of the Visual C++ 2005

Redistributable are required.

http://www.microsoft.com/download/en/details.aspx?id=5638








•

•

•

•

•

•



Microsoft Visual C++ 2005 Service Pack 1 Redistributable Package MFCSecurity Update. This update is required by IUS IDOL, IUS Content, WorkSiteIDOL, WorkSite Content, and the WorkSite Active Content services. Theinstaller automatically checks for this component and installs it if necessary.


http://www.microsoft.com/download/en/details.aspx?id=26347 32-bit version of Java Runtime Environment version 6.0. This component is

required by the Deploy Tool, Index Browser, WorkSite Connector, andWorkSite DiffTool. You can download this file from JRE 6 (32-bit) from:

http://java.com/en/download/manual_v6.jsp

You must use the 32-bit version on a Windows 64-bit platform.

Supported Platforms

For a list of supported platforms for this release, refer to the IUS Server ReleaseNotes and IUS Web Release Notes.

Hardware Guidelines

You must consider the following hardware recommendations when planning yourIUS deployment:

Processors. IUS Server is a multi-threaded process, which you can configureto optimize processor utilization for maximum throughput on indexing. Thebasic processor requirements provide high performance for indexing andsearching for most implementations. Increasing the number of processorsallows IUS Server to index more documents per hour, and process moresearch requests per second.

Memory. The amount of RAM available to IUS Server has a direct impact onthe speed of searches. IUS Server can retrieve search results more quickly if itcan cache more index data in RAM.

Data Storage Drive. The indexing and searching processes are input/output(I/O) intensive activities. Low write I/O can limit indexing performance, and low

IMPORTANT When installing on a 64-bit system, both the

32-bit and 64-bit versions of the Visual C++ 2005

Redistributable are required.











•

•

•

•

•

•

read I/O can limit search performance. Insufficient disk I/O can result in slowperformance, or index and search failures.

HP Autonomy recommends storing the full-text collection on a local SCSIarray using 15K drives or a SAN with equivalent throughput, using a directfiber channel connection to ensure optimal disk I/O.

Data Storage Space. To estimate index space, HP Autonomy recommendsthat you plan for 60% of the size of the file store. The final index typically takesup only 30% of the size of the file store, but the indexing process can use up to30% additional space for the temporary files used to create and merge thecollection. Most of this space is freed after indexing. HP Autonomyrecommends that you provide an additional 30% of space to allow for thecreation of staging collections for testing.

IUS Server with a single Content Service can index more than 20GB per Hour of

raw index data. It can deliver results at a rate of more than 2000 queries persecond on a single machine with 2 CPUs, with sub-second response times, whenused against over 30 million pieces of content.

The minimum requirements do not account for redundancy or optimalperformance considerations for indexing and search. Hardware requirementsmight increase according to several factors, including:

Redundancy and uptime requirements

Frequency of indexing and search load

Additional services hosted on the IUS Server machines

Other Planning Guidelines

Besides the physical hardware, the following factors affect the performance ofyour IUS deployment:

Operating System. IUS Server has 32-bit and 64-bit versions. HP Autonomyrecommends that you use the 64-bit version, which offers faster performancefor both indexing and searching.

Virtualization. IUS Server can function on virtualization platforms. However,

IUS Server has high I/O, processor, and memory requirements, sovirtualization can reduce overall system performance. HP Autonomyrecommends that you use physical hardware for all IUS deployments.

Network I/O. File transfers can make up a significant part of the indexing timeif the network link is slow or misconfigured. For example, if you distribute fileservers in remote offices, the lower file transfer speeds over the WAN canadversely affect the indexing time.



Licenses


•

•

•

•

•

•

Page file size. The page file is a machine configuration that can have asignificant impact on performance, particularly during activities such asdictionary building. HP Autonomy recommends that you either:

set the page file to be system-managed.

manually set it to a size appropriate for the machine. When manuallyconfiguring a page file, a standard guideline for the page file size is 1.5xthe size of physical RAM.

Licenses

The HP Autonomy Distributed Service Handler (DiSH) controls the licensing thatallows you to run IUS Server. You must have a valid license key

(l i censekey. dat ) to run IUS.

The license file is tied to the IP address and ACI port of your DiSH server, and youcannot transfer it between machines. You must have a running Autonomy LicenseServer that resides on a machine with a static known IP address, MAC address orhost name.

To obtain a license

1. Log on to the HP Autonomy Customer Support Site:

http://customers.autonomy.com

2. Request a license file for your specific installation.3. When you receive the license file from HP Autonomy, save it as

l i censekey. dat , and copy it to the I US DI SH directory.

You can revoke licenses at any time, for example, to re-allocate them, or tochange the IP address of a client.

IMPORTANT You must not:

change the IP address of the machine on which a licensed module is

running (if you are using an IP address to lock your license).

change the service port of a module without first revoking the license.

replace the network card of a client without first revoking the license.

remove the contents of the l i cense and ui d directories.

These actions cause the licensed module to become inoperable.

http://customers.autonomy.com/

http://customers.autonomy.com/





•

•

•

•

•

•

All services produce a l i cense. l og and servi ce. l og f i l e. If a service failsto start, examine the contents of these files before you submit a support ticket.

Antivirus Processes

Many systems run background processes or system services that regularly scanthe file systems on a computer system, such as antivirus, anti-spyware, andanti-malware packages. These packages check new and updated files for knownsignatures of viruses and other problematic software.

Index files created by IUS cannot contain viruses or dangerous software. Theycan also change relatively frequently, depending on your index refresh mode, orthe frequency with which you manually update your index files. Scanning these

files can slow the performance of your system substantially without providing anybenefit.

To prevent slow performance, exclude the directories that contain the IUS indexesfrom the list of directories to scan. The most common cause of slow documentcrawls is not having the proper antivirus exclusions.


By default, IUS Server includes a number of databases. Most databases store

index data. Other databases store information for specific IUS features.The following databases are required.

Table 1 Required databases.

Database Description

I QLRul es Stores information about search results to spotlight. This database is

internal to IUS, and is created automatically. For more information, see

“Spotlight Documents” on page 69.

KMCache Stores information about comments, ratings, and tags for search

results. This database is internal to IUS, and is created automatically.

For more information, refer to the IUS Web Components AdministrationGuide.

Agent Stores user information such as preferences. This database is internal

to IUS, and is created automatically.





•

•

•

•

•

•

The Deploy Tool creates the following additional databases.

For more information about how IUS Web displays these databases, refer to theIUS Web Administration Guide.

Table 2 Optional deployed databases

Database Description

Audi o Stores data from an audio repository.

Cl i ent s Stores indexed data from a listing of all legal clients.

Cour t Cases Displays results from the CourtCases database.

Document s Stores documents from a non-WorkSite repository.

Federal Cases Stores indexed data from a case law Web site or other similar

repository.

Mat t er s Stores indexed data from a listing of all legal matters.

Peopl e Stores indexed biographical information of users, which IUS usesfor the expertise locator functionality, together with the information

in the Timebilling database. For more information, refer to the IUS

Web Component Administration Guide.

PLC Stores indexed data from the Practical Law legal resource.

Vi deo Stores data from a video repository.





•

•

•

•

•

•




•

•

•

•

•

•

CHAPTER 3

Install IUS Server This chapter describes how to install IUS Server. Separate installers are providedfor each component, allowing you to deploy them to dedicated servers.

To install IUS Web, please refer to Chapter 3 of the IUS Web Server Administration Guide.

Review the information in “Plan an IUS Installation” on page 23 before continuing.

Turn Off User Account Control

Install IUS Server

Uninstall IUS Server

Turn Off User Account Control

On Windows Server 2008, or Windows Server 2008 R2, you must turn off User Account Control (UAC) before you install IUS Server, to ensure that IUS servicesdeploy correctly.

Turn Off UAC on Windows Server 2008 R2

Use the following procedure to turn off UAC on Windows Server 2008 R2.



Chapter 3 Install IUS Server


•

•

•

•

•

•

To turn off UAC on Windows Server 2008 R2

1. On the Windows Start menu, click Control Panel.

2. In the Control Panel, click User Accounts.

3. In the User Accounts window, click Change User Account Control settings.

4. If UAC is currently configured in Admin Approval Mode, the User AccountControl message is displayed. Click Continue.

5. Move the slider control to Never Notify, and then click OK.

6. Click Restart Now to apply the change immediately.

Turn Off UAC on Windows Server 2008

Use the following procedure to turn off UAC on Windows Server 2008.

To turn off User Account Control on Windows Server 2008

1. On the Windows Start menu, click Control Panel.

2. In the Control Panel, click User Accounts.

3. In the User Accounts window, click User Accounts.

4. In the User Accounts tasks window, click Turn User Account Control on orof f .

5. If UAC is currently configured in Admin Approval Mode, the User AccountControl message is displayed. Click Continue.

6. Clear the Use User Account Control (UAC) to help protect your computer check box, and then click OK.

7. Click Restart Now to apply the change immediately.

Install IUS Server

Use the following procedure to install IUS Server. Before you install IUS Server,ensure that your system meets the IUS system requirements. See “IUS SystemRequirements” on page 24.

Install and Configure the Java JRE

IUS Server requires the 32-bit version of the JRE.



Install IUS Server


•

•

•

•

•

•

To install and configure the JRE

1. Download and install the 32-bit version of Java JRE 7.0. Do not install the64-bit version.

2. Add the \ j r e\ bi n and j r e\ bi n\ cl i ent directories to the PATH environmental variable.

a. On your Windows desktop, right-click My Computer and selectProperties . The Properties dialog box opens.

b. Select the Advanced tab. Click Environment Variables. TheEnvironment Variables dialog box opens.

c. In the System variables list, find the Path variable, and then click Edit. TheEdit System Variable dialog box opens.

At the end of the existing Variable value, type the following:C: \ j re7\bi n; C: \ j re7\ bi n\ cl i ent

This location assumes that the JRE was installed to C: \ j re7\ . Modify thepath to use the location in which you installed the JRE.

Figure 1 Edit System Variable dialog box

d. Click OK to close the Edit System Variable dialog box.

3. Add the J AVA_HOME environmental variable.

a. In the Environment Variables dialog box, click New in the System variableslist. The New System Variable dialog box opens.

b. In the Variable name field, type JAVA_HOME.

c. In the Variable value field, type the location where the JRE was installed,for example:C: \ j r e7\ .

d. Click OK to close the New System Variable dialog box.

4. Continue with “Turn Off User Account Control” on page 31.

Install the IUS Server

Use the following procedure to install IUS Server.



Chapter 3 Install IUS Server


•

•

•

•

•

•

To install IUS Server

1. Run the iManage Universal Search setup. exe file, and follow theinstructions in the installation wizard.

By default, IUS Server is installed in C: \ Pr ogr am Fi l es( x86) \Aut onomy\ I nst al l \ I US Ser ver .

2. The WorkSite Indexer Deploy tool opens. Continue with “Configure IUSServer” on page 35

3. When the installation is complete, click Finish.

Uninstall IUS Server

Use the following procedure to remove IUS Server when it is no longer required.

To uninstall IUS Server

1. Export any index data that you want to preserve. See “Manual Back Up of IUSServer” on page 109.

2. Back up all configuration files.

3. Stop all IUS services. See “Stop IUS Services” on page 58.

4. To remove all services, run the _uni nst al l _ser vi ces. bat script.

To uninstall individual services:

a. Open a command prompt.

b. Run the service executable file with the - uni nstal l option.

For example, to uninstall the IUS IDOL service, run the following command:

C: \ InstallDir \ Uni ver sal Sear ch\ I US I DOL\ "I US I DOL. exe"

- uni nstal l

where InstallDir is the directory where the IUS IDOL is installed.

5. On the Windows Start Menu, click Control Panel, and then click Add/Remove Programs (or Programs and Features if you are using WindowsServer 2008).

6. Remove the IUS Server program.

NOTE On 64-bit versions of Windows, the installer runs in 32-bit mode.

By default, it installs to C: \ Pr ogr am Fi l es ( x86) \ Aut onomy\I nstal l \ I US Ser ver . The final installation location for each

component of IUS Server is determined during the deployment process.

http://backup.pdf/

http://backup.pdf/

http://backup.pdf/

http://backup.pdf/




•

•

•

•

•

•

CHAPTER 4

Configure IUS Server This chapter describes how to configure, deploy, and start IUS.

Configure IUS in the Indexer Deploy Tool

Move IUS Server or WorkSite Indexer Services

Create ODBC Connections to WorkSite Libraries

Perform Additional Configuration


When the IUS installation is complete, the installer automatically starts theWorkSite Indexer Deploy tool, as shown in Figure 2. This tool automates theconfiguration and deployment of IUS and WorkSite Indexer.

To start the WorkSite Indexer Deploy Tool manually, double-click thedepl oy- 8_5. bat file. This file is located in your main IUS Server installationdirectory. For example:

C: \ Pr ogr am Fi l es\ Aut onomy\ I nst al l \ I US Ser ver \ depl oy- 8_5. bator

C: \ Pr ogr am Fi l es( x86) \ Aut onomy\ I nst al l \ I US Ser ver \ depl oy- 8_5. bat



Chapter 4 Configure IUS Server


•

•

•

•

•

•

Figure 2 Deploy Tool

Configure IUS Server

Use the following procedure to configure IUS Server in the Deploy Tool.

To configure IUS Server

1. The deploy tool opens on the General tab. On the General tab, type or selectthe following information:





•

•

•

•

•

•

2. Continue with “Deploy IUS Server and WorkSite Indexer” on page 38.

Table 3 Deploy Tool options on the General tab

Option Description

Deployment

Mode

Production mode configures all IUS Server services for normal use in a production

environment.

Pilot mode configures IUS Server for a test environment on a small server. In the pilot

mode configuration:

the number of threads are reduced for applicable services.

memory usage is decreased for applicable services.

the synchronization times for services are reduced to update index data more

frequently.

the log levels for all services are set to FULL.

ComponentRoot Path

The directory where all components run. If you change this setting, click Apply to addthis new path to the individual component directories on the Components tab. The

individual components run from this location on their respective logical drive.

The default directory is C: \ Pr ogr am Fi l es\ Aut onomy\

Temporary

Output Path

The path where configuration and application files are generated when you perform a

Deploy action. The default path is C: \ t emp\ Aut onomy\

System Bits Select whether you are deploying the software on a 32-bit or 64-bit operating system.

Default Host The host name or IP address where you are deploying the majority of IUS Server

components.

NOTE Type a valid IP address or host name in this field. Do not use l ocal host or

127. 0. 0. 1, because these values are invalid in a multi-server deployment.The deploy tool uses the value you use in this field to populate the default host for each

IUS Server component (listed on the Components tab). If you leave the Default Host

field blank, you must manually enter a host name or IP address for each individual

component on the Components tab.

Default

Language Type

The language type of the majority of your documents.

IUS Server supports automatic language detection. However, when it cannot determine

the language of a document, it processes the document according to the default

language type. By default, this is set to Engl i shUTF8, which is a combination of the

English language type, and UTF-8 encoding.





•

•

•

•

•

•

Deploy IUS Server and WorkSite Indexer

The following procedure describes how to use the Deploy Tool to configure anddeploy WorkSite Indexer and IUS Server together.

To deploy WorkSite Indexer and IUS Server together

1. On the deploy tool, click the Indexer tab.

2. Enter the following information:

3. In the WorkSite Libraries section, click Add to define a connection to aWorkSite library. The Add Library Configuration dialog box opens.

IMPORTANT If you are deploying only IUS without WorkSite Indexer,

follow the steps below but do not make any changes to the Indexer tab.

Table 1 Deploy Tool options on the Indexer tab

Option Description

Number of Content

Engines

The number of Content services to create. If you completed the sizing questionnaire,

use the information returned to you. See “Size the Installation” on page 23.

Security Model The security model to use.

Select Hybrid or Pessimistic if the Secur i t y Model registry key on the WorkSite

Server is set to 1. For more information about pessimistic security, refer to the

WorkSite Server Administration Guide.

In pessimistic mode, WorkSite Indexer uses the pessimistic security model, where

the presence of any prohibition against access on a document outweighs any

explicit or default access to a document which the user might have unless that useris the owner of a document. (Denials outweigh allows.)

By default, an optimistic security model is used, where being granted permission to

access an object outweighs any inherited or explicit prohibitions against accessing

that document.

This option sets the Worksi t eSecur i t yModel parameter in the WorkSite

Content configuration files.

Support IUS Select this option to enable the Eduction functionality used by IUS.

Index Highest

Version Only

Select this option if you want WorkSite Indexer to ignore all older versions of

WorkSite documents, and index only the highest version.





•

•

•

•

•

•

Figure 3 Add Library Configuration dialog box

4. Enter the following information:

Option Description

Library Name The name of the WorkSite Library.

Database Name The name of the WorkSite database. For Oracle, type the database

instance name here.

Database

Vendor

The type of database, either SQLSERVER or ORACLE.

To use Microsoft Integrated Authentication for the connection to the

SQL Server, selectSQLSERVERINTEGRATEDSECURITY. When this

option is selected, the Database Username and Database

Password fields are ignored.

DB InstanceName (optional)

The name of the SQL Server database instance if the WorkSitedatabase is set up in a database instance.

Database

Username

The username to authenticate to the database server, for example:

sa.

NOTE With Microsoft Integrated Authentication, you can leave the

Database Username and Database Password fields blank.





•

•

•

•

•

•

5. Click Test to check the connection to the database. If the test is successful, itdisplays Database connect i on successf ul .

6. Click OK to save the configuration settings for this library.

7. Add any other WorkSite library connections.

8. Click Advanced to configure additional Indexer settings.

Figure 4 Indexer Deploy options

Select any relevant options from the following options:

Database

Password

The password to use for the database server, for example: mhdocs.

The Deploy tool automatically encrypts the password, and storesthe encrypted password in the Indexer configuration files. To view

the encrypted string, click (Lock).

Database Host The host name or IP address of the database server that serves the

WorkSite database.

Database Port The port number used by the database server. The default value is

1433 for SQL Server, and 1521 for Oracle.

NOTE For SQL Server, leave the Port value blank.

Use Local Time If the WorkSite library is configured to use local time instead of

Coordinated Universal Time (UTC), select this option. It sets the

i sLocal Ti me parameter to TRUE in the WorkSi t eConnect or . cf g.

Best Practices

Database

Select this option to store your Best Practice workspaces in a

dedicated database.

Option Description





•

•

•

•

•

•

Option Description

Enable Active

Content

Select this option to use the Active Content configuration. This option automatically adds

Active Content, Active DIH, and Worksite SyncTool services, and includes all applicable

configuration changes. This option is enabled by default.

For more information, refer to the Worksite Indexer Administration Guide.

Enable

Metadata

Content

Select this option to use a separate Content component to store document metadata.

This option installs the Metadata Content and Metadata IndexTasks services, and

includes all applicable configuration changes.

Enable

Workspace

Content

Select this option to use a separate Content component to store workspace information.

This option installs the Workspace Content service, and includes all applicable

configuration changes.

Enable

Non-Store Mode

Select this option to configure WorkSite Indexer so that it does not store the contents of

all indexed documents. By default, Worksite Indexer extracts, indexes, and stores thecontents of all documents in the DRECONTENT field in the index. Enabling this feature

significantly reduces the overall size of the index data stored.

This feature does not affect or alter search functionality. It is best suited for small to

medium sized deployments.

IMPORTANT HP Autonomy does not recommend non-store mode if you are deploying

WorkSite Indexer with IUS.

Some advanced IDOL features and functions are not available with Non-Store Mode,

such as the option to rebuild the index by exporting and importing the index data. If you

enable this feature, a full re-crawl of all documents is required if you need to rebuild the

index (such as for configuration changes).





•

•

•

•

•

•

Click OK to close the Indexer Deploy Options dialog box.

Enable

LexisNexisTagging

Select this option for IUS deployments integrating with Lexis Search Advantage. If you

select this option, click Config. The Config Properties dialog box opens. Enter thefollowing information:

Lexis Search Advantage Host. The host name or IP address of the server running

Lexis Search Advantage.

Lexis Search Advantage Port. The port number used to communicate with the

server running Lexis Search Advantage. The default port is 8088.

Click Close to close the Config Properties dialog box.

For more information about integrating IUS with Lexis Search Advantage, see “Lexis

Search Advantage” on page 83

Enable West KM

Tagging

Select this option for IUS deployments integrating with West KM. If you select this option,

click Config. The Config Properties dialog box opens. Enter the following information:

WestKM Host. The host name or IP address of the server running WestKM.

WestKM Port. The port number used to communicate with the server running

WestKM. The default port is 80.

WestKM Username. The username that IUS Server must use to log on to the

WestKM server.

WestKM Password. The password that IUS Server must use to log on to the

WestKM server.

WorkSite Server Host. The host name or IP address of the server running WorkSite

Server.

Click Close to close the Config Properties dialog box.

Option Description

http://lsa.pdf/

http://lsa.pdf/

http://lsa.pdf/

http://lsa.pdf/





•

•

•

•

•

•

9. Click the IUS tab and enter the following information:

10. To configure alerts, click Alert Email. This option enables IUS to send e-mailalerts to users when a new or updated document matches one of their savedsearches. A mail server is required to send the e-mail alerts.

Option Description

Number of Content

Engines

The number of separate IUS Content services to create. If you completed the

sizing questionnaire, use the information returned to you. See “Size the

Installation” on page 23.

IUS User Domain The domain in which IUS is deployed. This value is the domain that users use

to connect to the IUS Web interface. You can use only one domain.

NOTE Type the NETBI OS value (for example, aut onomy), not the full domain

(for example, autonomy. com).

IUS Database Names The database name to create in the IUS Content server to store index data for

each connector. Type the name and then click (Add).

For example, if you are indexing information from an HTTP, file system,

Exchange, or other connector, you must define a separate database for each

connector. You must then configure each connector to index data into the

respective database.

By default, IUS Server includes several example databases (Audio, Clients,

Documents, and so on.). If you do not plan to index such data, you can remove

the unused databases by using (Remove).

If you are deploying WorkSite Indexer together with IUS, IUS Server

automatically recognizes the WorkSite databases that you defined in the

Indexer tab.

For a description of the default IUS databases, see “Overview of IUS Server

Databases” on page 28.

For more information on how these databases are displayed in IUS Web, refer

to the IUS Web Components Administration Guide.

Option Description

SMTP Server The IP address or machine name of your SMTP mail server.

SMTP Port The port number of the SMTP server to use to send alert e-mails.The default port is 25.





•

•

•

•

•

•

11. Click OK to close the Alert Email Server dialog box.

12. Continue to “Configure Components” on page 44.

Configure Components

By default, the Deploy Tool deploys all IUS components to the default host. According to the sizing recommendations for your system, you might need todeploy one or more components to another host or disk.

To configure components for IUS Server

1. In the Deploy Tool, click the Components tab. See Figure 5.

Figure 5 Deploy Tool: Components tab

Sender’s Email The e-mail address from which to send alert e-mails to users. When

a user replies to an alert e-mail, it is sent to this address.

Sender’s

Username

The user name for the mail server account that you want to use to

send alert e-mail. This field is required if your mail server requires

authentication.

Sender’s

Password

The password for the mail server account that you want to use to

send alert e-mail. This field is required if your mail server requires

authentication.

Option Description





•

•

•

•

•

•

2. To provide an alternate host or path for a component, click Config for thatcomponent. If you leave the Host field blank, the value that you specified inthe Default Host field on the General tab is used.

The Configure Component dialog box opens. For example, Figure 6 showsthe Configure WorkSite Connector dialog box.

Figure 6 Deploy Tool: configure component host and path

In the Host field, type the valid IP address or host name of the server

where you want to deploy this component. Do not type l ocal host or127. 0. 0. 1.

In the Path field, type the path where you want to deploy and run thiscomponent.

For example, if you deploy two IUS Content servers to the same host, theymust each reside on a separate physical disk. As a result, you mightdeploy Content1 to drive E: \ and Content2 to drive F: \ . For example:

E: \ Pr ogr amFi l es\ Aut onomy\ Uni ver sal Sear ch\ I US Cont ent 1

F: \ Pr ogr amFi l es\ Aut onomy\ Uni ver sal Sear ch\ I US Cont ent 2

3. Click OK to close the Configure Component dialog box. Configure any othercomponent host or path settings on the Components tab and configurationdialog boxes.

4. Continue with “Deploy Components and Configuration Files” on page 46.

NOTE This step is required only if you are deploying

one or more services to a different host or a different

logical drive.

NOTE The IDOL Common component defines the

location of the l angf i l es directory. This directory is

used by IUS IDOL, IUS Content, WorkSite IDOL,

WorkSite ContentN and WorkSite Active Content.





•

•

•

•

•

•

Deploy Components and Configuration Files

After you have completed all the configuration in the Deploy Tool, use thefollowing procedure to deploy your components and configuration files to thedestination host.

To deploy IUS Server

1. Save all your configuration settings to a file. From the File menu, click Save.This option creates the Depl oyTool . save file in the \ I nstal l \ I USServer \ Depl oy Tool directory (located in the installation directory).

2. (Optional, for advanced users only) To customize the configuration files beforeyou deploy them, click (Edit). This option allows you to modify additionalsettings in the configuration files.

3. To deploy only the configuration files to the output directory, click

(Regenerate). All configuration files contain the settings that you specify in theDeploy Tool. You can use this option to regenerate the configuration files forupdate indexing after initial indexing is finished.

4. Click (Deploy) to export all the necessary application files to the outputdirectory. All configuration files contain the settings that you specify in theDeploy Tool.

The deployment progress windows opens.

Figure 7 IUS Server deployment progress

5. When the deployment is complete, click Done.





•

•

•

•

•

•


According to the sizing recommendations for your system, you might need tomove one or more IUS or WorkSite Indexer services to another physical server.Ensure that the destination servers meet the requirements for IUS before youmove the components.

The Deploy Tool creates a .ZIP file, with the name of each server that youconfigure in the Components tab. Use the following procedure to deploy thecomponents.

To move the components

1. In the Deploy Tool output directory, find the .ZIP files for each server. Copy the.ZIP files to the corresponding destination server.

2. On the new server, extract the .ZIP file.

3. In the extracted directory, run the _depl oy_ser vi ces. bat file. This scriptmoves the components to the appropriate place on the new server.

Related Topics

“Size the Installation” on page 23

“IUS System Requirements” on page 24


To enable OmniGroupServer (OGS) to import WorkSite user and groupinformation, you must create an ODBC System Data Source for each WorkSitedatabase on the server hosting OGS. This data source is required only for IUSdeployments used in conjunction with WorkSite. For more information, see“Create an ODBC System Data Source” on page 49.

IMPORTANT If you move either the Connector or Ingestion Server

services, you must update the configuration files of both services to include

the full path to a directory to which both services have full access:

In the WorkSi t e Connect or . cf g, set TempDi r ect or y to the name

of the shared path.

In the Wor kSi t e I ngest i on Ser ver . cf g, set Ext r actDi r ectoryto the name of the shared path.





•

•

•

•

•

•

You populate the data source connection in the Connect i onSt r i ng parameterin the IUS OGS configuration file.

Encrypt the Connection String in the Configuration FileYou can use the aut passw. exe tool to encrypt the information stored in theConnect i onSt r i ng parameter.

To encrypt information

1. Navigate to the directory where the Deploy Tool deployed the IUScomponents. The Deploy Tool deploys all IUS components to the Default Host,unless you use the Components tab to deploy components to another host ordisk.

2. Open the I US OGS. cf g file and find the Connect i onSt r i ng parameter.

3. Copy the entire parameter, for example: DSN=ws85; UI D=sa; PWD=pwd

4. Run the aut passw. exe tool. The Autonomy Password Encryption Utilitydialog box opens.

5. In the Plaintext Password box, paste the connection string from theconfiguration file. For example:

6. Click Encrypt.

The tool encrypts the password and prints the encrypted string in theCiphertext Password box.

7. Copy the encrypted string and paste it into the OGS configuration fileConnect i onSt r i ng parameter, replacing the original connection string.

For example:

Connect i onSt r i ng=9u7Cw8PI zt nEwsP+2d/Ew8qQ6f 7j kNr el Zj ym5mW+OTpkN7Ml v366ZDZyM7FycLO8A

You must encrypt each ODBC connection separately.

8. Save your changes to the I US OGS. cf g file.





•

•

•

•

•

•

Create an ODBC System Data Source

The server where you install OGS must have data source connections establishedwith all WorkSite databases.

The following instructions apply to Microsoft SQL Server databases.

To create this data source

1. Open the ODBC Data Source Administrative tool.

From the Windows Start menu, point to Administrat ive Tools , and then clickData Sources (ODBC).

The ODBC Data Source Administrator tool opens.

2. Click the System DSN tab.

Figure 8 ODBC Data Source Administrator, System DSN tab

IMPORTANT You must use the 32-bit ODBC Source

Administrator tool If you are installing WorkSite Server on a

64-bit version of Windows Server. By default, the 32-bitversion located in:

C: \ Wi ndows\ SysWOW64\ odbcad32. exe





•

•

•

•

•

•

3. Click Add. The Create New Data Source dialog box opens.

4. In the list of installed ODBC drivers, select SQL Server , and then click Finish.

The Create a New Data Source to SQL Server dialog box opens. See Figure9.

Figure 9 Create a New Data Source to SQL Server dialog box

a. In the Name box, type the name of the WorkSite database.

The data source name must have fewer than eight characters. It mustcontain only letters and numbers. Letters must be either all uppercase orall lowercase (do not mix cases).

The data source name is the name of the database as it is displayed toWorkSite users.

b. In the Server box, type the name of the SQL Server.

c. Click Next.

5. The Create a New Data Source to SQL Server screen opens. This screendisplays options for authenticating to the SQL Server.





•

•

•

•

•

•

Figure 10 Create a New Data Source to SQL Server, logon information

a. Select SQL Server authentication.

b. In the Login ID and Password boxes, type the SQL Server Login ID andPassword respectively.

c. Select the Connect to SQL Server to obtain default settings check box.

d. Click Next.

6. The Microsoft SQL Server DSN Configuration screen opens. See Figure 11.

Figure 11 Microsoft SQL Server DSN Configuration, default database information





•

•

•

•

•

•

a. In the Change the default database to field, select the database that youcreated earlier in this chapter (see Figure 9).

b. Select both the Use ANSI quoted identifiers check box, and the Use

ANSI nulls, paddings and warnings check box. These settings arerequired for saved searches when using UUEncode (All language supportwith the indexer).

c. Click Next.

7. The Microsoft SQL Server DSN Configuration language settings screenopens. See Figure 12

Figure 12 Microsoft SQL Server DSN Configuration, language settings

a. If you need to support multiple languages, deselect the Performtranslation for character data check box, and leave all other settingsunchanged on this screen.

b. Click Finish.

8. The ODBC Microsoft SQL Server Setup dialog box opens.





•

•

•

•

•

•

Figure 13 ODBC Microsoft SQL Server Setup summary

a. Click Test Data Source.

If all information was correct, it displays TESTS COMPLETEDSUCCESSFULLY.

b. Click OK to close the message dialog box.

9. Click OK to close the setup summary dialog box.

10. Click OK to close the ODBC Data Source Administrator dialog box.


Before you install and start the IUS services, you might want to manually modifysome of the other configuration parameters in the IUS configuration files. Forinformation about the available parameters, refer to the IDOL Server Reference:

InstallDir \ Uni ver sal Search\ I US I DOL\ hel p\ i ndex. ht ml

NOTE The test connection might fail if the Perform

translation for character data check box is notselected, even if the ODBC connection is successful

and is fully functional.





•

•

•

•

•

•




•

•

•

•

•

•

CHAPTER 5

IUS Server OperationsThis chapter describes how to install and run the IUS services.

Install IUS Services

Start the IUS Services

Stop IUS Services

Install and Configure WorkSite Indexer Services

Install IUS Services

IUS includes several batch files to automate the installation of IUS and WorkSiteIndexer services.

Install All Services

The _i nst al l _ser vi ces. bat script installs all WorkSite Indexer and IUSservices. It prompts you for user account information for the WorkSite Connectorservice, because you must run this service as a user that has read access to theWorkSite file server.

The deploy tool creates this script in the .ZIP file for each server. When youextract the files on the destination server, the script is in the main directory (bydefault, C: \ Pr ogr am Fi l es\ Aut onomy\ )



Chapter 5 IUS Server Operations


•

•

•

•

•

•

Install Individual Services

To install only specific services, navigate to the folder of the service and run the _i nst al l _ser vi ce. bat file located in the folder. This option quickly installsindividual services.

For example, to install only the WorkSite Active Content service, run the followingscript:

InstallDir \ I ndexer \ Wor kSi t e Act i ve Cont ent \ _i nst al l _ser vi ce. bat

Install Individual Services Manually

The following steps describe how to install the IUS services manually, instead ofusing the automated script. This option is necessary only for advancedinstallations, for example when you distribute services across multiple servers.

To install IUS services manually

1. Open the Windows command prompt.

2. On the command prompt, navigate to the installation directory for the service.

3. Type the following command:

ServiceName. exe - i nstal l

where ServiceName is the name of the executable file for the service thatyou want to install.

For example: "I US Cont ent 1. exe" - i nst al l


As soon as you start IUS services, they start to create the index. Ensure that yourIUS configuration is correct before you start the services.

Disable AlertTask

The Alert Task is a configured task that IUS IDOL performs during indexing. Itcompares new documents to user saved searches and sends alerts for any new

content. When you create the initial index, this process is unnecessary and mightslow down the index process.

Before you start IUS services for the first time, disable the WorkSite IDOL AlertTask. After you create the initial index, you can enable the AlertTask again.





•

•

•

•

•

•

To disable the AlertTask process

In Wor kSi t e I DOL. cf g, find the [ I ndexTasks] section and setSt ar t Task to Educt i on. For example:

[ I ndexTasks]St art Task= Educt i on

To enable the AlertTask process

In Wor kSi t e I DOL. cf g, find the [ I ndexTasks] section and setSt ar t Task to Educt i on. For example:

[ I ndexTasks]St art Task=Al er t Task

Start All Services

To start all IUS services, run the _st ar t _ser vi ces. bat script. This script islocated in the output directory you specified in the Indexer Deploy tool.

The script starts the services in the recommended order. If you choose to start theprocesses manually in Windows Services management console, you must startthem in the same order:

1. IUS DiSH

2. WorkSite ContentN (if you have multiple Content services, start all of thembefore starting the WorkSite IDOL service)

3. WorkSite Active Content

4. WorkSite IDOL

5. WorkSite IndexTaskN

6. WorkSite DIH

7. Active DIH

8. WorkSite Ingestion Server

9. WorkSite Connector

10. WorkSite SyncTool

11. IUS OGS

12. Statistics Server

13. IUS ContentN (if you have multiple Content services, start all of them beforestarting the IUS IDOL service)

14. IUS IDOL





•

•

•

•

•

•

The script ignores any of the above services that you have not configured in yourIUS deployment.

Review the log files generated by IUS to ensure that all services have startedproperly.

Start Individual Services

To start individual services, navigate to the folder of the service and run the _st ar t _ser vi ce. bat file located in the folder. This allows you to quickly startindividual services.

For example, to start only the WorkSite Active Content service, run the followingscript:

InstallDir \ I ndexer \ Wor kSi t e Act i ve Cont ent \ _st ar t _ser vi ce. bat

Start Individual Services Manually

The following procedure describes how to start IUS services manually, instead ofusing automated scripts. This method is necessary only for advancedinstallations, for example if you distribute services across multiple servers.

To start individual services manually

1. Open the Windows command prompt.

2. In the command prompt, navigate to the installation directory of each service.

3. Type the following command:ServiceName. exe - start

where ServiceName is the name of the executable file for the service thatyou want to start.

For example: " I US Cont ent 1. exe" - s tar t

Stop IUS Services

IMPORTANT Do not restart your system while IUS

services are running. Stop all IUS services and check the

Windows Task Manager to ensure that they have all

stopped.



Stop IUS Services


•

•

•

•

•

•

Use the following procedure to shut down IUS services.To safely shut down allIUS services

1. Stop any connector services by sending a WorkSi t e Connect or . exe

-stop command, or by sending a St op action to the Service port.

2. Check the connector logs to verify that all Connector activity has completed.

3. From a Web browser, send a GetSt atus action to IUS IDOL. For example:

ht t p: / / l ocal host : 10000/ a=Get St atus

Alternatively, open the Indexer Browser and click GetSt atus.

4. Make a note of the number of committed documents in each database.

5. In the Indexer Browser, check that there are no indexing jobs in the queue orthat are pending flush to disk.

In the Action box, send the following action:I ndexer Get St atus&I ndexSt atus=- 7, - 34

If any results return, wait and then perform the same action again. Go to Step6 only after IUS Server has finished processing actions, and the IndexerBrowser stops returning results.

6. In a Web browser, send the following index action to force IUS IDOL toimmediately flush documents to disk from the index cache:

htt p: / / host name: 10001/ DRESYNC?

Make a note of the index ID for this process.

7. In the Indexer Browser, check that the DRESYNC process is complete.a. Connect to port 10000.

b. Set the Result Size to 250 (on the Action menu, click Set Result Size).

c. Click Indexer Status (I ndexer GetSt atus action) to check when theDRESYNC process for that ID finishes (Status=-1, Description = Finished).For example:

i d = 53or i gi n_i p = 127. 0. 0. 1. . .per centage_processed = 100st at us = - 1

descr i pt i on = Fi ni shedi ndex_command = / DRESYNC?

8. Stop the IUS IDOL service, the IUS Content services, and the IUS DiSHservice by sending a -s top command, or by sending a St op action to theService port.





•

•

•

•

•

•

For information on shutting down the WorkSite Indexer, refer to the WorkSiteIndexer Administration Guide.

Install and Configure WorkSite Indexer Services

If you have deployed WorkSite Indexer in conjunction with your IUS deployment,you must also install and start the WorkSite Indexer services created by theDeploy Tool.

For complete instructions, refer to the WorkSite Indexer Administrator’s Guide.

Configure WorkSite Server

By default, WorkSite Server encrypts the query information it sends to theWorkSite Indexer. However, when you deploy WorkSite Indexer with IUS, youmust configure the WorkSite Server to send unencrypted queries to WorkSiteIndexer.

To configure WorkSite Server to send unencrypted queries

1. On the WorkSite Server, configure the WorkSite Server to not use ACIencryption with communications with the WorkSite Indexer.

a. Create or edit the registry key in the following location:

HKEY_LOCAL_MACHI NE\ SOFTWARE\ I nt er woven\ Wor kSi t e\ I mDmsSvc

b. Create or edit the following string value

Name: ACI Init Encryption

Value: N

2. In the Service Manager, stop and restart the WorkSite Server service.




•

•

•

•

•

•

CHAPTER 6

IUS Server AdvancedConfiguration

This chapter describes advanced IUS Server configuration.

WorkSite Taxonomy Tree

E-mail Alerts

Spotlight Documents

Highlight Search Terms

Statistics Server

Taxonomy


IUS can display a hierarchical view of specific WorkSite workspaces on the BestPractices tab. This tab provides users with quick access to commonly used

documents in WorkSite.

When you select a folder in this tree, the documents in the folder are displayed inthe center pane. Selecting a document in the center pane displays the preview ofthe document in the right pane, as shown in Figure 14.



Chapter 6 IUS Server Advanced Configuration


•

•

•

•

•

•

Figure 14 Taxonomy Information on the Best Practice Tab

To configure the Taxonomy Tree functionality, see the following sections:

Identify Best Practice Workspaces

Re-Index Best Practice Files

Configure IUS Web

Identify Best Practice Workspaces

There are two ways to identify Best Practice workspaces:

You can keep Best Practice workspaces in a dedicated database.

You can distribute them across multiple databases which contain both regular

documents and Best Practices documents.

For simplicity and performance reasons, HP Autonomy recommends that youstore all your Best Practices workspaces in a dedicated database. To do this,either set BPWor kspaceDocnumCSV to ALL in the fetch task configuration for the





•

•

•

•

•

•

dedicated database in WorkSi t e Connector . cf g, or check the BestPractices Database check box in the WorkSite Libraries configuration.TheDeploy Tool has been updated to support the dedicated database option.

To dis tribute your Best Practice workspaces across mul tiple databases

1. Find the I M_DOCNUMvalues for all your Best Practice workspaces in eachdatabase.

2. Set the value of the BPWor kspaceDocnumCSV parameter to the I M_DOCNUMvalues for the workspaces.

For example, if the ACTI VE database contains Best Practice workspaces withthe I M_DOCNUMvalues of 123, 456, and 7890, setBPWor kspaceDocnumCSV to 123,456,7890 in the ACTI VE fetch taskconfiguration.

Re-Index Best Practice Files

Use the following procedure to re-index your Best Practice files if you are storingyour Best Practice workspaces in a dedicated database.

To re-index your Best Practice files if you are storing your Best Practiceworkspaces in a dedicated database

1. Identify the Best Practice database.

2. Open WorkSi t e Connector. cf g.

3. Add BPWor kspaceDocnumCSV=ALL to the fetch task configuration for the

Best Practice database.

4. Delete the *. db file of the Best Practices database in the root path ofWorkSite Connector.

5. Back up and initialize the database in IDOL. For information on performingthese tasks, refer to the IDOL Server Administration Guide.

6. Restart WorkSite Connector.

Use the following procedure to re-index your Best Practice files if you are storingyour Best Practice workspaces across multiple databases.

To re-index your Best Practice files if you are storing your Best Practiceworkspaces across multip le databases

1. Identify the I M_DOCNUMvalues of the Best Practice workspaces in eachdatabase.

2. Open WorkSi t e Connector . cf g.





•

•

•

•

•

•

3. In the fetch task configurations for the relevant databases, set the value of theBPWor kspaceDocnumCSV parameter to the I M_DOCNUM values for theworkspaces.

4. Delete the *. db files for databases which contain Best Practice workspaces.

5. Back up and initialize the relevant databases in IDOL.

6. Restart WorkSite Connector.

Configure IUS Web

By default, IUS Web displays all WorkSite workspaces on the Best Practices tab.

To limi t the workspaces to disp lay

1. Open dat asour ces. xml .

<i us_i nst al l _di r ect or y>\ Webr oot \ conf i g\ dat amodel \ i us\datasour ces. xml .

2. Find the best Pr act i cesTab node, and enter the workspaceDREREFERENCE value in the best Pract i ceWor kspaceLi st command,and the f i el dText parameter in best Pr act i cesTab.

For example, if the workspace has a DREREFERENCE of Act i ve. 31581_1,type:

<dat asour ce i d="best Pract i cesTab"> <paramet er s> <par amet er i d="Fi el dText ">I M_PARENT_PATH:

Active.31581_1*, I M_DOCTYPE: DOCUMENTTYPED</ par amet er > </ par amet er s> <commands> … <command i d="best Pr act i ceWorkspaceLi st "

cl assName="com. i nt er woven. web. cor e. command. Cor ePageCommand "> <paramet er s> <par amet er

i d="Pr i ntFi el ds">DREREFERENCE, DRETI TLE</ par amet er> <par amet er

i d="querySt r i ng">act i on=Quer y& Pr i nt=Fi el ds&amp ; Fi el dText =MATCH{ Active.31581_1}: DREREFERENCE AND

MATCH{WORKSPACETYPE}: I M_DOCTYPE& maxr esul t s=10& amp; dat abaseMat ch=Best Pract i ce </ paramet er> </ par amet er s> <vi ews> <vi ew i d="mai n" mai nCont ent ="/ j son/ best Pr act i cesTab/ best Pr act i ceWorkspaceLi st . xml "/ >





•

•

•

•

•

•

</ vi ews> </ command> </ commands>

</ datasour ce>

3. To show multiple workspaces on the Best Practices tab, specify acomma-separated list of the workspaces in the following line:

<par amet er i d="Fi el dText ">( MATCH{ROOT}: I M_PARENT_PATH ANDMATCH{ Active.31581_1,Active.59_1}: DREREFERENCE) </ paramet er >

<dat asource i d="best Pract i cesTab"> <paramet er s> <par amet er i d="Fi el dText ">I M_PARENT_PATH:

Active.31581_1*,Active.59_1*, I M_DOCTYPE: DOCUMENTTYPED</ paramet er> </ paramet ers> … <commands> <command i d="best Pr act i ceWor kspaceLi st "

cl assName="com. i nt erwoven. web. cor e. command. Cor ePageComm and"> <paramet er s> <paramet er

i d="Pr i ntFi el ds">DREREFERENCE, DRETI TLE</ paramet er> <paramet er

i d="quer ySt r i ng">act i on=Query& Pr i nt =Fi el ds& amp; Fi el dText =MATCH{ Active.31581_1,

Active.59_1}: DREREFERENCE AND ……

This example displays two workspaces, Act i ve. 31581_1 andAct i ve. 59_1.

4. By default, IUS displays a maximum of five workspaces. To alter this setting,change the maxr esul t s parameter as highlighted in Step 2.

5. By default, IUS displays a maximum of 100 child folders or subfolders for eachnode. To alter this setting, change the maxr esul t s parameter as shown:

<command i d="f ol der Chi l dren"cl assName="com. i nt er woven. web. cor e. command. Cor ePageCommand"> <paramet er s>

NOTE There is an asterisk after the DREREFERENCE in the

f i el dText parameter.





•

•

•

•

•

•

<paramet eri d="querySt r i ng">act i on=Quer y& Pr i nt=Al l &maxresults

=100</ par amet er>

<par amet er i d="queryParams" >Fi el dText </ par amet er>

6. Save your changes and close dat asour ces. xml .

E-mail Alerts

To generate e-mail alerts, you must configure an Alert task in the IUS IDOL andWorkSite IDOL configuration files. The Deploy Tool can automatically configurethis functionality. See “Configure IUS Server” on page 35.

The following example shows the Al er t Task section of the configuration file,which controls this functionality. The SMTPSendFr omUser name andSMTPSendFr omPasswor d parameters are required only for mail servers thatrequire authentication.

[ Al er t Task]Modul e=Al er tAl er t Ret r ai nedAgent sOnl y=f al seI DOLserver =l ocal host : 10050Fi el ds=DRECONTENT, DRETI TLEFi el dMappi ngs=DRECONTENT, DRETI TLE

Quer yParamet er s=Fi el dText =MATCH{t r ue}: al er t

SMTPServer=10. 5. 203. 4SMTPPor t =25SMTPSendFr om=ej ohnson@l akes. netSMTPSendFr omUsername=el i zabet h j ohnsonSMTPSendFr omPasswor d=pwdSMTPSubj ect =Al er t : new document DREREFERENCE

You must also add the Al er t field to the Agent I ndexFi el dCSVs parameter inthe [ Agent ] section of the configuration file. For example:

Agent I ndexFi el dCSVs=owner , query, date, shar i ngmode, shar edwi t h*, dr e*,alert

User E-mail Addresses

Users can set up alerts for their saved searches only after they provide an e-mailaddress in the Preferences dialog box in the IUS user interface.



E-mail Alerts


•

•

•

•

•

•

Templates

You define the layout of alert e-mail messages in templates. The default e-mailtemplate, al ert Templ at e. ht ml , is located in the following directory:

C: \ Pr ogr am Fi l es\ Aut onomy\ Uni ver sal Sear ch\ I US I DOL\ t empl at es\

You can also create custom templates.

Create a Custom Template

Use the following procedure to create a custom template.

To create a new template

1. Open the al ert Templ ate. ht ml template file in a text editor and save it witha new name. Alternatively, you can create a new file.

2. Type the text that you want to display in the alert e-mail. You can also usevariables, which display document properties in the e-mail that the userreceives.

To display the following values in alert e-mails, type the associated field in thetemplate:

To display... Type this field Example

The document

reference

DREREFERENCE Ref : DREREFERENCE

If you type this example in the template and the document

DREREFERENCE field contains the value http://news.bbc.co.uk, the

alert e-mail contains the following text:

Ref : ht t p: / / news. bbc. co. uk

The document

title

DRETI TLE New document : DRETITLE

If you type this example in the template and the document

DRETI TLE field contains the value Tropical fish, the alert e-mail

contains the following text:

New document : Tropi cal f i sh

The document

content

DRECONTENT DRECONTENT

If you type this example in the template and a document

DRECONTENT field contains the value Brine shrimp: popular withaquaritics. High in protein and a nice snack for many freshwater

fish, the alert e-mail contains the following text:

Br i ne shr i mp: popul ar wi t h aquar i t i cs. Hi gh i npr otei n and a ni ce snack f or many f r eshwater f i sh





•

•

•

•

•

•

Type the fields in the position that you want to display them in the e-mail.

3. Save the template file.

Configure IUS to use a custom template

When you have created a custom template, you must configure IUS IDOL to use

this template.

To configure IUS to use a custom e-mail alert template

1. Open the I US I DOL. cf g configuration file in a text editor.

2. In the [ Al er t Task] section, find the Templ at e andAt t achment Templ at e parameters.

The content of

any otherdocument field

"FI ELDName" Aut hor : "FIELDauthor"

If you type this example in the template and the document aut hor field contains the value JR Hartley, the alert e-mail contains the

following text:

Aut hor : J R Har t l ey

Link terms (terms

in the document

that match terms

in the search

agent)

RESULTLI NKS Li nk t erms: RESULTLINKS

If you type this example in the template, and the stemmed terms

cat, dog and bird in a document match terms in an agent, the alert

e-mail contains the following text:

Li nk t erms: CAT, DOG, BI RD

NOTE IUS IDOL stems the link terms. For information about

stemming, refer to the IDOL Server Administration Guide.

The relevance of

the document to

the search agent

RESULTWEI GHT Rel evance: RESULTWEIGHT %

If you type this example in the template, and a result agent has a

conceptual similarity of 78% to the document, the alert e-mail

contains the following text:

Rel evance: 78 %

The agent

training

AGENTTRAI NI NG Trai ni ng t ext : AGENTTRAINING

If you type this example in the template, and a document

AGENTTRAI NI NG field contains the value Dry-fly fishing for

Woolhead Sculpins and Leadhead Muddlers, eager browns,

rainbows, and cutts, the alert e-mail contains the following text: Tr ai ni ng t ext : Dr y- f l y f i shi ng f or Wool headScul pi ns and Leadhead Muddl ers, eager browns,r ai nbows, and cut t s

To display... Type this field Example



Spotlight Documents


•

•

•

•

•

•

Set Templ at e to the path to the template to use for alert e-mails that donot have an attachment.

Set At t achment Templ at e to the path to the template to use for alert

e-mails that have an attachment.

For example:

Templ at e=. . \ t empl at es\ al er t Templ at e. ht mlAt t achment Templ at e=. . \ t empl ates\ al er t Templ ate. ht ml

3. Save and close the configuration file. Restart IUS IDOL to activate yourchanges.

Spotlight Documents

IUS can promote or spotlight specific documents or content at the top of the IUSsearch results page.

When users search for specific keywords, you can spotlight up to threedocuments. If IUS finds more than three spotlight documents, it displays the threethat have the highest relevance, according to the query terms.

The IUS Server must have an IQLRules database. You can create it using theDeploy tool, or manually. This database stores the data that determines thedocuments to spotlight.

You can use HP Autonomy Business Console (ABC) to populate the IQLRules

with information about spotlight documents, or you can configure it manually. Thefollowing sections describe how to manually set up the IQLRules database forspotlighting.

Find the Documents to Spotlight

Use the following procedure to find the documents that you want to spotlight in theresponse to queries.

To find the documents to spot light

1. In the IUS user interface, perform a search to return the documents.

2. In the list of search results, click the document that you want to use.

3. In the address bar of the Web browser, find the Mat chRef er ence parameter.This value is used in the DREFI ELD DOCREF entry.





•

•

•

•

•

•

For example:

For a WorkSite document:

ws85. 1. 1

For a File System Connector document:

\ \ \ \ f i l eser ver \ \ f ol der \ \ subf ol der \ \ document . pdf

Create the iqlrules. File

The IQLrules file contains details of the document that you want to spotlight, andthe query that a user must perform to return this spotlight document.

To create the IQLRules fi le

1. In a text editor, create a file named iqlrules..

2. Paste the following sample:

#DREREFERENCE I QLRul e1#DRETI TLE I QLRul e1#DREFI ELD KEYWORDS="pol i cy benef i t s empl oyee heal t h"#DREFI ELD USEALLTERMS="f al se"#DREFI ELD TYPE="manual "#DREFI ELD I QLRULETYPE="manual "#DREFI ELD NUMDOCS="2"#DREFI ELD DOCREF0="ws85. 1102_1"#DREFI ELD DOCTI TLE0="Empl oyee Pol i cy Manual "#DREFI ELD DOCSUMMARY0="The company pol i ci es and pr ocedur es as

wel l as i nf or mat i on about your r esponsi bi l i t i es, r i ght s andbenef i t s as an empl oyee. "#DREFI ELD DOCREF1="ws85. 1092_1"#DREFI ELD DOCTI TLE1="Heal t h Benef i t s"#DREFI ELD DOCSUMMARY1="Medi cal , Dent al , Vi si on, Prescr i pt i on,Fl exi bl e Spendi ng and Transi t Rei mbur sement "#DREDATE 1242424025#DRESECTI ON 0#DREFI ELD CUSTOM_I QLTYPE="PROMOTI ONS"#DREDBNAME I QLRul es#DRECONTENT pol i cy benef i t s empl oyee heal t h#DREENDDOC

#DREREFERENCE I QLRul e2#DRETI TLE I QLRul e2#DREFI ELD KEYWORDS="wor d wor d wor d wor d"#DREFI ELD USEALLTERMS="f al se"#DREFI ELD TYPE="manual "#DREFI ELD I QLRULETYPE="manual "#DREFI ELD NUMDOCS="1"



Spotlight Documents


•

•

•

•

•

•

#DREFI ELD DOCREF0="\ \ \ \ f i l eser ver \ \ f ol der \ \ subf ol der \ \document . pdf "#DREFI ELD DOCTI TLE0="Sampl e Ti t l e"

#DREFI ELD DOCSUMMARY0="Sampl e Summar y f or document . pdf "#DREDATE 1242424025#DRESECTI ON 0#DREFI ELD CUSTOM_I QLTYPE="PROMOTI ONS"#DREDBNAME I QLRul es#DRECONTENT wor d wor d wor d wor d#DREENDDOC

This example contains two spotlighting definitions: I QLRul es1 andI QLRul es2. I QLRul es1 promotes two separate documents dealing withemployee benefits. I QLRul es2 shows a second definition promoting asample file.

3. Modify the following fields. Other fields are not used by IUS.

Entry Description

DREREFERENCE A unique name for the spotlighting definition.

DRETI TLE A unique name for the DREREFERENCE. IUS

does not use this title, but other HP

Autonomy products do.

DREFI ELD KEYWORDS The query terms that must spotlight the

documents listed in DREFI ELD DOCREF#.

DREFI ELD NUMDOCS The number of DOCREF entries that you

define for this DREREFERENCE.

DREFI ELD DOCREF# Define a separate DOCREF entry for each

document to spotlight for this definition. Each

entry must increment its number (DOCREF1,

DOCREF2, DOCREF3, and so on). Add the

reference of the document that you want to

spotlight.

DREFI ELD DOCTI TLE A title for each DOCREF. IUS does not use this

title, but other HP Autonomy products do.

DREFI ELD DOCSUMMARY A summary for each DOCREF. IUS does not

use this title, but other HP Autonomy

products do.

DRECONTENT The same keywords that you entered in

DREFI ELD KEYWORDS.

DREFI ELD CUSTOM_I QLTYPE The custom IQL type. For the IUS Web

default configuration, set this field to

PROMOTI ONS .





•

•

•

•

•

•

4. After you have created the necessary definitions, save the file.

5. Send the following DREADD index action to the IUS IDOL index port to sendthe i ql rul es . to the IQLRules database:

ht t p: / / l ocal host : 10001/ DREADD?C: \ t emp\i ql r ul es. &DREDbName=I QLRul es

Highlight Search Terms

By default, IUS highlights search terms that occur in the title and the documentsummary. You can also define additional document fields that you want tohighlight terms in.

To define additional fields to highlight

Add the title field as a Hi ghl i ght field in the IUS Content and WorkSiteContent configuration files.

For example:

[ Set Hi ghl i ght Fi el ds]Pr oper t y=Hi ghl i ght Fi el dsProper t yFi el dCSVs==*/ I M_DOCNAME, */ DRETI TLE, */ I M_AUTHORFULLNAME, */I M_C1DESCRI PTI ON, */ I M_C2DESCRI PTI ON, */ I M_C29DESCRI PTI ON, */I M_C30DESCRI PTI ON, */ EMAI LFROM, */ EMAI LTO

Restart the Content services to activate your changes.

Statistics ServerIUS uses the IDOL Statistics Server to record information such as index rates,peak loads, null-hit queries and overall usage.

NOTE Do not include fields that are used to generate

URLs, such as if you have a click action configured for a

header or footer property. To check which fields are used in

building URLs in hr ef or t i t l eHref , look at the list and

zoom view XML files for resul t I temand its children. Also

check the act i onSet defined for the resul t I temdatasource or any child datasources.



Statistics Server


•

•

•

•

•

•

The Statistics Server is an add-on module. You can use the Autonomy BusinessConsole to view and generate reports on the data that Statistics Server collects.For more information, refer to the Autonomy Business Console User Guide.

Configure IUS Web to Use Statistics Server

Use the following procedure to configure IUS to send information to the StatisticsServer.

To conf igure IUS Web to send information to the statistics server

1. Open the \ Webr oot \ conf i g\ i us. pr oper t i es file.

2. In the i dol Ser ver . st at s. host and i dol Ser ver . stats. por t parameters, type the host and port number of the IDOL Statistics Serverrespectively.

The port must match the value of the Por t parameter in the Stat i st i csSer ver . cf g file.

3. Save and close the file.

4. Restart the IUS Web application pool.

Install Statistics Server Service

The Deploy Tool installs Statistics Server to the following directory by default:

\ Aut onomy\ Uni ver sal Sear ch\ St at i st i cs Ser ver \

To install the Statistics Server service, double-click _i nst al l _ser vi ce. bat .

Start and Stop Statistics Server

To start the Statistics Server service, double-click _st ar t _ser vi ce. bat .

To stop the Statistics Server service, double-click _st op_ser vi ce. bat .

You can also start and stop the Statistics Server service on the Windows ServiceManagement Console.

Statistics Server Operations

For each search action, IUS Web sends two XML events to the statistics server:

Query Information. The event definition for general query information is in \conf i g\ dat amodel \ i us\ vi ews\ j son\ st at i st i cs\quer ySt at i st i cs. xml . You can add additional properties inside the<queryi nf o>tag, to collect on the server.





•

•

•

•

•

•

Promotion Information. The event definition for promotions is in \ conf i g\dat amodel \ i us\ vi ews\ j son\ st at i st i cs\pr omot i onSt at i st i cs. xml . You can add additional properties inside the

<promot i on>tag.

Statistics Server saves the data it gathers in the \ resul t s directory, in a series oftext files.

You can use the Autonomy Business Console to view and generate reports on thedata collected by the Statistics Server. For more information, refer to the

Autonomy Business Console User Guide.

Define Additional Events to Track

You can define additional events for Statistics Server to record statistics for.

To send additional XML events from different commands to the server

1. Identify the command you want to record. The command must have atemplate associated with it.

2. Design the XML event. For information, refer to the Autonomy BusinessConsole User Guide. You can use the quer ySt at i st i cs. xml andpr omot i onSt at i st i cs. xml files as examples.

3. Add a call to the updat eSt at i st i cs command of the stat i st i cs datasource into the template associated with the command. Refer to \conf i g\ dat amodel \ i us\ vi ews\ j son\ sear ch\queryResul t sDat a. xml and quer yI QL. xml .

4. Pass the path to your XML event file as the f i l e parameter. Also pass all theproperties you want to record in the XML event as <w: put . . . parameters.You can use variable expressions in the form ${. . . } in the XML event, butnot the <w: >tags. You can access these variable expressions in the XMLevent file by using ${propert yname}.

<w: i nvoke oper ati on="updat eSt at i st i cs" dat asour ce="s t at i st i cs"><w: put name="f i l e" val ue=" / j son/ st ati st i cs/mySt at i st i cs. xml "/ ><w: put name=. . . . . . . . . / >

</ w: i nvoke>

Taxonomy

The IUS Classification Package allows you to generate and display taxonomies ofthe data in IDOL. For more information, refer to the IUS Web Components

Administration Guide.



Taxonomy


•

•

•

•

•

•

To enable taxonomies in IUS, see “Enable the Category Component” on page 75 and “Set LanguageDirectory Path” on page 76.

For more information about creating taxonomies, refer to the IDOL Server Administration Guide.

For information about using Autonomy Collaborative Classifier (ACC) to createand manage taxonomies, refer to the Autonomy Collaborative Classifier UserGuide.

For information on backing up the taxonomy information, see “Back UpCategories, Taxonomies, and Cluster Jobs” on page 116.

Enable the Category Component

To use the Category component, your license key that allows the classification

functionality.

To enable the Category component

1. Open the I US I DOL. cf g configuration file in a text editor.

2. Find the Cl assi f i cat i on section.

3. Remove the comment marks (/ / ) from the configuration parameters in thissection.

/ / - - - - - - - - - - - - - - - - - - - - - - Cl assi f i cat i on - - - - - - - - - - - - - - - - - - - - - - / /[ Cl uster]Resul t Expi r yDays=30

Snapshot Expi r yDays=30SGExpi r yDays=30Downl oadDocAct i on=drecont ent s Ti t l eFr omSummar y=TRUESummar yFi el d=aut n: summar y

[ Taxonomy]MaxConcept s=100Rel evanceThr eshol d=20Di st r i but i onThr eshol d=10ConceptThr eshol d=400Mi nConcept Occs=15CompoundRel evance=40

Si bl i ngSt r engt h=20Mi nChi l dren=1Onl yMat chSubset =0MaxQNum=5000

http://backup.pdf/

http://backup.pdf/

http://backup.pdf/

http://backup.pdf/





•

•

•

•

•

•

Set LanguageDirectory Path

When you enable the Category component, you must ensure that theLanguageDi r ect ory parameters in the IUS IDOL configuration file specify anabsolute path to the l angf i l es directory. By default, it specifies a relative path(. / l angf i l es).

You must change the LanguageDi r ect ory parameter in the[ Di str i but i onSet t i ngs] and the [ LanguageTypes] configurationsections.

For example:

[ Di str i but i onSet t i ngs]Mi r r orMode=f al seDi st r i but i onMethod=1LanguageDi r ectory=C:\Program Files\Autonomy\Universal Search\IUS

IDOL\langfilesVi r t ual Dat abases=12

[ LanguageTypes]Def aul t LanguageType=engl i shUTF8Def aul t Encodi ng=UTF8LanguageDi r ectory=C:\Program Files\Autonomy\Universal Search\IUSIDOL\langfiles

Save the changes to I US I DOL. cf g, and then restart IUS IDOL.




•

•

•

•

•

•

CHAPTER 7

IUS Server MaintenanceThis chapter describes the common maintenance tasks for IUS Server.

Back Up the Index on a Schedule

Back Up the Index Manually

Back Up the Index Dynamically

Restore the Index

Reindex IUS Data

Export Users, Roles, Agents, and Profiles

Import Users, Roles, Agents, and Profiles

Back Up Categories, Taxonomies, and Cluster Jobs

Restore Categories, Taxonomies, and Cluster Jobs

Compact the Index

IMPORTANT This chapter describes the recommended procedures for

common IUS Server maintenance tasks such as index data backup, restore,and reindexing.

IDOL is a powerful platform that offers an array of actions and features that

allow alternative approaches to these tasks. However, these alternative

approaches often require an advanced knowledge of both the IUS and IDOL

architecture to implement. For more information, refer to the IDOL Server

Reference and product documentation.



Chapter 7 IUS Server Maintenance


•

•

•

•

•

•


HP Autonomy recommends that you configure a schedule to regularly back upyour index data. Additionally, start a backup schedule immediately after thecompletion of the initial Index.

To allow you to fully restore the IUS Server, you must back up the following items:

All IUS Server configuration files. These files define the configurationparameters for all IUS Server components.

All IUS Content index backups. These files contain the actual Index collection.

The following sections describe the backup requirements of each component.

If you have also deployed IUS Server, refer to the IUS Server Administration

Guide for information about backing up the IUS Server.

Determine the Optimum Backup Schedule

In general, you must schedule a backup at least once a month. The followingguidelines allow you to optimize the backup schedule for your deployment.

After you have deployed IUS Server in a production environment, you shouldcarry out the following steps.

Determine the average indexing throughput (documents per hour) during theinitial creation of the index.

Record the total number of documents and total number of committed

documents after the initial index is complete. You can find these documentcounts in the Index Browser.

Record the total number of hours needed to complete the initial index.

This data enables you to determine how often to perform a backup of IUS Server.

Find the Number of Documents Indexed

The Index Browser displays two important document counts:

documents: The number of unique documents indexed.

committed_documents: The number of all files indexed and written to disk(synchronized).

Both numbers increase as new documents are added to IUS, and are indexed byIUS Server. The committed_documents value also increases when an existingdocument is reindexed because it was modified or deleted.





•

•

•

•

•

•

After you run a DRECOMPACT index action, the number of committed documentsdecreases, because this action removes deleted documents from the index.

HP Autonomy recommends that you run a DRECOMPACT index action if thecommitted_documents value is 20% or more higher than the documents value.

Related Topics

“Compact the Index” on page 96

Track the Rate of Change

You can use document counts to find the rate of change of documents in IUSServer; that is, how many new, edited, or deleted documents are submitted to IUSServer every day, week, or month.

The rate of change influences how often you must perform backups.

Example Backup Scenario

Consider the following IUS Server scenario:

your IUS Server has an average rate of change of 100,000 documents perweek.

the rate of indexing during the initial build of the index was approximately100,000 documents per hour.

you schedule a backup once per month.

In the event of a failure, it takes approximately four hours for IUS Server toprocess the difference between the most recent backup and the documents thatwere added, modified, or deleted since the backup occurred.

During this four hour period, IUS Server returns search results more slowly,because of the requirements of the indexing process.

You might want to adjust the backup schedule if:

the performance of your hardware, or the rate of change of documents,indicates that you must back up the index more or less frequently.

you want to have a smaller difference between the current content in IUS andthe index backup, or conversely if a larger difference is acceptable.

Backup Schedule Considerations

When you set up a backup schedule, consider the following factors:

The time needed to complete the backup job for each Content server variesaccording to:





•

•

•

•

•

•

the size of the index

the compression level being used

the disk speed of the source and destination locationsBy default, the Content server compresses the backup files, so that they takeup approximately 30-40% of the total index data space. If you choose not tocompress the backup files (BackupCompressi on=f al se orBackupCompress i onLevel =0), estimate backup space that is at least aslarge as the size of the live index.

HP Autonomy does not recommend that you use a third party backup orsnapshot process to back up live index data, because this can interfere withthe indexing process.

HP Autonomy recommends backing up the index data by using the Content

scheduling parameters or the DREBACKUP index action to copy the index datato another location. You can then back up the resulting data files using yourstandard backup process or service.

If your IDOL storage is a SAN with disk-snapshot capabilities, you can use theDREFLUSHANDPAUSE index action to flush all files to disk and pause indexing,so that you can take a snapshot of the data.

For information on the DREBACKUP index action, see “Back Up the IndexManually” on page 83.

For information on the DREFLUSHANDPAUSE action, see “Back Up the IndexDynamically” on page 87

Schedule backup activity for off-peak hours to minimize user impact.

Back Up IUS Server Configuration Files on a Schedule

To back up the IUS Server configuration files, create a script or batch file that youcan schedule to copy the following files:

. . \ Uni ver sal Sear ch\ I US DI SH\ I US DI SH. cf g

. . \ Uni ver sal Sear ch\ I US I DOL\ I US I DOL. cf g

. . \ Uni ver sal Sear ch\ I US Cont ent n\ I US Cont ent N . c f g

. . \ Uni ver sal Sear ch\ I US OGS\ I US OGS. cf g

You can use a third-party package to automate the configuration file backup

process. You can also use a simple batch file, using the xcopy command and theWindows Scheduling Service. For example:

xcopy / s SourceDir \ * . cf g DestinationDir





•

•

•

•

•

•

Back Up the Content Index on a Schedule

The Content servers process and store the index data. In a deployment withmultiple Content servers, each server contains a subset of the index data. Youmust back up all Content servers to have a complete backup of the index.

To schedule the full index data backup, you must set the schedule parameters inthe configuration file for each IUS Content.

For information about backing up IUS Server content, refer to the IUS Server Administration Guide.

To configure the backup schedule for each IUS Content server

1. Open the IUS Content configuration file in a text editor.

2. Find the [ Schedul e] section, or add it if it does not exist.

3. Set the following parameters:

Backup Type true to enable a backup schedule.

BackupCompress i on Whether to compress the backup files. The default value is

t rue.

BackupCompress i onLevel

The severity of compression to apply. Specify a value from 0

(no compression, fastest) to 9 (maximum compression,

slowest). These values are equivalent to gzip compression

levels. The default value is 1.

BackupTi me The time to start the first backup. Specify the time in the

24-hour clock and the format hh: mm.

When you start IUS Server, the specified BackupI nterval

must elapse (after the specified BackupTi me) before the first

backup takes place.

BackupI nt erval The time between backups. Specify the time in the 24-hour

clock and the format hh: mm.

When you start IUS Server, the specified BackupI nterval

must elapse (after the specified BackupTi me) before the first

backup takes place. Type 0 to use daily backups.





•

•

•

•

•

•

The following parameters in the [ Schedul e] section apply to backup actionstriggered by a DRECOMPACT index action. See “Compact the Index” onpage 96.

For example:

[ Schedul e]Backup=t r ueBackupCompressi on=t r ue

BackupDi r N The path to the location in which to create the data index

backup. You must specify one directory for each of the

Number Of Backups.

BackupMai ntai nDi rStructure

Type true to maintain the directory structure when the data

index is backed up.

Number Of Backups The number of times to back up the data index. You can cycle

the backup procedure by specifying multiple backups. The

number of backups must correspond to the number of

BackupDi r N directories. When you run multiple backups:

IUS Server creates the first backup at the first

BackupI nt erval after the specified BackupTi me.

IUS Server creates the next backup after the specified

BackupI nt erval , and so on. After it has backed up the

data index as many times as you have specified for

Number Of Backups, it overwrites the first backup at the

next BackupI nterval . This process means you always

have a current set of data index backups.

Pr eCompact i onBackup

Back up key files before compacting. Type true to perform a

backup of key files automatically for every DRECOMPACT index

action sent from a Web browser or a schedule. IUS Server takes

this internal backup so that you can restore the data and files if an

error occurs during the compaction.

Type false if you do not want to back up before compacting (a

backup requires significant disk space). The default value is

f al se.

Pr eCompact i onBackupPat h

If you set Pr eCompact i onBackup to true, set

Pr eCompact i onBackupPat h to the path to the directory where

you want to back up the files. By default, this is the

i nt er nal backup directory in the IUS Content server data

directory.

If IUS Server shuts down without completing a compaction, it uses

the contents of this directory to restore itself.





•

•

•

•

•

•

BackupCompress i onLevel =1BackupTi me=03: 00BackupI nterval =168

BackupMai nt ai nSt r uct ure=t r ueNumber Of Backups=3BackupDi r 0=E: \ Dat aI ndex_Backup0BackupDi r 1=E: \ Dat aI ndex_Backup1BackupDi r 2=E: \ Dat aI ndex_Backup2

4. If you have more than one Content server, configure the [ Schedul e] sectionparameters for each Content sever.

5. Save and close the configuration files.

6. Restart each of the IUS Content services for the new settings to take effect.See “Start the IUS Services” on page 56.


This section describes how to back up IUS Server files manually.

If you have also deployed IUS Server, refer to the IUS Server Administrator’s

Guide for information about manually backing up the IUS Server.

Back Up IUS Server Configuration Files

When you back up the index, it is important to create backup copies of theconfiguration files in addition to the index data. HP Autonomy recommendsbacking up the configuration files at the following times:

After the completion of the initial Index crawl.

Before and after you modify the configuration files.

To back up the configuration files, make copies of the following files for each of the

IUS Server components:

InstallDir \ Uni ver sal Sear ch\ I US DI SH\ I US DI SH. cf gInstallDir \ Uni ver sal Sear ch\ I US I DOL\ I US I DOL. cf gInstallDir \ Uni ver sal Search\ I US Cont ent n\ I US Cont ent n. c f gInstallDir \ Uni ver sal Search\ I US OGS\ I US OGS. cf g

IMPORTANT You must change the destination location for each Content

server backup to avoid overwriting backup data.





•

•

•

•

•

•

Back Up the Index Data

The following sections describe how to export and back up the index data.

Send the DRESYNC Index Act ion

Before you perform a backup of the index data, you must commit all index datathat is cached in memory to disk.

To commit cached index data to disk

1. Send the following index action to flush data from the index cache to disk. Thisaction commits any documents currently held only in the index cache to disk:

ht t p: / / host name: 9001/ DRESYNC?

Make a note of the index ID for this process.

2. In the Index Browser, check that the DRESYNC process is complete.

a. Connect to port 10000.

b. From the Action menu, select Set Result Size to adjust the Result Size to 250.

c. Click Indexer Status (I ndexerGetSt atus action) to determine whenthe DRESYNC process for that ID is finished (st at us=- 1, descri pt i on

= Fi ni shed). For example:i d = 53or i gi n_i p = 127. 0. 0. 1. . .per centage_processed = 100st atus = - 1descr i pt i on = Fi ni shedi ndex_command = / DRESYNC?

Continue with “Send the DREBACKUP Index Action” on page 84.

Send the DREBACKUP Index Action

To back up the index data stored in each Content server, use the DREBACKUP index action.

HP Autonomy recommends backing up the index data before compacting the datausing the DRECOMPACT index action.

NOTE This section applies only to non-Active Content

deployments that do not use the SyncTool.





•

•

•

•

•

•

HP Autonomy does not recommend that you use a third party backup or snapshotprocess to back up live index data, because this can interfere with the indexingprocess. For information on scheduling backups see “Back Up the Index on a

Schedule”.

For a manual backup, HP Autonomy recommends using the DREBACKUP indexaction to copy the index data to another location. You can then back up theresulting data files using your standard backup process or service.

Because each IUS Content stores a subset of the index, you must send theDREBACKUP individually to each Content server.

To manually back up the index

For each Content server, send the following index action (case sensitive) fromyour Web browser:

ht tp : / / host: indexPort/ DREBACKUP? path

where,

For example, if you have two Content servers, using the default values for theI ndexPor t (for example, Content1: 11001, Content2: 12001), the DREBACKUP index actions are:

ht t p: / / 127. 0. 0. 1: 11001/ DREBACKUP?E: \ backup\ cont ent 1

ht t p: / / 127. 0. 0. 1: 12001/ DREBACKUP?E: \ backup\ cont ent 2

In this example, the backup of IUS Content1 is stored in E: \ backup\ cont ent 1

and the backup of IUS Content2 is stored in E: \ backup\ cont ent 2.

You must have a backup copy of all Content servers to restore the complete indexcollection.

host is the IP address or host name of the machine where the target

Content server is installed.

indexPort is the index port used by the receiving Content server

(specified by the I ndexPort parameter in the I USCont entN . c f g file [ Ser ver ] section).

path is the location where you want to create the IUS Content

backup. On Microsoft Windows, you can use a UNC path. If you

have more than one Content server, remember to specify a

different path location for each Content backup.





•

•

•

•

•

•

Verify the Backup

To verify that the DREBACKUP index action was processed, review theappl i cat i on. l og for each Content server (located in the InstallDir \Uni ver sal Sear ch\ I US Cont ent N \ Logs directory). Eachappl i cat i on. l og file contains a message to indicate the start of the backup,for example:

Backi ng up dat abase i nt o exi st i ng di r ect ory ' E: \ backup\ cont ent 1'

After the backup is complete, the appl i cat i on. l og also logs a "BackupCompl et e" message.

You can also verify that the backup is complete from the Index Browser.

To verify the backup from the Index Browser

1. Start Index Browser.

2. Connect to the ACI port for each Content server (specified by the Por t parameter in the [ Ser ver ] section of each I US Cont ent N . c f g file).

3. Click Indexer Status.

If the DREBACKUP index action is complete, it appears in the result set withSt atus = - 1 and Descr i pt i on = Fi ni shed.

For example:

TIP To see the results, you might need to set the Result Size to 250 in the

Index Browser. From the Action menu, select Set Result Size.





•

•

•

•

•

•

The time needed to complete the backup for each Content server variesaccording to the size of the index, and the disk speed of the source anddestination locations. Because the backup is effectively a copy of the Content, HP

Autonomy recommends that you estimate backup space that is at least equivalentto the size of the live Index.

Back up data during off-peak hours to minimize user impact.


This section describes how to back up IUS Server files dynamically.

Back Up the Index Data

The following section describes how to make a hot backup of the index data.

Send the DREFLUSHANDPAUSE Index Action

If your IDOL storage is a SAN with disk-snapshot capabilities, you can use theDREFLUSHANDPAUSE index action to prepare IDOL Server for a snapshot (hotbackup). IDOL Server flushes all files to disk and pauses indexing, so that you cantake a snapshot of the data.

Because each IUS Content stores a subset of the index, you must send theDREFLUSHANDPAUSE individually to each Content server.

After sending the index action, poll IDOL Server with the I ndexerGetSt at us action until the returned status is -16 (Indexing Paused). You can then perform thesnapshot.

After the hot backup completes, restart the index queue with theI ndexerGetSt at us action and with the index ID returned fromDREFLUSHANDPAUSE.

Restore the Index

The following components are required for a successful restore: IUS Server Components. If a hardware or operating system failure requires

reinstallation of IUS Server, reinstall and redeploy IUS Server using theprocedures in “Install IUS Server” on page 31 and “Configure IUS Server” onpage 35.





•

•

•

•

•

•

IUS Server Configuration Files. If recovery of the Index also included areinstallation of the software, restore backup copies of the IUS Serverconfiguration files to the appropriate locations to ensure consistency in

configuration between the new environment and the restored Index.

IUS Index Data Backup Files. The restoration of the index data requires thedata files generated during the Content server backup process. Tosuccessfully restore an index you must have valid backups of all Contentservers from the same backup point.

The following instructions assume that the necessary environment and backupfiles are available to complete the restore.

Related Topics

“Back Up the Index on a Schedule”

“Back Up the Index Manually”

Restore the IUS Server Configuration Files

When you have to reinstall IUS Server during recovery, restoring backup copies ofthe configuration files can save time, and ensure that the restored index containsall your custom configurations. When you restore configuration files to a systemthat is not identical to the original environment, you might need to modify theconfiguration to use machine specific parameters and path values.

To restore IUS Server configuration files, replace the configuration file for each ofthe IUS Server components with the backup copy to the appropriate location:

InstallDir \ Uni ver sal Search\ I US DI SH\ I US DI SH. cf gInstallDir \ Uni ver sal Search\ I US I DOL\ I US I DOL. cf gInstallDir \ Uni ver sal Search\ I US Cont ent n\ I US Cont ent n. c f gInstallDir \ Uni ver sal Search\ I US OGS\ I US OGS. cf g

Restore the Index Data

The index data is stored in the IUS Content servers. Because each IUS Contentstores a subset of the index data, you must restore each individual IUS Content tosuccessfully restore the full index.

To restore a data index to IUS Server

Send a DREI NI TI AL index action (case sensitive) from your Web browser:

NOTE The IUS Content services must be running when you send the data

restore action.



Restore the Index


•

•

•

•

•

•

ht tp : / / host: indexPort/ DREI NI TI AL? path

where,

When you run the DREI NI TI AL index action the IUS Content services must berunning.

For example, if you have two Content servers, using the default values for theI ndexPor t (for example, Content1: 11001, Content2: 12001), the DREI NI TI AL index actions are:

ht t p: / / 127. 0. 0. 1: 11001/ DREI NI TI AL?E: \ backup\ cont ent 1

ht t p: / / 127. 0. 0. 1: 12001/ DREI NI TI AL?E: \ backup\ cont ent 2

In this example, IUS Content1 is restored from backup files at E: \ backup\cont ent 1 to the IUS Content1 server on a server with the IP address 127.0.0.1.IUS Content2 is restored from backup files on E: \ backup\ cont ent 2 to the IUSContent2 server on a server with the IP address 127.0.0.1.

Verify the Restore Process

To verify that the DREI NI TI AL index action to restore each content wasprocessed, review the appl i cat i on. l og for each Content server (located inthe l ogs directory). Each appl i cat i on. l og contains a message to indicatethe start the restoration, for example:

I ni t i al i si ng. . . . ....Recover i ng f r om backup. . .

host is the IP address or host name of the machine on which the

Content server is installed.

indexPort is the index port of the Content server (specified by the

I ndexPort parameter in the I US Content N . cf g file

[ Ser ver ] section).

path is the path to the IUS Content backup. On Windows, you can

use a UNC path.

IMPORTANT You must restore copies of all Content servers to restore the

complete index.

You cannot restore the backup from one Content server to a different

Content server.





•

•

•

•

•

•

After the restoration process is complete, the appl i cat i on. l og for eachContent server contains the following log entry:

St ar t i ng database wi t h NNN Document s

You can also use the Index Browser to verify that the backup is restored.

To ensure that the restore is successful

1. Start Index Browser and connect to the service port for each Content server(specified by the Por t parameter in the [ Ser ver ] section of eachI USCont ent N . c f g file).

2. Click Indexer Status.

If the DREI NI TI AL action has been completed, it is displayed in the result setwith St atus = - 1 and Descr i pt i on = Fi ni shed.

For example:

Restoration ConsiderationsThe time needed to complete the restoration job for each Content variesaccording to the size of the index as well as the disk speed of the source anddestination locations.

TIP To see the results you might need to set the Result Size to 250 in the

Index Browser. From the Action menu, select Set Result Size.



Reindex IUS Data


•

•

•

•

•

•

HP Autonomy does not recommend that you use a third party backup or snapshotprocess to back up or restore live index data, because this can interfere with theindexing process. Similarly, restoring the index data using a method other than the

DREI NI TI AL index action can result in an index that is not valid.

Reindex IUS Data

The following procedure describes how to reindex the data stored in IUS Server.Follow this process when you make a configuration change to IUS that requires arebuild of the index data.

If you are also running IUS Server with IUS, refer to the IUS Web AdministrationGuide for instructions for reindexing IUS data.

To reindex IUS Server

1. Stop all IUS Server services. For more information, refer to the IUS Server Administration Guide.

2. Make a note of the number of documents in each IUS database by sending aGETSTATUS action.

ht tp : / / hostname: 10000/ a=GETSTATUS

Alternatively, in the Index Browser, click Get Status.

3. In the Index Browser, check that there are no indexing jobs in the queue, orthat are pending being flushed to disk. Send the following actions in the Actiontext box:

I ndexer GetSt atus&I ndexSt at us=- 7

I ndexer GetSt atus&I ndexSt at us=- 34

If any results return, wait and perform the same actions again. Proceed to thenext step only when the action does not return any results.

4. Send the following index action to force an immediate flush to disk from theindex cache:

htt p: / / host name: 10001/ DRESYNC?

Make a note of the index ID reported for this process.

5. In the Index Browser, click Indexer Status (I ndexerGetSt atus action) todetermine when the DRESYNC process for that ID is finished (St at us=- 1,Descr i pt i on = Fi ni shed).

The output of the IUS Content server Index log also shows when the DRESYNC process is completed. For example:





•

•

•

•

•

•

I ndex Queue Command: / DRESYNC?I ndex Queue Command: DRESYNC?Sync Mapped Fi l es. . .

Commi t t i ng numeri c f i el d 45 to di sk.Commi t t i ng numeri c f i el d 46 to di sk.Commi t t i ng numeri c f i el d 47 to di sk.. . . . .Sync Mapped Fi l es. . . Compl eted

6. After the DRESYNC is complete, send a DREEXPORTI DX action to exportindexed data to a compressed data file (. gz) in each IUS Content directory.

ht t p: / / hostname: 10001/ DREEXPORTI DX?

Ensure that a . gz file is created in each IUS Content directory. Make a note ofthe name of the . gz file.

7. Stop the IUS Content services and the IUS IDOL service. The OGS and DiSHservices can remain running.

8. If you are making a configuration change, back up the existing configurationfiles, and then modify the appropriate configuration files.

9. Disable E-mail Alerts in IUS (if enabled) to prevent IUS from generating alertswhile it reindexes data.

10. In the IUS IDOL configuration file, find the [ I ndexTask] section.

a. Set the St ar t Task to Eduction, instead of AlertTask. For example:

St art Task=Educt i on

Remember to enable this functionality after reindexing is complete.11. Start the IUS IDOL service and IUS Content services to activate your

configuration changes.

12. Send a DREI NI TI AL index action to delete the old indexed data. Forexample:

ht t p: / / hostname: 10001/ DREI NI TI AL?

NOTE If you do not want to export data from all IUS

Server databases, use the Dat abaseMat ch parameter.

For example, to export data from the newyor k and

l ondon databases, use the following index action:

ht t p: / / hostname: 10001/DREEXPORTI DX?Dat abaseMat ch=newyor k, l ondon

Separate multiple databases with plus symbols (+),

commas (, ), or spaces (there must be no space before

or after a plus symbol or comma).





•

•

•

•

•

•

13. Send a DREADD index action to the index port of each IUS Content service toreindex the exported IDX files. You must specify the data archive file in theindex action. The index port must be the value of the I ndexPor t parameter

in the Content configuration file.The following example reindexes the . gz file stored in the Content1 directoryto the Content1 service using port 21001:

ht tp : / / hostname: 21001/ DREADD?C: \ Progr am Fi l es\ Autonomy\Uni ver sal Sear ch\ I US Cont ent 1\AUTN- I DX- EXPORT- hostname. domain. com- 22000- 21. 08. 2009- 10. 46. 42- 0. i dx. gz

If you exported data from specific databases using the Dat abaseMat ch parameter, restore that data to those specific databases:

ht tp : / / hostname: 21001/ DREADD?C: \ Progr am Fi l es\ Autonomy\

Uni ver sal Sear ch\ I US Cont ent 1\AUTN- I DX- EXPORT- hostname. domain. com- 22000- 21. 08. 2010- 01. 46. 42- 0. i dx. gz&DREDbName=newyor k, l ondon

14. Repeat this step for each IUS Content you have deployed, reindexing thearchived data to the Content index port. The default ports for IUS are:Content1: 21001, Content2: 22001, Content3: 23001, Content4: 24001, andso on.

15. Monitor the number of documents in each Indexer database by sending aGetSt atus action or by connecting with Index Browser.

16. Start the IUS Server services using the st ar t _i ndexer . bat file.


You can export IUS Server users, roles, agents, and profiles to a specified XMLfile, from which you can import them back into IUS Server. You can use thisaction, for example, to transfer IUS Server to a different platform.

To export users, roles, agents, and profiles, send the following action to IUSServer:

ht t p: / / IDOLhost: ACIPort/ act i on=Export &Expor t Fi l eName=fileName





•

•

•

•

•

•

where,

For example:

ht t p: / / 12. 3. 4. 56: 10000/ act i on=Export &Expor t Fi l eName=MyFi l e. xml

This action uses port 10000 to export IUS Server users, roles, agents, and profilesto the MyFi l e. xml file.

Import Users, Roles, Agents, and Profiles

You can import IUS Server users, roles, agents, and profiles from a specified XMLfile (into which you have previously exported them from an IUS Server using theExpor t action). You can use this action, for example, to transfer IUS Server to adifferent platform.

To import users, roles, agents, and profiles, send the following action to IUS

Server:

ht tp : / / hostname: ACIPort/act i on=I mpor t &I mpor t Fi l eName=fileName&UserFi el ds=fieldCSV

where,

IDOLhost is the IP address or host name of the machine on which IUS Server is

installed.

ACIPort is the IUS IDOL ACI port (the value of Por t in the IUS IDOL

configuration file [ Ser ver ] section). The default port is 10000.

fileName is the name of the XML file to export IUS Server users, roles, agents,

and profiles to. If you do not specify a path, it generates the XML file in

the / I US I DOL/ communi t y directory.

hostname is the IP address or host name of the machine on which IUS Server is

installed.

ACIPort is the IUS IDOL ACI port (the value of Por t in the IUS IDOL

configuration file’s [ Ser ver ] section).The default port is 10000.

fileName is the name of the XML file that contains the users, roles, agents, and

profiles to import. If the XML file is not stored in the / I US I DOL/communi t y directory, specify the path to the file as well.

fieldCSV (optional) enables you to restrict the import of user fields by specifying

a wild card list of fields to import. Separate multiple fields with commas

(there must be no space before or after a comma). Only user fields that

match a listed field are imported.





•

•

•

•

•

•

For example:

htt p: / / 12. 3. 4. 56: 10000/ act i on=I mpor t &I mport Fi l eName=MyFi l e. xml

This index action uses port 10000 to import IUS Server users, roles, agents, andprofiles from the MyFi l e. xml file.


Use this procedure to back up IUS Server categories, taxonomies, and cluster jobs (snapshots, cluster results, and spectrographs).

To back up categories, taxonomies, and cluster jobs

1. Open the IUS IDOL configuration file in a text editor.2. In the [ Ser ver ] section, set the BackupDi r parameter to the directory into

which you want to store the backups. For example:

BackupDi r =C: \ Autonomy\ I US\serviceAlias\ cat egory\ Backup

3. Save and close the configuration file.

4. Restart IUS IDOL.

5. Run a Backup action to back up your categories, taxonomies, and cluster jobsto the specified BackupDi r :

ht tp : / / hostname: port/ act i on=Backup

where,

For example:

ht t p: / / 12. 3. 4. 56: 10000/ act i on=Backup

A .BAK file is generated in the specified BackupDi r .To restore backed-up data, use the Rest or e action.

hostname is the IP address or host name of the machine on which IUS

Server is installed.

port is the IUS IDOL ACI port (the value of the Por t parameter in the

Server configuration section).





•

•

•

•

•

•

Restore Categories, Taxonomies, and Cluster Jobs

To restore backups of categories, taxonomies, and cluster jobs that the Backup action created, run a Rest or e action. The backup is restored from the specifiedBackupDi r .

ht tp : / / hostname: port/ act i on=Rest or e

where,

Compact the Index

The DRECOMPACT index action is a maintenance activity that enables you toremove unnecessary index data overhead that accrues over time due todocument deletions, modifications, and duplications. This action is similar to thedefragmentation process for disk drives, or DBCC jobs for a SQL database. Youmust run the DRECOMPACT index action as a regular maintenance task to optimizeperformance and disk usage by the IUS Server.

HP Autonomy recommends that you run a DRECOMPACT action:

as a regular maintenance task. You can increase or decrease the frequency ofthis task according to the activity of your site.

NOTE While IUS Server is processing a Backup action you cannot add,

change, or remove categories, or run cluster jobs. You can still run actions

that do not affect the data being backed up, for example,Cl ust er Resul t s , Cl ust erSGDat aServe, and Cat egor yQuer y.

hostname is the IP address or host name of the machine on which IUS Server is

installed.

port is the IUS IDOL ACI port (the value of the Por t parameter in the

Ser ver configuration section).

NOTE While IUS Server is processing a Rest ore action, you cannot run

any category, cluster, or taxonomy actions.



Compact the Index


•

•

•

•

•

•

In general, refer to the number of documents and committed documents ineach Content server. HP Autonomy recommends that you compact data whenthe number of committed documents reaches 120% of the number of

documents. after you delete a large batch of files from the IUS repository.

after you archive a large batch of files from the IUS repository.

after you selectively reindex a large batch of files from the IUS repository.

Important Considerations

The DRECOMPACT is similar to a DREBACKUP in terms of its impact on IUS Server.You must consider the following points when you run this index action.

The time needed to complete the compact job for each Content server variesaccording to the size of the index, and the speed of the disk hosting thecontent.

The amount of disk space needed to complete the compact job for eachContent server varies according to the size of the index and the level offragmentation. As a guideline, HP Autonomy recommends that you have freespace up to, and possibly exceeding, the size of the Content server targetedfor compaction.

Users cannot receive search results from the Content Engine when aDRECOMPACT is running. You must therefore schedule DRECOMPACT activityfor off-peak hours to minimize user impact.

HP Autonomy recommends performing a full backup of the index data beforerunning the DRECOMPACT.

By default, the DRECOMPACT index action automatically copies the data indexto a directory in the Content server data directory. If there is not enough diskspace on the IUS Content drive, you can change this directory by setting the

Pr eCompact i onBackupPath configuration parameter. For more information

about this configuration parameter, see “Back Up the Content Index on aSchedule” on page 81.

IMPORTANT You must ensure that you have a current

backup before running the DRECOMPACT action.





•

•

•

•

•

•

Compact the Index Data on a Schedule

Use the following procedure to configure a schedule for compacting your indexdata. HP Autonomy recommends that you run a backup before you compact yourdata. See “Back Up the Content Index on a Schedule” on page 81.

To set up a schedule for compaction

1. Open the Content server configuration file in a text editor.

2. Find the [ Schedul e] section. If the configuration file does not contain a[ Schedul e] section, add one.

3. Set the following parameters in the [ Schedul e] section:

For example:

[ Schedul e]Compact =t r ueCompact Ti me=01: 00Compact I nterval =168

This configures a compaction every 168 hours (once a week) at 1:00 a.m.

4. Save and close the configuration file.

5. Restart the Content server for your changes to take effect.

6. Repeat Step 1 to Step 5 for all your Content servers.

Compact Type true to enable a compacting schedule.

Compact Ti me The time (hh: mm) when you want the Compactoperation to start.

Compact I nterval The number of hours between DRECOMPACT

operations. Specify the time in the 24-hour clock and

the format hh: mm.

When you start IUS Server, the specified

Compact I nterval must elapse (after the specified

Compact Ti me) before the first DRECOMPACT

operation takes place. Type 0 to schedule daily

compactions.



Compact the Index


•

•

•

•

•

•

Manually Compact the Index Data

To compact the index data immediately, send a DRECOMPACT index action (casesensitive) from your Web browser:

ht tp : / / host: indexPort/ DRECOMPACT

where,

Make a note of the I NDEXI D number returned to your browser.

For example, if you have two Content servers, using the default values for theIndexPort (for example, Content1: 11001, Content2: 12001), the DRECOMPACT index actions are:

htt p: / / 127. 0. 0. 1: 11001/ DRECOMPACT

htt p: / / 127. 0. 0. 1: 12001/ DRECOMPACT

In this example, the Content servers located on a machine with the IP address127.0.0.1 (local host) are compacted.

The compaction is complete when the I ndexerGetSt atus action reports that

the job (I NDEXI D number) is finished (st at us=- 1, descr i pt i on =Fi ni shed).

host is the IP address or host name of the machine on which IUS

Server is installed.

indexPort is the index port used by each Content server (specified by

the I ndexPort parameter in the I US Content N . c f g file

[ Ser ver ] section).





•

•

•

•

•

•




•

•

•

•

•

•

CHAPTER 8

Troubleshoot IUSTo troubleshoot IUS, consult the log files that it creates. The entries in these filesprovide you with details of possible problems or misconfigurations. You can usethem to identify and correct configuration errors.

IUS Server Log Files

This section describes the log files that different IUS Server components create,and the information that the logs contain.

IUS IDOL Logs

The default location of the IUS IDOL log directory is:

C: \ Pr ogr am Fi l es\ Aut onomy\ Uni ver sal Search\ I US I DOL\ l ogs\

Table 4 IUS IDOL log files

Log file Description

appl i cat i on. l og Logs general application errors, warnings and

information relating to IUS IDOL service.

dah_appl i cat i on. l og Logs general application errors, warnings and

information relating to the DAH service.

di h_appl i cat i on. l og Logs general application errors, warnings and

information relating to the DAH service.



Chapter 8 Troubleshoot IUS


•

•

•

•

•

•

IUS Content Logs

The default location of the IUS Content log directory is:

C: \ Progr amFi l es\ Aut onomy\ Uni ver sal Sear ch\ I US Cont ent \ l ogs\

IUS OGS Logs

The default location of the IUS OGS log directory is:

C: \ Progr amFi l es\ Aut onomy\ Uni ver sal Sear ch\ I US OGS\ l ogs\

di h_i ndex. l og Logs the status of the connection with the DistributedIndex Handler service.

di h_quer y. l og Logs queries submitted using the Distributed Index

Handler service.

i mpor t . l og Logs status of all files imported into the IUS Server.

i ndexer . l og Logs the index actions that IDOL server receives.

Table 4 IUS IDOL log files


Table 5 IUS Content log files


appl i cat i on. l og Logs general application errors, warnings and information

relating to indexes.

i ndex. l og Logs the index actions that WorkSite Indexer receives.

quer y. l og Logs all the requests that WorkSite Indexer receives.

Table 6 OGS log files



relating to the OGS service.

j ob. l og Logs the user and group information processed by OGS.



IUS Server Log Files


•

•

•

•

•

•

IUS DiSH Logs

The default location of the DiSH log directory is:

C: \ Pr ogr am Fi l es\ Aut onomy\ Uni ver sal Search\ I US DI SH\ l ogs\

Table 7 DISH Log Files



relating to the DiSH service.

l i censeser ver . l og Logs the status of the loading of the license key, and the

products, functionality, and languages included in your

license.



Chapter 8 Troubleshoot IUS


•

•

•

•

•

•




•

•

•

•

•

•

Glossary

A

ABC Autonomy Business Console. The ABC application allows you to manage

content in IDOL server, and to modify how it responds to queries. You can set

up promotions to highlight specific content, or use synonyms to allow users

to retrieve conceptually related documents. ABC also manages the results

from the Statistics Server.

ACC Autonomy Collaborative Classifier. The ACC application allows you to set up

taxonomies of your data.

ACL Access Control List. In document security, ACLs contain information about

what users or groups of users can access a particular document.

access control list See ACL.

agent A process that searches for information about a specific topic.

Agentstore component The Agentstore component stores agents, and processes requests thatmatch agents to incoming documents.

alert Users can set up alerts to send them an e-mail when there is new content

that matches one of their saved searches.

automatic query guidance Automatic query guidance provides a list of terms that relate to a search, so

that users can make their search more specific. In IUS, this function is also

called Related Concepts.

Autonomy Business

Console

See ABC.

Autonomy Collaborative

Classifier

See ACC.

auto suggest Auto suggest provides type-ahead suggestions for users, while they are

typing a search. It provides common searches that match the search they are

typing.



Glossary


•

•

•

•

•

•

C

captions A caption is a text title or description for a part of the IUS user interface. You

define captions in a configuration file, which allows you to describe captions

in multiple languages for localization.

categories A category is a concept or set of concepts that you can use to group

documents. You define a category with text, query expressions, or

documents that describe the concepts for the category. IDOL server can

automatically match documents to your categories.

categorization IDOL server can analyze incoming documents and match the concepts to

your categories. This process is called categorization.

Category component The Category component analyzes the data in IDOL server and can

automatically tag documents with matching categories from a pre-definedlist. It can also analyze the concepts in documents and group related

documents in clusters, which you can use to analyze data or to create

categories.

classification Classification is the process of matching documents to categories or clusters.

The Category component performs classification on documents.

cluster A cluster is a group of conceptually related documents. The IDOL server

Category component can automatically divide a set of documents into

clusters of related documents. You can use the clusters to analyze concepts

in documents, or to create categories.

Community component The Community component stores information about IDOL server users. It

also manages the agents and profiles that are stored in the Agentstore

component.

connector Autonomy Connectors retrieve data from a repository (for example, your file

system, a Web site, or a database) and converts it to IDX or XML format,

which you can index into IDOL server. HP Autonomy has a large selection of

connectors to get documents from different repositories.

Content component The Content component is the store for content in IDOL server, and it also

processes search requests.



D


•

•

•

•

•

•

D

DAH Distributed Action Handler. The DAH server distributes actions (such as

search requests) between multiple IDOL servers, or Content components. In

IUS, content is generally distributed over multiple Content components. DAH

gets results from all the Content components, and combines them into a

single results list.

database IDOL Server stores data in databases. You can configure IDOL server to

store different sets of data in different databases. You can search for results

in one database, or across all databases.

deploy tool The IUS Server deploy tool is an application that allows you to configure and

install your IUS deployment. You can use it to customize your deployment,

and then it creates the configuration files for your options, and installs the

necessary components.

Distributed Action Handler See DAH.

Distributed Index Handler See DIH.

DIH Distributed Index Handler. The DIH server distributed index actions between

multiple IDOL servers or Content components. In IUS, it generally distributes

content to multiple Content components, so that each processes only a small

quantity of the whole dataset.

DiSH Distributed Service Handler. The DiSH server controls licensing for HP

Autonomy products. It has access to a license key, which containsinformation about all the licenses that you have available. When a product

requests a license, DiSH returns information about what components and

functionality are licensed.

Distributed Service

Handler (DiSH)

See DiSH.

DRECONTENT DRECONTENT is a field in index documents that contains the main content of

the document.

E

Eduction The Eduction process extracts entities from document text, and adds them

into a document field. The IUS interface allows you to view a list of extracted

entities in a document and search for other documents that contain those

entities.



Glossary


•

•

•

•

•

•

entities An entity is a word, phrase, or block of information, defined by a pattern. The

pattern can be a list of words, such as people or place names, or it can be an

expression that describes what an entity looks like without listing it explicitly

(for example, to match a telephone number or address).

F

fields IDOL server stores data in fields. Different fields can contain different type of

data, for example document content or metadata. IDOL server can process

different fields in different ways to optimize data retrieval.

I

IDOL Server The HP Autonomy Intelligent Data Operating Layer (IDOL) server, which

integrates unstructured, semi-structured and structured information from

multiple repositories through an understanding of the content, delivering a

real time environment in which operations across applications and content

are automated, removing all the manual processes involved in getting the

right information to the right people at the right time.

IDX A structured file format that can be indexed into IDOL server. Connectors

import files into this format for indexing.

iManage Universal Search See IUS.

index The content stored in IDOL server is the data index.

indexing The process of storing content in IDOL server.

IUS iManage Universal Search Server. IUS is a search user interface. IUS

enables end users to quickly sift through massive amounts of unstructured

and structured content in WorkSite and external repositories to find the most

relevant results through the use of natural language queries.

IUS Server iManage Universal Search Server. IUS Server includes IDOL server and all

the IDOL components that collect and index data for IUS.

For more information, refer to the IUS Server Administration Guide.

IUS Web iManage Universal Search Web Components. The Web application and userinterface that users can access to search for content in IUS.



O


•

•

•

•

•

•

O

OGS OmniGroup Server. OGS manages document security for IUS and IDOL

server. When a user tries to access a document, OGS compares the ACL of

the document with the permissions for the user, and ensures that users can

only retrieve documents that they have permission to see.

OmniGroupServer See OGS.

P

parametric fields Parametric fields are fields that contain values that can be used as search

filters. These fields often contain a restricted set of values, for a property that

users often want to restrict, for example a document source or type.

profiles Information about a user, which is based on the concepts in documents hat

the user reads. Every time a user opens a document, IDOL server updates

their profile. This process allows the administrator to bring new documents to

users attention that match the interests in their profiles.

Q

QMS Query Manipulation Server. QMS manipulates queries that you send to IDOL

server. It can return a promotion, modify the query (for example to add

synonyms), or manipulate the results (for example to return a specific result

higher up the results list).

query filters Query filters allow users to restrict a search by pre-defined categories. IUS

displays the list of query filters, and users can select one or more filter to

restrict search results to documents that match the filter criteria.

query manipulation server See QMS.

R

real time predictive query When a user types a search in IUS, IUS can automatically return a list of

searches that match what the user is typing. The user can then select one of

these searches to perform. This process is real time predictive querying.

S

spotlighting Spotlighting promotes a specific item in IUS. You can configure spotlights

such that when users search for specific keywords, a promotion item is

displayed at the top of the results list.



Glossary


•

•

•

•

•

•

Statistics Server Statistics server is an IDOL component that can monitor events and return

statistics about those events.

T

taxonomy An automatically created hierarchical structure of clusters of other

information. A taxonomy provides you with an overview of the information

landscape and an insight into specific areas of the information.

W

WorkSite WorkSite is a document management system, which stores and tracks all

content, and allows authorized users to access content from any location.

WorkSite Indexer WorkSite Indexer is a server that includes all the IDOL components requiredto collect, index, and store data from WorkSite.




•

•

•

•

•

•

Index

A

ACC

create taxonomies 75

ACIPort configuration parameter 94

actions

Backup 95

DREBACKUP 84DREFLUSHANDPAUSE 87

Export 93

Import 94

Restore 96

agent database

overview 28

agent query 21

agents

export 93

import 94

alertsconfigure 66

create template 67

e-mail address 66

e-mail template 67

alerttask

disable 56

enable 57

antivirus

recommendations 28

AQG 18

audio databaseoverview 29

automatic query guidance. See AQG

Autonomy Collaborative Classifier. See ACC.

autpassw.exe

encrypt passwords 48

B

back up 87

categories, taxonomies, and cluster jobs 95, 96

configuration file 80, 83

considerations 79, 90

content index 81

data index 84, 87dynamically 87

example 79

index 78

index data 84, 87

manually 83

optimum schedule 78

restore configuration file 88

restore index data 88

taxonomies 95

validate restore 89

verify 86Backup action 95

Backup configuration parameter 81

BackupCompression configuration parameter 81

BackupCompressionLevel configuration parameter 81

BackupDir N configuration parameter 82

BackupInterval configuration parameter 81

BackupMaintainDirStructure configuration parameter 82

BackupTime configuration parameter 81

best practicesidentify workspaces 62

taxonomy tree 61

C

categories 96



Index


•

•

•

•

•

•

back up 95, 96

categorization package 18

category

enable 75category query 21

classification

taxonomies 74

classification package 18

clients database

overview 29

cluster jobs

back up 95, 96

restore 96

committed documents 78

community 18

community query 21

compact

considerations 97

data index 96

manually 99

schedule 98

components

category 75

connectors 20

IUS 19

configuration file

back up 80

restore 88

configuration parameters

ACIPort 94

Backup 81

BackupCompression 81

BackupCompressionLevel 81

BackupDir N 82

BackupInterval 81

BackupMaintainDirStructure 82

BackupTime 81

NumberOfBackups 82

Port 95, 96

PreCompactionBackup 82

PreCompactionBackupPath 82

configure

advanced configuration 61

Category component 75

deploy tool 35

e-mail alerts 66IDOL 53

IUS Web to use statistics server 73

languages 76

promotions 69

search term highlighting 72

spotlighting 69

spotlighting documents 69

statistics server 72

WorkSite Indexer services 60

WorkSite server 60

connectors 20

Content

IUS Content 20

logs 102

content

back up 81

courtcases database 29

create

statistics 74

XML events 74

D

DAH

IUS IDOL 19

data

compact index 96

compact schedule 98

manually compact 99

databases

agent 28

audio 29

clients 29courtcases 29

documents 29

federalcases 29

IQLRules 28

KMCache 28

matters 29



E


•

•

•

•

•

•

overview 28

people 29

PLC 29

video 29datasources.xml

limit workspaces to display 64

define

best practice workspace 62

XML events 74

deploy

IUS Server 36, 38

WorkSite Indexer 38

deploy tool

deploy IUS server 36

overview 35

deployment

hardware 25

size 23

DIH

IUS IDOL 20

disable

alerttask 56

user account control 31

Windows Server 2008 32

Windows Server 2008 R2 32

DiSH

IUS DiSH 20

licenses 27

logs 103

display

limit displayed workspaces 64

Distributed Action Handler. See DAH.

Distributed Index Handler. See DIH.

Distributed Service Handler. See DiSH.

document counts 78

documents

in index 78

rate of change 79

re-index 63

spotlight 69

documents database

overview 29

DREADD 93

DREBACKUP 80, 97

run 84

DRECOMPACT 79, 82, 96, 99considerations 97

DREEXPORTIDX 92

DREFLUSHANDPAUSE

run 87

DREINITIAL 89, 90, 92

DRESYNC 84, 91

E

e-mail alerts

address 66configure 66

create template 67

template 67

enable alerttask 57

encrypt

passwords with autpassw.exe 48

events


experts 18

export

agents 93profiles 93

roles 93

users 93

Export action 93

F

federalcases database

overview 29

files

re-index 63

G

GETSTATUS 91



K


•

•

•

•

•

•

IQLRules database

create iqlrules file 70

overview 28

spotlighting 69IUS

architecture 19

components 19

configure language directory 76

configure statistics server 73

Content logs 102

deploy IUS Server 38

deploy WorkSite Indexer 38

DiSH 20

DiSH logs 103

enable Category 75

features 21

IDOL logs 101

install IUS server 32

install services 55

IUS Content 20

IUS IDOL 19

IUS Web component 20

log files 101

OGS logs 102

OmniGroupServer 20

overview 17

plan installation 23

prerequisites 24

reindex data 91

security 20

server databases 28

start all services 57

start individual servers 58

start services 56

Statistics server 20


statistics server operations 73

supported platforms 25

troubleshoot 101

IUS Server

advanced configuration 61

architecture 19

configuration 53

databases 28

deploy tool 35

install 32log files 101

move services 47

operations 55

overview 17

start services manually 58

uninstall 34

IUS server

deploy 36

stop services 58

K

KMCache database

overview 28

L

languages

configure 76

libraries

ODBC connections 47

licenses

overview 27

log files

IUS Server 101

logs

DiSH 103

IUS 101

IUS Content 102

IUS IDOL 101

IUS OGS 102

M

maintenance

tasks 77

matters database

overview 29

memory

guidelines 25



Index


•

•

•

•

•

•

move

IUS Server services 47


N

network

guidelines 26

NumberOfBackups configuration parameter 82

O

ODBC

connections to WorkSite libraries 47

create data source 49

ODBC System DSN 49

OGS

logs 102

OGS. See OmniGroupServer.

OmniGroupServer

IUS OmniGroupServer 20

operating system

guidelines 26

operations

IUS Server 55

P

page file

guidelines 27

people database

overview 29

plan

IUS installation 23

size of installation 23

platforms

support 25

PLC databaseoverview 29

Port configuration parameter 95, 96

PreCompactionBackup configuration parameter 82

PreCompactionBackupPath configuration parameter 82

preferences

e-mail address 66

prerequisites

antivirus 28

hardware 25IUS 24

processes

disable alerttask 56

enable alerttask 57

processors 25

guidelines 25

profile query 21

profiles

export 93

import 94

promotionstatistics 74

promotions

document spotlighting 69

Q

query

agent 21

category 21

community 21

overview 20profile 21

security 21

statistics 73

text 21

R

Real Time Predictive Query. See RPQ

record

statistics 74

re-index

documents 63

reindex

IUS data 91

relocate

IUS server services 47




S


•

•

•

•

•

•

requirements 25

antivirus 28

data storage 25

hardware 25memory 25

network 26

operating system 26

page file 26

virtualization 26

restore 96

categories 96

cluster jobs 96

configuration file 88

considerations 90

data 87

index 87

index data 88

taxonomies 96

verify 89

Restore action 96

roles

export 93

import 94

RPQ 18

run

DREBACKUP action 84

DREFLUSHANDPAUSE action 87

S

schedule

back ups 78

compact 98

search

highlight terms 72

security

agent query 21category query 21

community query 21

IUS 20

profile query 21

text query 21

services

install all services 55

install individual services 56

install manually 56

move 47start 56

start all services 57

start individual services 58

start manually 58

stop 58

shut down

IUS services 59

size installation

overview 23

spotlighting

configure 69

documents 69

IQLRules 69

start

all services 57

individual services 58

services manually 58


statistics

promotion 74

query 73

Statistics server

IUS Statistics server 20

statistics server

configure 72

configure in IUS Web 73

define events 74

install 73

operations 73

start 73

stop

IUS services 58

storage

guidelines 25

support

platforms 25



Index

T

taxonomies

back up

95

IDOL server 75

restore 96

taxonomy

back up 95, 96

classification 74

taxonomy tree

configure 61

templates

e-mail alerts 67

terms

highlight 72troubleshoot

IUS 101

U

UAC. See user account control

uninstall

IUS Server 34

user

e-mail address 66

user account control

disable 31

users

export 93

import 94

W

Web component

IUS Web

20

WorkSite

configure Indexer services 60

configure server 60

create ODBC connections 47

deploy Indexer 38

install Indexer services 60

limit workspaces 64

move Indexer services 47

re-index files 63

taxonomy tree 61

workspacesbest practice 62

limit display 64

X

XML events

define 74
