Вы находитесь на странице: 1из 96

ImageNow Installation

and Setup Guide


Environment: Windows
DBMS: Microsoft SQL Server

Version: 6.4.1

Written by: Product Documentation, R&D


Date: November 2010

ImageNow and CaptureNow are registered trademarks of Perceptive Software, Inc. All other products produced by Perceptive
Software, Inc., including WebNow, are Perceptive Software trademarks. All other brands and product names mentioned in this
document are trademarks or registered trademarks of their respective owners.
©
Copyright 2010 Perceptive Software, Inc. All rights reserved.
Perceptive Software ImageNow Installation and Setup Guide

Table of Contents
Installing ImageNow ................................................................................................................................... 1
Installation Process ................................................................................................................................... 1
Prepare for the installation ..................................................................................................................... 1
Verify the installation checklist ............................................................................................................... 2
Verify TCP/IP Connectivity for ImageNow Server ................................................................................. 2
Open firewall and network ports for communication .............................................................................. 3
About INEMUSER.................................................................................................................................. 3
Installing ImageNow Server on Windows using Microsoft SQL Server .................................................... 4
ImageNow Server installation process .................................................................................................. 4
Download the ImageNow Server files.................................................................................................... 5
Create the INOW6 database ................................................................................................................. 5
Verify the INOW6 database user authentication ................................................................................... 6
Install ImageNow Server ........................................................................................................................ 6
Remove the DEP setting........................................................................................................................ 7
Tune the Microsoft SQL Server for the ImageNow Server on Windows ............................................... 8
Increase performance for ImageNow .................................................................................................... 8
Installing ImageNow Client ........................................................................................................................ 9
Install ImageNow Client attended .......................................................................................................... 9
Install ImageNow Client unattended .................................................................................................... 11
ADDLOCAL value definitions ............................................................................................................... 15
Installing an ImageNow Server license ................................................................................................... 15
Generate a license hardware fingerprint.............................................................................................. 16
Install ImageNow product licenses ...................................................................................................... 16
Start all ImageNow services .................................................................................................................... 18
Appendix A: Server configuration tables ............................................................................................... 19
inow.ini ..................................................................................................................................................... 19
inserver.ini ............................................................................................................................................... 30
inserverAlarm.ini ...................................................................................................................................... 37
inserverBatch.ini ...................................................................................................................................... 39
inserverEM.ini .......................................................................................................................................... 42
inserverImp.ini ......................................................................................................................................... 43
inserverJob.ini ......................................................................................................................................... 54
inserverMonitor.ini ................................................................................................................................... 56
inserverMQ.ini ......................................................................................................................................... 67
inserverTask.ini ....................................................................................................................................... 69

ii
Perceptive Software ImageNow Installation and Setup Guide

inserverWorkflow.ini ................................................................................................................................ 73
Appendix B: Client configuration tables ................................................................................................ 75
ImageNow.ini ........................................................................................................................................... 75
Additional settings ................................................................................................................................ 75
Index ........................................................................................................................................................... 93

iii
Perceptive Software ImageNow Installation and Setup Guide

Installing ImageNow
Running ImageNow on your network requires that you install the ImageNow Server on a server computer
and install at least one ImageNow Client on a computer that can access the server computer. You install
the client on all computers on which a user performs ImageNow tasks, such as scanning and linking.
ImageNow can be set to use encrypted communication through TCP/IP to pass data between the server
and clients. Each user accesses ImageNow from the client using a login ID and password.
An initial installation of ImageNow Client and Server requires that you complete several tasks in order.
The following installation information assumes that you are performing an initial installation of ImageNow
instead of upgrading from an earlier version of ImageNow. If you are updating ImageNow components,
make sure you first refer to the Update ReadMe document available on the Customer Portal of the
Perceptive Software web site at www.imagenow.com. Sections of the update readme may reference
procedures in this installation guide.
ImageNow components are not backwards-compatible. For example, you must install version 6.4.1 of the
ImageNow Client to work with version 6.4.1 of the ImageNow Server. For product technical specifications
and system requirements, ask your Perceptive Software representative for a copy of the Product
Technical Specifications document.

Installation Process
The following steps outline the high-level procedures that you need to perform to install and configure
ImageNow and information you need to verify before the installation.

Prepare for the installation


Before you install ImageNow, verify the following information:
• Obtain the TCP/IP host name or TCP/IP address and the authorization port of the computer to install
the ImageNow Server on. You need these to log in the first time.
• On Windows, verify that Microsoft TCP/IP is installed and configured. On Windows, make sure that
you have an NTFS-formatted volume for all ImageNow Server executables and directory structures.
• Make sure that you have sufficient disk space for executables and object storage.

Page 1 of 93
Perceptive Software ImageNow Installation and Setup Guide

Verify the installation checklist


This checklist describes the high-level procedures performed during this installation. Each of these
procedures is described in detail later in this guide.
1. Verify TCP/IP connectivity for ImageNow Server.
2. Create users and groups on the operating system network domain or directory, if needed. User
names and passwords in ImageNow Management Console must match the network user names and
passwords.
3. Make sure that you have a user name and password for the Customer Portal at
http://www.imagenow.com/support so you can download product files for installation.
4. Download and install the appropriate ImageNow Server for your operating system and database. You
need the base installation of Microsoft SQL Server using mixed mode authentication.
5. Download and install ImageNow Client.
6. Install ImageNow licenses, unless you are installing an evaluation copy.
7. Start all ImageNow services.
8. Create and test a login profile.
9. Log in to ImageNow to create and test groups and users.

Verify TCP/IP Connectivity for ImageNow Server


At the command prompt, type ping <server address> where <server address> is the IP address or the
host name of the computer running the ImageNow Server (for example, ping 206.18.19.25 or ping
notesrvr), and then press ENTER.
If you are properly connected, the message you receive appears similar to the one below:

Note If you receive the message "Bad IP address" in response to the ping request, you are not
connected to the ImageNow Server. Check with your system administrator to verify the ImageNow Server
IP address or name.

Page 2 of 93
Perceptive Software ImageNow Installation and Setup Guide

Open firewall and network ports for communication


To enable communications between ImageNow Server and the ImageNow Clients and agents, you must
open two TCP ports on your network. ImageNow Server uses ports 7200 and 6000 by default.
For best performance and stability, disable the Windows firewall on the ImageNow Server computer. If the
firewall cannot be disabled, set exclusions in the firewall for ports 6000 and 7200 for ImageNow Server
processes and remote agents.
• Port 7200. ImageNow Server requires port 7200 to display workflow alarms, send documents to
users, or perform auto-logoff on ImageNow Client. The port is also required for ImageNow Server to
communicate with remote agents, such as Fax Agent or Mail Agent. Port 7200 is the default port for
messaging communications, though you can modify the port by changing the mq.agent.ip.port setting
in the \inserver6\etc\inow.ini file after installing the ImageNow Server.
• Port 6000. By default, port 6000 is used for communications between ImageNow Server and
ImageNow Client. If you need to change this port, modify the inowd.port setting in the
\inserver6\etc\inserver.ini file after installing ImageNow Server.

About INEMUSER
In addition to the INUSER database user, the database setup scripts also set up a database user named
INEMUSER. If you have external applications that need to connect to the ImageNow database, you can
do so using this database user, The INEMUSER user can add, remove, and update data in
IN_EXTERN_MSG and IN_EXTERN_MSG_PROP tables in External Messaging Agent without risk of
corrupting information stored in the ImageNow database. External applications can access ImageNow
database only through INEMUSER.

Page 3 of 93
Perceptive Software ImageNow Installation and Setup Guide

Installing ImageNow Server on Windows using Microsoft SQL


Server
Important This document assumes you are installing ImageNow Server for the first time or that you have
no earlier versions running on your computer. To update or upgrade from a previous version, refer to one
of the following documents, available on the ImageNow Customer Portal:
• To update ImageNow Server from a previous version, make sure you first refer to the Update
ReadMe document available on the Customer Portal of the Perceptive Software website at
http://www.imagenow.com. Sections of the update readme may reference procedures in this
installation guide.
• To upgrade to ImageNow 6.4.1 from a version earlier than ImageNow 6.0, refer to the iUpgrade
Guide for version 6.4.1. For more information on available upgrade services, contact your Account
Executive.

Before you install, verify the following:


• On the ImageNow Server computer, check the Windows Event Viewer to make sure that the
computer has no DNS, hardware, or critical Windows errors.
• Verify that your system meets the requirements in the Product Technical Specifications. Then, verify
your product compatibility outside of ImageNow, such as the compatibility between the service pack
level of the operating system and your version of Microsoft SQL Server.
In addition, we recommend that you have the Microsoft SQL Server database running on a different
computer than the ImageNow Server computer.

ImageNow Server installation process


During this installation, you perform the following procedures:
• Download the ImageNow Server files
• Create the INOW6 database
• Increase the tempdb space and the transaction log size
• Verify the INOW6 database user authentication
• Install ImageNow Server
• Change the DEP settings

Page 4 of 93
Perceptive Software ImageNow Installation and Setup Guide

Download the ImageNow Server files


1. Go to the Perceptive Software web site at www.imagenow.com, click Customer Portal, and then
click Downloads.
2. In the Downloads page, in the right pane, in the Content section, click the Clear Search link.
3. In the Downloads page, in the left pane:
1. Expand Database and select MS SQL
2. Expand Platform and select Windows.
3. Expand Product and select ImageNow Server.
4. Expand Product Release and select 6.4.1.
4. In the Downloads page, in the right pane, select the check boxes for all of the following files:
• The latest build of the ImageNow Server, shown by the highest Build Number.
Note The latest build is either called a Set-Up Kit, which is a full release, or a Patch, which is a
complete build released after the Set-Up Kit.
• The latest DB Creation and Update Scripts
• The latest Product Readme.
• The latest Update Readme, which is required only when you are updating ImageNow Server from
a previous version.
5. Click the Download button and save the files to a temporary directory on your computer.
6. Review the readme files.
7. Unzip the files.
8. Verify the location of the Data directory for your SQL Server. For example, for SQL Server 2005, this
location is C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Data.
Note If you are not using this default location, you must modify the SunflowerSS.sql file for your
system before creating the SQL Server INOW6 database. To do this, edit the SunflowerSS.sql file
and change the path for each FILENAME parameter to match the actual SQL server location on your
computer.

Create the INOW6 database


Important This procedure varies depending on your version of SQL Server. Verify the data directory for
Microsoft SQL. This is the directory where the database files appear when the following .sql file runs. If
you are using more than one drive, you must open the SunflowerSS.sql file and update the drive in the
three path locations at the top of the script.
1. Log in to the SQL Server computer with a user ID that has local administrator rights, then click the
Start button, point to Programs, point to Microsoft SQL Server 2005, and then click SQL Server
Management Studio.
2. Click New Query. In the New Query dialog box, verify that the master database is selected.
3. On the File menu, select Open. In the Open dialog box, select the SunflowerSS.sql file, and then
click Open. If you are prompted to connect to the database, select Connect to make the connection.
4. To execute the query batch file, on the Query menu, select Execute. The execution is finished when
the completion message appears at the bottom of the Query window.

Page 5 of 93
Perceptive Software ImageNow Installation and Setup Guide

Verify the INOW6 database user authentication


1. In SQL Server Management Studio, in the Object Explorer pane, right-click your server, which is
typically the first item in the tree, and then select Properties.
2. In the Server Properties dialog box, under Select a Page, click Security. Under Server
Authentication, do one of the following actions:
• If SQL Server and Windows Authentication mode is selected, click OK.
• If Windows Only is selected, change it to SQL Server and Windows, click OK, and then click
Yes to restart the server. If you are not prompted to restart the server after changing the user
authentication method, click the Refresh button.
3. Click OK and then exit SQL Server Management Studio.

Install ImageNow Server


Note Before proceeding, make sure that the INOW6 database is installed and online.
1. In Windows Explorer, double-click the ImageNowServer-ExternalDB_<build>.exe file. If this is an
update and you are prompted to continue, click Yes.
2. In the Welcome to the Installation Wizard for ImageNow Server 6 page, click Next.
3. In the License Agreement page, review the information, scroll to the bottom of the agreement and
click in the agreement field, click I accept the terms in the license agreement, and then click Next.
4. In the Select ImageNow Database page, click Microsoft SQL Server, and then click Next.
5. In the Destination Folder page, select or browse to the location for ImageNow, and then click Next.
6. In the ImageNow Setup page, set the Port number to the server port number, in ImageNow Owner,
accept the administrator as the owner or supply a different owner, and then click Next. When
prompted, click Yes to confirm the owner.
7. In the Ready to Install the Program page, click Install.
1. In the ODBC SQL Server Wire Protocol Driver Setup dialog box, on the General tab, in
Database server, supply the database server name or IP address for the database server
2. In Database name, supply the database name (INOW6 is the default database name), and then
click OK.
Note For 64-bit systems, you can access the ODBC connection through the
C:\WINDOWS\SysWOW64 directory, using the ODBCAD32.exe file.
8. In the Installation Wizard Completed page, complete the following actions:
1. Select the Show the readme file checkbox.
2. If the Show the Windows Installers log check box appears, you can select the check box to view
the log file.
3. Click Finish.
9. If you receive a message to turn off DEP protection, click OK and then refer to the following “Remove
the DEP setting” section.
10. If you are prompted to restart, click Yes.
11. Optional. If you need to change privileges for INUSER to meet your company's security requirements,
have your DBA do so at this time. If you change privileges, make sure your DBA provides the
following minimum privileges for ImageNow: CONNECT, SELECT, INSERT, UPDATE, DELETE, and
EXECUTE privileges to all INOW6 database objects. EXECUTE privileges include those used for
stored procedures, packages, and functions.

Page 6 of 93
Perceptive Software ImageNow Installation and Setup Guide

Remove the DEP setting


