ImageNow Server and Client Installation and Setup Guide · ImageNow Server and Client Installation and ... Create INOW6 database using Microsoft SQL Server 2012 ... setting in the

ImageNow Server and Client Installation and Setup Guide

ImageNow Version: 6.7. x Environments: AIX, Linux, and Oracle Solaris DBMS: Microsoft SQL Server

Written by: Product Knowledge, R&D Date: November 2016

© 2016 Lexmark. All rights reserved.

Lexmark is a trademark of Lexmark International Technology, S.A., or its subsidiaries, registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

Tab le o f Contents

Installing ImageNow .......................................................................................................................... 5

Active-passive versus an active-active server environment ..................................................................... 5

Using a server farm for load balancing ..................................................................................................... 6

Installation Process ................................................................................................................................... 6

Prepare for the installation ..................................................................................................................... 6

Verify the installation checklist .............................................................................................................. 6

Open network ports ............................................................................................................................... 7

IPv6 compatibility .................................................................................................................................. 7

Install ImageNow Server on UNIX with a Microsoft SQL Server database .............................................. 7

Install ImageNow Server on UNIX ......................................................................................................... 8

Download the ImageNow Server files ................................................................................................... 8

Create INOW6 database using Microsoft SQL Server 2008 ................................................................. 8

Create INOW6 database using Microsoft SQL Server 2012 ................................................................. 9

Install ImageNow Server for UNIX ....................................................................................................... 10

Download and install library files ......................................................................................................... 12

Configure ImageNow Server ............................................................................................................... 13

Assemble and configure a server farm for ImageNow Server ................................................................ 14

Set up server health monitoring .......................................................................................................... 14

Set up real servers ............................................................................................................................... 16

Configure the server farm .................................................................................................................... 16

Configure a virtual server for ImageNow Server ................................................................................. 17

Configure a virtual server for ImageNow Message Queuing Agent .................................................... 18

Configure a remote override for ImageNow Message Queuing Agent ............................................... 18

Increase performance for ImageNow .................................................................................................. 19

Create INEMUSER database user .......................................................................................................... 19

Database access through INEMUSER ................................................................................................ 20

Order processing of external messages.............................................................................................. 20

Install ImageNow Client ........................................................................................................................... 20

Install ImageNow Client attended ....................................................................................................... 21

Install ImageNow Client unattended ................................................................................................... 21

ADDLOCAL value definitions ............................................................................................................... 25

Schema changes for an INOW6 database on a SQL Server .................................................................. 27

Granting permissions to the INUSER schema .................................................................................... 27

ImageNow Server and Client Installation Guide Page 3 of 138

Install an ImageNow Server license ........................................................................................................ 28

Obtain the license files......................................................................................................................... 28

Install ImageNow product licenses ..................................................................................................... 28

Start all ImageNow services .................................................................................................................... 29

Appendix A: Installing a second ImageNow Server ......................................................................... 30

Appendix B: Server configuration tables ......................................................................................... 31

inow.ini ..................................................................................................................................................... 31

Optional settings .................................................................................................................................. 31

inserver.ini ............................................................................................................................................... 54

inserverAlarm.ini ...................................................................................................................................... 63

inserverBatch.ini ...................................................................................................................................... 64

inserverEM.ini .......................................................................................................................................... 67

inserverFS.ini ........................................................................................................................................... 70

inserverImp.ini ......................................................................................................................................... 71

Import Agent key mapping options ..................................................................................................... 84

inserverJob.ini ......................................................................................................................................... 86

inserverMonitor.ini ................................................................................................................................... 88

inserverMQ.ini.......................................................................................................................................... 98

inserverNotification.ini ........................................................................................................................... 101

inserverOSM.ini ..................................................................................................................................... 103

inserverRetention.ini .............................................................................................................................. 107

inserverTask.ini ...................................................................................................................................... 112

inserverWorkflow.ini .............................................................................................................................. 115

Client configuration tables ............................................................................................................ 119

ImageNow.ini ......................................................................................................................................... 119

Additional settings ............................................................................................................................. 119

Appendix D: IMAGENOWLOCALDIR6 and IMAGENOWDIR6 environment variables .................... 137

IMAGENOWLOCALDIR6 environment variable .................................................................................... 137

IMAGENOWDIR6 environment variable ................................................................................................ 137

Index ............................................................................................................................................. 138


I ns ta l l i ng 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. You can set ImageNow 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.perceptivesoftware.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.7 of ImageNow Client to work with version 6.7 of ImageNow Server. For product technical specifications and system requirements, go to www.perceptivesoftware.com, click Customer Portal and then log in. The Technical Specifications document for this product version is available in the Product Documentation tab.

Act ive-passive versus an act ive-act ive server env ironment Past ImageNow Server environments have always been installed and configured as active-passive. With the release of 6.7, the option to setup an active-active ImageNow Server environment is available. An active-active server environment (also known as a high-availability or clustered environment) has certain benefits over that of an active-passive environment.

In an active-passive environment, server applications are installed and run on only one physical server. In order to create redundancy, a second environment must be installed on a separate machine, usually in a different physical location. This usually results in a large investment in extra hardware, and extended system outages during shutdowns and restarts in order to recover from a system error.

With an active-active environment, you can run multiple instances of ImageNow balanced across redundant nodes, also called clusters. One server environment is set up (the primary) on one node, and at least one other server environment is created (secondary) on a different node, both on the same physical machine. If the primary environment begins to fail, the system immediately switches over to the secondary environment. This offers two benefits. The first is that an active-active environment does not require the large-scale investment in extra hardware to backup data. The second benefit is that an active-active environment protects against system-wide crashes and avoids single points of failure, because the server can switch to the secondary server environment if the primary server environment fails without having to shut down and restart the system.

You also can install the two parts of the ImageNow Server, per-server and shared server, in independent locations. The per-server is usually installed locally with respect to the installer. The shared server piece, since it is only installed once per active-active environment, is usually installed on a network drive.

Note Whether you decide to install the per-server and shared server on the same machine or in different locations, they both must be installed.

For more information about active-active and ImageNow Server, refer to the ImageNow Active-Active and High Availability Technical Guide and the Active-Active ImageNow Server Getting Started Guide available on the Perceptive Software Customer Center at www.perceptivesoftware.com.


http://www.imagenow.com/



Using a server farm for load balancing A server farm is a collection of real servers that operate behind a virtual IP address, streamlining server workload by spreading it among many physical servers through the use of a load-balancer. For example, when a connection is made to a virtual IP address that is associated with a load-balancer, the load-balancer picks the best real server to handle the connection. A server farm also increases redundancy by allowing other servers to handle incoming requests if one fails.

A real server is a physical machine that hosts data, manages network resources, and processes workload from clients. Virtual servers are interfaces that accept incoming connections and route them to a real server. The system that the load-balancer uses to determine if a real server is available to accept incoming connections is called health monitoring.

Assembling a server farm is optional and is done after installing ImageNow Server and before installing ImageNow Client. Refer to the steps in the Assemble and configure a server farm section in this document for more information.

Note If you create a server farm for ImageNow Server, creating a server farm for ImageNow Message Queuing Agent Server is optional.

Insta l lat ion 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 UNIX, you need to know the root user password unless you plan to run ImageNow as a non-root user. For more information about running ImageNow as a non-root user, refer to the Running ImageNow as a Non-Root User Best Practices Guide.

• In AIX, you need to ensure that the ODMDIR environment variable is set for the user running the inserver process to point to the ODM repositories (IE:/etc/objrepos). Verify this variable is set before running inserver for the first time.

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

• The server and client system time must be synced to GMT using third-party time server software.

• Decide whether this is a single server installation or if your environment requires an active-active failover installation.

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 the 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 www.perceptivesoftware.com so you can download product files for installation.

4. Download and install the appropriate ImageNow Server for your operating system and database. We recommend that you create a new instance for the INOW6 database.

5. Optional. Assemble a server farm.

6. Download and install ImageNow Client.

7. Start ImageNow Server.

8. License ImageNow, unless you are installing an evaluation copy.

9. Start all ImageNow services.

10. Create and test a login profile.

11. Log in to ImageNow to create and test groups and users.

Open network ports 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.

• Port 7200. ImageNow Server requires port 7200 to display workflow alarms, send documents to users, or perform auto-logoff in 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 inow.ini file after installing 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 inserver.ini file after installing ImageNow Server.

IPv6 compatibility ImageNow Server is capable of communicating with Internet Protocol, version 6 (IPv6) devices. IPv6 is the standard, global protocol by which IP addresses are issued to computers, servers, networks, and other Internet-compatible devices. The number of unassigned IP addresses for the previous protocol, IPv4, is diminishing. IPv6 was launched to provide a massive number of open IP addresses for future devices.

If your network has been set up to use IPv6, then you need to set the ipv6.enabled setting to TRUE. For more information, see the inow.ini file table.

Insta l l ImageNow Server on UNIX with a Microsof t SQL Server database This document provides instructions for installing ImageNow Server on various UNIX platforms including Oracle Solaris, AIX, and Linux. These platforms are addressed as “UNIX” in this document where the steps are generic to all platforms. Platform-specific instructions are provided when applicable.

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, make sure you first refer to the Update ReadMe document available on the Customer Portal of the Perceptive Software website at www.perceptivesoftware.com. Sections of the update readme may reference procedures in this installation guide.


Install ImageNow Server on UNIX During this installation, you perform the following procedures.

• Download the ImageNow Server files.

• Create the INOW6 database.

• Verify the INOW6 database user authentication.

• Remove INUSER schema sys admin role.

• Install ImageNow Server.

• Download and install library files.

• Configure ImageNow Server.

• Optional. Assemble a server farm.

Download the ImageNow Server files 1. Go to the Perceptive Software website at www.perceptivesoftware.com and log in to the Customer

Portal.

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

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

Create INOW6 database using Microsoft SQL Server 2008 Important This procedure varies depending on your version of Microsoft 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, click the Start button, point to Programs, point to Microsoft SQL Server 2008, and then click SQL Server Management Studio.

2. In the Connect to Server dialog box, enter the information in the Server Type, Server Name, and Authentication fields. Click Connect.

3. In the Object Explorer, verify that the master database is selected.

Tip This is typically under the System Databases folder.

4. On the File menu, select Open and then select File. In the Open File dialog box, navigate to the location that contains the SunflowerSS.sql file, select the SQL file, and then click Open. If you are prompted to connect to the database, select Connect to make the connection.

5. If you are using more than one drive, in the SunflowerSS.sql file, update the drive in the three paths located on the Create Database and the Alter Database lines.

6. 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.


about:blank

Create INOW6 database using Microsoft SQL Server 2012 Use the following instructions to create the INOW6 database.

Important Verify the data directory for Microsoft SQL before creating the database. This is the directory where the database files appear when the following SQL file runs.

1. Log in to the SQL Server computer with a user ID that has local administrator rights, click the Start button, point to Programs, point to Microsoft SQL Server 2012, and then click SQL Server Management Studio.

2. In the Connect to Server dialog box, enter the information in the Server Type, Server Name, and Authentication fields. Click Connect.

3. In the Object Explorer, verify that the master database is selected.

Tip This is typically under the System Databases folder.

4. On the File menu, select Open and then select File. In the Open File dialog box, navigate to the location that contains the SunflowerSS.sql file, select the SQL file, and then click Open. If you are prompted to connect to the database, select Connect to make the connection.

5. If you are using more than one drive, in the SunflowerSS.sql file, update the drive in the three paths located on the Create Database and the Alter Database lines.

6. 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.

Verify the INOW6 database user authentication ImageNow Server with a SQL Server database uses SQL Server authentication. Complete the following instructions to determine and set the correct authentication method.

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 Authentication Mode 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, in the Object Explorer pane, right-click the server and click Restart.

3. Click OK and then exit SQL Server Management Studio.

Remove INUSER schema sysadmin server role Important Complete the steps in this section prior to updating the ImageNow Server.

In ImageNow Server 6.7, all ImageNow tables and indexes reside in the INUSER schema. You must ensure that the INUSER schema does not have the sysadmin server role granted to it. If the INUSER schema has the sysadmin server role, this role sets the default schema asthe database owner instead of the INUSER schema. As a result, ImageNow Server might not start, and connections to the INOW6 database cannot query the ImageNow tables. Use the following instructions to remove the INUSER schema sysadmin server role.

Open SQL Server Management Studio.


1. Connect to the server hosting the SQL Server instance that contains the INOW6 database.

2. In Object Explorer, expand Security, and then expand Logins.

3. Right-click inuser, and then click Properties.

4. On the Login Properties – inuser dialog box, click Server Roles.

5. In the Server roles area, uncheck sysadmin.

6. Click OK.

7. Close SQL Server Management Studio.

Install ImageNow Server for UNIX In the following steps, you create the main directory for ImageNow. The default directory name is inserver6. It is important that you do not rename the inserver6 directory while it is running or after your configuration, and never install ImageNow in the root file system of the UNIX server. The root file system does not have the capacity to accommodate ImageNow.

Before beginning the installation process, decide if you are going to install and configure ImageNow Server in a standalone server environment, or in an active-active server environment. A standalone server environment requires a second server for failover protection and optional data backups. An active-active server environment requires more than one server in order to run multiple instances of ImageNow Server for data redundancy.

For a standalone server

1. To create the inserver6 directory, navigate to the desired base location on the local machine, and enter mkdir inserver6.

2. Copy <filename>.tar.gz into the inserver6 directory you created in step 1, replacing <filename> with the name of your ImageNow Server file.

3. To unzip the file, navigate to the inserver6 directory and then type gunzip -d <filename>.tar.gz, replacing <filename> with the name of your ImageNow Server file.

4. To extract all the packaged files, in the inserver6 directory, type tar -xvf <filename>.tar, replacing <filename> with the name of your ImageNow Server file.

5. In the inserver6 directory, execute the command: chown -R root:bin *

6. In the inserver6 directory, enter ls -l to verify that the directory contains the TAR file and the following directories: audit, bin, doc, envoy, etc, form, log, odbc, osm_01.00001, osm_02.00001, osm_03.00001, script, temp, update, user, workflow, and worksheet. This directory also includes the environment.ini file.

Note In the inserver6 directory, you can remove the TAR distribution file to save disk space.

For an active-active environment

1. To create the local inserver6 directory, navigate to the desired base location on the local machine, and enter mkdir inserver6.

Note The local directories on all of the machines in your environment should be in the same location due to the odbc.ini configuration settings.

2. To create the shared inserver6 directory, navigate to the desired base shared location, and enter mkdir inserver6.


3. Copy the local <ImageNow-Server-Active-Active-Local>.tar.gz into the local inserver6 directory you created in step 1, replacing <filename> with the name of your ImageNow Server file.

4. Copy the shared <ImageNow-Server-Active-Active-Shared>.tar.gz into the shared inserver6 directory you created in step 2, replacing <filename> with the name of your ImageNow Server file.

5. Navigate to the local inserver6 directory and then type gunzip -d <ImageNow-Server-Active-Active-Local>.tar.gz.

6. In the local inserver6 directory, type tar -xvf <ImageNow-Server-Active-Active-Local>.tar to extract all the packaged files for the local machine.

7. Navigate to the shared inserver6 directory and then type gunzip -d <ImageNow-Server-Active-Active-Shared>.tar.gz.

8. In the shared inserver6 directory, type tar -xvf <ImageNow-Server-Active-Active-Shared>.tar to extract all the packaged files for the shared machine.

