installation and setup guide - hyland content server installation and setup guide page 3 of 22 table...

ImageNow Content Server Installation and Setup Guide ImageNow Version: 6.7. x

Written by: Product Documentation, R&D Date: September 2016

© 2014 Perceptive Software. All rights reserved

CaptureNow, ImageNow, Interact, and WebNow are trademarks of Lexmark International Technology SA, registered in the U.S. and other countries. Perceptive Software is a stand-alone business unit within Lexmark International Technology SA. All other brands and product names mentioned in this document are trademarks or registered trademarks of their respective owners. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or any other media embodiments now known or hereafter to become known, without the prior written permission of Perceptive Software.

ImageNow Content Server Installation and Setup Guide of 22

Tab le o f Contents

Overview.......................................................................................................................................... 4

Before you install ........................................................................................................................... 4

Updating Content Server....................................................................................................................... 4

Prepare for the installation .................................................................................................................... 5

Open network ports for communication ............................................................................................. 5

Install Content Server .................................................................................................................... 5

Download Content Server files ............................................................................................................. 5

Install on Windows attended ................................................................................................................ 6

Install on Windows unattended ............................................................................................................ 8

Install Content Server on UNIX ........................................................................................................... 11

Turn off data execution prevention (DEP) ......................................................................................... 12

Install Content Server license ............................................................................................................. 12

Obtain the license files ..................................................................................................................... 12

Install ImageNow product licenses ................................................................................................ 13

Set up Content Server ................................................................................................................. 13

Configure Content Server ................................................................................................................... 14

Configure document submission in Content Server ....................................................................... 16

Start Content Server indexing process ............................................................................................. 16

Appendix: Server configuration tables ...................................................................................... 17

inow.ini ................................................................................................................................................... 17

inserverFT.ini ......................................................................................................................................... 18


Over v iew ImageNow Content Server is an external component you can add to ImageNow to collect text data and create searchable indexes based on the content of each document page. The search feature lets you search for specific keywords using complex queries or single word searches. Your search can contain wildcards to represent one or more characters. The server displays the document pages that contain matches for the search and highlights the matching keywords within the documents. Content Server lets you perform various types of searches, including fuzzy, phonetic, stemming and synonym, proximity, and relevance ranking searches.

You can use fuzzy searches to find documents when you are not sure how to spell a term, or when ImageNow Recognition Agent did not recognize the text. With phonetic searching, you can also retrieve words that sound similar to your search term. For example, your query can return words such as sale, sail, sell, or seal. Stemming and synonym expansion let you expand search terms to include word stems and synonyms in the document index. For example, searching for the word finance as a stem can return finances, financed, financing, and financial.

If you know the proximity of a search item on the page, you can use a proximity search to find documents that contain several search values within a given area of the page, such as a paragraph or phrase. You can also assign individual search items a relative importance, or weight. Content search interprets the weights you set and displays a higher relevancy ranking to documents that contain higher weighted search terms. Additionally, you can use query-by-example to narrow vague search queries that return unrelated results by searching for documents with similar content.

Before you ins ta l l Important In Windows, you must install this agent in a 32-bit environment. If you installed ImageNow Server on a 64-bit Windows server, follow the steps in this guide to install this agent on a remote 32-bit server. For product technical specifications and system requirements, refer to the Product Technical Specifications for your product version. This document is available on the Product Documentation tab of the Customer Portal on www.perceptivesoftware.com.

Updat ing Content Server

Important This document assumes you are installing ImageNow Content Server for the first time or that you have no earlier versions running on the computer. To update or upgrade Content Server from a previous version, refer to the Update ReadMe document available on the Customer Portal of the Perceptive Software website at http://www.perceptivesoftware.com. Because the upgrade requires you to run the Content Server installer, sections of the update readme may reference procedures in this installation guide.

http://www.perceptivesoftware.com/

http://www.perceptivesoftware.com/


Prepare for the insta l lat ion

Before you install Content Server, perform the following readiness checks:

• Verify that your ImageNow Server is running.