You must remove the Data Execution Prevention (DEP) setting from the ImageNow executable files in
[drive:]\inserver6\bin if you operate in a Windows Server 2003 or Windows Server 2008 environment.
1. On the desktop, right-click My Computer (Windows Server 2003) or Computer (Windows Server
2008), and then select Properties.
2. In Windows 2008, under Tasks choose Advanced system settings. Windows 2003 does not require
this selection.
3. In the System Properties dialog box, on the Advanced tab, under Performance, click Settings.
4. 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.
5. Click Add.
6. In the Open dialog box, navigate to the \inserver6\bin directory, select an .exe file in that directory,
and then click Open. Repeat this step for each .exe file in the directory.
7. Click OK twice.
8. Restart your computer to save the DEP setting.

Page 7 of 93
Perceptive Software ImageNow Installation and Setup Guide

Tune the Microsoft SQL Server for the ImageNow Server on Windows
After you install ImageNow and any additional ImageNow agents you want to use, like ImageNow
Content Server or ImageNow Fax Agent, you can optionally tune your SQL Server settings to make your
database run more efficiently. For some SQL Server installations, the default number of processes is not
set high enough to cover the number of users accessing the database through ImageNow. To assess the
number of default max worker threads set in SQL Server, do the following:
• Open the Microsoft SQL Server Query Analyzer and run the following statement:
sp_configure 'max worker threads';
This statement returns a config_value, which is a configurable number of processes that can
simultaneously access the database server. You can increase this number to cover the number of users
accessing the SQL Server through ImageNow using the following procedure:
1. In the SQL Server Enterprise Manager, in the left pane, open your SQL Server group.
2. In the right pane, right-click your server, and then select Properties.
3. In the SQL Server Properties dialog box, click the Processor tab.
4. Under Processor Control, in Maximum worker threads, type a new number for the threads that
can accommodate the number of simultaneous ImageNow users.
5. Click OK. Stop and restart the database server as needed.
If you add an agent or increase the num.workers setting in the inserver.ini file or any of the ImageNow
agent .ini files, you must re-evaluate the max worker threads setting in SQL Server.

Increase performance for ImageNow


The following recommendations can increase performance after you have ImageNow running in
production. In addition, as your user base gets larger, you can make the following changes to maximize
the performance of your system.
To ensure the integrity of your data, set up a maintenance plan using the recommendations in the
ImageNow Best Practices for Microsoft SQL Server document, which is available on the ImageNow
Customer Portal. In addition, to avoid disk contention, if you can do so, move the database transaction
log to a different drive than the drive where the data files and operating system are located.
In your anti-virus application, disable on-access scanning for the \inserver6 directory, including all
subdirectories, and your database. When you use on-access scanning, your virus scanner continually
examines the ImageNow Server memory and file system, which can decrease performance. If you move
any directory outside of \inserver6, make sure you disable on-access scanning in the new location. You
can verify the location of ImageNow directories through the \inserver6\etc\inow.ini file.
Verify that the num.workers setting in the inserver.ini file is set to reflect an accurate number of users. The
suggested ratio is to set one thread for every ten users. If you change this setting, make sure you re-
evaluate the max worker threads setting in SQL Server, using the information in the "Tune the Microsoft
SQL Server for the ImageNow Server on Windows” section of this document.

Page 8 of 93
Perceptive Software ImageNow Installation and Setup Guide

Installing ImageNow Client


This topic assumes that you are installing ImageNow for the first time or that you have no earlier versions
of ImageNow running on your computer. These instructions enable you to install the ImageNow Client
directly on the local computer, shown below as “attended.” You can also install the ImageNow Client
silently on “unattended” installations by following the instructions in the “Install ImageNow Client
unattended” section of this document.
Important To install or update the ImageNow Client on Microsoft Vista, make sure that you are logged in
as a member of the "Administrators" group on the local Vista computer.

Install ImageNow Client attended


Before you install, verify the following:
• On the ImageNow Client computer, check the Windows Event Viewer to make sure that the computer
has no DNS, hardware, or critical Windows errors.
• Verify that your system meets the requirements in the Product Technical Specifications. Then, verify
your product compatibility outside of ImageNow, such as the compatibility between the service pack
level of the operating system and your version of Microsoft SQL Server.
Download the ImageNow Client files
1. Go to the Perceptive Software web site at www.imagenow.com, click Customer Portal, and then
click Downloads.
2. In the Downloads page, in the right pane, in the Content section, click the Clear Search link.
3. In the Downloads page, in the left pane:
1. Expand Platform and select Windows.
2. Expand Product and select ImageNow Client.
3. Expand Product Release and select 6.4.1.
4. In the Downloads page, in the right pane, select the following check box:
• The latest build of the ImageNow Client, shown by the highest Build Number.
Note The latest build is either called a Set-Up Kit, which is a full release, or a Patch, which is a
complete build released after the Set-Up Kit.
5. Click the Download button and save the files to a temporary directory on your computer.
6. Unzip the file.
Install the ImageNow Client
1. Double-click the ClientSetup_<build>.exe.zip.
2. Optional. If the Choose Setup Language dialog box appears, from the list, select the language you
want to use during installation, and then click OK.
3. In the Welcome to the ImageNow Installation Wizard for ImageNow Desktop Client page, click
Next.
4. In the License Agreement page, read the License Agreement and scroll to the bottom of the
agreement, select I accept the terms in the license agreement, and then click Next.

Page 9 of 93
Perceptive Software ImageNow Installation and Setup Guide

5. In the Custom Setup page, select the components you want to install by selecting the corresponding
icons:
• ImageNow Client Files – Installs all files necessary to run ImageNow Client software.
• Demo Applications and Images – Installs demonstration software.
• User Help – Installs end-user help files.
• Administrator Help – Installs the ImageNow integration and administration help files.
• Support for viewing non-graphic data – Installs filters for viewing non-raster based objects
(such as .txt, .rtf, .pdf, .xls, or .doc).
• ImageNow Printer – Installs all files necessary to run the ImageNow Printer.
6. In the Default Connection Profile page do the following actions, and then click Next:
1. In the Profile Name box, enter a name for the default profile.
2. In the Server Name box, enter the name or IP address of the ImageNow Server.
3. In the Port box, enter the port number ImageNow Server uses.
7. In the ImageNow Shortcuts page, select the shortcuts you want to appear, and then click Next.
8. In the Ready to Install the Program page, click Install.
9. In the Installation Wizard Completed page, perform the following actions:
1. Select the Show the readme file checkbox.
2. If the Show the Windows Installers log check box appears, you can select the check box to view
the log file.
3. Click Finish.
Remove the DEP setting
You must remove the Data Execution Prevention (DEP) setting from the ImageNow executable if you
operate in a Windows Server 2003 or Windows Server 2008 environment.
1. On the desktop, right-click My Computer (Windows Server 2003) or Computer (Windows Server
2008), and then select Properties.
2. In Windows 2008, under Tasks choose Advanced system settings. Windows 2003 does not require
this selection.
3. In the System Properties dialog box, on the Advanced tab, under Performance, click Settings.
4. 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.
5. Click Add.
6. In the Open dialog box, navigate to the \Program Files\ImageNow6\bin directory, select the
imagenow.exe file in that directory, and then click Open.
7. Click OK twice. Restart your computer to save the DEP setting.

Page 10 of 93
Perceptive Software ImageNow Installation and Setup Guide

Install ImageNow Client unattended


Installing the ImageNow Client silently is an automatic way to run “unattended” installations. If you follow
the procedures below, you will not install ImageNow Client using a standard InstallShield interface.
Additionally, you can use your own automation tools or login scripts to install ImageNow on multiple
workstations. Using this silent install method, you can do a custom install or use a combination of default
and customized settings.
This section applies to new installs, updates, and upgrades as follows:
• This section assumes that you have no earlier versions of ImageNow, version 6.x running on your
computer.
• Use these instructions when performing a first time installation or when upgrading from ImageNow,
version 5.x.
• These instructions are not recommended when you update from an earlier version of 6.x to the
current version. Instead, use the automatic updater. For more information about the automatic
updates, refer to the auto update readme.
The default features include the ImageNow Client, Demo Applications and Images, and the Help files.
You also get three shortcuts to open ImageNow Client; they are located on the Windows Start menu, the
Quick Launch menu, and the desktop. The default features do not include the ImageNow Printer.
Download and prepare the ImageNow Client files
1. Go to the Perceptive Software web site at www.imagenow.com, click Customer Portal, and then
click Downloads.
2. In the Downloads page, in the right pane, in the Content section, click the Clear Search link.
3. In the Downloads page, in the left pane:
1. Expand Platform and select Windows.
2. Expand Product and select ImageNow Client.
3. Expand Product Release and select 6.4.1.
4. In the Downloads page, in the right pane, select the following check boxes:
• The latest build of the ImageNow Client, shown by the highest Build Number.
Note The latest build is either called a Set-Up Kit (which is a full release) or a Patch, which is a
complete build released after the Set-Up Kit.
• The Silent Client Batch Files.
5. Click the Download button and save the files to a temporary directory on your computer.
6. Unzip the files.
7. Optional. If you use deployment software to push out your installations and if it requires you to use an
MSI file, extract ClientSetup.msi from the ClientSetup.exe.
1. If you have not already installed this version of the ImageNow Client on your ImageNow Server
computer, double-click the downloaded ClientSetup.exe file, which extracts the
ClientSetup.msi.
2. By default, ClientSetup.msi is extracted to the common application data folder. The Unique ID
varies with each build, so sort the Downloaded Installations folder by Date Modified and copy
the most recent entry containing this file to the folder that is required by your deployment
software.
3. In the Welcome to the ImageNow Installation Wizard for ImageNow Client page, click
Cancel.

Page 11 of 93
Perceptive Software ImageNow Installation and Setup Guide

Note Do not delete the Downloaded Installations\[Unique ID] folder or remove the MSI file. You
must have both for certain maintenance functionality.
Run the unattended installation
1. Set up your argument values to customize the unattended installation. If you do not manually set
argument values, then the default values are used during the installation.

Argument Description Default Example

INSTALLDIR The default, and [drive:]\Progr INSTALLDIR=\”C:\Program


recommended, installation am Files\IN6\”
directory is Files\ImageN
[drive:]\Program ow6
Files\ImageNow6.

ADDLOCAL Select which features are ImageNowCli ADDLOCAL=


installed. Optional features ent, Pixtran, ImageNowClient,
are DemoAppAndImages, Accusoft, Pixtran,Accusoft,SystemFiles,
UserHelp, AdminHelp, SystemFiles, LeadTools,OneDirectory
KeyView, and LeadTools,
ImageNowPrinter. OneDirectory
,
Important You must
DemoAppan
install ImageNowClient,
dImages,
Pixtran, Accusoft,
UserHelp,
SystemFiles, LeadTools,
AdminHelp,
and OneDirectory for the
KeyView
application to work
properly.
There are no spaces
allowed between the
words and the commas
when using this argument.
The core features are
required, but there are
some features that are
optional.
Note For definitions of
values for the ADDLOCAL
argument, refer to the
ADDLOCAL definitions
section.

IN_PROFILENAME The default connection DefaultProfile IN_PROFILENAME=default


profile name.

IN_SERVER_NAME The ImageNow Server Localhost IN_SERVER_NAME=MyServe


host name or host r
address.

IN_PORT_NO The ImageNow Server 6000 IN_PORT_NO=7000


port.

Page 12 of 93
Perceptive Software ImageNow Installation and Setup Guide

Argument Description Default Example

STARTMENUICON The default value is Yes, Yes STARTMENUICON=Yes


which means a shortcut
for the ImageNow Client is
created on the Start menu.
Allowed values are either
Yes or No.

DESKTOPICON The default value is Yes, Yes DESKTOPICON=No


which means a shortcut to
ImageNow Client is
created on the desktop.
Allowed values are either
Yes or No.

QUICKLAUNCHICON The default value is Yes, Yes QUICKLAUNCHICON=Yes


which means a shortcut to
ImageNow Client is
created on the Quick
Launch area of the
Taskbar. Allowed values
are either Yes or No.

REMOVEOLDVERSIONS This value only applies No REMOVEOLDVERSIONS=Ye


when the client setup s
detects a version of
ImageNow earlier than
6.0. The default is No, and
allowed values are either
Yes or No.

LOGFILE This value is optional, and No log file is LOGFILE=C:\logs\client-


the default is no log file generated install.txt
generated. If you use this unless you
argument, setup does not include this
create directories so the argument.
path for the log file
generation must be a
valid, existing path. This
argument is typically used
to diagnose installation
errors.

Page 13 of 93
Perceptive Software ImageNow Installation and Setup Guide

2. Enter one of the following commands, depending on whether you need to use the EXE or the MSI file.
You can use one of the commands in a Command Prompt window, in the provided batch file
(SilentClientSetup.bat), or create a command line script for your deployment software:
• If you can use the EXE file, which is the preferred and more reliable method, enter:
ClientSetup.exe /V“<argument list>”

EXAMPLE: ClientSetup.exe /V"/qb /L*V \"C:\logs\client-install.txt\"


INSTALLDIR=\"C:\Program Files\ImageNow6\" ADDLOCAL=
ImageNowClient,Accusoft,Pixtran,SystemFiles,LeadTools,OneDirectory
IN_PROFILENAME=default IN_SERVER_NAME=localhost IN_PORT_NO=6000
STARTMENUICON=Yes DESKTOPICON=Yes QUICKLAUNCHICON=Yes
REMOVEOLDVERSIONS=No"
• If you need to use the MSI file due to using deployment software that requires it, enter:
msiexec.exe /qb /i “[drive:]\<path>\ClientSetup.msi” <argument list>”

EXAMPLE: msiexec /qb /L*v "C:\logs\client-install.txt" /i


"ClientSetup.msi" INSTALLDIR="C:\Program Files\ImageNow6" ADDLOCAL=
ImageNowClient,Accusoft,Pixtran,SystemFiles,LeadTools,OneDirectory,User
Help,AdminHelp,KeyView,DemoAppAndImages IN_PROFILENAME=default
IN_SERVER_NAME=localhost IN_PORT_NO=7000 STARTMENUICON=Yes
DESKTOPICON=No QUICKLAUNCHICON=No REMOVEOLDVERSIONS=Yes
Note On the Start menu, click Run, and enter msiexec for help on its command-line
parameters.
3. Verify your installation.

