Professional Documents
Culture Documents
iManage Universal
Search Server
Administration Guide
Version 8.5 SP3
Document Revision 0
18 July 2013
Copyright Notice
Notice
This documentation is a proprietary product of Autonomy and is protected by copyright laws and international treaty. Information in this
documentation is subject to change without notice and does not represent a commitment on the part of Autonomy. While reasonable efforts have
been made to ensure the accuracy of the information contained herein, Autonomy assumes no liability for errors or omissions. No liability is
assumed 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 User
License Agreement, which the Licensee should read carefully before commencing use of the software. No part of this publication may be
reproduced, 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 are
strictly coincidental.
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 ftp://ftp.info-zip.org/pub/infozip/license.html; HTML-to-RTF Pro DLL 1.8 2002-2007 SautinSoft.
18 July 2013
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 1
Introduction ................................................................................................................................ 17
iManage Universal Search Server............................................................................................... 17
HP Autonomys IDOL Platform .................................................................................................... 19
IUS Architecture .......................................................................................................................... 19
Components ........................................................................................................................ 19
Additional Components ........................................................................................................ 20
Index and Query .................................................................................................................. 20
Security ................................................................................................................................ 20
Text Queries .................................................................................................................. 21
Agent, Profile and Category Queries ............................................................................. 21
Community Queries ....................................................................................................... 21
IUS Features ............................................................................................................................... 21
Contents
Chapter 2
Plan 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 3
Install 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 4
Configure IUS Server ............................................................................................................... 35
Configure IUS in the Indexer Deploy Tool ................................................................................... 35
Configure 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 5
IUS Server Operations ............................................................................................................ 55
Install IUS Services .................................................................................................................... 55
Install All Services ................................................................................................................ 55
Install Individual Services ..................................................................................................... 56
Install Individual Services Manually ...................................................................................... 56
Contents
Chapter 6
IUS Server Advanced Configuration ................................................................................. 61
WorkSite Taxonomy Tree ........................................................................................................... 61
Identify Best Practice Workspaces ....................................................................................... 62
Re-Index Best Practice Files ................................................................................................ 63
Configure 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 7
IUS 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
Chapter 8
Troubleshoot IUS .................................................................................................................... 101
IUS Server Log Files ................................................................................................................. 101
IUS IDOL Logs ................................................................................................................... 101
IUS Content Logs ............................................................................................................... 102
IUS OGS Logs ................................................................................................................... 102
IUS DiSH Logs ................................................................................................................... 103
Figures
Figure 1
Figure 2
Figure 3
Figure 4
Figure 5
Figure 6
Figure 7
Figure 8
Figure 9
Figure 10
Figure 11
Figure 12
Figure 13
Figure 14
Figures
Tables
Table 1
Table 2
Table 3
Table 1
Table 4
Table 5
Table 6
Table 7
Required databases.................................................................................................... 28
Optional deployed databases ..................................................................................... 29
Deploy Tool options on the General tab ..................................................................... 37
Deploy Tool options on the Indexer tab ...................................................................... 38
IUS IDOL log files ..................................................................................................... 101
IUS Content log files ................................................................................................. 102
OGS log files............................................................................................................. 102
DISH Log Files.......................................................................................................... 103
Tables
10
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
Contact HP Autonomy
Documentation Updates
The information in this document is current as of iManage Universal Search
Server version 8.5 SP3. The content was last modified 18 July 2013.
You can retrieve the most current product documentation from HP Autonomys
Knowledge Base on the Customer Support Site.
A document in the Knowledge Base displays a version number in its name, such
as IDOL Server 7.5 Administration Guide. The version number applies to the
product that the document describes. The document may also have a revision
number in its name, such as IDOL Server 7.5 Administration Guide Revision 6.
The revision number applies to the document and indicates that there were
revisions to the document since its original release.
It is recommended that you periodically check the Knowledge Base for revisions
to documents for the products your enterprise is using.
11
Related Documentation
For IUS deployments that connect to WorkSite Indexer, refer to the following
guides for more information about configuring and administering WorkSite
Indexer:
12
Conventions
Conventions
The following conventions are used in this document.
Notational Conventions
This document uses the following conventions.
Convention
Usage
Bold
Italics
monospace font
monospace bold
monospace italics
13
Usage
[ optional ]
{ required }
required
variable
<variable>
-merge filename1
(In some documents, angle brackets are used to denote
these items.)
...
14
Notices
This document uses the following notices:
CAUTION A caution indicates an action can result in the loss
of data.
WorkSite Indexer
15
Case Center: The Case Center is a central location to create, monitor, and
manage all your cases that are open with technical support.
Contact HP Autonomy
For general information about HP Autonomy, contact one of the following
locations:
16
E-mail: autonomy@autonomy.com
E-mail: autonomy@autonomy.com
Autonomy, Inc.
One Market Plaza
Spear Tower, Suite 1900
San Francisco CA 94105
USA
CHAPTER 1
Introduction
This section provides an overview of iManage Universal Search Server (IUS) and
its capabilities.
IUS Architecture
IUS Features
IUS Server is powered by IDOL Server, providing faster and more efficient
indexing capabilities than previous releases of IUS.
17
Chapter 1 Introduction
NOTE Your license determines which of the following operations your IUS
installation can perform.
Fast Indexing Speed and Search Response time. IUS can quickly index
extremely large repositories, and provide rapid responses to queries against
multiple large repositories.
Concept searching. IUS can recognize concepts, and it can use concepts to
identify and relate similarities between different pieces of information.
Alerts. IUS allows you to monitor specific topics and alerts you to new
information as it appears.
Connector Support. IDOL supports over 1000 file formats and connects to
over 400 content repositories.
18
Rich Media. This package enables you to automatically capture, encode and
index video and audio content, and to generate highly granular metadata. This
process ensures that you can fully search all rich media and link it with other
structured and unstructured information.
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 Content
services. IUS IDOL includes the following subservices:
DAH (Distributed Action Handler). DAH distributes ACI (Autonomy
19
Chapter 1 Introduction
into multiple IUS Content services, providing failover and load balancing.
Community. Community stores information about users and their roles
IUS Content. This service indexes all the content and serves search requests.
IUS OmniGroup Server (OGS). This service collects and aggregates user
and group security information from a variety of repositories.
IUS Web component. An IIS Web application that serves the IUS search
interface.
Distributed Service Handler (DiSH). This service controls the licensing of all
IUS functionality.
IDOL Statistics Server. This service is a complete reporting platform that can
record any requested data for any specified time frame.
Additional Components
IUS requires one or more Connector services to collect data from external
repositories (for example, a WorkSite database, a Web site, or a file server).
Security
It is often necessary to ensure that users can access or retrieve only data that
they are authorized to view. IUS Server enables you to set permissions for users
or groups of users, to protect information, and ensure only the correct people can
access it.
20
IUS Features
Text Queries
IUS Server contains data that has been aggregated from one or more
repositories. In this example each of the repositories has its own group server,
which stores the user names and groups that users belong to. IUS Server
aggregates this security information from the group servers.
When a user logs on to a client, the client sends the authentication details to IUS
Server, which returns the user security details. The client stores these details until
the 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 IUS
Server.
IUS Server uses the security information in the query string to check if the user
has permission to access the documents that match the query. It matches the
security string against the document Access Control Lists (ACLs), and returns all
matching documents that the user has permission to see.
Community Queries
IUS Server stores the agents and profiles of users, so that you can match them in
community queries (that is, any type of query that requests agents or profiles as
results).
When a client sends a community query to IUS Server, IUS Server matches it
against the agents and profiles it stores. It returns matching agents and profiles to
the client.
IUS Features
For more information about the unique features provided by IUS, refer to the IUS
Web Administration Guide.
21
Chapter 1 Introduction
22
CHAPTER 2
Hardware Guidelines
Licenses
Antivirus Processes
23
Basic Requirements
You must install IUS Server on a dedicated Microsoft Windows server. Follow
the specific directions in the Sizing Questionnaire.
You must disable User Account Control (UAC) before installing on Windows
Server 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 disk
quotas, file handle limits or memory limits).
Your file system must permit file locking (for example, you cannot run IUS on
an NFS mount).
Software Requirements
IUS Server has the following software dependencies and requirements:
Microsoft .NET Framework version 3.5 SP1. The IUS Server installer
automatically 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
24
You can also download this package from the Microsoft download center:
http://www.microsoft.com/download/en/details.aspx?id=14431
You can also download this package from the Microsoft download center:
http://www.microsoft.com/download/en/details.aspx?id=26347
Supported Platforms
For a list of supported platforms for this release, refer to the IUS Server Release
Notes and IUS Web Release Notes.
Hardware Guidelines
You must consider the following hardware recommendations when planning your
IUS deployment:
Memory. The amount of RAM available to IUS Server has a direct impact on
the speed of searches. IUS Server can retrieve search results more quickly if it
can 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
25
read I/O can limit search performance. Insufficient disk I/O can result in slow
performance, or index and search failures.
HP Autonomy recommends storing the full-text collection on a local SCSI
array using 15K drives or a SAN with equivalent throughput, using a direct
fiber channel connection to ensure optimal disk I/O.
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 per
second on a single machine with 2 CPUs, with sub-second response times, when
used against over 30 million pieces of content.
The minimum requirements do not account for redundancy or optimal
performance considerations for indexing and search. Hardware requirements
might increase according to several factors, including:
26
Operating System. IUS Server has 32-bit and 64-bit versions. HP Autonomy
recommends that you use the 64-bit version, which offers faster performance
for both indexing and searching.
Network I/O. File transfers can make up a significant part of the indexing time
if the network link is slow or misconfigured. For example, if you distribute file
servers in remote offices, the lower file transfer speeds over the WAN can
adversely affect the indexing time.
Licenses
Page file size. The page file is a machine configuration that can have a
significant impact on performance, particularly during activities such as
dictionary 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 manually
configuring a page file, a standard guideline for the page file size is 1.5x
the size of physical RAM.
Licenses
The HP Autonomy Distributed Service Handler (DiSH) controls the licensing that
allows you to run IUS Server. You must have a valid license key
(licensekey.dat) to run IUS.
The license file is tied to the IP address and ACI port of your DiSH server, and you
cannot transfer it between machines. You must have a running Autonomy License
Server that resides on a machine with a static known IP address, MAC address or
host 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
licensekey.dat, and copy it to the IUS DISH directory.
You can revoke licenses at any time, for example, to re-allocate them, or to
change the IP address of a client.
IMPORTANT
27
Antivirus Processes
Many systems run background processes or system services that regularly scan
the file systems on a computer system, such as antivirus, anti-spyware, and
anti-malware packages. These packages check new and updated files for known
signatures of viruses and other problematic software.
Index files created by IUS cannot contain viruses or dangerous software. They
can also change relatively frequently, depending on your index refresh mode, or
the frequency with which you manually update your index files. Scanning these
files can slow the performance of your system substantially without providing any
benefit.
To prevent slow performance, exclude the directories that contain the IUS indexes
from the list of directories to scan. The most common cause of slow document
crawls is not having the proper antivirus exclusions.
28
Database
Description
IQLRules
KMCache
Agent
Description
Audio
Clients
CourtCases
Documents
FederalCases
Stores indexed data from a case law Web site or other similar
repository.
Matters
People
PLC
Video
For more information about how IUS Web displays these databases, refer to the
IUS Web Administration Guide.
29
30
CHAPTER 3
31
32
This location assumes that the JRE was installed to C:\jre7\. Modify the
path to use the location in which you installed the JRE.
Figure 1 Edit System Variable dialog box
33
2. The WorkSite Indexer Deploy tool opens. Continue with Configure IUS
Server on page 35
3. When the installation is complete, click Finish.
34
CHAPTER 4
or
C:\Program Files(x86)\Autonomy\Install\IUS Server\deploy-8_5.bat
35
36
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.
Component
Root Path
The directory where all components run. If you change this setting, click Apply to add
this 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:\Program Files\Autonomy\
Temporary
Output Path
The path where configuration and application files are generated when you perform a
Deploy action. The default path is C:\temp\Autonomy\
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 localhost 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
2. Continue with Deploy IUS Server and WorkSite Indexer on page 38.
37
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
Support 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.
38
Description
Library Name
Database Name
The name of the WorkSite database. For Oracle, type the database
instance name here.
Database
Vendor
DB Instance
Name (optional)
Database
Username
39
Option
Description
Database
Password
The password to use for the database server, for example: mhdocs.
The Deploy tool automatically encrypts the password, and stores
the 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.
Best Practices
Database
5. Click Test to check the connection to the database. If the test is successful, it
displays Database connection successful.
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
40
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 the
contents 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).
41
Option
Description
Enable
LexisNexis
Tagging
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 the
following 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.
42
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.
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 NETBIOS value (for example, autonomy), not the full domain
(for example, autonomy.com).
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.
10. To configure alerts, click Alert Email. This option enables IUS to send e-mail
alerts to users when a new or updated document matches one of their saved
searches. A mail server is required to send the e-mail alerts.
Option
Description
SMTP Server
SMTP Port
The port number of the SMTP server to use to send alert e-mails.
The default port is 25.
43
Option
Description
Senders 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.
Senders
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.
Senders
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.
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 to
deploy 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
44
2. To provide an alternate host or path for a component, click Config for that
component. If you leave the Host field blank, the value that you specified in
the Default Host field on the General tab is used.
NOTE This step is required only if you are deploying
one or more services to a different host or a different
logical drive.
The Configure Component dialog box opens. For example, Figure 6 shows
the Configure WorkSite Connector dialog box.
Figure 6 Deploy Tool: configure component host and path
component.
For example, if you deploy two IUS Content servers to the same host, they
must each reside on a separate physical disk. As a result, you might
deploy Content1 to drive E:\ and Content2 to drive F:\. For example:
E:\Program Files\Autonomy\Universal Search\IUS Content1
F:\Program Files\Autonomy\Universal Search\IUS Content2
3. Click OK to close the Configure Component dialog box. Configure any other
component host or path settings on the Components tab and configuration
dialog boxes.
4. Continue with Deploy Components and Configuration Files on page 46.
45
46
Related Topics
Size the Installation on page 23
47
6. Click Encrypt.
The tool encrypts the password and prints the encrypted string in the
Ciphertext Password box.
7. Copy the encrypted string and paste it into the OGS configuration file
ConnectionString parameter, replacing the original connection string.
For example:
ConnectionString=9u7Cw8PIztnEwsP+2d/
Ew8qQ6f7jkNrelZjym5mW+OTpkN7Mlv366ZDZyM7FycLO8A
You must encrypt each ODBC connection separately.
8. Save your changes to the IUS OGS.cfg file.
48
49
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 Figure
9.
Figure 9 Create a New Data Source to SQL Server dialog box
50
51
a. In the Change the default database to field, select the database that you
created 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 are
required for saved searches when using UUEncode (All language support
with the indexer).
c. Click Next.
7. The Microsoft SQL Server DSN Configuration language settings screen
opens. See Figure 12
Figure 12 Microsoft SQL Server DSN Configuration, language settings
52
53
54
CHAPTER 5
55
where ServiceName is the name of the executable file for the service that
you want to install.
For example: "IUS Content1.exe" -install
Disable AlertTask
The Alert Task is a configured task that IUS IDOL performs during indexing. It
compares new documents to user saved searches and sends alerts for any new
content. When you create the initial index, this process is unnecessary and might
slow down the index process.
Before you start IUS services for the first time, disable the WorkSite IDOL Alert
Task. After you create the initial index, you can enable the AlertTask again.
56
57
The script ignores any of the above services that you have not configured in your
IUS deployment.
Review the log files generated by IUS to ensure that all services have started
properly.
where ServiceName is the name of the executable file for the service that
you want to start.
For example: "IUS Content1.exe" -start
58
Use the following procedure to shut down IUS services.To safely shut down all
IUS services
1. Stop any connector services by sending a WorkSite Connector.exe
-stop command, or by sending a Stop 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 GetStatus action to IUS IDOL. For example:
http://localhost:10000/a=GetStatus
If any results return, wait and then perform the same action again. Go to Step
6 only after IUS Server has finished processing actions, and the Indexer
Browser stops returning results.
6. In a Web browser, send the following index action to force IUS IDOL to
immediately flush documents to disk from the index cache:
http://hostname:10001/DRESYNC?
8. Stop the IUS IDOL service, the IUS Content services, and the IUS DiSH
service by sending a -stop command, or by sending a Stop action to the
Service port.
59
For information on shutting down the WorkSite Indexer, refer to the WorkSite
Indexer Administration Guide.
60
CHAPTER 6
E-mail Alerts
Spotlight Documents
Statistics Server
Taxonomy
61
You can distribute them across multiple databases which contain both regular
documents and Best Practices documents.
62
63
3. In the fetch task configurations for the relevant databases, set the value of the
BPWorkspaceDocnumCSV parameter to the IM_DOCNUM values for the
workspaces.
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.
<command id="bestPracticeWorkspaceList"
className="com.interwoven.web.core.command.CorePageCommand
">
<parameters>
<parameter
id="PrintFields">DREREFERENCE,DRETITLE</parameter>
<parameter
id="queryString">action=Query&Print=Fields&
;FieldText=MATCH{Active.31581_1}:DREREFERENCE AND
MATCH{WORKSPACETYPE}:IM_DOCTYPE&maxresults=10&
amp;databaseMatch=BestPractice
</parameter>
</parameters>
<views>
<view id="main" mainContent="/json/
bestPracticesTab/bestPracticeWorkspaceList.xml"/>
64
</views>
</command>
</commands>
</datasource>
<commands>
<command id="bestPracticeWorkspaceList"
className="com.interwoven.web.core.command.CorePageComm
and">
<parameters>
<parameter
id="PrintFields">DREREFERENCE,DRETITLE</
parameter>
<parameter
id="queryString">action=Query&Print=Fields&
amp;FieldText=MATCH{Active.31581_1,
Active.59_1}:DREREFERENCE AND
65
<parameter
id="queryString">action=Query&Print=All&maxresults
=100</parameter>
<parameter id="queryParams">FieldText</parameter>
6.
E-mail Alerts
To generate e-mail alerts, you must configure an Alert task in the IUS IDOL and
WorkSite IDOL configuration files. The Deploy Tool can automatically configure
this functionality. See Configure IUS Server on page 35.
The following example shows the AlertTask section of the configuration file,
which controls this functionality. The SMTPSendFromUsername and
SMTPSendFromPassword parameters are required only for mail servers that
require authentication.
[AlertTask]
Module=Alert
AlertRetrainedAgentsOnly=false
IDOLserver=localhost:10050
Fields=DRECONTENT,DRETITLE
FieldMappings=DRECONTENT,DRETITLE
QueryParameters=FieldText=MATCH{true}:alert
SMTPServer=10.5.203.4
SMTPPort=25
SMTPSendFrom=ejohnson@lakes.net
SMTPSendFromUsername=elizabeth johnson
SMTPSendFromPassword=pwd
SMTPSubject=Alert: new document DREREFERENCE
You must also add the Alert field to the AgentIndexFieldCSVs parameter in
the [Agent] section of the configuration file. For example:
AgentIndexFieldCSVs=owner,query,date,sharingmode,sharedwith*,dre*,
alert
66
E-mail Alerts
Templates
You define the layout of alert e-mail messages in templates. The default e-mail
template, alertTemplate.html, is located in the following directory:
C:\Program Files\Autonomy\Universal Search\IUS IDOL\templates\
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: http://news.bbc.co.uk
The document
title
DRETITLE
The document
content
DRECONTENT
DRECONTENT
If you type this example in the template and a document
DRECONTENT field contains the value Brine shrimp: popular with
aquaritics. High in protein and a nice snack for many freshwater
fish, the alert e-mail contains the following text:
Brine shrimp: popular with aquaritics. High in
protein and a nice snack for many freshwater fish
67
To display...
Example
The content of
any other
document field
"FIELDName"
Author: "FIELDauthor"
If you type this example in the template and the document author
field contains the value JR Hartley, the alert e-mail contains the
following text:
Author: JR Hartley
RESULTLINKS
The relevance of
the document to
the search agent
RESULTWEIGHT
Relevance: 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:
Relevance: 78 %
The agent
training
AGENTTRAINING
Type the fields in the position that you want to display them in the e-mail.
3. Save the template file.
68
Spotlight Documents
Set Template to the path to the template to use for alert e-mails that do
3. Save and close the configuration file. Restart IUS IDOL to activate your
changes.
Spotlight Documents
IUS can promote or spotlight specific documents or content at the top of the IUS
search results page.
When users search for specific keywords, you can spotlight up to three
documents. If IUS finds more than three spotlight documents, it displays the three
that have the highest relevance, according to the query terms.
The IUS Server must have an IQLRules database. You can create it using the
Deploy tool, or manually. This database stores the data that determines the
documents 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. The
following sections describe how to manually set up the IQLRules database for
spotlighting.
69
For example:
For a WorkSite document:
ws85.1.1
For a File System Connector document:
\\\\fileserver\\folder\\subfolder\\document.pdf
70
Spotlight Documents
#DREFIELD DOCREF0="\\\\fileserver\\folder\\subfolder\\
document.pdf"
#DREFIELD DOCTITLE0="Sample Title"
#DREFIELD DOCSUMMARY0="Sample Summary for document.pdf"
#DREDATE 1242424025
#DRESECTION 0
#DREFIELD CUSTOM_IQLTYPE="PROMOTIONS"
#DREDBNAME IQLRules
#DRECONTENT word word word word
#DREENDDOC
Description
DREREFERENCE
DRETITLE
DREFIELD KEYWORDS
DREFIELD NUMDOCS
DREFIELD DOCREF#
DREFIELD DOCTITLE
DREFIELD DOCSUMMARY
DRECONTENT
DREFIELD CUSTOM_IQLTYPE
71
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 send
the iqlrules. to the IQLRules database:
http://localhost:10001/DREADD?C:\temp\
iqlrules.&DREDbName=IQLRules
Statistics Server
IUS uses the IDOL Statistics Server to record information such as index rates,
peak loads, null-hit queries and overall usage.
72
Statistics Server
The Statistics Server is an add-on module. You can use the Autonomy Business
Console to view and generate reports on the data that Statistics Server collects.
For more information, refer to the Autonomy Business Console User Guide.
73
Statistics Server saves the data it gathers in the \results directory, in a series of
text files.
You can use the Autonomy Business Console to view and generate reports on the
data collected by the Statistics Server. For more information, refer to the
Autonomy Business Console User Guide.
Taxonomy
The IUS Classification Package allows you to generate and display taxonomies of
the data in IDOL. For more information, refer to the IUS Web Components
Administration Guide.
74
Taxonomy
75
Save the changes to IUS IDOL.cfg, and then restart IUS IDOL.
76
CHAPTER 7
77
All IUS Content index backups. These files contain the actual Index collection.
Determine the average indexing throughput (documents per hour) during the
initial creation of the index.
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.
Both numbers increase as new documents are added to IUS, and are indexed by
IUS Server. The committed_documents value also increases when an existing
document is reindexed because it was modified or deleted.
78
After you run a DRECOMPACT index action, the number of committed documents
decreases, because this action removes deleted documents from the index.
HP Autonomy recommends that you run a DRECOMPACT index action if the
committed_documents value is 20% or more higher than the documents value.
Related Topics
Compact the Index on page 96
your IUS Server has an average rate of change of 100,000 documents per
week.
the rate of indexing during the initial build of the index was approximately
100,000 documents per hour.
In the event of a failure, it takes approximately four hours for IUS Server to
process the difference between the most recent backup and the documents that
were 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:
you want to have a smaller difference between the current content in IUS and
the index backup, or conversely if a larger difference is acceptable.
The time needed to complete the backup job for each Content server varies
according to:
79
By default, the Content server compresses the backup files, so that they take
up approximately 30-40% of the total index data space. If you choose not to
compress the backup files (BackupCompression=false or
BackupCompressionLevel=0), estimate backup space that is at least as
large as the size of the live index.
HP Autonomy does not recommend that you use a third party backup or
snapshot process to back up live index data, because this can interfere with
the 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 data
to another location. You can then back up the resulting data files using your
standard backup process or service.
If your IDOL storage is a SAN with disk-snapshot capabilities, you can use the
DREFLUSHANDPAUSE 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 Index
Manually on page 83.
For information on the DREFLUSHANDPAUSE action, see Back Up the Index
Dynamically on page 87
Search\IUS
Search\IUS
Search\IUS
Search\IUS
DISH\IUS DISH.cfg
IDOL\IUS IDOL.cfg
Contentn\IUS ContentN.cfg
OGS\IUS OGS.cfg
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 the
Windows Scheduling Service. For example:
xcopy /s SourceDir\*.cfg DestinationDir
80
BackupCompression
BackupCompression
Level
BackupTime
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 BackupInterval
must elapse (after the specified BackupTime) before the first
backup takes place.
BackupInterval
81
BackupDirN
BackupMaintainDir
Structure
NumberOfBackups
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
BackupDirN directories. When you run multiple backups:
IUS Server creates the first backup at the first
BackupInterval after the specified BackupTime.
IUS Server creates the next backup after the specified
BackupInterval, and so on. After it has backed up the
data index as many times as you have specified for
NumberOfBackups, it overwrites the first backup at the
next BackupInterval. This process means you always
have a current set of data index backups.
PreCompaction
BackupPath
For example:
[Schedule]
Backup=true
BackupCompression=true
82
BackupCompressionLevel=1
BackupTime=03:00
BackupInterval=168
BackupMaintainStructure=true
NumberOfBackups=3
BackupDir0=E:\DataIndex_Backup0
BackupDir1=E:\DataIndex_Backup1
BackupDir2=E:\DataIndex_Backup2
4. If you have more than one Content server, configure the [Schedule] section
parameters for each Content sever.
IMPORTANT You must change the destination location for each Content
server backup to avoid overwriting backup data.
To back up the configuration files, make copies of the following files for each of the
IUS Server components:
InstallDir\Universal
InstallDir\Universal
InstallDir\Universal
InstallDir\Universal
Search\IUS
Search\IUS
Search\IUS
Search\IUS
DISH\IUS DISH.cfg
IDOL\IUS IDOL.cfg
Contentn\IUS Contentn.cfg
OGS\IUS OGS.cfg
83
84
HP Autonomy does not recommend that you use a third party backup or snapshot
process to back up live index data, because this can interfere with the indexing
process. For information on scheduling backups see Back Up the Index on a
Schedule.
For a manual backup, HP Autonomy recommends using the DREBACKUP index
action to copy the index data to another location. You can then back up the
resulting data files using your standard backup process or service.
Because each IUS Content stores a subset of the index, you must send the
DREBACKUP individually to each Content server.
To manually back up the index
For each Content server, send the following index action (case sensitive) from
your Web browser:
http://host:indexPort/DREBACKUP?path
where,
host
indexPort
path
For example, if you have two Content servers, using the default values for the
IndexPort (for example, Content1: 11001, Content2: 12001), the DREBACKUP
index actions are:
http://127.0.0.1:11001/DREBACKUP?E:\backup\content1
http://127.0.0.1:12001/DREBACKUP?E:\backup\content2
85
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.
86
The time needed to complete the backup for each Content server varies
according to the size of the index, and the disk speed of the source and
destination locations. Because the backup is effectively a copy of the Content, HP
Autonomy recommends that you estimate backup space that is at least equivalent
to the size of the live Index.
Back up data during off-peak hours to minimize user impact.
87
IUS Index Data Backup Files. The restoration of the index data requires the
data files generated during the Content server backup process. To
successfully restore an index you must have valid backups of all Content
servers from the same backup point.
The following instructions assume that the necessary environment and backup
files are available to complete the restore.
Related Topics
Back Up the Index on a Schedule
Search\IUS
Search\IUS
Search\IUS
Search\IUS
DISH\IUS DISH.cfg
IDOL\IUS IDOL.cfg
Contentn\IUS Contentn.cfg
OGS\IUS OGS.cfg
NOTE The IUS Content services must be running when you send the data
restore action.
88
http://host:indexPort/DREINITIAL?path
where,
host
indexPort
path
When you run the DREINITIAL index action the IUS Content services must be
running.
For example, if you have two Content servers, using the default values for the
IndexPort (for example, Content1: 11001, Content2: 12001), the DREINITIAL
index actions are:
http://127.0.0.1:11001/DREINITIAL?E:\backup\content1
http://127.0.0.1:12001/DREINITIAL?E:\backup\content2
89
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 Port parameter in the [Server] section of each
IUSContentN.cfg file).
2. Click Indexer Status.
If the DREINITIAL action has been completed, it is displayed in the result set
with Status = -1 and Description = Finished.
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.
Restoration Considerations
The time needed to complete the restoration job for each Content varies
according to the size of the index as well as the disk speed of the source and
destination locations.
90
HP Autonomy does not recommend that you use a third party backup or snapshot
process to back up or restore live index data, because this can interfere with the
indexing process. Similarly, restoring the index data using a method other than the
DREINITIAL index action can result in an index that is not valid.
If any results return, wait and perform the same actions again. Proceed to the
next step only when the action does not return any results.
4. Send the following index action to force an immediate flush to disk from the
index cache:
http://hostname:10001/DRESYNC?
91
Ensure that a .gz file is created in each IUS Content directory. Make a note of
the name of the .gz file.
NOTE If you do not want to export data from all IUS
Server databases, use the DatabaseMatch parameter.
For example, to export data from the newyork and
london databases, use the following index action:
http://hostname:10001/
DREEXPORTIDX?DatabaseMatch=newyork,london
Separate multiple databases with plus symbols (+),
commas (,), or spaces (there must be no space before
or after a plus symbol or comma).
7. Stop the IUS Content services and the IUS IDOL service. The OGS and DiSH
services can remain running.
8. If you are making a configuration change, back up the existing configuration
files, and then modify the appropriate configuration files.
9. Disable E-mail Alerts in IUS (if enabled) to prevent IUS from generating alerts
while it reindexes data.
10. In the IUS IDOL configuration file, find the [IndexTask] section.
a. Set the StartTask to Eduction, instead of AlertTask. For example:
StartTask=Eduction
92
13. Send a DREADD index action to the index port of each IUS Content service to
reindex the exported IDX files. You must specify the data archive file in the
index action. The index port must be the value of the IndexPort parameter
in the Content configuration file.
The following example reindexes the .gz file stored in the Content1 directory
to the Content1 service using port 21001:
http://hostname:21001/DREADD?C:\Program Files\Autonomy\
Universal Search\IUS Content1\
AUTN-IDX-EXPORT-hostname.domain.com-22000-21.08.2009-10.46.42-0
.idx.gz
14. Repeat this step for each IUS Content you have deployed, reindexing the
archived data to the Content index port. The default ports for IUS are:
Content1: 21001, Content2: 22001, Content3: 23001, Content4: 24001, and
so on.
15. Monitor the number of documents in each Indexer database by sending a
GetStatus action or by connecting with Index Browser.
16. Start the IUS Server services using the start_indexer.bat file.
93
where,
IDOLhost
ACIPort
is the IUS IDOL ACI port (the value of Port in the IUS IDOL
configuration file [Server] 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 /IUS IDOL/community directory.
For example:
http://12.3.4.56:10000/action=Export&ExportFileName=MyFile.xml
This action uses port 10000 to export IUS Server users, roles, agents, and profiles
to the MyFile.xml file.
where,
94
hostname
ACIPort
is the IUS IDOL ACI port (the value of Port in the IUS IDOL
configuration files [Server] 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 /IUS IDOL/
community directory, specify the path to the file as well.
fieldCSV
For example:
http://12.3.4.56:10000/action=Import&ImportFileName=MyFile.xml
This index action uses port 10000 to import IUS Server users, roles, agents, and
profiles from the MyFile.xml file.
where,
hostname
port
is the IUS IDOL ACI port (the value of the Port parameter in the
Server configuration section).
For example:
http://12.3.4.56:10000/action=Backup
95
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,
ClusterResults, ClusterSGDataServe, and CategoryQuery.
where,
hostname
port
is the IUS IDOL ACI port (the value of the Port parameter in the
Server configuration section).
NOTE While IUS Server is processing a Restore action, you cannot run
any category, cluster, or taxonomy actions.
96
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
IMPORTANT You must ensure that you have a current
backup before running the DRECOMPACT action.
The time needed to complete the compact job for each Content server varies
according to the size of the index, and the speed of the disk hosting the
content.
The amount of disk space needed to complete the compact job for each
Content server varies according to the size of the index and the level of
fragmentation. As a guideline, HP Autonomy recommends that you have free
space up to, and possibly exceeding, the size of the Content server targeted
for compaction.
Users cannot receive search results from the Content Engine when a
DRECOMPACT is running. You must therefore schedule DRECOMPACT activity
for off-peak hours to minimize user impact.
By default, the DRECOMPACT index action automatically copies the data index
to a directory in the Content server data directory. If there is not enough disk
space on the IUS Content drive, you can change this directory by setting the
PreCompactionBackupPath configuration parameter. For more information
about this configuration parameter, see Back Up the Content Index on a
Schedule on page 81.
97
CompactTime
CompactInterval
For example:
[Schedule]
Compact=true
CompactTime=01:00
CompactInterval=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.
98
where,
host
indexPort
In this example, the Content servers located on a machine with the IP address
127.0.0.1 (local host) are compacted.
The compaction is complete when the IndexerGetStatus action reports that
the job (INDEXID number) is finished (status=-1, description =
Finished).
99
100
CHAPTER 8
Troubleshoot IUS
To troubleshoot IUS, consult the log files that it creates. The entries in these files
provide you with details of possible problems or misconfigurations. You can use
them to identify and correct configuration errors.
Description
application.log
dah_application.log
dih_application.log
101
Description
dih_index.log
dih_query.log
import.log
indexer.log
Description
application.log
index.log
query.log
102
Log file
Description
application.log
job.log
Description
application.log
licenseserver.log
Logs the status of the loading of the license key, and the
products, functionality, and languages included in your
license.
103
104
Glossary
A
ABC
ACC
ACL
See ACL.
agent
Agentstore component
alert
Users can set up alerts to send them an e-mail when there is new content
that matches one of their saved searches.
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.
105
Glossary
106
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
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-defined
list. 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
cluster
Community 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
DAH
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.
See DAH.
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 (DiSH)
See DiSH.
DRECONTENT
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.
107
Glossary
entities
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.
IDOL Server
IDX
A structured file format that can be indexed into IDOL server. Connectors
import files into this format for indexing.
See IUS.
index
indexing
IUS
IUS Server
iManage Universal Search Server. IUS Server includes IDOL server and all
the IDOL components that collect and index data for IUS.
108
iManage Universal Search Web Components. The Web application and user
interface that users can access to search for content in IUS.
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.
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
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
See QMS.
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.
spotlighting
109
Glossary
Statistics Server
Statistics server is an IDOL component that can monitor events and return
statistics about those events.
taxonomy
110
WorkSite
WorkSite Indexer
WorkSite Indexer is a server that includes all the IDOL components required
to collect, index, and store data from WorkSite.
Index
A
ACC
create taxonomies 75
ACIPort configuration parameter 94
actions
Backup 95
DREBACKUP 84
DREFLUSHANDPAUSE 87
Export 93
Import 94
Restore 96
agent database
overview 28
agent query 21
agents
export 93
import 94
alerts
configure 66
create template 67
e-mail address 66
e-mail template 67
alerttask
disable 56
enable 57
antivirus
recommendations 28
AQG 18
audio database
overview 29
automatic query guidance. See AQG
Autonomy Collaborative Classifier. See ACC.
autpassw.exe
encrypt passwords 48
back up 87
categories, taxonomies, and cluster jobs 95, 96
configuration file 80, 83
considerations 79, 90
content index 81
data index 84, 87
dynamically 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 86
Backup action 95
Backup configuration parameter 81
BackupCompression configuration parameter 81
BackupCompressionLevel configuration parameter
81
C
categories 96
111
Index
back up 95, 96
categorization package 18
category
enable 75
category 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
BackupDirN 82
BackupInterval 81
BackupMaintainDirStructure 82
BackupTime 81
NumberOfBackups 82
Port 95, 96
PreCompactionBackup 82
PreCompactionBackupPath 82
configure
112
advanced configuration 61
Category component 75
deploy tool 35
e-mail alerts 66
IDOL 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 29
courtcases 29
documents 29
federalcases 29
IQLRules 28
KMCache 28
matters 29
overview 28
people 29
PLC 29
video 29
datasources.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, 99
considerations 97
DREEXPORTIDX 92
DREFLUSHANDPAUSE
run 87
DREINITIAL 89, 90, 92
DRESYNC 84, 91
E
e-mail alerts
address 66
configure 66
create template 67
template 67
enable alerttask 57
encrypt
passwords with autpassw.exe 48
events
statistics server 74
experts 18
export
agents 93
profiles 93
roles 93
users 93
Export action 93
F
federalcases database
overview 29
files
re-index 63
G
GETSTATUS 91
113
Index
H
hardware
guidelines 25
highlight
search terms 72
I
identify
best practice workspace 62
IDOL 19
configuration 53
Content 20
DAH 19
IUS IDOL 19
licenses 27
logs 101
OmniGroupServer 20
re-index 63
Statistics server 20
statistics server 72
IDOL server
back up 95, 96
create taxonomies 75
enable Category 75
iManage Universal Search. See IUS.
import
agents 94
profiles 94
roles 94
users 94
users, roles, agents, and profiles from IDOL
server 94
Import action 94
index
back up configuration file 83
back up content 81
back up data 84, 87
compact 84, 87, 96
dynamic back up 87
manual back up 83
number of documents 78
114
overview 20
rate of change 79
restore from back up 87
schedule back up 78
index actions
DREADD 93
DREBACKUP 80, 84, 97
DRECOMPACT 79, 82, 96, 99
DREEXPORTIDX 92
DREFLUSHANDPAUSE 87
DREINITIAL 89, 90, 92
DRESYNC 84, 91
GETSTATUS 91
Index Browser 78
index data
manually compact 99
restore 88
schedule compact 98
indexer
deploy tool 35
install
all services 55
deploy tool 35
individual services 56
IUS Server 32
IUS services 55
services manually 56
statistics server 73
WorkSite Indexer services 60
installation
antivirus guidelines 28
data storage 25
hardware 25
memory 25
network 26
operating system 26
page file 26
plan 23
prerequisites 24
processors 25
size 23
virtualization 26
IQLRules database
create iqlrules file 70
overview 28
spotlighting 69
IUS
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 72
statistics server operations 73
supported platforms 25
troubleshoot 101
IUS Server
advanced configuration 61
architecture 19
configuration 53
databases 28
deploy tool 35
install 32
log 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
115
Index
move
IUS Server services 47
WorkSite Indexer 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 database
overview 29
Port configuration parameter 95, 96
PreCompactionBackup configuration parameter 82
PreCompactionBackupPath configuration parameter
82
preferences
116
e-mail address 66
prerequisites
antivirus 28
hardware 25
IUS 24
processes
disable alerttask 56
enable alerttask 57
processors 25
guidelines 25
profile query 21
profiles
export 93
import 94
promotion
statistics 74
promotions
document spotlighting 69
Q
query
agent 21
category 21
community 21
overview 20
profile 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
WorkSite Indexer services 47
requirements 25
antivirus 28
data storage 25
hardware 25
memory 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 21
category query 21
community query 21
IUS 20
profile query 21
text query 21
services
117
Index
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 72
troubleshoot
IUS 101
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
workspaces
best practice 62
limit display 64
XML events
define 74
statistics server 73
V
validate
restore 89
verify
back up 86
restore 89
video database
overview 29
virtualization
guidelines 26
118