• Obtain the user name and password for the user that administers the ImageNow database.

• Make sure that you have sufficient disk space for executables and object storage.

• Verify that ImageNow Recognition Agent is installed and configured.

• Verify that the computer you are using to install Content Server is not a 64-bit operating system.

Open network ports for communicat ion

To enable communications between ImageNow Server and ImageNow Content Server, you must open two TCP ports on your network. If you plan to install Content Server on the same computer as ImageNow Server, you open both network ports on the ImageNow Server computer.

• Port 7202: On the ImageNow Server computer, the OSM Agent uses port 7202 to communicate with Content Server. Port 7202 is the default port for messaging communications, though you can modify the port by changing the ip.port setting in the \inserver6\etc\inserverOSM.ini file.

• Port 7201: On the Content Server computer, the Full Text Agent uses port 7201 to communicate with ImageNow Server and OSM Agent. Port 7201 is the default port for messaging communications, though you can modify the port by changing the ip.port setting in the \inserver6\etc\inserverFT.ini file.

I ns ta l l Conten t Ser ver The following procedures describe how to download, install, and configure ImageNow Content Server. You can choose to install Content Server on the ImageNow Server computer or on a computer separate from ImageNow Server.

Important If you are installing Content Server on the same computer as ImageNow Server, Content Server automatically installs to the [drive]:/inserver6 directory. If you are installing Content Server remotely, you can select the directory.

Download Content Server f i les

1. Go to the Perceptive Software website at www.perceptivesoftware.com and log in to the Customer Portal.

about:blank


2. In the Product Downloads page, search for all downloadable items for the specific product and version you want to use. These files may include a product installer, product documentation, or set of supporting files.

3. Download the relevant files to a temporary directory on your computer.

Insta l l on Windows attended

The installation wizard pages described in this section prompt you for the information needed to install Content Server. If you want to bypass the wizard, skip to the “Install on Windows unattended” section.

1. Double-click the EXE file you downloaded.

2. In the Welcome to the Installation Wizard for ImageNow Content Server page, click Next.

3. In the License Agreement page, review the terms of the License Agreement, scroll to the end of the agreement, click the I accept the terms in the license agreement button, and then click Next.

4. If you are installing Content Server on a separate computer from the ImageNow Server, do the following substeps:

1. In the ImageNow Database Connection page, do the following substeps:

1. Under Database type, select the database type that corresponds to your ImageNow database.

2. Click Next.

2. In the Destination Folder page, accept the default installation location or click Change to select a different installation directory and then click Next.

5. In the Ready to Install the Program page, click Install.

6. If you are installing Content Server on a separate computer from the ImageNow Server, do one of the following subprocedures:

• If you use an SQL Server DBMS, in the ODBC SQL Server Wire Protocol Driver Setup dialog box, on the General tab, do the following steps:

1. In Description, type an optional description for the connection.

2. In Host Name, type the database server name or IP address for the computer that hosts your ImageNow database.

3. In Port Number, type the port number for your ImageNow database.

4. In Database, type the ImageNow database name. By default, this name is INOW6.

5. Click Test Connect.


6. In the Logon to SQL Server Native Wire Protocol dialog box, type the user name and password of the user that administers the ImageNow database and click OK.

7. Click Apply and click OK.

• If you use an Oracle DBMS, in the Oracle Wire Protocol Driver Setup dialog box, on the General tab, do the following steps:

1. In Description, type an optional description for the connection.

2. Under Standard Connection, enter the host name and port number for the computer that hosts the ImageNow database and type the SID of the ImageNow database.

3. Click Test Connect.

4. In the Logon to Oracle Wire Protocol dialog box, enter the user name and password of the user that administers the ImageNow database and click OK.

5. Click Apply and click OK.

7. Optional. If the Show the Windows Installer log check box appears, you can select the check box to view the log file.

8. When the installation is complete, click Finish.

9. When prompted, restart the computer.

Note If you installed ImageNow Content Server on a Windows Server 2003 or Windows Server 2008 operating system, you must modify the DEP setting. Because changing this setting requires you to restart the computer, you can wait to restart the computer until after you change the DEP setting.