Page 14 of 93
Perceptive Software ImageNow Installation and Setup Guide

ADDLOCAL value definitions


The ADDLOCAL argument enables you to specify which features are installed with ImageNow during an
unattended installation. The following table defines the values for ADDLOCAL.
Important You must install ImageNowClient, Pixtran, Accusoft, SystemFiles, LeadTools, and
OneDirectory for the application to work properly.

Value Description

ImageNowClient Core functionality of the ImageNow Client.


Installation of these features is mandatory to ensure the application works
Pixtran properly.
Accusoft

SystemFiles

LeadTools

OneDirectory

DemoAppandImages Demo applications and images.

UserHelp User help files.

AdminHelp ImageNow administrator help files.

KeyView Functionality to view non-graphical files in ImageNow.

ImageNowPrinter Feature that contains ImageNow Printer.

Installing an ImageNow Server license


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. To obtain the
hardware information for the ImageNow Server, you must be the admin user on Windows.

Page 15 of 93
Perceptive Software ImageNow Installation and Setup Guide

Generate a license hardware fingerprint


To obtain the license hardware fingerprint for the ImageNow Server, you must be the administrator user.
1. To obtain the inhwinfo.exe utility, go to the Perceptive Software web site at imagenow.com, click
Customer Portal, and then click Downloads.
2. In the Downloads page, in the right pane, perform the following substeps:
1. In the Content section, under Search for Content, in the Search in list, verify that All
Workspaces is selected.
2. In the for box, type Hardware fingerprint and then press ENTER.
3. Select the Hardware Fingerprint Application check box for your ImageNow Server operating
system.
4. Click Download and save the application to the [drive:]\inserver6\bin on your ImageNow Server
computer.
3. Navigate to [drive:]\inserver6\bin and then run the utility.
4. Send all of the text files generated by inhwinfo.exe to your Perceptive Software representative. The
generated files are named node_id_<computer_name>.txt, where <computer_name> is the name of
the ImageNow Server computer, and in_hwfp, which is the actual hardware fingerprint.
Note Back up any in_hwfp files in the \inserver6\etc directory and replace them with the in_hwfp that is
generated for the new licenses.

Install ImageNow product licenses


Before entering your license, you must have successfully installed the ImageNow Server and at least one
ImageNow Client. Only the owner or a manager user can complete this task. To obtain the hardware
fingerprint for the ImageNow Server, you must be the administrator user on Windows.
1. Contact your Perceptive Software representative to obtain the required ImageNow licenses and
optional licenses you want.
2. After you receive the inhwinfo.exe utility file from your Perceptive Software representative, execute
the utility on every new or existing ImageNow Server computer.
3. Send all of the text files generated by inhwinfo.exe to your Perceptive Software representative. The
generated files are named node_id_<computer_name>.txt, where <computer_name> is the name of
the ImageNow Server computer, and in_hwfp, which is the actual hardware fingerprint.
Note Back-up any in_hwfp files in the \inserver6\etc directory and replace them with the in_hwfp that
is generated for the new licenses.
4. When you receive the license files from your Perceptive Software representative, copy them to a
temporary folder where you can access them from an ImageNow Client.
5. Perform one of the following actions:
• Upload multiple licenses:
1. On the Start menu, point to All Programs, point to ImageNow 6, and then click ImageNow
6.
2. In the ImageNow login, click License Manager.
3. In the License Management dialog box, select Upload Licenses and click OK.
4. Navigate to the folder where the ImageNow license files are stored, select the .lic files to
upload, and then click Open.

Page 16 of 93
Perceptive Software ImageNow Installation and Setup Guide

5. 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.
• Upload a single license:
1. On the Start menu, point to All Programs, point to ImageNow 6, and then click ImageNow
6.
2. In the ImageNow login, click License Manager.
3. In the ImageNow License Manager dialog box, select Create a new license.
4. Click Browse to select a single *.lic file to upload, and then click Open.

Page 17 of 93
Perceptive Software ImageNow Installation and Setup Guide

• Enter a license manually:


1. On the Start menu, point to All Programs, point to ImageNow 6, and then click ImageNow
6.
2. In the ImageNow login, click License Manager.
3. In the ImageNow License Manager dialog box, select Create a new license.
4. Click OK.
5. In the ImageNow License Manager dialog box, in the Product list, select the product for
which you want to enter a license.
6. Type the information from your license form or as conveyed to you by telephone into the
remaining boxes.
7. Note Some of these boxes may appear dimmed and unavailable depending on the product
and license type.
8. Click Calculate to verify that the number displayed in the Checksum box matches the
number provided on your license form, and then click OK.
9. On the License Generation - Server Information dialog box, perform the following steps,
and then click OK:
1. In the User ID and Password boxes, type the user name and password of the owner or
a manager.
2. In the Server Name or IP Address box, type the ImageNow Server computer host name
or IP address.
3. In the Port Number box, type the port number of your ImageNow Server.
6. Click OK.

Start all ImageNow services


After all components are licensed, you can start all the ImageNow Services using ImageNow Server
Administrator (ISA).
1. On the Start menu, point to All Programs, point to ImageNow Server 6, and then click ImageNow
Server Admin.
2. In the ImageNow Server Administration dialog box, type the password for your ImageNow owner,
provided when you installed the ImageNow Server, and then click OK.
3. When the message box appears, asking if you want to start all services, click Yes.
4. When all services successfully start, the ImageNow Server Administration window shows "0
ImageNow Services stopped." You can click View Details to look at service status.

Page 18 of 93
Perceptive Software ImageNow Installation and Setup Guide

Appendix A: Server configuration tables


inow.ini
The following table provides definitions and sample data for the settings in the inow.ini configuration file.
This table displays the INI settings under group headings in brackets, for example, [Network], 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.

Group Setting Options Description

Network encryption.enabled TRUE Specifies whether data encryption


is enabled for the network.
FALSE
TRUE = Encryption is enabled.
FALSE = Encryption is not enabled.
The default is FALSE.

ipv6.enabled TRUE Specifies whether Internet Protocol


version 6 (IPv6) is enabled for the
FALSE
network. If it is disabled, the
process supports only IPv4.
TRUE = IPv6 is enabled.
FALSE = IPv6 is disabled.
The default is FALSE.

OSM filesystem.minimum. Any positive integer Specifies, in bytes, the memory


required.space threshold for OSM storage. When
the threshold is exceeded,
ImageNow displays a warning
message.

centera.capacitycheck. TRUE Specifies whether ImageNow


enabled Server checks the Centera device
FALSE
to determine if it has enough
memory to store the OSM tree.
TRUE = ImageNow Sever checks
for memory.
FALSE = ImageNow Server does
not check for memory.
The default is FALSE.

centera.cache.lifespan Any positive integer Specifies how long, in seconds,


Centera keeps the cache before
deleting it.
The default is 60.

Page 19 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

OSM centera.cache.dir Any valid directory Specifies the location of the


Centera cache.
(continued)
The default is
$(IMAGENOWDIR6)/osm.

Doc scan.as.creation TRUE Specifies whether the scanning


user or current user is identified as
FALSE
the document creation user.
TRUE = Scanning user is document
creation user.
FALSE = Current user is document
creation user.

DocLock doclock.lock_retries Any positive integer Specifies the number of attempts


allowed to lock a document.
The default is 5.

doclock.lock_timeout Any positive integer Specifies the number of


milliseconds ImageNow Server
waits between doclock.lock retries.
The default is 1000.

Directory user.dir Any valid directory Specifies where the user temporary
Locations directories are located.
The default is
$(IMAGENOWDIR6)/user.

worksheet.dir Any valid directory Specifies the worksheets directory.


The default is $(IMAGENOWDIR6)/
worksheet.

worksheet.shared.dir Any valid directory Specifies the location of shared


worksheet files.

ERM erm.enabled TRUE Specifies whether you are using


ERM.
FALSE
TRUE = ERM is enabled.
FALSE = ERM is disabled.
The default is FALSE.

ODBC odbc.dbms CTreeSQL Specifies the DBMS ImageNow


uses.
Oracle
SQLServer

Page 20 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

ODBC odbc.dsn Any valid database Specifies the name of your


name ImageNow database.
(continued)
The default is INOW6.

odbc.userid Any valid username Specifies the user ID for the ODBC
connection.
The default is inuser.

odbc.password Any valid password Specifies the password for the


ODBC connection, where each
character is advanced +1, so the
password “imagenow” would be
“jnbhfopx”.
The default is jnbhfopx.

odbc.use_dddriver TRUE Specifies whether ODBC uses the


DD driver. The default is TRUE.
FALSE

odbc.grid.max.fetch. Any positive integer Specifies that maximum number of


count records retrieved by ODBC at one
time.
This setting applies to workflow,
batch, related documents,
document search, project search,
ERM, and project viewer grids.
The default is 2000.

auth.odbc.dbms CTreeSQL ImageNow Server uses auth.*


settings to connect to the
Oracle
authorization database when
SQLServer logon.method is set to SQL.
This setting specifies the database
management system ImageNow
uses.

auth.odbc.dsn Any valid database Specifies the name of your


name ImageNow database.

auth.odbc.userid Any valid username Specifies the user ID for the ODBC
connection.
The default is inuser.

Page 21 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

ODBC auth.odbc.password Any valid password Specifies the password for the
ODBC connection, where each
(continued)
character is advanced +1, so the
password “imagenow” would be
“jnbhfopx”.
The default is jnbhfopx.

Logon Control logon.method SYSTEM Specifies the value that determines


what method to use when inserver
LDAP
authenticates user logons from
SQL ImageNow Client or WebNow
Client.
SYSTEM = inserver uses OS
authentication methods. For
Windows, inserver uses
authentication methods defined by
nt.logontype.
LDAP = inserver uses LDAP
authentication methods as defined
by LDAP values.
SQL = inserver uses SQL
authentication methods as defined
by auth.* values.
The default is SYSTEM.

nt.logontype 1 If logon.method is set to SYSTEM,


and Windows NT is the operating
2
system, this setting specifies the
3 type of NT User verification logon
ImageNow passes to the NT
LogonUser API call.
1 = Logon_Interactive
2 = Logon_Service
3 = Logon_Batch
The default is 1.
Note Do not change this setting
without first contacting Perceptive
Software Product Support.

Page 22 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logon Control client.validation TRUE Specifies whether ImageNow


allows the ImageNow Client to
(continued) FALSE
logon with the User ID provided in
the ImageNow logon dialog.
TRUE = ImageNow Client logs on
with the User ID provided in the
ImageNow logon dialog as long as
the user is logged into a valid
windows NT domain on the client
PC with a NT domain account that
is equal to the ImageNow User ID.
Otherwise, ImageNow validates
user and password requests via the
ImageNow Server.
FALSE = ImageNow Client does
not log on with the User ID
provided.
The default is FALSE.

nt.domain.list Domains separated Specifies the valid NT Domain list


by commas of which the ImageNow User ID
must already be logged into on the
requesting PC.f

LDAP<n>.server Any valid IP address If logon.method is set to LDAP,


or server name ImageNow uses the LDAP.*
settings for LDAP logon
authentication.
This setting specifies the IP
address or name of the server.
The default is 0.0.0.0.
Note You can define additional
LDAP server configurations by
creating additional LDAP settings
that are subsequently numbered,
such as LDAP2.server,
LDAP2.server.port, and so on.

LDAP<n>.server.port Any valid port Specifies the port number used by


number the LDAP server.
The default is 389.

LDAP<n>.use.ssl TRUE Specifies whether to use LDAP


over SSL.
FALSE
The default is FALSE.

Page 23 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logon Control LDAP<n>.method 1 or 2 Specifies which LDAP method to


use.
(continued)
1 = Direct binding
2 = Indirect binding
The default is 1.

LDAP<n>.ImageNow. Any list of valid Specifies lists of users or groups


Groups users separated by that use LDAP.
carets (^)

LDAP<n>.name. Any string If LDAP.method is set to 1, this


prepend setting specifies the string to add
before the user name.

LDAP<n>.name. Any string If LDAP.method is set to 1, this


append<n> setting specifies the string to add
after the user name.
You can specify multiple appends
by adding sequentially numbered
LDAP.name.append settings.

LDAP<n>.anonymous. TRUE Specifies whether the initial bind to


logon.enabled the LDAP server is anonymous
FALSE
during the search for user entries.
When this setting is TRUE, the
LDAP.login and LDAP.password
settings are ignored.
The default is FALSE.

LDAP<n>.login Any valid user DN Specifies the LDAP user DN for


binding to the LDAP server to begin
the search for user entries.

LDAP<n>.password Any valid password Specifies the LDAP password for


the user DN specified in the
LDAP.login setting.

LDAP<n>.base.dn Any valid DN Specifies the base or root DN of the


LDAP server where you want the
search to begin and search all its
containers. For example,
LDAP.base.dn="OU=Research and
Development, DC=acme,
DC=com".

Page 24 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logon Control LDAP<n>.login.attr Any valid attribute Specifies the LDAP user attribute
you want to search for in the LDAP
(continued)
server. The search looks for this
attribute whose value is the value
entered in the ImageNow login. For
example,
LDAP.login.attr=sAMAccountName.

LDAP.ssl.cert.path Any valid directory Specifies the location of the LDAP


SSL certificate.
The default is
$(IMAGENOWDIR6)/etc.

auth.sql.query Any valid string If logon.method is set to SQL, this


setting defines the SQL query string
for authentication.
For example, "SELECT * FROM
SQLAUTH WHERE
LOGINNAME='[USERID]' AND
PASSWORD='[PASSWORD]' AND
USERSTATUS=1"[USERID] and
[PASSWORD] will be replaced with
the strings specified in
auth.odbc.userid and
auth.odbc.password.
Warning Do not use a "SELECT
COUNT (*)...". This query must
return one row if valid and no rows
if invalid.

logon.singlesignon. TRUE Specifies whether users running