9. In the local inserver6 directory, open the environment.ini configuration file. Create this file if it does not exist.

10. In the environment.ini file, update the following setting:

[Directory Locations]

IMAGENOWDIR6=[location of the shared files] this is the same shared inserver6 directory where you extracted the <ImageNow-Server-Active-Active-Shared>.tar file.

11. In the local inserver6 and shared inserver6 directories, execute the command: chown -R root:bin*

12. In the local inserver6 and shared inserver6 directories, enter ls -l to verify that the directory contains the TAR file and the following directories:

Location Directories

local inserver6 bin, log, odbc, temp, environment.ini

shared inserver6 audit, doc, envoy, etc, form, osm_01.00001, osm_02.00001, osm_03.00001, script, workflow

13. Optional. In the local inserver6 and shared inserver6 directories, you can remove the appropriate TAR distribution file to save disk space:

Location File

local inserver6 ImageNow-Server-Active-Active-Local.tar

shared inserver6 ImageNow-Server-Active-Active-Shared.tar


Download and install library files Install the library files specified in this section.

Download UNIX supporting files

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



Install library files

1. Navigate to the best location for your server computer to place the files from the downloaded TAR file. This directory is referenced as <library_dir> in the remaining steps.

• If you have enough space, the easiest directory to place these files is /usr/local/waspc6.5. If you use this directory, you do not need to create a symbolic link.

• If you don’t have enough space in the recommended location, create a subdirectory for these files under the directory you created in the first step.

• If you have other server considerations, you can use any directory location.

2. Navigate to the directory you determined in the previous step. Create a directory on your UNIX server to store the additional libraries required for ImageNow Server to operate properly by entering the following command, replacing <library_dir> with the directory name you want you want to use:

mkdir <library_dir>

3. Copy the downloaded TAR file to the new directory. To unzip the file, navigate to the <library_dir> directory, type gunzip <filename>.tar.gz, and then type tar -xvf <filename>.tar, replacing <filename> with the name you supplied during the download. The extracted files and subdirectories appear in <library_dir>.

4. If you did not use the recommended directory of /usr/local/waspc6.5 from previous steps, create a symbolic link from /usr/local/waspc6.5 to <library_dir>/waspc6.5 by entering:

ln -s <library_dir>/waspc6.5 /usr/local/waspc6.5

5. Copy the TrustStoreTool, UserStoreTool, and PolicyStoreTool files to this directory:

/usr/local/wasp6.5/bin


http://www.perceptivesoftware.com/

Configure ImageNow Server 1. Make changes to ImageNow Server INI files using the following substeps:

1. From the command prompt, change directories to the etc directory under inserver6.

2. Type cp odbc_SS.ini odbc.ini and then press ENTER.

3. Type vi odbc.ini, press ENTER, and then make the following changes:

Setting Value

Address The computer name that hosts your SQL Server database

Database INOW6

4. Replace all instances of [INSTALL_DIR] with the full path to your inserver6 directory.

5. Change [SQLServer Wire Protocol] to [your DSN name] and then save the file.

6. In the inow.ini file, in the [ODBC] section, make the following changes:

Setting Value

odbc.dbms SQLServer

odbc.dsn The DSN name you specified in odbc.ini

7. To enable IPv6, under [Network], set ipv6.enabled to TRUE.

Note IPv6 is the current protocol used for communicating data. If you remove this setting or set it to FALSE, IPv4 is used.

8. Save and then exit the inow.ini file.

9. If you are using a port other than 6000 for communication between the ImageNow Server and ImageNow Client, do the following substeps:

1. Edit the inserver.ini file.

2. In the inserver.ini file, in the [Network] section, set inowd.port to the port number.

3. Save and then exit inserver.ini.

2. Configure the ImageNow Server environment using the following substeps:

1. In the root for your inserver6 folder type chown -R root:bin ./* and then press ENTER.

2. Change to the bin directory.

3. Type . ./setenv.sh and then press ENTER.

4. Type ./intool --cmd create-owner-user --owner <Your Owner’s Name> and then press ENTER.

5. Type . ./setup.sh and then press ENTER.

6. Type `pwd`/inserver -start <instance_name>and then press ENTER.


Assemble and conf igure a server farm for ImageNow Server The following instructions provide a high-level overview for setting up and configuring a server farm using a Cisco Application Control Engine (ACE) Module. Refer to the appropriate Cisco documentation for more detailed information and configuration parameters. If you are using a different third-party product to set up a server farm, refer to that product’s documentation for similar instructions.

Note Setting up and configuring a server farm is optional. Continue with the steps in Installing ImageNow Client if you are not setting up a server farm.

Assembling a server farm is comprised of the following steps:

• Setting up server-health monitoring.

• Setting up real servers.

• Configuring the server farm.

• Configuring a virtual server.

• Configuring a remote override for ImageNow Message Queuing Agent.

Set up server health monitoring The following instructions include how to set up two different probe methods. The first method uses specific ImageNow Server and Message Queuing Agent Server probes that verify that the servers are running and responding to requests. The second method is a simple machine ping that pings the machine to verify that it is online.

Method one is the preferred method and you can implement both types of health checks in the same environment. However, you do not need to use both methods to set up server health monitoring.

Method one, set specific probes for ImageNow Server and ImageNow Message Queuing Agent

Perform the following steps once for each ImageNow Server health probe you want to establish and once for each ImageNow Message Queuing Agent probe you want to establish.

Note When setting up a health probe for ImageNow Server, use step 5 and skip step 6. When setting up a probe for ImageNow Message Queuing Agent use step 6 and skip step 5.

1. Open the Cisco ACE configuration tool.

2. Click the Config tab.

3. In the Load Balancing menu, select Health Monitoring.

4. In the Probe name field, provide a name for the probe.

5. For ImageNow Server, in the Health probe type field, select TCP for the type and complete the following substeps:

1. In the Port field, enter 6000. This is the port that ImageNow Server listens on, as defined in the inserver.ini file.

2. In the Send Data field, enter the following:

000000011SERVER_PING000000008END_MARK000000013CLOSE_SESSION


3. In the Expect Regular Expression field, under the More Settings header, enter the following:

.*SUCCESS.* Note This health probe ensures that SUCCESS appears in the returned string. If .* tokens are not valid on your load balancer, adjust the configured receive string. Load balancers that perform a 'contains' comparison with the receive string do not require the .* token.

6. For ImageNow Message Queuing Agent, in the Health probe type field, select TCP for the type and complete the following substeps:

1. In the Port field, enter 7200. This is the port that ImageNow Message Queuing Agent listens on, as defined in the inserverMQ.ini file.

2. In the Send Data field, enter the following:

000000007MQ_PING000000008END_MARK000000023MQ_TERMINATE_CONNECTION

3. In the Expect Regular Expression field, under the More Settings header, enter the following:

.*SUCCESS.* Note This health probe ensures that SUCCESS appears in the returned string. If .* tokens are not valid on your load balancer, adjust the configured receive string. Load balancers that perform a 'contains' comparison with the receive string do not require the .* token.

7. In the Probe interval count field, enter a probe interval count. This is the time interval between sending probes during a health check. The recommended value is 15 seconds.

8. In the Pass detect (failed probe) interval field, enter a pass detect count. This is the time interval between sending probes during a health check when the server is in a known bad state. The recommended value is 30 seconds.

9. In the Fail detect count field, enter a fail-detail count. This is the consecutive number of times a probe must fail before the server is marked as failed. The recommended count is two times. If you set the Probe interval count to 15 seconds in step 8, the load balancer stops sending new connections to the server within 30 seconds of it going down.

10. In the Pass detect count field, enter a pass detect count. This is the number of successful responses a probe must produce before the server is marked healthy. The recommended count is two times. If you set the Pass detect (failed probe) interval to 30 seconds in step 9, the load balancer starts to send new connections to the server within one minute of it coming back up.

11. In the Receive timeout for a response count field, enter a receive timeout for a response count. This is the amount of time that a server has to return a response during a probe. If it does not return a response within the set time, the probe fails. The recommended value is five seconds.

Method two, set a simple machine ping

The following steps establish a simple machine ping that verifies the machine is online.



3. In the Load Balancing menu, select Health Monitoring.

4. Create a new health probe by clicking the + (plus) symbol.

5. In the Probe name field, provide a name for the probe.

6. In the Health probe type field, select ICMP for the type.


7. In the Pass detect (failed probe) interval field, enter a pass detect count. This is the time interval between sending probes during a health check when the server is in a known bad state. The recommended value is 30 seconds.

8. In the Fail detect count field, enter a fail-detail count. This is the consecutive number of times a probe must fail before the server is marked as failed. The recommended count is two times. If you set the Probe interval count to 15 seconds in step 8, the load balancer stops sending new connections to the server within 30 seconds of it going down.

9. In the Pass detect count field, enter a pass detect count. This is the number of successful responses a probe must produce before the server is marked healthy. The recommended count is two times. If you set the Pass detect (failed probe) interval to 30 seconds in step 9, the load balancer starts to send new connections to the server within one minute of it coming back up.

10. In the Receive timeout for a response count field, enter a receive timeout for a response count. This is the amount of time that a server has to return a response during a probe. If it does not return a response within the set time, the probe fails. The recommended value is five seconds.

Set up real servers Set up the real servers on a VLAN interface. Make sure that these servers exist on the same subnet as the VLAN interface. After setting up the servers on real machines, use the following steps to add them to the hardware load-balancer configuration.



3. Add a new server by clicking the + (plus) symbol.

4. In the Server Name field, enter the server name.

5. In the IP address field, enter the IP address.

6. In the Connection limits field, enter the connection limits.

Configure the server farm Configure the server farm for ImageNow Server and ImageNow Message Queuing Agent using the steps in the following sections.

Configure the server farm for ImageNow Server



3. In the Load Balancing menu, select Server Farms.

4. Add a new server farm by clicking the + (plus) symbol.

5. To monitor the health of the server farm, set the probe to the one that you configured when you set up server-health monitoring.

6. Select Purge for the fail action. This sends a reset to terminate the socket connection when a server fails.

7. Click Deploy Now.

8. Under the Real Server @ <ServerFarmName> heading, add the real servers to the server farm by clicking the + (plus) symbol.


9. Complete the following substeps.

1. In the Real server name list, select the real server name.

2. In the Port field, set the port number to the port ImageNow Server listens on. This is the same port that was set when you created the health probe for ImageNow Server. The default is 6000, as defined in the inserver.ini file.

3. Optional. Set a backup server and port. The backup server becomes active if the real server is in a failed state.

4. In the Server weight area, configure the server weight. Servers with higher weights receive more connections as a ratio of their weight to the other servers’ weights.


10. Click the Predictor tab and select Least Connections for the predictor type.

Configure the server farm for ImageNow Message Queueing Agent



3. In the Load Balancing menu, select Server Farms.

4. Add a new server farm by clicking the + (plus) symbol.

5. To monitor the health of the server farm, set the probe to the one that you configured when you set up server-health monitoring.

6. Select Purge for the fail action. This sends a reset to terminate the socket connection when a server fails.


8. Under the Real Server @ <ServerFarmName> heading, add the real servers to the server farm by clicking the + (plus) symbol.

9. Complete the following substeps.

1. In the Real server name list, select the real server name.

2. In the Port field, set the port number to the port ImageNow Message Queuing Agent listens on. This is the same port that was set when you created the health probe for ImageNow Message Queuing Agent. The default is 7200, as defined in the inserverMQ.ini file.

3. Optional. Set a backup server and port. The backup server becomes active if the real server is in a failed state.

4. In the Server weight area, configure the server weight. Servers with higher weights receive more connections as a ratio of their weight to the other servers’ weights.


10. Click the Predictor tab and select Least Connections for the predictor type.

Configure a virtual server for ImageNow Server Associate the server farm with a virtual server using the following steps for ImageNow Server.

1. Click the Config tab

2. In the Load Balancing menu, select Virtual Servers.


3. Add a new virtual server by clicking the + (plus) symbol.

Note This requires administrative permissions on the Cisco ACE device.

4. In the Provide a virtual server IP address field, enter a virtual server IP address. This is the address clients use to connect to one of the machines in the server farm.

5. In the Virtual Server list, select VLAN interface for the virtual server.

6. In the Load Balance list, select Load Balance for the primary action.

7. Use the server farm you configured in the “Configure the server farm” section as the server farm.

Configure a virtual server for ImageNow Message Queuing Agent Associate the server farm with a virtual server using the following steps for ImageNow Message Queuing Agent.

Note You can use the same IP address in step 4 that you use for the normal ImageNow Server, but in step 7 ensure that you use the previously defined ImageNow Message Queue Agent farm.

1. Click the Config tab

2. In the Load Balancing menu, select Virtual Servers.

3. Add a new virtual server by clicking the + (plus) symbol.

Note This requires administrative permissions on the Cisco ACE device.

4. In the Provide a virtual server IP address field, enter a virtual server IP address. This is the address clients use to connect to one of the machines in the server farm.

5. In the Virtual Server list, select VLAN interface for the virtual server.

6. In the Load Balance list, select Load Balance for the primary action.

7. Use the server farm you configured in the “Configure the server farm” section as the server farm.

Configure a remote override for ImageNow Message Queuing Agent The following steps enable clients and remote agents to use the load balanced IP address when attempting to connect to ImageNow Message Queuing Agent.

Note In the following steps, <MQHostName> is the host name of the physical server and <LoadBalancerIPAddress> is the virtual IP address for the load balancer.

1. Open the inserver.ini file with a text editor and locate the Network section.

2. Set remote.hostname.useoverride to TRUE.

3. Add the following line for each ImageNow Message Queuing Agent in your server farm:

remote.hostname.override.<MQHostName>=<LoadBalancerIPAddress>

4. Save the inserver.ini file and close the text editor.

Verify the server farm setup Complete the following steps to ensure that you have successfully setup and configured your server farm.

1. Start ImageNow Server and ImageNow Message Queuing Agent on the real server machines.


2. In the Cisco Application Control Engine (ACE) Module, select the Monitors tab.

3. In the left column, click Real Servers. Ensure that the servers you configured appear as In Service.

4. Continue with installing ImageNow Client.

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 Managing the ImageNow Database on Microsoft SQL Server document, which is available on the ImageNow website. 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 in the 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 thread setting in SQL Server, using the information in the "Tune the Microsoft SQL Server for the ImageNow Server” section of this document.

Create INEMUSER database user In addition to the INUSER database user, you have the option to set up the INEMUSER database user. If you system includes applications that need to communicate with ImageNow Server, you can use the following database tables to processes external messages. External applications can access the ImageNow database only through INEMUSER.

• IN_EXTERN_MSG • IN_EXTERN_MSG_PROP • IN_EXTERN_MSG_GROUP • IN_EXTERN_MSG_SEQ

To create INEMUSER, run the following DDL within SQL*Plus or any other tool that allows you to execute SQL against an Oracle database:

create user INEMUSER identified by Externalmsg1 default tablespace DATA temporary tablespace TEMP account unlock; alter user inuser quota unlimited on DATA; alter user inuser quota unlimited on INDX; grant create session to INEMUSER; grant select, insert, update, delete on INUSER.IN_EXTERN_MSG to INEMUSER; grant select, insert, update, delete on INUSER.IN_EXTERN_MSG_PROP to INEMUSER;


create synonym INEMUSER.IN_EXTERN_MSG for INUSER.IN_EXTERN_MSG; create synonym INEMUSER.IN_EXTERN_MSG_PROP for INUSER.IN_EXTERN_MSG_PROP;

To create a new message, insert a record into the IN_EXTERN_MSG table with a unique value for the EXTERN_MSG_ID column.

Database access through INEMUSER The database setup script creates the INUSER and INEMUSER users. INEMUSER allows you to connect your external applications to the ImageNow database. INEMUSER user can add, remove, and update records in the database tables without the risk of corrupting information stored in the ImageNow database. External applications can access the ImageNow database only through INEMUSER.

Order processing of external messages Messages with the same group process in first-in-first-out (FIFO) order.

If you want to group messages, insert the EXTERN_MSG_ID and an EXTERN_MSG_GROUP_ID into the IN_EXTERN_MSG_GROUP table. You must also insert the EXTERN_MSG_ID into the IN_EXTERN_MSG_SEQ table. The EXTERN_MSG_ID is the same ID used in the IN_EXTERN_MSG table.

Note You can add more than one group to a message by inserting additional records into the IN_EXTERN_MSG_GROUP table.

Note The EXTERN_MSG_ID and EXTERN_MSG_GROUP_ID columns have a limit of 64 characters.

Insta l l ImageNow Cl ient This document 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 guide.

Important To install or update the ImageNow Client, make sure that you are logged in as a member of the “Administrators” group on the local computer.

Before you install, verify the following:

1. 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 website at www.perceptivesoftware.com and log in to the Customer

Portal.




about:blank

Notes

• To install ImageNow Client and download any required .NET components from the web during installation, select the latest build, as shown by the highest Build Number, of ClientSetup-Light.exe. Use this installer if you are distributing this application over a network or if your network connectivity is stable.

• To install any required .NET components and ImageNow Client, select the latest build, shown by the highest Build Number, of ClientSetup.exe. This installer includes all of the .NET components required to run ImageNow Client. Use this installer if your internet network connectivity is slow or unstable.

Install ImageNow Client attended 1. Double-click the downloaded ClientSetup_<build>.exe file.

2. On the Welcome to the ImageNow Installation Wizard for ImageNow Desktop Client 6 page, click Next.

3. 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.

4. On the License Agreement page, read the License Agreement, scroll to the bottom of the agreement, select I accept the terms in the license agreement, and then click Next.

5. On 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.

• Business Insight Integration – Installs all files necessary to view Business Insight reports in ImageNow.

6. On the ImageNow Server page, enter a name for the default profile, enter the name and port number of the ImageNow Server, and then click Next.

7. On the ImageNow Shortcuts page, select the shortcuts you want to appear, and then click Next.

8. On the Ready to Install the Program page, click Install.

9. On the Installation Wizard Completed page, select the Show the readme file check box.

10. Click Finish.

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.

The default features include the ImageNow Client, Demo 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 or Business Insight Integration.

The following instructions refer to the "common application data folder," which is typically hidden. Its physical location varies, depending on your version of Windows. For example, in Windows XP, the path to this folder is C:\Documents and Settings\<username>\Local Settings\Application Data\ Downloaded Installations\[Unique ID] and in Windows 7, the path to this folder is C:\ProgramData\Downloaded Installations\[Unique ID]. Refer to your Windows documentation for the specific location of your common application data folder.

Prepare the ImageNow Client files

1. 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 downloaded executable.

2. 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.

3. By default, ClientSetup.msi is extracted to the common application data folder. The Unique ID varies with each build, and so you must 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.

4. In the Welcome to the ImageNow Installation Wizard for ImageNow Client page, click Cancel.

Note Do not delete the Downloaded Installations\[Unique ID] folder or remove the MSI file. You must have both for certain maintenance functionality.


The following table contains the arguments you can use when you install ImageNow Client unattended. 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 recommended, installation directory is [drive:]\Program Files\ImageNow6.

[drive:]\Program Files\ImageNow6

INSTALLDIR=\”C:\Program Files\IN6\”

L Set the language for the installation. English = 1033 German = 1031 Spanish = 1034 French = 1036 Dutch = 1043 Brazilian Portuguese = 1046 Italian = 1040

1033 /L1033

L*V This value is optional, and the default is no log file generated. If you use this argument, setup does not create directories. The path for the log file generation must be a valid, existing path. This argument is typically used to diagnose installation errors.

%TEMP% directory

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



ADDLOCAL Select which features are installed. Optional features are DemoImages, UserHelp, AdminHelp, KeyView, ImageNowPrinter, and BIIntegration.

Important You must install ImageNowClient, Accusoft, Pixtran, SystemFiles, LeadTools, and OneDirectory for the 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 some features are optional.

Note For definitions of values for the ADDLOCAL argument, refer to the ADDLOCAL value definitions section.

ImageNowClient, Accusoft, Pixtran, SystemFiles, LeadTools, OneDirectory, DemoImages, UserHelp, AdminHelp, KeyView,

ADDLOCAL= ImageNowClient,Accusoft, Pixtran,SystemFiles, LeadTools,OneDirectory

IN_PROFILENAME The default connection profile name.

DefaultProfile

IN_PROFILENAME=default

IN_SERVER_NAME The ImageNow Server host name or host address.

Localhost IN_SERVER_NAME= MyServer

IN_PORT_NO The ImageNow Server port. 6000 IN_PORT_NO=7000

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

Yes STARTMENUICON=Yes

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

Yes DESKTOPICON=No

QUICKLAUNCHICON The default value is 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.

Yes QUICKLAUNCHICON= Yes



UPDATE_URL Specify the HTTP address for PEDS to check for ImageNow Client updates.

NA UPDATE_URL=http://webserver:8080/pedserver

PUPDATE_URL.34D7B38C_34B1_4B08_A7CB_C1A906C54F91

Specify a different HTTP address for PEDS Client to check for PEDS Client updates.

NA PUPDATE_URL.34D7B38C_34B1_4B08_A7CB_C1A906C54F91=http://otherwebserver:8080/pedserver

Run the unattended installation

You use the arguments in the preceding table as the argument list for your installation.

1. Enter one of the following commands, depending on whether you need to use the EXE or the MSI file. Replace “ClientSetup.exe” with the name of the downloaded executable file. You can use one of the commands in a command line script you create for your deployment software:

• If you can use the EXE file, which is the preferred and more reliable method, enter:

ClientSetup.exe /s /V“<argument list>” EXAMPLE: "ClientSetup.exe" /L1033 /s /V"/quiet /norestart /Lime \"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 /i "C:\ClientSetup.msi" /norestart /quiet /qb /l* log.txt ADDLOCAL=ALL IN_PROFILENAME=default IN_SERVER_NAME=localhost IN_PORT_NO=6000 STARTMENUICON=Yes DESKTOPICON=No QUICKLAUNCHICON=No REMOVEOLDVERSIONS=No UPDATE_URL=http://webserver:8080/pedserverPUPDATE_URL.34D7B38C_34B1_4B08_A7CB_C1A906C54F91=http://otherwebserver:8080/pedserver

Note On the Start menu, click Run and enter msiexec for help on its command-line parameters.

2. Verify your installation.

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.


http://webserver:8080/pedserver

http://webserver:8080/pedserver

http://otherwebserver:8080/pedserver

http://otherwebserver:8080/pedserver

Value Description

Pixtran Installation of these features is mandatory to ensure the application works 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.

BIIntegration Functionality to view Business Insight reports in ImageNow.


Schema changes for an INOW6 database on a SQL Server Prior to the ImageNow 6.7 release, the INOW6 database tables resided in the DBO schema. This was the default schema for users that connected to the database tables using Windows Authentication. In ImageNow 6.7, the INOW6 database tables reside in a new schema called INUSER. These tables are automatically moved from the DBO schema to the INUSER schema when an upgrade is performed. Any permissions that have been granted to the ImageNow tables, such as INEMUSER, reports and so on, are lost during the transfer. However, a SQL script is available to identify the permissions and dynamically create the SQL commands to re-grant the permissions for each table at the object level. Alternatively, if you do not need to set different permissions for each table, you can grant the permissions across the entire INUSER schema level with a single command.

This change also affects external systems that access the ImageNow database. If your users have hard coded access to the ImageNow database tables using the OWNER.TABLE_NAME structure, you must change it when performing the update to 6.7.

Granting permissions to the INUSER schema If you need to set different permissions for individual tables, use the instructions in Granting permission at the object level. If your environment is configured to allow access to all of the tables using one set of permissions, use the instructions in Grant permissions cross the entire schema.

Grant permissions at the object level

1. Execute the MSSQL_Get_INOW6_Privs.sql script and save the output.

2. After the database has been upgraded, manually execute the permission statements that are dynamically generated when you run the MSSQL_Get_INOW6_Privs.sql command.

3. If you have external systems that access the INOW6 database using the dbo.IN_EXTERN_MSG access structure, change it to inuser.IN_EXTERN_MSG.

Note If users perform queries by table name only, you do not have to change the access structure if they are connecting to the database with the inuser login.

Grant permissions across the entire schema

1. Instead of granting specific permissions for each individual object, as outlined in the previous section, you can run the following command instead to grant the appropriate privileges across the entire schema:

GRANT SELECT [INSERT, UPDATE, DELETE] ON SCHEMA :: inuser TO reports;

For example:

GRANT SELECT ON SCHEMA :: inuser TO reports;

2. If you have external systems that access the INOW6 database using the dbo.IN_EXTERN_MSG access structure, change it to inuser.IN_EXTERN_MSG.

Note If users perform queries by table name only, you do not have to change the access structure.


Insta l l an ImageNow Server l icense Before entering your license, you must install 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 also be the root user on UNIX.

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

1. Generate a system fingerprint using the following substeps:

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

2. In the Login page, click License Manager.

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

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

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

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

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

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

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

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

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

2. In the login page, click License Manager.

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

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

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

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

3. Click OK.


Start a l l ImageNow serv ices After everything is licensed, you can start the ImageNow services. Skip this procedure if your services are running.

1. If this is a new UNIX terminal session, then run setenv.sh.

Note If you ran setenv.sh for this session, do not run it again. If you are unsure whether you have run the command, check the IMAGENOWDIR6 environment variable with the following command:

echo $IMAGENOWDIR6

2. Start all services and agents. For example, to start the main services and agents (inserver, inserverAlarm, inserverBatch, inserverEM, inserverImp, inserverJob, inserverMonitor, inserverMQ, nserverTask and inserverWorkflow), navigate to the inserver6/bin directory, and then execute the following commands:

`pwd`/inserver –start <instance_name> `pwd`/inserverAlarm –start <instance_name> `pwd`/inserverBatch –start <instance_name> `pwd`/inserverEM –start <instance_name> `pwd`/inserverImp –start <instance_name> `pwd`/inserverJob –start <instance_name> `pwd`/inserverMonitor –start `pwd`/inserverMQ –start <instance_name> `pwd`/inserverWorkflow –start <instance_name>

Note The instance name allows for multiple instances of the same agent or server to run in parallel in an active-active environment. If you do not specify an instance name, the default value is set to Primary.

3. If you installed the ImageNow option for full-text, navigate to the inserver6 directory, execute the following command:`pwd`/inserverFT -setup.

Note If you purchased additional ImageNow agents or services, like inserverFT or inserverMA, you must also start them. Each time you log on, you must set your environment variables, as shown in the previous step, before you execute start-up commands like `pwd`/inserver


Append ix A : Ins ta l l i ng a second ImageNow Ser ver An advantage of running the ImageNow Server in a UNIX environment is the ability to run multiple ImageNow Servers on the same system. This feature allows you to install and run a test ImageNow Server on the same system as the production ImageNow Server.

To install a second ImageNow Server, add the following steps to the installation procedure for the second server. These steps change the semaphores available to the second ImageNow Server from the operating system and to change inserver listening port. To make these changes, add these steps when you update the INI files during the installation procedure.

• Open the inow.ini file for editing.

• Change the inowd.semaphore_key setting, which is the beginning of the range of semaphores available to this ImageNow Server instance. Discuss the value of this setting with your UNIX administrator. It is recommended that you add 100 or 1000 to the default value.

• Save and then close the inow.ini file.

• Open the inserver.ini file for editing.

• Change the inowd.port to an available port number. Your UNIX administrator should assist in finding an available port. Recommended selections include: 2000, 3000, 4000, and 5000.

• Change the inowd.max.port setting. The first port used by inserver is actually the inowd.port setting plus 100. Change this setting accordingly, based on the inowd.port setting and the number of users.

• Save and then close the inserver.ini file.


Append ix B : Ser ver conf igura t ion tab les

inow.in i 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.

Optional settings The standard settings for the inow.ini file appear in the following table. In addition to the standard settings, you can manually add the following setting to inow.ini as needed.

• Under [Logon Control], add the following setting:

logon.settings.delimiter=

This setting allows you to select a character to be the delimiter for the LDAP.ImageNow.Groups and LDAP.ImageNow.Users settings. You can use any symbol you want except for square brackets - '[' or ']'.

• Under [Directory Locations], add the following setting:

temp.dir=

This setting allows you to change the directory ImageNow Server uses for temporary files. The default location is $(IMAGENOWDIR6)/temp.

Group Setting Options Description

Logging

(optional)

rolling.log.files.enabled TRUE

FALSE

Enables ImageNow to create multiple log files of a size you specify. This setting is useful in large-scale environments where log files tend to be large.

The default is FALSE.

rolling.log.file.threshold Any positive integer

When rolling.log.files.enabled = TRUE, specifies the size in MB of the log files.

The default is 100.

Network encryption.enabled TRUE

FALSE

Specifies whether data encryption is enabled for the network.

TRUE = Encryption is enabled.

FALSE = Encryption is not enabled.




Network

(continued)

ipv6.enabled TRUE

FALSE

Specifies whether Internet Protocol version 6 (IPv6) is enabled for the network. If it is disabled, the process supports only IPv4.

TRUE = IPv6 is enabled.

FALSE = IPv6 is disabled.


OSM filesystem.minimum. required.space

Any integer from 0 to 2,147,483,648

Specifies, in bytes, the memory threshold for OSM storage. When the threshold is exceeded, ImageNow displays a warning message.

This value is a maximum of (2^31) bytes. This value is verified prior to storing documents in a Centera OSM.

If the device has fewer bytes available than the value specified here, no document is stored. This statement applies to FSS and CAS. With FSS, if an OSM tree does not have enough space, ImageNow checks other OSM trees in that OSM set. If there is no tree available that contains enough space, an error results.

The default is 2000000.

centera.capacitycheck. enabled

TRUE

FALSE

Specifies whether ImageNow Server checks the Centera device to determine if it has enough memory to store the OSM tree.

TRUE = ImageNow Server checks for memory.

FALSE = ImageNow Server does not check for memory.


centera.temp.dir Any valid directory Specifies the location of the Centera temporary directory.

The default is $(IMAGENOWDIR6)/temp/centera.

This setting does not appear in the inow.ini file by default. You must create the setting.



Doc scan.as.creation TRUE

FALSE

Specifies whether the scanning user or current user is identified as the document creation user.

TRUE = Scanning user is document creation user.

FALSE = Current user is document creation user.

The default is TRUE.

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.


Directory Locations form.dir Any valid directory Specifies the forms directory.

The default is $(IMAGENOWDIR6)/worksheet.

You may set the directory to any location, including other drives (such as Z:\forms) and it can be named anything. You may also set it as a Windows UNC path name (such as \\computername\form\path). The original path may still be used under this new capability.

form.shared.dir Any valid directory Specifies the location of shared form files.

The default is shared.

Can be its own full path. You may set the directory to any location, including other drives (such as Z:\formsshare) and it can be named anything. You may also set it as a Windows UNC path name (such as \\computername\share\path). The original path may still be used under this new capability.

Directory Locations

(continued)

logging.dir Any valid directory Specifies the directory in which ImageNow Server and Agents stores log files.

The default is $(IMAGENOWLOCALDIR6)/log.



Envoy

(Optional)

Date.time.zone.enabled TRUE

FALSE

Setting this to FALSE removes the time zone from the end of an XSD:date type. For example, if set to FALSE:

YYYY-MM-DDZ will be displayed as YYYY-MM-DD.

Where Z is the time zone.


ERM erm.enabled TRUE

FALSE

Specifies whether you are using ERM.

TRUE = ERM is enabled.

FALSE = ERM is disabled.


ODBC odbc.dbms Oracle

SQLServer

Specifies the DBMS ImageNow uses.

odbc.dsn Any valid database name

Specifies the name of your ImageNow database.

The default is ImageNow 6.

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

FALSE

Specifies whether ODBC uses the DD driver. The default is TRUE.



ODBC (continued) odbc.grid.max.fetch. count

Any positive integer

Specifies that maximum number of records retrieved by ODBC at one time.

This setting applies to workflow, batch, related documents, document search, folder search, ERM, and folder viewer grids.


Note For changes to this setting to take effect in ImageNow, you must also change the Maximum results setting in View Designer, or in the Appearance properties of the folder type, workflow queue, or workflow process.

auth.odbc.dbms Oracle

SQLServer

ImageNow Server uses auth.* settings to connect to the authorization database when logon.method is set to SQL.

This setting specifies the database management system ImageNow uses.

auth.odbc.dsn Any valid database name

Specifies the name of your ImageNow database.

auth.odbc.userid Any valid username

Specifies the user ID for the ODBC connection.

The default is inuser.

auth.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.



Licenses combo.imagenow.number

combo.webnow.number

combo.interact.desktop.number


Use these settings to allocate the number of user connections to each client type (ImageNow, WebNow, and Interact Desktop), available on a combo client license. The values for each setting must total the number of user connections available.

For example, if the total number of user connections available is 15, you can set the INI file as follows:

combo.imagenow.number=7

combo.webnow.number=5

combo.interact.desktop.number=3

If the total number of user connections allocated exceeds the total number available, then the ImageNow Client receives the seat allocations first, followed by WebNow, and then Interact Desktop.

If the total number of user connections allocated is less than the total number available, then the ImageNow Client receives the remainder of the licenses.

The clients are prioritized as follows:

ImageNow

WebNow

Interact Desktop

The default value for each value is 0.

Logon Control logon.method SYSTEM

LDAP

SQL

Specifies the value that determines what method to use when inserver authenticates user logons from 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

2

3

If logon.method is set to SYSTEM, and Windows NT is the operating system, this setting specifies the 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.

Logon Control

(continued)

client.validation TRUE

FALSE

Specifies whether ImageNow allows the ImageNow Client to 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.


nt.domain.list Domains separated by commas

Specifies the valid NT Domain list of which the ImageNow User ID must already be logged into on the requesting PC.



LDAP<n>.server Any valid IP address or server name

If logon.method is set to LDAP, 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.

When using LDAP with SSL, you must specify the fully qualified domain name (FQDN) for this setting.

LDAP<n>.server.port Any valid port number

Specifies the port number used by the LDAP server.

The default is 389.

Logon Control

(continued)

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.

Note This setting is required for direct and indirect authentication.

LDAP<n>.password Any valid password

Specifies the LDAP password for the user DN specified in the LDAP.login setting.

Notes

This setting is required for direct and indirect authentication.

If the ldap.password or ldap.login property is left blank, the ImageNow Server automatically attempts an anonymous login.

LDAP<n>.use.ssl TRUE

FALSE

Specifies whether to use LDAP over SSL.


LDAP<n>. conn.timeout Any positive integer

Specifies the amount of time, in seconds, before the ImageNow server abandons an attempt to connect to the LDAP Server during authentication.



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

1 = Direct binding

2 = Indirect binding

The default is 1.

LDAP<n>.ImageNow. Groups

Any list of valid groups separated by carets (^)

Specifies lists of groups that use LDAP.

LDAP<n>.ImageNow. Users

Any list of valid users separated by carets (^)

Specifies lists of users that use LDAP.

LDAP<n>.name. prepend

Any string If LDAP.method is set to 1, this setting specifies the string to add before the user name.

Logon Control

(continued)

LDAP<n>.name. append<n>

Any string If LDAP.method is set to 1, this 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>.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".

LDAP<n>.login.attr Any valid attribute Specifies the LDAP user attribute you want to search for in the LDAP 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 Control

(continued)

logon.singlesignon. enable

TRUE

FALSE

Specifies whether users running multiple desktop clients can use the 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.


logon.minclientversion Any valid ImageNow Client version number that uses the general format: <major>.<minor>.<revision>.<build>

Specifies the Image Now version number the Windows Client must meet or exceed to log onto the ImageNow Server successfully. The default setting is 0.0.0.1 and may be changed to force upgrades for revisions and builds within the same release version.

logon.minclientversion. msg

Any text string Specifies the message that will 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.”



Logon Control

(continued)

wn.sso TRUE

FALSE

You must add this setting to the inow.ini file to use it.

Specifies whether single sign-on is enabled for WebNow.

Notes

To enable single sign-on for WebNow, you must also configure the single sign-on settings in WebNow.settings on the WebNow Server machine.

When single sign-on is enabled, your single sign-on provider supplies authentication information. Users cannot log in to WebNow anonymously.

wn.sso.key Any valid string You must add this setting to the inow.ini file to use it.

Specifies the token used when single sign-on is enabled for WebNow.

Message Queuing 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.

Forms form.integration TRUE

FALSE

Specifies whether forms are enabled.


OCR ocr.integration TRUE

FALSE

Specifies whether OCR is enabled.


Data Capture data.capture. integration

TRUE

FALSE

Specifies whether DataCapture is enabled.


Full Text full.text.integration TRUE

FALSE

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

TRUE = Enabled.

FALSE = Disabled.




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

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

cleanup.bulk.files TRUE

FALSE

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

TRUE = Internal bulk files are deleted after use.

FALSE = Internal bulk files are not deleted.


search.last.n. collections

Any positive integer up to the total number of collections

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

0 = Search all collections.

The default is 0.

collection.high.water. mark


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


Full Text

(continued)

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. delay.seconds


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

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

The default is 300.



content.submission. threshold


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

The default is 500.

index.new.content.in. batch

TRUE

FALSE

Specifies whether ImageNow indexes documents in batches.

TRUE = ImageNow indexes documents in batches.

FALSE = ImageNow does not index documents in batches.


Fax Out fax.out.integration TRUE

FALSE

Specifies whether outbound faxing is enabled.

TRUE = Outbound faxing is enabled.

FALSE = Outbound faxing is disabled.


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

2

3

Specifies where audit details are stored.

1 = XML formatted file

2 = Database

3 = Both the XML file and the database

The default is 1.



login.audit.level 0

1

Specifies the verboseness level for user authentication auditing.

0 = no authentication auditing

1 = audit only failed authentication attempts

The default is 0.

Auto Form auto.form.integration TRUE

FALSE

Determines whether Auto Form integration is active.

TRUE = Auto Form integration is activated.

FALSE = Auto Form integration is deactivated.

Statistics stats.ss.delimiter Any valid character Specifies the character used as a delimiter between columns in statistic log files.

Statistics

(continued)

stats.all.log.type 0, 1, 2, 3, 4 Specifies the logging period for all types of statistic logs.

Note If you set a subsequent status.<category>.log.type to a value other than 0, that category's settings override these global statistic settings.

0 = Logging turned off

1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.all.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 2.

stats.all.timer.period Any positive integer ranging from 5 to 3595

If stats.all.log.type = 1, this setting specifies the frequency, in seconds, ImageNow creates a statistics log.


stats.all.start.time Any positive integer ranging from 0 to 23

If stats.all.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.



stats.all.action.length Any positive integer ranging from 0 to 1000

Truncates the action string printed to the log to the number of characters specified as the value.

0 = Show all

The default is 0.

Statistics

(continued)

stats.servercall.log.type 0, 1, 2, 3, 4 Specifies the logging period for ImageNow Server logs.


1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.servercall.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 0.

stats.servercall.timer. period

Any positive integer ranging from 5 to 3595

If stats.servercall.log.type = 1, this setting specifies the frequency, in seconds, ImageNow creates an ImageNow Server log.


stats.servercall.start. time


If stats.servercall.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.

stats.servercall.action. length



0 = Show all

The default is 0.



Statistics

(continued)

stats.query.log.type 0, 1, 2, 3, 4 Specifies the logging period for SQL logs.


1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.query.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 0.

stats.query.timer.period Any positive integer ranging from 5 to 3595

If stats. query.log.type = 1, this setting specifies the frequency, in seconds, ImageNow creates a SQL log.


stats.query.start.time Any positive integer ranging from 0 to 23

If stats.query.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.

stats.query.action. length



0 = Show all

The default is 0.

stats.query.plan. threshold

Any number from 0 to 3599.999

Specifies, in seconds, the threshold for queries. Any query that takes longer to run than the threshold is included in the log. The query is logged in a separate details log where the execution plan for that query is written.

The default is 1.0.



Statistics

(continued)

stats.query.plan.freq Any positive integer from 0 to 100

Specifies how often query plans are included in the log.

0 = Query plans are not logged.

n = Query plans that exceed the threshold specified in stats.query.plan.threshold are included every n log periods and are logged to a separate details log.

For example, stats.query.plan.freq = 2 means query plans are logged once every two log periods.

The default is 1.

stats.storage.log.type 0, 1, 2, 3, 4 Specifies the logging period for OSM storage operations logs.


1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.storage.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 0.

stats.storage.timer. period


If stats.storage.log.type = 1, this setting specifies the frequency, in seconds, ImageNow creates an OSM storage operations log.


stats.storage.start.time Any positive integer ranging from 0 to 23

If stats.storage.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.

Statistics

(continued)

stats.storage.action. length



0 = Show all

The default is 0.



stats.mq.log.type 0, 1, 2, 3, 4 Specifies the logging period for message queue logs.


1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.storage.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 0.

stats.mq.timer.period Any positive integer ranging from 5 to 3595

If stats.storage.log.type = 1, this setting specifies the frequency, in seconds, ImageNow creates a message queue log.


stats.mq.start.time Any positive integer ranging from 0 to 23

If stats.mq.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.

stats.mq.action.length Any positive integer ranging from 0 to 1000

The default is 0.

Statistics

(continued)

stats.wfaction.log.type 0, 1, 2, 3, 4 Specifies the logging period for WFActions logs.


1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.wfaction.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 0.

stats.wfaction.timer. period


If stats.wfaction.log.type = 1, this setting specifies frequency in seconds ImageNow creates a WFActions log.




stats.wfaction.start.time Any positive integer ranging from 0 to 23

If stats.wfaction.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.

stats.wfaction.action. length



0 = Show all

The default is 0.

Statistics

(continued)

stats.thread.log.type 0, 1, 2, 3, 4 Specifies the logging period for ImageNow Server thread logs.


1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.thread.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 0.

stats.thread.timer.period Any positive integer ranging from 5 to 3595

If stats.thread.log.type = 1, this setting specifies the frequency, in seconds, ImageNow creates an ImageNow Server thread log.


stats.thread.start.time Any positive integer ranging from 0 to 23

If stats.job.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.

stats.thread.action. length



0 = Show all

The default is 0.



Statistics

(continued)

stats.job.log.type 0, 1, 2, 3, 4 Specifies the logging period for Job logs.


1 = User defined

Note If you specify value = 1, you must specify the number of seconds in the stats.job.timer.period setting.

2 = Hourly

3 = Every six hours

4 = Every 12 hours

The default is 0.

stats.job.timer.period Any positive integer ranging from 5 to 3595

If stats.job.log.type = 1, this setting specifies frequency in seconds ImageNow creates a Job log.


stats.job.start.time Any positive integer ranging from 0 to 23

If stats.job.log.type = 3 or 4, this setting specifies the starting hour statistic logs are created for six or 12 hour logs.

The default is 0.

stats.job.action.length Any positive integer ranging from 0 to 1000


0 = Show all

The default is 0.

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

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

webnow.getpage Any valid URL page location

Specifies the home page for WebNow.

The default is index.jsp?action=filter&.

Digital Signature digIDExpireInterval Any positive integer

Specifies the expiration period, in days, for digital IDs.

The setting is only available if you have a Document Management license.

You must restart the ImageNow Server if you change this setting in the inow.ini file. If you make the change from the Management Console, you do not need to restart the server.

0 = Never expires.

The default is 365.



digSigReportDisplay 0, 1, 2 Specifies the digital signature display option when printing a Digital Signature report.

0 = Disables the report.

1 = Prints only valid digital signatures on the report.

2 = Prints all digital signatures on the report.



The default is 1.

Digital Signature

(continued)

digSigPwdOption TRUE FALSE

Specifies whether a user who digitally signed a document but who did not log out before the specified time out value must re-enter his or her digital signature password.


This setting must be TRUE to set the dig.sig.pwd.webnow.timeout or the dig.sig.pwd.imagenow.timeout setting to any value other than -1.


TRUE = Enabled

FALSE = Disabled




dig.sig.pwd.webnow. timeout

-1, 1, 2, 3, 4, 5, 10, 15, 20, 25, 30, 40, 50, 60

Specifies the amount of time, in minutes, before the user must re-enter his or her digital signature password when logged in to WebNow.


The time out applies globally to all digital signatures.

Adding any value other than those specified in the Options column results in the value being ignored.


-1 = Never times out.

The default is -1.

Digital Signature

(continued)

dig.sig.pwd.imagenow. timeout

-1, 1, 2, 3, 4, 5, 10, 15, 20, 25, 30, 40, 50, 60

Specifies the amount of time, in minutes, before the user must re-enter his or her digital signature password when logged in to ImageNow.


The time out applies globally to all digital signatures.

Adding any value other than those specified in the Options column results in the value being ignored.


-1 = Never times out.

The default is -1.



dig.sig.lock.addendum. only

TRUE FALSE

Specifies whether an addendum is required to modify a signed document.



TRUE = An addendum is required.

FALSE = An addendum is not required.


Folders search.in.subfolders. enable

TRUE

FALSE

Specifies whether to search within the subfolders of a folder hierarchy.



inserver. in i 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.


General remove.old.service 1

0

Specifies whether ImageNow Server removes old services.

1 = ImageNow Server removes services.

0 = ImageNow Server does not remove services.

The default is 0.

client.autotimeout.enabled TRUE

FALSE

Specifies whether ImageNow Server automatically times out the 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.


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. This setting applies to ImageNow and Interact Desktop Clients. ImageNow Server supports a minimum of 30 minutes for ImageNow Client and 2 minutes for Interact Desktop Client.

For example, if you set this option to 5 minutes, ImageNow Server logs the ImageNow Client off after 30 minutes of inactivity, and the Interact Desktop Client after 2 minutes of inactivity. If you leave the default setting, ImageNow Server logs off both clients after 30 minutes of inactivity.

The default is 30.



General

(continued)

client.autotimeout.warning Any positive integer

If client.autotimeout.enabled is set to TRUE, this setting specifies the number of seconds that count down between when the timeout warning is displayed and when the user is logged out. This option should not exceed the client.autotimeout setting. If the client.autotimeout.warning value is greater than the client.autotimeout value, ImageNow disables the warning.

The minimum value for this setting is 10.

0=ImageNow Server does not send a warning.

The default is 300 seconds.

Note This setting is available only for Interact Desktop.

num.workers Any positive integer

Specifies the number of worker threads in the main pool.

The default is 15.

client. alwaysdeletelocalcopy

TRUE

FALSE

Specifies whether Document Management enables the user to 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.


thumbnail.max.size Any positive integer

Specifies the maximum pixel size for thumbnail images. Setting the maximum above 500 is not recommended.

The default is 100.

thumbnail.batch.size Any positive integer from 1 to 50

Specifies the number of thumbnail images to retrieve at one time.

The default is 5.


num.crossnode.cache. workers


Specifies the number of worker threads ImageNow Server dedicates to cross-node cache synchronization.

The default is 2.



General

(continued)

navigation.thumbnails.enabled

TRUE

FALSE

Specifies whether or not thumbnails are displayed in the Navigation area of Interact Desktop.



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


<instance name>.inowd. port

Any value Specifies the port number for a given instance of a server where <instance name> is the instance name of the server you want to set the port for. For example, if the instance name for the server is “Secondary”, this setting would be:

Secondary.inowd.port

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.

remote.hostname. useoverride

TRUE or FALSE Specifies whether ImageNow Server uses the host name in the remote.hostname.override.<hostname> setting to connect to an agent.

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

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




Network (continued)

remote.hostname.override. <hostname>

Text strings Specifies the host name of the connecting agent ImageNow Server uses when remote.hostname.useoverride is set to TRUE.

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

remote.hostname.useoverride = TRUE

remote.hostname.override.ComputerOne = Computer A

remote.hostname.override.ComputerTwo = ComputerB

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

The default is empty.

Logging socket.level.file 0

1

2

3

Specifies how ImageNow Server logs socket communication.

0 = ImageNow Server does not log communication.

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.



Logging

(continued)

debug.level.file 0 through 6 Specifies the level ImageNow Server 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.

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.

rolling.log.files.enabled TRUE

FALSE

This setting is optional.

Enables ImageNow to create multiple log files of a size you specify. This setting is useful in large-scale environments where log files tend to be large.


rolling.log.file.threshold Any positive integer


When rolling.log.files.enabled = TRUE, specifies the size in MB of the log files.

The default is 100.

Anonymous Login anonymous.logon. enabled

TRUE

FALSE

Specifies whether ImageNow Server allows anonymous log on.


number.of.anonymous users


Specifies how many anonymous users can be logged on to ImageNow Server.

The default is 0.



ClientINI client.ini.sync.mode 0, 1, 2 Specifies whether or not ImageNow.ini updates are automatically downloaded to the client. This 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.

There is no default setting.

client.ini.search.grid. file.path

Any valid path. Specifies the path to the SearchGrid.ini file used to update client INI files.

There is no default setting.

Remote vsl.extended.operators. enabled

TRUE

FALSE

Specifies whether ImageNow adds the “ends with” and “contains” 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.


Timing timing.enabled TRUE

FALSE

Specifies whether Client Performance is turned on.

TRUE = Client Performance is enabled and uses the timing.threshold.percentage setting.

FALSE = Client Performance is disabled.


timing.threshold.enabled TRUE

FALSE

When timing.enabled = TRUE, specifies if the timing.threshold.percentage setting will be used.




Timing

(continued)

timing.threshold. percentage


When timing.threshold.enabled = TRUE, specifies the threshold as a percentage. When the percentage of documents exceeds 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.

The default is 10.

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.

The default is 6.

timing.state.removal. period



Specifies, in hours, how often Client Performance searches ImageNow Server for expired reports. Client Performance moves expired reports to the database.

The default is 4.

timing.purge.delay Any positive integer

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

The default is 60.

timing.category. viewer.enabled

TRUE

FALSE

Specifies whether ImageNow collects data based on a threshold you define for opening a document.


timing.category. viewer.report. threshold


Specifies the number of seconds 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.

The default is 5.



Timing

(continued)

timing.category. workflow.enabled

TRUE

FALSE

Specifies whether ImageNow collects data based on a threshold you define for routing an item forward.

timing.category. workflow.report. threshold


Specifies the number of seconds you want to establish as the threshold for routing an item forward.


timing.category. forms.enabled

TRUE

FALSE

Specifies whether ImageNow collects data based on a threshold you define for opening a form.

timing.category. forms.report. threshold


Specifies the number of seconds you want to establish as the threshold for opening a form.


timing.detail.purge.enabled TRUE

FALSE

Enables periodic deletion of detailed performance data.

If timing.aggregation.enabled is set to TRUE, then ImageNow condenses the detailed performance data after this number of hours instead of deleting it.

timing.detail.retention. period

0, or a positive integer that is a multiple of 24

Specifies the number of hours after which ImageNow deletes detailed performance data.

timing.aggregation.enabled TRUE

FALSE

Enables retention of detailed performance data as condensed performance data. If set to TRUE, then ImageNow condenses the detailed performance data after the number of hours set for timing.detail.retention.period.

timing.aggregate.purge. enabled

TRUE

FALSE

Enables periodic deletion of condensed performance data.

timing.aggregate.retention. period

An integer between 0 and 9999

Specifies the number of days after which ImageNow deletes condensed performance data.



Business Insight business.insight. address

Valid URL for Business Insight

This setting stores the URL, including the server, of the Business Insight reporting website set up in your web application server.

An example value is http://[host name]/cognos8.

business.insight. authnamespace

Valid namespace This setting stores the authentication namespace used to connect to Business Insight.

By default, this value matches the Namespace ID value in Business Insight Configuration.

business.insight.max. output.default


This setting stores the default number of prior versions of report output that appears when you set the value in ImageNow Management Console.

The default value is 5.

Folders folders.move.maximum. results


Specifies the maximum number of folder to move, for example:

Folders.move.maximum.result=50

The default is 50.

folders.path.delimiter Any character or characters

Specifies the character used to separate values in the path that displays the folder location.

The default is \.

Note To add a space before and after a character, enclose the spaces and delimiter character in quotation marks. For example, suppose you enter the following value for the folders.path.delimiter setting:

folders.path.delimiter=“ \ ”

ImageNow displays the folder path as <drawer name> \ <folder name>

LearnMode pretrieve.interval Any positive integer from 0 to 10,000

Specifies, in milliseconds, the polling interval value for LearnMode Pretrieve.

The default is 500.



inserverAlarm.in i 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.


General num.workers Any positive integer

Specifies the number of worker threads used when the Alarm Agent starts.

The default is 2.

Email queue.email.link 0, 1, 2 Specifies the link type to send in queue alarm emails.

0 = Include an ImageNow link.

1 = Include a WebNow URL link.

2 = Include ImageNow and WebNow link types

The default is 0.

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.


The default is 0.


inserverBatch. in i 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.

Note Changes to settings in the INI file require a restart of the ImageNow Server and any affected agents unless noted otherwise in the Description portion of the setting.


General pause.between. transactions


Specifies, in milliseconds, how long Batch Agent pauses between pages when processing a batch.

The default is 100.

barcode.fail.to.queue. enabled

TRUE

FALSE

Specifies whether Batch Agent can fail a batch with an unverified barcode.

TRUE = Batch Agent can fail a batch with unverified barcodes.

FALSE = Batch Agent does not fail unverified barcodes.


submit.to.content.server TRUE

FALSE

Specifies whether Batch Agent submits imported files to Content Server to provide full-text search. Content Server requires a separate license.

TRUE = Submit imported files to Content Server.

FALSE = Do not submit imported files to Content Server.


remove.old.service 0 1

Specifies whether Batch Agent removes old services from the Services list. When you enable this setting and the path and name for services match, Batch Agent removes any existing service registrations.

1 = Remove old services.

0 = Do not remove old services.

The default is 0.



Logging debug.level.file 0 through 6 Specifies the level Batch 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 level, make sure you reduce the level after you finish debugging. Failure to do so can affect performance and hard disk space.

0 = Do not log errors.

1 through 6 = Log errors. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, while 6 provides logging that offers the most information.

The default is 0.

Message Queuing mq.heartbeat.interval Any positive integer

Specifies the time, in seconds, between Message Queue heartbeats.

The default is 60.

The maximum value for this setting is 86400 seconds. If an integer that exceeds 86400 seconds is entered for this setting, the maximum value is used.

ReadSoft perform.readsoft.export TRUE

FALSE

Specifies whether Batch Agent exports files to ReadSoft for optical character recognition.

TRUE = Exports files to ReadSoft.

FALSE = Do not export files to ReadSoft.


export.mode 1

2

Specifies which pages to export to ReadSoft.

1 = Only first page.

2 = After every store page.

The default is 1.

selected.batches.only TRUE

FALSE

Specifies whether to process selected batches based on criteria. You set the criteria with the selection.criteria setting.

TRUE = Process selected batches.

FALSE = Process all batches.




ReadSoft

(continued)

selection.criteria creation.user Specifies the criteria for batches when the selected.batches.only setting is set to “TRUE”.

creation.user Any valid user names separated by ^.

Specifies the creation user when selection.criteria is set to creation.user.

Example:

creation.user=user1^user2^user3

file.name Any combination of:

<<drawer>>

<<field1>>

<<field2>>

<<field3>>

<<field4>>

<<field5>>

<<page_number>>

<<docid>>

<<doctype>>

Specifies the file name format of exported ReadSoft files.

Example:

file.name=<<drawer>>_<<field1>>_<<field2>>_<<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.

Example:

export.directory.1=<valid directory> export.directory.2=<valid directory>

failed.export.directory Any valid directory

Specifies the directory to which Batch Agent exports files that failed OCR by ReadSoft.


inserverEM.in i 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.


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.interval Any positive integer

Specifies how often, in seconds, the agent checks and downloads messages from the external message database.

The default is 60.

max.messages.per.type Any positive integer

Specifies the maximum number of processed messages to pull each time from the database for each message type.

The default is 100.

Purge Note A record’s END_TIME value determines the amount of time External Message Agent waits before purging messages. However, outbound messages are processed by other entities that may not set the END_TIME value or may set the value in local time instead of GMT time causing processed messages to be purged earlier than desired. Inbound Messages processed by inserverEM are not affected.

purge.completed. messages

TRUE

FALSE

Specifies whether External Message Agent removes messages after successful completion.

TRUE = Messages with a MSG_STATUS of 3 and an END_TIME of x hours are purged after x hours have passed.


hours.to.keep. completed.messages

Any positive integer If purge.completed.messages = TRUE, specifies the number of hours before External Message Agent purges completed messages.

The default is 48.



Purge

(continued)

purge.errored.messages TRUE

FALSE

Specifies whether External Message Agent removes messages that have been completed with an error. When set to TRUE, messages with an MSG_STATUS of 4 and an END_TIME of X hours ago are purged. The hours.to.keep.errored setting specifies the value of X

hours.to.keep.errored. messages

Any positive integer If purge.completed.messages = TRUE, specifies the number of hours before External Message Agent purges messages that have completed with an error.


Expire reset.expired.messages TRUE

FALSE

Set to TRUE if there is the potential for multiple External Messaging Agents to work on the same set of records. This allows External Messaging Agent to release a set of records it is processing after the minutes.to.expire timer has expired.

The default value is FALSE.

minutes.to.expire Any integer If reset.expired.messages = TRUE, this specifies the number of minutes before External Messaging agent will release a set of records that has finished processing.

The default value is 10.

Logging debug.level.file 0 through 6 Specifies the level External Messaging Agent uses to log errors for troubleshooting.


0 = Logging is off.


The default is 0.



ODBC odbc.timeout.seconds Any integer By default, this setting is not included as part the inserverEM.ini file. It is a hidden setting with a value of 60 seconds.

As a troubleshooting measure if you are experiencing slow performance when running multiple instances of External Messaging Agent, you can change this setting in the inserverEM.ini file.

You can confirm that it will be beneficial to change this setting by searching for the following message in the inserverEM_Pulling.log file:

[ImageNow][ODBC SQL Server Native Wire Protocol driver][Microsoft SQL Server]Lock request time out period exceeded.

Note The name of the inserverEM_Pulling.log varies, but always starts with inserverEM_Pulling.

If you see this message, add the following section to the inserverEM.ini file:

[ODBC]

odbc.timeout.seconds=1

A low value such as 1 is recommended.


inserverFS. in i The following table provides definitions and sample data for the settings in the inserverFS.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.

Note The num.transfer.workers, num.osm.replication.works, and max.osm.replication.retries settings previously in inserverFS.ini file now appear in the inserverOSM.ini file during an installation or upgrade. The setting values are not preserved during the transfer, and you must reapply the values.


General batch.delete.size Any positive integer

Specifies the number of deleted documents and folders in a batch ImageNow deletes permanently at one time. You may need to decrease this value if the CPU is taking too long to remove a large batch of items.

The default is 500.

destruction.wait.time Any positive integer Specifies the number of days a deleted document or folder remains in the recycle bin before it is permanently deleted. If you specify a value of 0, ImageNow deletes the document or folder as soon as it is sent to the recycle bin.

The default is 0.

no.work.delay.max. seconds

0 through 16 Specifies how often, in seconds, File System Agent searches for new jobs after the queue is empty.

0 = Continuously check for new jobs.

1 through 16 = Wait the specified number of seconds to check for new jobs.

The default is 16.

Logging debug.level.file 0 through 6 Specifies the level File System 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 decrease it 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 active. The higher the number, the more verbose the logging.

The default is 0.


inserver Imp. in i 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.



General import.mode INDEX_FILE

COMBO

KEYMAPPING

TIFF_TEXT_COMBO

FILENAME

DATA_CAPTURE

DOD_XML

CAPTURE_PROFILE

Specifies the types of files that Import Agent imports and the method that Import Agent uses to gather document property values and assign them to the new documents.

INDEX_FILE = Your business application provides separate index files and import files to Import Agent. The application can supply a single-line or multiple-line index file. If you set import.mode to INDEX_FILE, you must also configure the [Mode INDEX_FILE] group.

COMBO = Import Agent imports a combined index file and text data object in ASCII or XML format. Import Agent gathers property values from the first line of the file and imports the remaining data in the file. If you set import.mode to COMBO, you must also configure the [Mode COMBO] group.

KEYMAPPING = Import Agent imports a TIFF file and relies on tags within the file to provide property values. If you set import.mode to KEYMAPPING, you must also configure the [Mode KEYMAPPING] group.

TIFF_TEXT_COMBO = Import Agent imports a TIFF file and its accompanying text file that contains the text of the TIFF file. Import Agent searches the text to gather property values. If you set import.mode to TIFF_TEXT_COMBO, you must also configure the [Mode TIFF_TEXT_COMBO] group.

FILENAME = Import Agent imports objects that only contain data and gathers property values from the file name. If you set import.mode to FILENAME, you must also configure the [Mode FILENAME] group.



DATA_CAPTURE = Import Agent imports files and submits them to DataCapture. DataCapture performs OCR on the files and assigns the property values based on the defined DataCapture templates. If you set import.mode to DATA_CAPTURE, you must also configure the [Mode DATA_CAPTURE] group.

DOD_XML = Import Agent imports XML files that follow DoD 5015.02-STD requirements and gathers property values from the files. If you set import.mode to DOD_XML, you must also configure the [Mode DOD_XML] group.

CAPTURE_PROFILE = Import Agent uses a source profile, capture profile, and application plan to import files and assign property values. This mode provides the ability to store a document in a folder and to assign custom property values upon import. If you set import.mode to CAPTURE_PROFILE, Import Agent ignores the following inserverImp.ini settings: import.directory, send.to.queue, delete.source.objects.after.import, import.failed.directory, import.complete.directory, and submit.to.content.server. You must specify a capture profile for the capture.profile setting.

The default is INDEX_FILE.

import.directory.<n> Any valid directory Specifies the directory that Import Agent monitors for import files. You can define an unlimited number of directories by creating new, subsequently named import.directory.<n> settings.

Example:

import.directory.receipts=<directory>

import.directory.invoices=<directory>

The default is $(IMAGENOWDIR6)/import.

poll.interval Any positive integer Specifies how often, in seconds, the Import Agent searches for new import files.

Note Do not change this value without first consulting Product Support.

The default is 1.



pause.between. transactions

Any positive integer Specifies, in milliseconds, how 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 where Import Agent sends imported files. For each import.directory defined, create a subsequently named send.to.queue.<n> settings.

Example:

send.to.queue.invoices=<queue name>

send.to.queue.receipts=<queue name>

delete.source. objects.after.import

DELETE

MOVE

Specifies whether Import Agent deletes the source file or moves it to a specified location after Import Agent imports it.

DELETE = Delete the source file after import.

MOVE = Move the file to the directory you specify for import.complete.directory.<n> after import.

The default is MOVE.

Note If you set delete.source.objects.after.import to MOVE, you must set import.failed.directory.<n> and import.complete.directory.<n>.

import.failed. directory.<n>

Any valid directory Specifies the directory to which Import Agent stores source files that failed to import. For each import.directory defined, create a subsequently named import.failed.directory.<n>. If you set delete.source.objects.after.import to MOVE, you must set import.failed.directory.<n>.

Example:

import.failed.directory.invoices

import.failed.directory.receipts



import.complete. directory.<n>

Any valid directory Specifies the directory where Import Agent stores source files after importing them. If you set delete.source. objects.after.import to MOVE, you must set import.complete.directory.<n>. For each import.directory defined, create a subsequently name import.failed.directory.<n>.

Example:

import.complete.directory.invoices

import.complete.directory.receipts

submit.to.content.server TRUE

FALSE

Specifies whether Import Agent submits imported files to Content Server to provide full-text search. Content Server requires a separate license.

TRUE = Submit imported files to Content Server.

FALSE = Do not submit imported files to Content Server.


num.directory.workers Any positive integer Specifies the number of worker threads that monitor the directory specified for import.directory.<n>.

The default is 1.

num.import.workers Any positive integer Specifies the number of worker threads used to import files into ImageNow.

The default is 1.

capture.profile Any valid capture profile.

Specifies a capture profile for the directory Import Agent monitors for the import.directory.<n> setting. Use this setting when you set import.mode to CAPTURE_PROFILE.

No default is specified.

MODE INDEX_FILE index.file.ext Any valid file extension such as inx or txt. Separate multiple extensions with commas.

Specifies the file extension Import Agent uses to identify the index file when import.mode is set to INDEX_FILE.

The default is inx.

field.delim Any character Specifies the character Import Agent uses as the field delimiter in the index file.

The default is ^.



index.file.status. report

0

1

2

Specifies how Import Agent reports the status of index files as a result of importing.

0 = Do not generate a report.

1 = Generate a report for failed imports.

2 = Generate a report for successful and failed imports.

The default is 0.

index.file.retry. attempts

Any positive integer Specifies how many times Import Agent attempts to import a file before considering it failed.

The default is 1.

use.page.num TRUE

FALSE

Specifies whether Import Agent uses page numbers to split files and gather property values.

TRUE = Use the page number to gather property values from the associated line in the index file. Split multiple page TIFF files into one file per page and make each page a unique document in ImageNow. If a line in the index file does not list a page number, Import Agent does not import the page.

FALSE = Do not use page numbers to split files and assign property values.


split.multipage.tiffs TRUE

FALSE

Specifies whether Import Agent splits multiple page TIFF files into one file per page. If you set use.page.num to TRUE, Import Agent ignores this setting.

TRUE = Split multiple-page TIFF files.

FALSE = Do not split multiple-page TIFF files.


multi.doc.mode TRUE

FALSE

Specifies whether each page of the imported file is a unique document in ImageNow. If you set use.page.num to TRUE, Import Agent ignores this setting.

TRUE = Make each page of the file a unique ImageNow document.

FALSE = Make the entire file a single ImageNow document.




Mode COMBO combined.inx.data.file. ext

Any valid file extension. Separate multiple extensions with commas.

Specifies the file extension Import Agent uses to find the property values, 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 in the index file.

The default is ^.

Mode KEY MAPPING

image.file.ext Any valid file extension. Separate multiple extensions with commas.

Specifies the file extension Import Agent uses as the image file when import.mode is set to KEYMAPPING.

The default is tif.


FALSE

Specifies whether Import Agent splits multi-page TIFF files into one file per page.




multi.doc.mode TRUE

FALSE

Specifies whether each page of the imported file is a unique document in ImageNow.




Mode TIFF_TEXT_ COMBO

index.file.ext Any valid file extension. Separate multiple extensions with commas.

Specifies the file extension Import Agent uses to identify the index file when import.mode is set to TIFF_TEXT_COMBO.

The default is txt.

image.file.ext Any valid file extension. Separate multiple extensions with commas.

Specifies the file extension Import Agent uses as the image file.

The default is tif.



multi.doc.mode TRUE

FALSE





subsequent.image.use. first.txt

TRUE

FALSE

Specifies whether subsequent images in an import use the same index file.


Mode FILENAME image.file.ext Any valid file extension. Separate multiple extensions with commas.

Specifies the file extension Import Agent imports when import.mode is set to FILENAME.

The default is pdf.

file.name Any combination of:

<<drawer>>

<<field1>>

<<field2>>

<<field3>>

<<field4>>

<<field5>>

<<doctype>>

Specifies the syntax Import Agent uses to gather values from the file name and assign them to document properties. In the [Key mapping] group, you must enter <<index provided>> for any document properties you specify for file.name.

Example:

file.name=<<drawer>>_<<field1>>_<<field2>>_<<doctype>>

field.delim Any character Specifies the character Import Agent uses as the field delimiter in the file name.

The default is ^.


FALSE







multi.doc.mode TRUE

FALSE





Mode DATA_ CAPTURE

extension.to.capture Any valid file extension. Separate multiple extensions with commas.

Specifies the extension of the files to import when import.mode is set to DATA_CAPTURE.

The default is tif.

bypass.qa TRUE

FALSE

Specifies whether imported files bypass the Batch QA process and move directly into the DataCapture process.

TRUE = Bypass the Batch QA process.

FALSE = Do not bypass the Batch QA process.


use.previous.keys.when.missing

TRUE

FALSE

Specifies which property values to assign if DataCapture encounters a file from which it cannot extract values.

TRUE = Use property values from the previously processed document.

FALSE = Use default property values.


capture.template.<n> Any valid template. Specifies which template DataCapture uses to process imported files. Each directory that DataCapture monitors can use a different template. For each import.directory defined, create a subsequently name capture.template.<n>. If you specify a directory as monitored, but do not define a template for that directory, the Import Agent stops processing files.

Example:

capture.template.invoices

capture.template.receipts




FALSE





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

Mode DOD_XML xml.file.ext Any valid XML file extension. Separate multiple extensions with commas.

Specifies for Import Agent to import XML files that follow DoD 5015.02-STD requirements.

The default is xml.

Key Mapping doc.type <Any valid document type>

DEFAULT

<<date/time>>

<<index provided>>

<<search,<string parameter>>>

<<SerialNumber>>

<<tiff_tag>>

<<undefined>>

<<uniqueID>>

Specifies the document type value Import Agent assigns to the Type field.

For a description of the mapping options, refer to the Import Agent key mapping options table.


drawer <Any valid drawer>

<<date/time>>

DEFAULT

<<index provided>>


<<SerialNumber>>

<<tiff_tag>>

<<undefined>>

<<uniqueID>>

Specifies the value Import Agent assigns to the Drawer field.





field1

field2

field3

field4

field5

<<date/time>>

DEFAULT

<<index provided>>

<Literal text>


<<SerialNumber>>

<<tiff_tag >>

<<undefined>>

<<uniqueID>>

Specifies the values that Import Agent uses for the fields 1, 2, 3, 4, and 5 document properties.



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.

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 level, make sure you reduce the level after you finish debugging. Failure to do so can affect performance and hard disk space.

0 = Do not log errors.1 through 6 = Log errors. The higher the number, the more verbose the logging. For example, 1 offers minimal logging, while 6 provides 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 = Log communication.

0 = Do not log communication.

The default is 0.



Remote Remoted TRUE

FALSE

Specifies whether you installed Import Agent on a different computer than ImageNow Server.

TRUE = Import Agent and ImageNow Server are on different computers.

FALSE = Import Agent and ImageNow Server are on the same computer.


heartbeat.interval Any positive integer Specifies how often, in seconds, Import Agent verifies its connection to ImageNow Server. The default is 60.

socket.login.timeout Any positive integer Specifies how many seconds Import Agent waits for successful 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.


server.ip.address Any valid IP address. Separate multiple IP addresses with semicolons.

Specifies the IP address of ImageNow Server. You can supply multiple IP addresses with a semicolon delimited string. Import Agent attempts to connect to the IP addresses in the order listed until it establishes a successful connection.

Example: 123.12.123.10;234.23.234.2;345.34.345.3

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



force.server. validation

1, 0 Specifies whether Import Agent forces the server to validate the user ID and password.

1 = Force the server to validate user ID and password.

0 = Do not force the server to validate user ID and password. The default is 0.




Serial Number serial.number.format %d

Text<%d>

<%number of digitsd>

Text<%number of digitsd>

<%0number of digitsd>

Text<%0number of digitsd>

Specifies the serial number format that Import Agent generates and assigns to each job.

%d = Assign the standard serial number.

Text<%d> = Assign a serial number that includes text.

<%number of digitsd> = Assign a serial number that includes the specified minimum number of digits while padding shorter values with spaces.

Text<%number of digitsd> = Assign a serial number that includes text and the specified minimum number of digits while padding shorter values with spaces.

<%0number of digitsd> = Assign a serial number that includes the specified minimum number of digits while padding shorter values with zeros.

Text<%0number of digitsd> = Assign a serial number that includes text and the specified minimum number of digits while padding shorter values with zeros.

Example:

When serial.number.format = Acme<%08d>, and the imported job is number 118, Import Agent assigns the serial number Acme00000118.

When serial.number.format = Acme<%04d>Invoice, and the imported job is number 118, Import Agent assigns the serial number Acme0118Invoice.

When serial.number.format = Acme%d, and the imported job is number 118, Import Agent assigns the serial number Acme118.

When serial.number.format = Acme<%4d>Invoice, and the imported job is number 118, Import Agent assigns the serial number Acme 118Invoice.

The default is %d.

serial.number. startvalue

Any single-digit positive integer

Specifies the start value of the serial number.



OSM bypass.write.cache TRUE

FALSE

Specifies whether Import Agent writes new files directly to the main OSM set when OSM write caching is enabled.

TRUE = Write new files to the main OSM set.

FALSE = Write new files to the cache OSM set. If a cache OSM set is not available, Import Agent writes new files to the main OSM set.


Import Agent key mapping options The following table describes the mapping options available in the [Key Mapping] group in the inserverImp.ini file. These options map values to document property values assigned to imported files.

Option Description

<Any valid document type>

Assign the name of an existing document type in your ImageNow system.

Example: Invoice

<Any valid drawer> Assign the name of an existing drawer in your ImageNow system.

Example: Accounts Payable

<<index provided>> Assign a value specified in the applicable mode group, such as [Mode KEYMAPPING] or [Mode FILENAME].

DEFAULT Assign the value DEFAULT.

Example:

If you set drawer=DEFAULT, ImageNow stores the new document in the drawer named DEFAULT.

<<date/time>> Assign the date and time that Import Agent imports the file.

<Literal text> Assign a literal string of text up to 39 characters.

<<SerialNumber>> Assign the serial number that Import Agent generates as defined in the [Serial Number] group.

<<tiff_tag >> When import.mode = KEYMAPPING, assign values from a TIFF tag using the following format: <<tiff_tag <tag#> <tag_length> <key_start_position> <key_length>>>

Example:

field1 = <<tiff_tag 65329 10 3 5>>


Option Description


When import.mode = TIFF_TEXT_COMBO, use Parameter 1 or Parameter 2 to search an index file for values. The fixed_string is case sensitive and must match the string in the text file.

Parameter 1

<<search,fixed_string,skip number, extract number>>

Import Agent locates the string (fixed_string) and skips y characters while reading x characters. Import Agent does not stop reading a string at an EOL and it removes an EOL from the result string.

y = skip number

x = extract number

Example:

field1=<<search,"Patient No: ",0,9>>

Parameter 2

<<search,fixed_string,skipped number,EOL,EOL_ordinal>>

Import Agent locates the string (fixed_string) and assigns the first 40 characters of the result string as the property value.

When EOL_ordinal = 1, read to the first line EOL and stop.

When EOL_ordinal = 2, read to the second line EOL and stop.

When EOL_ordinal = 3, read to the third line EOL and stop.

Example:

field1=<<search,"a",1,EOL,2>>

<<undefined>> Do not assign a value.

<<uniqueID>> Assign the unique ID that ImageNow generates for each document.


inserverJob. in i 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.


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.



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.



inserverMonitor. in i The following table provides definitions and sample data for the settings in the inserverMonitor.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.


Polling polling.interval Any positive integer Specifies how often, in seconds, Monitor Agent searches for new actions and events.


The default is 3.

EventLog eventlog.enable TRUE

FALSE

Specifies whether to store information to an external file about events, actions, and status of (PAS) Monitor Agent monitors.


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.

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 (continued)

debug.level.pipe 0 through 6 Specifies the level Monitor Agent 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.


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.


defaults.cpuusage Any positive integer up to 100

Specifies the percent of CPU a PAS uses before Monitor Agent identifies the PAS as non-responsive.

The default is 90.

defaults. nonresponsivetime

Any positive integer Specifies the time, in seconds, that a PAS is over the percentage identified in defaults.cpuusage before Monitor Agent identifies the PAS as non-responsive.

The default is 30.

defaults.timesince start

Any positive integer Specifies the time, in minutes, Monitor Agent waits to start a PAS after being non-responsive.


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.gdi Any positive integer Specifies the number of GDI objects a PAS can have open before Monitor Agent considers it a memory leak.




Defaults (continued)

defaults.handles Any positive integer Specifies the number of handles a PAS can have open before Monitor Agent considers it a memory leak.


defaults.time Any time based on a 24-hour schedule

Specifies the time of day, based 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.

defaults.day EVERYDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Specifies the day Monitor Agent monitors the event identified in the Processes group.

The default is EVERYDAY.

defaults. dumpdirectory

Any valid directory Specifies the directory Monitor Agent watches for dumps.

The default is $(IMAGENOWDIR6)\bin

defaults.max attempts

Any positive integer Specifies the maximum number of times Monitor Agent attempts to restart the PAS before identifying it as failed.

The default is 3.

defaults.toemail address

Any valid e-mail address

Specifies the e-mail address to which Monitor Agent sends communications.

defaults.fromemail address

Any valid e-mail address

Specifies the e-mail address from which Monitor Agent sends communications.

defaults.program Any valid path and program

Specifies the full path of the program Monitor Agent runs in response to an event.

defaults.command arguments

Any valid command line prompt

Specifies one or more command line arguments Monitor Agent sends to the program identified in defaults.program.

defaults.archivefile type

Any file extension Specifies the file types Monitor Agent archives.

The default is .log.



Defaults (continued)

defaults.archive whichfiles

AllLogs

AllBeforeToday

Specifies which files Monitor Agent archives based on creation date.

AllLogs = All logs recorded.

AllBeforeToday = All logs recorded before the current date.

The default is AllBeforeToday.

defaults.archivesearch subdirectories

TRUE

FALSE

Specifies whether Monitor Agent searches all sub-directories for more files to archive.

TRUE = Monitor Agent searches all sub-directories.

FALSE = Monitor Agent does not search sub-directories.


defaults.archive directory

Any valid directory Specifies the directory Monitor Agent uses to store logs.

The default is $(IMAGENOWDIR6)\bin

defaults. ignorerequeststrings

TRUE

FALSE

Specifies whether to allow actions and events to run on processes 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 or server name of an SMTP server.

Specifies the SMTP server Monitor Agent uses for e-mail.

There is no default value.

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

The default is 25.

Ignore ignore. allnonwatched processes

TRUE

FALSE

Specifies whether Monitor Agent ignores processes that do not have events and actions set up.


Defines [defined_process] Any unique string Specifies the unique name for each process Monitor Agent monitors, for example:

AlarmAgent = inserverAlarm.exe



Profiles profile[n].event[n] For Windows:

TimeSinceStarted

NonResponsive

MemoryLeak

ThreadLeak

GDILeak

HandleLeak

AbnormalTermination

TimeOfDay

DumpWatch

For Unix:

AbnormalTermination

TimeOfDay

DumpWatch

Specifies unique profiles that Monitor Agent uses to perform specific actions in response to events. Profiles are a simplified approach to perform the same actions across multiple processes.

For example:

profile1.event1 = AbnormalTermination

profile[n].event[n]. action[n]

RestartProcess

EmailAlert

RunProgram

Archive

When used in conjunction with profile[n].event[n], these settings specify the action to perform if the specified event occurs.

For example:

profile1.event1.action1 = RestartProcess

profile1.event1.action1.failedaction1 =

EmailAlert

profile[n].event[n]. action[n]. failedaction[n]

profile[n].event[n]. action[n].[setting_ name]

MaxAttempts

ToEmailAddress

FromEmailAddress

Program

CommandArguments

ArchiveWhichFiles

ArchiveDirectory

ArchiveFileType

ArchiveSearch-SubDirectories

When used in conjunction with profile[n].event[n], these settings specify the setting name and value related to the action.

For example:

profile1.event1.action1.ToEmailAddress = [email protected]

Refer to [process].event[n].action[n].[setting] for descriptions of the options.

profile[n].event[n]. action[n]. failedaction[n]. [setting_name]



Profiles

(continued)

[process].event[n] For Windows:

TimeSinceStarted

NonResponsive

MemoryLeak

ThreadLeak

GDILeak

HandleLeak

AbnormalTermination

TimeOfDay

DumpWatch

For Unix:

AbnormalTermination

TimeOfDay

DumpWatch

Specifies the program or server Monitor Agent monitors for specific events.

Each event for each process must include a unique positive integer, for example event1, event2, and so on.

You can assign a profile to a process, for example:

AlarmAgent = profile1

TimeSinceStarted = Time since the PAS started.

NonResponsive = Excessive CPU usage over period of time.

MemoryLeak = When PAS is determined to be using more memory than the threshold value.

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.



Processes (continued)

[process].event[n]. [setting]

Time

CpuUsage

NonResponsiveTime

Memory

Threads

GDI

Handles

Time

Day

Specifies settings for each event that override the threshold values specified in the Defaults group, or specifies more information for each event to use.

These settings are optional.

Event: TimeSinceStarted

Time = Time in minutes since the PAS was started.

Event: NonResponsive

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.




[process].event[n] action[n]

RestartProcess

EmailAlert

RunProgram

Archive

Specifies the action Monitor Agent performs when each specific event occurs. Each action for each event must include a unique positive integer, for example action1, 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.




[process].event[n]. action[n].[setting]

MaxAttempts

ToEmailAddress

FromEmailAddress

Program

CommandArguments

ArchiveWhichFiles

ArchiveDirectory

ArchiveFileType


Specifies the setting name and value related to the actions you specified for [process].event[n].action[n] and overrides the global default values or specifies more information for each action to use.

For example:

profile1.event1.action1.ToEmailAddress = [email protected]

These settings are optional.

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.

[process].event[n]. action[n]. failedaction[n]

RestartProcess

EmailAlert

RunProgram

Archive

Specifies an alternate action Monitor Agent performs if action[n] fails.

Refer to [process].event[n].action[n] for descriptions of the options.




[process].event[n]. action[n]. failedaction[n]. [setting]

MaxAttempts

ToEmailAddress

FromEmailAddress

Program

CommandArguments

ArchiveWhichFiles

ArchiveDirectory

ArchiveFileType


Specifies settings for failedaction[n].

Refer to [process].event[n].action[n].[setting] for option descriptions.


inserverMQ.in i 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.


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. queue

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



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.


The default is 0.


Network local.hostname. useoverride

TRUE FALSE

Specifies how Messaging Queuing Agent identifies itself to remote agents wanting to connect to the services it offers. FALSE = Message Queuing Agent uses the name of the local computer as defined by your operating system.

TRUE = Message Queuing Agent uses the name set in the local.hostname.override setting.


local.hostname.override Text strings Specifies the host name of the local computer to use when local.hostname.useoverride is set to TRUE. The default is empty.

ip.bind.address Any valid IP address Specifies the IP address that the Message Queuing Agent listener socket will bind to. DEFAULT = ImageNow Server determines its own IP address.




Network

(continued) ip.bind.port Any valid port Specifies the port on which Message

Queuing Agent will listen for incoming connections. The default is 7200.

<instance name>. ip.bind.port

Any valid port Specifies individual port values for specific instance names by placing the instance name before the IP and bind fields. An instance setting takes precedence over the global setting. The default is 7200.


inserverNot i f icat ion. in i The following table provides definitions and sample data for the settings in the inserverNotification.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.


General refresh.settings.interval. minutes

Any positive integer Specifies how often, in minutes, Notification Agent waits between updates.

The default is 60.

Workers num.workers Any positive integer Specifies the number of worker threads used to perform background processing.

The default is 1.

Email smtp.server Any valid IP address or server name of an SMTP server

Specifies the SMTP server Notification Agent uses for e-mail notifications.

The default is localhost.

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

The default is 25.

smtp.from Any e-mail address Specifies the e-mail address to use as the “from” e-mail address in notification e-mails sent with this agent.

Note A reply e-mail address is required.



Logging debug.level.file 0 through 6 Specifies the level Notification Agent uses to log errors for troubleshooting.


0 = Logging is off.


The default is 0.


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


General num.transfer.workers Any positive integer Specifies the number of worker threads for transfer job processing.

The default is 1.

num.osm.replication. workers

Any positive integer Specifies the number of worker threads to process OSM cache replication jobs (asynchronous cache writes).

The default is 2.

max.osm.replication. retries

Any positive integer Specifies the total number of allowed attempts to replicate a cached item to the primary device.

The default is 3.

num.osm.background. workers

Any positive integer Specifies the number of worker threads to use to process background OSM tasks such as cleaning up deleted OSM objects.

The default is 5.

osm.cleanup.interval. seconds

Any positive integer Specifies the time, in seconds, to wait between performing object cleanups on OSM trees.

The default is 30.

max.osm.concurrent. leases

Any positive integer Specifies the maximum number of OSM background-work items allowed in memory at one time. This is initially set to a low value to balance the workload between multiple OSM agents, but it can be increased for higher throughput.

The default is 1.



General

(continued)

remove.old.service 1

0

Specifies whether ImageNow Server removes old services.

0 = ImageNow Server removes services.

1 = ImageNow Server does not remove services.

The default is 0.

Logging debug.level.file 0 through 6 Specifies the level OSM Agent uses to log errors for troubleshooting.


0 = Logging is off.


The default is 0.

Network local.hostname. useoverride

TRUE FALSE

Specifies how OSM Agent identifies itself to remote agents wanting to connect to the services it offers.

FALSE = OSM Agent uses the name of the local computer as defined by your operating system.

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


local.hostname.override Text strings Specifies the host name of the local computer to use when local.hostname.useoverride is set to TRUE.

The default is empty.

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

The default is 800.



Network

(continued)

num.connection.workers Any positive integer Specifies the number of worker threads in the connection pool.

The default is 2.

num.active.monitor. threads

Any positive integer Specifies the number of worker threads in the active socket monitor.

The default is 1.

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

The default is 30.

ip.port Any available port Specifies the port OSM agent uses for incoming connections.


Note

You can set individual values for specific instance names by placing the instance name between the ip and port fields. An instance setting takes precedence over the global setting.

For example,

ip.Primary.port=7202

ip.Secondary.port=17202

ip.<instance name>.port Any valid instance name for an anctive/active node

Specifies the individual values that can be set for specific instance names. This allows multiple instances of the server or agent to be started from the same EXE and INI file.

Place the instance name between the ip and port fields.

For example,

ip.Primary.port=7202

ip.Secondary.port=17202

Note When present, the instance setting takes precedence over the global setting.



Network

(continued)

ip.address Any valid IP address or DEFAULT

Specifies the IP address of OSM Agent.

DEFAULT = OSM Agent selects an available IP address.


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

heartbeat.timeout Any positive integer greater than 60

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



inserverRetent ion. in i The following table provides definitions and sample data for the settings in the inserverRetention.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.


General default.minimum.delay n/a This setting currently is not supported.

num.workers Any positive integer Specifies the number of worker threads used to perform background processing.

The default is 1.

num.policy.apply.workers Any positive integer Specifies the number of worker threads Retention Agent uses to perform policy application work.

work.timeout.seconds Any positive integer from 30 to 10000

Specifies, for active-active installations, the amount of seconds the retention agent may use to process a task before a second agent takes the task.

The default is180.

remove.old.service 1 or 0 Allows you to remove old services when you upgrade your system.

0 = Off

1 = On

The default is 0.

Event Hold delay.between.work 60 – 86400 Specifies, in seconds, how often Retention Agent waits between searches for modified items.

The default is 600.



max.items.to.route 1 – 50000 Specifies the maximum number of modified items the Retention Agent can route out of the hold queue at one time.

The default is 200.

Assign group.size Any positive integer Specifies the number of items this agent assigns to a policy at one time.

The default is 100.

Remove group.size Any positive integer Specifies the number of items this agent removes from a policy at one time when a document type is removed.

The default is 100.

Deletion delete.accession.sets. hours

Any positive integer Specifies, in hours, the time this agent waits to delete accession sets.

The default is 168.

Deletion

(continued)

delete.hold.sets.hours Any positive integer Specifies, in hours, the time this agent waits to delete hold sets.

The default is 168.

delete.offline.transfer. sets.hours

Any positive integer Specifies, in hours, the time this agent waits to delete offline transfer sets.

The default is 168.

delete.destruction.sets. hours

Any positive integer Specifies, in hours, the time this agent waits to delete destruction sets.

The default is 168.

delete.offline.move.sets. hours

Any positive integer Specifies, in hours, the time this agent waits to delete offline move sets.

The default is 168.

delete.offline.copy.sets. hours

Any positive integer Specifies, in hours, the time this agent waits to delete offline copy sets.

The default is 168.



Notification notify.frequency Daily, Weekly, Monthly, Yearly

Specifies the frequency with which this agent batches and sends email notifications for policies.

Daily = The agent sends email notifications once per day.

Weekly = The agent sends notifications one day per week.

Monthly = The agent sends email notifications one day per month.

Yearly = The agent sends email notifications one day per year.

The default is Weekly.

notify.weekly.day Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday

Specifies the day of each week this agent batches and sends notifications.

This setting is applicable only when you enter Weekly for the notify.frequency setting.

The default is weekly.

Notification

(continued)

notify.monthly.day 1 through 31 and Last

Specifies the day of the month this agent batches and sends notifications.

This setting is applicable only when you enter Monthly for the notify.frequency setting.

The default is 1.

notify.yearly.month Any valid month Specifies the name of the month this agent batches and sends notifications.

This setting is applicable only when you enter Yearly for the notify.frequency setting.

The default is January.

notify.yearly.day 1 through 31 and Last

Specifies the day of the month this agent batches and sends notifications.

This setting is applicable only when you enter Yearly for the notify.frequency setting.

The default is 1.



PolicyApplyScheduling

PolicyApplyScheduling

(continued)

policy.apply. schedule.mode

TRUE

FALSE

Specifies if policy scheduling is on or off. This allows an administrator to set the Retention Agent to run jobs during certain hours of the day, at a specified interval using the settings below.

TRUE policy scheduling is on.

FALSE policy scheduling is off.


policy.apply. schedule.start

0 through 23 Specifies, in hours, when Retention Agent can start removing items associated with destruction retention policies.

The default is 22.

Note: The policy.apply.schedule.mode setting must be set to TRUE for this setting to work.

policy.apply. schedule.duration

1 through 24 Specifies, in hours, the amount of time Retention Agent can take to remove items associated with destruction retention policies.

The default is 8.

Note: The policy.apply.schedule.mode setting must be set to TRUE for this setting to work.

policy.apply. schedule.delay

1 through 84600 Specifies, in seconds, how often Retention Agent waits to start removing items associated with destruction retention policies.

The default is 1.



Logging debug.level.file 0 through 6 Specifies the level Retention Agent uses to log errors for troubleshooting.


0 = Logging is off.


The default is 0.


inserverTask. in i 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.


General refresh.settings.interval. minutes

Any positive integer Specifies, in minutes, the time this agent waits to refresh all of the settings in this file.

The default is 60.

Deletion delete.tasks.assigned. days

Any positive integer Specifies, in days, the age of 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. days

Any positive integer Specifies, in days, the age of 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.


The default is -1.



Deletion (continued)

delete.tasks.complete. pending.review.days

Any positive integer Specifies, in days, the age of complete pending 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.


The default is -1.

delete.tasks.complete. days

Any positive integer Specifies, in days, the age of 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 default is -1.

delete.tasks.cancelled. days

Any positive integer Specifies, in days, the age of cancelled 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 default is -1.



Deletion (continued)

delete.tasks.invalid. days

Any positive integer Specifies, in days, the age of 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 default is -1.

delete.tasks.job. interval.minutes

Any positive integer Specifies, in minutes, how long 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.

Logging debug.level.file 0 through 6 Specifies the level Task Agent uses to log errors for troubleshooting.


0 = Logging is off.


The default is 0.


inserverWorkf low.in i 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.


General num.workers Any positive integer Specifies the number of worker threads used to perform background processing.

The default is 5.

refresh.queue. interval.seconds

Any positive integer Specifies how often, in seconds, Workflow Agent refreshes queue information, such as inbound and within queue actions, route recall, and archival settings.

The default is 600.

refresh.queue. attendee.interval. minutes

Any positive integer Specifies how often, in minutes, Workflow Agent waits between updates to the attendee count for all queues.

The default is 10.

num.crossnode.cache. workers

Any positive integer Specifies the number of worker threads Workflow Agent dedicates to cross-node cache synchronization.

The default is 2.

Workload

retention.schedule.mode Off, Expensive, All Places a time restriction, in hours, when the agent can process retention policy work.

Notes This setting does not affect workflow processing.

The retention.removal.schedule setting is ignored when this setting is enabled.

Off = Retention processing runs all of the time.

Expensive = The agent processes aging, policy events, and deletion only during specified hours.

All = The agent runs retention policy work only during specified hours.

The default is off.



Workload

(continued)

retention.schedule.start 4 through 24 Specifies, in hours, the amount of time the agent can take to process retention policies.

Note The system does not recognize minute or second formatting.

The default is 4.

retention.removal. schedule.mode

Off, on, weekends, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday

This setting places a time restriction on when Workflow agent can remove items associated with destruction retention policies.

Off = Workflow agent runs all of the time.

On = Workflow agent runs only during specified time schedules.

Weekends = Workflow agent runs only during specified times on the weekend.

Monday – Sunday = Workflow agent runs only during specified times on that day.

The default is off.

retention.event.polling. delay.seconds

Any positive integer Specifies how often, in seconds, Workflow Agent waits before performing retention event queue work.

The default is 120 seconds (2 minutes).

retention.event.polling.size Any positive integer The maximum number of retention event queue work that Workflow Agent can process at one time.

The default maximum number of retention event queue work that can be processed at one time is 2000.

retention.aging.polling. delay.seconds

Any positive integer Specifies how often, in seconds, Workflow Agent waits before performing retention aging queue work.

The default is 3600 seconds (1 hour).

retention.aging.polling.size Any positive integer The maximum number of retention aging queue events that Workflow Agent can process at one time.

The default maximum number of retention aging queue events that can be processed at one time is 2000.



Workload

(continued)

retention.delete.polling. delay.seconds

Any positive integer Specifies how often, in seconds, Workflow Agent waits before performing retention delete queue work.

The default is 120 seconds (2 minutes).

retention.delete.polling.size Any positive integer The maximum number of retention delete queue events that Workflow Agent can process at one time.

The default maximum number of retention delete queue events that can be processed at one time is 2000.

retention.general.polling. delay.seconds

Any positive integer Specifies how often, in seconds, Workflow Agent waits before performing retention general queue work.

The default is 30 seconds.

retention.general. polling.size

Any positive integer The maximum number of retention general queue events that Workflow Agent can process at one time.

The default maximum number of retention general queue events that can be processed at one time is 2000.

retention.removal. schedule.mode

Off, on, weekends, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday

This setting places a time restriction on when Workflow agent can remove documents associated with destruction retention policies or removal methods in workflow queues.

Off =Workflow agent runs all of the time.

On = Workflow agent runs only during specified time schedules.

Weekends =Workflow agent runs only during specified times on the weekend.

Monday – Sunday = Workflow agent runs only during specified times on that day.

The default is off.

retention.removal. schedule.start

0 through 23 Specifies the hour formatting on a 24-hour clock. Note The system does not recognize minute or second formatting.

The default is 0.



Workload

(continued)

retention.removal. schedule.duration

1 through 24 Specifies, in hours, the amount of time Workflow agent can take to remove documents associated with destruction retention policies or removal methods in workflow queues.

The default is 0.

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.


The default is 0.


Cl ien t conf igura t ion tab les

ImageNow.in i The following table provides definitions and sample data for the most commonly used settings in the ImageNow.ini configuration file, version 6.7. 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.



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 FALSE

Specifies whether ImageNow saves logon credentials.

Default Any profile under [Logon Profiles]

Specifies the default login profile.



User Preferences CopyDlg.Default FocusPoint

0,1,2 Specifies the default focus point 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. SkipCustProps OnTab

TRUE FALSE Specifies whether Custom Properties is included in the tab order in the Insert Document and Copy Document dialog boxes.


CopyDlg. Disable. SelectedRegion

TRUE FALSE Specifies whether the Selected region option is disabled on the Copy Document dialog box.


CopyDlg. Disable. CurrentPage

TRUE FALSE Specifies whether the Current page option is disabled on the Copy Document dialog box.


CopyDlg. Disable.AllOpen Pages

TRUE FALSE Specifies whether the All open pages option is disabled on the Copy Document dialog box.


CopyDlg. Disable. AllPages

TRUE FALSE Specifies whether the All pages option is disabled on the Copy Document dialog box.


CopyDlg. Disable.Page Range

TRUE FALSE Specifies whether the Page range option is disabled on the Copy Document dialog box.


CopyDlg. Disable.Remove PagesFromDoc

TRUE FALSE Specifies whether the Remove selected pages from current documentation checkbox is disabled on the Copy Document dialog box.




User Preferences (continued)

CopyDlg. Disable.Use DefaultValues

TRUE FALSE Specifies whether the Use default values checkbox is disabled on the Copy Document dialog box.


CopyDlg. Disable. SubmitTo ContentServer

TRUE FALSE Specifies whether the Submit to content server checkbox is disabled on the Copy Document dialog box.


CopyDlg. Disable.SendTo WFQueue

TRUE FALSE Specifies whether the Send to Workflow queue check box is disabled on the Copy Document dialog box.


CopyDlg. Disable.AddTo Proj

TRUE FALSE Specifies whether the Add to project check box is disabled on the Copy Document dialog box.


CopyDlg. Disable.AddNew DocToVC

TRUE FALSE Specifies whether the Add new document to version control check box is disabled on the Copy Document dialog box.


AcquireToken DuringScan

1, 0 Enables ImageNow to acquire 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.

ThumbHeight Any positive integer Specifies, in pixels, the height of document thumbnails.

WF Settings LastAddProcess Any valid workflow process

Specifies the process name that was used last when adding a document to workflow.

The default is blank.



WF Settings

(continued)

LastAdd WFQueue

Any valid workflow queue

Specifies the queue name that was used last when adding a document to workflow.


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 FromGrid

0, 1, 2 Specifies the default behavior 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.

AutoFetch NextItem

0, 1 Specifies whether workflow automatically fetches the next 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.



Workflow (continued)

WhenGetNext Item

0, 1, 2 Specifies the action workflow 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 OrClose

0, 1, 2 Specifies the action workflow performs on an item when the user closes or saves it from the viewer.




The default is 1.

SaveChanged Keys

0, 1, 2 Specifies the action workflow performs on an item when the user changes the document keys.




The default is 2.

AutoRefresh Timer

-1 or any positive integer greater than or equal to10

Specifies how long, in seconds, workflow refreshes the explorer grid.

If set to -1, workflow uses the minimum number of seconds, which is 10.

The default is -1.



Workflow (continued)

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.

WF Designer WFQueueAlarm Columns

n,n,n,n

where n = 1 or 0

Specifies which columns are visible in the Queue Properties dialog box in the Alarms 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 Auto

0, 1 Specifies whether workflow 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 Preferences

Hyperlearn CaptureDelay

n If HyperlearnBringAppForward=TRUE, 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.

Hyperlearn Disable ServerFonts

0, 1 Specifies whether Hyperlearn disables fonts from the server and instead uses client fonts 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 ConvertColors

n; n; n; n; … Specifies a string of color code 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 KeyOffset

x,y This setting specifies the shift in 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.



Learn Preferences (continued)

Hyperlearn Debug

0, 1, 2 Specifies whether debugging is enabled for Hyperlearn.

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 OutlineColor

RGB(n,n,n) Specifies the line color used for the rectangles in LearnMode Designer, Hyperlearn, or Viewpoint screens.

The default is RGB(0, 0, 0), which is black.

TextBackground Color

RGB(n,n,n) Specifies the color used for 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 Background Color

RGB(n,n,n) Specifies the highlight color for table rows when editing an Internet Explorer application plan.

The default is RGB(192,192,192), which is 25% grey.

MinimizeOn DictionaryTest

0, 1 Specifies whether the 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.

UseIEShell Search

TRUE

FALSE

Specifies whether ImageNow uses the Internet Explorer shell to locate the Internet Explorer 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.

HyperlearnDisable RemoveFocus

0, 1 Removes the focus from a business application before taking a screen capture, which prevents displaying insertion bars (cursors) in a field that is used for a document key value.

0 = False

1 = True

The default is 0.

HyperlearnBringApp Forward

0, 1 Note This setting is necessary for business applications that do not support WM_PRINT Windows API.

Prior to ImageNow 6.3, to capture a bitmap of the business application, the business application had to be in focus. In ImageNow 6.3, the business application no longer needed to be in focus before capturing a bitmap. Use this setting to revert to the previous method for capturing a bitmap.

0 = False

1 = True

The default is 0.

DisableFontSmoothing 0, 1 Before capturing a bitmap of the business application, the system disables ClearType font rendering and then enables it again once the bitmap is captured. Use this setting to stop the system from disabling ClearType font rendering.

0 = False

1 = True

The default is 0.




BatchOnlyRemember Keys

0, 1 Use this setting if you want the system to copy document key values, such as drawer and field1, from the previously linked document into the corresponding boxes of the next document you link, in batch mode only.

0 = False

1 = True

The default is 0.

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.


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.


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.


Document Valid document When DefaultDocument is set to 0, this setting specifies the default document that opens when the user clicks Documents on the ImageNow toolbar.


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.


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.




Button Actions (continued)

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


2 = No action

The default is 1.

Default Document

0, 1, 2 Specifies the default action when the user clicks Documents on the ImageNow toolbar.

0 = Document defined in Document setting


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


2 = No action

The default is 1.



Button Actions (continued)

DefaultTask 0, 1, 2 Specifies the default action when the user clicks Tasks on the ImageNow toolbar.

0 = Task defined in Task setting


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


2 = No action

The default is 1.

PowerVu MaxOpenPages Enabled

1, 0 Specifies whether ImageNow 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 Color

RGB(n,n,n) Optional. Specifies the Content Search highlight color in 24-bit RGB representation.

Thumbnails RetainFocus

TRUE

FALSE

Specifies whether the thumbnail pane retains focus when the user opens a document from the thumbnail pane in ImageNow or WebNow Viewer.




PowerVu

(continued)

LoadLastPage 0, 1 This optional setting determines whether the first or last page of a document appears when opened in ImageNow Viewer.

0 = first page

1 = last page

The default is 0.

document.viewer. title

Any string followed by zero or more of the following macros:

%Drawer%

%Folder%

%Tab%

%F3%

%F4%

%F5%

%DocType%

All macros are case sensitive.

This optional setting changes the text in the Document Viewer title bar. The string can contain any literal text followed by macro replacement macros shown. The % delimiters are required.

The string in the settings file is the base string, and the code appends the following string based on viewer status:

Associated project information

Workflow mode

Version number (if in version control)

Checked out

The default is: document.viewer.title=Document - %DocType%

project.viewer.title Any string followed by zero or more of the following macros:

%ProjType%

%ProjName%

All macros are case sensitive.

This optional setting changes the text in the Project Viewer title bar. The string in the settings file is the base string, and the code appends the following string based on viewer status:

Workflow mode

The default is: project.viewer.title=Project - %ProjType% - %ProjName%

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.



Batch Options (continued)

ConfirmLink Discard

0, 1 Specifies whether ImageNow displays a confirmation message 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 BetweenLinks

0, 1 Specifies whether ImageNow 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 SizeEqPages

0, 1 Specifies whether to set the document keys for all pages in a batch to be the same.

0 = No

1 = Yes

LastBatchApplet Any valid application plan

Specifies the name of the last application plan used.

BatchUpload Delay

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



Logging debug.level.file 0, 1 – 6 Specifies the level ImageNow uses to log errors for troubleshooting.


0 = Logging is off.


The default is 0.

General logon. singlesignon. enable

TRUE

FALSE

Specifies whether the user can sign in once when using multiple 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


scroll.login. image

1, 0 Specifies whether the scrolling clouds on the ImageNow login screen are enabled.

0 = disabled

1 = enabled

Locale LangID 1031 1033 1034 1036

Specifies the language ImageNow uses.

1033 = English

1036 = French

1031 = German

1034 = Spanish

Remote heartbeat.interval Any positive integer Specifies how often, in seconds, Import Agent verifies its connection to ImageNow Server. The default is 60.



Remote

(continued)

socket.login.timeout Any positive integer Specifies how many seconds Import Agent waits for successful login before terminating the connection.

The default is 60.


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.


Tasks 0, 1, 2, 3, 4 Specifies the start up 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 Action

0, 1, 2 The TaskStartupAction setting specifies the type of task ImageNow opens.

0 = Document deficiency

1 = Pointer

2 = Signature required

The default is 0.



Tasks (continued)

TaskStartup Type

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.

NextTaskAction 0, 1, 2 The NextTaskAction setting 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.

NextTaskType TRUE

FALSE

Specifies whether ImageNow opens the next task in explorer when a task is complete.


AutoLaunchNext Task

TRUE

FALSE

Specifies whether ImageNow open the next task for the current document or project.


ProcessAllTasks ForCurrent

string ID Specifies the last used digital signature task template ID when creating new digital signature task.

LastDigSig Template

string ID Specifies the last used document deficiency task template ID when creating new document deficiency task.

LastDocDef Template

string ID Specifies the last used pointer task template ID when creating pointer task.

LastPointer Template

string ID Specifies the last used pointer task template ID when creating pointer task.


Append ix D: IMAGENOWLOCALDIR6 and IMAGENOWDIR6 env i ronment var iab les

The IMAGENOWLOCALDIR6 environment variable is a new variable that holds the absolute file path to ImageNow Server resources in the inserver6 directory on a local machine. This is required for any ImageNow Server environment. The IMAGENOWDIR6 variable holds the absolute file path to the ImageNow Server resources in the inserver6 directory on a shared device. It is only required if running an active-active server environment.

IMAGENOWLOCALDIR6 environment var iable This environment variable is required and specifies the location of the following folders. These folders cannot be shared among the different instances of ImageNow Server.

• bin

• bin64

• fulltext

• temp

• log (default)

• ODBC

Note The log directory is included in this location by default, but it may be moved to the shared location.

IMAGENOWDIR6 environment var iable The IMAGENOWDIR6 environment variable is only required in an active-active environment. Some of the ImageNow Server resources must be moved to a shared file system, so they can be accessed by all of the different machines in an active-active environment. On Windows, this needs to be a NTFS file share accessible by UNC path. On Linux, the shared file system needs to be mounted locally and accessed like any other local directory. The path to that share is saved in the IMAGENOWDIR6 variable. If this environment variable is not present, its value is defaulted to the value of IMAGENOWLOCALDIR6. The environment variable is pulled on server startup from the environment.ini file located in the inserver6 directory on the local machine.

IMAGENOWDIR6 should specify the location of the following folders:

• envoy

• etc

• form

• job

• learnmode

• osm

• script

• workflow


I ndex

Customer Portal ................................................. 5

ImageNow.ini ................................................. 118

inow.ini ............................................................. 32

inserver.ini ........................................................ 54

inserverAlarm.ini ............................................... 63

inserverBatch.ini............................................... 64

inserverEM.ini ................................................... 67

inserverFS.ini .................................................... 70

inserverImp.ini .................................................. 71

inserverJob.ini .................................................. 86

inserverMonitor.ini ............................................ 88

inserverNotification.ini ................................... 101

inserverOSM.ini ............................................. 103

inserverRetention.ini ...................................... 107

inserverTask.ini .............................................. 111

inserverWorkflow.ini....................................... 114

Installing ImageNow

ImageNow Client unattended ...................... 22

SQL Server Management Studio ................... 8, 9

starting all ImageNow services ........................ 30

SunflowerSS.sql ............................................ 8, 9