Insta l l on Windows unat tended

By installing Content Server with a single command, you can bypass the installation wizard and run the installation automatically. The command includes an optional set of custom values in the <argument list> shown below.

ContentServerSetup.exe /s /V"/qb <argument list>”

If you omit any of the arguments in the list, the installer uses default values shown in the table below for the missing arguments. If you use environment variables to set the arguments, be sure to set all of your environment variables.

You can issue this command from a Command Prompt window, you can use the command in a batch file, or you can create a command line script for your deployment software. An unattended installation skips the license agreement the user sees when using the wizard.

1. Set up your argument values as necessary to customize the unattended installation.

Script Variables Argument Description Default Example

LOGFILE /L*V If you use this argument, setup does not create directories so the path for the log file generation must be a valid, existing path. This argument is typically used to diagnose installation errors.

Use escaped quotation marks when setting this argument.

If the command line argument is removed, it defaults to the %TEMP% directory in a file named ContentServerInstall. log.

Script Variable:

set LOGFILE=C:\logs\contentserver-install.txt

Command line:

/L*V \”C:\logs\contentserver-install.txt\”

INSTALLDIR_ VAL

INSTALL DIR

The default, and recommended, installation directory is [drive:]\inserver6.

Use escaped quotation marks when setting this argument.

[drive:]\inserver6 Script Variable:

set INSTALLDIR_VAL= C:\inserver6

Command line:

INSTALLDIR=\”C:\inserver6\”



IMAGENOW_ DB_VAL

IMAGENOW_DB

Use either SQLSERVER or ORACLE.

SQLSERVER Script Variable:

set IMAGENOW_DB_VAL=ORACLE

Command line:

IMAGENOW_DB=ORACLE

PORT_NO_VAL PORT_NO The port number of the SQL or Oracle server.

1433 Script Variable:

PORT_NO_VAL =7000

Command line:

PORT_NO=7000

DATABASE_ NAME_VAL

ODBC_SID

ODBC_DBNAME

This is the name of the database. For Oracle use the ODBC_SID argument, and for SQL Server use the ODBC_DBNAME argument.

INOW6 Script Variable:

Set DATABASE_NAME_VAL=INOW6

Command line:

ODBC_SID=INOW6

ODBC_DBNAME=INOW6

IS_SQLSERVER_SERVER_ VAL

IS_SQLSERVER_SERVER

Location of the SQL or Oracle server.

127.0.0.1 Script Variable:

set IS_SQLSERVER_SERVER_VAL

= localhost

Command line:

IS_SQLSERVER_SERVER

=127.0.0.1



MQ.AGENT.IP.ENABLE.OVERRIDE_VAL

MQ.AGENT.IP.ENABLE.OVERRIDE

Whether to override the installation location from ImageNow Server in a remote installation environment. For remote installations, use the TRUE value.

FALSE Script Variable:

Set

MQ.AGENT.IP.ENABLE.OVERRIDE_VAL=FALSE

Command line:

MQ.AGENT.IP.ENABLE.OVERRIDE=FALSE

MQ.AGENT.IP.ADDRESS.OVERRIDE_VAL

MQ.AGENT.IP.ADDRESS.OVERRIDE

The IP address of the ImageNow Server for remote installations.

127.0.0.1 Script Variable:

Set

MQ.AGENT.IP.ADDRESS.OVERRIDE_VAL=123.4.5.6

Command line:

MQ.AGENT.IP.ADDRESS.OVERRIDE=123.4.5.6

2. Enter the following command. You can use one of the commands in a Command Prompt window, use a command in the provided batch file, or create a command line script for your deployment software:

ContentServerSetup.exe /s /V“/qb <argument list>”

The following example shows the command format using the environment variables:

ContentServerSetup.exe /s /V"/qb /L*V \"%LOGFILE%\" INSTALLDIR=\"%INSTALLDIR_VAL%\" IMAGENOW_DB=%IMAGENOW_DB_VAL% IS_SQLSERVER_SERVER=%IS_SQLSERVER_SERVER_VAL% PORT_NO=%PORT_NO_VAL% ODBC_DBNAME=%DATABASE_NAME_VAL% ODBC_SID=%DATABASE_NAME_VAL% MQ.AGENT.IP.ENABLE.OVERRIDE=%MQ.AGENT.IP.ENABLE.OVERRIDE_VAL% MQ.AGENT.IP.ADDRESS.OVERRIDE=%MQ.AGENT.IP.ADDRESS.OVERRIDE_VAL%"

The following example shows the command with a defined argument list: ContentServerSetup.exe /s /V"/qb /L*V \"C:\logs\contentServer-silentinstall660.txt\" INSTALLDIR=\"C:\inserver6\" IMAGENOW_DB=SQLSERVER IS_SQLSERVER_SERVER=127.0.0.1 PORT_NO=1433 ODBC_DBNAME=INOW6 ODBC_SID=INOW6 MQ.AGENT.IP.ENABLE.OVERRIDE=FALSE MQ.AGENT.IP.ADDRESS.OVERRIDE=127.0.0.1"

3. Verify your installation.


Insta l l Content Server on UNIX

To install Content Server on a Linux, AIX, or Oracle Solaris environment, complete the following procedure. You can only perform this procedure on the ImageNow Server computer.

1. Access a command prompt with root permissions.

2. Locate the inserver6 directory where you installed ImageNow Server.

3. Unzip and copy the compressed tarball to that directory.

4. Type gunzip <downloaded file name>.tar.gz and press ENTER.

5. Type tar -xvf <downloaded file name>.tar and press ENTER.


Turn off data execut ion prevent ion (DEP)

If you operate in a Windows Server 2003 or Windows Server 2008 environment, you must remove the Data Execution Prevention (DEP) setting from the executable file in [drive:]\inserver6\bin. You do this by adding the appropriate EXE files to an exception list in the Windows System Properties dialog box.

1. On the desktop of the Content Server computer, do one of the following options:

• If you use Windows Server 2003, right-click My Computer and then select Properties.

• If you use Windows Server 2008, right-click Computer, select Properties, and then, under Tasks, choose Advanced system settings.

2. In the System Properties dialog box, on the Advanced tab, under Performance, click Settings.

3. In the Performance Options dialog box, on the Data Execution Prevention tab, select Turn on DEP for all programs and services except those I select.

4. Click Add.

5. In the Open dialog box, navigate to the directory where you installed ImageNow Content Server, select an EXE file in that directory, and then click Open. Repeat this step for the remaining EXE files in the directory.

6. Click OK twice.

7. Restart the computer.

Insta l l Content Server l icense

When you purchase Content Server, you receive a license file to use it. Before entering your license, you must have successfully installed the ImageNow Server and at least one ImageNow Client. Only the ImageNow owner or a manager user can complete this task.

Obtain the license files

To obtain the hardware information for the ImageNow Server, you must be the admin user on Windows.

1. Generate a system fingerprint using the following substeps.

1. Click Start, point to All Programs, point to ImageNow 6, and then click ImageNow Management Console.

2. In the Login page, click License Manager.

3. In the License Management dialog box, select Save system fingerprint and click OK.

4. In the Save As dialog box, enter a name for the file and then navigate to the location where you want to save the report. Click Save.


2. Contact your Perceptive Software representative for instructions on where to send the system fingerprint file to obtain your license. The system fingerprint file has a SYSFP extension.

3. When you receive the license files, store the license files in a temporary directory on the ImageNow Server computer.

Install ImageNow product licenses

Before entering your licenses, you must have installed the ImageNow Server and at least one ImageNow Client. You must have Service Administrator privileges to install ImageNow licenses. The ImageNow Client must be available on a Windows machine in order to install the ImageNow product licenses.

1. When you receive the license files from your Perceptive Software representative, copy them to a temporary folder where you can access them with an ImageNow Client.

2. Upload licenses, as explained in the following substeps:

1. Click Start, point to All Programs, and then select ImageNow 6.

2. In the login page, click License Manager.

3. In the License Management dialog box, select Upload Licenses and click OK.

4. Navigate to the folder where you stored the ImageNow license files, select the LIC files to upload, and click Open.

5. Enter the User Name, Password, and Server Location and click OK.

6. Optional. The License Upload dialog box lets you view the type name, actual license code, and current status of each license upload. To display detailed information for a specific license, select the appropriate row.

3. Click OK.

Set up Content Ser ver After installation and licensing, Content Server requires no further configuration steps to begin indexing new documents if it is installed on the ImageNow Server computer. The [Full Text] section of the inow.ini file contains the default settings and directories used by Content Server. For example, the installer sets a default submissions directory, where the internal bulk files are temporarily stored while they are waiting for processing and the default collections group directory, where new collections are to be dynamically allocated.

To set up Content Server to index legacy data automatically, you must update the inserverFT.ini file settings using the following procedure. For more information about the settings in the configuration files, refer to the appendix of this document.


Conf igure Content Server

1. If you installed Content Server remotely, on the ImageNow Server computer, navigate to the [drive]:/inserver6/etc folder and open the inow.ini file in a text editor and complete the following substeps:

1. In the [Full Text] section, set the full.text.integration property to TRUE.

2. In the [OCR] section, verify that the ocr.integration property value is TRUE.

3. Save and close the inow.ini file.

2. Restart the ImageNow Server service.

3. On the Content Server computer, navigate to the directory where you installed Content Server, access the etc folder, and then open the inserverFT.ini file in a text editor.

Note If you installed Content Server on the ImageNow Server computer, this directory is [drive]:/inserver6/etc.

4. In the [Legacy] section, complete the following substeps:

1. To enable Content Server, set the enabled property to TRUE.

2. Set begin.creation.time to the date or date and time you want the first page of the legacy data to be indexed, using MM/DD/YYYY or MM/DD/YYYY HH:MM:SS format for a date and time.

3. Set end.creation.time to the date you want the last page of the legacy data to be indexed, using MM/DD/YYYY or MM/DD/YYYY HH:MM:SS format for a date and time.

Note You can also specify min for the earliest possible date or max for the latest possible date. If the begin.creation.time is earlier than the end creation time, Content Server indexes the oldest document first. If the end.creation.time is greater than the begin.creation.time, Content Server indexes the newest document first.

4. Set minutes.between.legacy.submissions to a number that represents the interval in minutes that Content Server takes to detect legacy documents.

5. Set legacy.submission.group.size to the number of pages to process.

6. Set mime.type.filter to specific file types to limit the types of files you want to index. The file type you specify is the file type for the first page of multi-page documents.

7. To filter on the document keys you want to index, set the values for the following settings:

• drawer.filter

• field1.filter

• field2.filter


• field3.filter

• field4.filter

• field5.filter

• doc.type.filter

Note You can use SQL wildcards in the filter, including _ and %.

5. Save and close the file.

6. On the Content Server computer, in the etc folder, open the inow.ini file in a text editor and complete the following substeps:

1. In the [Full Text] section, set the full.text.integration property to TRUE.

2. In the [OCR] section, verify that the ocr.integration property value is TRUE.

3. Save and close the inow.ini file.



Conf igure document submission in Content Server

If you want to submit ImageNow documents to Content Server automatically, complete one of the following options.

Situation Steps

Submit documents to Content Server using an Automated System Queue in Workflow.

1. In the Workflow Designer, add a Content queue to your workflow process.

2. In the Queue Properties dialog box, define the Success Action and Failure Action for the queue.

Submit scanned documents during batch processing.

1. On the ImageNow server computer, access the [drive]:/inserver6/etc directory and open the inserverBatch.ini file with a text editor.

2. Under [General], set the submit.to.content.server property to TRUE.


Note Automatically submitting all document batches to Content Server can slow system performance.

Start Content Server indexing process

You can use this procedure to index existing ImageNow documents in the database to Content Server.