enable multiple desktop clients can use the
FALSE
same workstation.
TRUE = ImageNow Server allows
users running multiple desktop
clients on the same workstation to
logon to both clients by logging into
one client and sharing the
connection between the two clients.
The user will only be prompted to
log in once.
FALSE = ImageNow Server does
not allow single sign on.
The default is TRUE.

Page 25 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logon Control logon.minclientversion Any valid ImageNow Specifies the Image Now version
Client version number the Windows Client must
(continued)
number that uses meet or exceed to log onto the
the general format: ImageNow Server successfully.
<major>.<minor>.<r The default setting is 0.0.0.1 and
evision>.<build> may be changed to force upgrades
for revisions and builds within the
same release version.

logon.minclientversion. Any text string Specifies the message that will


msg appear when the user’s Windows
Client version does not meet or
exceed the logon.minclientversion
setting.
The default is “Consult your system
administrator for assistance in
upgrading ImageNow Client.”

Message mq.agent.ip.address Any valid IP address Specifies which network interface


Queuing or DEFAULT that Message Queuing Agent
listens to for incoming connections.
If you change this value to
something other than DEFAULT,
Message Queuing Agent monitors
only the specified IP address.
The default is DEFAULT. This
setting only takes effect if you do
not use the message queuing
override settings.

mq.agent.ip.port Any valid port Specifies the port ImageNow uses


for messaging communications.
The default is 7200.

mq.reconnect.interval Any positive integer Specifies how long, in seconds,


ImageNow waits before
reattempting to connect to Message
Queuing Agent after a failed
attempt.
The default is 60.

mq.agent.ip.general. Any valid IP address Specifies which IP address clients


override or DEFAULT and agents use to connect to the
Message Queuing Agent. If
DEFAULT is specified then the
value for mq.agent.ip.port is used.
The default is DEFAULT.

Page 26 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Forms form.integration TRUE Specifies whether forms are


enabled.
FALSE
The default is TRUE.

OCR ocr.integration TRUE Specifies whether OCR is enabled.


FALSE The default is FALSE.

Data Capture data.capture. TRUE Specifies whether DataCapture is


integration enabled.
FALSE
The default is FALSE.

Full Text full.text.integration TRUE Specifies whether Content Server


submissions, indexing, and
FALSE
searching are enabled.
TRUE = Enabled.
FALSE = Disabled.
The default is FALSE.

submissions.dir Any valid directory Specifies where internal bulk files


are stored while waiting to be
processed.
The default is
$(IMAGENOWDIR6)/fulltext/submis
sions.

cleanup.bulk.files TRUE Specifies whether internal bulk files


should be deleted after they are
FALSE
used. This setting may be
temporarily turned off in order to
help debug the Content Server.
TRUE = Internal bulk files are
deleted after use.
FALSE = Internal bulk files are not
deleted.
The default is TRUE.

search.last.n. Any positive integer Specifies how many collections to


collections up to the total search when a query is submitted
number of to Content Server.
collections
0 = Search all collections.
The default is 0.

Page 27 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Full Text collection.high.water. Any positive integer Specifies the maximum number of
mark records allowed per Content Server
(continued)
collection.
The default is 5000000.

collection.group<n>.dir Any valid directory Specifies the directory to which new


collections are dynamically
allocated. Content Server
collections can be distributed
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. Any positive integer Specifies how long in seconds


delay.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. Any positive integer Specifies the maximum number of


threshold 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. TRUE Specifies whether ImageNow


batch indexes documents in batches.
FALSE
TRUE = ImageNow indexes
documents in batches.
FALSE = ImageNow does not index
documents in batches.
The default is TRUE.

Page 28 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Fax Out fax.out.integration TRUE Specifies whether outbound faxing


is enabled.
FALSE
TRUE = Outbound faxing is
enabled.
FALSE = Outbound faxing is
disabled.
The default is FALSE.

Locale supported.locale EN, FR, DE, ES Specifies the languages that are
supported.
EN = English
FR = French
DE = German
ES = Spanish
The default is EN.

Audit audit.format 1 Specifies where audit details are


stored.
2
1 = XML formatted file
3
2 = Database
3 = Both the XML file and the
database
The default is 1.

login.audit.level 0 Specifies the verboseness level for


user authentication auditing.
1
0 = no authentication auditing
2
1 = audit only failed authentication
attempts
2 = audit all authentication attempts
The default is 0.

Auto Form auto.form.integration TRUE Determines whether Auto Form


integration is active.
FALSE
TRUE = Auto Form integration is
activated.
FALSE = Auto Form integration is
deactivated.

Page 29 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserver.ini
The following table provides definitions and sample data for the settings in the inserver.ini configuration
file. This table displays the INI settings under group headings in brackets, for example, [General], 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.

Group Setting Options Description

General remove.old.service 1 Specifies whether ImageNow


Server removes old services.
0
1 = ImageNow Server removes
services.
0 = ImageNow Server does not
remove services.
The default is 0.

inowd.heartbeat. Any positive integer Specifies the number of seconds


timeout the ImageNow Server waits to
receive a heartbeat from the client
before terminating the connection.
The default is 3600.

client.autotimeout. TRUE Specifies whether ImageNow


enabled Server automatically times out the
FALSE
client after the client reaches the
client.autotimeout value.
TRUE = ImageNow Server times
out the client.
FALSE = ImageNow Server does
not time out the client.
The default is FALSE.

client.autotimeout Any positive integer If client.autotimeout.enabled is set


to TRUE, this setting specifies the
number of minutes ImageNow
Server waits before timing out the
client.
The default is 30.

num.workers Any positive integer Specifies the number of worker


threads in the main pool.
The default is 15.

webnow.url Any valid URL Specifies the URL for WebNow.


The default is http://host/webnow/.

Page 30 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

General webnow.getpage Any valid URL page Specifies the home page for
location WebNow.
(continued)
The default is
index.jsp?action=filter&.

client. TRUE Specifies whether Document


alwaysdeletelocalcopy Management enables the user to
FALSE
save a local copy of a document
when checking it into ImageNow.
TRUE = The local copy is always
deleted when checking the
document in as a new version.
FALSE = The user has the option to
delete the local copy when
checking the document in as a new
version.
The default is FALSE.

Network inowd.port Any valid port Specifies the port number of


ImageNow Server.
The default is 6000.

inowd.ip.address Any valid IP address Specifies the IP address of


ImageNow Server.
DEFAULT = ImageNow Server
determines its own IP address.
The default is DEFAULT.

Logging socket.level.file 0 Specifies how ImageNow Server


logs socket communication.
1
0 = ImageNow Server does not log
2
communication.
3
1 = ImageNow Server logs only
function names.
2 = ImageNow Server logs all
socket transactions.
3 = ImageNow Server logs all
socket transactions including
SERV_SYNC.
The default is 0.

Page 31 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level ImageNow


Server uses to log errors for
(continued)
troubleshooting.
Typically, you want to set minimal
logging unless you are debugging
an issue. If you increase the
logging, make sure that you set the
logging level back down after you
finish debugging. Failure to do so
can greatly affect performance and
hard disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose the logging. For example,
1 offers minimal logging, whereas 6
offers logging that offers the most
information.
The default is 0.
Tip You can specify unique values
for specific users by placing the
user name at the beginning of the
string. For example, to set logging
to 5 for user jsmith, create a string
that states: jsmith.debug.level.file =
5.

Anonymous anonymous.logon. TRUE Specifies whether ImageNow


Login enabled Server allows anonymous log on.
FALSE
The default is FALSE.

number.of.anonymous. Any positive integer Specifies how many anonymous


users users can be logged on to
ImageNow Server.
The default is 0.

AutoUpdate max.users Any positive integer Specifies the maximum number of


update services allowed to login
simultaneously.
The default is 5.

package.dir Any valid directory Specifies the directory that contains


the update packages.
The default is
$(IMAGENOWDIR6)/update/dist.

Page 32 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

AutoUpdate test.package.dir Any valid directory This setting is optional.


(continued) Specifies the directory that contains
test packages.

test.nodes Valid client nodes Specifies a list of client nodes


separated by designated to receive test
commas packages identified in
test.package.dir.
Separate client nodes with
commas.

window.start.time Any integer from 1 Specifies the approximate start time


to 24 in whole hours update services
starts checking for updates. Times
are specified in whole hours.
For example, 18 means 6:00 PM.
The default is 18.

window.end.time Any integer from 1 Specifies the approximate time in


to 24 whole hours update services stops
checking for updates. Times are
specified in whole hours.
For example, 7 means 7:00 AM.
The default is 7.

rollback.package Any text string This setting is optional.


Specifies the name of the package
that ImageNow Server rolls back.
Note If you specify a rollback
package, updates are not
processed.

update.config.mode 0 Specifies whether or not ImageNow


Client should automatically
1
configure what server the update
service should contact. This occurs
during log on.
0 = ImageNow does not change the
server and port configuration of the
update service during log on.
1 = ImageNow changes the server
and port configuration of the update
service during log on. Specify the
server IP address and port in
auto.update.ip.address and
auto.update.ip.port.

Page 33 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

AutoUpdate auto.update.ip.address Any valid IP address This setting is optional.


(continued) If update.config.mode is set to 1,
this setting specifies the new server
IP address for update services.

auto.update.ip.port Any valid port This setting is optional.


If update.config.mode is set to 1,
this setting specifies the new server
port for update services.
The default is 6010.

ClientINI client.ini.sync.mode 0 Specifies whether ImageNow.ini


updates are automatically
1
downloaded to the client. This
2 occurs during log in.
0 = Disabled, the client does not
download updates.
1 = This setting tells the client to
check for updates on log in and to
download any updates.
2= This setting tells the client to
download the file every time the
client logs in to the server.
The default is 0.

client.ini.file.path Any valid path. Specifies the path to the


ImageNow.ini file used to update
client .ini files.
The default is
$(IMAGENOWDIR6)/etc/ImageNow
.ini

client.ini.search.grid. Any valid path. Specifies the path to the


file.path SearchGrid.ini file used to update
client .ini files.
The default is
$(IMAGENOWDIR6)/etc/clientINI/S
earchGrid.ini

Page 34 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Remote vsl.extended.operators. TRUE Specifies whether ImageNow adds


enabled the “ends with” and “contains”
FALSE
operators for search grids.
TRUE = “Ends with” and “contains”
appear in the search grid operator
list.
FALSE = “Ends with” and “contains”
do not appear in the search grid
operator list.
The default is FALSE.

Timing timing.enabled 0, 1, 2 Specifies whether Client


Performance is turned on. The
default is 1.
0 = Client Performance is disabled.
1 = Client Performance is enabled.
2 = Client Performance is enabled
and uses the
timing.threshold.percentage setting.

timing.threshold. Any positive integer When timing.enabled = 2, specifies


percentage the threshold as a percentage.
When the percentage of documents
exceed the specified threshold, the
data is included in the report.
For example, 10 = that if 10% of the
documents exceed the threshold,
then the event is included in the
performance report.

timing.collection. Any positive integer Specifies the number of hours


interval Client Performance collects data
before sending the data to
ImageNow Server.

timing.data.life Any positive integer Specifies the number of days you


want ImageNow to keep a report
before deleting it from the
database.

timing.max.purge.size Any positive integer Specifies the maximum number of


records Client Performance deletes
at one time.

timing.cleanup.period Any positive integer Specifies the number of hours


Client Performance waits after
completing a purge to check for
data to start another purge.

Page 35 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Timing timing.purge.delay Any positive integer Specifies the number of seconds


Client Performance waits to delete
(continued)
data when the total number of
records to be deleted exceeds the
setting for max.purge.size.

timing.category.viewer. TRUE Specifies whether ImageNow


enabled collects data based on a threshold
FALSE
you define for opening a document.

timing.category.viewer. Any positive integer Specifies the number of seconds


report.threshold you want to establish as the
threshold for opening a document.
Any events that exceed the
threshold are included in the
Threshold Count column in the
performance report.

timing.category. TRUE Specifies whether ImageNow


workflow.enabled collects data based on a threshold
FALSE
you define for routing an item
forward.

timing.category. Any positive integer Specifies the number of seconds


workflow.report. you want to establish as the
threshold threshold for routing an item
forward.
Any events that exceed the
threshold are included in the
Threshold Count column in the
performance report.

timing.category. TRUE Specifies whether ImageNow


worksheets.enabled collects data based on a threshold
FALSE
you define for opening a form.

timing.category. Any positive integer Specifies the number of seconds


worksheets.report. you want to establish as the
threshold threshold for opening a form.
Any events that exceed the
threshold are included in the
Threshold Count column in the
performance report.

Page 36 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverAlarm.ini
The following table provides definitions and sample data for the settings in the inserverAlarm.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[General], 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.

Group Setting Options Description

General remove.old.service 1 Specifies whether Alarm Agent


removes old services.
0
1 = Alarm Agent removes services.
0 = Alarm Agent does not remove
services.
The default is 0.

polling.interval Any positive integer Specifies how often, in seconds,


Alarm Agent searches for new
alarms.
Note Do not change this value
without first consulting Perceptive
Software Product Support.
The default is 15.

Modem comm.port Any valid port Specifies the port Alarm Agents
uses to connect to the modem.
The default is COM1.

baud.rate Any positive integer Specifies the baud rate of the


modem.
The default is 9600.

Email smtp.server Any valid IP address Specifies the SMTP server Alarm
or server name of Agent uses for e-mail alarms.
an SMTP server
The default is localhost.

port Any valid port Specifies the e-mail server port.


The default is 25.

Page 37 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Alarm Agent


uses to log errors for
troubleshooting.
Typically, you want minimal logging
unless you are debugging an issue.
If you increase the logging level,
make sure that you set it back
down after you finish debugging.
Failure to do so can slow
performance and consume hard
disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose the logging. For example,
1 offers minimal logging, whereas 6
offers logging that offers the most
information.
The default is 0.

debug.level.pipe 0 through 6 Specifies the level Alarm Agent


