Workflow Solutions
InfoImage
Registry Reference Manual
UNISYS
© 2003 Unisys Corporation.
All rights reserved.
September 2003
Printed in USA
4334 7798–006
NO WARRANTIES OF ANY NATURE ARE EXTENDED BY THIS DOCUMENT. Any product or related
information described herein is only furnished pursuant and subject to the terms and conditions of a duly
executed agreement to purchase or lease equipment or to license software. The only warranties made by
Unisys, if any, with respect to the products described in this document are set forth in such agreement.
Unisys cannot accept any financial or other responsibility that may be the result of your use of the
information in this document or software material, including direct, special, or consequential damages.
You should be very careful to ensure that the use of this information and/or software material complies
with the laws, rules, and regulations of the jurisdictions with respect to which it is used.
The information contained herein is subject to change without notice. Revisions may be issued to advise
of such changes and/or additions.
Notice to U.S. Government End Users: This is commercial computer software or hardware
documentation developed at private expense. Use, reproduction, or disclosure by the Government is
subject to the terms of Unisys standard commercial license for the products, and where applicable, the
restricted/limited rights provisions of the contract data rights clauses.
Correspondence regarding this publication can be e-mailed to doc@unisys.com.
Unisys is a registered trademark of Unisys Corporation in the United States and other countries.
All other brands and products referenced in this document are acknowledged to be the trademarks or
registered trademarks of their respective holders.
Contents
Section 1.
Overview
Purpose ......................................................................................... 1–1
Audience........................................................................................ 1–1
Prerequisites .................................................................................. 1–1
Technical Support........................................................................... 1–2
Using This Reference ..................................................................... 1–2
Editing Registry Entries................................................................... 1–2
Section 2.
Archive Manager
ARCHIVE........................................................................................ 2–1
ARCHIVE UNITS........................................................................... 2–11
<Archive Unit Name>................................................................... 2–12
<Archive Unit Name> OPTICAL DRIVES ....................................... 2–12
COMMON.................................................................................... 2–13
LOCATOR .................................................................................... 2–14
Network Communication Keys...................................................... 2–16
ODA DRIVES................................................................................ 2–17
ODBCSETUP................................................................................ 2–18
PLATTER LABELS ........................................................................ 2–19
SCHEDULER................................................................................ 2–19
System Control............................................................................. 2–20
Section 3.
Central Administration Console
CAC (Server) .................................................................................. 3–1
CAC (Client).................................................................................... 3–4
CAC (Client).................................................................................... 3–5
NETSETUP..................................................................................... 3–5
4334 7798–006
iii
Contents
Section 4.
Client API and Other Integration Components
Client API .......................................................................................4–2
App Paths\<application filename>..........................................4–2
COMMON.............................................................................4–3
DocWindow ..........................................................................4–4
Network Communication Keys...............................................4–4
OBJECT ................................................................................4–5
OMDAPI ...............................................................................4–6
OMDAPI_LOG.......................................................................4–7
System Control......................................................................4–7
Connector for Siebel .......................................................................4–7
IAS........................................................................................4–8
ActiveXDocViewer.................................................................4–9
Section 5.
Client Work Manager
WorkManager.................................................................................5–1
FormViewer....................................................................................5–3
UeWIDocumentViewer...................................................................5–4
UeWIDocumentViewer\DocViewer ........................................5–4
UeWIDocumentViewer\NoteEditor.........................................5–5
Section 6.
Enterprise Indexing
ENTERPRISE_INDEXING ................................................................6–1
ENTERPRISE..................................................................................6–2
Section 7.
Fax Manager
COMMON......................................................................................7–1
FAX................................................................................................7–2
FAXINDEX......................................................................................7–6
FAXIN_LOG...........................................................................7–7
FAXOUT_LOG.......................................................................7–7
Network Communication Keys........................................................7–8
OBJECT .........................................................................................7–8
System Control...............................................................................7–9
TEXT TO TIFF .................................................................................7–9
iv
4334 7798–006
Contents
Section 8.
Workflow Domain Subsystem
<Workflow Domain Subsystem> .................................................... 8–1
ALIASES ........................................................................................ 8–2
COMMON...................................................................................... 8–3
DBV ............................................................................................... 8–7
IIFCATUU....................................................................................... 8–7
INDEX............................................................................................ 8–8
INTERNAL.................................................................................... 8–10
LOCATOR .................................................................................... 8–12
Network Communication Keys...................................................... 8–13
NETCALL ............................................................................ 8–13
NETCONFIG........................................................................ 8–14
NETLISTEN ......................................................................... 8–14
NETMODULE...................................................................... 8–16
NETSETUP.......................................................................... 8–16
OBJECT ....................................................................................... 8–17
ODBCSETUP................................................................................ 8–22
OMDAPI ...................................................................................... 8–24
PROCESS NAME_LOG................................................................. 8–24
RNDZMGR................................................................................... 8–26
RPC ............................................................................................. 8–27
ROUTE......................................................................................... 8–27
RRMAIN....................................................................................... 8–33
Security........................................................................................ 8–33
System Control............................................................................. 8–34
TRANSFER................................................................................... 8–34
UpdateUtility ................................................................................ 8–41
Section 9.
Imaging High Volume Scanner
COMMON...................................................................................... 9–1
<Datasource Name> ...................................................................... 9–2
HSSDEL_LOG, HSSGEN_LOG, HSSREL_LOG,
HSSSCAN_LOG......................................................................... 9–3
HSSMAIN ...................................................................................... 9–3
INTERNAL...................................................................................... 9–4
Network Communication Keys........................................................ 9–4
OBJECT ......................................................................................... 9–5
ODBCSETUP.................................................................................. 9–5
SCANINI......................................................................................... 9–6
SCANNER ...................................................................................... 9–7
System Control............................................................................... 9–9
VIEWER ......................................................................................... 9–9
4334 7798–006
v
Contents
Section 10.
Print Manager
COMMON.................................................................................... 10–1
Network Communication Keys...................................................... 10–2
OBJECT ....................................................................................... 10–3
PRINT .......................................................................................... 10–3
System Control............................................................................. 10–7
TEXT TO TIFF ............................................................................... 10–7
Section 11.
Rapid Batch Entry and the Document Generator
COMMON.................................................................................... 11–1
Network Communication Keys...................................................... 11–2
RBE ............................................................................................. 11–3
RIO .............................................................................................. 11–4
System Control............................................................................. 11–6
Section 12.
Relational Catalog
LOCATOR .................................................................................... 12–1
System Control............................................................................. 12–1
Section 13.
Request Manager
ARCHIVES.................................................................................... 13–1
COMMON.................................................................................... 13–2
Network Communication Keys...................................................... 13–3
ODBCSETUP................................................................................ 13–5
REQMAN ..................................................................................... 13–5
System Control............................................................................. 13–8
VOLUME PRIORITY FACTORS ..................................................... 13–8
Section 14.
Robot Manager
<Your Custom Robot Name>........................................................ 14–1
GatherRobot................................................................................. 14–2
PrefetchRobot .............................................................................. 14–4
SiebelImportRobot........................................................................ 14–5
SysDeleteRobot ......................................................................... 14–11
XMLExportGatewayRobot........................................................... 14–12
vi
4334 7798–006
Contents
Section 15.
Scan Manager
BatchOutput................................................................................. 15–1
BatchOutput\CWM.............................................................. 15–2
BatchOutput\CWM\BatchInUeWI......................................... 15–2
BatchOutput\Email .............................................................. 15–3
BatchOutput\Exchange........................................................ 15–3
BatchOutput\JPEGSettings.................................................. 15–3
BatchOutput\Kernel............................................................. 15–4
BatchOutput\Kernel\Imports ................................................ 15–5
BatchOutput\RBE................................................................ 15–7
BatchViewer................................................................................. 15–7
ScanManager ............................................................................. 15–10
Shared ....................................................................................... 15–21
Custom Defaults and Overrides .................................................. 15–27
Enforcing Custom Defaults and Overrides.......................... 15–27
Defaults ............................................................................ 15–28
Overrides .......................................................................... 15–29
Custom Defaults and Overrides Values .............................. 15–30
Section 16.
Storage Manager
<Storage Manager Name> ........................................................... 16–1
COMMON.................................................................................... 16–2
LOCATOR .................................................................................... 16–4
Network Communication Keys...................................................... 16–4
NETCALL ............................................................................ 16–5
NETLISTEN ......................................................................... 16–6
NETMODULE...................................................................... 16–7
NETSETUP.......................................................................... 16–7
ODBCSETUP................................................................................ 16–8
STORAGE .................................................................................... 16–9
ARCVOLUMES........................................................................... 16–11
DOCFAMILIES ........................................................................... 16–12
DEFAULT .......................................................................... 16–13
Familyn ............................................................................. 16–13
Classn............................................................................... 16–14
4334 7798–006
vii
Contents
Appendix A. Initialization File for 16-bit Workstations
[ACDDE]........................................................................................ A–1
[BATCHPRINT] .............................................................................. A–1
[COMMON]................................................................................... A–2
[DesktopTools] .............................................................................. A–3
[Folder].......................................................................................... A–4
[FORMAP]....................................................................................A–14
[FormBuilder]................................................................................A–15
[FormInterpreter] ..........................................................................A–15
[INBOX]........................................................................................A–18
[INSTALL].....................................................................................A–19
[Markups].....................................................................................A–20
[NETCALL] ...................................................................................A–20
[NETMODULE] .............................................................................A–21
[NETSETUP] .................................................................................A–21
[ObjectSecurity]............................................................................A–22
[OCR] ...........................................................................................A–22
[Outbox] .......................................................................................A–23
[Page]...........................................................................................A–23
[Scan]...........................................................................................A–24
[System Admin Console]...............................................................A–26
[SystemError] ...............................................................................A–33
[TermHLLAPI]...............................................................................A–35
[Toolbar] .......................................................................................A–35
[WS/2]..........................................................................................A–36
viii
4334 7798–006
Section 1
Overview
This section provides a brief introduction to this manual, including its purpose
and recommended prerequisites, and a description of the manual’s
organization and how information is presented.
Purpose
This manual is a reference guide to the initialization and configuration settings
stored in the Windows registry for all the various software components of a
Unisys InfoImage system.
There are numerous key values maintained in the registry that are not
intended for editing. These values are used by and for the system, for
example, to maintain a record of the display settings of the most recent user.
Because you should not manually edit these registry entries, we do not
include them in this reference guide.
Audience
This document is intended for those responsible for configuring the InfoImage
system, such as system engineers and system administrators.
Prerequisites
Before modifying any registry key values, you should have a thorough
understanding of all the options and requirements. We recommend
completing the following prerequisite tasks:
•
Read the Technical Overview Guide.
•
Receive initial training from Unisys on how to use the system.
•
Be familiar with the Windows operating systems, LAN architecture, the
Windows environment, the DBMS, and the computer hardware used in
your organization’s implementation.
4334 7798–006
1–1
Overview
Technical Support
If you have questions regarding InfoImage registry keys or system
configuration in general, please consult your customer support representative.
Using This Reference
Each section of this manual provides registry keys for an InfoImage
component. Within each section, registry keys are organized according to
their hierarchical arrangement in the registry itself. Both the keys and the
value entries in a registry depend on the specific Workflow Domain
configuration. Your registry may not contain all of the possible entries.
Each subkey includes a table, such as the one that follows:
Registry Key Name
Value Entry
Name of the
Value Entry
Description
A description of the key’s
purpose or function in the
system.
Values
A list of valid values. Note the following
conventions:
•
Default values (set on installation)
appear in bold type.
•
DWORD values are decimal unless
otherwise noted as hexadecimal.
Editing Registry Entries
You can change many Windows Registry values using the properties dialogs
or other options dialogs provided with the product interfaces. Refer to the on
line help files for each product before changing values directly in the Windows
Registry.
For some Windows Registry values, you must use the Microsoft Registry
Editor to edit the keys and values.
Caution
Value entries entered incorrectly may prevent the software or Windows
from loading or functioning properly.
1–2
4334 7798–006
Overview
To edit a registry value
1. Click Run on the Start menu.
2. Type in REGEDIT, and then click OK. The Registry Editor starts.
3. Navigate to the appropriate subkey, and modify the values as necessary.
4334 7798–006
1–3
Overview
1–4
4334 7798–006
Section 2
Archive Manager
This section describes the registry keys used by the Archive Manager
software to modify system behavior. Unless otherwise noted, registry keys
for Archive Manager have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
Default values appear in bold type.
ARCHIVE
This subkey contains value entries for Archive Manager.
ARCHIVE Key
Description
Values
Specifies whether platters can be
removed when the Volume table is
not accessible.
Y
Permit platters to be
removed.
N
Do not permit platters to
be removed.
ARCHIVE DIR
The directory name and path for the
Archive data directory where all of
the files to be archived are stored.
Default ..\ARCDATA.
ARCHIVE RESTART
DELAY
Used only if RETRIEVAL SERVICE
LEVEL is set to FLIP ARCHIVE or
ALL ARCHIVE. It specifies the
minimum time (in seconds) that
retrieval servicing is idle before
archive processing is restarted.
Minimum 5
ARCHIVE SEQ
The number of A sides of platters to
be used for archiving before the B
sides are used.
Default 10
ARCHIVE STAT
Indicates whether the Archive
Manager will start up with archive
status Active or Inactive.
ON
Status active
OFF
Status inactive
ALLOW PLATTER
EJECTS
4334 7798–006
Maximum 120
Default 30
2–1
Archive Manager
ARCHIVE Key
Description
Values
BACKUP INC
The value by which the archive
platter is incremented in order to
deter mine the name of the backup
platter.
Default 2
BACKUP RESTART
DELAY
Used only if RETRIEVAL SERVICE
LEVEL is set to FLIP BACKUP or
ALL BACKUP. It specifies the
minimum time (in seconds) that
retrieval servicing is idle before
backup processing is restarted.
Minimum 5
Maximum 120
Default 30
This entry does not normally appear
in the registry. If a change from the
default is desired, the entry must be
added.
BUFFER CHAIN SIZE
The total number of application
buffers linked as a chain for SGT
(Scatter/Gather Transfer). Archive
Manager allocates several SGT
chains; each chain will have this
number of buffers for transferring
data to and from the optical disk.
The default and only value is
1.
BUFFER SIZE
The number of KB allocated in each
buffer link in an SGT chain; all links
in all chains will have this buffer
size.
Default
63
Maximum
Limited by the hardware
installed. The practical limit
is 1023.
Minimum
None, but setting the value
below the default will
negatively impact
performance.
2–2
CONSECUTIVE
ERRORS
Applies only to version 2.11 or
earlier platters. Sets the maximum
number of consecutive SCSI errors
after which archiving is turned off.
Default 3
CONTINUOUS CHECK
The number of buffers to be verified
before verification is disabled if
MODE=CONTINUOUS.
Default 1000000
4334 7798–006
Archive Manager
ARCHIVE Key
COUNTPAGES
Description
Enables page counting. If enabled,
the catalog record will be updated
to contain the page count of the
documents.
ERROR DIR
The directory name and path for
the Error Directory.
ERROR TEMPLOC
Enable this option to control
whether records rejected by the
catalog are placed in the catalog
error file TEMPLOC.ERR.
Values
A
Count all pages of the
static and variable
portions of the
document.
V
Count all pages of the
variable portions only.
N
Disable the page count.
Default ..\ERROR
Y
Records rejected by the
Catalog are placed in
TEMPLOC.ERR.
N
Records rejected by the
Catalog are not placed in
TEMPLOC.ERR.
This option enables/disables
Archive Manager event logging.
When enabled, an events log file,
EVENTS.TRA, is generated. The
maximum size of this file is
configured with the LOG SIZE
entry. When the EVENTS.TRA file
has reached the maximum size, it
is renamed to events.tr0 and a
new EVENTS.TRA file is
generated.
Y
Enable Archive Manager
event logging.
N
Do not enable Archive
Manager event logging.
Allows locator table to be updated
regardless of revision differences
while running the LSFIX utility. If
enabled, revision comparisons will
be ignored and the locator table will
be updated. The default is to only
update the table if the locator table
update is for a later version.
Y
Ignore revision
comparison and update
locator table.
N
Do not ignore revision
comparison.
Determines (every x minutes)
whether archiving is currently in
progress.
Minimum 1
Note:
ERROR TEMPLOC
should not be set to N in
production environments. It is
for testing use only.
EVENT LOG
FORCE_UPDATE
IDLE COUNT
4334 7798–006
Maximum none
Default
15
2–3
Archive Manager
ARCHIVE Key
Description
Values
Specifies the number of minutes
the catalog database can remain
inactive before Archive Manager
disconnects from the database
and the Catalog Status (displayed
in the Archive Manager window)
changes from Connected to Idle.
While the Catalog Status is Idle,
the database can be backed up
without having to shut down
Archive Manager.
Minimum 1
IGNORE HARDWARE
ERRORS ò
When enabled, allows a primary
platter with SCSI (hardware)
errors to be backed up. During the
backup, bad blocks on the primary
platter are ignored and the
corresponding blocks on the
backup platter are written with a
default pattern.
Y
Yes
N
No
IGNORE MEDIUM
ERROR ò
Indicates whether a backup to
optical platters should continue if
an error is encountered on the
primary platter.
Y
Ignore the error and
continue the backup.
N
Do not ignore error. Stop
backup.
IDLE TIME
Maximum 1440
Default
10
ò Note: Use the preceding two options only in exceptional cases and under controlled
conditions. Enable it (set the value to Y) only to backup a primary platter containing
hardware errors, then immediately reset the values to N upon completion of that backup. Do
not leave this option enabled at unattended Archive Controllers.
JB TIMEOUT
2–4
The software timeout interval (in
seconds) for jukebox operations. If
jukebox operations exceed this
interval, Archive Manager assumes
an error has occurred and the
operation (archive or retrieval from
archive) fails. Timeout errors may
indicate jukebox hardware
problems.
Minimum 10
Default
30
4334 7798–006
Archive Manager
ARCHIVE Key
LOG SIZE
Description
The maximum size (in KB) of the
events log file.
Values
Minimum 1
Maximum 100,000
Default
LS LOGIN RETRY
The number of seconds between
logon retry attempts to the catalog.
Minimum 10
Maximum None
Default
MEDIA ERR LIMIT
The maximum number of media
errors allowed per volume (side) of
a platter.
The limit is determined by the
software and varies depending on
the hardware.
1000
60
Calculate as a percentage:
Maximum = 100% of the
hardware maximum
Minimum = 10% of the
hardware maximum
Hardware limits for the optical
media/drive types are:
200 For 12” and 14” optical
media.
100
For 51/4” optical media.
When this limit is surpassed,
archive or backup processing is
discontinued on the current volume
and messages are logged. Under
normal conditions, it is not
expected that this limit would be
surpassed.
MAX BUFFER
CHAINS
The total number of SGT chains
allocated for archiving and backup
operations.
Minimum
3
Maximum
None
There is no maximum;
however, check the formula
for SCSI performance
enhancements. For more
information, see “Enhancing
Archive Manager
Performance Using Large
Buffers” in the Archive
Manager section of the
Installation and Configuration
Guide.
4334 7798–006
2–5
Archive Manager
ARCHIVE Key
Description
The maximum number of platters
with media errors that can be
skipped before archive and backup
processing is automatically shut
down. This entry does not normally
appear in the registry. If a change
from the default value is desired,
the entry must be added.
Minimum 1
MAX LOCINFO
BLOCKS
The maximum number of workitem
components for which catalog
information is cached, while
archiving, before being written to
the catalog.
Default 500
MEDIA ERR
WARNING
The value of this entry is a
percentage; the maximum being
100 per cent of the MEDIA ERR
LIMIT; the minimum is 10 percent,
or one-tenth of the MEDIA ERR
LIMIT. Each time this percentage is
reached, archive or backup
processing is stopped on the
current volume.
Default 10
MIN SPACE
Sets the minimum space (blocks)
required to have a valid archive
platter. When the available space is
less than or equal to this value, a
new platter will be needed.
Minimum 50
Enables the verification mode.
CONTINUOUS
MAX ERROR
PLATTERS
MODE
•
•
2–6
Values
“Continuous” mode
configures Archive Manager to
continually verify buffers
written to optical disk until n
number of buffers has been
verified, after which
verification is disabled.
Maximum 10
Default 2
The recommended value is
1024.
PERIODIC
This entry does not normally
appear in the registry. If a
change from the default is
desired, the entry must be
added to the registry.
”Periodic” mode configures
Archive Manager to verify
buffers written to optical disk
once every n number of
buffers (see also PERIODIC
CHECK, which sets n).
4334 7798–006
Archive Manager
ARCHIVE Key
Description
Values
The number of successive
failures before a Listen thread
terminates.
Minimum 1
The number of queues to be
allocated for the update thread's
record queue.
Minimum 2
OTP
The directory name and path for
the Object Transfer Protocol
Directory.
Default ..\OTPDATA
PERIODIC CHECK
The buffer number (n) upon which
Archive Manager will perform
buffer verification. This setting
applies when the MODE entry is
set to PERIODIC.
Minimum 1
The number of queue retries
before the temporary catalog is
used to buffer the archive
workitem information to the main
catalog.
Minimum 5
RETRIEVAL BUFFER
CHAIN SIZE
The total number of linked buffers
dedicated to each optical disk
drive and used for retrieval
operations.
The default and only value
is 1.
RETRIEVAL
BUFFER SIZE
The KB allocated in each buffer
link in a retrieval chain; all links
in all chains will have this buffer
size.
Default 63
NET LISTEN
RETRY
NUM OF QUEUES
QUEUE RETRY
Maximum 32000
Default 5
Maximum 5
Default 3
Maximum There is no
maximum value.
Maximum 1000
Default 30
The maximum value is
dependent on
configuration.
NT3.51:63
NT4.0:63-1020
RETRIEVAL
RESTART DELAY
4334 7798–006
Default 30
2–7
Archive Manager
ARCHIVE Key
RETRIEVAL WAIT
Description
The number of seconds a
retrieval request will wait for a
platter to be mounted. If the
time expires, the retrieval fails
with:
Error 951
DRIVE
UNAVAILABLE)
Values
Minimum 15
Maximum None
Default 30
The value entry is not
visible unless the value is
changed from the default.
OR
Error 952
RETRIEVE
DISABLE
VOLUME
UNAVAILABLE
The timeout interval (in minutes)
for the Retrieval Disable Mode
when activated by the user
through the Utilities menu,
Settings option, and Retrieval
Disable option.
Minimum 1
Default 3
If activated, retrieval processing is
interrupted. If the user does not
perform any Add or Remove
operations while Retrieval Disable
mode is activated, then it will time
out according to the value of this
entry.
2–8
4334 7798–006
Archive Manager
ARCHIVE Key
RETRIEVAL
SERVICE LEVEL
Description
The configuration for preemptive
retrievals.
Multiple values may be
specified and must be
separated by a comma.
Values
FLIP ARCHIVE - Archive
processing is interrupted if a
retrieval request is issued for
the flip side of the archive
platter.
ALL ARCHIVE - Archive
processing is interrupted if a
retrieval request requires a
resource (drive or platter)
that is reserved for archiving.
Because ALL ARCHIVE
implies FLIP ARCHIVE, do
not specify both.
FLIP BACKUP - Backup
processing is interrupted if a
retrieval request is issued for
the flip side of a backup
platter.
ALL BACKUP - Backup
processing is interrupted if a
retrieval request requires any
resource (drive or platter)
that is reserved for backup
processing. Because ALL
BACKUP implies FLIP
BACKUP, do not specify
both.
NO PREEMPTION Archiving or backup is not
interrupted in order to
service retrieval requests.
4334 7798–006
2–9
Archive Manager
ARCHIVE Key
STORE PLATTERS
Description
Controls whether all platters are
removed from jukebox drives and
whether platters in stand-alone
drives are stopped each time
Archive Manager is shut down.
Values
Y
Platters are removed or
stopped at Archive
Manager shutdown.
N
Restores pre 3.2
behavior.
The value entry is not visible
unless the value is changed
from the default.
SUMMARY REPORT
Specifies whether successful
archive requests are written to a
journal file (JUKELST.DAT).
Yes
Successful archive
requests are written to
the journal file.
Note: JUKelst.dat is a journal of
every workitem component archived
and successfully updated to the
Catalog. While useful for
confirmation of archiving and
Catalog update, it can quickly grow
large during production archiving.
No
Successful archive
requests are not
written to journal file.
TEMP DB RECORD
NUM
Specifies how many records at a
time to dequeue from the
temporary cache.
Maximum 15
TEMP LOCATOR
Sets the name of the temporary
catalog. The temporary catalog is
used by Archive Manager to store
catalog entries when the
connection to the catalog is not
available.
Default TEMPLOC
Default
5
Note:
If the Archive Manager
and Location Manager are running
on the same machine, this entry
must be different from the TEMP
LOCATOR entry in the LOCATOR
subkey.
UPDATE BLOCK TIME
UPDATE MAX LSREC
2–10
Specifies the maximum amount of
time (in seconds) to wait for a buffer
with data.
Minimum
Sets the number of archive
requests to be grouped together
for the main catalog update call.
1
Maximum
None
Default
2
Minimum
1
Maximum
45
4334 7798–006
Archive Manager
ARCHIVE Key
Description
Values
Default
UPDATE MULT
RECORD
UPDATE TEMP LOC
ONLY
UPDATE TEST
USE VOLUME TABLE
45
Specifies whether updates to the
catalog are made once per record or
once per multiple records.
Y
Update once per
multiple records.
N
Update once per record.
For debugging and testing only.
Indicates whether updates are only
to be made to the temporary
catalog.
YES Update the temporary
catalog only (the main
catalog is not updated).
Used for testing only. If enabled,
catalog updates are disabled.
Y
Catalog updates
disabled.
N
Catalog updates not
disabled.
Sets whether to use the Volume
table.
NO Update main catalog.
YES Use Volume table.
NO
Do not use Volume Table.
For testing purposes, set
this entry to NO.
ARCHIVE UNITS
This subkey contains value entries for each jukebox unit. The jukebox type
follows the unit name. The table shows the values for the supported jukebox
types. Contact your customer representative for a listing of supported devices.
Value Entry
<Archive Unit
Name>
4334 7798–006
Description
Values
Jukebox Type:
Supported CYGNET jukeboxes
1803
All supported Hewlett Packard jukeboxes
1700
Supported KODAK jukeboxes
6800
Supported LMS jukeboxes
4500
Supported Plasmon G-series jukeboxes
638
Supported Plasmon M-series jukeboxes
500
Plasmon LMS 8600 jukebox
4500
Any supported, standalone optical drive
NO_JUKEBOX
2–11
Archive Manager
<Archive Unit Name>
There is one unit name subkey for each of the preceding archive unit subkeys.
Value Entry
JB PORT
Description
Sets the interface method for jukebox
communication.
Required for each attached jukebox unit.
Values
For SCSI interfaces, the
values are: SCSI, card#,
SCSI ID, LUN (logical unit
number)
For RS-232 interfaces,
the values are: com port,
baud rate, parity, data
bits, stop bits.
JB SLOTS
Sets the total slot allocation for the jukebox.
Required for each attached jukebox unit.
This may be greater
than the actual number
of storage slots in the
jukebox. If the unit is
standalone, the value is
0.
<Archive Unit Name> OPTICAL DRIVES
This subkey provides the mapping between the drive number and the
robotics slot address for each attached jukebox. For each entry there is a key
to identify the storage slot address and a value to indicate the drive number.
The Archive Unit Name OPTICAL DRIVES subkey is required for each drive
attached.
For example: 1:REG_SZ:0,ARCHIVE
2–12
4334 7798–006
Archive Manager
COMMON
This subkey contains value entries to indicate the server name and other
common values.
COMMON Key
ARCHIVE
Description
Values
Name of the Archive
Controller.
Maximum of eight characters,
uppercase if using APPC,
NONE is reserved. Archive
Manager will not start if the
value NONE is placed here.
DB_MULTITHREADED
Indicates whether the access
to the ODBC driver is singlethreaded or multithreaded.
LOCATOR
Sets the name of the machine
on which the relational catalog
database is installed.
NET NAME
Specifies the network name.
This name is written in the
Netname field of each entry in
the volume table.
1 Multi-threaded
0 Single-threaded
Maximum of eight characters.
NETTRACE
Enables the trace mechanism
used for debugging.
Note:
Detailed tracing
slows down the system
significantly; therefore,
NETTRACE must be set to 0 in
a production environment. Use
tracing only for debugging
purposes.
ODBCDEFAULTPOOL
SIZE
PASSWORD
4334 7798–006
Sets the handle pool size of a
process if the process does
not have an entry under the
ODBCSETUP subkey.
0 No trace
1 Function tracing
2 Data tracing
3 Function and data
tracing
Minimum 1
Maximum > 1
Default 20
Sets the datasource logon
password for the Catalog.
2–13
Archive Manager
COMMON Key
REQUEST
Description
Values
Sets the name of the server
running Request Manager.
Used for asynchronous
retrievals utilizing Request
Manager.
SERVER
Sets the name of the
Workflow Domain Subsystem
if the Workflow Domain
Subsystem is installed on the
same computer as the Archive
Manager. Otherwise, this
value entry is not used.
•
Maximum of eight
characters.
•
Must be uppercase if
using APPC.
Note:
Installing the Workflow Domain Subsystem and the Archive Manager on the same
computer is not recommended or supported for production applications. Such a
configuration is intended only for demonstration or very low volume pilot purposes. For more
information on this configuration, refer to the Installation & Configuration Guide.
USERID
Sets the datasource logon
User ID for the Catalog.
LOCATOR
LOCATOR Key
CONVERSATIONS
2–14
Description
Sets the number of concurrent
conversations.
DATA SERVER
The name of the remote
machine on which the remote
Relational Catalog is located.
Delete this entry if the catalog is
local.
DATABASE
The name of the ODBC DSN.
Value
Minimum 1
Maximum 10
Default CATALOG
4334 7798–006
Archive Manager
LOCATOR Key
DEFAULT_ALIAS
Description
Supplies a default alias for
updating the LOCATOR with
records where the alias is
missing (or blank).
Applies to Relational Catalog
only.
Value
Default #unnamed#.
Character string of up to
44 characters. Illegal
characters (% / \ *) are
replaced with blank.
If #ClassName#, the
name of the workitem
class is used.
If #ObjectID#, the internal
object ID of the workitem
is used.
DEFAULTINDEX
The name of the default index
that is mounted for the
enterprise.
The host security
administrator provides
this value.
MAINFRAME_
VERSION
Indicates which version of the
Catalog is being used.
0
PARALLEL_
SESSIONS
Sets APPC sessions.
0 For single APPC
sessions
Relational Catalog
1 Enable parallel
sessions
PASSWORD
Sets the access password for
the Relational Catalog.
TMPDIR
Set to a temporary directory.
TPNAME
Indicates the name of the
Transaction Program opened by
the user.
USERID
Sets the access user ID for the
relational catalog. If there is no
value in this entry, the User ID
in the USERID entry in the
COMMON subkey will be used.
4334 7798–006
If there is no value in this
entry, the password
indicated in the
PASSWORD entry in the
COMMON subkey is
used.
2–15
Archive Manager
Network Communication Keys
Archive Manager uses the following registry keys to enable network
communications through the TCP/IP protocol:
•
•
•
•
NETCALL
NETLISTEN
NETMODULE
NETSETUP
Various InfoImage components may use these registry keys. Section 8
describes the keys for Workflow Domain Subsystem. In this section, we
provide the basic format, along with examples for this specific component.
Please refer to Section 8 if you require further details on the individual
parameters used in a particular key (for example, <parameter>).
Key
Format
Sample Entries
NETCALL
<name>/<API>:<protocol name>,
<protocol info>
*/*:REG_SZ:TCP/IP
NETLISTEN*
<process name><API> <instance>:
<protocol name>,<threads>,
<adapter no>
ARCHIVEARC2:REG_SZ:TCP/IP,15
ARCHIVEARM2:REG_SZ:TCP/IP,15
ARCHIVEOTP2:REG_SZ:TCP/IP,10
where API names are:
OTP
used for archival and retrieval
of DMWS workitems
ARC
used for archive and retrieval
of HPWS workitems
ARM used for the Request Manager
If you increase NETLISTEN threads
you can serve more clients
simultaneously, however, more
threads consume resources (for
example, memory for stack) and
require service from the Windows
scheduler.
2–16
NETMODULE
<protocol name>:<module name>
APPC:REG_SZ:PASAPPC
TCP/IP:REG_SZ:PASTCPIP
NETSETUP
<name><instance>:<protocol
name><adapter>
ARCHIVE2:REG_SZ: TCP/IP
4334 7798–006
Archive Manager
ODA DRIVES
This subkey contains one key per optical drive and is required for each drive.
The format of any entry is:
<drive no.>:<REG_SZ>:<card>,<id>,<lun>,<heads>
where
<drive no.>indicates the drive number.
<card> indicates the host adapter number.
<id> indicates the SCSI bus ID.
<lun> indicates the logical unit number.
<heads> indicates the number of drive heads.
4334 7798–006
2–17
Archive Manager
Sample entry
0:REG_SZ:0,0,0,SINGLE_HEAD
Optical drives with two read/write heads are designated as Dual_Head in
Archive Manager.
Sample Entry
0:REG_SZ:0,0,0,DUAL_HEAD
ODBCSETUP
This subkey contains value entries that indicate the maximum number of
concurrently open database connections.
Value Entry
ARCHIVE
Description
Indicates the maximum number of
concurrently open database
connections allowed for the archive
process.
Values
The total number of
connection handles for all
processes must not exceed
the number of connection
handles allowed by the
DBMS.
For example:
ARCHIVE:20
2–18
4334 7798–006
Archive Manager
PLATTER LABELS
This subkey contains the keys that describe the procedures for labeling the
platters in the jukebox. For each entry, a key name identifies the labeling
procedure, followed by a format string, and upper and lower ranges for the
labels.
Example
LABEL: CCCVVVV,AAA000A,AAA999D
where:
LABEL is the key name of the procedure.
CCCVVVV is the format string (CCC being a constant, and VVVV being a
variable).
AAA000A represents the lower range of the labels.
AAA999D represents the upper range of the labels.
There is an eight-character maximum for the labeling scheme. For more
information about labeling, see the System Internals Guide.
SCHEDULER
This subkey contains value entries for the Scheduler program for automatic
backups of archive platters.
Value Entry
DAY_SETn
JBX_BACKUP_DAY_
SETn
Description
Values
Specifies one set of days as
a timetable for the backup
process. Multiple day sets
can be created.
Mon, Tue
Specifies the time schedule
for the backup resource for
DAY_SETn.
Time in format: HHMM
Wed, Thu
Fri, Sat, Sun
There should always be an
even number of entries. The
first entry specifies the start
time; the second entry
specifies the stop time.
4334 7798–006
2–19
Archive Manager
Value Entry
Description
Values
RESOURCE_NAMESn
Sets the name(s) of the
resources on the Archive
Controller for which the
scheduler runs a backup (n =
1,2,...).
JBX_BACKUP
RESOURCE_NAMESn_
DEFAULT
Specifies whether the
resource
(RESOURCE_NAMESn)
should be activated when the
scheduler process is not
running.
Y
Activated
N
Not activated
SCHEDULE_SLEEP
Specifies the polling interval
(in seconds) the scheduler
uses to check its internal
process list for resources to
start or stop.
Default 60
System Control
This subkey allows you to determine the version of the software running on
the server.
Value Entry
2–20
Description
Values
Archive Manager
Specifies the directory where the
Archive Manager is installed.
PRODUCT NAME
Indicates the name of the product
currently installed.
Do not modify.
Version
Indicates the current version of
the software running on the
server.
Do not modify.
4334 7798–006
Section 3
Central Administration Console
This section describes the registry keys used by the Central Administration
Console (CAC) to modify system behavior. Unless otherwise noted, registry
keys for CAC have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\CAC
Default values appear in bold type.
CAC subkeys for CAC Server and CAC client are in separate tables.
CAC (Server)
The following are CAC subkey entries for the CAC Server.
Value Entry
Description
ConfigurationType
The value is set during installation.
DbDSN
The ODBC Data Source Name for
the Central Administration Console
database.
Values
CONFIG
The value is set during installation
based on data entered.
DbLocation
Location of the CAC database file.
C:\
The value is set during installation
based on the selection if default is
changed.
DbLogfileLocation
Location of the CAC transaction log
file.
C:\
The value is set during installation
based on the selection if default is
changed.
4334 7798–006
3–1
Central Administration Console
Value Entry
DbPassword
Description
Values
Password for use with the ODBC
Data Source Name for the Central
Administration Console.
The value is set during installation
based on data entered.
DbServName
Database server name.
The value is set during installation
based on data entered.
DbType
DbUser
The type of database used by the
Central Administration Console.
SQLSERVER
The value is set during installation
based on the type of database
selected.
OTHER
ORACLE
SYBASE*
*Note: The value does
not get automatically set
when using a Sybase
database. Following
installation, manually
change the value to
“SYBASE” (all caps).
User ID for use with the ODBC
Data Source Name for the Central
Administration Console.
The value is set during installation
based on data entered.
LogLevel
Sets the severity level of
messages logged to the log files.
100 All messages
10
Critical errors only
LogSize
Maximum size, in bytes, of
Central Administration log files.
1000000
LogDebug
Controls the internal debugging
displays for the CACLogManager
service.
0 Turn debugging off.
1
Turn debugging on.
If debugging is turned on, entries will
be made in CaclogManager.dbg.
3–2
4334 7798–006
Central Administration Console
Value Entry
ServiceAcctDomain
Description
Values
Windows domain where the
Unisys Service Account user ID
logs on.
The value is set during installation
based on data entered.
ServiceAcctName
User ID of the Unisys Service
Account.
UnisysServiceAcco
unt
The value is set during installation
based on data entered.
SystemObjects
Directory
4334 7798–006
Folder where system objects will
be written.
3–3
Central Administration Console
CAC (Client)
The following are CAC subkey entries for the CAC Client.
Value Entry
Description
ClientEXELocation
The value is set during installation to
the path location of the CAC Server
client executable.
Values
fully qualified path to:
CAC.MSI Windows
2000 systems
CAC.EXE Windows NT
systems
ClientLogFile
Location of the CACConsole.log file.
Set during installation to the user’s
temp folder location.
Default is the user’s
temp folder.
ClientLogFileDelet
eOnStartup
Used to enable or disable deletion
of the log file at startup.
1
Delete enabled
0
Delete disabled
ClientLogLevel
This value is set during installation.
2147483647
ClientLogLevelHex
This value is set during installation.
7FFFFFFF
UNIFIEDLOGON
Specifies whether the CAC Client has
unified logon enabled.
Y
Enabled
N
Disabled
Note: The CAC Client can be set
up on each client machine to logon
to CAC with the Windows User ID.
This precludes from having the user
enter his CAC password. The
default CAC Server or last CAC
Server selected is used as the CAC
Server. When switching CAC
Servers, the user is only prompted
for the CAC Server. If a user has
logged into 2 machines with the
same NT User ID and attempts to
log into CAC from each machine
simultaneously, the logons will be
successful, but it is not supported
and not recommended.
(SettingsLastSaved)
3–4
This value is updated by the system.
Do not change.
4334 7798–006
Central Administration Console
These registry keys for CAC have the following location in the registry:
HKEY_CURRENT_USER\SOFTWARE\Unisys\UeWI\<version>\CAC
CAC (Client)
The following are CAC subkey entries for the CAC Client.
Value Entry
Description
CACServers
List of all CAC Servers connected to
successfully. The items in the list are
each separated by a semicolon
LastCACServer
The last CAC Server that was
connected successfully
Values
NETSETUP
This subkey value will be inserted during installation in the NETSETUP subkey
on the server identified as the InfoImage Workflow Domain Controller.
Value Entry
uu1
Description
Registers Update Utility as a
server process with InfoImage.
Values
TCP/IP
Note: The Update Utility is an
agent for CAC that runs on the
InfoImage Workflow Domain
Controller. It provides an interface
into the Workflow Domain
Controller.
<Console> Subkey
Each administration console installed on the CAC Client should have a subkey
under CAC. The CAC Server should have one subkey under CAC.
The subkey console names are; CAC Server, UeWIAdm, UeWIConsole,
UeWILic, UeWIOps, and UeWIXMLGateway.
4334 7798–006
3–5
Central Administration Console
Value Entry
<No Name>
3–6
Description
InfoImage installation path
Values
The value is entered by
the installation script.
4334 7798–006
Section 4
Client API and Other Integration
Components
This section describes the registry keys used by the Client API software to
modify system behavior. This section also includes registry entries for other
integration components, such as Connector for Siebel.
Unless otherwise noted, keys have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
Default values appear in bold type.
4334 7798–006
4–1
Client API and Other Integration Components
Client API
App Paths\<application filename>
This subkey and its values have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\
Value Entry
PATH
Description
A Windows environment system
variable that specifies the path of
Client API/CAL directories. This
entry enables the proper
functioning of custom and thirdparty applications that use Client
API/CAL.
Values
Default:
“C:\Program Files\UeWI\;
C:\Program Files\UeWI\Common;
C:\Program Files\Common Files\
UeWI”
Note: InfoImage release 5.2
automatically sets the PATH
variable on installation of Client
API/CAL. If you are migrating from
a previous versionInfoImage, you
may need to manually set the
directories. These situations are
as follows:
•
The locations of the Client
API/CAL directories have
changed from those of a
previous installation.
•
You reinstalled the Client
API/CAL into a different
directory, and user
applications using Client
API/CAL have set up the
application’s Apps Paths in the
Windows registry.
For more information on manually
setting the PATH entry, see
Appendix D of the Installation &
Configuration Guide.
4–2
4334 7798–006
Client API and Other Integration Components
COMMON
This subkey and its contents are not set up during a default installation.
Value Entry
Description
Values
LOG_DIR
The directory for the .STS file is a log file
produced by the Client API.
Default
Current
Directory
LOG_FILE_SIZE
Maximum size (in KB) of an .STS log file
before rollover.
Minimum 65
Default 1000
When an .STS file grows too large, it is
backed up. For more information on the
naming and numbering of backup files, see
the key NUM_BACKUP_LOG_FILES.
Note: The rollover mechanism is
disabled if more than one instance of an
individual client engine program is
running concurrently on the same
machine.
NUM_BACKUP_
LOG_FILES
The maximum number of backup log
files. The name of the first backup file is
exename.st0, the second is
exename.st1, and so forth. As additional
backup files are created, existing backup
files are renamed in order, so that the
last digit of the backup file extension is
higher for older files. If the maximum
number of backup .STS files already
exists, the oldest backup file is deleted.
Default 10
LOG_FILE_SIZE
Maximum size (in KB) of an .STS log file
before rollover.
Minimum 65
Maximum 10
Default 1000
When an .STS file grows too large, it is
backed up. For more information on the
naming and numbering of backup files, see
the key NUM_BACKUP_LOG_FILES.
Note: The rollover mechanism is
disabled if more than one instance of an
individual client engine program is
running concurrently on the same
machine.
4334 7798–006
4–3
Client API and Other Integration Components
Value Entry
NUM_BACKUP_
LOG_FILES
Description
The maximum number of backup log
files. The name of the first backup file is
exename.st0, the second is
exename.st1, and so forth. As additional
backup files are created, existing backup
files are renamed in order, so that the
last digit of the backup file extension is
higher for older files. If the maximum
number of backup .STS files already
exists, the oldest backup file is deleted.
Values
Default 1
Maximum 10
DocWindow
The DocWindow subkey is present if the Client API software has been
upgraded from an existing installation. The subkey entries store the client
application’s window coordinates. Sample entries are as follows:
BOTTOM
REG_DWORD:0x251
LEFT
REG_DWORD:0xe3
RIGHT
REG_DWORD:0x273
TOP
REG_DWORD:0xfffffff9
Network Communication Keys
The InfoImage Client API uses the following registry keys to enable network
communications through the TCP/IP protocol:
4–4
•
NETCALL
•
NETMODULE
•
NETSETUP
4334 7798–006
Client API and Other Integration Components
Various InfoImage components may use these registry keys. Section 8
describes the keys for Workflow Domain Subsystem. In this section, we
provide the basic format, along with examples for this specific component.
Please refer to Section 8 if you require further details on the individual
parameters used in a particular key (for example, <parameter >).
Key
Format
Sample Entries
NETCALL
<name>/<API>:<protocol name>,
<protocol info>
*/*:REG_SZ:TCP/IP
NETMODULE
<protocol name>:<module name>
TCP/IP:REG_SZ:PASTCPIP
Note: There must be one
NETMODULE entry for each protocol
specified in the NETSETUP subkey.
NETSETUP
<name><instance>:<protocol name>
OMDAPI2:REG_SZ:TCP/IP
OBJECT
Value Entry
CLIENTROOT
Description
Optional entry that can be used to
specify an objects directory for
InfoImage Client API client programs.
Values
Any valid directory location
other than that specified for
ROOT (see caution).
Example:
D:\Program
Files\InfoImage\ClientObjects
ROOT
Specifies the Client API objects
directory for InfoImage server
components.
Any valid directory location
other than that specified for
CLIENTROOT (see caution).
Example:
D:\Program
Files\InfoImage\ServerObjects
Caution
If server and client components are installed on the same machine, be
certain you specify different folders for CLIENTROOT and ROOT.
4334 7798–006
4–5
Client API and Other Integration Components
OMDAPI
4–6
Value Entry
Description
Values
EnableOLEMark
ups
Specifies whether OLE markups
should be enabled.
1 Enable OLE markups.
<Application
Short Name>
Maps an application short name
to an InfoImage Import class
name for OLE markup
conversion.
Any valid InfoImage Import
Class name
PrintQueue
Specifies the default print queue
when the name is not specified
the API call.
“” (an empty string)
FaxQueue
Specifies the default fax-out
queue when the name is not
specified the API call.
“” (an empty string)
MemoryCacheSi
ze
Specifies the number of
kilobytes (8192=8MB) of
memory allocated to
decompressed pages images.
Increasing this can reduce the
time it takes the workstation to
respond to a page view request,
if the requested page is already
decompressed. Too much
memory allocated for the
images may degrade
performance, because less
memory will be available to
other data and processes on the
workstation. Note that you
could set this parameter to a
size that would include the
virtual memory available, but
this is not desirable. In general
you should set this parameter to
use as much memory as
possible without causing the
system to swap.
8192
NumRenderingT
hreads
Sets the number of threads that
can perform image
manipulation, particularly image
decompression.
1
0 Disable OLE markups.
4334 7798–006
Client API and Other Integration Components
OMDAPI_LOG
Value Entry
SAVE
Description
Indicates whether to save the
*.STS log files to a file on disk.
Values
0 Do not save.
1 Save.
This value entry is not set at
installation and the system
behavior defaults to 1 (log is saved
to file on disk).
System Control
Value Entry
Description
Values
Client Engine
Specifies the path to the Client API
installation on this computer.
<Entered during install>
PRODUCT NAME
Indicates the name of the product
currently installed.
Do not modify.
Version
Specifies the current version of the
software running on this machine.
Do not modify.
Connector for Siebel
This section describes the registry keys that the Connector for Siebel
software uses to modify system behavior. Unless otherwise noted, registry
keys for Index Assistant for Siebel have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\UeWI\<version>\Siebel
Interface\<version>\
Default values appear in bold type.
4334 7798–006
4–7
Client API and Other Integration Components
IAS
This subkey contains value entries used by the Index Assistant for Siebel you
create and maintain using the Siebel Preferences program.
Value Entry
Values
SiebelUser
The User Name to log onto the Siebel
Call Center.
Default is blank
SiebelPassword
The encrypted Password to log onto the
Siebel Call Center using the SiebelUser
User Name.
Default is blank
ConnectTo
The name of the Siebel domain to log
onto, typically Server. Available options
depend on the values in the uagent.cfg
file.
Enabled
The flag that indicates whether the Index
Assistant is enabled or disabled. In the
Siebel Preferences interface Index
Assistant tab, this entry corresponds to
the Index Assistant Enabled check
box.
True = enabled
The full path to the Siebel Configuration
File, uagent.cfg.
Default is blank
XMLMappingDefinitio The full path to the XML Mapping
nsFile
Definitions File, the Siebel XML IAS
Mapping Definitions.xml, or Siebel XML
IAS Mappings Definitionsfor Contact
Address.xml.
Default is blank
SiebelCFG
4–8
Description
False = disabled
4334 7798–006
Client API and Other Integration Components
ActiveXDocViewer
This subkey contains value entries used by any Document Viewer for Siebel
you create and maintain using the Siebel Preferences program.
The location for MaxViewerCount is
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\UeWI\5.0\UeWIVaio
Value Entry
Description
Values
UserName
The User Name to log onto Client
Work Manager.
Default is blank
Password
The encrypted Password to log onto
Client Work Manager.
Default is blank
Department
The InfoImage Department (or
Workflow Domain) name to which you
want to connect
Default is blank
MaxViewerCount
The maximum number of Document
Viewer windows the user can open
simultaneously. Opening multiple
windows can affect performance, and
the number of windows is governed
by the available memory on the
workstation. In the Siebel Preferences
interface Document Viewer tab, this
entry corresponds to the Maximum
Document Viewer Window
Count field
-1 = unlimited
4334 7798–006
+n = number of
windows
0 = invalid
1 = default
4–9
Client API and Other Integration Components
4–10
4334 7798–006
Section 5
Client Work Manager
This section describes the registry keys used by the Client Work Manager
software that you can use to modify system behavior. In addition to covering
keys specific to the core Client Work Manager application, this section
includes registry keys for the supporting applications Document Viewer and
Form Viewer.
Registry keys for Client Work Manager and associated applications have the
following location in the registry:
HKEY_CURRENT_USER\Software\Unisys\UeWI\<version>\
Default values appear in bold type.
WorkManager
The following are WorkManager subkey entries.
Value Key
CacheQueryForms
Description
Determines whether query forms are
cached after use.
Values
True
False
To turn on Query Form caching for a
workstation, manually create this registry
key, and set the value to “True.”
4334 7798–006
5–1
Client Work Manager
Value Key
CacheMailLogin
Description
Values
Controls the caching of the mail login
when Microsoft Outlook is configured to
prompt the user for a user profile.
Valid Entries:
Note: This option has no effect when
Outlook is configured to automatically
use a profile.
Default for Windows
95, 98, and ME
When creating new mail messages in
Client Work Manager; and the user is not
logged into the mail system, the Choose
Profile login dialog box displays.
1 = Caching on
•
With caching turned off, the dialog
box continues to display every time a
new mail message is created.
•
When caching it is turned on, Client
Work Manager uses the previously
selected profile for every new mail
message created.
0=
Caching off
(no caching)
Default for Windows
2000 and NT
Determines whether to automatically
close an open Document Viewer window
when the user opens a different
document.
0 = Do not close
the previous
Document Viewer
HideDocViewerW
orkitemMenus
Determines if menus in the Document
Viewer window will be hidden.
0
Do Not hide
1
Hide Menus
Logging
Determines whether logging is turned on
or off for Client Work Manager. The
setting creates a log file that tracks
everything the program does.
0
No
1
Yes
ClosePreviousDoc
umentViewer
1 = Close the
previous document
viewer.
Turning logging on can be useful for
debugging purposes. If you need to
contact Unisys Support with problems,
you may be asked to turn the option on for
a period of time. To locate the log files, you
can run the LumberJack.exe utility.
In production mode, we recommend that
you work with logging turned off for
optimal system performance.
5–2
4334 7798–006
Client Work Manager
Value Key
MaxDocViewers
RetrieveWarningLi
mit
Description
Values
Determines the number of Document
Viewers that can be open concurrently.
Use to restrict resource usage on
Windows 95 or 98 systems.
1 to
When a attempts to retrieve more
workitems than the number set by this
registry entry, displays a message
asking the user to confirm the retrieval.
Any value > 0 =
Display the
message
9999 (default)
0 = Do not display
the message
ClientServices
The following are ClientServices subkey entries under the WorkManager
subkey
Value Key
Description
Values
BufferSize
The number of debug messages to buffer
before writing to the file. The greater the
number, the less the impact on performance.
0
Debugging
off
FileName
The location of the debug file,
clientservices.dbg
Specify the full
path of the file.
FormViewer
The following is the FormViewer subkey entry.
Value Key
Description
Values
EnterKeyRunsQue
ry
Determines whether to use the Enter key
to run a query.
0
No
1
Yes
Logging
Determines whether logging is turned on or
off for FormViewer.
0
No
1
Yes
4334 7798–006
5–3
Client Work Manager
UeWIDocumentViewer
The following are UeWIDocumentViewer subkey entries.
Value Key
EmbeddedColorCo
mpression
Description
Indicates the color compression type to
use when storing imported color image
files to the InfoImage internal native
format.
Values
0 LZW –
Lossless,
highest quality
1 JPG Best –
Lossy, highest
quality
2 JPG Default –
Lossy, default
quality
Logging
Determines whether logging is turned on
or off for Document Viewer.
0
No
1
Yes
UeWIDocumentViewer\DocViewer
The following are UeWIDocumentViewer subkey entries.
Value Key
ConfirmPageDelet
e
Resource
Threshold
5–4
Description
Values
When a user deletes a page, displays a
message asking the user to confirm the
delete command.
True=displays
the message
Sets the level against which to check
available resources.
0 to 100
False=does not
display the
message
4334 7798–006
Client Work Manager
UeWIDocumentViewer\NoteEditor
Value Key
SortOrder
Description
Used to store the sorting order selected
by the user.
Values
DateCreated_A
scending = 1
DateCreated_D
escending = 2
Author_Ascendi
ng = 3
Author_Descen
ding = 4
4334 7798–006
5–5
Client Work Manager
5–6
4334 7798–006
Section 6
Enterprise Indexing
This section describes the registry keys used by the Enterprise Indexing
software to modify system behavior. Unless otherwise noted, keys for
Enterprise Indexing have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
<Workflow Domain>\<Workflow Domain Subsystem>
\
Default values appear in bold type.
ENTERPRISE_INDEXING
Value Entry
Enabled
Description
Values
Enables enterprise-indexing
queries to be performed from this
server.
True -- EI queries can be performed.
Do not set this value to True until you
have entered all of the Enterprise
Indexing configuration information.
False -- (default) No EI queries will
be performed from this server.
MaxRows
Defines the maximum number of
rows returned on a query.
Note: Client Work Manager has
a field that is called MAX ROWS.
The value entered here can
override the Client Work Manager
field.
MaxQueries
Number of EI queries to process
concurrently.
Minimum -- > 0
Maximum (default) -- < 99,999
The greater this number, the more
impact enterprise queries have on
system performance.
Minimum -- > 0
Maximum – no more than half the
number of NETLISTEN threads.
The greater this number, the more
impact enterprise queries will have on
system performance.
4334 7798–006
6–1
Enterprise Indexing
ENTERPRISE
Value Entry
Enabled
Description
Values
Enables enterprise queries to be
performed against this enterprise.
True -- Enterprise queries can
be performed.
CAUTION: Do not set this value
to True until you have entered all of
the Enterprise Indexing
configuration information.
False -- No enterprise
queries can be performed
against this enterprise.
(Default)
<DOMAIN> Subkey
Each Workflow Domain in the enterprise should have a subkey under
ENTERPRISE. The system administrator should realize that the Workflow
Domains defined here should all use the same Archive Server. Also, the
administrator must know the names of the Workflow Domains; the system
does not supply them.
Value Entry
IndexServer
Description
Name of Index Server for this
Workflow Domain.
Required.
Enabled
Enables enterprise queries to be
performed against this Workflow
Domain.
Note:
You can safely set
Enabled to True at the Workflow
Domain level since it is set to False
at the ENTERPRISE_INDEXING
level. This enables you to configure
the Workflow Domains, but
prevents Index Manager from
attempting to use Enterprise
Indexing until you have set up all the
configuration information.
6–2
Values
The value entered here must
match the name specified in
COMMON\INDEXIDX1 for the
current server.
True -- Enterprise Indexing
queries can be performed.
False --- No EI queries will be
performed against this
Workflow Domain. (Default)
4334 7798–006
Enterprise Indexing
Value Entry
ODBCConnectString
Description
Pathway to the database that
contains the Attributes table (Index
Server).
Required.
Values
At a minimum, you must
supply a DSN. You must define
a DSN for every Index Server
participating in the enterprise
queries. Define the DSN(s) in
the ODBC Data Source
Administrator.
You also need to set the user
ID and password for this
connection.
ODBCLoginTimeOut
ODBCQueryTimeOut
How long (in seconds) to try to log in
to the database before getting an
error message.
Minimum -- > 0
How long to wait (in seconds) for a
response from the database before
getting an error message.
Minimum -- > 0
Maximum -- 60 (default)
Maximum -- 60 (default)
WARNING
The name in the IndexServer field MUST match the name
specified in COMMON\INDEXIDX1, otherwise all enterprise
queries processed by this Index Server will fail.
4334 7798–006
6–3
Enterprise Indexing
6–4
4334 7798–006
Section 7
Fax Manager
This section describes the registry keys used by the Unisys Fax Manager
software to modify system behavior. Unless otherwise noted, registry keys
for Fax Manager have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
Default values appear in bold type.
COMMON
Value Entry
NETTRACE
Description
Enables the trace mechanism used for
debugging.
Note: Set NETTRACE to 0 in a
production environment. Detailed tracing
slows down the system significantly.
Tracing should only be used for
debugging purposes.
SERVER
Sets the name by which this Fax
Manager is known on the network. Must
be unique across all Workflow Domains
that have network connectivity.
Values
0 No trace
1
Function
tracing
2
Data tracing
3
Both function
tracing and
data tracing
Eight characters
maximum
Case sensitive
Required.
UNIFIED LOGON
Specifies whether unified logon is
enabled.
Y
Enabled
N Disabled
Note: Unified logon is determined by
the Workflow Domain. If configured for
Unified Logon, the Unified Logon
password and ID are used. If not
configured for Unified Logon, the
password and ID in the registry are used.
See also Appendix C of the Installation
4334 7798–006
7–1
Fax Manager
Value Entry
Description
Values
and Configuration Guide.
FAX
FAX Value Entry
Description
Values
COVER SHEET
TEMPLATE
Specifies the .TIFF file to use as the
fax cover page. If a .TIFF file is not
specified, a blank page will be used as
the cover page template.
Any (8.3) file name.
DEBUG
Logs debug messages displayed.
1
Log Debug messages.
0
Do not log debug
messages.
DOC_CLASS
Must be in the ..\SYS
directory
Indicates the name of the document
class to be associated with the
document created when an incoming
fax is received.
Required.
DOCUMENT
ASSEMBLY
Creates single page documents or a
multiple page document from a multipage fax transmission.
SINGLE
Creates a separate
document for each page
in a multi-page fax
transmission.
MULTIPLE
All of the pages in the
multi-page fax
transmission are placed
in the same document.
DOMAIN
Set to the name of the Workflow
Domains to which the Fax Manager
connects.
Required.
FAX_SPOOL
For more information,
see the GammaFax
Reference Manual.
7–2
Indicates the full directory path for the
GammaFax queue files.
Reserved for future use.
The default value is the current
directory. If this entry is used to
define a directory other than the
current directory, the GammaFax
software must also be configured to
use the same directory. Add a line to
4334 7798–006
Fax Manager
FAX Value Entry
Description
Values
the gfax.$dc file in the..\SYS directory
identifying the directory and file name,
for example, GFXRECVPATHE 1
C:\FAXDOCS\F001P001.TIF.
FAX_TYPE
Indicates the type of fax. Currently
GammaFax is the only supported
type.
Reserved for future use.
FAXIN BASE NAME
Specifies a character string (maximum
19 characters) used to build the
workitem name of documents faxed
into the system. The format of the
workitem name is as follows:
Default FAX
FAXIN_BASE_NAME+date_
string+'@'+time_stamp
FAXIN ERROR QUEUE
Specifies the name (maximum alpha
numeric 20 characters) of an error
queue to which incoming truncated
(that is, those whose length
exceeds the value in the MAX
FAXIN PAGE LENGTH entry) or
corrupted faxed pages will be sent If
this entry does not exist, the
truncated or corrupted fax pages are
sent to the workstep specified by
the FAXIN QUEUE value entry.
FAXIN QUEUE
Indicates the name (maximum 20
alphanumeric characters) of the
faxin queue to which all documents
faxed in are to be routed. If this
entry is not entered, no routing is
performed.
FAXOUT FIT TO WIDTH
Sets a flag that specifies whether to
scale an image to fit an 8.5” width
prior to the fax out.
Y Scale to 8.5” width.
FAXOUT HEADER
Specifies the header to appear on
each page that is faxed out.
Maximum 20 characters
FAXOUT_SLEEP
Sets the polling interval (in
milliseconds) for faxout task requests.
Default 60000
(60 seconds.)
FAXOUT USE PAGE
Indicates whether the header should
N No page header.
4334 7798–006
N Do not scale to 8.5”
width.
7–3
Fax Manager
FAX Value Entry
Description
HEADER
be used on a page that is faxed out.
FONT NAME
Sets the default font for index data,
notes, and annotations. The default
depends on the language version of
the Windows NT operating system.
This name should be set after some
system testing is performed.
GFAX FAXIN SLEEP
Sets the polling interval (in seconds)
for the faxin queue.
GFAX PHONE
NUMBER
Indicates the Fax Manager phone
number in nnn.nnn.nnnn format.
GFAX QUEUE
REMOVE
Indicates whether received
documents are deleted from the fax
queue.
Values
Y Use page header.
Default 30
NO
Received
documents are not
deleted from the
fax queue.
YES Received
documents are
deleted from the
fax queue.
Sets the maximum number of retry
attempts to open the Fax Sent List of
the GammaFax queue.
Minimum 2
GFAX_RETRY_DELAY
Sets the frequency (in minutes) of the
GFAX_RETRY entry.
Default 10 (Minutes)
ID
Sets the fax logon ID.
INDEX
Specifies whether documents faxed
into the system:
GFAX_RETRY
• Are indexed with fax transmission
information, namely, customer
service ID, time and date, and port
information.
Maximum 30
Default 6
Y Yes
N No
(See FAXINDEX subkey.)
• Are named with fax transmission
information, namely, prefix, date,
customer service ID, and time.
INFF_REVISION
7–4
Indicates the INFF (Icons, Notes,
Form data, Foreign object) revision
number. The INFF revision number is
defined in the workstation software
Default 4 (current
revision)
Do not modify.
4334 7798–006
Fax Manager
FAX Value Entry
Description
Values
defined in the workstation software.
LOGIN_SLEEP
Sets the number of milliseconds to
pause between logon retries.
Default 30000
(30 seconds)
MAX FAXIN PAGE
LENGTH
Specifies the maximum length (in
inches) of incoming faxed pages. An
incoming faxed page that exceeds this
length will be truncated.
Maximum 36
MAX_FAXOUT_
RETRIES
Species the maximum number of
retries to fax out documents.
Default 3
MIN_FAX_DISK_
SPACE
Specifies the minimum (in KB) disk
space required.
Default 2000
NETWORK_NAME
Sets the name used on the network; it
should match the SERVER entry in the
COMMON subkey.
Default FAX
PASSWORD
Sets the fax logon password.
TEMP FILES
Sets the directory path for temporary
files that are created.
WORKSET
Sets the name of the faxout workset
in the route.
4334 7798–006
Default 24
The default value is the
current directory.
7–5
Fax Manager
FAXINDEX
Value Entry
CSID
Description
Values
Specifies the index field on a form that will
contain the customer service ID from a
document faxed into the system. The field
must have a minimum width of 20
characters.
If the INDEX is set to Y, this field is used in
the document name. All leading and
trailing blanks are stripped.
DATE
Specifies the index field on a form that will
contain the fax transmission date from a
document faxed into the system. The field
must have a minimum width of 12
characters.
If the INDEX is set to Y, this field is
used in the document name.
PORT
Specifies the index field on a form that will
contain the port information from a
document faxed into the system. The field
must have a minimum width of 1
character.
PRFX
Specifies a four-character string used to
pad the workitem name of a document
faxed into the system. The purpose of
this value entry is to distinguish
documents that have been indexed
during an inbound FAX transmission
from those that are not.
Default CSID
If the INDEX is set to Y, this field is used in
the document name.
This value is used instead of the name
specified in the FAX IN BASE NAME
value.
TIME
Specifies the index field on a form that will
contain the fax transmission time from a
document faxed into the system.
If the INDEX is set to Y, this field is used in
the document name.
7–6
4334 7798–006
Fax Manager
FAXIN_LOG
Value Entry
Description
Values
ALARM
Stores the setting for the log window
alarm.
0 Off
1 On
DISPLAY
Stores the setting for the log window
display.
0 Do not display
1 Display
MESSAGES
Stores the type of messages displayed in
the process log window.
DET
DEB
EVE
SUM
SQL
TIM
TRA
WAR
There can be multiple values listed,
separated by a comma. For example:
SUM,EVE,DET,TIM,SQL
POSITION
Stores the log window size.
SAVE
Sets whether the contents of the log
window are saved to a file on disk.
Detail
Debug
Event
Summary
SQL syntax
Time stamp
Trace
Warning
0 Do not save
1 Save
FAXOUT_LOG
Value Entry
Description
Values
ALARM
Stores the setting for the log window
alarm.
0 Off
1 On
DISPLAY
Stores the setting for the log window
display.
0 Do not display
1 Display
MESSAGES
Stores the type of messages displayed in
the process log window.
DET
DEB
EVE
SUM
SQL
TIM
TRA
WAR
There can be multiple values listed,
separated by a comma. For example:
SUM,EVE,DET,TIM,SQL
POSITION
Stores the log window size.
SAVE
Sets whether the contents of the log
window are saved to a file on disk.
4334 7798–006
Detail
Debug
Event
Summary
SQL syntax
Time stamp
Trace
Warning
0 Do not save
1 Save
7–7
Fax Manager
Network Communication Keys
The Fax Manager uses the following registry keys to enable network
communications through the TCP/IP protocol:
•
•
•
NETCALL
NETMODULE
NETSETUP
Various InfoImage components may use these registry keys. Section 8
describes the keys for Workflow Domain Subsystem. In this section, we
provide the basic format, along with examples for this specific component.
Please refer to Section 8 if you require further details on the individual
parameters used in a particular key (for example, <parameter >).
Key
Format
Sample Entries
NETCALL
<name>/<API>:<protocol name>,
<protocol info>
*/*:REG_SZ:TCP/IP
NETMODULE
<protocol name>:<module name>
TCP/IP:REG_SZ:PASTCPIP
Note: There must be one
NETMODULE entry for each protocol
specified in the NETSETUP subkey.
NETSETUP
<name><instance>:<protocol name>
FAX2:REG_SZ: TCP/IP
OBJECT
Value Entry
ROOT
7–8
Description
Values
Set to the directory in which the Fax
Manager software is installed. This is used
for temporary files.
4334 7798–006
Fax Manager
System Control
This subkey allows you to determine the version of the software running on
the server.
Value Entry
Description
Values
FAX MANAGER
Indicates the directory in which the Fax
Manager software is installed.
PRODUCT NAME
Indicates the name of the product currently
installed.
Do not modify.
Version
Indicates the current version of the software
running on the server.
Do not modify.
TEXT TO TIFF
Value Entry
Convert Hidden Fields
Description
For remote printing or faxing, enables
the printing or faxing of the fields in all
hidden views of an image.
Values
Key is absent (default)
Print or fax the fields in
hidden views.
N Do not print or fax
hidden views.
FORM FONT NAME
Sets the default font for index data. The
default depends on the language
version of the Windows NT operating
system. This name should be set after
some system testing is per formed.
This value is overridden by
the value in the FONT
NAME entry in the FAX
subkey, if set.
FONT NAME
Sets the default font for notes and
annotations. The default depends on
the language version of the Windows
NT operating system. This name should
be set after some system testing is
performed.
This value is overridden by
the value in the FONT
NAME entry in the FAX
subkey, if set.
4334 7798–006
7–9
Fax Manager
7–10
4334 7798–006
Section 8
Workflow Domain Subsystem
This section describes the registry keys used by the Workflow Domain
Subsystem software to modify system behavior.
<Workflow Domain Subsystem>
This key has the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
\<Workflow Domain>
Value Entry
ACTIVE
Description
Provides the status of the
Workflow Domain
Subsystem.
Values
Y
The Workflow
Domain Subsystem is
active.
N The Workflow
Domain Subsystem is in
active.
4334 2948–005
8–1
Workflow Domain Subsystem
Unless otherwise noted, registry keys for the Workflow Domain Subsystem
have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
\<Workflow Domain>\<Workflow Domain Subsystem>
Default values appear in bold type.
ALIASES
This subkey’s value entries are used to map logical Rendezvous Server names
(as defined in a Workflow Designer route) to actual server names.
Rendezvous worksteps can be assigned to distinct Rendezvous Manager
processes running on different servers. To implement this, Rendezvous
Servers are specified for individual rendezvous worksteps using Workflow
Designer. A default Rendezvous Server can also be specified in Workflow
Designer. The default server is used for those rendezvous worksteps that
have not made an explicit association.
When a Workflow Domain Controller initializes, each rendezvous workstep in
the route is checked for an explicit Rendezvous Server name. If an explicit
name is not found, Route Engine substitutes the default Rendezvous Server.
The process then assumes that the explicit and/or default server names may
be logical, rather than actual, server names, and the registry is checked for
corresponding logical-to-actual translations (aliases). Any that are found are
substituted and the results are saved in a modified route file. On demand, the
modified file is downloaded to subsystems and Rendezvous Managers during
their startup.
Value Entry
logical rendezvous server
name
8–2
Description
See above.
Values
explicit server name
4334 2948–005
Workflow Domain Subsystem
COMMON
This subkey contains value entries to indicate the server name and other
common values.
COMMON
Value Entry
Description
ACCEPT_NEW_
WORK
Allows or prevents work from
being released to the
Workflow Domain
Subsystem.
Values
Y
Accept new work.
N
Do not accept new work.
Only Workflow Domain
Controller requires this
ARCHIVE
Specifies the name of the
Archive Controller to which
workitems in the Workflow
Domain are sent.
Required on all nodes
Name specified during
installation.
NONE (reserved) if no archive
name was specified during
installation.
If you have Archive worksteps
defined in the workflow, you
must define a valid ARCHIVE
value. Otherwise, Route
Engine will not start.
Eight characters maximum
Indicates whether this
Workflow Domain Subsystem
is the Workflow Domain
Controller.
1
Workflow Domain
Controller
DATABASE
Sets the name of the ODBC
data source.
32 characters maximum,
uppercase
DB_MULTITHR
EADED
Indicates whether the access
to the ODBC driver is singlethreaded or multi-threaded.
1
Multi-threaded
0
Single-threaded
DOMAIN
The name of the Workflow
Domain.
Name specified during
installation.
Required
Eight characters maximum
CONTROL
4334 2948–005
0
Not Workflow Domain
Controller
8–3
Workflow Domain Subsystem
COMMON
Value Entry
INDEX
Description
Specifies the name of the
server running Index
Manager.
Values
Name specified during
installation.
Eight characters maximum
Required
LOCATOR
Specifies the name of the
server running Location
Manager.
Name specified during
installation.
Eight characters maximum
Required
LOG_DIR
Sets the directory path for the
process log and debug files. If
this entry is blank, the .LOG,
.DBG, and .STS files are
stored in the \SYS directory.
For example, .db0, .db1.
A directory path.
LOG_FILE_SIZE
Sets the maximum size for an
individual file in KB. If the
number specified is less than
64KB, then 64KB is used.
Minimum 64
The password of the mail
user.
Blank
MAILPASSWOR
D
Default
1024
Note:
The password is
encrypted using Win 32
Crypto API and the InfoImage
key.
MAILPROFILE
The user ID (profile name)
with which the user will log
on to the system.
Blank
MAILTHREADS
LEEP
The time interval, in minutes,
the mail thread will wait
before checking for mail.
5
NETTRACE
Enables the trace mechanism
used for debugging.
0
No trace
1
Function tracing
2
Data tracing
Note: In a production
environment, always set this
value to 0, as detailed tracing
slows down the system
significantly. Tracing should
only be used for debugging.
8–4
3 Both function and data
tracing
4334 2948–005
Workflow Domain Subsystem
COMMON
Value Entry
Description
NUM_BACKUP_
LOG_FILES
Sets the desired number of
backup log, debug, and status
(.LOG, .DBG, .STS) files.
Minimum 1
ODBCDEFAULT
POOL SIZE
Sets the handle pool size of a
process if the process does
not have an entry under the
ODBCSETUP subkey. The
original ODBC POOLSIZE
under the COMMON subkey
should be replaced with this
parameter.
Minimum 1
Sets the logon password for
the supported database.
Name specified during
installation.
Required
Eight characters maximum
Specifies the name of the
server running the Security
Manager.
Name specified during
installation.
PASSWORD
SECURITY
Values
Maximum 10
Maximum > 1
Default 20
Eight characters maximum,.
Required on the Workflow
Domain Controller only
SERVER
Sets the name for this
Workflow Domain Subsystem
on the network.
Name specified during
installation.
Eight characters maximum
Required. Must be unique
across all Workflow Domains
that have network
connectivity.
4334 2948–005
8–5
Workflow Domain Subsystem
COMMON
Value Entry
UNIFIED
LOGON
Description
Sets whether Windows NT
Unified Logon is enabled or
disabled.
Values
Y
Enabled
N
Disabled
Only the Workflow Domain
Controller requires this only.
Note: The Workflow Domain
software determines Unified
Logon. For more information
about Unified Logon, see the
section titled “Setting Up
Unified Logon” in the
Installation and Configuration
Guide.
USERID
8–6
Sets the logon User ID for the
supported database.
Name specified during
installation.
Required.
Eight characters maximum.
4334 2948–005
Workflow Domain Subsystem
DBV
This subkey contains value entries specific to the DB Vista.
DBV
Value Entry
USERNAME
Description
Sets the logon User ID for
DB Vista.
Values
Default
Dbvuser
Default
dbv
This is required by
Workflow Domain
Controller only.
PASSWORD
Sets the logon password
for DB Vista.
Only the Workflow Domain
Controller requires this.
IIFCATUU
This subkey contains value entries specific to the Update Utility.
IIFCATUU
Value Entry
DBVREFRSHTI
ME
4334 2948–005
Description
Sets the time interval
between polls for DB Vista.
Values
Default
5
8–7
Workflow Domain Subsystem
INDEX
This subkey contains entries specific to the Index Manager.
INDEX Value
Entry
CREATE_LOCA
TOR_REORD
Description
Used to create Catalog
entries for non-archived
workitems (Enterprise
Visibility)
Values
0 Location Manager is not
called, catalog record is not
written, the result of
Workflow Domain index
creation is returned to caller.
1 Index Manager creates a
workitem when called to
create a Workflow Domain
index for a workitem, then
calls Location Manager, which
then calls the Catalog to
create Catalog records for
non-archived workitems.
EXCEPTION_CL
ASS_LIST
8–8
Specifies the action to
perform on workitems that
are exceptions to the
INDEX_OPTION setting. For
example, if you set
INDEX_OPTION to DELETE,
index entry of workitems in
classes listed in
EXCEPTION_CLASS_LIST are
updated. Conversely, if you
set the value to UPDATE,
workitems in classes listed in
EXCEPTION_CLASS_LIST have
their index entry deleted.
A valid workitem class name.
The maximum number of
workitem classes (separated
by commas) in the list is 256.
4334 2948–005
Workflow Domain Subsystem
INDEX Value
Entry
Description
Values
INDEX_OPTION
Specifies the action to
perform on the index entry of
a workitem after deletion
from the Workflow Domain.
UPDATE The Index entry is
updated in the Attributes
table when the workitem is
deleted from the Workflow
Domain. The entry will remain
in the Attributes table with
the OBJECT_SERVER column
set to ARCHIVE.
Required entry for the server
where Index Manager
resides.
DELETE The Index entry is
deleted from the Attributes
table when the workitem is
deleted from the Workflow
Domain. If you delete the
index entry of a workitem
from Attributes, the workitem
can be retrieved from archive
only by its name (and not by
its index information).
UPDATE_LOCA
TOR_RECORD
Updates or creates Catalog
entries for non-archived
workitems
0 When Index Manager
receives a call to update a
workitem name (rename) or
class (reclassification), it
updates the Workflow
Domain index and calls
Location Manager, which calls
the Catalog to update or
create a Catalog record. The
workitem name or class is
updated on the Catalog
whether or not the workitem
was archived. If a Catalog
record does not exist, and a
name is now supplied, a new
Catalog record is created.
1 Location Manager is not
called, no catalog record is
written or updated, and the
result of the Workflow
Domain index update is
returned.
4334 2948–005
8–9
Workflow Domain Subsystem
INTERNAL
This subkey contains value entries for the version of the catalog software.
INTERNAL
Value Entry
LOCATORVER
Description
Values
Defines the Catalog software
version. Entries are
hexadecimal.
This is an internal variable and
should not be modified.
0x10136 - Versions 3.1 and
3.2 where:
Enterprise Locking = ON
Enterprise Visibility = OFF
0x30136 - Versions 3.1 and
3.2 where:
Enterprise Locking = ON
Enterprise Visibility = ON
SERVER_UNK_C
OMPAT_VER
8–10
Only the Workflow Domain
Controller requires this.
Do not modify.
This entry is for internal use
only.
4334 2948–005
Workflow Domain Subsystem
INTERNAL
Value Entry
SERVER_DCG_
COMPAT_VER
Description
Enables compatibility
between version 4.0 Rapid
Batch Entry (RBE)/Document
Generator clients and the
version 5.0 server software.
Values
Default
3.200
Default
3.200
Default
3.200
One of three registry entries
that are required to make
InfoImage 4.0 version clients
compatible with the
InfoImage 5.0 version
Workflow Domain
Subsystem.
Note: If you select INSTALL for
Workflow Domain Subsystem,
setup automatically creates the
registry entries.
If you select UPGRADE for
Workflow Domain Subsystem,
you must manually create the
entries. An upgrade copies only
the .EXE and .DLL files.
SERVER_HVS_
COMPAT_VER
Enables compatibility between
version 4.0 Imaging High Volume
Scanner clients and the version
5.0 server software.
See also the description for
SERVER_DCG_COMPAT_VER.
SERVER_WKS_
COMPAT_VER
Enables compatibility between
version 4.0 workstation clients
and the version 5.0 server
software.
See also the description for
SERVER_DCG_COMPAT_VER.
4334 2948–005
8–11
Workflow Domain Subsystem
LOCATOR
This subkey contains value entries used by Location Manager.
LOCATOR
Value Entry
DATABASE
Description
Indicates the ODBC DSN
name of the database in
which the Relational
Catalog is stored.
Values
Default
CATALOG
Required only if you are
using the Relational
Catalog.
DETAIL_REPORT
Used for Enterprise
Visibility.
0
The loctrans.dat file is
not written
1
Every successful
Locator update has an audit
line written to the
loctrans.dat file. The
information listed includes
type of update (replace, add,
or delete), ID, name, class
data type and timestamp.
PASSWORD
Sets the password for
access the Relational
Catalog.
TEMP LOCATOR
The name of the file that
Location Manager uses for
Temploc functionality.
Used for Enterprise
Visibility.
#THREADS
USERID
8–12
Any file name is valid.
Default
The name of the Error
Temploc is always
TEMPLCM.ERR.
Default
Sets the User ID for
access to the Relational
Catalog.
TEMPLCM
10
Blank
4334 2948–005
Workflow Domain Subsystem
Network Communication Keys
The Workflow Domain Subsystem uses the following registry keys to enable
network communications through the TCP/IP protocol:
•
NETCALL
•
NETCONFIG
•
NETLISTEN
•
NETMODULE
•
NETSETUP
NETCALL
The value entries in this subkey are used to configure the protocol and
protocol adapter number that each process API uses to initiate an outbound
conversation.
TCP/IP Format
<name>/<API>:<protocol name>,<protocol info>
where:
name
is a specific Workflow Domain Subsystem name
(may include an asterisk (*) as a match character).
API
is a three-character API (or an asterisk (*) to
specify any API)
protocol name
is the protocol name.
protocol info
is the network protocol information, if any is
required.
4334 2948–005
8–13
Workflow Domain Subsystem
Sample TCP/IP entries
*/*:REG_SZ:TCP/IP,0
*/IDX:REG_SZ: TCP/IP,0
*/LOC:REG_SZ:TCP/IP,0
*/QUE:REG_SZ:TCP/IP,0
*/OBJ:REG_SZ:TCP/IP,0
*/OTP:REG_SZ:TCP/IP,0
*/SSN:REG_SZ:TCP/IP,0
*/WRK:REG_SZ:TCP/IP,0
NETCONFIG
Value Entry
COMMAND_BUFFER_SIZE
Description
Sets the size in bytes of the
command buffer for Network
Services information.
Values
Minimum 2048
Maximum 32767
NETLISTEN
The value entries in this subkey are used to configure the threads, protocol,
and protocol adapter on which the process APIs listen.
8–14
4334 2948–005
Workflow Domain Subsystem
TCP/IP Format
<process name><API><instance>:<protocol
name>,<threads>,RESERVED,<Workflow Domain Subsystem>
where:
process name
API
instance
protocol
name
threads
RESERVED
Workflow
Domain
Subsystem
indicates the name of the process (Index, Locator,
Object, Rendez, SecMgr, Route, Transfer)
is the three-character API name (QUE, SSN, WRK,
OBJ, OTP, IDX, XFR, LOC, SEC, RND).
is a number starting at 1 and incremented for each
protocol.
is the name of the network protocol.
are the number of listen threads for this API.
is reserved for future software enhancements.
Is the name of the Workflow Domain Subsystem.
Sample TCP/IP entries
INDEXIDX2:REG_SZ:TCP/IP,18,RESERVED,SERVER1,
LOCATORLOC2:REG_SZ:TCP/IP,5,RESERVED,SERVER1,
OBJECTOBJ2:REG_SZ:TCP/IP,20,RESERVED,SERVER1,
OBJECTOTP2:REG_SZ:TCP/IP,8,RESERVED,SERVER1,
OMNIKRNL2:REG_SZ:TCP/IP,4,RESERVED,SERVER1,
RENDEZRND2:REG_SZ:TCP/IP,1,RESERVED,SERVER1,
ROUTEQUE2:REG_SZ:TCP/IP,20,RESERVED,SERVER1,
ROUTESSN2:REG_SZ:TCP/IP,8,RESERVED,SERVER1,
ROUTEWRK2:REG_SZ:TCP/IP,4,RESERVED,SERVER1,
SECMGRGRP2:REG_SZ:TCP/IP,2,RESERVED,SERVER1,
SECMGRSEC2:REG_SZ:TCP/IP,7,RESERVED,SERVER1,
TRANSFERXFR2:REG_SZ:TCP/IP,1,RESERVED,SERVER1,
The comma after the Workflow Domain Subsystem is necessary for the
functioning of the Workflow Domain Subsystem.
4334 2948–005
8–15
Workflow Domain Subsystem
Increasing NETLISTEN Threads
Increasing NETLISTEN threads allows more clients to be served simultaneously.
Increasing the NETLISTEN threads, however, consumes resources (for example,
memory for stack) and requires service from Windows NT’s scheduler.
NETMODULE
The value entries in this subkey are used to configure the modules for the
protocols specified in the NETSETUP subkey. There must be one entry for
each protocol specified in the NETSETUP subkey.
Format
<protocol name>:<module name>
where:
protocol name
is the name of the protocol.
module name
is: TCP/IP module = PASTCPIP
APPC module = PASAPPC
Sample entries
APPC:REG_SZ:PASAPPC
TCP/IP:REG_SZ:PASTCPIP
NETSETUP
The value entries in this subkey are used to configure the protocols (TCP/IP or
APPC) and network resources for each process running on theWorkflow
Domain Subsystem.
TCP/IP Format
<name><instance>:<protocol name>
where:
8–16
name
is the Workflow Domain Subsystem process name.
instance
is a number starting at 1 and incremented for each protocol.
protocol name
is the name of the protocol (TCP/IP).
4334 2948–005
Workflow Domain Subsystem
The NETSETUP key for Update Utility is required on Workflow Domain
Controller only.
Sample TCP/IP entries:
INDEX2:REG_SZ:TCP/IP
LOCATOR2:REG_SZ:TCP/IP
OBJECT2:REG_SZ:TCP/IP
OMDAPI2:REG_SZ:TCP/IP
OMNIKRNL2:REG_SZ:TCP/IP
RENDEZ2:REG_SZ:TCP/IP
ROUTE2:REG_SZ:TCP/IP
SECMGR2:REG_SZ:TCP/IP
SYSCTL2:REG_SZ:TCP/IP
TRANSFER2:REG_SZ: TCP/IP
OBJECT
This subkey contains value entries used by Object Manager.
OBJECT Value
Entry
Description
Value
ARC_AGE
Indicates the number of days
elapsed since a workitem was
last modified before it can be
archived.
7
ARC_SLEEP
Indicates, in seconds, how long
Object Manager pauses
between checks for workitems
to archive.
Minimum
(one minute)
Note:
The ARC_SLEEP
entry should be set to the
longest interval possible, as
there may be overhead
associated with background
archival.
Default 1800 (30
minutes)
4334 2948–005
60
Maximum
8–17
Workflow Domain Subsystem
OBJECT Value
Entry
Description
Value
DEFAULT QUEUE
Specifies the name of the
workstep into which objects
received from another
Workflow Domain are
enqueued.
Work Introduction
DEL_AGE
Sets the number of days after
which you can delete a
workitem.
Default
DEL_AGE_ARCHIVE
Sets the number of days after
which a workitem retrieved
from archive is deleted. If no
value is specified, a workitem
retrieved from archive is
deleted according to the value
in the DEL_AGE or DEL_AGEnn
entry
Note:
If you enter
a value for this entry,
the system creates a
DELARCH deletion
group.
DEL_AGEnn
Sets the number of days after
which a workitem in
DELGRPnn can be deleted.
Default The
DEL_AGE value
DEL_CRITERIA
Sets the comparison criterion
for the DEL_AGE entry.
MODIFY Uses the
date a workitem was
last modified as the
comparison criterion.
7
CREATE Uses the
date a workitem was
created as the
comparison criterion.
REFERENCE Uses
the date a workitem
was last referenced
(accessed) as the
comparison criterion.
8–18
4334 2948–005
Workflow Domain Subsystem
OBJECT Value
Entry
DEL_CRITERIAnn
Description
Value
Sets the comparison criterion
for the DEL_AGEnn entry.
MODIFY Uses the
date a workitem in
DELGRPnn was last
modified as the
comparison criterion.
CREATE Uses the date
a workitem in
DELGRPnn was
created as the
comparison criterion.
REFERENCE Uses
the date a workitem
in DELGRPnn was
last referenced
(accessed) as the
comparison criterion.
DEL_FAST_START
DELGRPnn
Sets whether deletion daemon
runs 1 minute after Object
Manager starts. When used,
used primarily in test or pilot
situations.
Y
Causes the deletion
daemon to run 1
minute after Object
Manager is started.
N
Object Manager
waits the amount of
time defined by
DEL_SLEEP before
running the deletion
daemon.
Defines workitem deletion
groups. Up to 20 different
groups may be defined.
Workitem groups are
defined by one or more
class names. The class
name can include the
wild card character (%)
to define matching
groups of classes. For
example:
DELGRP01:ACCNT1
DELGRP02:CUST,INVOICE
%
4334 2948–005
8–19
Workflow Domain Subsystem
OBJECT Value
Entry
Description
Value
DEL_MIN_REF_AGE
Sets the minimum number of
hours a workitem must be on a
server before it is eligible for
deletion.
Default 1
DEL_SLEEP
Indicates the polling interval, in
seconds, for Object Manager
when it checks for workitems to
delete.
Minimum 1
Default 1800 (30
minutes)
Note: DEL_SLEEP should be set
to the longest interval possible, as
there may be overhead associated
with background deletion.
DEL_SLEEPnn
DOARCHIVE
DODELETE
NODEID
8–20
Indicates the polling interval, in
hours, for Object Manager when it
checks for workitems in
DELGROUPnn to delete.
Minimum 1
Enables background archival of
workitems that are not in
workflow (for example, workitems
retrieved from the File Cabinet).
Y
Enable background
archival.
N
Do not enable
background archival.
Default The value in
the DEL_SLEEP
entry.
Enables background deletion of
workitems not in workflow (for
example, workitems retrieved
from the File Cabinet).
Y Enable background
deletion.
Indicates the identifier used in
the Object Manager workitem
ID for Workflow Domain clientcreated workitems. Required.
A unique fourcharacter identifier. It
must be unique on
each Workflow
Domain Subsystem
(and each work item
generator) in the
enterprise. Case
insensitive; entries
are always converted
to upper case.
N Do not enable
background deletion.
4334 2948–005
Workflow Domain Subsystem
OBJECT Value
Entry
NUM DIRS
Description
Indicates the number of data
directories in which to save
objects on the Workflow
Domain Subsystem. If NUM
DIRS is specified, the
OBJ_DIRn entry must also be
specified. If NUM DIRS is not
specified, the data directory
specified in the ROOT entry is
used.
Value
Minimum 1
Maximum 999
Default 3
The number of data directories is
specified at installation time.
OBJ_DIRn
Specifies a path and directory
name for each NUM DIRS in the
previous row.
The format is OBJ_DIRn:
path,max files,max KB.
Default Maximum File
Number 12000
Default Maximum
Directory Size (KB)
534237
If the maximum number of files
has been reached in some of the
directories, all subsequent files
are placed in directories that have
not reached the maximum files.
If all directories have reached the
maximum files, then the
Workflow Domain Subsystem
continues to accept work and
distributes the files across all
directories.
If a directory has reached the
maximum, then no more files are
added, even if the maximum has
not yet been reached. If the
Workflow Domain Subsystem
has less then 2 MB of free space
on the disk, then it no longer
accepts new work.
OBJECT DATE
Used by Object Manager.
Do Not Modify.
ROOT
Sets the data directory name
and path. Required.
Application specific.
The convention is
PATH\DATA.
4334 2948–005
8–21
Workflow Domain Subsystem
ODBCSETUP
This subkey contains value entries that indicate the maximum number of
concurrently open database connections.
Value Entry
CACodbc
Description
This is an ODBC connection
string that consists of
Name=Value pairs separated by
semicolons.
Consult the table that follows
for a detailed explanation of the
Name=Value pairs.
<process name>
The value indicates the
maximum number of
concurrently open database
connections allowed for a
specific process, and
corresponds to the process, as
follows:
Index Manager INDEXMGR
Location Manager LOCMGR
Object Manager
OBJECT
Values
CACodbc has a
default value of:
Provider=MSDASQL;
DRIVER=SQL
Server;
SERVER=servname;
DATABASE=CAC2000;
UID=user;
PWD=xxxxx
The value of the
parameter can be
different for each
process, but the total
number of
connection handles
for all processes
must not exceed the
number of
connection handles
allowed by the
DBMS.
Route Engine RTENGINE
Examples:
Security Manager
SECMGR
INDEXMGR
10
OBJECT 20
RTENGINE
20
RTENGINE
20
SECMGR 5
The CACodbc String
Name
PROVIDER=
Description
Name of the OLE DB DLL the
Workflow Domain Subsystem
will use to connect to the
CAC database.
Value
MSDASQL
For Oracle 8i: MSDAORA
(provided by Microsoft)
Required.
8–22
4334 2948–005
Workflow Domain Subsystem
Name
DRIVER=
Description
Name of the ODBC driver.
Value
Enter values as shown in
bold:
Microsoft
SQL Server
(default)
Sybase
Driver
SQL Server
ASE ODBC
Oracle
Microsoft ODBC
for Oracle (Microsoftprovided)
SERVER=
The name of the CAC
database server for Microsoft
SQL Server and Oracle users.
Note: For Oracle 7.x
databases, SERVER name
must be the same as the
profile for the CAC database
instance defined in the
Tnsnames.ora file.
For a typical production
environment, where the
CAC2000 database is on a
different server than the
Workflow Domain
Subsystem, replace
servname with the name of
the CAC database server, as
follows:
Microsoft SQL Server
Enter the network server
name where the CAC
database is stored.
Oracle
Enter the Net8 Net Service
Name. See note. We strongly
recommend that you use the
value CAC2000.
If the CAC2000 database is
stored on the same server as
the Workflow Domain
Subsystem (such as for a
demonstration system), set to
LOCAL instead of the server
name.
SRVR=
4334 2948–005
For Sybase users, the name
of the CAC database server.
Replace xxxxx with the
Sybase server name.
8–23
Workflow Domain Subsystem
Name
DATABASE=
Description
Name of the CAC database.
Value
CAC2000 (default)
Required for both Microsoft
SQL and Sybase databases.
When using an Oracle
database, remove this
parameter from the string.
DSN=
Indicates that a Server Cursor
is used.
Required for Sybase users
only.
UID=
User name to log on to the
CAC database.
Required.
PWD=
Password to log on to the
CAC database.
CAC2000 or SYBASE
Example CACodbc entry for
Sybase:
DSN=CAC2000;UID=sa;PWD
=sa;
Replace user with the user
name to log on to the CAC
database.
Replace xxxxxx with the
password associated with the
user name.
OMDAPI
Value Entry
EnableOLEMarkups
Description
Values
Specifies whether OLE
markups should be enabled.
1 Enable OLE markups.
RequestQueue
Specifies Request queue
name. Not currently used.
Default REQUEST
STAT LOG PATH
Indicates the status log file to
which the client engine logs
status information.
0 Disable OLE markups.
PROCESS NAME_LOG
There can be multiple “process name” logs. The format for each subkey
name is PROCESS NAME_LOG, where process name is any one of the
Workflow Domain Subsystem processes (for example, OBJECT_LOG,
RTENGINE_LOG).
8–24
4334 2948–005
Workflow Domain Subsystem
The subkey(s) contain these value entries.
Value Entry
ALARM
DISPLAY
MESSAGE
QUEUE SIZE
Description
Stores the setting for the log window
alarm.
0 Off
Stores the setting for the log window
display.
0 Do not display
This value entry is only required if a
process is generating more log
messages than can be handled,
resulting in a frozen user interface.
Messages can be generated faster
than they can be displayed, depending
on the configuration and processor.
When more messages are waiting to
be displayed than the value of
MESSAGE QUEUE SIZE, then certain
messages are not displayed in the log
window, but are written to the log file.
Default 50
Note: The value of MESSAGE
QUEUE SIZE depends on CPU speed
and memory, as well as the typical
workload and type of messages
selected for the process log window.
MESSAGES
Values
1 On
1 Display
Set to a value less than
50 to have diagnostic
messages (Detail, SQL,
Timing, Debug, and
Trace) written only to the
log file and not displayed
in the log window. In this
case, the Critical,
Summary, Event, and
Warning messages will
continue to be displayed
in the log window as well
as written to the log file.
Stores the type of messages
displayed in the process log window.
DET
DEB
Detail
Debug
Multiple values can be listed,
separated by a comma. For example:
EVE
Event
SUM,EVE,DET,TIM,SQL
SQL
SQL Syntax
TIM
Time Stamp
TRA
Trace
SUM Summary
WAR Warning
POSITION
Stores the log window size.
SAVE
Sets whether the contents of the log
window are saved to a file on disk.
4334 2948–005
0
Do not save
1 Save
8–25
Workflow Domain Subsystem
RNDZMGR
This subkey contains value entries used by Rendezvous Manager.
Value Entry
ALLOW
DUPLICATE
INSERTS
Description
Specifies how to handle an
attempt to file a candidate
into a container that already
contains that candidate.
Values
Y A warning message is
displayed, but processing
continues (the rendezvous
succeeds, but the candidate
is not reinserted).
N An attempt to file a
candidate into a container
that already contains that
candidate is processed as
an error; both the candidate
and the container are
placed into error status.
BACKUP LOG FILE
NAME
Sets the name of the
backup exception log file.
rndzmgr.bak (default)
LOG FILE NAME
Sets the name of the log
file used to store exception
information.
rndzmgr.sts (default)
SLEEPTIME
Sets the polling interval (in
minutes) for Rendezvous
Manager when it checks
for workitems that are
needed at a rendezvous
workstep.
Minimum 15
Maximum 1440
Note:
To ensure that
Rendezvous Manager
detects workitems before
they expire, set
SLEEPTIMES to a value
less than the expiration
condition for all workitems.
TRANSACTION
FILE SIZE
8–26
Sets the maximum size (in
KB) of the exception log
file. When the file reaches
this size, it is copied to the
backup exception log file
and a new log file is
started.
2500 (default)
4334 2948–005
Workflow Domain Subsystem
RPC
This subkey contains value entries used for unified logon processing.
Value Entry
Description
Values
PROTOCOL
Indicates the network protocol
used for unified logon
communication.
TCP/IP
UNIFIED LOGON
ENDPOINT
Indicates the port used by the
UNILOG API
27640
UNIFIED LOGON MAX
CLIENTS
Indicates the maximum number
of unified logon clients.
5
ROUTE
This subkey contains value entries used by the Route Engine.
ROUTE Value Entry
Description
Value
BACKUP LOG FILE
NAME
Sets the path and name of the
backup log file.
rtengine.bak (default)
DATABASE_
SERIALIZATION
Sets how the Route Engine handles
serialization of database operations.
None Route Engine does
not serialize database
transactions and relies on
the underlying DBMS to
handle serialization issues.
Note: The default for Microsoft
SQL Server is WriteOnly. For any
other database environment, set to
ReadWrite.
ReadWrite Route Engine
performs only one
database operation at a
time.
WriteOnly Route Engine
serializes only write
operations and allows
multiple simultaneous
read operations.
DEFAULT
RENDEZVOUS SERVER
4334 2948–005
Defines the default Rendezvous
server that is being used. You can
also specify the default rendezvous
server through Workflow Designer
and this value is stored in the route
file. If you specify this value in Work
flow Designer, the value from the
route file takes precedence over the
value in the registry.
Server name
8–27
Workflow Domain Subsystem
ROUTE Value Entry
ERROR_IF_NO_
RULES
Description
Value
Sets whether a routed workitem that
encounters no post-processing rules
that evaluate as TRUE (i.e. no default
rule is specified) is placed into error
at the current workstep.
0 Route Engine reports
error QUEUE_ERR_
RETRY_ROUTE and
message No workflow
routing rules apply to
this workitem. The
internal state of the
workitem is preserved
as what it was prior to
route attempt.
1 Workitem is put into
error at current
workstep.
EXECUTION_MODE
Sets whether trap information is
captured.
PRODUCTION
The system dumps state
information, including a
stack trace and register
values, to a debug log.
DEBUG
Trap information is not
captured, and the
exception is dispatched to
a debugger.
INBOXFORM
Enables the InBox view at the
DMWS workstation. The value sets
the class name (case sensitive) of
the form containing an InBox view,
or the name of the “master” form if
multiple forms with InBox views are
being used.
A valid workitem class
name. INBOXFORM must
be set to the same value
at all Workflow Domain
Subsystems in the
Workflow Domain.
This entry is not used for Client
Work Manager workstations.
LAST_LOG_EXPORT_DA Defines the date that last exported
TE
into a file. This is an internal entry.
8–28
Do not modify.
4334 2948–005
Workflow Domain Subsystem
ROUTE Value Entry
LISTALL_CACHE_LIFETI
ME
Description
Sets cache refresh frequency in
seconds.
Value
Minimum 0
Maximum 300
Default 60
If set to 0, a database
query is run every time a
user opens their InBox in
ListAll mode.
Use with caution.
Configuring short refresh
periods will cause
database queries to be
executed more often,
degrading database
performance. Must be set
to the same value for all
servers in the Workflow
Domain.
LOG_ALL_EVENTS
Sets whether all routing events are
logged in the Log table in the
database.
0
Note: When LOG_ALL_EVENTS is
set to 0, events related to Workflow
Domain information, workflow
history, dequeue, and obtaining
variable data operations are not
logged.
Do not log all
events. The
following events,
related to Workflow
Domain information,
workflow history,
dequeue, and
obtaining variable
data operations, are
not logged to the
LOG table or the
Route Engine log
window:
DEQUEUE
CANCEL
WORKFLOW
HISTORY REQUEST
GET VARIABLE
DISABLE USER
1
LOG FILE NAME
4334 2948–005
Log all events.
Specifies the name of the log file used rtengine.sts (default)
to store exception log information.
8–29
Workflow Domain Subsystem
ROUTE Value Entry
OBJKEEPALIVE
PREPROC_QUEUE_R
ATIO
Description
Value
Circumvents the requirement of
having Object Manager running with
Route Engine on any Workflow
Domain Subsystem in the Workflow
Domain. Currently the Workflow
Domain Controller listens for keepalive messages from both Route
Engine and Object Manager on a
server in the Workflow Domain. If
the Workflow Domain Controller
does not “hear” from both, it
assumes the server is inactive.
YES
Sets the number of Route Engine
threads that are started to handle
workstep pre-processing.
Minimum 2
NO Eliminates the failure
of calls to the Object
API.
Maximum
The number of queue
listen threads. This
number is the ratio of
queue listen threads to the
number of pre-processing
threads. For example, if
you have 20 queue listen
threads and this entry is
set to 5, the result will be
4 pre-processing threads.
QUEUE_ERROR_RETRY
Sets the number of retries the batch
thread can use to process batches
5
ROUTE
Sets the name of the route to run.
Required on the Workflow Domain
Controller.
Default
ROUTING
Determines whether folder routing is
enabled for this Workflow Domain
Subsystem.
Same name as route file
(without the .RTE extension)
that will be used on the
Workflow Domain.
FOLDER
Enable folder
routing.
BATCH
Disable folder
routing.
Note: This entry must be the
same for all Workflow Domain
Subsystems in a Workflow
Domain.
SAVE HISTORY
8–30
Sets whether the routing history of
a workitem is saved in a note with
the workitem.
DEMO
0
Do not save history.
1
Save history.
4334 2948–005
Workflow Domain Subsystem
ROUTE Value Entry
Description
Value
the workitem.
SCRIPT_TIMEOUT_CYC
LE
Specifies how much time, in
seconds, will elapse between
timeout thread cycles before a
script is aborted. This is a numeric
value between 15 and 60 inclusive.
Default 15
SCRIPT_TIMEOUT_MUL Percentage to be applied to a script
T
timeout value. This is expressed as
a positive whole number. For
example, a value of 100 equals
100%, in which case, the actual
timeout value of each script will be
100% of the stated timeout value.
The default is 100.
Default 100
SHOW_SCRIPT_LOGS
0
Suppress the
messages from the
Route Engine log.
1
Cause messages to
be added.
Determines whether messages
passed to the Sys.Log method will
be added to the Route Engine log.
Sys is an object in the Workflow
Object Model.
Default 0
SERVER_HVS_
COMPAT_VER
Internal use.
Do not modify.
SERVER_DCG_
COMPAT_VER
Internal use.
Do not modify.
SERVER_WKS_
COMPAT_VER
Internal use.
Do not modify.
SERVER_UNK_
COMPAT_VER
Internal use.
Do not modify.
SETUP
Application data.
Do not modify.
4334 2948–005
8–31
Workflow Domain Subsystem
ROUTE Value Entry
STARTUP_WORKSET_
SEARCH
Value
Enables the creation of workset
caches during Route Engine
initialization, instead of when the first
workset request is received.
YES
Enable workset
cache creation at
Route Engine
initialization.
This entry should be set to NO to
improve performance, except in
environments where many users log
on to the system (in ListNext mode)
at the same time and would
experience additional delays when
first opening their InBoxes.
NO
Do not enable
workset cache
creation at Route
Engine
initialization.
STRICT_CHECK_
WORKFLOW
0
Sets whether strict type checking is
performed for certain queue functions.
1
TIMEOUT_INTERVAL
Sets the polling interval (in minutes)
for the Route Engine to check for
expired workitems in Rendezvous
queues or any queues that
participate in date/deadline workflow
events.
TRANSACTION
FILE SIZE
8–32
Description
No type checking.
Perform type
checks on all
workstep and
workset types in
queue functions to
prevent
incompatible cases.
60
Sets the maximum size (in KB) of
the log file. When the log file
reaches this size, it is copied to the
backup log file and a new log file is
started.
4334 2948–005
Workflow Domain Subsystem
RRMAIN
This subkey contains value entries for Remote Request Manager.
Value Entry
Description
Values
BACKUP_NAME
Specifies the path and name of the
Remote Request Backup file. For
recovery purposes, it should be stored
on a drive different from the one
housing the original file.
Backup.fil
FILE_NAME
Sets the path and name of the remote
request file to which the Remote
Request Manager program writes.
Remote.fil
TP_NAME
Specifies the name of the transaction
program started on the server by a host
application.
RRMAIN
Security
This subkey contains value entries for Security Manager.
Value Entry
CACHE_SIZE
Description
Values
Sets the number of security profiles
cached for each server process.
00
TEMP_DIR
Sets the directory path for temporary
files used by Security Manager.
..\sys
TIMEOUT
Sets the maximum time-out (in minutes)
for obtaining data to build a security
profile.
2
4334 2948–005
Displayed as 0xC8,
hexadecimal.
8–33
Workflow Domain Subsystem
System Control
This subkey allows you to determine the version of software running on the
server.
Value Entry
Description
Values
PRODUCT NAME
Indicates the name of the product
currently installed.
Do not modify.
Version
Indicates the current version of the
software running on the server.
Required.
Do not modify.
In addition to these value entries, the System Control subkey contains an
entry for each component (Workflow Domain Subsystem, Index Manager, and
so forth) installed on the device. Values for each of these entries indicate the
name of the directory where the component is installed.
TRANSFER
This subkey contains value entries used by Transfer Manager.
TRANSFER Value Entry
ARCHIVE ALL
CHILDREN
ARCHIVE_THREADS
Description
Values
Specifies the outcome of
archiving a folder when any
one WIP-in-WIP child
workitem fails to archive.
Y The folder archive
fails if any one WIPin-WIP child workitem
fails archiving.
If this value entry is not added
to the registry and set to Y,
the system assumes the
value is set to N.
N The folder is archived
even when the WIPin-WIP children fail to
archive.
Indicates the number of
archive threads to be started.
Minimum 1
Maximum 10
Default
ARCHSLEEP
8–34
Indicates, in seconds, how
long the archive thread
pauses between executions.
2
Minimum 15
Maximum 65535
Default
1800 (30
minutes)
4334 2948–005
Workflow Domain Subsystem
TRANSFER Value Entry
Description
Values
BACKUP_TS_POS
Remote Request Manager
recovery package. Used
internally by Transfer Manager
to store the time stamp of the
backup file.
Default 0
COUNTER
Indicates how many records
in the file created by the
Remote Request Manager
program have already been
processed. This is an internal
variable.
Do not modify.
DELETE_CHILD_OBJ
Specifies whether first-level
child workitems are deleted
when deletion of the parent is
requested. This applies to
folder deletions.
Y Delete the first-level
workitems in a folder
(documents and sub
folders, but not
documents within the
subfolders) when
deleting a folder.
N Do not delete the first
level workitems in
folder when deleting
the folder.
DELETE_THREADS
DELINITSLEEP
DELSLEEP
DOARCHIVE
Indicates the number of
delete threads to be started.
Indicates, in seconds, how
long the deletion thread is
inactive upon start-up of
Transfer Manager. If this entry
is not defined or contains an
invalid value, the deletion
thread will start upon startup
of Transfer Manager.
Minimum 1
Maximum 10
Minimum
0
Maximum
65536
Indicates, in seconds, how
long the delete thread pauses
between each iteration.
Minimum 15
Indicates whether the archive
thread runs.
Y Archive thread
runs.
Default
1800 (30
minutes)
N Archive thread does
not run.
4334 2948–005
8–35
Workflow Domain Subsystem
TRANSFER Value Entry
DODELETE
DOPIPE
DOPROGRAM
8–36
Description
Values
Indicates whether to run the
delete thread that draws tasks
from a deletion queue profile
and deletes the workitem of
the corresponding task record.
Y Delete thread runs.
Indicates whether to run the
pipe thread that takes input
from the file specified in the
RRMAIN subkey, FILE_NAME
entry, and posts tasks in the
external request queue
according to the content of
the file. The Remote Request
Manager (rrmain.exe) writes
the file in response to an
APPC transmission.
Y Pipe thread runs.
Indicates whether workitems
are processed at a program
workstep (a step where a user
exit DLL is defined).
Y Process workitems at
a program workstep.
N Delete thread does
not run.
N Pipe thread does
not run.
N Do not process
workitems at a
program workstep.
4334 2948–005
Workflow Domain Subsystem
TRANSFER Value Entry
DOREQUEST
Description
Indicates whether the remote
request thread runs. The
remote request thread
processes tasks posted to the
external request queue.
Values
Y Runs the Remote
Request thread.
N Does not run the
Remote Request
thread.
The types of remote requests
supported are:
AR Archive a workitem.
DD Delete a document
FX Fax out a workitem
PD Print and delete a
workitem
PN Print a workitem. Notify
host application that workitem
was found
PR Print and retain a
workitem
PT Print and transfer a
workitem
QU Queue a workitem in a
specified queue
RA Retrieve a workitem
from archive
RQ Retrieve a workitem
from archive and queue it in a
specified queue
RR Retrieve recursively
(retrieve a folder and the first
level workitems)
TQ Transfer a workitem to
another Workflow Domain.
Queue it in a specified queue
TR Transfer a workitem to
another Workflow Domain
DOTRANSFER
4334 2948–005
Indicates whether the transfer
thread runs. The transfer
thread pulls entries from a
single transfer queue profile
and sends them to the
specified Workflow Domain.
Y Transfer thread
runs.
N Transfer thread
does not run.
8–37
Workflow Domain Subsystem
TRANSFER Value Entry
HEAPCHECK
Values
Specifies whether to check
heap memory before and after
a user exit call. If a heap fails
the check, the corrupted heap
is dumped to the transfer.dbg
file.
Y Check heap
memory.
Specifies whether to perform a
heap dump. See also
HEAPCHECK.
Y Perform heap
dump.
KEY1
Specifies how key values
from a remote request should
be mapped to a workflow
item variable as a result of the
remote request.
Set to the custom
INTVAR1-15, or
STRVAR1-15) to which
the key should be
mapped (Forms and
Variables dialog box in
Workflow Designer).
KEY2
Specifies how key values
from a remote request should
be mapped to a workflow
item variable as a result of the
remote request.
Set to the custom
variable (INTVAR1-15, or
STRVAR1-15) to which
the key should be
mapped (Forms and
Variables dialog box in
Workflow Designer).
KEY3
Specifies how key values
from a remote request should
be mapped to a workflow
item variable as a result of the
remote request.
Set to the custom
variable (INTVAR1-15, or
STRVAR1-15) to which
the key should be
mapped (Forms and
Variables dialog box in
Workflow Designer).
HEAPDUMP
8–38
Description
N Do not check heap
memory.
N Do not perform
heap dump.
4334 2948–005
Workflow Domain Subsystem
TRANSFER Value Entry
MAX_REQUEUE_AGE
Description
Sets the maximum amount of
time (in hours) that a retrieval
request entry can remain in
the REQUEST2 workset
before being marked with an
error status. Used in
configuring asynchronous
retrievals.
Values
Maximum
days)
168 (7
Default
24
To disable this entry, set
it to 0.
Note: Any REQUEST2
workitem with an error status
requires intervention to
requeue or delete the entry.
MAX_TRANSFER_
RETRIES
Specifies the number of
transfer attempt retries for a
workitem.
Minimum 0
Maximum 15
Default 3
Indicates the polling interval
(in seconds) used by
Transfer Manager to check
for work at program
worksteps (a step where a
user exit DLL is defined).
Minimum 15
Indicates the number of
program threads to be
started.
Minimum 1
PRQUEUE
Indicates the name of the
queue to which print
requests are sent.
PRINTER
QUEUE_ALLOC
Sets the number of files the
Workflow Domain Controller
allocates to the REQUEST
queue of a given server in a
multi-node Workflow
Domain.
Minimum 1
Remote Request Manager
recovery package. Sets the
path and name of the Request
Queue Backup file. (This file
contains a copy of all requests
enqueued by Transfer Manager
on the Workflow Domain
RQUEUE.BAK
PROGRAM_SLEEP
PROGRAM_THREADS
REQ_BACK_NAME
4334 2948–005
Default 60
Maximum 10
Maximum 256
Default 64
8–39
Workflow Domain Subsystem
TRANSFER Value Entry
Description
Values
Subsystem where Remote
Request Manager is defined.)
REQ_DONE_NAME
Remote Request Manager
recovery package. Sets the
path and name of the
Completed Request file.
(This file contains all remote
requests processed by the
Workflow Domain
Subsystem.)
RQDONE.FIL
RMFAXQ
Indicates the name of the
workflow queue to which
faxout remote requests are
enqueued.
FAXOUT
SEMAPHORE
Transfer Manager creates this
system semaphore and waits
for the Remote Request
Manager program to clear it.
When the APPC transaction is
received, the semaphore is
cleared, and the file specified
in the FILE_NAME entry in the
RRMAIN subkey is ready to
be processed. Required if the
DOPIPE entry is set to Y.
Set to the name of the
semaphore used for
communication with
the Remote Request
Manager program.
SLEEP_INTERVAL
Sets the delay (in minutes)
between polls of the
REQUEST queue profile.
Used in configuring
asynchronous retrievals.
Maximum 1440 (24
hours)
Sets the delay, in minutes,
between polls of the
REQUEST2 workset.
Maximum 1440 (24
hours)
SLEEP_INTERVAL2
Default
Default
15
15
Used in configuring
asynchronous retrievals.
TRANSFER ALL
CHILDREN
8–40
Specifies the outcome of
transferring a folder when
some child items fail to
transfer.
Y The folder transfer
fails if any child
item fails.
N The folder is
transferred even
when the children
4334 2948–005
Workflow Domain Subsystem
TRANSFER Value Entry
Description
Values
fail to transfer.
TRANSFER_THREADS
Indicates the number of
transfer threads started.
Minimum
1
Maximum
10
Default
1
UpdateUtility
This subkey contains value entries used by the CAC Server Update Utility.
UpdateUtility] Value
Entry
ClientEXELocation
Description
Indicates the path to the
CAC MTS client proxy used
for UpdateUtility.
Values
Windows 2000
<full path>:\CAC.MSI
Windows NT
<full path>:\CAC.EXE
ServiceAcctDomain
Specifies the Windows
Workflow Domain name of
the NT Service Account
where InfoImage users log
on.
The value is set during
installation based on data
entered.
ServiceAcctName
Specifies the name of the
NT Service Account.
UnisysServiceAcco
unt
The value is set during
installation based on data
entered.
4334 2948–005
8–41
Workflow Domain Subsystem
8–42
4334 2948–005
Section 9
Imaging High Volume Scanner
This section describes the registry keys used by the Unisys Imaging High
Volume Scanner software to modify system behavior. Unless otherwise
noted, registry keys for Imaging High Volume Scanner have the following
location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
Default values appear in bold type.
COMMON
Value Entry
Description
Values
DATABASE
Sets the name of the datasource
on the Imaging High Volume
Scanner controller.
DB_MULTITHREAD
Sets whether the database will
run in single thread or multithreaded mode.
Default 1 (Multi-thread)
NETTRACE
Enables the trace mechanism
used for debugging.
0 No trace
Note: NETTRACE must be set to
0 in a production environment as
detailed tracing slows down the
system significantly. Tracing
should only be used for debugging
purposes.
ODBCDEFAULTPOOL SIZE
Sets the default ODBC pool size.
PASSWORD
Sets the datasource logon
password.
4334 7798–006
1 Function tracing
2 Data tracing
3 Both function tracing
and data tracing
Default 20
9–1
Imaging High Volume Scanner
Value Entry
SERVER
Description
Sets the name of the Imaging
High Volume Scanner controller.
Values
Maximum of eight
characters.
Must be uppercase if
using APPC.
UNIFIED LOGON
Sets whether Windows NT
Unified Logon is enabled or
disabled.
Y Enabled
N Disabled
Note: The Workflow Domain
determines Unified Logon. If the
Workflow Domain is configured
for unified logon, the unified logon
password and ID are used. If the
Workflow Domain is not
configured for unified logon, the
password and ID specified by the
registry will be used. For more
information about setting up
Unified Logon, see Appendix C of
the Installation and Configuration
Guide.
USERID
Sets the datasource User ID.
<Datasource Name>
This subkey should have the name of the database on the Imaging High
Volume Scanner Controller.
Value Entry
9–2
Description
Value
DATABASE
Sets the name of the database on the
Imaging High Volume Scanner controller.
Database name
PASSWORD
Sets the datasource logon password.
Logon password
USERID
Sets the datasource logon User ID.
User ID
4334 7798–006
Imaging High Volume Scanner
HSSDEL_LOG, HSSGEN_LOG, HSSREL_LOG,
HSSSCAN_LOG
Value Entry
ALARM
Description
Values
Sets a warning beep when an error
occurs.
0 Enabled
DISPLAY
Set to display all the log messages.
0 Do not display
1 Display
MESSAGES
Sets messages that are shown in the
log window.
SUM
EVE
DET
DEB
WAR
TRA
SQL
There can be multiple values listed,
separated by a comma.
For example:
SUM,EVE,DET,TIM,SQL
POSITION
Sets the position of the log window on
the screen.
1 Disabled
Summary
Event
Detail
Debug
Warning
Trace
SQL
Defaults:
HSSDEL_LOG:
325,186,317,138
HSSGEN_LOG:
0,184,327,136
HSSREL_LOG:
0,319,315,138
HSSSCAN_LOG:
118,72,529,399
SAVE
Set to save all the log messages.
0 Do not save
1 Save
HSSMAIN
Value Entry
POSITION
4334 7798–006
Description
Sets the position of the log window on
the screen.
Values
2,1,648,185
9–3
Imaging High Volume Scanner
INTERNAL
Value Entry
Description
Values
CLIENT_HVS_COMPAT _VER
Internal Use.
Do not modify.
LOCATORVER
Sets the locator version.
Do not modify.
SERVER_HVS_COMPAT_VER
Internal use.
Do not modify.
Network Communication Keys
The Client API uses the following registry keys to enable network
communications through the TCP/IP protocol:
•
•
•
NETCALL
NETMODULE
NETSETUP
Various InfoImage components may use these registry keys. Section 8
describes the keys for Workflow Domain Subsystem. In this section, we
provide the basic format, along with examples for this specific component.
Please refer to Section 8 if you require further details on the individual
parameters used in a particular key (for example, <parameter >).
Key
Format
NETCALL
<name>/<API>:<protocol name>,
<protocol info>
*/*:REG_SZ:TCP/IP
NETMODULE
<protocol name>:<module name>
APPC:REG_SZ:PASAPPC
TCP/IP:REG_SZ:PASTCPIP
Note: There must be one
NETMODULE entry for each protocol
specified in the NETSETUP subkey.
NETSETUP
9–4
Sample Entries
<name><instance>:<protocol name>
SCANNER1:REG_SZ:TCP/IP
4334 7798–006
Imaging High Volume Scanner
OBJECT
Value Entry
Description
NODEID
Indicates a unique four-character
identifier used to build the
workitem ID of workitems created
on the Imaging High Volume
Scanner controller. NODEIDs
should be unique across all
Imaging High Volume Scanner
controllers, as well as all Workflow
Domain Subsystems
(ImageServers), in the enterprise.
OBJECT SEQUENCE
Specifies in hexadecimal the
sequence number used by the
Imaging High Volume Scanner to
create a unique ID for each new
document.
Values
Do not modify.
ODBCSETUP
This subkey contains a value entry that indicates the maximum number of
concurrently open database connections.
Value Entry
KDKSCAN
4334 7798–006
Description
Indicates the maximum number of
concurrently open database
connections allowed for the specific
process.
Value
10
Example:
KDKSCAN:REG_SZ:10
9–5
Imaging High Volume Scanner
SCANINI
Earlier versions (1.0) of the Imaging High Volume Scanner made use of an
initialization file, SCAN.INI, which stored the names of all archives and
Workflow Domains to which the Imaging High Volume Scanner could release
workitems. These parameters are now stored and configured in the registry
subkeys, ARCHIVEn and SERVERn.
Value Entry
DEFAULT
Description
Do not modify the values of these
entries.
Values
AUTODELETE
AUTOPURGE
AUTORELEASE
BATCHING
BCControl
CLASS FORM
DBFields
DEFARCSRV
DEFIMGSRV
Dropout
FORM NAME
FORM TYPE
9–6
4334 7798–006
Imaging High Volume Scanner
SCANNER
This subkey contains general settings for the Imaging High Volume Scanner.
You can change many of these settings through the HVS interface.
Value Entry
Description
ARCHIVEn
Set to the name(s) of the
archive(s) to which this scanner
will release workitems.
ASSEMBLY_EXIT
Specifies the name of an
assembly user exit. If set to the
value of CLAIMS, a claims
assembly processing user exit is
loaded. This user exit assembles
batches and documents based
on bar codes on the scanned
pages
DATABASE
Set to the name of the
datasource.
DIRECTORY
Set to the images directory on
the NTFS partition.
FORM DIRECTORY
Set to the ..\sys directory where
all form files are stored by
default.
FORCE_DUAL
Sets whether batches are
released to the Workflow
Domain Subsystem before they
are released to the archive. If a
batch is released to both the
archive and Workflow Domain
Subsystem, the archive is tried
first, then the Workflow Domain
Subsystem.
The batch is not considered
released until it is successfully
released to both the archive and
the Workflow Domain
Subsystem. Until the batch is
released to both, the status is
pending.
4334 7798–006
Values
NO The Imaging High
Volume Scanner
tries to release
batches to the
Workflow
Domain
Subsystem even
if an error occurs
when releasing to
the archive.
YES The Imaging High
Volume Scanner
will not release a
batch to the
Workflow
Domain
Subsystem until
it is successfully
9–7
Imaging High Volume Scanner
Value Entry
Description
Values
sent to archive.
INI DIRECTORY
Set to the ..\SYS subdirectory.
JOURNAL
Set to the path for the scanner
journal files.
Kofax
Indicates whether the scanner
will use the Kofax card.
NO
The scanner
does not use
the Kofax card.
There is then no
image
verification and
postage stamps
are not created.
YES Verification can
be performed
and postage
stamps are
created.
LAST PROFILE
Set to the name of the last profile
loaded on the scanner controller.
MAXIMAGESPERDOC
Sets the maximum number of
image pages per document.
999
Note:
You should test the
maximum number of image
pages per document that your
workstation configuration can
view. For more information, see
the System Internals Guide.
9–8
MinFree
Sets the minimum free disk
space required to continue
scanning. When the disk space
falls below this value, scanning is
automatically stopped.
Reardrop
When enabled, acts as a threshold
to determine when the back of a
document is not captured during
double-sided scanning. A
percentage value represents the
minimum image compression ratio.
If the compression ratio of the
back of a document is less than
the value of this entry the back of
Values are entered as
n.n, or n.nn.
If this entry is not
explicitly included, or is
set to 0, both the front
and backsides of
documents are
captured during
4334 7798–006
Imaging High Volume Scanner
Value Entry
SERVERn
Description
Values
the value of this entry, the back of
the document is not captured.
double-sided scanning.
Specifies the Workflow Domain
name(s) to which the scanner
releases workitem batches.
System Control
This subkey allows you to determine the version of the software running on
the server.
Value Entry
Description
Values
High Volume Scanner
Sets the directory where the
software is installed.
PRODUCT NAME
Indicates the name of the product
currently installed.
Do not modify.
Version
Indicates the current version of the
software running on the server.
Do not modify.
VIEWER
Value Entry
Description
Values
VIEWPOS
Sets the position of the log
window, on the screen.
132,408,636,126
WINDOW_POSITION
Sets the position of the window
on the screen.
79,493,717,7
IMAGE_INFO_ POSITION
Sets the position of the image on
the log window.
179,493,717,7
SCALE_PERCENTAGE
Sets the size of the displayed
image.
10
4334 7798–006
9–9
Imaging High Volume Scanner
9–10
4334 7798–006
Section 10
Print Manager
This section describes the registry keys used by the Unisys Print Manager
software to modify system behavior. Unless otherwise noted, registry keys
for Print Manager have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg
Default values appear in bold type.
Note: Print Manager versions 3.0x and earlier used an initialization file
(pserver.ini) to set configuration parameters. All parameters are now
configured in the registry. The Print Manager installation program does not
delete an existing pserver.ini file. Instead, the file remains available as a
configuration reference.
COMMON
The COMMON key stores key values that are either shared by or are
common to different InfoImage components. The table that follows describes
only those values that Print Manager uses. Numerous additional values may
be present in the registry, depending on the components installed.
Value Entry
NETTRACE
Description
Enables the trace mechanism
used for debugging.
Note: NETTRACE must be set
to 0 in a production environment
as detailed tracing slows down
the system significantly. Tracing
should only be used for debugging
purposes.
4334 7798–006
Value
0 No trace
1 Function tracing
2 Data tracing
3 Function and data
tracing
10–1
Print Manager
Value Entry
UNIFIED
LOGON
Description
Specifies whether Unified Logon
is enabled.
Value
Y Enabled
N Disabled
Note: The Workflow Domain
determines Unified Logon. If the
Workflow Domain is configured
for Unified Logon, the Unified
Logon password and ID are used.
If the Workflow Domain is not
configured for Unified Logon, the
password and ID specified by the
registry will be used. For more
information about setting up
Unified Logon, see Appendix C of
the Installation and Configuration
Guide.
Network Communication Keys
Print Manager uses these keys to enable network communications through
the TCP/IP protocol. The table that follows gives basic format for each key,
along with examples for Print Manager. The values are set by the setup
program, and should not require your modification.
Note: Various InfoImage components may use these registry keys,
including the Workflow Domain Subsystem. Section 8 provides additional
details on these keys.
Key
Format
Sample Entries
NETCALL
<name>/<API>:<protocol name>,
<protocol info>
*/*:REG_SZ:TCP/IP
NETMODULE
<protocol name>:<module name>
TCP/IP:REG_SZ:PASTCPIP
Note: There must be one
NETMODULE entry for each
protocol specified in the NETSETUP
subkey.
NETSETUP
10–2
<name><instance>:<protocol
name>
PSERVER1:REG_SZ:TCP/IP
4334 7798–006
Print Manager
OBJECT
Value Name
ROOT
Description
The directory used for storage of
temporary files.
Value Data
The ROOT path is initially
set to the same value as
the installation path, whose
default is:
C:\Program Files\UeWI
PRINT
This key is added to the registry upon installation. Certain values are added only
after selecting the corresponding options through Print Manager’s user
interface.
PRINT Value Entry
DEBUG
DBG_FILE_SIZE
Description
Indicates whether to log debug
messages.
Indicates the size (in KB) of the
print.dbg file.
Value Data
1
Log debug
messages.
0
Do not log debug
messages.
Minimum
Default
DOMAINn
Sets the following parameters, based
on information entered during
software installation:
•
Workflow Domain name
•
Print Manager logon User ID
•
Print Manager logon password
•
Connection status:
−
Y indicates that the Print
Manager is enabled for
logon to the Workflow
Domain.
−
N indicates that Print
Manager is not enabled for
logon to the Workflow
Domain.
There can be up to four
DOMAINn entries, one for each
4334 7798–006
10
Maximum 200
100
DOMAINn:<domain
name>,<user ID>,
<password>,<Y or N>
Example:
DOMAIN1:DOM1,USER1,
PWRD1,Y
The above indicates the
Workflow Domain to
which this Print Manager
may attempt to log on
using the USER1 and
PWRD1 logon ID and
password. Y indicates
that the Print Manager is
enabled for attempting
logon to the Workflow
Domain.
10–3
Print Manager
PRINT Value Entry
Description
Value Data
Workflow Domain to which a Print
Manager could log on.
FONT_FACE_NAME
FULL PAGE IMAGE
Sets the font for index data,
notes, and annotations.
Enables full page printing of image
documents without a page header.
You can modify this option using
the Print Manager menu.
FULL PAGE IMAGE
HEADER
Set only if the FULL PAGE IMAGE
entry is set to YES.
Any font name that is
valid for the system on
which Print Manager is
installed. If this key is
not present, the default
font is Courier.
YES Enables full-page
printing of image
documents
without a page
header.
NO
Do not enable fullpage printing of
image documents
without a page
header.
YES
Enables the page
header to be
printed on a
separate page.
NO
Does not enable
the page header to
be printed on a
separate page.
You can modify this option using
the Print Manager menu.
10–4
LOGIN_SLEEP
Set to the number of milliseconds
to pause between logon retries.
15000 (= 15 seconds)
NETWORK_NAME
The system name of this
installation of Print Manager. The
name must be eight characters or
less.
The value is set during
software installation. In the
absence of a value
the default is PSERVER.
PAGE_EJECT_TIME
Indicates the time required by the
printer to eject a page, in seconds
or milliseconds, as follows:
3000
•
If the number less than 40,
the value is considered to be
in seconds.
•
If the number is 40 or greater,
then the value is considered to
4334 7798–006
Print Manager
PRINT Value Entry
Description
Value Data
be in milliseconds.
PRINT_FLAGS
PRINTER1
Indicates which objects to print in
the case of remote print requests
or workflow-generated print
requests. Options are:
•
form data
•
notes
•
annotations
•
no pages
•
all pages
FORM_INFO
NOTES
ANNOT
NO_PAGES
ALL_PAGES
Commas separate
multiple selected values.
For example, the default
is as follows:
You may select only one of the
last two options. Note that you
should change these settings
through Print Manager’s menus.
ALL_PAGES,NOTES,ANNOT,
FORM_INFO
Specifies the printer to be used by
Print Manager.
DEFAULT
(Print Manager uses
the printer identified
as the Default in the
Control Panel /
Printers applet.)
Each Print Manager supports one
printer. There can be only one
value for PRINTER1.
< Local Printer>
Ex. pc10lpt1
< Network Printer>
(requires full path)
Ex. \\PC10\pc10lpt1
PRINT_RES
PRINT_SLEEP
4334 7798–006
Indicates the print resolution.
The time Print Manager pauses
between checking for print
requests. The value is measured
in seconds or milliseconds, as
follows:
•
If the number less than 500,
the value is considered to be
in seconds.
•
If the number is 500 or greater,
then the value is considered to
1
Low
2
Medium
3
High
15000 (= 15 seconds)
10–5
Print Manager
PRINT Value Entry
Description
Value Data
be in milliseconds.
TEMP_FILES
Indicates the path and directory
name where the temporary files
are stored.
No default
TRAY_SIZE
Specifies the size of the paper for
printing workitems.
A4
LEGAL
LETTER
PRINT_LOG
This key is added to the registry after selecting the options through Print
Manager’s user interface. To modify these values, use the log window menu.
Value Entry
ALARM
DISPLAY
MESSAGES
Description
Values
Stores the setting for the log window
alarm. When set to “On,” the
system sounds an audible beep for
every red line that appears in the log
window (critical errors and
warnings).
0
Off
1
On
Stores the setting that determines
whether Print Manager displays log
messages in the log window.
0
Do not display.
1
Display.
Stores a string value that determines
the type of messages displayed in the
process log window.
DET
DEB
EVE
SUM
SQL
TIM
TRA
WAR
Detail
Debug
Event
Summary
SQL syntax
Time stamp
Trace
Warning
Commas separate
multiple values. Ex:
SUM,EVE,DET,TIM,SQL
10–6
POSITION
Stores the log window size.
Value is machine/user
determined.
SAVE
Sets whether the contents of the log
window are saved to a file on disk.
0
1
Do not save.
Save.
4334 7798–006
Print Manager
System Control
This subkey allows you to determine the version of the software running on
the server.
Value Entry
Description
Values
PRINT MANAGER
Indicates the directory where
the Print Manager software
was installed.
Do not modify.
PRODUCT NAME
Indicates the name of the
product currently installed.
Do not modify.
Version
Indicates the current version
of the software running on the
server.
Do not modify.
TEXT TO TIFF
This key must be added manually to the registry following the syntax
described in the table that follows. Note that you should first perform some
system testing before setting the font name.
Value Entry
Description
Values
FORM_FONT_FACE_NAME
Sets the default font for index
data.
The default value
depends on the
language version of the
Windows operating
system.
FONT_FACE_NAME
Sets the default font for notes
and annotations.
The default value
depends on the
language version of the
operating system.
The value, if set, overrides the
values for both of the preceding
keys.
4334 7798–006
10–7
Print Manager
10–8
4334 7798–006
Section 11
Rapid Batch Entry and the Document
Generator
Most parameters are initially set during installation. You can change certain
parameters only by directly editing the registry.
COMMON
Value Entry
Description
MAX_DOCS_PER_BATCH
Sets the maximum number of
documents allowed in a batch
release by Document Generator to
a Workflow Domain or archive. If
the batch released by RBE to the
Document Generator has more
documents than this value,
Document Generator creates
multiple batches, each containing
no more than MAX DOCS PER
BATCH.
Values
Maximum value 1000
To change the value, select
Configuration from the
Options menu of the Document
Generator interface.
RIOSERVER
4334 7798–006
Sets the name of the Document
Generator. Maximum number of
characters is 8, and must be
unique on the network. The
installation prompts you to enter a
value.
11–1
Rapid Batch Entry and the Document Generator
Network Communication Keys
Rapid Batch Entry and the Document Generator use the following registry keys
to enable network communications using the TCP/IP protocol:
•
NETCALL
•
NETLISTEN
•
NETMODULE
•
NETSETUP
Various InfoImage components may use these registry keys. Section 8
describes the keys for Workflow Domain Subsystem. In this section, we
provide the basic format, along with examples for this specific component.
Please refer to Section 8 if you require further details on the individual
parameters used in a particular key (for example, <parameter >).
Key
Format
Sample Entries
NETCALL
<name>/<API>:<protocol name>, <protocol info>
*/*:REG_SZ:TCP/IP
NETLISTEN
<process name><API> <instance>: <protocol
name>,<threads>,<adapter no>
RIOGEN1:TCP/IP,4,0
RIOGEN2:TCP/IP,4,0
Note: The value entries in this subkey are
created by the installation program based on the
network protocol you select during installation,
and are used to configure the number of listen
threads for all server processes.
The number of listen threads allocated for
Document Generator (RIOGEN) must be at
least one greater than the total number of
DOCTHREADS specified in the
[RBE\DOCTHREADS] subkey.
NETMODULE
11–2
<protocol name>:<module name>
APPC:PASAPPC
TCP/IP:PASTCPIP
4334 7798–006
Rapid Batch Entry and the Document Generator
Key
NETSETUP
Format
<name><instance>:<protocol name> <adapter>
•
The <name>parameter is the server
process name, as follows:
−
GENCLI1 for RBE
The number of GENCLI sessions specified
should be at least one more than the
number specified for the RBE\
DOCTHREADS entry.
OR
−
Sample Entries
RBE:
GENCLI1:TCP/IP,0,5,
10,2
GENCLI2:TCP/IP
Document
Generator:
RIO1:REG_SZ:TCP/IP
,0,5,10,2
RIO2:REG_SZ:TCP/IP
RIO1 for Document Generator
The number of RIO sessions specified
should be at least one more than the
number specified in the NETLISTEN\
RIOGEN entry.
•
The <adapter> parameter indicates the
number of the logical network adapter,
either the primary (0) or secondary (1)
adapter.
RBE
The value entries in this subkey are used to configure RBE. Values are set
during installation. To change any values, use the RBE user interface
Configuration menu options.
Value Entry
AUTODELETE
AUTOICON
BASEDIR
4334 7798–006
Description
Automatically deletes batches
that were successfully released.
Automatically creates page icons if
none is specified in the DDF file.
Values
0 Don’t autodelete
1 Delete
Y Create icons
N Don’t create icons
Specifies the base directory.
Batches to be released are placed
in the subdirectories of this base
directory.
11–3
Rapid Batch Entry and the Document Generator
Value Entry
Description
Values
DOCTHREADS
Specifies the number of threads to
release simultaneously to the
Document Generator, assuming
there are enough batch
subdirectories. You must configure
the Document Generator with
sufficient listen threads
(NETLISTEN).
Default
1
IGNORE UNKNOWN
FIELD
Specifies whether to log and
ignore records that are not
recognized.
Y Logs and ignores
unrecognized records
SEPARATOR
Specifies a DDF separator
character.
Default
SLEEP INTERVAL
Specifies the number of minutes
to pause before resuming
processing.
0 Do not resume
processing
N Causes the batch
containing
unrecognized records
to fail.
| (pipe)
RIO
The value entries in this subkey are used to set the default class value in the
DDF file, as long as you used Class Administration to create a class value on
the Workflow Domain Subsystem. Values are set during installation. To
change any values, use the RBE user interface Configuration menu options.
Value Entry
11–4
Description
Values
DATA CONFIG
Specifies the data configuration file
name with fully qualified PATH
information.
rioidx.dat
DEFAULT CLASS
Specifies the default document class
to use if class information is not
indicated in the DDF file.
Maximum 17 characters
DESTINATION
ARCHIVE
Specifies the default Archive
Controller to which the Document
Generator will release batches if the
Archive Controller name is not
indicated in the DDF configuration file.
Maximum 8 characters
4334 7798–006
Rapid Batch Entry and the Document Generator
Value Entry
Description
Values
Maximum 8 characters
DESTINATION
DOMAIN
Specifies the default Workflow
Domain to which the Document
Generator releases batches if the
Workflow Domain name is not
indicated in the DDF configuration file.
DIRECTORY
Indicates the full path name of the
directory on an NTFS partition, used
by the Document Generator for
temporary files.
NODEID
Specifies a four-character string,
unique in the enterprise, to use in the
ID and document name for each
document generated by the
Document Generator.
NUM BATCH
THREADS
Specifies the number of batch threads
used by the Document Generator to
release batches. Multiple batch
threads allow the simultaneous
release of multiple batches. To be
effective, you must configure
sufficient OBJECTOTP listen threads
for the target locations.
Minimum
1
Maximum
20
JOURNAL
The folder to which the Document
Generator writes the release journal
file Rel.Jrn.
A valid directory path on
an NTFS partition
Manually create this entry in the
registry, as needed.
OBJECT SEQUENCE
Specifies the sequence number the
Document Generator uses to create a
unique ID for each new document.
Do not modify.
TIFF VERIFICATION
Enables the validation of incoming
pages. When enabled, the server can
detect corrupt files before the pages
enter the Workflow Domain. Because
TIFF VERIFICATION impacts
performance, enable this parameter
only if you are debugging a problem.
VERIFY NONE
No verification
VERIFY HEADER
Check the TIFF header
only.
VERIFY IMAGE
Check the TIFF header
and the image bits by
decompressing the
4334 7798–006
11–5
Rapid Batch Entry and the Document Generator
Value Entry
Description
Values
image.
USE_DEFAULT_PAGE_
NAME
Enables the automatic generation of
page names.
Enabled
USE MAX OBJECT
SEQUENCE
Used to set the object ID sequence
number length. Adding this value will
cause a message to be written to the
rio debug file indicating the maximum
number of objects that can be
created.
N
Use 6 digits
Y
Use 9 digits
Disabled
System Control
The value entries in this subkey specify RBE system control information. The
values are set during installation.
Value Entry
11–6
Description
Values
Rapid Batch Entry
Specifies the target directory for the
RBE application.
Do not modify the
values.
Version
Specifies the current version of the
software running on a given machine.
Do not modify the
values.
4334 7798–006
Section 12
Relational Catalog
This section describes the registry keys used by the Relational Catalog
software to modify system behavior. Unless otherwise noted, registry keys
for Relational Catalog have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\version\InfoImg
Default values appear in bold type.
LOCATOR
Value Entry
Description
DATABASE
Set to the name of the ODBC data
source associated with the name of
the Relational Catalog database.
PASSWORD
Set to the database logon password.
USERID
Set to the database logon User ID.
Values
Must not exceed 32
characters in length.
System Control
This subkey allows you to determine the version of the software running on
the server.
Value Entry
Description
Values
PRODUCT NAME
Indicates the name of the product
currently installed.
Do not modify.
Catalog Database
Indicates the directory where the
Relational Catalog is installed.
Do not modify.
Version
Indicates the current version of the
relational catalog software installed
on the server.
Do not modify.
4334 7798–006
12–1
Relational Catalog
12–2
4334 7798–006
Section 13
Request Manager
This section describes the registry keys used by the Unisys Request Manager
software to modify system behavior. Unless otherwise noted, registry keys
for Request Manager have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\version\InfoImg.
Default values appear in bold type.
ARCHIVES
Value Entry
Name of Archive
Manager
4334 7798–006
Description
Set to the name of the server
running Archive Manager for
which Request Manager is
configured. There should be one
entry for each Archive Manager
to be managed by Request
Manager.
Values
Valid values for each
entry are Y or N.
Y
Configures
Request
Manager to
manage an
Archive
Manager.
N
Configures
Request
Manager to
ignore an
Archive
Manager,
without having to
delete the entry.
13–1
Request Manager
COMMON
Value Entry
DATABASE
Description
Sets the name of the ODBC
Data Source that Request
Manager uses.
Values
The maximum is eight
characters.
Required.
DB_MULTITHREADED
NETTRACE
ODBCDEFAULTPOOL
SIZE
PASSWORD
Indicates whether the access
to the ODBC driver is singlethreaded or multi-threaded.
1 Multi-threaded.
Enables the trace mechanism
used for debugging.
0 No trace.
Note:
NETTRACE must
be set to 0 in a production
environment; detailed tracing
slows down the system
significantly. Tracing should
only be used for debugging
purposes.
2 Data tracing.
Sets the handle pool size of a
process if the process does
not have an entry under the
ODBCSETUP Subkey.
Minimum 1
Sets the database logon
password.
Must not exceed 32
characters in length.
0 Single-threaded.
1 Function tracing.
3 Both function tracing
and data tracing.
Maximum > 1
Default 20
Required.
SERVER
Sets the name by which the
Request Manager server is
known on the network.
Required.
USERID
Sets the database logon user
ID.
Required.
13–2
4334 7798–006
Request Manager
Network Communication Keys
The Request Manager use the following registry keys to enable network
communications using TCP/IP protocol:
•
•
•
•
NETCALL
NETLISTEN
NETMODULE
NETSETUP
Various InfoImage components may use these registry keys. Section 8
describes the keys for Workflow Domain Subsystem. In this section, we
provide the basic format, along with examples for this specific component.
Please refer to Section 8 if you require further details on the individual
parameters used in a particular key (for example, <parameter >).
Key
NETCALL
NETLISTEN
Format
Sample Entries
<name>/<API>:<protocol name>,
<protocol info>
*/*:REG_SZ:TCP/IP
<process name><API>
<instance>: <protocol
name>,<threads><adapter no>
ARCKOD2:TCP/IP,5
Note: This entry must have one
thread configured for each archive
device the Request Manager
services. You will also have one
entry for each Archive Controller
from the ARCHIVES subkey. These
entries must configure the listen
threads required to handle the
volume of Object Manager clients
that are simultaneously retrieving
from archive.
NETMODULE
<protocol name>:<module name>
APPC:PASAPPC
TCP/IP:PASTCPIP
NETSETUP
<name><instance>:<protocol
name>
REQUEST1:REQ_SZ:TCP/IP
4334 7798–006
13–3
Request Manager
Increasing NETLISTEN Threads
Increasing NETLISTEN threads allows more clients to be served
simultaneously. Increasing the NETLISTEN threads, however, consumes
resources (for example, memory for stack) and requires service from
Windows NT/2000’s scheduler.
Request Manager and Multiple Archives with TCP/IP
If you configure Request Manager to monitor more than one Archive
Manager, you may encounter a situation where the total number of
established connections is less than the number of NETLISTEN threads you
assigned. In this situation, the NT implementation decides which socket it will
assign each incoming address. It may pick only one and thus only a subset of
the threads you configured is available for servicing the requests.
For example, if Request Manager (REQMAN1) serviced two archives (ARC1
and ARC2), and you had configured 20 NETLISTEN threads for each Archive,
the NETLISTEN entries could be:
NETLISTEN
ARC11:TCP/IP, 20
ARC21:TCP/IP, 20
Forty NETLISTEN threads should be available for servicing requests, but only
a subset is available.
To alleviate this situation, you can do one of two things:
13–4
•
In the Request Manager’s registry, assign 40 NETLISTEN threads to each
Archive.
•
Bind each NETLISTEN to a specific interface. Bind one NETLISTEN entry
with all the required threads to the Request Manager name and all others
(a third archive is added to the example) to the name localhost. This
creates a single listen queue. No requests will come in from localhost.
For example:
NETLISTEN
ARC11:TCP/IP,60,0,REQMAN1
ARC21:TCP/IP,1,0,localhost
ARC31:TCP/IP,1,0,localhost
4334 7798–006
Request Manager
Note: The localhost entry should say localhost. It is not a reference to
another name. In the example, ARC1,2,3 are the names of the computers
on which Archive Manager is installed. REQMAN1 is the name of the
computer on which Request Manager is installed.
ODBCSETUP
This subkey contains value entries that indicate the maximum number of
concurrently open database connections.
Value Entry
REQMAN
Description
Values
Indicates the maximum number of
concurrently open database connections
allowed for the Request Manager software.
Default
20
The number of connection handles must not
exceed the number of connection handles
allowed by the DBMS.
REQMAN
This subkey will not appear in the registry unless the default values are
changed. If it becomes necessary, this subkey can be added to the registry.
REQMAN Value Entry
ARC_TIMEOUT
4334 7798–006
Description
Sets the number of seconds
after which Request Manager
times out on a synchronous
workitem retrieval request. If
a retrieval request is not
satisfied before this timeout
period, it is downgraded to
asynchronous.
Values
Minimum 20
Maximum 300
Default 60
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the
subkey.
13–5
Request Manager
REQMAN Value Entry
Description
Values
Set to the number of retrieval
threads that Request
Manager starts for each drive
to which each configured
Archive Manager is
connected.
Minimum 2
BACKUP LOG FILE
NAME
Specifies the Request
Manager backup log file
name.
reqman.bak
LOG FILE NAME
Specifies the Request
Manager log file name.
reqman.log
Specifies the number of
seconds Request Manager
waits for all threads to
terminate before it
performs a shutdown.
Minimum 10
ARC THREADS
MAX SHUTDOWN
DELAY
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the
subkey.
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the subkey.
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the
subkey.
Maximum 300
Default 90
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the
subkey.
13–6
4334 7798–006
Request Manager
REQMAN Value Entry
STATS REFRESH RATE
Description
Specifies the refresh rate
(in seconds) of the
statistics display in the log
windows.
Values
Minimum 10
Maximum 120
Default 30
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the subkey.
STATS SUMMARY
TRANSACTION RATE
TRANSACTION FILE
SIZE
POSITION
4334 7798–006
Specifies (in minutes) how
often the system summary
messages are writ ten to the
Request Manager
transaction file.
Minimum 1
Specifies the maximum
size (in bytes) of the
Request Manager
transaction file.
Minimum 64
Records the position and size
of the Request Manager
window.
These settings are
internally managed and
should not be altered.
Maximum 60
Default 60
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the subkey.
Default 2500 (2.5 KB)
The default value is set at
installation and the value
entry will not appear in the
registry. If changes to the
default value become
necessary, the value entry
can be added to the subkey.
13–7
Request Manager
System Control
Value Entry
Description
PRODUCT NAME
Indicates the name of the
product currently installed.
Request Manager
Indicates the directory where
the Request Manager
software is installed.
Version
Indicates the current version
of the software running on
the server.
Values
Do not modify.
Do not modify.
VOLUME PRIORITY FACTORS
Value Entry
BIAS FACTOR
HIGH PRIORITY AGE
HIGH PRIORITY
COUNT
HIGH PRIORITY SIZE
LOW PRIORITY AGE
13–8
Description
Values
Specifies the weighting factor
for mounted volumes that
Request Manager uses in
determining volume priorities.
Maximum 1000
Specifies the weighting factor
for the age of high priority
retrieval requests that Request
Manager uses in deter mining
volume priorities.
Minimum 1,000
Specifies the weighting factor
for the count of high priority
retrieval requests that Request
Manager uses in deter mining
volume priorities.
Minimum 1,000
Specifies the maximum number
of high priority retrieval
requests serviced by an archive
unit during a single retrieval
cycle.
Minimum 10
Specifies the weighting factor
for the age of low priority
retrieval requests that Request
Manager uses in deter mining
Minimum 1
Default 25
The value is based on
100 as a factor of 100
percent. For example, 25
would be used as .25.
Maximum 1,000,000,000
Default 10,000,000
Maximum 1,000,000,000
Default 1,000,000
Maximum 40
Default 15
Maximum 1,000,000,000
4334 7798–006
Request Manager
Value Entry
Description
Values
volume priorities.
LOW PRIORITY
COUNT
LOW PRIORITY SIZE
4334 7798–006
Specifies the weighting factor
for the count of low priority
retrieval requests that Request
Manager uses in deter mining
volume priorities.
Minimum 10
Specifies the maximum number
of low priority retrieval requests
serviced by an archive unit
during a single retrieval cycle.
Minimum 10
Maximum 1,000,000,000
Default 100
Maximum 50
Default 20
13–9
Request Manager
13–10
4334 7798–006
Section 14
Robot Manager
This section describes the registry keys used by the Unisys Robot Manager
software to modify system behavior. Unless otherwise noted, registry keys
for Robot Manager have the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg\Robots
Default values appear in bold type.
<Your Custom Robot Name>
This subkey contains configuration parameters used by any custom robots
you may have created using the provided template.
Value Entry
Description
Values
DELAY
The delay interval. This is the amount
of time, in minutes, after which the
robot program wakes up.
1
DOMAIN
The name of the Workflow Domain
Subsystem for the Workflow
Domain.
Default is blank
EXECUTABLE
The name of the executable file
(.exe) for the custom robot.
<Root>:\Program Files\
UEWI\Samples\Robot\
PRbtTmpl.exe
INSTALL
Determines whether the robot is
installed as a service or as a process.
Values correspond to the robot’s
installation as a process.
Y
Install as a service.
N
Install as a process. (No
to running as a service.)
LOGFILENAME
The name of the file that contains a
log of each robot's activities.
PRbtTmpl.log
PASSWORD
The encrypted user password used
by the robot. See also USERNAME.
Default is blank
4334 7798–006
14–1
Robot Manager
Value Entry
Description
Values
USERNAME
The InfoImage user ID the robot uses
when connecting to a workset.
Default is blank
WORKSET
The InfoImage workset in Custom
Workstep from which the robot
accesses documents. The robot
program attaches to this workset
using the username and password.
Default is blank
GatherRobot
This subkey contains configuration parameters used by the Gather robot.
Value Entry
14–2
Description
Values
ASSIGN FIELD
The name of the field from which the robot
takes a value from a retrieved workitem,
and assigns it to all other matched
workitems (based on the Match Field).
Default is blank
DELAY
The delay interval. This is the amount of
time, in minutes, after which the robot
program wakes up.
1
DOMAIN
The name of the Workflow Domain
Subsystem for the Workflow Domain.
Default is blank
EXECUTABLE
The name of the executable file (.exe) for
the custom robot.
<Root>:\Program
Files\UEWI\
GatherRobot.exe
4334 7798–006
Robot Manager
Value Entry
FOLDER
Description
The Folder parameter is a flag that
determines how the Gather Robot will
process associated documents.
Values
Y
Use folders.
N
Do not use folders.
Set to "Y" -- The workitems can be either
documents or folders. If the retrieved item
is a folder, associated documents will be
added to the folder, if the retrieved item is
a document, a folder will be created and
associated documents added to it.
Set to "N" -- The same processing is
performed to obtain a list of associated
documents, however, instead of placing all
of these documents in a folder, the "set
field" of all associated documents is set to
whatever value this field has in the
retrieved workitem.
Determines whether the robot is installed
as a service or as a process. Values
correspond to the robot’s installation as a
process.
Y Install as a service.
LOGFILENAME
The name of the file that contains a log of
each robot's activities.
GatherRobot.log
MATCH FIELD
The name of the field that the Gather
Robot uses to locate associated
workitems. The robot locates candidates
based on the value in this field.
Default is blank
PASSWORD
The encrypted user password used by the
robot. See also USERNAME.
Default is blank
USERNAME
The InfoImage user ID the robot uses
when connecting to a workset.
Default is blank
WORKSET
The InfoImage workset in Custom
Workstep from which the robot accesses
documents. The robot program attaches
to this workset using the username and
password.
Default is blank
INSTALL
4334 7798–006
N Install as a process.
(No to running as a
service.)
14–3
Robot Manager
PrefetchRobot
This subkey contains configuration parameters used by the Prefetch robot.
Value Entry
Description
Values
The delay interval. This is the amount
of time, in minutes, after which the
robot program wakes up.
Range 1 – 60
DOMAIN
The name of the Workflow Domain
Subsystem for the Workflow Domain.
Default is blank
EXECUTABLE
The name of the executable file (.exe)
for the custom robot.
<Root>:\Program Files\
UEWI\PrefetchRobot.exe
INSTALL
Determines whether the robot is
installed as a service or as a process.
Values correspond to the robot’s
installation as a process.
Y
Install as a service.
N
Install as a process.
(No to running as a
service.)
LOGFILENAME
The name of the file that contains a log
of each robot's activities.
PrefetchRobot.log
MATCH FIELD
The name of the field that the Gather
Robot uses to locate associated
workitems. The robot locates candidates
based on the value in this field.
Default is blank
PASSWORD
The encrypted user password used
by the robot. See also USERNAME.
Default is blank
SCOPE
Determines the scope of the query to
be either Domain or Archive.
Domain
The lookup is against
the Attributes table.
DELAY
Default 1
Archive
The lookup is against
the Catalog.
14–4
USERNAME
The InfoImage user ID the robot uses
when connecting to a workset.
Default is blank
WORKSET
The InfoImage workset in Custom
Workstep from which the robot
accesses documents. The robot
program attaches to this workset using
the username and password.
Default is blank
4334 7798–006
Robot Manager
SiebelImportRobot
This subkey contains value entries used by the SiebelImportRobot. Use the
InfoImage Robot Manager to configure these registry entries.
Note: In the Values column, bold type indicates default values. In the
Description column, bold type indicates the field name in the Robot
Configuration dialog box or Robot Configuration Wizard.
Value Entry
Description
Values
Max File Size is the maximum file
size in KB of the external XML output
file
Range 1 – 2048
Audit Filename
Audit Filename is the full path and
filename to the external XMLformatted audit file.
Audit.xml
DELAY
Delay Interval is the amount of
time, in minutes, after which the
robot program wakes up.
Range 1 – 7200
Domain is name of the Workflow
Domain. A Workflow Domain is
Default is blank
Audit File Max Size
DOMAIN
Default 2048
Default 1
1. One or more Workflow Domain
Subsystems running a single route
and communicating with a single
Workflow Domain Controller.
2. Logical group of InfoImage
components that generally form a
departmental processing unit within
an enterprise.
Enable Audit File
Output
Enable Audit File Output
determines whether the robot writes
a record of changes made to
documents in workflow to an external
XML-formatted file.
Y
enabled
N
disabled
Enable Delete Log
on Startup
Delete Logfile on Startup
determines whether to overwrite the
log file each time the robot starts.
Y
overwrite
N
not overwritten
EXECUTABLE
The name of the executable file (.exe)
for the custom robot.
<root>:\Program Files\
UEWI\SiebelImportRobot
.exe
4334 7798–006
14–5
Robot Manager
Value Entry
INSTALL
Determines whether the robot is
installed as a service or as a process.
Values
Y
Install as a service.
N
Install as a process.
(No to running as a
service.)
Logfile Max Size
Max File Size is the maximum size,
in KB, before a new log file is created.
The old log file is backed up with a
date and time stamp.
Range 1 - 2048
LOGFILENAME
Filename is the path and file name
of the log file that contains the robot
error messages
SiebelImportRobotLog.log
Logging
Turns logging on or off. Logging is
automatically turned on when you
check any logging level, and turned
off when you deselect all logging
levels.
TRUE
On
FALSE
Off
Choose Message Types to be
Logged represents the level of detail
to apply when logging error
messages.
NULL no messages
LoggingLevel
14–6
Description
0
Critical messages
1
Warning messages
2
Informational
messages
3
Debug messages
New Document
Class
Class is the name of the InfoImage
document class required for creating
new documents from Siebel Activity
records in InfoImage.
Application
New Document
Indicator Fieldname
Fieldname Indicating New
Documents is the InfoImage index
form field that indicates whether the
Siebel Import Robot created a new
document or updated an existing
document
New_doc
4334 7798–006
Robot Manager
Value Entry
New Document
Name
Description
Values
Name is the name to assign each new
document generated by the Siebel
Import Program. You can include the
following functions in the name. The
entire name, including any function
must be enclosed in quotes.
Any character except
slash (/), backslash (\),
and percent (%), except
when % indicates one of
the four InfoImage
functions described.
%now
Returns a string with the current
date/time in one of the following
formats required by Siebel:
"Activity %now"
YY:MM:DD HH:MM:SS A.M.
YY:MM:DD HH:MM:SS P.M.
YY=the 2 digit year
MM=the 2 digit month
DD=the 2 digit day of the month
HH=the 2 digit hour
MM=the 2 digit minute
SS=the 2 digit second
A.M.=morning hours
P.M.=evening hours
%UeWIUserID
Returns InfoImage User ID from the
registry entry.
%e-WorkflowExportUserID
Returns the Siebel User ID from the
XML Export Gateway Robot registry
entry.
%e-WorkflowImportUserID
Returns the Siebel User ID from the
Siebel Import Robot registry entry.
PASSWORD
Password is the encrypted
InfoImage user password associated
with the InfoImage User ID that the
robot uses when connecting to a
workset. See also USERNAME.
Default is blank
Siebel Gateway
Name
Gateway Name is the name you
assign to the gateway configuration
to use when importing data from
Siebel Activity records.
Default is blank
4334 7798–006
14–7
Robot Manager
Value Entry
14–8
Description
Values
Siebel Gateway
Password
Password is the password for the
HTTP Gateway to log onto the Siebel
Call Center.
Default is blank
Siebel Gateway
Username
Username is the user name for the
HTTP Gateway to log onto the Siebel
Call Center.
Default is blank
Siebel Logoff
HTTP Logoff is a string for HTTP
connection, built from the Remote
Host, Document, Username, and
Password entries, and from Siebel
Call Center or general command
strings.
Default is blank
Siebel Logoff
Response
Logoff Response is the response
string expected from the host to
validate successful log off. You can
enter a string, or accept the response
returned from the host when you click
Test Logoff.
Default is blank
Siebel Query Login
HTTP Activity Query Login is the
login string for HTTP connection, built
from the Remote Host, Document,
Username and Password entries,
and from Siebel Call Center or general
command strings.
Default is blank
Siebel Query Login
Response
Activity Query Response is the
response string expected from the host
for successful validation of a request to
log in. You can enter a string, or accept
the response returned from the host
when you click Test Logon.
Default is blank
Siebel Query String
An XML-formatted string that indicates
the Siebel Activity record fields and
values to query to determine whether
to import data to InfoImage.
<Status>Send To
Unisys
Workflow</Status>
4334 7798–006
Robot Manager
Value Entry
Description
Values
Siebel Send Data
HTTP Send Data is the ‘Send’
command Header for HTTP
Connection, built from the Remote
Host, Document, Gateway
Username and Gateway Password
entries, and from Siebel Call Center or
general command strings.
Default is blank
Siebel Send Data
Response
Send Data Response is the
response string expected from the host
that confirms the successful receipt of
data. You can enter a string, or accept
the response returned from the host
when you click Test Send Data.
Default is blank
Siebel Upsert Login
HTTP Activity Upsert Login is a
string for upserting data to Siebel, built
from the Remote Host, Document,
Username, and Password entries,
and from Siebel Call Center or general
command strings.
Default is blank
Siebel Upsert Login
Response
Activity Upsert Response Login
Response is the response string
expected from the host to validate
successful log in. You can enter a
string, or accept the response returned
from the host when you click Test
Logon.
Default is blank
Siebel Upsert String
An XML-formatted string that indicates
the Siebel Activity record fields and
values to be updated after the Siebel
Import Robot updates InfoImage
documents.
<Status>Sent To Unisys
Workflow </Status>
Siebel URL
The Remote Host IP address and
Document name, combined to form
the HTTP target and parameter values
expected by the external Siebel web
server.
Default is blank
Example:
If Remote Host = 192.62.81.130, and
Document = eai
Siebel URL = http://192.62.81.130/eai
4334 7798–006
14–9
Robot Manager
Value Entry
14–10
Description
Values
USERNAME
The InfoImage user ID the robot uses
when connecting to a workset.
Default is blank
WI Processed
Fieldname Flag
The name of the InfoImage form field
that holds the status value of the HTTP
transfer. In the configuration window
this corresponds to the Error
Fieldname.
error_stat
WORKSET
Work Entry Queue is the name of
the InfoImage workset to which the
Siebel Import Robot sends workitems
for re-entry to workflow.
CallCenter WorkEntry
XML Mapping
Definitions File
The full path and filename of the import
XML Mapping Definitions File,
that maps the fields between the Siebel
Call Center fields (XML Reference
Schema.xml) and InfoImage index form
(APPLICAT.frm) and the importing data
to InfoImage from Siebel Call Center
Activity records.
Default is blank
4334 7798–006
Robot Manager
SysDeleteRobot
This subkey contains configuration parameters used by the Sysdelete robot.
Value Entry
Description
Values
DELAY
The delay interval. This is the amount of
time, in minutes, after which the robot
program wakes up.
Default 1
DOMAIN
The InfoImage Workflow Domain.
Default is blank
EXECUTABLE
The name of the executable file (.exe)
for the custom robot.
<root>:\Program Files\
UEWI\SysDeleteRobot.exe
INSTALL
Determines whether the robot is
installed as a service or as a process.
Values correspond to the robot’s
installation as a process.
Y
Install as a service.
N
Install as a process.
(No to running as a
service.)
LOGFILENAME
The name of the file that contains a log
of each robot's activities.
SysDeleteRobot.log
PASSWORD
The InfoImage user password.
Default is blank
USERNAME
The InfoImage user ID the robot uses
when connecting to a workset.
Default is blank
WORKSET
The InfoImage workset in Custom
Workstep from which the robot
accesses documents. The robot
program attaches to this workset using
the username and password.
Default is blank
4334 7798–006
14–11
Robot Manager
XMLExportGatewayRobot
This subkey contains configuration parameters used by the
XMLExportGatewayRobot robot. Use the Robot Manager to configure these
registry entries.
Note: In the Values column, bold type indicates default values. In the
Description column, bold type indicates the field name in the Robot
Configuration dialog box or Robot Configuration Wizard.
Value Entry
DELAY
14–12
Description
Delay Interval is the amount of time,
in minutes, after which the robot
program wakes up.
Values
Range 1 – 7200
Default 1
DOMAIN
The name of the InfoImage Workflow
Domain.
Enable Delete Log
on Startup
Delete Logfile on Startup
determines whether to overwrite the
log file each time the robot starts.
Y
overwrite
N
do not overwrite
Enable XML File
Output
Enable XML File Output
determines whether the robot writes
data to an external XML-formatted file.
Y
enabled
N
disabled
Enable XML HTTP
Gateway
Enable XML HTTP Gateway
determines whether the robot sends
data across the HTTP Gateway.
Y
enabled
N
disabled
EXECUTABLE
The name of the executable file (.exe)
for the custom robot.
<root>:\Program Files\
UEWI\XMLExportGateway.
exe
HTTP Gateway
Name
Gateway Name is the name you
assign for the gateway configuration to
use to connect using HTTP when
exporting data from InfoImage to
another application (such as the Siebel
Call Center).
Default is blank
HTTP Gateway
Password
Password is the password for HTTP
Gateway to log onto the remote host
where the web application resides.
Default is blank
HTTP Gateway
Username
Username is the user name for HTTP
Gateway to log onto the remote host
where the web application resides.
Default is blank
4334 7798–006
Robot Manager
Value Entry
Description
Values
HTTP Login
HTTP Login is the login string for HTTP
connection, built from the Remote
Host, Document, Username and
Password entries, and from the thirdparty application (such as the Siebel Call
Center), or general command strings.
Default is blank
HTTP Login
Response
Login Response is the response
string expected from the host to
validate a successful log in. You can
enter a string, or accept the response
returned from the host when you click
Test Logon.
Default is blank
HTTP Logoff
HTTP Logoff is a string for HTTP
connection, built from the Remote
Host, Document, Username, and
Password entries, and from the thirdparty application (such as the Siebel
Call Center), or general command
strings.
Default is blank
HTTP Logoff
Response
Logoff Response is the response
string expected from the host to
validate a successful log off. You can
enter a string, or accept the response
returned from the host when you click
Test Logoff.
Default is blank
HTTP Send Data
HTTP Send Data is the ‘Send’
command Header for HTTP Connection,
built from the Remote Host,
Document, Gateway Username and
Gateway Password entries, and from
the third-party application (such as the
Siebel Call Center), or general command
strings.
Default is blank
Send Data Response is the response
string expected from the host that
confirms the successful receipt of data.
You can enter a string, or accept the
response returned from the host when
you click Test Send Data.
Default is blank
HTTP Send Data
Response
4334 7798–006
14–13
Robot Manager
Value Entry
HTTP URL
Description
Values
Default is blank
The Remote Host IP address and
Document name, combined to form
the HTTP target and parameter values
expected by the external web server.
Examples:
For a General gateway
Remote Host =
www.service.unisys.com
Document = blank
URL=http://www.service.unisys.com
For a Siebel gateway
Remote Host = 192.62.81.130
Document = eai
URL = http://192.62.81.130/eai
INSTALL
Determines whether the robot is
installed as a service or as a process.
Y
Install as a service.
N
Install as a process.
(No to running as a
service.)
Logfile Max Size
Max File Size is the maximum size,
in KB, before a new log file is created.
The old log file is backed up with a date
and time stamp.
Range 1 - 2048
LOGFILENAME
Filename is the path and file name of
the log file that contains the robot error
messages
XMLGatewayOutRobotLog.
log
Logging
Turns logging on or off. Logging is
automatically turned on when you
check any logging level, and turned off
when you deselect all logging levels.
TRUE
On
FALSE
Off
Choose Message Types to be
Logged represents the level of detail
to apply when logging error messages.
NULL no messages
LoggingLevel
14–14
0
Critical Messages
1
Warning messages
2
Informational
messages
3
Debug messages
4334 7798–006
Robot Manager
Value Entry
Description
Values
PASSWORD
The encrypted InfoImage user password
used by the robot. See also USERNAME.
Default is blank
USERNAME
The InfoImage user ID the robot uses
when connecting to a workset.
Default is blank
WI Processed
Fieldname Flag
The name of the InfoImage form field
that holds the status value of the HTTP
transfer. In the configuration window this
corresponds to the Error Fieldname.
error_stat
WORKSET
The InfoImage workset in Custom
Workstep from which the robot
accesses documents. The robot program
attaches to this workset using the
username and password.
Default is blank
XML Mapping
Definitions File
The full path and filename of the export
XML Mapping Definitions File. This file
maps the fields between the InfoImage
index form and the external XML
application.
Default is blank
For Siebel, this file maps the fields
between the InfoImage index form
(APPLICAT.frm) and the Siebel Call
Center fields (XML Reference
Schema.xml). Used for exporting data
from InfoImage to the Siebel Call
Center. .
XML Output File
Max Enumerations
Max File Enumerations is the
maximum number to append to the
external XML output file name before
cycling back to 001.
Range
XML Output File
Max Size
Max File Size is the maximum file
size in KB that the external XML output
file can become before it is either
overwritten or an enumeration is
added.
Range
XML Output
Filename
Output Filename is the full path and
filename to the external XML file
output.
xmlOutput.xml
4334 7798–006
0 – 999
0 = Disabled
1 - 2048
14–15
Robot Manager
14–16
4334 7798–006
Section 15
Scan Manager
Scan Manager registry keys are generally located in the following location:
HKEY_CURRENT_USER\Software\Unisys\UeWI\ScanManager\<version>
Default values appear in bold type.
BatchOutput
This registry subkey contains registry entries and additional subkeys used for
Scan Manager batch output.
Value Entry
Description
Value
Destinations
The batch output control uses this value to
reconstruct the interface on startup to
appear as it was before the last shutdown.
Do not modify.
MaxLogSize
Specifies a maximum file size for log files.
The log file will be truncated at some point
after it exceeds this size.
Number of kilobytes
WarnLargeImageF
ormat
Determines whether a warning message is
displayed when a user chooses an output
option that may generate a very large
image file.
0
No
1
Yes
4334 7798–006
15–1
Scan Manager
BatchOutput\CWM
This subkey of BatchOutput contains registry entries used for Scan Manager
batch output to Client Work Manager.
Value Entry
WarnFolder
Description
This determines whether a warning
message is displayed when the user
sends a batch to Client Work Manager with
the option to file the documents in a folder.
Value
0
No
1
Yes
The user changes the value to 0 by clicking
a checkbox on the message box with the
caption "Do not show this message again"
BatchOutput\CWM\BatchInUeWI
This subkey enables import of the batch file as a foreign import attached to a
folder. When present, this key and its required values result in additional fields
on the BatchOutput Client Work Manager interface.
Value Entry
FolderClass
Description
The name of the folder class of the folder
that the system will create for importing
the batch file. This folder class, with this
name, must exist in the target Workflow
Domain or the process will fail.
Value
Value must
conform to
system folder
class naming
conventions.
This setting is required.
FolderName
If this setting is valued, it will be used to
name the folder created to import the
batch. If it is not valued, or is missing, the
batch name will be used to name the
folder.
This value must
conform to
system folder
naming
conventions.
ImportClass
The name of the import class to use when
importing the batch as a foreign object. An
import class with this name must exist in
the target Workflow Domain or the process
will fail. The import class should specify the
BatchViewer executable (BatchVue.exe) as
its viewer, and .UTF as its file extension.
This value must
conform to
system import
class naming
conventions.
This setting is required.
15–2
4334 7798–006
Scan Manager
BatchOutput\Email
This subkey of BatchOutput contains registry entries used for Scan Manager
batch output by email.
Value Entry
(RetainText)
Description
The batch output interface uses this value
to determine whether message text should
be propagated from batch to batch.
Value
Do not modify.
BatchOutput\Exchange
This subkey of BatchOutput contains registry entries used for Scan Manager
batch output to an Exchange folder.
Value Entry
(RetainText)
Description
The batch output interface uses this value to
determine whether message text should be
propagated from batch to batch.
Value
Do not modify.
BatchOutput\JPEGSettings
The subkeys of BatchOutput\JPEGSettings contain settings that control image
compression for JPEG images. These values are managed by the JPEG
Options dialog, which is available on all output options except RBE, Client
Work Manager and Printer/Fax.
Higher values result in higher compression, smaller files and lesser image
quality.
4334 7798–006
15–3
Scan Manager
The JPEGSettings subkey includes the subkeys listed below. The Value Entry
and Value are the same for each subkey.
•
JPEGColorHigh
•
JPEGColorLow
•
JPEGColorMedium
•
JPEGGrayHigh
•
JPEGGrayLow
•
JPEGGrayMedium
Value Entry
Description
Value
Chrominance
A compression setting that applies to
color images. For grayscale images,
this value has no meaning.
0 through 255
Luminance
A compression setting that applies to
color and grayscale images.
0 through 255
SubSampling
A compression setting that applies to
color and grayscale images.
0 through 3
BatchOutput\Kernel
Value Entry
AutoFailureNotification
RetainSuccessfulBatch
15–4
Description
Value
This determines
whether an automatic failure
notification displays when the batch
output process fails. The user changes
the value by clicking a checkbox on
the Batch Output Options dialog.
1
Yes
0
No
This determines whether to retain the
batch file after a successful output
operation. The user changes the value
by clicking a checkbox on the Batch
Output Options dialog.
1
Yes
0
No - delete
the batch files
after output
completes
4334 7798–006
Scan Manager
BatchOutput\Kernel\Imports
When you import color image pages through Client Work Manager, the file
extension of the import class determines the image type of the attachment.
Examples
•
If the import class file extension is .bmp, the import is a Windows Bitmap
file.
•
If the import class file extension is .jpg, the import is a JPEG file.
This set of registry values determines file format characteristics, such as
compression type. To generate a specific sub-type or compression type
desired you reset these values. You control the import class assigned by
setting the Page import class field in the Workflow Domain Information
dialog box.
The values in this subkey are used only if the value of ImageColorTarget in the
Shared subkey is 0. If the value is 1 or 2, values under this subkey are
ignored. If you set a value outside of the expected range, the setting is
ignored and then the internal default value is used. To restore system defaults
delete the entire subkey.
Note: The subkey only appears in the registry after sending a batch with
attachments to RBE or Client Work Manager for the first time, or when
ImageColorTarget equals 0.
Value Entry
GIFInterlace
GIFType
JPEGChrominance
Description
Value
Determines whether to interlace
the GIF image data.
0
Non-interlaced
1
Interlaced
Determines the format of the
GIF data.
0
GIF89a
1
GIF87a
JPEG compression setting that
affects the color quality of the
image.
0 through 255
0
Highest quality
255 Highest
compression
30 Default
4334 7798–006
15–5
Scan Manager
Value Entry
JPEGLuminance
Description
JPEG compression setting that
affects the intensity of colors in
the image.
Value
0 through 255
0
Highest quality
255 Highest
compression
24 Default
JPEGSubSampling
PNGInterlaced
Portable Type
TIF Compression
0
1:1:1
1
2:1:1 horizontal
3
4:1:1
4
2:1:1 vertical
Determines whether to interlace
PNG data.
0
Non-interlaced
1
Interlaced
Determines the format for PBM,
PGM and PPM files.
0
Binary
1
ACSII
Determines the type of
compression for TIF files.
0
Uncompressed
1
RLE
2
CCITT Group 3 ID
3
CCITT Group 4
4
LZW
5
Pack Bits
JPEG compression setting that
determines how to merge
adjacent pixels to reduce the size
of the image.
6
JPEG (use JPEG
setting shown above)
15–6
7
Deflate
8
CCITT Group 3 2D
4334 7798–006
Scan Manager
BatchOutput\RBE
This subkey of BatchOutput contains registry entries used for Scan Manager
batch output to Rapid Batch Entry.
Value Entry
Delimiter
Description
Value
This value determines the delimiter to use
when constructing the DDF file.
Default: |
(Pipe character)
Refer to the RBE manual for specific
details on the DDF field delimiter and its
valid values.
Single-character
values only.
BatchViewer
This key contains registry entries used for the Scan Manager Batch Viewer
program.
Value Entry
Description
Value
AllowPageChan
gesOnIndex
Allows image page changes in the page
viewer when indexing or verifying
indexes, so you can clean up (despeckle)
while indexing. You set this option using
the Batch Viewer Options dialog.
1 Allow changes
AutoOpenOnInd
ex
Displays the first page of each document
during indexing, whether or not the image
was defined in the index form. You set
this option using the Batch Viewer
Options dialog.
1 Display page
one
BatchVueSplash
Screen
Displays the Batch Viewer splash screen.
1 Display
ClosePageView
erOnIndex
Controls the state of any open page
viewer when you start an indexing
operation. You set this option using the
Batch Viewer Options dialog.
4334 7798–006
0 No changes
allowed
0 Use form
default
0 Do not display
1 Close viewers
0 Leave viewers
open
15–7
Scan Manager
Value Entry
Description
CreateThumbnai
ls
Controls whether Scan Manager creates
thumbnails after scanning a batch, and the
batch is closed.
When set to 0, users can generate
thumbnails for a selected batch as
needed. Using the Windows Explorer, the
user selects a batch and then selects the
Create Thumbnails option from the
context menu.
CreateThumbsO
nOpen
1
Create
thumbnails.
0
Do not
create
thumbnails.
Controls whether Batch Viewer creates
thumbnails when a batch is opened (if
thumbnails were not previously created).
1
Create
thumbnails.
Controls the selection of document with
which to start an indexing operation. The
default is the currently selected
document. Alternatively you can start
indexing at the first un-indexed document.
You set this option using the Batch
Viewer Options dialog.
1
Start at
selected
The maximum number of page viewers
that can be active.
1 to 32
OverrideFormIm
ageDefinitions
Displays the first page of a document,
even if the index form has another image
defined, overriding the AutoOpenOnIndex
setting You set this option using the
Batch Viewer Options dialog.
1 Override form
PageViewerREC
T
Determines the screen position and size
of the last page viewer you close.
A colon-delimited
( : ) string of Top,
Left, Height, and
Width
PageViewerStat
e
Determines the state of the page viewer
window
0
Normal
1
Maximized
IndexStartAtSel
ected
MaxViewers
15–8
Value
0
Do not
create
thumbnails.
0
Start at first
un-indexed
8
Default
0 Use form
definition
4334 7798–006
Scan Manager
Value Entry
Description
Value
RequiredFieldsS
topSend
Controls whether to prevent a batch from
being sent to RBE or CWM if you do not
have all the required index data on an
index form. The form must reside in the
Scan Manager Forms directory.
1
Stop the
batch from
entering
workflow when
required fields are
not present
If you supply a valid Workflow Domain
and document class, and the class uses a
form containing required fields, a value of
1 displays an error and the send function
fails. You must index all documents in the
batch before the batch can be
successfully sent.
0
Ignore
required fields
and send the
batch to workflow
If the value is 0, Scan Manager or Batch
Viewer ignores the required fields on the
form, and sends the batch to RBE or
CWM.
RetainFormData
Options
Indicates which types of form fields retain
their values when progressing from
indexing one document to the next
document.
0
None
1
List fields
2
Checkboxes
4
Yes/No
fields
65535 All
UseTextNotes
Controls the format that Batch Viewer
uses for notes. By default, Batch Viewer
creates HTML notes if Internet Explorer 5
or later is installed. Otherwise, it creates
simple text notes. If you always want
simple text notes, set this to 1.
See Batch Viewer help for additional
information.
0
Use HTML
notes if Internet
Explorer 5 or
higher is
available.
1
Always use
simple text notes.
WinRECT
Stores the most recent position and size
of the Batch Viewer window.
A colon-delimited
( : ) string of Top,
Left, Height, and
Width
WinState
Stores the most recent window state of
the Batch Viewer window.
0
Normal
1
Maximized
4334 7798–006
15–9
Scan Manager
ScanManager
This registry key contains registry entries used for the Scan Manager
program. The current runtime values of these settings are saved to the
Registry when Scan Manager terminates, and are used to initialize the
settings when Scan Manager is next started. The default values are used if no
registry settings are found. You can restore the system defaults by deleting
this entire registry key.
ScanManager
Entry
Description
Value
(SettingsLastSaved)
Indicates the date Scan Manager
settings were last saved.
Do not modify
BatchAutoFixNames
Determines the action Scan
Manager takes when a Batch
Name is invalid. We recommend
that you leave this setting at the
default value of 1.
0
Display an error
message to the user.
1
Automatically fix
the name.
Note:
Scan Manager
validates the Batch Name against
certain criteria. For example, a
batch name cannot be
Zero-length
Greater than a certain number of
characters
Contain certain special characters
CanModifyImages
For non-InfoImage
configurations, determines
whether you can alter images,
such as altering by despeckling
or deskewing.
0
No
1
Yes
This value only applies to nonInfoImage configurations.
InfoImage configurations use the
value specified in the Workflow
Domain and doc class.
15–10
4334 7798–006
Scan Manager
ScanManager
Entry
DiscardedImagesDir
Description
Specifies an existing directory
where you save a copy of each
scanned image that you would
otherwise discard.
Value
<Empty or nonexistent value>
Note:
This entry is a technical
support tool to assist in problem
analysis and should not normally
appear in the Registry. When
activated, Scan Manager stores
every page that would normally
be discarded (patch pages, blank
pages), and utilizes additional
disk storage.
DSCannotSetBrightn
essOrContrast
Indicates whether to enable the
brightness and contrast features
on the user interface. This is a
workaround for a Kofax
Adrenaline Data Source (DS) bug.
0
No
1
Yes
0
No
1
Yes
0
No
1
Yes
For Kofax the default is 1. For all
others, the default is 0.
DSSetFrameAfterOri
entation
Specifies whether the Twain
source has a problem setting the
Image Layout frame after the
Orientation is set during
negotiation. If set to 1, Scan
Manager handles orientation
instead of the Twain interface.
For the FUJITSU M309xDC
Scanner, the default is 1.
DSIgnoreSupportedSi
zesList
Specifies whether the Twain
source has a problem returning
the entire list of supported paper
sizes. If set to 1, Scan Manager
builds the list of sizes based on
the physical dimensions of the
scanner, instead of using the list
returned by the Twain source.
For the Canon DR-5080C TWAIN,
the default is 1.
4334 7798–006
15–11
Scan Manager
ScanManager
Entry
DSPixelFlavor
Description
Specifies the Twain
ICAP_PixelFlavor capability
setting.
Value
0
Chocolate
1
Vanilla
0
Chocolate
1
Vanilla
Use this setting only if you need
to work around Twain source
problems that result in negative
or reverse video images.
DSPixelFlavorCodes
Specifies the Twain
ICAP_PixelFlavorCodes capability
setting to use when you scan
with a CCITT compression
setting such as TIFF Group IV. By
default, Scan Manager uses the
same value as DSPixelFlavor.
Use this setting only if you need
to work around Twain source
problems that result in negative
or reverse video images.
EarlyImageProcessin
g
ExtraTwainResetAt
Startup
Despeckles, deskews, and
deborders an image before
searching for patch codes or
barcodes. Scan Manager
Professional Edition only.
0
Does not
perform early
processing
Sends an extra reset command
to the Twain driver for the Kofax
Adrenaline 850, but explicitly
does NOT do so for the
Adrenaline 1700.
0
No reset – for
ALL scanners except
Adrenalin 850
Set the value to 1 only if you are
using the Kofax Adrenaline 850
scanner.
15–12
1
Performs early
processing
1
Resets the
Twain driver for the
Kofax Adrenalin 850
4334 7798–006
Scan Manager
ScanManager
Entry
FakeModeFeederDir
FakeModePage1
Description
Value
Reads from a directory instead of
from a physical scanner when
the Scan Mode is the dir test
mode; for example, when you
add /sm=dir to the command
line. The directory is treated as a
virtual document feeder, reading
images from this directory then
deleting them. Deleted images
are sent to the Recycle Bin. You
can change the value to any
existing, accessible, writable
directory name
C:\TempScanDir
Specifies the full path name of an
existing TIF image file in the
directory specified by the
SampleDir settings. This setting
and FakeModePage2 provide two
sample images to simulate
scanning when the Scan Mode is
the fake test mode. When
activated, and you select the
Scan command button, Scan
Manager simulates the scanning
of physical documents.
FakePage1.tif
The value can be
changed to any
existing, accessible,
writable directory
name.
See also FakeModePagesInADF
to set the number of pages to
read from this virtual document
feeder.
Test Mode is enabled when
either:
No accessible default TWAIN
scanner is found.
You use the command line option
/sm=fake.
FakeModePage2
Same as FakeModePage1
FakePage4.tif
FakeModePages
InADF
Specifies the number of pages to
scan from a virtual document
feeder you set up for testing. See
FakeModePage1.
4
4334 7798–006
15–13
Scan Manager
ScanManager
Entry
Height
LastBatchName
Description
Stores the most recent height of
the main window, in twips.
4410
Stores the last batch name used
by Scan Manager, and enables
Scan Manager to preserve the
Document Name between
sessions.
NN –The maximum
length is 44
characters, and
cannot contain the
characters
/,\,%,*,",",|,=,&.
For internal Scan Manager use
only.
LastBatchProfile
LastDocClass
LastDocName
Value
Do not modify.
Do not modify.
Stores the full path name of the
last valid Scan Manager profile
selected by the user. Profiles
use the .SMP extension.
Standard.smp
Stores the last valid doc class
used in the LastDomain
Workflow Domain
(empty string)
Stores the name of the last valid
Document Name used, and
(empty string)
enables Scan Manager to
preserve the Document Name
between sessions.
Do not modify.
Do not modify.
Do not modify.
For internal Scan Manager use
only.
LastDomain
15–14
Stores the last valid Workflow
Domain name used.
(empty string)
Left
Stores the most recent position
of the left side of the main
window, in twips, calculated to
center the main window on the
monitor screen.
Do not modify.
LocalizeToolbar
Determines whether Scan
Manager localizes the toolbar by
retrieving the toolbar strings from
its localization file. Because this
can be a time-consuming
process, you can bypass this for
US English systems.
0
No
1
Yes
Do not modify.
4334 7798–006
Scan Manager
ScanManager
Entry
Description
Value
LogFileDeleteOn
Startup
Indicates whether to delete the
Scan Manager log file when you
start Scan Manager. You set this
value in the Program Options
dialog box, on the Logging tab.
0
No
1
Yes
MaxSkewForFalsePo
sCheck
Indicates the maximum amount
of skew (the angle in degrees) for
a detected patch code to be
subject to the false positive
checking. If a patch code is
detected, and is skewed at an
angle less than or equal to this
value, then it may be checked for
a false positive (if
ReduceFalsePosPatchCodes=1).
If the angle of skew is greater
than this value, the patch code is
l always accepted.
2
<an integer in the
range 0 to 45>
See also
ReduceFalsePosPatchCodes.
NegateEveryImage
ProfileDir
4334 7798–006
Indicates whether to invert
(reverse video) each scanned
image. If you experience a
problem with a particular Twain
driver, that results in all images
appearing as negatives (white
text on black background), then
you can set this option.
0
No
1
Yes
Indicates the directory in which
to store local batch profile files.
Located under the system
Common AppData directory, if
the directory does not exist, the
directory is created. You can set
this option in the Program
Options dialog box on the
Logging tab.
Profiles
subdirectory
15–15
Scan Manager
ScanManager
Entry
Description
ReadToolbarLayoutFil
e
Controls whether Scan Manager
reads the toolbar configuration
file, ToolbarLayout.atb, located in
the local data directory. For
example, on a Windows 2000
workstation, the local data
directory is:
C:\Documents and Settings\
<username>\Application Data\
Unisys\UeWI\ScanManager\<version>\
ToolbarLayout.atb
Using the last value (empty)
results in the loss of any existing
toolbar customization
information, This is necessary to
use the new toolbar information.
You can force this to occur by
deleting your ToolbarLayout.atb
file. Then the file is recreated
with default settings.
ReduceFalsePosPatc
hCodes
Indicates whether to ignore
detected patch codes, if the
codes fall outside of the standard
specifications for a patch code
(called false positives).
Specifically, if you set this value
to 1, Scan Manager ignores a
patch code if the detected
candidate is less than 2 inches
wide, or is outside the height
range of 0.6 to 1.0 inches. .
Value
1
Read layout file
at startup (normal
value)
0
Use the Scan
Manager default
toolbar settings and
not those in the
ToolbarLayout.atb
file. (not normally
used)
<empty> Use the
new Scan Manager
default settings one
time, reset the value
to 1, and then
resume normal
operations. (used
after installation of a
new Scan Manager
version that includes
new toolbar data)
0
No
1
Yes
1
Do not modify.
See also
MaxSkewForFalsePosCheck.
ScanBufferOptimizati
on
15–16
For internal use only.
4334 7798–006
Scan Manager
ScanManager
Entry
ScanTimeout
ScanWindowVisible
Description
Value
Indicates the approximate
number of seconds of inactivity
until Scan Manager stops waiting
for images to come from the
scanner, and prompts the user to
continue waiting. You set this
option using the Program
Options dialog box.
0
Indicates whether to show or
hide the scan window that
receives the pages from the
scanner and passes them to
Scan Manager.
0
Do not show
window
This setting is for testing and
debugging purposes only.
No timeout
1-16000 Seconds
until timeout
1
Show the
hidden scan
Do not modify.
SharedProfileDir
Indicates the directory in which
to store shared batch profile files.
Located under the system
Common AppData directory, if
the directory does not exist, the
directory is created. The directory
must be a valid, shared,
accessible, writable directory
name. You set this option using
the Program Options dialog box
Logging tab.
SharedProfile
subdirectory
ShortcutBarVisible
Indicates if the Options bar is
visible.
Do not modify.
4334 7798–006
0
Not visible
1
Visible
15–17
Scan Manager
ScanManager
Entry
TestDir
Description
Indicates the directory in which
to store test image files and
utility programs. Use this
primarily when Scan Mode is the
script test mode, for example,
when you use the command line
option /sm=script . Located
under the system Common
AppData directory, this must be a
valid, accessible, writable
directory name. If the file does
not exist, it is created.
Value
Test subdirectory
In this mode, Scan Manager
reads image files from the test
directory in the order specified in
the special script file called
batch.txt instead of from a
physical scanner. Unlike files
created by the simulated
scanning in the dir test mode,
files scanned in the script test
mode are not deleted after
scanning.
For more information see the
sample batch.txt file in the Test
directory.
Top
15–18
Stores the most recent position
of the top edge of the main
window, in twips, calculated to
center the main window on the
monitor screen.
Do not modify.
4334 7798–006
Scan Manager
ScanManager
Entry
TransferMode
Description
Specifies the Transfer Mode for
the Twain source to use when
transferring scanned image data
to Scan Manager. This equates to
the Twain ICAP_XFERMECH
capability. Normally, Scan
Manager uses the best value for
the Twain source, and no
Registry value is required.
Value
0
Native Transfer
2
Memory
Transfer
Use this setting only if you
experience problems related to
image compression and/or
Native/Memory Transfer mode.
TWAINAutoScanMod
e
Controls the Twain AutoScan
capability of a scanner, and
0
Always disable
AutoScan.
enables you to scan ahead, that
is to continuously scan images,
even if the application is not
ready for them.
1
Enable
AutoScan only if
Scan Manager
is operating in
queuing mode (pages
are continuously
scanned vs. pages
scanned on page-at-atime).
Because this feature can
potentially cause confusion,
especially if rescans are required,
we recommend leaving this
setting at its default setting of 0.
2
Always enable
AutoScan.
TWAINSourceIsRead
only
Indicates whether Scan Manager
should assume that the scanner
settings in the Twain source
cannot be modified.
Do not modify.
0
Not read-only
1
Read-only
This value is primarily for testing
purposes. If a problem exists
with the Twain source, Scan
Manager automatically sets the
value internally.
4334 7798–006
15–19
Scan Manager
ScanManager
Entry
15–20
Description
Value
UpdateNonNumericD
ocName
Indicates whether to
automatically increment the
DocName field if the current
value does not end with a
numeric value. For compatibility
with earlier versions, the default
is 1. If set to 0, such names will
not be altered on a NewDoc
request.
0
No
1
Yes
UsePlatinumBarcode
Indicates whether to use the
fastest possible barcode
recognition speed.
0
No
1
Yes
UseSeparatorIndexDa
ta
Indicates whether to include the
batch and document separator
index data from the Assembly
window.
0
No
1
Yes
Width
Stores the most recent width of
the main window, in twips.
Do not modify.
WindowState
Indicates whether to open the
Scan Manager window in
minimized or maximized state.
Do not modify.
0
Normal
1
Minimized
2
Maximized
4334 7798–006
Scan Manager
Shared
This subkey contains registry entries shared by all Scan Manager programs.
SHARED Value
Entry
BatchDir
Description
Value
Indicates the directory in which
to store batch files. Located
under the system Common
AppData directory, the directory
should be a valid, accessible,
writable directory name. If the
directory does not already exist
it is created.
Batches subdirectory
You set this directory in the
Program Options dialog box.
CompressionColor
Contains the Luminance,
Chrominance, and Subsampling
values to use for each
ImageColorCompression color
setting. The value is a string of
triplets (Lum:Chrom:Subsamp)
for each of the 4 settings (Low,
Med, Hi, Custom). All values
are separated by a colon ( : )
20:30:0:80:90:3:160:18
0:3:80:90:3
Luminance (0-255)
Chrominance (0-255)
Subsampling (0-3)
Lower numbers produce lower
compression, but better image
quality and larger image size.
CompressionGrayscal
e
Contains the Luminance values
to use for each of the
ImageColorCompression
grayscale settings. The value is
a string of Luminance values
containing each of the 4
settings (Low, Med, Hi,
Custom), separated by a colon (
:)
20:80:160:70
Luminance (0-255)
Lower numbers produce lower
compression, but better image
quality and larger image size.
4334 7798–006
15–21
Scan Manager
SHARED Value
Entry
CropPercentBlack
Border
Description
Indicates the threshold
percentage used to detect
black pixels around the edges
of an image. If the percentage
exceeds the value you set,
Scan Manager crops the
edges.Scanned documents
sometimes have edges where
the selected scan area falls
outside of the scanned page.
Use the Advanced Scanner
options to configure Scan
Manager to remove the black
edges based on a defined
threshold. You can adjust this
number to compensate for the
typical noise found in scanned
documents. The units are
tenths of a percent, for
example, 1 = 0.1%, and 50 =
5%.
Value
> 0 and < 1000.
800 Removes borders
80% or more black.
Beginning with the top row,
each row is examined for pixels
containing the border color. If
the percentage pixels
containing the border color in
that row and its adjacent row is
greater than this setting, the
row is eliminated and the next
row is examined. The process
continues until the number of
pixels containing the border
color is less than this setting.
The same process is applied for
rows from bottom to top and
from the left-most column to
the right and from the rightmost column to the left.
15–22
4334 7798–006
Scan Manager
SHARED Value
Entry
Description
CropPercentWhiteBo
rder
Indicates the threshold
percentage of black pixels
around the edges of an image.
If the percentage falls below
this value, Scan Manager
considers the area empty white
space for white border
cropping.
Value
>0 and < 1000.
5
Removes borders
0.5% or less black.)
See also
CropPercentBlackBorder..
These are similar, except
CropPercentBlackBorder
determines when a black
border exists, and
CropPercentWhiteBorder
determines when a white
border exists.
The units are tenths of a
percent, for example, 1 = 0.1%,
and 50 = 5%.
FormDir
Indicates the directory in which
to store doc class forms for
retrieval. Located under the
system Common AppData
directory, if it does not already
exist the folder is created. You
set this option using the
Program Option dialog box
Logging tab.
Forms subdirectory
HelpDir
Indicates the directory in which
to find the Scan Manager and
Batch Viewer Help files.
Located under the Scan
Manager installation directory,
the directory should be a valid,
accessible directory name. If it
does not already exist, the
directory is created.
Help subdirectory
4334 7798–006
15–23
Scan Manager
SHARED Value
Entry
Description
ImageColorCompress
ion
Specifies the image
compression format to use
when storing scanned color
images from a batch file. The
value indicates which value
triplet (luminance, chrominance,
subsampling) to use from the
CompressionColor or
CompressionGrayscale values.
0
Lossless LZW
1
Color Low
2
Color Med
3
Color High
4
Color Custom
5
Grayscale Low
All images are internally stored
in TIFF format, using the
ImageColorCompression
algorithm, Since this specifies
the initial scanned
compression, it represents the
highest quality that could ever
be obtained from scanned
images throughout any
subsequent image processing
operations
6
Grayscale Med
7
Grayscale High
8
Grayscale Custom
Determine how the batch
output processor treats color
image pages when sending
them to the Workflow Domain
Subsystem through RBE or
CWM.
0
Import to
document as foreign
attachment
ImageColorTarget
Value
1
Add to document
as an InfoImage color
image page.
2
Add to document
as an InfoImage color
image page and
include a black/white
copy of the image for
compatibility with old
workstations.
InstallPath
Indicates the path in which you
installed Scan Manager.
Important: Do not
modify manually!
C:\Program
Files\UeWI
15–24
4334 7798–006
Scan Manager
SHARED Value
Entry
Description
Value
LogFile
Indicates name and location of
the Scan Manager log file. Use
any valid path and file name
that is writable and deletable by
Scan Manager. You set this
option using the Program
Options dialog box Logging tab.
full path
LogFileDeleteOnStart
up
Indicates whether to delete the
Scan Manager or Batch Viewer
log file each time you start the
application
0
No
1
Yes
LogMode
Specifies the types of Scan
Manager messages to log You
set this option using the
Program Options dialog box
Logging tab.
Do not manually
change this option.
If you set this value greater
than 0, the following additional
log files are generated in the
Windows temporary directory:
0
No Logging.
1-63 Bitmask that
specifies logging
levels.
BatchOutputUI.log
BOKrnl.log
smUeWIIS.log
OverlayDir
4334 7798–006
Indicates the directory in which
to store overlay forms for
retrieval. Located under the
system Common AppData
directory, the directory should
be a valid, accessible, writable
directory name. If it does not
already exist, the directory is
created. You set this option
using the Program Options
dialog box Logging tab.
Overlays subdirectory
15–25
Scan Manager
SHARED Value
Entry
Value
PreviousImageDir
Stores the names of the last
directory used. This directory
becomes the starting point
directory for subsequent Open
Image dialogs. The directory
can be any accessible directory
name.
SampleDir
SampleDir
Indicates the location of the
sample image and data files
installed with Scan Manager.
Located under the InstallPath
directory, the directory can be
any accessible directory name.
Samples subdirectory
SharedFilesDir
Specifies the location of the
common Scan Manager
program files.
Do not modify.
ShowSplashScreen
Indicates whether Scan
Manager should display its
startup (“splash”) screen during
its initialization.
0
No
1
Yes
Specifies the level of expertise
of the current Scan Manager
user. In future versions, this
might determine the user
interface presented to the user.
Not currently used.
Indicates the installed
InfoImage version on the local
system so Scan Manager can
determine whether to refresh
the Workflow Domain,
DocClass, and other
information. The information
refreshed depends on whether
you run Scan Manager from an
InfoImage back-end, or in a
standalone environment. You
set this option using the
Program Options dialog box.
0 No InfoImage
environment
UserLevel
UseUeWI
15–26
Description
0
Novice user
1
Advanced user
4 Running in an
InfoImage Release 4
environment
5 Running in an
InfoImage version 5.0
or later environment
4334 7798–006
Scan Manager
Custom Defaults and Overrides
The Defaults and Overrides subkeys give you more control over Scan
Manager Registry settings. For example you can now
•
Specify your own default settings for all users that differ from the hardcoded defaults
•
Specify settings that override individual user settings to enforce settings
for all users
•
Prohibit users from changing certain settings
•
These two keys are a subset of the normal Registry settings found in
HKEY_CURRENT_USER\Software\Unisys\UeWI\ScanManager\<version>,
and do not include settings stored in the Scan Manager Profile files
(.smp). A list of allowable custom Default and Override subkeys follows
the tables.
Defaults are the initial values set for first-time Scan Manager users or users
who need to revert to default settings. Overrides are values imposed on all
users on a given machine, regardless of the setting in their personal area of
the Registry. An override value is written into the per-user area, overwriting
any existing value.
Enforcing Custom Defaults and Overrides
To enforce overrides, you can set a flag that prevents users from changing
any settings while using Scan Manager. You specify overrides under the
Overrides subkey. If set, the Enforce Overrides feature prohibits any user
from setting values for those controls specified in the Overrides subkey. If
you do not set the Enforce Overrides value, then Scan Manager starts up
using the Overrides setting, but the user can change the value during the
current session.
When you start Scan Manager on a workstation, Scan Manager uses the
following logic to determine the value of a given setting:
1. Check for a value in the Overrides subkey in the HKLM area.
2. If found in Overrides, use the Overrides value. If the value comes from
the Overrides subkey, and if the Overrides subkey contains the value
(EnforceOverrides)=1, then the user interface prohibits the user from
changing the value.
3. If not found in Overrides, look in the per-user area (HKCU).
4334 7798–006
15–27
Scan Manager
4. If found in per-user area under HKCU, use the per-user area value.
5. If not found in the Overrides subkey or in the per-user area, look in the
Defaults subkey area of HKLM.
6. If found in the Defaults subkey, use the Defaults subkey value.
7. If still not found, use the value hard-coded default Scan Manager value.
To set custom defaults
1. Add a Defaults subkey in the
HKEY_LOCAL_MACHINE\Software\Unisys\UeWI\ScanManager\<version> area
of the Registry.
2. Using the list of allowable Default and Overrides values, add one or
custom default values.
To restore installation defaults
1. Under the subkey
HKEY_CURRENT_USER\Software\Unisys\UeWI\ScanManager\<version>,
delete the ScanManager folder.
2. Restart Scan Manager.
To set Overrides
1. Add an Overrides subkey in the
HKEY_LOCAL_MACHINE\Software\Unisys\UeWI\ScanManager\<version> area
of the Registry.
2. Using the list of allowable Default and Overrides values, add one or more
string values. The name of the value is the same name as found in the
HKCU area. The value is any legitimate (string) value for that setting.
Defaults
The following Scan Manager registry keys are located in the registry path
HKEY_LOCAL_MACHINE\Software\Unisys\UeWI\ScanManager\<version>
\Defaults.
15–28
4334 7798–006
Scan Manager
Default values appear in bold type.
Value Entry
Description
<any
allowable
setting>
See Custom Defaults and Overrides
Values below.
DataPath
Specifies the default root path to all
primary folders – Batches, Forms,
Overlays, Profiles, Shared Profiles,
and Test. You can substitute the
names of the following special
variables. Supported variables
supported:
Value
<any valid complete folder
spec>, including special
variable substitution
Example
%SYSTEM%\Images
might equate to
%LOCAL_APPDATA%
%COMMON_APPDATA%
%PROGRAM_FILES%
%MYPICTURES%
%PROGRAM_FILES_COMMON%
%COMMON_DOCUMENTS%
%PERSONAL%
%APPDATA%
%WINDOWS%
%SYSTEM%
C:\Winnt\System32\Ima
ges
Overrides
The following Scan Manager registry keys are located in the registry path
HKEY_LOCAL_MACHINE\Software\Unisys\UeWI\ScanManager\<version>
\Overrides. Default values appear in bold type.
Value Entry
Description
<any allowable
setting>
See Custom Defaults and
Overrides Values below.
(EnforceOverrides)
Indicates whether to enforce any
Override settings and
consequently disable the user
interface. If set to 0, the setting
is overridden, but the user can
change the setting during the
current session only.
4334 7798–006
Value
0
No
1
Yes
15–29
Scan Manager
Custom Defaults and Overrides Values
The following is a list of Registry values you can place in the Defaults and
Overrides subkeys of the Registry.
BatchOutput\Kernel
AutoFailureNotification
RetainSuccessfulBatch
BatchViewer
AllowPageChangesOnIndex
AutoOpenOnIndex
ClosePageViewersOnIndex
CreateThumbnails
CreateThumbsOnOpen
MaxViewers
OverrideFormImageDefinitions
RequiredFieldsStopSend
RetainFormDataOptions
UseTextNotes
ScanManager
BatchAutoFixNames
CanModifyImages
DiscardedImagesDir
DSCannotSetBrightnessOrContrast
DSSetFrameAfterOrientation
DSIgnoreSupportedSizesList
DSPixelFlavor
DSPixelFlavorCodes
ExtraTwainResetAtStartup
FakeModeFeederDir
FakeModePage1
FakeModePage2
FakeModePagesInADF
MaxSkewForFalsePosCheck
NegateEveryImage
ProfileDir
ReadToolbarLayoutFile
15–30
ReduceFalsePosPatchCodes
ScanBufferOptimization
ScanTimeout
SharedProfileDir
TestDir
TransferMode
TwainAutoScanMode
UpdateNonNumericDocName
UsePlatinumBarcode
UseSeparatorIndexData
Shared
BatchDir
CompressionColor
CompressionGrayscale
CropPercentBlackBorder
CropPercentWhiteBorder
FormDir
HelpDir
ImageColorCompression
ImageColorTarget
LogFile
LogFileDeleteOnStartup
LogMode
OverlayDir
SampleDir
SharedFilesDir
ShowSplashScreen
UseUeWI
Special (only in HKLM)
(EnforceOverrides)
<only for Overrides>
DataPath
only for Defaults
4334 7798–006
Section 16
Storage Manager
This section describes the registry keys used by the Unisys Storage Manager
software to modify system behavior.
<Storage Manager Name>
This key has the following location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\<version>\InfoImg\STOR
AGEMGR
Value Entry
ACTIVE
Description
Provides the status of the
Storage Manager.
Values
Y
The Storage Server is
active.
N The Storage Server is in
active.
Unless otherwise noted, registry keys for Storage Manager have the following
location in the registry:
HKEY_LOCAL_MACHINE\SOFTWARE\Unisys\InfoImage\version\InfoImg\STORA
GEMGR\<StorageManagerName>
Default values appear in bold type.
4334 7798–006
16–1
Storage Manager
COMMON
This subkey contains value entries to indicate Storage Server values and other
common values.
COMMON
Value Entry
Description
DB_MULTITHR
EADED
Indicates whether the
access to the ODBC driver
is single-threaded or multithreaded.
1
Multi-threaded
0
Single-threaded
LOCATOR
Sets the name of the
machine on which the
relational catalog database
is installed.
Default The Storage
Server name
LOG_DIR
Sets the directory path for
the process log and debug
files.
A directory path
NET NAME
Specifies the network
name.
Default The Storage
Server name
This name is written in the
NetName field of each
entry in the volume table.
Maximum eight characters
Enables the trace
mechanism, used for
debugging.
0
No trace
1
Function tracing
2
Data tracing
NETTRACE
Note: Always set this value
to 0 in a production
environment, because
detailed tracing slows
down the system
significantly. Tracing
should be used only for
debugging.
16–2
Values
Maximum eight characters
3
Both function and data
tracing.
4334 7798–006
Storage Manager
COMMON
Value Entry
Description
ODBCDEFAULT
POOL SIZE
Sets the handle pool size
of a process if the process
does not have an entry
under the ODBCSETUP
sub key.
Values
Minimum
1
Maximum
>1
Default
20
The original ODBC
POOLSIZE under the
COMMON subkey should
be replaced with this
parameter.
SERVER
Sets the name of the
Workflow Domain
Subsystem, if the
Workflow Domain
Subsystem is installed on
the same pc as the
Storage Manager.
Default The Storage
Server name
Maximum eight characters.
Required
STORAGE
Sets the name for this
Storage Server on the
network.
Name specified during
configuration.
Maximum eight characters.
Required
Must be unique across all
Workflow Domain
Subsystems and Storage
Servers that have network
connectivity.
4334 7798–006
16–3
Storage Manager
LOCATOR
LOCATOR
Value Entry
DATABASE
Description
Values
The name of the ODBC
DSN.
Default
DEFAULTINDEX
The name of the default
index that is mounted for
the enterprise.
The host security
administrator provides this
value.
MAINFRAME_VER
SION
Indicates which version of
the Catalog is being used.
0
PASSWORD
Sets the access password
for the Relational Catalog.
If there is no value in this
entry, then the password
indicated in the PASSWORD
entry, in the COMMON
subkey is used
Sets the access user ID for
the relational catalog.
If there is no value in this
entry, the User ID in the
USERID entry, in the
COMMON subkey will be
used.
(Relational Only)
(Relational Only)
USERID
CATALOG
Relational Catalog
Network Communication Keys
The Storage Server uses the following keys to enable network communications
through TCP/IP protocol:
16–4
•
NETCALL
•
NETLISTEN
•
NETMODULE
•
NETSETUP
4334 7798–006
Storage Manager
NETCALL
The value entries in this subkey are used to configure the protocol and protocol
adapter number that each process API uses to initiate an outbound conversation.
TCP/IP Format
<Name>/<API>:<Protocol name>,<Protocol info>
Where:
Name is a specific storage server name (may include an asterisk (*) as a
match character).
API is a three-character API (or an asterisk (*) to specify any API)
Protocol name is the protocol name.
Protocol info is the network protocol information, if any is required.
Sample TCP/IP entries
*/*:REG_SZ:TCP/IP,0
4334 7798–006
16–5
Storage Manager
NETLISTEN
The value entries in this subkey are used to configure the threads, protocol, and
protocol adapter on which the process APIs listen.
TCP/IP Format
<Process name ><API ><Instance >:<Protocol name >,<Threads
>,RESERVED,<Storage Server>,
Where:
Process name indicates the name of the process (Archive)
API is the three-character API name (ARC, ARM, OTP).
Instance is a number starting at 1 and incremented for each protocol.
Protocol name is the name of the network protocol.
Threads are the number of listen threads for this API.
RESERVED is reserved for future software enhancements
Storage Server is the name of the storage server
Sample TCP/IP entries
ARCHIVEARC2:REG_SZ:TCP/IP,15,RESERVED,SERVER1,
ARCHIVEARM2:REG_SZ:TCP/IP,15,RESERVED,SERVER1,
ARCHIVEOTP2:REG_SZ:TCP/IP,10,RESERVED,SERVER1,
The comma after the Storage Server is necessary for the functioning of the
Storage Server.
16–6
4334 7798–006
Storage Manager
Increasing NETLISTEN Threads
Increasing the NETLISTEN threads allows more clients to be served.
However, simultaneously, increasing NETLISTEN threads consumes
resources (for example, memory for stack) and requires service from
Windows NT’s scheduler.
NETMODULE
The value entries in this subkey are used to configure the modules for the
protocols specified in the NETSETUP subkey. There must be one entry for
each protocol specified in the NETSETUP subkey.
Format
<Protocol name>:<Module name>
Where:
Protocol name is the name of the protocol.
Module name is:
TCP/IP module = PASTCPIP
APPC module = PASAPPC
Sample entries
APPC:REG_SZ:PASAPPC
TCP/IP:REG_SZ:PASTCPIP
NETSETUP
The value entries in this subkey are used to configure the protocols (TCP/IP or
APPC) and network resources for each process running on the Storage
Server.
4334 7798–006
16–7
Storage Manager
TCP/IP Format
<Name><Instance>:<Protocol name>
Where:
Name is the storage server process name.
Instance is a number starting at 1 and incremented for each protocol.
Protocol name is the name of the protocol (TCP/IP).
Sample TCP/IP entries:
ARCHIVE2:REG_SZ:TCP/IP
ODBCSETUP
This subkey contains value entries that indicate the maximum number of
concurrently open database connections.
ODBCSETUP
Value Entry
<Process name>
Description
Values
The value indicates the
maximum number of
concurrently open
database connections
allowed for a specific
process, and corresponds
to the process, as follows:
Archive Manager ARCHIVE
The value of the parameter
can be different for each
process, but the total
number of connection
handles for all processes
must not exceed the number
of connection handles
allowed by the DBMS.
Examples:
ARCHIVE
16–8
20
4334 7798–006
Storage Manager
STORAGE
The STORAGE subkey contains general entries for the Storage Manager.
STORAGE Value Entry
ARCHIVE BUFFERS
Description
The number of buffers to be
used for archive file processing.
Values
3
Three is the minimum value
recommended.
ARCHIVE BUFFER SIZE
Specifies the size of the archive
buffers in 1K increments.
64
ARCHIVE DIR
This folder is a temporary holding
place for files transferred to the
Storage Manager. When a file is
archived, it is deleted from this
location.
D:\ARCDATA
ARCHIVE STAT
Indicates whether the Archive
Manager will start up with
archive status Active or Inactive
ON
Specifies whether or not
Storage Manager should read
and possibly compare the
current archive buffer that was
written to disk.
Y Read only
ARCHIVEREADAFTERWRITE
OFF
Archive
status active.
Archive
status
inactive.
C Read and compare
N No read or compare
ARCHIVESPACECRITICAL
Specifies the number of
megabytes of free disk space on
the current archive volume at
which to stop archiving because
free disk space is too low.
Any integer up to
four digits.
ARCHIVESPACEWARNING
Specifies the number of
megabytes of free disk space on
the current archive volume at
which to start issuing warning
messages about low disk space.
Any integer up to
four digits.
Enables page counting. If
enabled, the catalog record will
be updated to contain the page
count of the documents.
A Count all pages –
both the static and
variable portions
of the document.
COUNTPAGES
20
V Count just the
variable portions.
4334 7798–006
16–9
Storage Manager
STORAGE Value Entry
Description
Values
N Disable page
count.
ERROR DIR
The folder into which Storage
Manager will place files it could
not archive.
D:\ERROR
MAX FILES PER DIRECTORY
The number of files per directory
that Storage Manager writes to an
archive volume.
Minimum
1000
Maximum 16000
Note: To use this option, you
must manually add the entry to
the registry.
MAX LOCINFO BLOCKS
The maximum number of
workitem components for which
catalog information is cached,
while archiving, before being
written to the catalog.
500
MAXITERATIONS*
The maximum number of times
the loop will execute while trying
to successfully read data.
String value
between 1 and x
Note: To use this option, you
must manually add the entry to
the registry.
PRETRANSFERDELAY*
When data has been read, this
entry specifies the delay (in
seconds) prior on initiating the file
transfer via the Transfer Manager.
String value
between 1 and
3559
Note: To use this option, you
must manually add the entry to
the registry.
READSTORRESTAGE
When no data is available, this
entry specifies the number of
seconds Storage Manager will
sleep before attempting the next
read.
String value
between 1 and
3559
Note: To use this option, you
must manually add the entry to
the registry.
*Note: MAXITERATIONS, PRETRANSFERDELAY, and READTORESTAGE are used by
external HSM systems that require a read loop to initiate and monitor the restaging of an
16–10
4334 7798–006
Storage Manager
STORAGE Value Entry
Description
Values
archived file from the HSM system. Storage Manager opens the file, attempts to read 16K
of data, and closes the file.
SUMMARY REPORT
Specifies whether successful
archive requests are written to a
journal file (jukelst.dat).
Yes Successful
archive
requests are
written to the
journal file.
No
Successful
archive
requests are
not written to
journal file.
TEMP LOCATOR
Sets the name of the temporary
catalog. The temporary catalog
is used by Storage Manager to
store catalog entries when the
connection to the catalog is not
available.
TEMPLOC
TRACE
Instructs Storage Manager to
write trace information to the
log file (storage.log).
Y
Sets the number of archive
requests to be grouped together
for the main catalog update call.
45
UPDATE MAX LSREC
N
ARCVOLUMES
The ARCVOLUMES subkey contains entries for the volumes you use for
archiving and retrieval. The installation process creates the Volumen subkey.
For each volume you add through the Storage Manager Console, a subkey is
created for the volume.
Value Entry
NoOfVolumes
4334 7798–006
Description
The number of Archive Volume subkeys created.
Values
0
16–11
Storage Manager
Volumen Subkey
The Volumen subkey contains entries that describe each sequentially
numbered volume.
Value Entry
Name
Description
Values
The label and drive letter of the archive volume.
For example:
SM1V01 (E:)
NoOfFiles
80000000
The maximum number of archive files to be
stored on the volume.
DOCFAMILIES
The DOCFAMILIES Key enables you to direct items of various classes or
items containing various attributes to specific archive folders on a volume.
The installation process creates the Familyn subkey. For each document
family you add through the Storage Manager Console, a subkey is created
for the document family.
Value Entry
NoOfFamilies
16–12
Description
The number of document families created,
not counting the Default family.
Values
0
4334 7798–006
Storage Manager
DEFAULT
(Subkey of DOCFAMILIES)
The DEFAULT subkey contains entries for the default document family. The
DEFAULT subkey is created at installation.
Value Entry
Description Values
Name
The name of the default document family.
Path
A path to a folder into which files will be
archived for this family. The path must be
unique for each document family including
the default document family.
NoOfClasses
A count of the number of class criteria
entries that are used to select workitems to
be archived to this document family. For the
DEFAULT document family, the value is
always 0.
Values
0
Familyn
(Subkey of DOCFAMILIES)
The Familyn subkey contains entries for the document family, excluding the
DEFAULT document family.
Value Entry
Description
Name
The name of the document family.
Path
A path to a folder into which files will be
archived for this family. The path must be
unique for each document family including the
default document family.
NoOfClasses
A count of the number of class criteria entries
that are used to select workitems to be
archived to this document family.
4334 7798–006
Values
0
16–13
Storage Manager
Classn
(Subkey of DOCFAMILIES)
The Classn subkey contains entries that describe document family selection
criteria.
Value Entry
16–14
Description
Name
The name of a document class.
Attribute
The name of a form field attribute.
Value
A selected string value for the form field
attribute.
Values
4334 7798–006
Appendix A
Initialization File for 16-bit
Workstations
When you install one of the 16-bit workstations, the infoimg.ini file is installed.
You can edit the Infoimg.ini parameter definitions using Windows Notepad or
any text editor.
[ACDDE]
Key
SYSCONFIELD
SEPARATOR
Description
This parameter specifies the field separator value.
By default it is tab and should not normally need
to be changed. The workstation install does not
add this key to the workstation initialization file.
Add this key only if the default needs to be
changed.
Values
Default Tab
[BATCHPRINT]
Key
Description
Values
Comment
Specifies the comments used for printing.
IncludeAnnots
Specifies whether or not to include annotations
with the printout.
0
1
Include.
IncludeIndex
Specifies whether or not to include the index with
the printout.
0
Do Not Include.
1
Include.
IncludeNotes
Specifies whether or not to include notes with the
printout.
0
Do Not Include.
1
Include.
Name
4334 7798–006
Do Not Include.
Specifies the name of the workitem to print.
A–1
Initialization File for 16-bit Workstations
Key
PagesAll
Description
Determines if you can print all of the workitem
pages.
Values
0 Cannot print all
pages.
1 Print all workitem
pages.
PagesNone
PagesRange
Determines if you can print any workitem pages.
Determines if you can print a range of workitem
pages.
Printer
Specifies the name of the printer.
RangeFrom
Specifies the first page of the range of page. This
is only available if PagesRange is set to 1.
RangeTo
Specifies the last page of the range of page. This
is only available if PagesRange is set to 1.
SaveSettings
Enables you to save the current settings for the
batch print.
0
Cannot print
workitem pages.
1
Can print workitem
pages.
0
Cannot print a
range of pages.
1
Can print a range
of pages.
0 Does not save
settings.
1 Saves settings.
[COMMON]
Key
NETTRACE
Description
Used for debugging purposes only, and should be
set to zero.
Value
0 None
1 Function tracing
2 Data tracing
3 Both 1 and 2
Note:
NETTRACE must be set to 0 in a production environment, because detailed tracing
slows down the system significantly. Tracing should only be used for debugging purposes.
A–2
4334 7798–006
Initialization File for 16-bit Workstations
[DesktopTools]
This section contains the names of third-party Windows applications to be
accessible from the Document Management Workstation.
desktop icon caption=exec file icon file working directory command line
arguments
excel=excel.exe c:\data\excel.ico
c:excel c:\sheet1.xls
Note: The icon file, working directory, and command line arguments are
optional. However, to specify a working directory, an icon file must be
specified. To specify command line parameters, both an icon file and working
directory must be specified.
4334 7798–006
A–3
Initialization File for 16-bit Workstations
[Folder]
This section contains general parameters for all Document Management
Workstation operations.
[Folder] Parameter
Description
Values
BackEnd
Name of the back-end server
executable.
Must be set to
bes_omni.exe.
BATCHContainer Cell
Specifies the icon spacing inside
the Batch Viewer.
200 220 230
200 Horizontal spacing
(distance between
page icons in a batch).
220 Vertical spacing
(distance between
different doc
separator icons in a
batch).
230 Document separation
width (The distance
between the
document separator
icons and the first
page icon in each
row).
A–4
BATCHINDEXPHAS
E REQUIRED
If enabled, documents in a batch
must be indexed before the batch
can be committed. If disabled,
batches can be committed without
indexing. If the IndexVerify
property of the class is set, this
parameter is ignored.
0
Disabled
1
Enabled
BatchPage Prefetch
Number of pages to prefetch when
a batch is opened.
Default
BatchWindow
Indicates the size and location of
the Batch Viewer.
BatchToolbar
Enables you to show or hide the
Batch toolbar.
1
1 Show
0 Hide
4334 7798–006
Initialization File for 16-bit Workstations
[Folder] Parameter
BESTrace
Description
Specifies whether to capture backend server trace information.
BinPath
Sets the path to the ..\bin
subdirectory.
BrowseAllPages
Enables you to set whether or not
you can browse all pages.
ButtonSize
ConfirmDragFile
Sets the size of Toolbar icons.
When enabled, this option displays
a message box, prompting the
user to confirm the drag and drop
of the file to a folder.
Values
0
Does not capture
trace messages.
1
Captures trace
messages.
0
Cannot browse all
pages.
1
Browse all pages.
Large
(32 bit icons)
Small
(16 bit icons)
0
Do not display message
box.
1
Display message box.
ConfirmDrag
NonWipItem
When enabled, this option displays
a message box, prompting the
user to confirm the drag and drop
of the non-WIP item to the
OutBox.
0
No message box.
1
Display message box.
ConfirmDragQueue
Return
When enabled, this option displays
a message box, prompting the
user to confirm the drag and drop
of the workitem to an InQueue.
0
No message box.
1
Display message box.
ConfirmDragSend
When enabled, this option displays
a message box, prompting the
user to confirm the drag and drop
of the workitem to an OutQueue.
0
No message box.
1
Display message box.
ConfirmDragSend
Default
When enabled, this option displays
a message box, prompting the
user to confirm the drag and drop
of the workitem to the OutBox.
0
No message box.
1
Display message box.
ConfirmDrag Unfile
When enabled, this option displays
a message box, prompting the user
to confirm the drag and drop of the
workitem from a folder to the
desktop.
0
No message box.
1
Display message box.
4334 7798–006
A–5
Initialization File for 16-bit Workstations
[Folder] Parameter
Description
Values
CustomScan Program
When enabled, this option sets the
path and name of a vendor scan
program, or a customized scan
program that is executed when the
Scan menu item is selected in the
Batch or Document Viewer.
Valid path and file name.
DBPath
Sets the path to local data file
storage. Required.
C:\FOLDER\DATA
DecompYieldLimit
Specifies the amount of data (in
KB) that the software
decompression routine processes
before giving up control of CPU
resources.
1024
DesktopApp
Specifies the name of the
application that acts as the central
control for resources.
desktop.exe
DESKTOPContainer
Cell
Specifies the item spacing on the
Desktop.
160 120 150
where:
The first value (160) is the
horizontal spacing distance
between page icons, the
second value (120) is the
vertical spacing distance
between different document
separator icons, and the
third value (150) is not used.
DesktopPrefetch
DesktopToolbar
DesktopWindow
A–6
Specifies whether workitems are
prefetched to the desktop.
0
No prefetching
1
Prefetch
Enables you to show or hide the
Desktop toolbar.
1
Show
0
Hide
Indicates the size and location of
the Desktop window in x, y, dx, dy
format.
4334 7798–006
Initialization File for 16-bit Workstations
[Folder] Parameter
Description
Values
DirSize
Specifies the number of files to
store in each DIRnnnnn
subdirectory of the DBPath
directory. Too many files will slow
down access to the DOS File
Allocation Table; too few will cause
too many subdirectories to be
created.
50
DocAutoOpenForm
When enabled, this option
specifies whether a document
form opens automatically when a
document is opened.
0 The document form
does not open
automatically.
Specifies the item spacing in the
document
180 220 150
DOCContainerCell
1 The document form
automatically opens
whenever a document
is opened (as if Index
were selected from
the Document menu).
where:
The first value (180) is the
horizontal spacing distance
between page icons, the
second value (220) is the
vertical spacing distance
between different document
separator icons, and the third
value (150) is not used.
DocPagePrefetch
DocToolbar
DocWindow
4334 7798–006
When enabled, this option
specifies the number of pages to
prefetch when a document is
opened.
0 Disabled
Enables you to show or hide the
Document toolbar.
0 Hide
n number of pages
1 Show
Indicates the size and location of
the Document Viewer.
A–7
Initialization File for 16-bit Workstations
[Folder] Parameter
Description
Values
DomainName
Name of the Workflow Domain to
be automatically displayed in the
Logon Window. If a value is not
entered, the user has to enter the
Workflow Domain name when
logging on (in addition to a user ID
and password).
A Workflow Ddomain
name.
EnumerateDomain
When enabled, queue enumeration
is enabled across all servers in the
Workflow Domain. The result in
the InBox is a view of all
workitems on all servers in the
Workflow Domain for a particular
queue.
0 Disabled
Stores the Type of the last query
form used by the File Cabinet.
Document
When enabled, this option stores
the Name of the last query form
used by the File Cabinet.
The FileCabinet
automatically sets this
value.
FCQry
FCQryName
FOLDERContainer
Cell
Specifies the item spacing in the
Folder.
1 Enabled
The File Cabinet
automatically sets this
value.
160 120 150
where:
The first value (160) is the
horizontal spacing distance
between page icons, the
second value (120) is the
vertical spacing distance
between different
document separator icons,
and the third value (150) is
not used.
FolderPrefetch
FolderToolbar
A–8
When enabled, this option sets the
number of children to prefetch
when a folder is opened.
0 Disabled
Allows you to show or hide the
Folder toolbar.
0 Hide
n Number of children
1 Show
4334 7798–006
Initialization File for 16-bit Workstations
[Folder] Parameter
Description
FolderWindow
Indicates the size and location of
the Folder Viewer.
FileToolbar
Sets the view of the Batch toolbar.
Values
0 Hide
1 Show
HelpPath
Sets the path for the on-line help
file.
IconCaptionFont
When enabled, this option sets the
name of the font to load for the
Desktop icon captions. Also sets
the font for icons in the other
viewers.
The default value is the
default font in Windows.
IconCaptionFont
Height
When enabled, this option sets the
font height to use with the name
of font. Also sets the font height
for icons in the other viewers.
0 Disabled
ImageToolbar
Sets the view of the Image toolbar.
1 Enabled
0 Hide
1 Show
ImageWindow
Indicates the size and location of
the Page Viewer.
INBOXContainer
Cell
Sets the item spacing in the InBox.
160 120 150
160
Horizontal (distance
between page
icons).
120
Vertical (distance
between different
document
separator icons).
150 Not used.
InboxEnumSize
InboxToolbar
Sets the maximum number of
items to display in the InBox in
Enumerate mode.
Default
Sets the view of the Inbox toolbar.
0 Hide
200
Maximum 500
1 Show
LocalDir
4334 7798–006
Sets the path to the ..\sys\data
subdirectory.
A–9
Initialization File for 16-bit Workstations
[Folder] Parameter
LocalPrintDevice
Description
Values
Sets the name of the local printer
device chosen in the Print/Fax
dialog box.
Normally, there is no need to set
this INI parameter; it is handled by
the Print/Fax dialog box. If the DDE
API is used to programmatically
print a workitem, it may be
necessary to set this INI
parameter to pick the printer
destination.
Log
Output goes to the log file
0 Output will not go to
the log file.
1 Output will go to the
log file.
MaxLocalPrint
FormWidthInChar
Configures the printable form
width for Local Print. The value is
in characters.
Minimum
MaxMatch
Specifies the maximum number of
matches for a FileCabinet query.
Minimum
80
Maximum 132
1
Maximum 23767
Default
MinLPFreeMem
Specifies the minimum amount of
memory (in KB) required before a
local print operation is executed.
Default
80
ObjDBCache
Sets the local database cache. This
is the amount of memory (in KB)
reserved for the local database
caching algorithms.
Default
512
Determines whether page names
are displayed in the Batch Viewer.
This is set through the Options
menu in the Batch Viewer.
1 Display
Enables the display of image page
numbers in the Batch Viewer.
0 Disable
PageNames
PageNumbers
A–10
50
For optimal performance,
set this to a value between
512 and 1024.
0 No display
1 Enable
4334 7798–006
Initialization File for 16-bit Workstations
[Folder] Parameter
PageStyle
PostageStamp
ScaleFactor
Description
Values
Determines whether cascade or
stack mode is used for displayed
pages. This is automatically set
through the Options menu in the
various viewers.
1 Cascade mode
When enabled, this option sets the
display size of the postage stamps
(miniature bitmap images of a
page).
Minimum
2 Stack mode
10%
Maximum 300%
Default
67%
Recommended values are:
PrintFaxDlg
80
VGA, 13" monitor
(640x480).
66
SVGA, 15" monitor
(1024x768).
80
Color, 19" monitor
(1600x1200).
Defines the different preferences
selected on the Print/Fax dialog box.
Reclassify Batches
Default
1
1000
RegDiskSpace
Specifies the amount of free disk
space (in KB) required before
logging into the system.
Default
ReqDiskSpace
Specifies the amount of free disk
space (in KB) required before
retrieving a workitem to the
workstation.
Default 1000
ResultsList Toolbar
Allows you to show or hide the
Results List toolbar.
0 Hide
Specifies whether workitems
retrieved from the Query Results
Viewer are opened automatically.
This can be toggled through the
AutoView menu item in the
Options menu in the Query
Results Viewer.
0 No autoview
RVAutoview
4334 7798–006
1 Show
1 Autoview
A–11
Initialization File for 16-bit Workstations
[Folder] Parameter
Description
Values
Specifies whether workitems are
retrieved to folders from the Query
Results Viewer.
0 Workitems are not
retrieved to folders.
Specifies whether workitems are
retrieved to folders from the
Results Viewer. This can be toggled
through the Options menu in the
Query Results Viewer.
0 Workitems are not
retrieved to folders.
SAVESENDDEFAUL
T ENABLED
When enabled, this option specifies
whether the Save and Send to
Default feature is enabled.
0 Disabled
ScanQCWin
Notes size and location of the
scanner image quality control
window.
It should not be
necessary to adjust this
parameter.
ScanWin
Indicates the size and location of
the Scanner dialog box.
ScreenTimeout
Number of minutes the Logon
screen displays before going into
screen saver mode. If the value is
zero, or if this parameter is
removed, the Logon screen goes
into screen saver mode after one
minute.
Default
SuppressBESmsg
System parameter.
Do not modify.
SysPath
Specifies the path to the
workstation system files.
Default
RVReserve
RVToFolder
1 Workitems are
retrieved to folders.
1 Workitems are
retrieved to folders.
1 Enabled
30
..\sys
Required.
Trace
A–12
Specifies the logging of low priority
messages and debug tracing
information.
1 Enable logging.
0 Disable logging of
these messages.
4334 7798–006
Initialization File for 16-bit Workstations
[Folder] Parameter
Unified Logon
Description
Sets whether to use the same
User ID that is used to log on to
Windows NT domain is used to log
on to the Workflow Domain.
Values
1 Yes
0 No
Note:
The InfoImage software Workflow Domain determines unified logon. If the
Workflow Domain is configured for unified logon, the unified logon password and ID is used.
If the Workflow Domain is not configured for unified logon, the password and ID specified by
the registry will be used. For more information about setting up Unified Logon, see Appendix
C of the Installation and Configuration Guide.
UseColorApp
Workspace
Specifies whether to use the
Windows Application Workspace
color for the Inbox and Desktop.
You can use this only on an onbit/pixel display.
0 Disable
UseListViewer
Inbox
Enables the display of workitem
form data in the InBox List Viewer.
0 Disable
UseQuotedDDEListVi
ewerInboxContents
Specifies whether to use quotes to
enclose fields in quotes.
0 Don’t use quotes
1 Enable
1 Enable
1 Use quotes
If the key is absent or set to 0,
fields in the list viewer InBox are
formatted without quote, for
example
96101GERN001134,3,AAAF0004,dom1,,1996-04-1013.09.09.13,,0,,4,CLAIM_SCREENI
NG,CS_ALL,HCFA1500,0,,0,0,0,0,0
,,,,,ABC.
If set to 1, the same contents
would be formatted as
“96101GERN001134”,”3”,”AAAF0004”,”dom1”,””,”1996-04-1013.09.09.13”,””,”0”,””,
”4”,”CLAIM_SCREENING”,”
CS_ALL”,”HCFA1500”,”0”,””,”0”
,”0”,”0”,”0”,”0”,””,””,””,””,
”ABC”,””
UITrace
Specifies whether user interface
trace information is captured.
0 Trace information is
not captured.
1 Trace information is
captured.
4334 7798–006
A–13
Initialization File for 16-bit Workstations
[Folder] Parameter
Description
WorkPath
Sets the path to temp/scratch files
created by the workstation.
Required.
XEQFile
The path and file name used by the
IBM Image Adapter/A display card.
Values
Default ..\sys\data
[FORMAP]
This section contains the parameter that specifies the number of forms you
can cache in the workstation memory.
Parameter
CACHE_MAX
A–14
Description
Specifies the maximum number of
forms cached in memory on the
workstation. The workstation
maintains this value by discarding
unused forms if this value is
exceeded. Several copies of the
same form may be resident in the
cache at the same time if the
workstation requires several copies
in use at any one time. If this value
is frequently exceeded,
performance gains at the
workstation will decrease, as the
workstation tries to maintain this
value by discarding and loading
forms into the cache. If this occurs,
this value should be increased.
Values
Default
20
4334 7798–006
Initialization File for 16-bit Workstations
[FormBuilder]
This section contains parameters for Forms Creator.
Parameter
ColorField Inactive
Description
Sets the color (in RGB values) to use
for fields in Forms Creator.
Values
Default
64,64,64
(light gray)
ColorFieldEdit
Sets the color (in RGV values) to use
for the active field being edited in
Forms Creator.
CourierFont
Specifies whether to use the courier
font.
0
No courier font.
1
Use courier font.
BigFontHeight
Sets the size of the font in the
Magnified Field window.
Default 37
FormHelpPath
Sets the path for the on-line help file
to the ../sys/help subdirectory.
[FormInterpreter]
This section contains parameters for runtime form editing on a Document
Management or High Performance Workstation. The parameters described
here are used by FormInterpreter and should not need to be changed.
[FormInterpreter]
Parameter
Description
Values
BigFontHeight
Sets the size of the font in the
Magnified Field Window.
Default 37
CourierFont
Specifies whether to use the standard
Courier font.
0
No Courier font.
1
Use Courier font.
FontFaceName
Sets the name of the font in the
Magnified Field Window.
FontHeight
If CourierFont is set to 1, this
parameter specifies the courier font
height.
4334 7798–006
Default 10
A–15
Initialization File for 16-bit Workstations
[FormInterpreter]
Parameter
FontSize
Sets the font size for display.
Values
14 Set it to 14 for
Image Adapter/A
display.
10
Set it to 10 for
VGA display.
FontType
Sets the type of font in the Magnified
Field Window.
FormCache
Enables caching of forms. When
forms are cached, static variable
values can be preserved when a data
entry form is closed.
0
Disable.
1
Enable.
Specifies whether the Magnified Field
window is automatically opened when
the form is displayed.
0
Magnified Field
is not opened.
1
Magnified Field
is automatically
opened.
Specifies whether the Magnify
Window automatically opened when
the form is displayed.
0
Magnified Field
is not opened.
1
Magnified Field
is automatically
opened.
NumberOfForm Cache
Defines the number of forms that can
be cached.
Default 120
RumbaVersion
Indicates the version of Rumba.
SendBlankFields
Specifies whether a blank form field
should be sent to the host application.
MagnifyField
MagnifyLens
ShowImagePage
A–16
Description
Specifies whether the Page Viewer is
automatically opened when the form
is displayed.
0
Do not send
form fields.
1
Send blank
fields.
0
Page Viewer is
not opened.
1
Page Viewer is
automatically
opened.
4334 7798–006
Initialization File for 16-bit Workstations
[FormInterpreter]
Parameter
Description
Values
TermDDE
Application
DDE Application name. This is an
optional parameter.
Consult the vendor for
the appropriate value if
your application
interacts with a host
communication
software package.
TermDDETopic
DDE Topic name. This is an optional
parameter.
Consult the vendor for
the appropriate value if
your application
interacts with a host
communication
software package.
TerminalEmulator
Sets the emulator DLL to use.
TDDEPCOMM If using
IBM PCOMM emulator
package.
TDDERUM If using
RUMBA Emulator
package.
TDDEICC If using ICC.
TERMHLL If using
HLLAPI standard.
Enables caching of user exits. When
user exits are cached, the values of
static variables can be preserved upon
closure of a data entry form.
0
Disable
1
Enable
UserMustVerify
Specifies whether or not a form can
be closed when opened in verify mode
if all of the fields have not been
entered and verified. Setting this value
to 1 requires that all fields in a verify
view be entered and verified before
the form can be closed. Setting this
value to 0 enables a user to close a
form without entering or verifying all
fields in the verify view. Valid values
are 0 and 1.
Default
VerifyView
Name of data verification view.
Default VERIFY
UserExitsCache
4334 7798–006
0
A–17
Initialization File for 16-bit Workstations
[INBOX]
This section contains parameters used in the InBox on a Document
Management Workstation.
[INBOX] Parameter
Values
Specifies whether workitems are
automatically opened when retrieved
from the InBox in Enumerate mode. Can
be toggled through the Options menu in
the InBox.
0
No auto open of
workitems.
1
Auto open of
workitems.
Sets the maximum number of items to
display in the InBox in Enumerate mode.
Maximum
500
Default
200
Specifies whether GetNextMode is
enabled in InBox. Can be toggled
through the Options menu in the InBox.
0
Disabled
1
Enabled
Sets the maximum number of items to
display in the InBox in Enumerate mode.
Maximum 500
InboxSize
Sets how many items to retrieve to the
InBox in GetNext mode.
Default
1
PollInterval
Specifies the polling interval to check
whether another workitem should be
retrieved to the InBox in GetNext mode
in order to maintain the number of items
specified in the InBoxSize parameter.
Default
10
TextMode
Specifies whether the InBox display is
text or iconic. Can be toggled through
the View menu in the InBox.
0
Iconic.
1
Text.
Specifies whether you can view locked
items.
0
Cannot view
locked items.
1
Can view locked
items.
AutoView
InboxEnumSize
GetNextMode
InboxEnumSize
ViewLockedItems
Xc, Yc, nWIDTH,
HEIGHT
A–18
Description
Sets the coordinates of the InBox
window.
Default
250
If not specified, the
Windows defaults are
used.
4334 7798–006
Initialization File for 16-bit Workstations
[INSTALL]
This section contains parameters used in the installation on a Document
Management and High Performance Workstation.
Parameter
Description
DMWSNumber
Current installed release of the
DMWS software.
FormBuilder Number
Current installed release of the Forms
Creator software.
FormBuilderPath
Path of installed Forms Creator
software.
FormBuilder Status
Indicates the type of installation.
Value
Local
NetClient
(Network install only.)
HPWSNumber
Current installed release of the High
Performance Workstation software.
Only appears on HPWS.
InternalRelNum
Indicates the current software release
level. Used internally by the software.
TZText
Indicates the time zone setting of this
workstation.
WorkstationPath
Path of installed DMWS or HPWS
software.
Workstation Status
Indicates the type of installation.
Do not modify.
Local
NetClient
(Network install only.)
4334 7798–006
A–19
Initialization File for 16-bit Workstations
[Markups]
This section contains a parameter used in the installation on a Document
Management and High Performance Workstation.
Key
EnableOLEMarkups
Description
Enables or disables the OLE
subsystem.
Values
0
Disable the OLE
subsystem.
1
Enable the OLE
subsystem.
[NETCALL]
Identifies the server and API, protocol, and protocol-specific information for
outbound network calls. The format of an entry is:
<name>/<API>:<protocol name>,<protocol info>
where:
name
is a client name (may include an asterisk (*) as a match
character).
API
is the three-character API (or an asterisk (*) to specify an API).
protocol info
is the adapter number.
For NetBIOS, the default is:
*/*=NETBIOS,0
For TCP/IP, the default is:
*/*=TCP/IP,0
Note: The workstations must be configured to use the same adapter
number as the Workflow Domain Subsystem . The initial installation
configures NetBIOS for adapter number 0. If your configuration uses an
adapter number other than 0, you can either edit this section to replace
adapter number 0 with your adapter number or reconfigure your LANA
number to 0 for NetBIOS to NetBIOS frames (Nbf).
A–20
4334 7798–006
Initialization File for 16-bit Workstations
[NETMODULE]
Identifies the protocol mapping module DLL that is loaded for the specified
protocol:
NETBIOS=PASNETBW.DLL
TCPIP=PASTCPW.DLL
[NETSETUP]
Provides the protocol-specific configuration for the client process.
The format of a NetBIOS entry is:
<name><instance>:<protocol name>,<adapter>,<sessions>,
<commands>,<network names>
where:
name
is the client process name.
instance
is the number starting at 1 and incremented for each protocol.
protocol name
is the name of the protocol.
adapter
indicates the primary network adapter.
sessions
is the number of NetBIOS sessions allocated to the process.
commands
is the number of NCBs allocated to the process.
network names
is the number of network names allocated to the process.
Sample NetBIOS entry:
WS1=NETBIOS,0,0,0,0
The format of a TCP/IP entry is:
name instance:TCP/IP,adapter
where:
name
is the client process name.
instance
is the number starting at 1 and incremented for each protocol.
protocol name
is the name of the protocol (TCP/IP).
adapter
indicates the network adapter.
4334 7798–006
A–21
Initialization File for 16-bit Workstations
Sample TCP/IP entries:
WS1=TCP/IP,0
AC1=TCP/IP,0
Note: The workstations must be configured to use the same adapter
number as the Workflow Domain Subsystems. The initial installation
configures NetBIOS for adapter number 0. If your configuration uses an
adapter number other than 0, you can either edit this section to replace
adapter number 0 with your adapter number or reconfigure your LANA
number to 0 for NetBIOS to NetBIOS frames (Nbf).
[ObjectSecurity]
This section contains a parameter for the object security of the Document
Management Workstation.
Key
GroupPrefix
Description
Specifies an ASCII character to use
in group names.
Values
Default #
Invalid values are: blanks,
double quotes (“), percent
(%), forward slash (/), and
tilde (~).
[OCR]
Key
AutoOrientation
A–22
Description
Enables or disables the autoorientation feature of the OCR
workstation.
OcrLanguageCode
Indicates the language for which
OCR is configured.
OcrCountryCode
Country Code. This corresponds to
the Language Code.
Values
1
Enable the autoorientation feature of
the OCR workstation.
0
Disable the autoorientation feature of
the OCR workstation.
4334 7798–006
Initialization File for 16-bit Workstations
[Outbox]
This section contains parameters used for the OutBox on a Document
Management Workstation.
Key
Xc, Yc, nWIDTH,
nHEIGHT
Description
Sets the coordinates of the OutBox
window.
Values
If not specified, the
Windows defaults are
used.
[Page]
This section contains parameters used for the Page Viewer on a Document
Management or High Performance Workstation.
Key
FitToDisplay
MaxPageWindows
Description
Determines whether to scale an image
to fit in a maximized Page Viewer.
Sets the maximum number of Page
Viewers that can be open at the same
time. This is used to optimize the use
of memory for image storage.
Values
0
No scaling.
1
Scaling.
2
Width to display.
Default 8
This value is limited
only by available
memory.
By setting this to a value of 3, for
example, the user can ensure that no
more than three pages’ worth of
memory will be used for image
display, thus ensuring that system
operations run smoothly.
PageStyle
StatusBarShow
4334 7798–006
Determines whether cascade or stack
mode is used for displayed pages.
This is automatically set through the
Options menu in the various viewers.
1
Cascade mode.
2
Stack mode.
Allows you to show or hide the Status
bar.
0
Hide.
1
Show.
A–23
Initialization File for 16-bit Workstations
[Scan]
This section contains parameters for a Scanner Workstation.
Key
Description
Value
BatchAttr
Internal key. Should not require
configuration.
Default
CopyFormData
Specifies whether form field data is
retained or cleared from form to
form when indexing while scanning.
1 Data entered into a
previous document's
form is copied into the
next scanned
document's form, if the
next document is the
same document class.
0
DefaultTimeout
Specifies out of paper timeout for
scanners that support this feature.
0
Form data is not copied
from one document
form to the next when
indexing while
scanning.
1-60
Default 15
Note the following:
•
If the value is less than 1, the
timeout period is set to 15
seconds.
•
If the value is greater than 60, the
timeout period is set to 60.
•
Whenever the parameter is
changed, you must restart the
scanner utility.
You do not need to add this key in
the file because the default (optimal
value) will be used. This parameter is
used with KIPP 2.12 software and
does not interact with the scanner
directly. Any value you set in
Eswm.ini may not be supported by
the scanner itself.
DisplayActive
A–24
Internal key. Should not require
configuration.
Default 0
4334 7798–006
Initialization File for 16-bit Workstations
Key
Description
Value
LogActive
Internal key. Should not require
configuration.
Default 0
MinDiskSpace
Used by the scanner and is the
minimum amount of free hard disk
space (in KB) on the drive specified in
the WorkPath parameter required to
scan a page.
Default 200
<paper name>
< DPI>
<orientation> = right
bottom left top
This parameter is used during
scanning to ensure that the image size
is on a word boundary, which is
required by the OCR process.
Calculation of image size is
based on a 16-byte word
boundary. Right is the
closest word boundary for
the width; bottom is the
closest word boundary for
the height; left is the initial
left position, top is the initial
top position.
To calculate the image height
and width, the following
arithmetic operation should
be performed: paper size *
DPI, rounded to the nearest
multiple of 16.
paper name values:
•
Letter
•
Legal
•
B Size
•
A3
•
A4
•
A5
•
B4
•
B5
DPI values:
•
200
•
300
•
400
orientation values:
•
Portrait
•
Landscape
4334 7798–006
A–25
Initialization File for 16-bit Workstations
[System Admin Console]
This section contains parameters used to set the display in the System
Administration Console.
Cache Report Settings
Key
Description
Values
CAEColType
Sets the type of column
displayed.
PNAME, PSERVER,
PWORKSTEP, UNAME,
PSIZE, PCOUNT,
PCOMPLETE, PSEARCH,
PFIND TIME, PFIND COUNT,
PFIND, PUSERCACHE,
CAEHidden
Sets whether or not a column
is hidden from view.
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0,
A value of 1 hides the column from
view.
CAELength
Sets the width of each
CAETitle item.
1395, 750, 1710, 1245,
1680, 2205, 1365, 1095,
2175, 1170, 750, 1035,
CAEPosition
Sets the position in the users
report window.
1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
11, 12,
CAETitle
Sets the title headings
displayed in the cache report
window.
Workset, Server, Workstep,
Active Users, Cache Size,
Items in Workset Cache,
Items Completed, Last
Search, Search Duration
(seconds), Items Found,
Last Find, User Cache,
Print Information
Key
A–26
Description
HeaderFooter
Printer information
PageSetup
Printer information.
Values
.25, .25, .25, .25
4334 7798–006
Initialization File for 16-bit Workstations
Profile Report Settings
Key
Description
Value
PRFColType
Sets the type of column displayed.
QNAME, QSTEP,
QDYNAMIC,
PRFHidden
Sets whether or not a column is
hidden from view.
0,0,0,
PRFLength
Sets the width of each PRFTitle item.
2700, 2850, 3000,
PRFPosition
Sets the position in the profile report
window.
1, 2, 3,
PRFTitle
Sets the title headings displayed in the
profile report settings window.
Workset, Workstep,
Dynamic,
A value of 1 hides the
column from view.
Queue Contents Report Settings
Key
QUEColType
Description
Sets the type of column displayed.
Values
QOBJECT_NAME,
QOBJECT_ID,
QOBJECT_TYPE,
QOBJECT_SERVER,
QENTRY_TIME,
QRESOURCE,
QLOCKED,
QLOCK_TIME,
QWORK_STATUS,
QWORKSTEP,
QCLASS,
QASSOCIATEDUSER,
QERRCODE,
QERRCOMMENT,
QUEHidden
Sets whether or not a column is hidden
from view.
0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0 0, 0, 0,
A value of 1 hides the
column from view.
4334 7798–006
A–27
Initialization File for 16-bit Workstations
Key
Description
Values
QUELength
Sets the width of each QUETitle item.
780, 1695, 900, 810,
1890, 930, 900, 795,
930, 900, 975, 1200,
795,1080,
QUEPosition
Sets the position in the queue contents
window.
1, 2, 3, 4, 5, 6, 7, 8, 9,
10, 11,12, 13, 14,
QUETitle
Sets the title headings displayed in the
queue contents report window.
Name, Internal Name,
Type, Server, Workstep
Entry Time, Current
User, Lock Status, Lock
Time, Work Status,
Workstep, Class,
Associated User, Error
Code, Error Comment,
Report Contents
Key
Description
Values
CACHESERVER
Report contents.
[all servers]
WORKQUEUE
Report contents.
[all queues]
WORKSERVER
Report contents.
[all servers]
Report Sort Key
Key
CacheSortKey
Description
Internal program use.
Values
Do not modify.
PNAME
QueueSortKey
Internal program use.
Do not modify.
QOBJECT_ID
UserRptSort
Internal program use.
Do not modify.
UNAME
WorkSortKey
Internal program use.
Do not modify.
WNAME
A–28
4334 7798–006
Initialization File for 16-bit Workstations
Report Style
Key
CacheRptStyle
Description
Internal program use.
Value
Do not modify.
Option1
ProfileRptStyle
Internal program use.
Do not modify.
Option2
UserRptStyle
Internal program use.
Do not modify.
Option1
WorkRptStyle
Internal program use.
Do not modify.
Option1
Report Window Size and Position
Key
Description
Values
CacheWindow
Report window size and position.
9120, 3645
MainWindow
Report window size and position.
1035, 780, 10890, 7305
ProfileWindow
Report window size and position.
19120, 3645
QueueWindow
Report window size and position.
9120, 3645
ServerWindow
Report window size and position.
9120, 3645
UserWindow
Report window size and position.
9120, 3645
UserVarWindow
Report window size and position.
9120, 3645
WorkWindow
Report window size and position.
9120, 3645 13020, 6324
4334 7798–006
A–29
Initialization File for 16-bit Workstations
Route Variable Report Settings
Key
Description
Value
RTVColType
Sets the type of column displayed.
RVARNAME,
RVARTYPE,
RVARMODE,
RVARVALUE,
RVARCOMMENT,
RTVHidden
Sets whether or not a column is
hidden from view.
0,0,0,0,0,
RTVLength
Sets the width of each QUETitle
item.
1800, 1800, 1800, 1800,
1800,
RTVPosition
Sets the position in the queue
contents window.
1, 2, 3, 4, 5,
RTVTitle
Sets the title headings displayed in
the queue contents report window.
Name, Type, Mode,
Value, Comment,
A value of 1 hides the column
from view.
Servers Report Settings
Key
Description
Values
SRVColType
Sets the type of column displayed.
SSERVER, STYPE,
SPROCESSES,
SNEWWORK, SSTATUS,
SRVHidden
Sets whether or not a column is
hidden from view.
0, 0, 0, 0, 0,
(All columns are displayed.)
A value of 1 hides the column
from view.
A–30
SRVLength
Sets the width of each SRVLength
item.
1800, 1920, 1800, 1800,
1800,
SRVPosition
Sets the position in the Servers
Report window.
1, 2, 3, 4, 5,
SRVTitle
Sets the title headings displayed in
the servers report window.
Server, Type, Active
Processes, Accepting New
Work, Status,
4334 7798–006
Initialization File for 16-bit Workstations
User’s Report Settings
Key
Description
Value
AUColType
Sets the type of column displayed.
UNAME, USERVER,
UWORKSET, ULOGON,
ULOGON DURATION,
UCOMPLETE, URATE,
UAUDIT, UDISABLE,
AUHidden
Sets whether or not a column is
hidden from view.
0, 0, 0, 0, 0, 0, 0, 0, 0 (All
columns are displayed.)
A value of 1 hides the column
from view.
AULength
Sets the width of each AUTitle item.
1005, 1005, 1005,
1770,1440, 1785, 2430,
1650, 1005
AUPosition
Sets the position in the user’s report
window.
1, 2, 3, 4, 5, 6, 7, 8, 9
AUTitle
Sets the title headings displayed in
the user’s report window.
User, Server, Workset,
Logon Time, Session
Duration, Items
Completed, Transaction
Rate (items/hour), Audit
Percentage, Enabled
User Variable Report Settings
Key
Description
Value
USVColType
Sets the type of column displayed.
UVARNAME,
UVARUSER, UVARTYPE,
RVARMODE,
UVARVALUE,
UVARCOMMENT,
USVHidden
Sets whether or not a column is
hidden from view.
0,0,0,0,0,0 (All columns are
displayed.)
A value of 1 hides the column
from view.
USVLength
4334 7798–006
Sets the width of each QUETitle
item.
1125, 1305, 1305, 1500,
1395, 4935
A–31
Initialization File for 16-bit Workstations
Key
Description
Value
USVPosition
Sets the position in the queue
contents window.
1,2,3,4,5,6
USVTitle
Sets the title headings displayed in
the queue contents report window.
Name, User, Type, Mode,
Value, Comment
Work Distribution Report Settings
Key
Description
Value
WRKColType
Sets the type of column displayed.
WNAME, WSERVER,
WCOUNT, WERRORS,
WCOMPLETE, WLAST
ADD, WCHILD
WRKHidden
Sets whether a column is hidden
from view.
0, 0, 0, 0, 0, 0 (All columns
are displayed.)
A value of 1 hides a column
from view.
A–32
WRKLength
Sets the width of each WRKTitle
item.
1650, 1305, 1125, 1125,
1650, 1695,1410, 0
WRKPosition
Sets the position in the work
distribution report window.
1, 2, 3, 4, 5, 6, 7, 8
WRKTitle
Sets the title headings displayed in
the work distribution report window.
Workstep, Server, Item
Count, Items in Error,
Items Completed, Last
Item Added, Total Child
Count, Invisible
4334 7798–006
Initialization File for 16-bit Workstations
[SystemError]
This section is used for both the Document Management and High
Performance Workstations. It contains parameters to specify how errors are
handled in the system. It should be set up carefully so that important error
information is logged correctly. However, it is also important that error
information not be sent incorrectly to message boxes on a user’s screen. The
defaults should suffice for most installations. This section should not be
necessary, except in debugging situations.
Key
Description
Values
LogFilePath
Specifies the log file path
and name.
SysPath\folder.dbg
LogFileBackup
Specifies whether a backup
file of the log should be
created before a new log is
created.
Yes A backup file (with .bak
extension) is created in the
directory specified in the
LogFilePath parameter.
No Backup file is not created.
LogFileCache
Specifies the cache size of
the log file. All messages
are written to cache prior to
being written to disk.
LogFileMaxSize
Specifies the maximum
size of the log file.
StackTraceHex
Dump
Specifies whether the
stack trace should include a
hex dump.
Caching is disabled if this
parameter is set to a value less
than 512K.
Defaults:
204800
If error tracing is on.
102400
If error tracing is off.
Yes The stack trace includes a
hex dump.
No The stack trace does not
include a hex dump.
There are several types of system error flags:
Trace
Specifies low priority messages and debug tracing information.
Warning
Specifies low priority warnings about the status of the system.
Error
Specifies high priority warnings about the status of the system.
Fatal
Specifies nonrecoverable system errors.
Memory
Specifies memory allocation errors.
4334 7798–006
A–33
Initialization File for 16-bit Workstations
It is possible to specify the destination for a specific type of error using the
format:
ErrorType=Destination1,Destination2,...
where:
ErrorType is one of the above, and Destination is one of the following
destinations.
Log
Output goes to the log file.
MessageBox
Output goes to a Message box.
Debug
Output goes to an auxiliary debug device.
None
No output.
The following are the system default error processing flags.
Trace=None
Warning=Log
Error=Log
Fatal=Log
Memory=Log
Info=None
User=Log
When a SystemError call is made, these defaults control where the messages
will be sent unless overridden. If these defaults are not indicated, the
messages are directed to the log file.
In addition, you can specify how errors for a specific executable are reported.
To do this, place the name of the executable in brackets as the section
header, and specify the destinations.
For example:
[DOC.EXE]
Trace=Log
This will send all trace information from the Document Viewer to the log file.
Note: If message boxes are enabled for any type of errors, a separate
[IS.EXE] section must be set up that redirects Trace, Warning, Error, Fatal,
and Memory to a log file only, and not to a message box. If this is not done,
the IS executable will behave unpredictably.
A–34
4334 7798–006
Initialization File for 16-bit Workstations
[TermHLLAPI]
Key
HLLAPIFN
Description
Sets the HLLAPI function used by
the terminal emulation package.
Value
HLLAPI
If using Personal
communications/3
270 or CM/2 for
terminal
emulation.
WINHLLAPI If using DCA’s
3270 terminal
emulation
package.
HLLAPILIB
Sets the HLLAPI DLL used by the
terminal emulation package.
PCSHLL
If using Personal
Communications
/3270 or CM/2
for terminal
emulation.
WHLLAPI If using DCA’s
3270 terminal emulation
package.
UseTabs
Sets whether or not HLLAPI sends a
tab character at the end of each field.
The tab character positions the cursor
on the next field in the emulator
widow.
1
Send a tab character at
the end of each field.
0
Do not send a tab
character at the end of
each field.
If you leave this value blank,
a tab character will not be
sent.
[Toolbar]
This section contains a parameter that determines the size of the Toolbar
icons on the Document Management Workstation.
Key
ButtonSize
4334 7798–006
Description
Sets the size of Toolbar icons.
Value
Large
(32 bit icons.)
Small
(16 bit icons.)
A–35
Initialization File for 16-bit Workstations
[WS/2]
This section contains parameters used by the High Performance Workstation.
Key
Values
AltWorkPath
Specifies the alternate path for data
files from the server. Any files that
cannot be stored in the path specified
in the WorkPath parameter are
stored in this path.
Default path specified in the
WorkPath parameter.
ArchiveNotepad
Specifies whether to archive notepad
data.
1
Archive notepad data.
0
Do not archive notepad
data.
Sets whether the I3270 should regain
keyboard focus after the resulting
workitem is closed and routed.
1
Regains keyboard focus.
0
Does not regain keyboard
focus.
Sets whether documents are
automatically retrieved to the InBox.
It is set automatically through the
Settings dialog box.
0
Will not autofetch.
1
Will autofetch.
Sets whether a form is opened when
a document is opened. It is set
automatically through the Settings
dialog box.
0
Will not open form.
1
Opens form.
Sets whether the next document in
InBox is automatically opened when
a document is closed. It is set
automatically through the Settings
dialog box.
0
No. Next document is not
automatically opened.
1
Yes. Next document is
automatically opened.
BatchPrintQueue
Specifies the queue to which batch
print and batch retrieval requests are
sent.
REQUEST
BinPath
Sets the path to the bin subdirectory.
Cabinetsearch
Specifies if a File Cabinet search is on
a server in the Workflow Domain, or
on the archive. It is automatically set
through the File Cabinet tool.
APSResponse
AutoFetch
AutoForm
AutoOpen
A–36
Description
0
Domain
1
Archive
4334 7798–006
Initialization File for 16-bit Workstations
Key
CabinetSize
Description
Stores the maximum number of
documents returned through a File
Cabinet. It is automatically set
through the File Cabinet tool.
ConfirmResponse
CancelToEndof
Queue
Values
10
1
0
Workitem is requeued at
the beginning of the
queue after an Abandon
operation.
1
Workitem is requeued at
the end of the queue
after an Abandon
operation.
Sets a prompt to user to confirm route
of workitem when I3270 closes it.
1
Prompt confirmation.
0
Do not prompt.
dc3270Window
Sets the size and location of the
terminal emulation window.
Internal. Do not modify.
Decompressed
ImageCount
Sets the number of images in a
document to be decompressed when
the document is retrieved to the
workstation.
-1
All
0
None
n
n images
DecompYieldLimit
Specifies the amount of data (in KB)
that the software decompression
routine processes before giving up
control of CPU resources.
256
FolderWindow
Indicates the size and location of the
Folder Window in x, y, dx, dy format.
It is updated through the Control
menu Save Window option.
FormWindow
Indicates the size and location of the
Form Window in x, y, dx, dy format.
Freemem
Specifies whether the available
system memory and available image
memory are displayed in the
Desktop. It is set automatically
through the Set tings dialog box.
ConfirmRoute
4334 7798–006
Sets the behavior of a workitem after
an Abandon operation.
1
Information is displayed.
0
Information is not
displayed.
A–37
Initialization File for 16-bit Workstations
Key
GetArchiveForm
Data
Description
Specifies whether form data is
retrieved from archive.
Values
0
No retrieval from archive.
1
Retrieve from archive.
This parameter should
normally be set to 1.
HardwareType
Determines the type of image display
adapter.
0
Software decompression.
1
TI Control Systems.
2
IBM Image Adapter/A. In
this case, the XEQFile
parameter should be set.
You also need an [Image
Adapter/A] section.
HelpPath
Sets the path for the on-line help file.
HighLite
Stores the display characteristics of
the ruler bar: transparent or opaque.
HoldInterval
A–38
Transparent
It is set automatically through
the Ruler Preferences dialog
box.
32000
IconSpacing
Horizontal
Stores the horizontal spacing of icons
in the InBox, HoldBox, and OutBox.
IconSpacing Vertical
Stores the vertical spacing of icons in
the InBox, HoldBox, and OutBox.
ImageWindow
Indicates the size and location of the
Image Viewer in x, y, dx, dy format. It
is updated through the Control menu
Save Window option.
InBoxSize
Stores the maximum number of
entries in the Inbox. It is set
automatically through the Settings
dialog box.
3
ISqSize
Internal, used to set the size (in KB)
of the Workflow Domain Subsystem
message queue.
32
4334 7798–006
Initialization File for 16-bit Workstations
Key
Description
Values
ISVisible
Specifies if the Workflow Domain
Subsystem should be displayed.
0
LockFailure Report
Sets whether or not an error is
reported to a user during an attempt
to lock a document in a folder.
Yes A warning message is
displayed the first time a
document lock fails, and
an error message is
displayed after the nth
retry that fails, where n is
the value of the
LockFailureRetries
parameter.
No An error message is
always displayed after
the nth retry which fails,
where n is the value of
the LockFailuresRetries
parameter.
LockFailure Retries
4334 7798–006
Sets the number of retry attempts to
lock a document in a folder. Each
time a lock attempt on a document
fails, the document is put at the end
of the list of current documents to be
processed, the retry count is
incremented, and processing skips to
the next document in a folder. The
lock is retried when a failed
document is again at the top of the
list of current documents to process.
A document is not put in a user’s
InBox until the lock is successful.
When the maximum number of retry
attempts is met, the folder is put into
an error status after all other
documents it contains are processed.
If set to 0, the workstation keeps
trying to lock a document until the
lock is successful. In this case, an
error message is only issued the first
time the lock fails.
Minimum 0
Maximum 100
A–39
Initialization File for 16-bit Workstations
Key
NIProgram
Description
Sets the network interface program.
Values
ni.exe
ni2.exe
ni21.exe
NIVisible
Specifies if the network interface
should be displayed.
0
Do not display.
1
Display.
NIqSize
Internal, used to set the size (in KB)
of the network message queue.
32
NIWindow
Indicates the size and location of the
network interface window in x, y, dx,
dy format.
NotepadWindow
Indicates the size and location of the
Notepad Window in x, y, dx, dy
format. It is updated through the
Control menu Save Window option.
PBAClose
Controls the amount of XMM to
allocate to images.
Minimum 0
Maximum 4608
Default
1
Set to 4608 if you have 8 MB
or more XMM. Decrement
according to XMM availability.
If not set or set to 0, defaults
to all available memory.
A–40
PollInterval
Sets the number of seconds between
polls of the InBox in order to maintain
the number of documents in the
InBox at the size specified in the
InBoxSize parameter.
10
PrintQueue
The queue to which remote print
requests are directed.
PRINTER
ReceiveTimeout
Sets the NetBIOS receive time-out
value in seconds.
120
4334 7798–006
Initialization File for 16-bit Workstations
Key
Description
Values
Retrieval
WorkflowQueue
Specifies a queue name to which
documents can be enqueued when
retrieved through the Batch Retrieval
tool, so that they can be accessed
from a user's InBox. (The user's
queue pro file must be set up so that
KEY1 is equal to the user's logon ID.)
If a queue name is not specified here,
any documents retrieved through the
Batch Retrieval tool are accessed
through the HoldBox.
RulerGry
Stores the height of the gray portion
of the ruler bar. It is set automatically
through the Ruler Preferences dialog
box.
RulerHgt
Stores the height of the ruler bar. It is
set automatically through the Ruler
Preferences dialog box.
RulerLoc
Stores the position of the ruler on an
image page. It is set automatically
through the Ruler Preferences dialog
box.
RulerSho
Stores whether the ruler bar displays
automatically when an image page is
opened. It is set automatically through
the Ruler Preferences dialog box.
0 (no display)
ScreenTimeout
Number of minutes the Logon screen
displays before going into screen
saver mode. If the value is zero, or if
this parameter is removed, the Logon
screen goes into screen saver mode
after one minute.
30
SendInterval
SysPath
5000
Specifies the path to the workstation
system files.
..\sys \
Required.
4334 7798–006
A–41
Initialization File for 16-bit Workstations
Key
UNIFIED LOGON
Description
Specifies whether unified logon is
enabled.
Values
Y
Enabled
N
Disabled.
Note:
Unified logon is determined by the InfoImage software Workflow Domain. If the
Workflow Domain is configured for unified logon, the unified logon password and ID is used. If
the Workflow Domain is not configured for unified logon, the password and ID specified by the
registry will be used.
ViewAllPages
WorkPath
Sets the View All Pages mode. It is
set through the Settings dialog box.
0 (off)
Sets the path to temporary files
created by the workstation.
..\data\
1 (on)
Required.
WSPRogram
Sets the workstation program.
ws2.exe
ws2.exe is the HPWS application.
A–42
WSqSize
System parameter to set the size (in
KB) of the workstation message
queue.
WSWindow
Indicates the size and location of the
High Performance Desktop Window
in x, y, dx, dy format. It is updated
through the Control menu’s Save
Window option.
32
4334 7798–006