1. On the ImageNow Server computer, start the following services:

• ImageNow Recognition Agent

• ImageNow Message Queueing Agent

• ImageNow OSM Agent

• ImageNow Job Agent

2. On the Content Server computer, restart the ImageNow Full Text Agent service.


Append ix : Ser ver conf igura t ion tab les

inow.in i

The following table provides definitions and sample data for the settings in the [Full Text] group of the inow.ini configuration file. Each setting offers two or more options, which are defined in the table below along with a description of each setting and its options. Use this table as a guide when customizing the file.

Note If you installed Content Server remotely, use the inow.ini file in the directory you specified during installation on the Content Server computer.

Group Setting Options Description

OCR ocr.integration TRUE

FALSE

Specifies whether OCR is enabled.

The default is FALSE.

Full Text full.text.integration TRUE

FALSE

Specifies whether Content Server submissions, indexing, and searching are enabled.

TRUE = Enabled.

FALSE = Disabled.


submissions.dir Any valid directory Specifies where internal bulk files are stored while waiting to be processed.

The default is $(IMAGENOWDIR6)/fulltext/submissions.

cleanup.bulk.files TRUE

FALSE

Specifies whether internal bulk files should be deleted after they are used. This setting may be temporarily turned off in order to help debug Content Server.

TRUE = Internal bulk files are deleted after use.

FALSE = Internal bulk files are not deleted.

The default is TRUE.

search.last.n. collections

Any positive integer up to the total number of collections

Specifies how many collections to search when a query is submitted to Content Server.

0 = Search all collections.

The default is 0.

collection.high.water. mark

Any positive integer

Specifies the maximum number of records allowed per Content Server collection.

The default is 5000000.



Full Text

(continued)

collection.group<n>.dir Any valid directory Specifies the directory to which new collections are dynamically allocated. You can distribute Content Server collections among group directories, each of which can house multiple collections. You can define up to nine different group directories by creating new, subsequently numbered collection.group<n>.dir settings.

content.submission. delay.seconds


Specifies how long in seconds ImageNow waits to submit the batch to Verify.

The longer ImageNow waits to submit the batch, the more documents are included.

The default is 300.

content.submission. threshold


Specifies the maximum number of documents ImageNow allows in a batch. If you reach the maximum, ImageNow submits the batch to Verify regardless of the content.submission.delay.seconds setting.

The default is 500.

index.new.content.in. batch

TRUE

FALSE

Specifies whether ImageNow indexes documents in batches.

TRUE = ImageNow indexes documents in batches.

FALSE = ImageNow does not index documents in batches.

The default is TRUE.

inserverFT. in i

The following table provides definitions and sample data for the settings in the inserverFT.ini configuration file. This table displays the INI settings under group headings in brackets, for example, [Logging], in the order the groups appear in the INI file. Each setting offers two or more options, which are defined in the table below along with a description of each setting and its options. Use this table as a guide when customizing the file.

Note If you installed Content Server remotely, use the inserverFT.ini file in the directory you specified during installation on the Content Server computer.


General fulltext.workqueue.suspenduntilindexed

TRUE

FALSE

Indicates whether to suspend the job in the work queue until after the full-text engine indexes the item.




num.job.workers Any positive integer

Specifies the number of worker threads to process indexing jobs.

The default is 4.

Logging debug.level.file 0

1

2

3

4

5

6

Defines the level of verboseness for debug logging to file.

Options range from 0 (minimal debugging information logged) to 6 (maximum debugging information logged).

Typically, you want minimal logging unless you are debugging an issue. If you increase the logging level, make sure that you decrease it after you finish debugging. Failure to do so can slow performance and consume hard disk space.

The default is 0.

Legacy enabled TRUE

FALSE

Defines whether Content Server is enabled or disabled.

begin.creation.time MIN

MAX

<Date>

<Date Time>

Defines the link date and time Content Server indexes the first page.

MIN = earliest possible date.

MAX = latest possible date.

<Date> = A date you specify in MM/DD/YYYY format.