uses to log pipe errors for
troubleshooting.
0 = Logging is off.
1 = The least verbose logging.
6 = The most verbose logging.
The default is 0.

Page 38 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverBatch.ini
The following table provides definitions and sample data for the settings in the inserverBatch.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[General], 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.

Group Setting Options Description

General poll.interval Any positive integer Specifies how often, in seconds,


the Batch Agent searches for new
batches.
Note Do not change this value
without first consulting Perceptive
Software Product Support.
The default is 1.

number.of.server. Any positive integer Specifies the number of Batch


agents Agents.
The default is 1.

pause.between. Any positive integer Specifies, in milliseconds, how long


transactions Batch Agent pauses between
pages when processing a batch.
The default is 100.

barcode.fail.to.queue. TRUE Specifies whether Batch Agent can


enabled fail a batch with an unverified
FALSE
barcode.
TRUE = Batch Agent can fail a
batch with unverified barcodes.
FALSE = Batch Agent does not fail
unverified barcodes.
The default is FALSE.

submit.to.content. TRUE Specifies whether full-text


server searching is enabled for batches.
FALSE
TRUE = Full-text searching is
enabled.
FALSE = Full-text searching is
disabled.
The default is FALSE.

Page 39 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Batch Agent


uses to log errors for
troubleshooting.
0 = Logging is off.
1 = The least verbose logging.
6 = The most verbose logging.
The default is 0.

debug.level.pipe 0 through 6 Specifies the level Batch Agent


uses to log pipe errors for
troubleshooting.
0 = Logging is off.
1 = The least verbose logging.
6 = The most verbose logging.
The default is 0.

ReadSoft perform.readsoft.export TRUE Specifies whether Batch Agent


exports files in to ReadSoft for
FALSE
optical character recognition.
TRUE = Batch Agent exports files
to ReadSoft.
FALSE = Batch Agent does not
export files to ReadSoft.
The default is FALSE.

export.mode 1 Specifies pages to export to


ReadSoft.
2
1 = Only first page.
2 = After every store page.

selected.batches.only TRUE Specifies whether to process


selected batches based on criteria.
FALSE
Specify the criteria in the
selection.criteria setting.
TRUE = Process selected batches.
FALSE = Process all batches.

selection.criteria creation.user Specifies the criteria for batches


when the selected.batches.only
setting is set to “TRUE”.

creation.user Any valid user Specifies the creation user when


names separated by selection.criteria is set to
^. creation.user.

Page 40 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

ReadSoft file.name Any combination of : Specifies the file name format of


exported ReadSoft files.
(continued) <<drawer>>
<<folder>>
<<tab>>
<<f3>>
<<f4>>
<<f5>>
<<docid>>
<<doctype>>

export.directory.<n> Any valid directory Specifies the directory to which


Batch Agent exports files for
ReadSoft.
You can specify up to five different
directories subsequently numbered.
For example, for two export
directories you would have the
following settings: export.directory.1
and export.directory.2.

failed.export.directory Any valid directory Specifies the directory to which


Batch Agent exports files that failed
OCR by ReadSoft.

Page 41 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverEM.ini
The following table provides definitions and sample data for the settings in the inserverEM.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[General], 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.

Group Setting Options Description

General num.workers Any positive integer Specifies the number of worker


threads used when the External
Message Agent starts.
The default is 3.

message.pulling. Any positive integer Specifies how often, in seconds,


interval the agent checks and downloads
messages from the external
message database.
The default is 60.

max.messages.per. Any positive integer Specifies the maximum number of


type processed messages to pull each
time from the database for each
message type.
The default is 100.

Logging debug.level.file 0 through 6 Specifies the level Extern


Messaging Agent uses to log
errors for troubleshooting.
Typically, you want minimal
logging unless you are debugging
an issue. If you increase the
logging level, make sure that you
set it back down after you finish
debugging. Failure to do so can
slow performance and consume
hard disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose the logging. For example,
1 offers minimal logging, whereas
6 offers logging that offers the
most information.
The default is 0.

Page 42 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverImp.ini
The following table provides definitions and sample data for the settings in the inserverImp.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[General], 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.

Group Setting Options Description

General import.mode INDEX_FILE Specifies the type of file or files


Import Agent uses as index and
COMBO
data files.
KEYMAPPING
INDEX_FILE =Import Agent
TIFF_TEXT_COMBO obtains document keys from a
separate index file, and the data
FILENAME file is available on ImageNow
DATA_CAPTURE Server. The index file can be
single- or multi-line.
COMBO = Import Agent obtains
document keys from the first line
of the file and imports the
remaining data in the file.
KEYMAPPING = This setting
relies on the index keys section
defined in the inserverImp.ini file
TIFF_TEXT_COMBO = This mode
is used to import TIFF objects that
are accompanied by a text file
containing the textual
representation of the TIFF file.
Import Agent generates index
values from searching the text file.
FILENAME = This mode is used
when the import objects are data
only with the index values being
the file name.
The default is INDEX_FILE.
DATA_CAPTURE = This mode is
used to send files to Data Capture
for indexing. Key mapping is not
performed by this agent because
files are indexed according to the
specified Data Capture template.

Page 43 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

General import.directory.<n> Any valid directory Specifies the directory that Import
Agent monitors. You can define an
(continued)
unlimited number of directories by
creating new, subsequently named
import.directory.<n>. For example,
import.directory.receipts and
import.directory.invoices.
The default is
$(IMAGENOWDIR6)/import.

poll.interval Any positive integer Specifies how often, in seconds,


the Import Agent searches for new
files.
Note Do not change this value
without first consulting Perceptive
Software Product Support.
The default is 1.

pause.between. Any positive integer Specifies, in milliseconds, how


transactions long Import Agent pauses between
pages when processing a batch.
The default is 100.

send.to.queue.<n> Any existing queue Specifies the queue to which


Import Agent sends imported files.
For each import.directory defined,
create a subsequently named
send.to.queue.<n>. For example,
send.to.queue.invoices and
send.to.queue.receipts.

delete.source. DELETE Specifies whether Import Agent


objects.after.import deletes the source file or moves it
MOVE
to a specified location after it’s
imported.
DELETE = Import Agent deletes
the source file after importing.
MOVE = Import Agent moves the
file.
The default is MOVE.

Page 44 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

General import.failed. Any valid directory Specifies the directory to which


directory.<n> Import Agent stores source files
(continued)
that failed to import. For each
import.directory defined, create a
subsequently name
import.failed.directory.<n>. For
example,
import.failed.directory.invoices and
import.failed.directory.receipts.

import.complete. Any valid directory Specifies the directory to which


directory.<n> Import Agent stores source files
after importing them. For each
import.directory defined, create a
subsequently name
import.failed.directory.<n>. For
example,
import.complete.directory.invoices
and
import.complete.directory.receipts.

submit.to.content. TRUE Specifies whether Import Agent


server collects data from incoming
FALSE
batches.
TRUE = Batch Agent collects data.
FALSE = Batch Agent does not
collect data.
The default is FALSE.

num.directory.workers Any positive integer Specifies the number of worker


threads that are monitoring for
new files.
The default is 1.

num.import.workers Any positive integer Specifies the number of worker


threads used when importing
documents into the ImageNow
Server.
The default is 1.

Mode index.file.ext Any valid file Specifies the file extension Import
INDEX_FILE extension Agent uses to identify the index file
when import.mode is set to
INDEX_FILE.
The default is INX.

Page 45 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Mode field.delim Any character Specifies the character Import


INDEX_FILE Agent uses as the field delimiter.
(continued) The default is ^.

index.file.status.report 0 Specifies how Import Agent


reports the status of index files as
1
a result of importing.
2
0 = Import Agent does not
generate a report.
1 = Import Agent generates a
report only when an import fails.
2 = Import Agent generates a
report for successful and failed
imports.
The default is 0.

index.file.retry.attempts Any positive integer Specifies how many times Import


Agent reattempts importing a file
before considering it failed.
The default is 1.

use.page.num TRUE Specifies whether Import Agent


uses page numbers when
FALSE
generating keys.
The default is FALSE.

split.multipage.tiffs TRUE Specifies whether Import Agent


splits multiple page TIFF files into
FALSE
one file per page.
The default is FALSE.

multi.doc.mode TRUE Specifies whether each page of


the imported file is a unique
FALSE
document in ImageNow.
TRUE = Each page of the file is a
unique ImageNow document
(depending on key setup).
FALSE = The entire file is a single
ImageNow document (depending
on key setup).
The default is FALSE.

Page 46 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Mode COMBO combined.inx.data. Any valid file Specifies the file extension Import
file.ext extension Agent uses to find the keys, which
are contained in the first line of the
file.
The default is CMX.

field.delim Any character Specifies the character Import


Agent uses as the field delimiter.
The default is ^.

Mode KEY image.file.ext Any valid image file Specifies the file extension Import
MAPPING extension Agent uses as the image file.
The default is TIF.

split.multipage.tiffs TRUE Specifies whether Import Agent


splits multi-page TIFF files into
FALSE
one file per page.
The default is FALSE.

multi.doc.mode TRUE Specifies whether each page of


the imported file is a unique
FALSE
document in ImageNow.
TRUE = Each page of the file is a
unique ImageNow document
(depending on key setup).
FALSE = The entire file is a single
ImageNow document (depending
on key setup).
The default is FALSE.

Mode index.file.ext Any valid file Specifies the file extension Import
TIFF_TEXT_ extension Agent uses to identify the index file
COMBO when import.mode is set to
TIFF_TEXT_COMBO
The default is TXT.

image.file.ext Any valid image file Specifies the file extension Import
extension Agent uses as the image file.
The default is TIF.

Page 47 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Mode multi.doc.mode TRUE Specifies whether each page of


TIFF_TEXT_ the imported file is a unique
FALSE
COMBO document in ImageNow.
(continued) TRUE = Each page of the file is a
unique ImageNow document
(depending on key setup).
FALSE = The entire file is a single
ImageNow document (depending
on key setup).
The default is FALSE.

subsequent.image. TRUE Specifies whether subsequent


use.first.txt images in an import use the same
FALSE
index file.
The default is FALSE.

Mode image.file.ext Any valid image file Specifies the file extension Import
FILENAME extension Agent uses as the image file.
The default is PDF.

file.name Any combination of: Specifies the syntax used to name


the file. For example:
<<drawer>>
<<drawer>>_<<folder>>_<<tab>>
<<folder>>
_
<<tab>>
<<doctype>>
<<f3>>
<<f4>>
<<f5>>
<<doctype>>
<<literal>>
<<uniqueID>>
<<date/time>>

field.delim Any character Specifies the character Import


Agent uses as the field delimiter.
The default is ^.

split.multipage.tiffs TRUE Specifies whether Import Agent


splits multi-page TIFF files into
FALSE
one file per page.
The default is FALSE.

Page 48 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Mode multi.doc.mode TRUE Specifies whether each page of


FILENAME the imported file is a unique
FALSE
document in ImageNow.
(continued)
TRUE = Each page of the file is a
unique ImageNow document
(depending on key setup).
FALSE = The entire file is a single
ImageNow document (depending
on key setup).
The default is FALSE.

Mode DATA_ extension.to.capture Any valid file Specifies the extension of the files
CAPTURE extension to import.
The default is TIF.

bypass.qa TRUE Specifies which batches skip the


QA process.
FALSE
The default is TRUE.

use.previous.keys. TRUE Specifies which document keys to


when.missing use if Data Capture encounters a
FALSE
file from which it cannot extract
document keys.
TRUE = Use keys from the
previously processed document.
FALSE = Use default keys.
The default is FALSE.

capture.template.<n> Any valid template. Specifies which template to use.


Each directory monitored by this
agent can use a different template.
For each import.directory defined,
create a subsequently name
capture.template.<n>. For
example,
capture.template.invoices and
capture.template.receipts.
If you specify a directory as
monitored, but do not define a
template for that directory, the
Import Agent stops processing and
shuts down.

split.multipage.tiffs TRUE Specifies whether Import Agent


splits multi-page TIFF files into
FALSE
one file per page.
The default is FALSE.

Page 49 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Mode DATA_ scan.user.name Any valid user name Specifies an identifier that is
CAPTURE required by DataCapture and that
optionally allows non-manager
(continued)
users to access DataCapture
results in the batch grid.

Key mapping doc.type Valid doc type Specifies the index key Import
Agent uses for the doc type.
DEFAULT
<text> = A valid doc type.
DEFAULT = The default doc type
identified in ImageNow.
The default is DEFAULT.

drawer <text> Specifies the index key Import


Agent uses for the drawer, folder,
DEFAULT
folder tab, and fields 3, 4, and 5.
<text> = A literal string of text up to
tab 39 characters.

f3 DEFAULT = The default drawer,


folder, tab, or field 3, 4, or 5
f4 specified in ImageNow.
The default is DEFAULT.
f5

File Contention loop Any positive integer Specifies the number of times
Import Agent checks the file before
importing it to ensure the file is
complete.
The default is 10.

Page 50 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Import Agent


uses to log errors for
troubleshooting.
Typically, you want to set minimal
logging unless you are debugging
an issue. If you increase the
logging, make sure that you set
the logging level back down after
you finish debugging. Failure to do
so can greatly affect performance
and hard disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas 6
offers logging that offers the most
information.
The default is 0.

socket.level.file 0, 1 Specifies whether to log


communication between
ImageNow Server and Import
Agent.
1 = Import Agent logs
communication.
0 = Import Agent does not log
communication.
The default is 0.

Remote Remoted TRUE Specifies whether you installed


Import Agent on a different
FALSE
computer than ImageNow Server.
TRUE = Import Agent and
ImageNow Server are installed on
different computers.
FALSE = Import Agent and
ImageNow Server are on the
same computer.
The default is FALSE.

heartbeat.interval Any positive integer Specifies how often, in seconds,


Import Agent verifies its
connection to ImageNow Server.
The default is 60.

Page 51 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Remote socket.login.timeout Any positive integer Specifies how many seconds


Import Agent waits for successful
(continued)
login before terminating the
connection.
The default is 60.
Note Do not change this value
without first consulting Perceptive
Software Product Support.

socket.default.timeout Any positive integer Specifies how many seconds


Import Agent waits for APIs.
To override this setting for an
individual ImageNow Client, add
this setting to the Remote group in
imagenow.ini and restart the client.
The default is 60.
Note Do not change this value
without first consulting Perceptive
Software Product Support.

server.ip.address Any valid IP address Specifies the IP address of


ImageNow Server.

server.ip.port Any valid port Specifies the port number of


ImageNow Server.

force.server. 1, 0 Specifies whether Import Agent


validation forces the server to validate the
user ID and password.
1 = Import Agent forces the server
to validate user ID and password.
0 = Import Agent does not force
the server to validate user ID and
password. The default is 0.
Note Do not change this value
without first consulting Perceptive
Software Product Support.

Page 52 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Serial Number serial.number.format ;%08d Specifies the type of serial number


Import Agent uses to assign a
;%8d
unique ID to each job.
;<>
;%08d = 8 bits and retain the
;[] leading zero
;%8d = 8 bits or less and omit the
leading zero
;<> = variable section
;[] = fixed section

serial.number. Any single-digit Specifies the start value of the


startvalue positive integer serial number.

Page 53 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverJob.ini
The following table provides definitions and sample data for the settings in the inserverJob.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[Timers], 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.

Group Setting Options Description

Timers auto.suspend.timeout Any positive integer Specifies the number of seconds


Job Agent allows a job to process
before suspending it.
The default is 1200.

auto.destroy.timeout Any positive integer Specifies the number of hours Job


Agent retains a completed job
before deleting it.
The default is 1.

auto.suspend.interval Any positive integer Specifies the number of seconds


Job Agent waits to start an
automatic suspension upon
completion of the previous
automatic suspension.
The default is 1800.

auto.resume.interval Any positive integer Specifies the number of seconds


Job Agent waits to resume
processing jobs after a
suspension.
The default is 600.

auto.destroy.interval Any positive integer Specifies the number of seconds


Job Agent waits to start an
automatic destroy upon
completion of the previous
automatic destroy.
The default is 1800.

Page 54 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Job Agent uses


to log errors for troubleshooting.
Typically, you want to set minimal
logging unless you are debugging
an issue. If you increase the
logging, make sure that you set
the logging level back down after
you finish debugging. Failure to do
so can greatly affect performance
and hard disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas 6
offers logging that offers the most
information.
The default is 0.
Tip You can specify unique
values for specific users by placing
the user name at the beginning of
the string. For example, to set
logging to 5 for user jsmith, create
a string that states:
jsmith.debug.level.file = 5.

debug.level.pipe 0 through 6 Specifies the level Job Agent uses


to log pipe errors for
troubleshooting.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas 6
offers logging that offers the most
information.
The default is 0.

Page 55 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverMonitor.ini
The following table provides definitions and sample data for the settings in the inserverMonitorAgent.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[Polling], 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.

Group Setting Options Description

Polling polling.interval Any positive integer Specifies how often, in seconds,


Monitor Agent searches for new
actions and events.
Note Do not change this value
without first consulting Perceptive
Software Product Support.
The default is 3.

EventLog eventlog.enable TRUE Specifies whether to store


information to an external file
FALSE
about events, actions, and status
Monitor Agent monitors.
The default is TRUE.

eventlog.outputtiming Any positive integer If eventlog.enable is set to TRUE,


this setting specifies how often, in
hours, Monitor Agent logs
information to the external file.
The default is 6.

Page 56 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Monitor Agent


uses to log errors for
troubleshooting.
Typically, you want to set minimal
logging unless you are debugging
an issue. If you increase logging,
make sure that you set the logging
level back down after you finish
debugging. Failure to do so can
greatly affect performance and
hard disk space.
0 = Minimal logging.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas 6
offers logging that provides the
most information.
The default is 0.

Logging debug.level.pipe 0 through 6 Specifies the level Monitor Agent


(continued) uses to log pipe errors for
troubleshooting.
Typically, you want to set minimal
logging unless you are debugging
an issue. If you increase logging,
make sure that you set the logging
level back down after you finish
debugging.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas 6
offers logging that offers the most
information.
The default is 0.

Defaults defaults.memory Any positive integer Specifies the amount of memory,


in kilobytes, that a PAS uses
before Monitor Agent identifies it
as a memory leak.
The default is 250000.

Page 57 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

defaults.cpuusage Any positive integer Specifies the percent of CPU a


up to 100 PAS uses before Monitor Agent
identifies the PAS as non-
responsive.
The default is 90.

defaults. Any positive integer Specifies the time, in seconds, that


nonresponsivetime a PAS is over the percentage
identified in defaults.cpuusage
before Monitor Agent identifies the
PAS as non-responsive.
The default is 30.

defaults.timesincestart Any positive integer Specifies the time, in minutes,


Monitor Agent waits to start a PAS
after being non-responsive.
The default is 2880.

defaults.threads Any positive integer Specifies the number of threads a


PAS can have open before
Monitor Agent considers it a
memory leak.
The default is 100.

Defaults defaults.gdi Any positive integer Specifies the number of GDI


objects a PAS can have open
(continued)
before Monitor Agent considers it
a memory leak.
The default is 2000.

defaults.handles Any positive integer Specifies the number of handles a


PAS can have open before
Monitor Agent considers it a
memory leak.
The default is 5000.

defaults.time Any time based on a Specifies the time of day, based


24-hour schedule on a 24-hour schedule, that
Monitor Agent monitors the event
identified in the Processes group.
For example, 20:00 is 8:00 PM.
The default is 20:00.

Page 58 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

defaults.day EVERYDAY Specifies the day Monitor Agent


monitors the event identified in the
MONDAY
Processes group.
TUESDAY
The default is EVERYDAY.
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY

defaults. Any valid directory Specifies the directory Monitor


dumpdirectory Agent watches for dumps.
The default is c:\inserver6\bin

defaults.max Any positive integer Specifies the maximum number of


attempts times Monitor Agent attempts to
restart the PAS before identifying it
as failed.
The default is 3.

defaults.toemail Any valid e-mail Specifies the e-mail address to


address address which Monitor Agent sends
communications.

defaults.fromemail Any valid e-mail Specifies the e-mail address from


address address which Monitor Agent sends
communications.

Defaults defaults.program Any valid path and Specifies the full path of the
program program Monitor Agent runs in
(continued)
response to an event.

defaults.command Any valid command Specifies one or more command


arguments line prompt line arguments Monitor Agent
sends to the program identified in
defaults.program.

defaults.archivefile Any file extension Specifies the file types Monitor


type Agent archives.
The default is .log.

Page 59 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

defaults.archive AllLogs Specifies which files Monitor Agent


whichfiles archives based on creation date.
AllBeforeToday
AllLogs = All logs recorded.
AllBeforeToday = All logs recorded
before the current date.
The default is AllBeforeToday.

defaults.archivesearch TRUE Specifies whether Monitor Agent


subdirectories searches all sub-directories for
FALSE
more files to archive.
TRUE = Monitor Agent searches
all sub-directories.
FALSE = Monitor Agent does not
search sub-directories.
The default is FALSE.

defaults.archive Any valid directory Specifies the directory Monitor


directory Agent uses to store logs.
The default is c:\inserver6\log.

defaults.ignorerequest TRUE Specifies whether to allow actions


strings and events to run on processes
FALSE
that contain strings such as "-
start", that are run as temporary
processes that just query some
data or start the actual service.

Email email.smtpserver Any valid IP address Specifies the SMTP server Monitor
or server name of an Agent uses for e-mail.
SMTP server.
The default is localhost.

email.port Any valid port. Specifies the e-mail server port.


The default is 25.

Ignore ignore. TRUE Specifies whether Monitor Agent


allnonwatched ignores processes that do not
FALSE
processes have events and actions set up.
The default is FALSE.

Defines [defined_process] Any unique string Specifies the unique name for
each process Monitor Agent
monitors, for example:
AlarmAgent = inserverAlarm.exe

Page 60 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Profiles profile[n].event[n] For Windows: Specifies unique profiles that


Monitor Agent uses to perform
TimeSinceStarted
specific actions in response to
NonResponsive events. Profiles are a simplified
approach to perform the same
MemoryLeak actions across multiple processes.
ThreadLeak For example:
GDILeak
profile1.event1 =
HandleLeak AbnormalTermination
AbnormalTermination
TimeOfDay
DumpWatch
For Unix:
AbnormalTermination
TimeOfDay
DumpWatch

profile[n].event[n]. RestartProcess When used in conjunction with


action[n] profile[n].event[n], these settings
EmailAlert
specify the action to perform if the
profile[n].event[n]. RunProgram specified event occurs.
action[n]. For example:
Archive
failedaction[n]
profile1.event1.action1 =
RestartProcess
profile1.event1.action1.failedaction
1=
EmailAlert

profile[n].event[n]. MaxAttempts When used in conjunction with


action[n].[setting_ profile[n].event[n], these settings
ToEmailAddress
name] specify the setting name and value
FromEmailAddress related to the action.
Program For example:
Profiles profile[n].event[n]. CommandArguments profile1.event1.action1.ToEmailAd
action[n].failedaction[n]. dress = admin@home.com
(continued) ArchiveWhichFiles
[setting_name]
Refer to
ArchiveDirectory [process].event[n].action[n].[setting
ArchiveFileType ] for descriptions of the options.
ArchiveSearch-
SubDirectories

Page 61 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Processes [process].event[n] For Windows: Specifies the program or server


Monitor Agent monitors for specific
TimeSinceStarted
events.
NonResponsive
Each event for each process must
MemoryLeak include a unique positive integer,
for example event1, event2, and
ThreadLeak so on.
GDILeak
You can assign a profile to a
HandleLeak process, for example:
AbnormalTermination AlarmAgent = profile1
TimeOfDay TimeSinceStarted = Time since
the PAS started.
DumpWatch
NonResponsive = Excessive CPU
For Unix: usage over period of time.
AbnormalTermination MemoryLeak = When PAS is
TimeOfDay determined to be using more
memory than the threshold value.
DumpWatch
ThreadLeak = Using more threads
than the threshold value.
GDILeak = Using more GDI
objects than the threshold value.
HandleLeak = Using more handles
than the threshold value.
AbnormalTermination = When
PAS stops unexpectedly.
TimeOfDay = When a certain time
of day or time of week is passed.
DumpWatch = Watches for dump
files created by crashing agents.

Page 62 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Processes [process].event[n]. Time Specifies settings for each event


(continued) [setting] that override the threshold values
CpuUsage
specified in the Defaults group, or
NonResponsiveTime specifies more information for
each event to use.
Memory
These settings are optional.
Threads
Event: TimeSinceStarted
GDI
Time = Time in minutes since the
Handles PAS was started.
Time Event: NonResponsive
Day CpuUsage = Percentage of CPU
that a PAS is using.
NonResponsiveTime = Time in
seconds where a PAS exceeds
the CpuUsage setting before the
event occurs.
Event: MemoryLeak
Memory = Amount of memory in
kilobytes that a PAS can exceed
before the event occurs.
Event: ThreadLeak
Threads = Number of threads a
PAS can have open before the
event occurs.
Event: GDILeak
GDI = Number of GDI objects a
PAS can have open before the
event occurs.
Event: HandleLeak
Handles = Number of handles a
PAS can have open before the
event occurs.
Event: TimeOfDay
Time = The time based on 24
hours when the event occurs.
Day =Day of the week the event
occurs.

Page 63 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Processes [process].event[n] RestartProcess Specifies the action Monitor Agent


(continued) action[n] performs when each specific event
EmailAlert
occurs. Each action for each event
RunProgram must include a unique positive
integer, for example action1,
Archive action2, and so on.
RestartProcess = Monitor Agent
restarts the process in response to
the event.
EmailAlert = Monitor Agent sends
an e-mail detailing the actions in
response to the event.
RunProgram = Monitor Agent runs
an external program in response
to the event.
Archive = Monitor Agent archives
files in response to the event.

Page 64 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Processes [process].event[n]. MaxAttempts Specifies the setting name and


(continued) action[n].[setting] value related to the actions you
ToEmailAddress
specified for
FromEmailAddress [process].event[n].action[n] and
overrides the global default values
Program or specifies more information for
CommandArguments each action to use.
ArchiveWhichFiles For example:
ArchiveDirectory profile1.event1.action1.ToEmailAd
dress = admin@home.com
ArchiveFileType
These settings are optional.
ArchiveSearch-
SubDirectories Action: RestartProcess
MaxAttempts = Maximum number
of unsuccessful attempts in a row
before Monitor Agent considers
the action failed.
Action: EmailAlert
ToEmailAddress = E-mail address
to which Monitor Agent sends the
alert.
FromEmailAddress = E-mail
address from which Montior Agent
sends the alert.
Action: RunProgram
Program = The full path to the
external program Monitor Agent
runs.
CommandArguments = Any
command line arguments Monitor
Agent passes to the program.
Action: Archive
ArchiveWhichFiles = Files Monitor
Agent archives based on creation
date, All or AllBeforeToday.
ArchiveDirectory = The directory
fromwhich Monitor Agent archives
files.
ArchiveFileType = Type of files
Monitor Agent archives.
ArchiveSearchSubDirectories =
Whether Monitor Agent searches
sub-directories for more files to
archive.

Page 65 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Processes [process].event[n]. RestartProcess Specifies an alternate action


(continued) action[n]. Monitor Agent performs if action[n]
EmailAlert
failedaction[n] fails.
RunProgram
Refer to
Archive [process].event[n].action[n] for
descriptions of the options.

[process].event[n]. MaxAttempts Specifies settings for


action[n]. failedaction[n].
ToEmailAddress
failedaction[n].
Refer to
[setting] FromEmailAddress
[process].event[n].action[n].[setting
Program ] for option descriptions.
CommandArguments
ArchiveWhichFiles
ArchiveDirectory
ArchiveFileType
ArchiveSearch-
SubDirectories