<Date Time> = A date and time you specify in MM/DD/YYYY HH:MM:SS

format.

The default is MAX.

end.creation.time MIN

MAX

<Date>

<Date Time>

Defines the link date and time Content Server indexes the last page.

MIN = earliest possible date.

MAX = latest possible date.

<Date> = A date you specify in MM/DD/YYYY format.

<Date Time> = A date and (optional) time you specify in MM/DD/YYYY HH:MM:SS format.

The default is MIN.

minutes.between.legacy. submissions


Defines the number of pages per hour Content Server spools for indexing.

The default is 10.

legacy.submission. group.size


Defines the document size Content Server spools for indexing.

The default is 100.

mime.type.filter Text strings Defines parameters Content Server follows when performing indexing. Only documents matching the parameters specified in the filter settings are

file.type.filter

drawer.filter



field1.filter indexed. Separate multiple options with a semicolon (;), for example:

file.type.filter = tif;doc;xls

Content Server supports the following wildcards:

% = Zero or more characters.

_ = Exactly 1 character.

The following example indexes documents with filter values of “accounts payable” and “ap123”.

field1.filter = a%.

The default is %.

field2.filter

field3.filter

field4.filter

field5.filter

doc.type.filter

Network local.hostname.useoverride TRUE or FALSE

Specifies how Content Server identifies itself to remote agents wanting to connect to the services it offers.

FALSE = Content Server uses the name of the local computer as defined by the operating system.

TRUE = Content Server uses the name set in the local.hostname.override setting.


local.hostname.override Text strings Specifies the host name used for incoming connections when local.hostname.useoverride is set to TRUE.

The default is empty.

remote.hostname.useoverride TRUE or FALSE

Specifies whether Content Server uses the host name in the remote.hostname.override.<hostname> setting to connect to a remote agent.

If Content Server cannot resolve the host name of the agent and remote.hostname.useoverride is set to TRUE, Content Server searches for a replacement host name in the list of remote.hostname.override.<hostname> settings.

If Content Server cannot resolve the host name of the agent and remote.hostname.useoverride is set to FALSE, Content Server generates an exception error.

The default is FALSE



remote.hostname.override. <hostname>

Text strings Specifies the host name of the remote agent to use when remote.hostname.useoverride is set to TRUE.

In the following example, if Content Server cannot resolve the remote agent host name ComputerTwo and remote.hostname.useoverride is set to TRUE, it searches the list of all remote.hostname.override.<hostname> settings. When it locates ComputerTwo, it replaces that host name with the value set for remote.hostname.override.ComputerTwo. In this example, the new host name is ComputerB.

remote.hostname.useoverride = TRUE

remote.hostname.override.ComputerOne = ComputerA

remote.hostname.override.ComputerTwo = ComputerB

remote.hostname.override.ComputerThree = ComputerC

If remote.hostname.useoverride is set to TRUE and no host name is provided for remote.hostname.override.<hostname>, Content Server generates an exception error.

The default is empty.

active.threshold Any positive integer

Specifies the number of consecutive times a socket can be unreadable before the active monitor passes the socket off to the passive monitor.

The default is 800.

num.connection.workers Any positive integer

Specifies the number of worker threads in the connection pool.

The default is 2.

num.active.monitor.threads Any positive integer

Specifies the number of worker threads in the active socket monitor.

The default is 1.

poll.delay.msec Any positive integer

Specifies the number of milliseconds the active monitor waits between attempts to poll the open socket connections to check for incoming data.

The default is 30.

ip.port Any available port

Specifies the port OSM agent uses for incoming connections from Content Server.




ip.address Any valid IP address or DEFAULT

Specifies the IP address of OSM Agent.

DEFAULT = OSM Agent selects an available IP address.

The default is DEFAULT.

Note Do not change this setting unless OSM Agent is unable to secure an IP address.

heartbeat.timeout Any positive integer greater than 60

Specifies how long, in seconds, OSM Agent waits before terminating incoming connections from Content Server.


installation and setup guide - hyland content server installation and setup guide page 3 of 22 table...

Documents