Page 66 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverMQ.ini
The following table provides definitions and sample data for the settings in the inserverMQ.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[General], 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.

Group Setting Options Description

General num.workers Any positive integer Specifies the number of worker


threads Message Queuing
Agent uses for processing
messages.
The default is 5.

message.polling.interval Any positive integer Specifies, in seconds, how often


Message Queuing Agent
searches for message in the
directory.
The default is 60.

max.messages.per. Any positive integer Specifies the maximum number


queue of messages Message Queuing
Agent retrieves from the
database at one time.
The default is 100.

sleep.interval.max Any positive integer Specifies, in milliseconds, how


long worker threads wait to
check for messages when
messages are not available from
the database.
The default is 1000.

sleep.interval.between. Any positive integer Specifies, in milliseconds, how


send long worker threads pause after
successfully sending a message
before starting the next process.
The default is 100.

Page 67 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Message


Queuing Agent uses to log
errors for troubleshooting.
Typically, you want to set
minimal logging unless you are
debugging an issue. If you
increase the logging, make sure
that you set the logging level
back down after you finish
debugging. Failure to do so can
greatly affect performance and
hard disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas
6 offers logging that offers the
most information.
The default is 0.
Tip You can specify unique
values for specific users by
placing the user name at the
beginning of the string. For
example, to set logging to 5 for
user jsmith, create a string that
states: jsmith.debug.level.file =
5.

debug.level.pipe 0 through 6 Specifies the level Message


Queuing Agent uses to log pipe
errors for troubleshooting.
Typically, you want to set
minimal logging unless you are
debugging an issue. If you
increase the logging, make sure
that you set the logging level
back down after you finish
debugging.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas
6 offers logging that offers the
most information.
The default is 0.

Page 68 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverTask.ini
The following table provides definitions and sample data for the settings in the inserverTask.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[General], 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.

Group Setting Options Description

General refresh.settings. Any positive integer Specifies, in minutes, the time


interval.minutes Task Agent waits to refresh all of
the settings in this file.
The default is 60.

Deletion delete.tasks.assigned. Any positive integer Specifies, in days, the age of


days assigned tasks the Task Agent
deletes. Age calculation begins
when a task enters the
designated state. In addition to
the state, the modification date
is also a consideration when
deleting tasks.
The Task Agent deletes items in
this state only when the
modification date is older than
the number of days specified in
this setting.
-1 = Tasks in this state are not
deleted.
The default is -1.

delete.tasks.returned. Any positive integer Specifies, in days, the age of


days returned tasks the Task Agent
deletes. Age calculation begins
when a task enters the
designated state. In addition to
the state, the modification date
is also a consideration when
deleting tasks.
The Task Agent deletes items in
this state only when the
modification date is older than
the number of days specified in
this setting.
-1 = Tasks in this state are not
deleted.
The default is -1.

Page 69 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Deletion delete.tasks.complete. Any positive integer Specifies, in days, the age of


pending.review.days complete pending tasks the
(continued)
Task Agent deletes. Age
calculation begins when a task
enters the designated state. In
addition to the state, the
modification date is also a
consideration when deleting
tasks.
The Task Agent deletes items in
this state only when the
modification date is older than
the number of days you specify
for this setting.
-1 = Tasks in this state are not
deleted.
The default is -1.

delete.tasks.complete. Any positive integer Specifies, in days, the age of


days complete tasks the Task Agent
deletes. Age calculation begins
when a task enters the
designated state. In addition to
the state, the modification date
is also a consideration when
deleting tasks.
The Task Agent deletes items in
this state only when the
modification date is older than
the number of days you specify
for this setting.
-1 = Tasks in this state are not
deleted.
The default is -1.

Page 70 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Deletion delete.tasks.cancelled. Any positive integer Specifies, in days, the age of


days cancelled tasks the Task Agent
(continued)
deletes. Age calculation begins
when a task enters the
designated state. In addition to
the state, the modification date
is also a consideration when
deleting tasks.
The Task Agent deletes items in
this state only when the
modification date is older than
the number of days you specify
for this setting.
-1 = Tasks in this state are not
deleted.
The default is -1.

delete.tasks.invalid. Any positive integer Specifies, in days, the age of


days invalid tasks the Task Agent
deletes. Age calculation begins
when a task enters the
designated state. In addition to
the state, the modification date
is also a consideration when
deleting tasks.
The Task Agent deletes items in
this state only when the
modification date is older than
the number of days you specify
for this setting.
-1 = Tasks in this state are not
deleted.
The default is -1.

delete.tasks.job. Any positive integer Specifies, in minutes, how long


interval.minutes the Task Agent waits between
delete jobs. Tasks are deleted in
batches.
The default is 5.

Workload delete.work.load Any positive integer Specifies the number of tasks to


delete in a batch.
The default is 20.

Page 71 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Task Agent


uses to log errors for
troubleshooting.
Typically, you want to set
minimal logging unless you are
debugging an issue. If you
increase the logging, make sure
that you set the logging level
back down after you finish
debugging. Failure to do so can
greatly affect performance and
hard disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose the logging. For
example, 1 offers minimal
logging, whereas 6 offers
logging that offers the most
information.
The default is 0.

debug.level.pipe 0 through 6 Specifies the level Task Agent


uses to log pipe errors for
troubleshooting.
Typically, you want to set
minimal logging unless you are
debugging an issue. If you
increase the logging, make sure
that you set the logging level
back down after you finish
debugging.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose the logging. For
example, 1 offers minimal
logging, whereas 6 offers
logging that offers the most
information.
The default is 0.

Page 72 of 93
Perceptive Software ImageNow Installation and Setup Guide

inserverWorkflow.ini
The following table provides definitions and sample data for the settings in the inserverWorkflow.ini
configuration file. This table displays the INI settings under group headings in brackets, for example,
[General], 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.

Group Setting Options Description

General poll.interval Any positive integer Specifies how often, in seconds,


Workflow Agent searches the
directory.
Note Do not change this value
without first consulting
Perceptive Software Product
Support.
The default is 5.

num.workers Any positive integer Specifies the number of worker


threads used to perform
background processing.
The default is 5.

refresh.queue. Any positive integer Specifies how often, in seconds,


interval.seconds Workflow Agent refreshes queue
information.
The default is 600.

refresh.queue. Any positive integer Specifies how often, in minutes,


attendee.interval. Workflow Agent waits between
minutes updates to the attendee count
for all queues.
The default is 10.

Workload work.load Any positive integer Specifies the default number of


items Workflow Agent processes
for each action.
You can specify the number of
items processed for each unique
workload type using the
remaining settings in the
Workload group, or keep them
all set to 0 to use the work.load
setting.
The default is 100.

Page 73 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0 through 6 Specifies the level Workflow


Agent uses to log errors for
troubleshooting.
Typically, you want to set
minimal logging unless you are
debugging an issue. If you
increase the logging, make sure
that you set the logging level
back down after you finish
debugging.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas
6 offers logging that offers the
most information.
The default is 0.

debug.level.pipe 0 through 6 Specifies the level Workflow


Agent uses to log pipe errors for
troubleshooting.
Typically, you want to set
minimal logging unless you are
debugging an issue. If you
increase the logging, make sure
that you set the logging level
back down after you finish
debugging.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas
6 offers logging that offers the
most information.
The default is 0.

Page 74 of 93
Perceptive Software ImageNow Installation and Setup Guide

Appendix B: Client configuration tables


ImageNow.ini
The following table provides definitions and sample data for the most commonly used settings in the
ImageNow.ini configuration file, version 6.4.1. This table displays the INI settings under group headings in
brackets, for example, [User Preferences], 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.

Additional settings
The standard settings for the imagenow.ini file appear in the following section. In addition to the standard
settings, you can manually add the following settings to imagenow.ini as needed. We recommend that
you add these settings to both the default imagenow.ini file and any imagenow.ini files that have been
created in the user profiles. The default imagenow.ini file resides in [drive:]\Program
Files\ImageNow6\imagenow.ini. Each user who has logged in at least once has an imagenow.ini file in
their user profile, which is typically [drive:]\Documents and Settings\<username>\Application
Data\ImageNow\imagenow.ini.
Network Address Translation override: If you add these settings, you enable IP address override for
Network Address Translation (NAT) purposes. Use these settings to override the standard IP address
settings in the inow.ini file. To enable this function, under the [Message Queuing] section in the
imagenow.ini file, add the following two settings:
Set the enable setting to TRUE to specify that ImageNow Client uses the IP address in the
mq.agent.ip.address.override setting of this same configuration file. Set the enable setting to FALSE to
disable the setting. The default is FALSE.
Set the address setting to a valid and explicit IP address to specify the IP address to use when
mq.agent.ip.enable.override is set to TRUE. Leave the address setting empty if the enable setting is set
to FALSE. If mq.agent.ip.enable.override is set to TRUE and no override address is provided for this
setting, ImageNow Server generates an exception error. The default is empty.
Note If you are upgrading to ImageNow version 6.3 from a previous version, the former client-side
settings are replaced with these new settings, so you need to use the new settings instead. The
mq.agent.ip.enable.override setting replaces the mq.agent.client.ip.override setting. The
mq.agent.ip.address.override setting replaces the mq.agent.client.ip.address setting. The
mq.agent.client.ip.override and the mq.agent.client.ip.address settings were used in previous versions of
ImageNow in the imagenow.ini configuration files.
The following is an example of using the settings.
mq.agent.ip.enable.override=TRUE
mq.agent.ip.address.override=127.0.0.1

Page 75 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logon Profiles DefaultProfile n,n,n,n,n,n,n Specifies information about the


user and the server. ImageNow
uses the user-specified profile
name as the default profile
during installation. The value
options are a comma delimited
list of the following values:
server address - The address
or host name of the server. The
default is 127.0.0.1
login type – This setting is static
that should remain set to 1.
server port - The port on the
server. The default is 6000.
default username - The default
user name for the connection
profile if the user type is set to
either 1 or 2. The default is
blank.
user type - Determines the
default user name displayed on
the User name field on the login
screen.
0 = Always prompt for user
name.
1 = Always set to the user name
specified in the default user
name value of this setting.
2 = remember last successful
login user name. The default is
2.
profile type – Specifies one of
the following types of profiles:
0 = Production
1 = Test
2 = Development
3 = Personal
The default is 0.
license group ID - The LGID
value provided by the server.
The default is blank.

Logon Settings Remember TRUE Specifies whether ImageNow


FALSE saves logon credentials.

Page 76 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Default Any profile under Specifies the default login


[Logon Profiles] profile.

User CopyDlg.Default 0,1,2 Specifies the default focus point


Preferences FocusPoint when the user opens the Copy
Document dialog box.
0 = App Plan list box
1 = Page Range box
2 = Workflow check box, if
enabled
The default is 0.

CopyDlg. TRUE FALSE Specifies whether Custom


SkipCustProps Properties is included in the tab
OnTab order in the Insert Document
and Copy Document dialog
boxes.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Selected


Disable. region option is disabled on the
SelectedRegion Copy Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Current


Disable. page option is disabled on the
CurrentPage Copy Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the All open


Disable.AllOpen pages option is disabled on the
Pages Copy Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the All pages


Disable. option is disabled on the Copy
AllPages Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Page


Disable.Page range option is disabled on the
Range Copy Document dialog box.
The default is FALSE.

Page 77 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

User CopyDlg. TRUE FALSE Specifies whether the Remove


Preferences Disable.Remove selected pages from current
PagesFromDoc documentation checkbox is
(continued)
disabled on the Copy
Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Use


Disable.Use default values checkbox is
DefaultValues disabled on the Copy
Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Submit to


Disable. content server checkbox is
SubmitTo disabled on the Copy
ContentServer Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Send to


Disable.SendTo Workflow queue check box is
WFQueue disabled on the Copy
Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Add to


Disable.AddTo project check box is disabled on
Proj the Copy Document dialog box.
The default is FALSE.

CopyDlg. TRUE FALSE Specifies whether the Add new


Disable.AddNew document to version control
DocToVC check box is disabled on the
Copy Document dialog box.
The default is FALSE.

AcquireToken 1, 0 Enables ImageNow to acquire


DuringScan automatically a token for a
device performing a capture
when a token is not detected.
1 = Enabled
0 = Disabled

Viewer Settings ExportPath Any valid path Specifies the default path for
exported documents.

ThumbWidth Any positive integer Specifies, in pixels, the width of


document thumbnails.

Page 78 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Viewer Settings ThumbHeight Any positive integer Specifies, in pixels, the height of
document thumbnails.
(continued)

WF Settings LastAddProcess Any valid workflow Specifies the process name that
process was used last when adding a
document to workflow.
The default is blank.

LastAdd Any valid workflow Specifies the queue name that


WFQueue queue was used last when adding a
document to workflow.
The default is blank.

Workflow OnStart 0, 1, 3, 4 Specifies the default action


when the user clicks Workflow
on the ImageNow toolbar.
0 = Retrieves next item in
workflow viewer.
1 = Displays all items in
workflow explorer.
3 = Displays only on hold items
in workflow explorer.
4 = Displays workflow explorer
and retrieves item in workflow
viewer.
The default is 1.

FetchNextItem 0, 1, 2 Specifies the default behavior


FromGrid when the user selects an item to
display in the viewer from
workflow Explorer grid.
0 = Open oldest item.
1 = Open next item.
2 = Open top item.
The default is 1.

Page 79 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Workflow AutoFetch 0, 1 Specifies whether workflow


NextItem automatically fetches the next
(continued)
item from the workflow queue
upon completion of exiting item.
0 = Workflow does not fetch the
next item.
1 = Workflow fetches the next
item.
The default is 1.

PendingFetch 0, 1 Specifies whether workflow


fetches items that have pending
status.
0 = Workflow does not fetch
items that are in pending status.
1 = Workflow fetches items
regardless of pending status.
The default is 0.

WhenGetNext 0, 1, 2 Specifies the action workflow


Item performs on the next workflow
item after the user closes the
current workflow item in viewer.
0 = Places the item on hold
1 = Returns the item to queue
2 = Prompts the user to choose
an action
The default is 2.

OnCancel 0, 1, 2 Specifies the action workflow


OrClose performs on an item when the
user closes or saves it from the
viewer.
0 = Places the item on hold
1 = Returns the item to queue
2 = Prompts the user to choose
an action
The default is 1.

Page 80 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Workflow SaveChanged 0, 1, 2 Specifies the action workflow


Keys performs on an item when the
(continued)
user changes the document
keys.
0 = Places the item on hold
1 = Returns the item to queue
2 = Prompts the user to choose
an action
The default is 2.

AutoRefresh -1 or any positive Specifies how long, in seconds,


Timer integer greater than or workflow refreshes the explorer
equal to10 grid.
If set to -1, workflow uses the
minimum number of seconds,
which is 10.
The default is -1.

AlertUser XY Specifies how soon ImageNow


alerts the user when an item is
older than the designated time.
X represents the quantifier.
Y represents one of the following
units of measurement:
0 = Minutes
1 = Hours
2 = Days
3 = Weeks
4 = Never
For example, a value of 12
means ImageNow alerts the
user when items are one day
old. In this example, the second
number, 2, represents days. The
first number, x, represents the
number of days.
The default is 72, meaning items
that are seven days old.

Page 81 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

WF Designer WFQueueAlarm n,n,n,n Specifies which columns are


Columns visible in the Queue Properties
where
dialog box in the Alarms
n = 1 or 0
section.
Each n corresponds to the
following column in order:
Name, Queue Status, Alarm
Status, Last Triggered
0 = column is hidden
1 = column is visible
The user can modify which
columns are displayed in by
clicking Columns in the Queue
Properties dialog box under the
Alarms section.
The default is 1,1,0,1.

ShowQProps 0, 1 Specifies whether workflow


Auto displays the Queue Properties
dialog box when the user
creates a new queue by
dragging a queue icon into the
Workflow process diagram.
0 = Disabled
1 = Enabled
The default is 0.

Learn Hyperlearn n If
Preferences CaptureDelay HyperlearnBringAppForward=TR
UE, this setting specifies the
delay in milliseconds between
bringing the host application
forward and capturing the
screen as a bitmap.
The default is 750, which is 3/4
of a second.

Page 82 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Learn Hyperlearn 0, 1 Specifies whether Hyperlearn


Preferences Disable disables fonts from the server
ServerFonts and instead uses client fonts
(continued)
before processing a host
application.
0 = Hyperlearn uses fonts from
the server.
1 = Hyperlearn uses the fonts on
the client.
The default is 0.

HyperLearn n; n; n; n; … Specifies a string of color code


ConvertColors conversions that occur before
Hyperlearn attempts to
recognize the text in a bitmap.
The string consists of up to ten
pairs of numbers, separated by
a semicolon. The first number of
the pair is the color to convert
from and the second is the color
to use.
The default is blank, meaning no
color conversion.

HyperLearn x,y This setting specifies the shift in


KeyOffset pixels from the Hyperlearn
coordinates defined in the
template, where x is horizontal
movement and y is vertical
movement.
Example: -3,5 shifts the
coordinates left three pixels and
up five pixels.
The default is 0,0.
Note This setting is useful if you
consistently receive Cannot
Recognize Text error messages.
Check the Hyperlearn debug log
file to see which way the screen
is shifting, and then add this
setting to imagenow.ini under
[Learn Preferences] on the
ImageNow Client computer. This
setting applies to all Hyperlearn
and application plan templates
on the Client.

Page 83 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Learn Hyperlearn 0, 1, 2 Specifies whether debugging is


Preferences Debug enabled for Hyperlearn.
(continued) 0 = Debugging is disabled.
1 = Show debugging information
in a dialog box.
2 = Show debugging information
in a dialog box and write to
hyperlearn.log.
The default is 1.

BitmapSel RGB(n,n,n) Specifies the line color used for


OutlineColor the rectangles in LearnMode
Designer, Hyperlearn, or
Viewpoint screens.
The default is RGB(0, 0, 0),
which is black.

TextBackground RGB(n,n,n) Specifies the color used for


Color drawing selected areas on DOS
and Terminal Learnmode
application plans in the
LearnMode Designer.
The default is
RGB(192,192,192), which is
25% grey.

Table RGB(n,n,n) Specifies the highlight color for


Background table rows when editing an
Color Internet Explorer application
plan.
The default is
RGB(192,192,192), which is
25% grey.

MinimizeOn 0, 1 Specifies whether the


DictionaryTest LearnMode Designer window is
hidden when the Test Map
button is used on a context map
or on the Test Dictionary
command in the dictionary pane.
0 = LearnMode Designer
window is hidden.
1 = LearnMode Designer
window is visible.
The default is 1.

Page 84 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Learn UseIEShell TRUE Specifies whether ImageNow


Preferences Search uses the Internet Explorer shell
FALSE
to locate the Internet Explorer
(continued)
window for IE LearnMode
application plans.
TRUE = ImageNow uses the IE
shell.
FALSE = ImageNow ignores the
IE shell.
The default is FALSE

MultiGrab 0, 1 Optional. This setting forces


your host application screen to
the top when linking in
LearnMode.
0 = MultiGrab is disabled.
1 = MultiGrab is enabled.
Since this setting is optional, a
default value does not exist.

Button Actions Applet Valid application plan When DefaultApplet is set to 0,


this setting specifies the default
application plan that opens when
the user clicks Applications on
the ImageNow toolbar.
The default is blank.

Batch Valid batch When DefaultBatch is set to 0,


this setting specifies the default
batch that opens when the user
clicks Batches on the
ImageNow toolbar.
The default is blank.

Project Valid project When DefaultProject is set to 0,


this setting specifies the default
project that opens when the user
clicks Projects on the
ImageNow toolbar.
The default is blank.

Page 85 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Button Actions Document Valid document When DefaultDocument is set to


0, this setting specifies the
(continued)
default document that opens
when the user clicks
Documents on the ImageNow
toolbar.
The default is blank.

Workflow Valid workflow queue When DefaultWorkflow is set to


0, this setting specifies the
default queue that opens when
the user clicks Workflow on the
ImageNow toolbar.
The default is blank.

Tasks Valid ID string When DefaultTask is set to 0,


this setting specifies the default
task view that ImageNow opens
in task explorer when Task is
clicked on the ImageNow
toolbar.
The default is blank.

DefaultApplet 0, 1, 2 Specifies the default action


when the user clicks
Applications on the ImageNow
toolbar.
0 = Application plan defined in
Applet setting
1 = Most recently accessed
application plan
2 = No action
The default is 1.

DefaultBatch 0, 1, 2 Specifies the default action


when the user clicks the
Batches button on the
ImageNow toolbar.
0 = Batch defined in Batch
setting
1 = Most recently accessed
application plan
2 = No action
The default is 1.

Page 86 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Button Actions Default 0, 1, 2 Specifies the default action


Document when the user clicks
(continued)
Documents on the ImageNow
toolbar.
0 = Document defined in
Document setting
1 = Most recently accessed
application plan
2 = No action
The default is 1.

DefaultProject 0, 1, 2 Specifies the default action


when the user clicks Projects
on the ImageNow toolbar.
0 = Project defined in Project
setting
1 = Most recently accessed
application plan
2 = No action
The default is 1.

DefaultTask 0, 1, 2 Specifies the default action


when the user clicks Tasks on
the ImageNow toolbar.
0 = Task defined in Task setting
1 = Most recently accessed
application plan
2 = No action
The default is 1.

DefaultWorkflow 0, 1, 2 Specifies the default action


when the user clicks Workflow
on the ImageNow toolbar.
0 = Workflow defined in
Workflow setting
1 = Most recently accessed
application plan
2 = No action
The default is 1.

Page 87 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

PowerVu MaxOpenPages 1, 0 Specifies whether ImageNow


Enabled limits the number of pages a
user can have open at one time.
1 = Enabled
0 = Disabled

MaxOpenPages Any positive integer Specifies the maximum number


of pages ImageNow allows you
to have open at one time.

PrintTitle 0, 1, 2, 3 Specifies whether ImageNow


prints the document keys and
title for documents within the
Viewer.
0 = Off
1 = Print Dockeys
2 = Print Title (the title of the
Viewer)
3 = Both (Document keys and
title)

ContentHighlight RGB(n,n,n) Optional. Specifies the Content


Color Search highlight color in 24-bit
RGB representation.

Thumbnails TRUE FALSE Specifies whether the thumbnail


RetainFocus pane retains focus when the
user opens a document from the
thumbnail pane in ImageNow or
WebNow Viewer.
The default is FALSE.

Batch Options QAReview 0, 1, 2, 3, 4 Specifies which pages of the


document need reviewed for
QA.
0 = Every page
1 = First page only
2 = First and last pages
3 = last page only
4 = every other page
The default is 0.

Page 88 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Batch Options ConfirmLink 0, 1 Specifies whether ImageNow


Discard displays a confirmation message
(continued)
when the user deletes a page
from the batch.
0 = Disable; a message will not
appear
1 = Enabled; a message
appears
The default is 1.

RememberKeys 0, 1 Specifies whether ImageNow


BetweenLinks remembers the document keys
from the last linked page when
linking pages within a batch.
0 = Disable; document keys are
not remembered
1 = Enabled; document keys are
remembered
The default is 1.

PromptGroup 0, 1 Specifies whether to set the


SizeEqPages document keys for all pages in a
batch to be the same.
0 = No
1 = Yes

LastBatchApplet Any valid application Specifies the name of the last


plan application plan used.

BatchUpload Any positive integer. Specifies the number of seconds


Delay the user must wait between
scanning a batch and logging
out.
This setting prevents the user
from logging out while a batch is
running.
The default is 10.

Page 89 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Logging debug.level.file 0, 1 – 6 Specifies the level ImageNow


uses to log errors for
troubleshooting.
Typically, you want to set
minimal logging unless you are
debugging an issue. If you
increase the logging, make sure
that you set the logging level
back down after you finish
debugging. Failure to do so can
greatly affect performance and
hard disk space.
0 = Logging is off.
1 through 6 = Logging is on. The
higher the number, the more
verbose logging. For example, 1
offers minimal logging, whereas
6 offers logging that offers the
most information.
The default is 0.

General logon. TRUE Specifies whether the user can


singlesignon. sign in once when using multiple
FALSE
enable ImageNow products.
For example, if the user has
signed in to ImageNow client
and single sign on is enabled,
the user can open Management
Console without needed to sign
in again.
TRUE = Single sign on is
enabled
FALSE = Single sign on is
disabled
The default is TRUE.

scroll.login. 1, 0 Specifies whether the scrolling


image clouds on the ImageNow login
screen are enabled.
0 = disabled
1 = enabled

Page 90 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Locale LangID 1031 Specifies the language


1033 ImageNow uses.
1034
1033 = English
1036
1036 = French
1031 = German
1034 = Spanish

Tasks TaskStartup 0, 1, 2, 3, 4 Specifies the start up action


Action when the user opens Tasks
explorer.
0 = Open the next due task
1 = Open the next due task by
specific type
2 = Open the oldest task
3 = Open the oldest task by
specific type
4 = Show all tasks
The default is 4.

TaskStartup 0, 1, 2 The TaskStartupAction setting


Type specifies the type of task
ImageNow opens.
0 = Document deficiency
1 = Pointer
2 = Signature required
The default is 0.

NextTaskAction 0, 1, 2, 3, 4, 5 Specifies the action ImageNow


performs after the user
completes a task.
0 = Opens the next task due
1 = Opens the next task by
specified type
2 = Opens the task from the top
of the list in explorer
3 = Opens the next task from
task explorer list of tasks
4 = Opens the oldest task
5 = Opens the oldest task by
specific type
The default is 3.

Page 91 of 93
Perceptive Software ImageNow Installation and Setup Guide

Group Setting Options Description

Tasks NextTaskType 0, 1, 2 The NextTaskAction setting


(continued) specifies the type of task
ImageNow opens after the user
completes a task.
0 = Document deficiency
1 = Pointer
2 = Signature required
The default is 0.

AutoLaunchNext TRUE Specifies whether ImageNow


Task opens the next task in explorer
FALSE
when a task is complete.
The default is TRUE.

ProcessAllTasks TRUE Specifies whether ImageNow


ForCurrent open the next task for the
FALSE
current document or project.
The default is TRUE.

LastDigSig string ID Specifies the last used digital


Template signature task template ID when
creating new digital signature
task.

LastDocDef string ID Specifies the last used


Template document deficiency task
template ID when creating new
document deficiency task.

LastPointer string ID Specifies the last used pointer


Template task template ID when creating
pointer task.

Page 92 of 93
Perceptive Software ImageNow Installation and Setup Guide

Index
Create the INOW6 database .............................. 5 inserverTask.ini ................................................ 69
Customer Portal ......................................... 1, 2, 8 inserverWorkflow.ini ......................................... 73
DEP ......................................................4, 6, 7, 10 Installing an ImageNow Server license............ 15
remove the setting .......................................... 7 Installing ImageNow .......................................... 1
ImageNow.ini ................................................... 75 checklist.......................................................... 2
Increase performance for ImageNow ................. 8 ImageNow Client ............................................ 9
ImageNow Client unattended ....................... 11
INEMUSER ........................................................ 3
ImageNow Server on Windows using
inow.ini ............................................................. 19 Microsoft SQL Server ................................. 4
inserver.ini ........................................................ 30 process ........................................................... 1
inserverAlarm.ini .............................................. 37 Microsoft Vista ................................................... 9
inserverBatch.ini ............................................... 39 services ............................................................ 18
inserverEM.ini .................................................. 42 SQL Server Management Studio ................... 5, 6
inserverImp.ini .................................................. 43 SunflowerSS.sql................................................. 5
inserverJob.ini .................................................. 54 TCP/IP Connectivity ........................................... 2
inserverMonitor.ini ............................................ 56 Tune Microsoft SQL Server ............................... 8
inserverMQ.ini .................................................. 67

Page 93 of 93

Вам также может понравиться