OmniDocs 8.2 Configuration Settings Guide

OmniDocs 8.
OmniDocs 8.2
Configuration Settings Guide
2015
Newgen Software Technologies Ltd

A-6, Satsang Vihar Marg, Qutab Institutional Area
New Delhi - 110067, INDIA
Tel: 91-11-40770100, 26964733, 26963571
Fax: +91-11-26856936
E-mail: helpdesk@newgen.co.in
Disclaimer
This document contains information proprietary to Newgen Software Technologies Limited. You may
not disclose or use any proprietary information or use any part of this document without written
permission from Newgen Software Technologies Limited.
Newgen Software Technologies Limited makes no representations or warranties regarding any
software or to the contents or use of this manual. It also specifically disclaims any express or implied
warranties of merchantability, title, or fitness for any particular purpose. Even though Newgen
Software Technologies Limited has tested the hardware and software and reviewed the
documentation, it does not guarantee or imply that this document is error free or accurate regarding
any particular specification. As a result, this product is sold as it is and you, the purchaser, are
assuming the entire risk as to its quality and performance.
Further, Newgen Software Technologies Limited reserves the right to revise this publication and
make changes in contents without any obligation to notify any person of such revisions or changes.
Newgen Software Technologies Limited authorizes no agent, dealer or employee to make any
modification, extension, or addition to the above statements.
Newgen Software Technologies Limited has attempted to supply trademark information about
company names, products, and services mentioned in this document. Trademarks indicated below
were derived from various sources.
Copyright 2014 by Newgen Software Technologies Ltd. All Rights Reserved.
No part of this publication may be reproduced and distributed without the prior permission of:
Newgen Software Technologies Limited,
A-6, SATSANG VIHAR MARG, QUTAB INSTITUTIONAL AREA,
New Delhi - 110067
INDIA
Table of Contents
CHAPTER 1 - IMAGE SERVER ........................................................................................................................ 1
1.1 IMAGE SERVER COMPONENTS .................................................................................................................... 1
1.2 IMAGE SERVER COMPONENT CONFIGURATION MATRIX ................................................................................ 1
CHAPTER 2 - OMNIDOCS SERVICE ADMINISTRATION (OSA) ..................................................................... 6
2.1 OSA COMPONENT CONFIGURATION MATRIX ............................................................................................... 6
CHAPTER 3 - OMNIDOCS WEB....................................................................................................................... 8
3.1 OMNIDOCS WEB COMPONENT CONFIGURATION MATRIX .............................................................................. 8
CHAPTER 4 - PANDB ..................................................................................................................................... 21
4.1 PANDB COMPONENTS ............................................................................................................................. 21
CHAPTER 5 - REMOTE IMAGE SERVER ...................................................................................................... 22
5.1 REMOTE IMAGE SERVER COMPONENTS .................................................................................................... 23
5.2 REMOTE IMAGE SERVER COMPONENT CONFIGURATION MATRIX................................................................. 23
CHAPTER 6 - OMNIDOCS AUTHENTICATION MANAGER (LDAP) .............................................................. 25
6.1 LDAP COMPONENTS ............................................................................................................................... 25
6.2 LDAP COMPONENT CONFIGURATION MATRIX............................................................................................ 26
CHAPTER 7 - TEXT EXTRACTION MANAGER (FTS).................................................................................... 29
7.1 FTS COMPONENTS .................................................................................................................................. 29
7.2 FTS COMPONENT CONFIGURATION .......................................................................................................... 29
CHAPTER 8 - WRAPPER ............................................................................................................................... 30
8.1 WRAPPER COMPONENT CONFIGURATION MATRIX...................................................................................... 30
CHAPTER 9 - REPLICATION SCHEDULER ................................................................................................... 32
9.1 REPLICATION SCHEDULER COMPONENTS .................................................................................................. 32
9.2 REPLICATION SCHEDULER COMPONENT CONFIGURATION MATRIX .............................................................. 33
CHAPTER 10 - OMNIDOCS CONFIGURATION SETTINGS ON APPLICATION SERVER(S) ........................ 35
10.1 JBOSS 6.1.1/ JBOSS-6.0 EAP ................................................................................................................ 35
CHAPTER 11 - DATABASE SERVER ............................................................................................................. 37
11.1 MSSQL SERVER 2008/2012.................................................................................................................. 37
11.2 ORACLE 11G ......................................................................................................................................... 38
CHAPTER 12 - BROWSER SETTINGS .......................................................................................................... 39

12.1 INTERNET EXPLORER ............................................................................................................................. 39
12.2 MOZILLA FIREFOX.................................................................................................................................. 39
CHAPTER 13 - NETWORK SETTINGS........................................................................................................... 40
CHAPTER 14 - OPERATING SYSTEM SETTINGS ........................................................................................ 40
14.1 WINDOWS 7/WINDOWS SERVER 2008/ WINDOWS SERVER 2012 .............................................................. 40
CHAPTER 15 - CONFIGURATION SETTINGS OF THUMBNAIL MANAGER ................................................. 40
15.1 THUMBNAIL MANAGER............................................................................................................................ 41
15.2 THUMBNAIL MANAGER COMPONENT CONFIGURATION MATRIX .................................................................. 41
15.3 STEPS TO CONFIGURE THUMBNAIL SCHEDULAR/MANAGER ....................................................................... 44
CHAPTER 16 - CONFIGURATION SETTINGS OF ALARM MAILER .............................................................. 44
16.1 ALARM MAILER ...................................................................................................................................... 44
16.2 ALARM MAILER COMPONENT CONFIGURATION MATRIX ............................................................................. 44
16.3 STEPS TO CONFIGURE ALARM MAILER .................................................................................................... 47
CHAPTER 17 - CONFIGURATION SETTINGS OF ACTION ITEM ................................................................. 48
CHAPTER 18 - PERSONAL SETTINGS SORTING PREFERENCES ............................................................. 49
CHAPTER 19 HOW TO SET UTF-8 ENCODING CHARACTER SET........................................................... 50
19.1 - STEPS TO SET UTF-8 ENCODING CHARACTER SET IN OMNIDOCS 8.0 WINDOWS - JBOSS-6.1.1
APPLICATION SERVER.................................................................................................................................... 50
19.2 - STEPS TO SET UTF-8 ENCODING CHARACTER SET IN OMNIDOCS 8.0 - WINDOWS - JBOSS-6.2.0 EAP
19.3 - STEPS TO SET UTF-8 ENCODING CHARACTER SET IN OMNIDOCS 8.0 WINDOWS - WEBSPHERE 8.5
19.4 - STEPS TO SET UTF-8 ENCODING CHARACTER SET IN OMNIDOCS 8.0 WINDOWS - WEBLOGIC 12C
CHAPTER 20 - HOW TO CONFIGURE IVAPPLET VIEWER AND OPALLVIEWER ....................................... 70
APPENDIX A ................................................................................................................................................... 71
APPENDIX B ................................................................................................................................................... 73
APPENDIX C................................................................................................................................................... 81
APPENDIX D................................................................................................................................................... 82
APPENDIX E ................................................................................................................................................... 84
Chapter 1 - Image Server

Image Server receives requests from client and transfers requests to the JTS for processing. Image
Server also receives information about the document from JTS and then transfers this information to
SMS for document image retrieval. Image Server handles storage and retrieval of documents in WAN
environment. It stores document using file system and maintains information about these documents
in a database.
1.1 Image Server Components

The components of Image Server are as follows:
1) ISPACK: It includes all the image server API calls and class files for the definition of Document,
Volume,
Site
and
connection
related
functions.
ISPACK
uses
IS.ini
as
its
initialization/configuration matrix.
2) JDTS: Client requests are transferred to JTS in the form of XML. JDTS includes functions, which
are used by ISPACK for sending input XML to JTS and receiving output XML after processing at
JTS.
3) NSMS: ISPACK uses functions of NSMS in establishing connection with the specified SMS and
provides document information to that SMS.
1.2 Image Server Component Configuration Matrix

There are two ini files, which are used as Image Server component configuration matrix.
1) IS.ini: It is used by Image Server (ISPACK).
The location of lS.ini file is:
[Application server root path]\
OmniDocs 8.2 - Configuration Settings Guide
Page 1
It contains the following tag:
S. No
1.
Variable Name
LogPath
Description
Values D*/d+/e#
It represents replication log file

name (Replication.log).
2.
SMSTimeOut
It represents SMS time out limit

in milliseconds.
3.
SMSReadInterval
It represents SMS read interval in

milliseconds.
4.
SMSRetryCount
It represents the number of retry

counts for SMS.
5.
SMSGenerateLog:
It represents a flag that shows
True/False
whether the SMS log is to be

generated or not.
6.
IsJNDI
It represents a flag that shows
True/False
whether JNDI lookup occurs or

not.
7.
ProviderUrl
It represents a protocol that

depends upon specific
application sever which is being
used.
8.
JNDIServerName
It represents IP address of the

application server.
9.
JNDIServerPort
It represents the RMI port or IIOP

port number.
10.
JNDIContextFactory It represents that initial context

factory depends on the
application server and protocol
Page 2
being used.
11.
LookupBean
It represents actual bean for

lookup.
12.
UrlPackagePrefix
Provide only if AppServer is

JBoss and clustering is used.
13.
PartitionName
Provide only if AppServer is

JBoss and clustering is used.
14.
ProxyHost
Proxy address of proxy

server which is used to connect
with Amazon S3 server.
15.
ProxyPort
Port of the proxy server which is

used to connect with Amazon S3
server.
16.
ProxyUserName
A valid user name authenticated

by proxy server.
17.
ProxyPassword
Password of ProxyUserName
18.
AddCache
A flag to enable a local copy of

data. All data which will be added
to Amazon S3 server, a local
copy will also be maintained.
19.
PageCache
A flag to enable local lookup of

data from local cache while
viewing.
20.
CacheDir
Path of directory where local

copy of data will be maintained.
21.
SiteId
Site ID of looked up SMS on the

basis of cabinet name
22.
CabinetName
Provide only if Cabinet Name
Page 3
based SMS lookup is required.

23.
SMSIp
SMS IP of looked up SMS on the

basis of cabinet name.
24.
SMSPort
SMS port of looked up SMS on

the basis of cabinet name.
25.
ISPACKTIMELOG
Provide True to enable
True/False
transaction start & end time in

jerr log.
26.
ClusterSMSPort2
SMS port of machine two in

cluster
27.
ClusterSMSIp2
SMS IP of machine two in cluster
28.
ClusterSMSPort1
SMS port of machine one in

cluster
29.
ClusterSMSIp1
SMS IP of machine one in cluster
30.
ISCLUSTER
Provide True if SMS is running in

cluster mode where PN files are
located at common drive.
2) Server.ini: It is used by SMS.

The location of Server.ini file is:
<Folder in which OD Server is installed>\Common Services for J2EE\SMS
It contains the following tags:
S. No
Variable Name
Description
1.
Port
It represents Server port (generally 900).
2.
CFGFile:
It represents CFG file for sms (volume.cfg) where

complete information of SMS labels is shown.
Page 4
3.
Log File:
It represents log file name of SMS (Client. log).
4.
RetryCount:
It represents the retry count for SMS operation.
5.
AdminPort:
It represents the admin port number of SMS (10000).
6.
ResolveClient:
It represents the flag for resolving remote client machine

name condition.
7.
Encoding:
It represents encoding of characters used by SMS.
8.
Default
It represents default connections made by the client to the
ConnectionAllowed
host machine. Its default value is 15.
ErrorLogSize
Obsolete
9.
10. ISClientIP
True to enable clients machine IP address.
11. ChunckSize
chunck size of for read & write in KB.
12. BytesSize
Define Threshold BytesSize of Read, Write and Fetch

operations.
13. SmsReadTime
Define Threshold time of Read operation.
14. SmsWriteTime
Define Threshold time of Write operation.
15. SmsFetchTime
Define Threshold time of Fetch operation.
16. ConTimeOut
Define Connection Threshold time in seconds.
17. SleepTime
Define sleep time of a thread in seconds.
18. ISConThread
True to enable connection threshold log.
19. ISHcap
True if Hitachi Content Archival Platform (HCAP) is to be

used
20. ServerTimeOut
socket timeout in minutes
21. ReadThreadTimeO
For Document download operation, Thread Timeout value
ut
22. WriteThreadTimeO
ut
in seconds.
For Document add operation, Thread Timeout value in
seconds.
Page 5
23. FetchPageThreadTi For Document view operation, Thread Timeout value in

meOut
seconds.
24. ThreadTimeOut
Default Thread Timeout value in seconds.
25. CPUThreshold
CPU usage threshold value.
Chapter 2 - OmniDocs Service Administration (OSA)

OSA is used for remote administration of Java Transaction Server, Storage Management Server,
LDAP services, Alarm Mailer and Thumbnail Manager. JTS, Storage Management Server and
Listener listen on a port, called Admin Port in addition to the client ports. OSA manages these servers
by connecting to the Admin port.
2.1 OSA Component Configuration Matrix

There are two xml files that are used as an OSA component configuration matrix. It is used to
manage OSA and has the following tags:
1) Admin.xml:
The location of Admin.xml file is:

<Drive in which OD Server is installed>\Common Services for J2EE\OSA
a) ServerInfo: It represents information about various servers of OmniDocs, such as SMS, JTS,
and Thumbnail Manager.
Server: It represents information related to the specific server. It contains following sub-tags as
follows:
Page 6
S. No
Variable Name
Description
1.
Type
It represents the name of the server.
2.
IPAddress
It represents the IP address of the machine where the

server is running.
Port
3.
It represents the port number at which the server is

listening.
b) LoginInfo: It represents the user authentication information for logging into OSA. It contains
following sub-tags as follows:
S. No
Variable Name
Description
1.
User
It represents details of a specific user.
2.
Username
It represents the name of the user.
3.
Password
It represents the password of the user.
c) Preferences: It represents specific behavior of OSA. It contains following sub-tags as follows:
S. No
1.
Variable Name
AutoVersioning
Description
It specifies whether auto versioning feature should be
enabled or not.
2.
BrowserPath
It represents the specific path of the browser.
3.
HelpFileName
It represents the path of the file for OSA help.
4.
SocketTimeoutCon
It represents the time in seconds after which the socket

time out will occur.
5.
JTSEncodings
It represents the encoding supported by JTS.
Page 7
6.
JTSEncoding
It represents name of the encoding supported by JTS.
7.
OSAEncoding
It represents the character set encoding of the OSA.
8.
FontName
Setting for text appearing in OSA.
9.
FontStyle
10.
FontSize
11.
OSAEncoding
Character set encoding.
12.
NewServicesName
Y, if new Alarm mailer & Thumbnail service is used.
Chapter 3 - OmniDocs Web

OmniDocs Web is a user interface by which user can perform various operations, such as scanning
documents, changing the preferences for folders and documents etc. User can search documents
and folders on varied criteria. Documents and Folders can be added easily from this interface.
3.1 OmniDocs Web Component Configuration Matrix

There are four ini files, which are used as OmniDocs Web configuration files.
1) Eworkstyle.ini: This configuration file is used to initialize various components of OmniDocs.
The location of Eworkstyle.ini file is:

Application server root path\ngdbini\odwebini

S.
Variable Name
Description
No
Values
D*/d+/e#
1.
Webserverhost
It represents host name of the

Web Server.
Page 8
2.
Webserverport
It represents the port number on

which server is running.
3.
Servletzone
It gives information about the

servlet zone.
4.
ThumbnailServerIP
It represents the IP address of

the Thumbnail server where the
Thumbnail service is registered.
5.
ThumbnailServerPort
It represents the port number of

the Thumbnail Server on which
Thumbnail service is running.
6.
Protocol
It represents the details of the

protocol, which the server is
running.
7.
ThumbnailPath
It gives the path address where

the Thumbnail will be
generated.
8.
ReplicationSchedulerConfPa It gives the path of the jobxml, if

th
Replication Scheduler is
installed on the server.
9.
ApplicationRightsConfPath
It gives the path where

applicationRight.xml file is
stored.
10. StampIniPath
It gives the path where

stamp.ini file is stored.
11. StampImagePath
It gives the path where stamp

image is kept after registering
from Web Admin.
12. ProvisioningString
This string tells about the

provision used in OmniDocs.
Current value of this tag is
Page 9
000010000.
13. DisableFTSFor
This tag is used to disable Full

Text Search for any database
cabinet.
14. MailServerIPAddress
It represents the IP address of

the default mail server on the
system.
15. AdminMailId
It represents the mail Id of the

administrator.
16. ConvertToTif
This tag value is set to either 1
0/1
or 0 when a gif or a bmp image

is to be converted to a tiff
image.
17. CompressTextFile
This tag value is set to either
False/True
true or false depending on

whether the text file is to be
compressed or not.
18. OVPlugin
This tag value is set to either 0
0/1
or 1 depending on whether
OmniViewer is to be enabled or
not.
19. J2EE
This tag value is set to 1 in
0/1
case of Application Server and

is set to 0 in case of JTS
version of OmniDocs.
20. ContextName
It represents the context name

on which OmniDocs is running.
21. TrashManagement
It is for enabling or disabling the
0/1
Trash Management feature. It is

set to 1 for enabling and 0 for
Page 10
disabling the feature (Default

value is 0).
22. ZoomSetting
It is for setting the default zoom
0/1
percentage of the document

opened in the applet.
23. PaperProfileDisplay
It is for enabling or disabling
0/1
PaperProfile feature. It is set to

1 for enabling and 0 for
value is 0)
24. MakerChecker
0/1
MakerChecker feature. It is set

to 1 for enabling and 0 for
value is 1).
25. SortFieldId
It is the field on which the

sorting is to be done in
Document List. Default value is
5.
26. OperatedRequestBatchSiz
e
It is the Operated Request

BatchSize of MakerChecker
feature. Default value is 10.
27. SentRequestBatchSize
It is the Sent Request

BatchSize of Maker Checker
28. PendingRequestBatchSize
It is the Pending Request

BatchSize of MakerChecker
Different values are:

Page 11
S.
Value
Meaning
Document Name
11
Document Size
Document Type
10
No. Of Pages
Modified Date
Owner
18
Order No.
Variable Name
Description
Values
No
D*/d+/e#
29. SortOrderId
It is the order of the Document
0/1
list. Default value is 0.

Different values are:
S.
Value
Meaning
Ascending
Descending
Variable Name
Description
Values D*/d+/e#
No
30. EnableRule
N/Y
Rule feature of Action Item. It is set

to Y for enabling and N for disabling
the feature (Default value is N).
31. EnableLocalRoute
N/Y
Local Route feature of Action Item.

It is set to Y for enabling and N for
disabling the feature (Default value
is N).
Page 12
32. SocketTimeOut
It is time after which a call for

pending reminders and alarms will
be made to server by the
MesgPollApplet. Default value is
900000(ms).
33. RISEnabled
Remote image server exists or not
0/1
34. PageRangeDownload
In case of multipage tiff document
0/1
user can configure to provide option

to download a selected page range
of document
35. PrintWithAnnotation
User can configure the option to
Not Used in OD
print the image document with
Now.
annotation.
36. EnableMsgPollApplet
Not Used in OD Now.
0/0/1
NOTE: For enabling
JRE Free Mode
the value should be
fixed to 0.
37. OmniProcess
Whether to provide the
NA/0/1 if empty
omniProcess link or not can be
behave abnormally
made configurable
38. AdminFolderSearch
Folder search option in OmniDocs
0/0/1
admin can be made configurable

39. EncryptUser
Setting this flag 1 will save the user
0/0/1
in encrypted form
40. SaveRecordSize
Not Use in OD Now
NA
41. EnableHMT
Not Use in OD Now
NA
42. ImageEnabling
Not Use in OD Now
NA
43. CompactionSchedulerCo
It gives path of jobs.xml required for
Can't remain Empty.
Page 13
nfPath
compaction
Default :
Compaction
Scheduler/jobxml
44. EncryptPassword
Setting this flag 1 will save the
0/0/1
password in encrypted form

45. Paperlessoffice
Enable paperlessoffice tab in
0/0/1
odweb
46. schedularLocation
List of IP where schedulars are
jtsip/Ips seperated
running
by commas
47. AdditionalInformation
Not Use in OD
0/0/1
48. EnableSSO
Single sign on enabled or not
N/0/1
49. URLForLogon
to go to custom url after logout
N/login.jsp/custom
50. URLForAdminLogon
to go to custom url after admin
N/'admin/login.jsp'/c
logout
ustom
If SaveReport button enables it
False/False/True
51. ReportFlag
displays format combo box

52. ReportType
53. FTSText
If SaveReport button enables it
Value can b txt, xls,
provide extenstion of report file
csv
It enables/disables (show/hide) full
False/False/True
text/icon search link

54. ShowMultipleDocument
It show/hide(s) multiple document
False/False/True
link in od web/masterdesktop
55. ShowFilingUtility
It show/hide(s) Filing Utility icon
56. ResetPassword
Not used in OD Now
57. SearchRange
It provides the date range in search.
False/False/True
Format:
NumericalDigit+D/M
/Y
Page 14
D-Day(s)
M-Month(s)
Y=Year(s)
Default:3M
58. UserName
User Name for mail server
Mandatory for Email
configuration
feature
Password for mail server
Mandatory for Email
configuration
feature
60. MailServerPort
MailserverPort for Email
Default 25
61. RMSEnabled
It show/hide(s) RMS tab in od web
N/N/Y
62. EnableForgotPassword
It show/ hide(s) forgot password link
False/False/True
59. Password
in login page(odadmin/odweb)
63. PrintScreenDisable
It enable/disable(s) printscreen
N/N/Y
NOTE: For enabling
JRE Free Mode
the value should be
fixed to N.
64. showPasswordPolicy
It enable/disable(s) Password policy
N/N/Y
at time of forced change password

65. ShowCustomView
It show/hide(s) custom view icon in
N/N/Y
Masterdesktop
66. ShowMasterDesktop
It show/hide(s) Masterdesktop tab
N/N/Y
in od web
67. ShowDocNamePickList
It show/hide(s) Picklist button for
N/N/Y
the list which has predefined

document names
68. AFVBatchSize
Advance folder view Batch Size
Default : 5
69. DataFieldOrder
This parameter is to support Data
N/Y
Field ordering functionality.

Page 15
70. ShowSecureLink
This parameter is for Seclore
True/False
Security Functionality.
71. Application
This tag defines name of

applications for licensing through
OmniDocs.
72. SSLenabled
For direct mail to enable SSL.
N/Y
73. DefaultPasswordExpiry Number of days, after which default

Days
74. MaxNumberOfDocume
ntsInEmail
75. MaxAttachmentSizeIn
EmailMB
76. ShowMultipleDocumen
t
77. EnableAmazonS3
password will expire.

Maximum number of documents,
which can be forwarded in mail.
Maximum total size of attached doc

in a mail.
This flag is used to show Multiple
True/False
Document Upload link.

This parameter is for support of
N/Y
Amazon S3 as SMS.
78. EnableHCP
N/Y
HCP as SMS.
79. EnableClientInfo
If this flag is set true, then on in
N/Y
cabinet connect API, client systems
NOTE: For enabling
IP address will be saved in DB.
JRE Free Mode

the value should be
fixed to N.
80. EncryptVolume
This parameter is for Volume
0/1
Encryption Functionality.
Page 16
81. ScanDisplay
N/Y
New Web Scan Integration
NOTE: For enabling
functionality.
JRE Free Mode

the value should be
fixed to N.
82. FetchRecordStatus
Y - Easy RMS is to be enabled.
Y/N
This tag enables fetching of

documents associated with record
along with normal documents while
performing document search
N - Easy RMS feature is disabled /
RMS is not installed in current
setup.
Default Value is N.
83. EnableDisableOpAllFla This parameter defines whether
OpAllViewer will be used or
g
IVApplet.
Default Value is N.
Setting value to N signifies IVApplet
will get enable.
And setting value to Y signifies
Y/N
NOTE: For enabling

JRE Free Mode,
the value should be
fixed to Y.
OpAllViewer will get enable.

84. EnableJREFreeMode
This parameter defines whether the
Y/N
Applets is to be used or not.

Default value is Y.
Setting value to Y signifies JRE
Free mode features will get enable.
And setting value to N signifies
JRE Free mode features will get
NOTE: For enabling

JRE Free Mode
the value should be
fixed to Y.
disable.
Page 17
List of eworkstyle.ini parameters for enabling JRE free mode

I.
EnableJREFreeMode = Y
II.
ScanDisplay = N
III.
EnableDisableOpAllFlag = Y
IV.
EnableClientInfo = N
V.
EnableMsgPollApplet = 0
VI.
PrintScreenDisable = N
2) Admin.ini: This configuration file contains information about a cabinet, which is registered by
Admin.
The location of Admin.ini file is:
It contains the following tag:

S. No
1.
Variable Name
Provision
Description
It represents information about the provision, which is used
by OmniDocs. Configurable values are 0/1.
3) Odcablist.ini: This configuration file contains information about the cabinet, which is registered
from OmniDocs Web Desktop.
The Location of Odcablist.ini file is:
4) Provision.ini: This configuration file contains information about the provisions that are followed by
OmniDocs.
The location of Provision.ini file is:
[Application server root path]\server\[instance_name]\deploy\omnidocs.war
Page 18

S. No
1.
Variable Name
Provision
Description
It contains provisioning string for 44 provisions as
DOC_FORWARD, REMINDERS_ MODIFY etc. These different
provisions either store 0 or 1 value.
2.
Read
This tag contains provisions for copy, print, and download option.
5) uploadconf.xml: This file is used to ensure the contents of the documents uploaded are same as
the type of the document.
The location of uploadconf.xml is:
<APP_SERVER>\bin\ngdbini\odwebini
6) SecloreConfiguration.xml: This file is added to configure Seclore configuration.
The location of SecloreConfiguration.xml file is:
<APP_SERVER>\bin\ngdbini\odwebini
Page 19

S. No
Variable Name
Description
1.
App-path
Location of logs related to Seclore.
2.
Initalize-logger
Whether Seclore related logs need to be initialized or not.
3.
server
URL of Seclore Server.
4.
port
Port number on which Seclore server is running.
5.
App-name
Application name of Seclore Application on Policy Server.
7) Web.xml: This file contains configuration for viewing image stamps.

The location of the Web.xml depends on the application server in use. Different locations of Web.xml,
as per its application server, are as follows:JBOSS Community:
<Server_Installed_Directory>\server\<Instance_name>\deploy
JBOSS EAP:
<Server_Installed_Directory>\standalone\deployments
Weblogic:
<Server_Installed_Directory>\user_projects\domains\<instance_name>\applications
WebSphere 1:
<Server_Installed_Directory>\WebSphere\AppServer\profiles\<profile_name>\installableApps\
WebSphere 2:
<Server_Installed_Directory>\WebSphere\AppServer\profiles\<profile_name>\config\cells\vm607Node
03Cell\applications\omnidocs.ear\deployments\omnidocs
Page 20
NOTE:
In IBM WebSphere application server, Web.xml file is present in two different places. To enable Opall Viewer, it is
necessary to pick Web.xml file from both these locations and made the necessary configuration changes in it. The
location where Web.xml file is present is provided above.

S. No
1.
Variable Name
Description
EnableDisableOpAllFlag Defines whether OpAllViewer will be used or IVApplet

Default Value is N.
Setting value to N signifies IVApplet will get enable.
And setting value to Y signifies OpAllViewer will get enable.
Chapter 4 - PanDB
PanDB is an Active-X dll, which is an important part of different utilities like OmniScan, OmniAcquire
etc..This dll file is used for establishing connection to the JTS where cabinet is registered, and then
generates XML for each operation that user performs on the shared cabinets. Thereafter, receiving
and parsing the XMLs are received from the JTS.
4.1 PanDB Components

The files, which work together with Pandb dll, are as follows. These files are not a component of
Pandb dll but their working is highly integrated with it. The PanDB component files are as follows:
VBWinsock.dll: This Active-X dll file is used to establish connection to the socket based JTS (Java
Transaction server) and for sending XML as generated by the Pandb. Thereafter, it receives XML
generated by the JTS as an output and in the end closes the socket connection.
AdtTrail.dll: This dll file is used for creating Audit Log Reports based on the Cabinet or on folder
level.
ActView.dll: This dll file is used for performing all the Action Item related functionalities. It involves
initiating an Action Item from the Desktop module, forwarding Action Items to the users as
prescribed in the routes.
Page 21
DocProp.dll: This dll file is used for displaying document properties in OmniDocs. User can apply
new Global Indexes, Keywords, and Data class to the documents. User can also apply Sharing
rights to the documents.
S. No
Variable
Description
Name
1.
VBWinsock.dll
This Active-X dll file is used to establish connection to the socket

based JTS (Java Transaction server) and for sending XML as
generated by the Pandb. Thereafter, it receives XML generated by
the JTS as an output and in the end closes the socket connection.
2.
AdtTrail.dll
This dll file is used for creating Audit LogReports based on the
Cabinet or on folder level.
3.
ActView.dll
This dll file is used for performing all the Action Item related
functionalities. It involves initiating an Action Item from the Desktop
module, forwarding Action Items to the users as prescribed in the
routes.
4.
DocProp.dll
This dll file is used for displaying document properties in OmniDocs.

User can apply new Global Indexes, Keywords, and Data class to
the documents. User can also apply Sharing rights to the
documents.
Chapter 5 - Remote Image Server

In a multi-location scenario, clients and servers are spanned across different geographical locations
and data transfer is a problem due to less bandwidth of the network. In this scenario, Remote Image
Service is used to import and access images from remote locations. The architecture of Remote
Image Service is as shown in the following figure:
Page 22
5.1 Remote Image Server Components

Remote Image Server is having two main components for using following two services.
1) SMS: SMS is the Storage Management Server, which listen requests from Image Server client
and consequently performs document addition, retrieval or any other operation on request. You
can connect any storage device to your system and register it with SMS. In addition, you can
also access the storage system through SMS whenever required.
2) ODTomcat: ODTomcat is a windows service created by OmniDocs. To use ODTomcat, tomcat
service can be started as a windows service by using command net start OdTomcat similarly it
can be stopped by command net stop OdTomcat. ODTomcat is used for running JSPs and
Servlets. OmniDocs Web Desktop and Admin are executed by ODTomcat and Apache Service.
5.2 Remote Image Server Component Configuration Matrix

1. Server.ini: It is used by SMS.
The location of Server.ini file is:
<Drive in which OD Server is installed>\Common Services for J2EE\SMS
It has the following optional tags:
S. No
Variable Name
Description
1.
Port
It represents Server port (generally 900).
2.
CFGFile
It represents CFG file for sms (volume.cfg) where

complete information of SMS labels is shown.
3.
Log File
It represents log file name of SMS (Client. log).
4.
RetryCount
It represents the retry count for SMS operation.
5.
AdminPort
It represents the admin port number of SMS (10000).
Page 23
6.
ResolveClient
It represents the flag for resolving remote client

machine name condition.
7.
Encoding
It represents encoding of characters used by SMS.
8.
DefaultConnectionA It represents default connections made by the client to

llowed
the host machine. Its default value is 15.
9.
IsSmslog
Obsolete
10.
ErrorLogSize
Obsolete
11.
ISClientIP
True to enable client's machine IP address.
12.
ChunckSize
chunck size of for read & write in KB.
13.
BytesSize
Define Threshold BytesSize of Read, Write and Fetch

operations.
14.
SmsReadTime
Define Threshold time of Read operation.
15.
SmsWriteTime
Define Threshold time of Write operation.
16.
SmsFetchTime
Define Threshold time of Fetch operation.
17.
ConTimeOut
Define Connection Threshold time in seconds.
18.
SleepTime
Define sleep time of a thread in seconds.
19.
ISConThread
True to enable connection threshold log.
20.
ISHcap
True if Hitachi Content Archival Platform (HCAP) is to

be used
21.
ServerTimeOut
socket timeout in minutes
22.
ReadThreadTimeO
For Document download operation, Thread Timeout
ut
value in seconds.
WriteThreadTimeO
For Document add operation, Thread Timeout value in
ut
seconds.
23.
24.
25.
FetchPageThreadTi For Document view operation, Thread Timeout value in

meOut
seconds.
ThreadTimeOut
Default Thread Timeout value in seconds.
Page 24
26.
CPUThreshold
CPU usage threshold value.
Chapter 6 - OmniDocs Authentication Manager (LDAP)

OmniDocs Authentication Manager is used for the synchronization of a domain configured on any
directory service to the cabinet thus enabling domain authentication for users created in cabinet. The
synchronization process involves addition of domain users selected on the basis of their group
memberships as Supervisor or normal users in the cabinet. Users imported from domain to cabinet
will be authenticated with domain when the user tries to login in any OmniDocs application. Group as
well as group membership synchronization is an optional feature and can be configured to import
groups from domain to cabinet. The group membership of users created in cabinet will also be
synchronized from domain to the cabinet.
6.1 LDAP Components

The components of LDAP are as follows:
1) disldap.jar: It is responsible for interacting with any directory service using JNDI and does all the
operations, such as getting group list, searching user, getting members of a group from domain
by making a connection to directory service. This component is also responsible for
authenticating users and interacts with other components like synchronization module using
socket based XML communication. It contains DirectoryService class whose main function is
executed to run as DIS service which listens on port 1999.
2) sm.jar: Synchronization module is used for carrying out the whole process of synchronizing a
domain to cabinet initiated through LDAP configuration web interface. sm.jar also handles the
scheduling logic needed to schedule synchronization operation on weekly or daily basis.
3) jtshook.jar: The hook applied on JTS is responsible for acting as a layer between OmniDocs web
applications and JTS by capturing input and output XMLs sent and received by JTS. Jtshook.jar
file provides various operations, such as user authentication, allowing or disallowing operations
like group addition and deletion, user addition and deletion etc. Various hooks like
HookConnectCabinet are implemented to capture input XML being sent to JTS, carrying out
authentication operations by interacting with directory service, and making desired changes in
the XML & then sending it to JTS.
Page 25
6.2 LDAP Component Configuration Matrix

There are three ini files and one XML file, which are used as LDAP component configuration matrix.
1) DIS.xml: It is used by synchronization module and DIS service and has the following tags:
The location of DIS.xml file is:
< Installation folder of LDAP>
S.
Variable Name
Description
No
1. SynchLog
It represents whether synchronization log is to be created or

not.
2. DISLog
It represents whether DIS XML log containing XMLs are sent

and received by DIS service should be created or not.
3. ChangePass
It represents whether passwords of existing users in the

cabinet should be changed or not.
4. Encoding
It represents the encoding used while sending or receiving

input or output XMLs.
5. DirectoryService
It represents the directory service; for example, ActiveDS

tag is used for Active Directory. Default tag is used for
other directory services.
2) Map.ini: It is used by DIS and ldapbeans modules and has the following tags:
The location of Map.ini file is:
< Installation folder of LDAP>
S.
Variable Name
Description
No
Page 26
1. Filter tags
Needed for search functions in DIS service.
2. Encoding
It represents the encoding needed for sending and receiving

input and output XMLs used by ldapbeans module.
3. DISLog
It represents whether XML log containing XMLs sent and

received to DIS service by ldapbeans is to be created or not.
4. JTSLog
It represents whether XML log containing XMLs sent and

received to JTS by ldapbeans is to be created or not.
3) Hook.ini: It is used by JTS hook module and has the following tags:
The location of Hook.ini file is:

<Application server root path>
Page 27
S. No
1.
Variable Name
DISPort
Description
It represents the port at which DIS service listens for
requests.
2.
DISIPAddress
It represents the IP address at which DIS service is

running.
3.
GROUPSYNCH
It
represents
whether
group
and
group
member
synchronization is to be done or not.

4.
HOOKPATH
It represents the location at which hook log will be created.
5.
HOOKLOG
It represents whether hook log will be created or not.
4) ldap.ini: It is used by ldapbeans module and has the following tags:

The location of ldap.ini file is:
<Application server root path>
S. No
1.
Variable Name
Encoding
Description
It represents the encoding needed for sending and receiving
input and output XMLs used by ldapbeans module.
2.
DISLog
It represents whether XML log containing XMLs that are sent

and received to DIS service by ldapbeans are to be created
or not.
3.
JTSLog
It represents whether XML log containing XMLs that are sent

and received to JTS by ldapbeans are to be created or not.
Page 28
Chapter 7 - Text Extraction Manager (FTS)

Text Extraction Manager is used for extracting the content of documents in the cabinet thus enabling
full text search for the documents. The text extraction process involves retrieving documents from the
cabinet and then carrying out text extraction on them according to their document type. Image
documents are extracted by carrying out OCR (Optical Character Recognition) extraction mechanism.
MS Office documents, PDF documents, and html documents are extracted by IFilter (a plug-in that is
used to index the content of different file types) extraction. Compressed text files are first
uncompressed and then extracted. EML mail files along with their attachments can also be extracted.
Full text extraction for the cabinet as well as instant text extraction for selected folders can also be
done. Extraction can also be scheduled according to the time interval after which text extraction
should be done. Highlighting of content for image documents is also done.
7.1 FTS Components

The components of FTS are as follows:
1) OmniDocsTEM.exe: It is the main exe file responsible for running text extraction application. It
interacts with MS extraction dlls, tesseract.exe and other dlls for carrying out text extraction. It
carries out the complete sequence of retrieving documents for carrying out FTS, then choosing
extraction technique. After the text extraction process is complete, set its FTSFlag status and if
extraction is successful then FTSed data is set in the database.
2) tesseract.exe: This exe file initializes OCR engine, next carries out OCR extraction of a
document. It then sets the extracted content and data coordinates for highlighting document
content in two temporary files.
7.2 FTS Component Configuration

There is one FTSServer.xml file, which is used for keeping configuration information about Text
Extraction Manager.
1) FTSServer.xml: This xml file is used by FTS to maintain the following information:
The location of FTSServer.xml file is:
<Inside the installed directory>
Page 29
S. No
Variable Name
Description
1.
Cabinet Name
It represents the name of the cabinet used.
2.
IPAddress and
IPAddress and Port of the machine in use
Port
3.
SiteId
Name of the SiteId, which is in use.
4.
UserName
It represents user name of the user entered
5.
Password
It is encrypted password correspondent to define user
6.
ExePath
It is tesseract.exe path. This exe has been already

installed during FTS.exe installation.
7.
Application Name
Here default value is OmniDocs. However, application

name changes with the change in the application.
Chapter 8 - Wrapper
8.1 Wrapper Component Configuration Matrix
There are three configuration files, which are used by wrapper.
1. Log4j.properties: It is used for configuration of wrapper logs.
The location of Log4j.properties file is:
<Drive in which OD Server is installed>\Wrapper->ngdbini
2. NGOClientData.xml:
The location of NGOClientData.xml file is:
Page 30
S. No
1.
Variable Name
ProviderUrl
Description
It represents a protocol that depends upon
specific application sever which is being used.
2.
JNDIServerName
It represents IP address of the application

server.
3.
JNDIServerPort
It represents the RMI port or IIOP port

number.
4.
JNDIContextFactory It represents that initial context factory

depends on the application server and
protocol being used.
5.
ClientLookUpe
It represents actual bean for lookup.
6.
AdminLookUpName It represents actual bean for lookup (Admin

Lookup).
7.
UrlPackagePrefix
Provide only if AppServer is JBoss and

clustering is used.
8.
PartitionName
Provide only if AppServer is JBoss and

clustering is used.
3. NGOWrapper.xml:
The location of NGOWrapper.xml file is:
S. No
Variable Name
Description
1.
WrapperIP
IP of machine on which wrapper is running
2.
WrapperPort
It represents Server portof Wrapper (3333

default).
3.
AdminPort
It represents the admin port number of

Wrapper(9999 default)
Page 31
4.
SocketTimeOut
Socket timeout in minutes
5.
AdminStart
Configuration flag to start admin port of

wrapper.
6.
Debug
Obsolete
7.
CharacterSet
It represents encoding of characters used by

Wrapper.
8.
ClientMaxConnAllo
It represents maximum connections allowed to
wed
wrapper made by the client.
Chapter 9 - Replication Scheduler

Replication Scheduler is used for performing replication of volumes at their respective replica sites at
the scheduled time. Replication jobs can be created through OmniDocs Web Admin by creating
replication jobs. A volume must have a Replica Site configured for it. One or more than one volume
site combinations can be selected for replication. Quartz scheduler is used to enable execution of a
job at scheduled time to run replication. The replication job will be executed for the fixed duration of
time, which has been decided for running a particular replication job. Replication scheduler service
ODRep is restarted automatically after changing settings to enable quartz scheduler to pick up the
new job settings, which have been created.
9.1 Replication Scheduler Components

The components of Replication Scheduler are as follows:
1) ODRep.jar: It consists of main logic needed for scheduling the job, running it at scheduled time by
using quartz scheduler. ODRep.jar also contains the logic needed to run the replication job i.e.;
replicate the required volume at the selected replica site by looping for all volblocks followed by
looping for all documents present in a volblock. The file also contains encryption and decryption
code used for storing passwords in the encrypted form in xmls.
Page 32
2) quartz.jar: It is a third party scheduler used to harness scheduling capabilities.
9.2 Replication Scheduler Component Configuration Matrix

There are two XML files, which are used as Replication Scheduler component configuration matrix:
1) Jobs.xml: It contains job information needed by Quartz scheduler to run the job at scheduled time.
The main tags used for storing information are:
The location of Jobs.xml file is:
<Drive
in
which
OD
Server
is
installed>\Program
Files\OmniDocs
Server\Replication
Schedular\jobxml \Jobs.xml
S. No
Variable
Description
Name
1.
name
It represents the name of the replication job created from OmniDocs

admin.
2.
job-class
It represents the name of the class file called by Replication

Scheduler to run the replication at scheduled time.
3.
start
It represents the starting time for a specific job at which the

scheduled job will run.
4.
duration
It represents the total time for which the specific job will run
after it is started.
2) ReplicationJob.xml: This xml contains the details about replica sites and volumes using the
following tags:
Page 33
The location of ReplicationJob.xml file is:

<Drive in which OD Server is installed>\Program Files\OmniDocs Server\Replication
Schedular\ jobxml\ReplicationJob.xml
S. No
1.
Variable Name
RETRY_COUNT
Description
It represents the number of times a replication job should
be tried for execution even if it fails due to some reason.
2.
RETRY_INTERVAL
It represents the time gap after which a job should be

retried for execution.
3.
JTS_IP
It represents the address of the JTS IP at which JTS is

running and should be used for making a connection.
4.
JTS_PORT
It represents the port number of the JTS port, which

should be used for making a connection to JTS.
5.
CABINET_NAME
It represents the name of the cabinet used.
6.
USER_NAME:
It represents user name of the user entered while

entering scheduling information, which should be used
for making connection with JTS.
7.
PASSWORD
User password entered in scheduling information stored

in encrypted form.
8.
STATUS
Status of the job being considered as whether it is

executing, stopped, interrupted, or completed.
9.
LAST_EXECUTION_T
It represents the time at which the job was executed last
IME
time.
10. VOLUME_NAME
It represents the volume name of the volume to be

replicated.
11. REPLICATION_SITE_
NAME:
It represents the name of the replica site at which volume

should be replicated.
Page 34
Chapter 10 - OmniDocs Configuration Settings on Application

Server(s)
Connection Pool settings are recommended for 50-75 users. When concurrency of users is increased
then Connection pool settings are increased. These settings are increased by approximately 1
connection per 2-3 users.
NOTE:
(*) Parameters are applicable for OmniDocs 6.0.2 (including future releases) and all non-English setups prior to
OmniDocs 6.0.2
() Parameters are not applicable for OmniDocs 6.0.2, (including future releases)
10.1 JBoss 6.1.1/ JBoss-6.0 EAP

Sr.
Parameters
No.
1
-Xms
Default
Recommended
How
Value
Value
To
64m
512m
Set
Remarks
Minimum size of the java
heap. Large heaps can take
several seconds to fill up, so
garbage collection occurs
less frequently which means
that pause times due to GC
will increase.
-Xmx
64m
1024m
Set
Maximum size of the java

heap.
Increasing the size of the
Java heap improves
throughput to the point
where the heap no longer
resides in physical memory.
The max heap setting
should be set small enough
to contain the heap within
physical memory to avoid
Page 35
performance suffering.
3
-Dfile.encoding
Platforms
(*)
encoding
SelectMethod
Direct
UTF-8
Set
To set system encoding.Dfile.encoding=UTF-8
Cursor
Set
Method type.
Cursor: To execute multiple
statements against a SQL
Server database with the
JDBC driver.
Direct: to use only one
active statement on each
connection.
CheckValidCon
Select 1
Select 1
Set
nectionSql
Used to make Jboss check

connections before handing
them out to applications.
MinConnection
10
Set
No. of min connections

allowed
MaxConnection
20
25
Set
No. of max connections

allowed.
URIEncoding
ISO-8859-
(*)
UTF-8
Set
To encode the web

parameters.
UTF-8: all parameters are
UTF-8 encoded.
SocketTimeOut
60 mins
60 mins
Set
Maximum amount of time

Wrapper component will
accept incoming client
requests on a particular
Socket. Also determines the
time period (1.5
*SocketTimeOut), user
session is valid.
10
BatchSize
100
100
Set
Maximum number of
records returned in a
particular transaction. The
Page 36
size should be kept

depending on the
requirement
11
ConnectionLog
False
False
Set
()
12
Connection Log.
TransactionLog
False
False
Set
()
13
Flag determining creation of

Transaction Log.
XMLLog ()
False
False
Set

XML Log.
14
Querytimeout
300
300
Set
Maximum amount of time,

server will wait for the result
of a particular database
transaction. Should be set
to give enough time to the
database perform a
transaction.
15
CharacterSet
UTF-8
UTF-8
Set
Servers encoding
(*)
Chapter 11 - Database Server

11.1 MSSQL Server 2008/2012
Sr. No.
1
Parameters
Tempdb size
Default Value
8MB(Data File)
1MB(Log file)
Remarks
Increased Tempdb size improves the
performance of extensive operations like
sorting and index rebuilding etc.
Database growth
9MB(Data File) 5
MB(Log File)
The selections under "Automatically Grow

File" definitely matter. Leaving these
settings too low (eg, 1 meg, 10%, etc) will
eventually lead to system performance
issues due to fragmentation of the files.
Service Pack
Service Pack 3a provides new features
Page 37
viz enhanced error reporting, better

performance and security, new diagnostic
T-SQL etc.
4
Automatic
Disabled
shrinking
Automatically shrinking not recommended

as it can cause serious performance
degradation. With every database update
operation, DB is shrunk causing the
operations to wait and time out.
Trace
Off
Traces are turned on for debugging

operations only. Setting them On
permanently may impact system
performance.
11.2 Oracle 11g

Sr.
Parameters
Default Value
Remarks
No.
1
SGA Size
Set on
Installation(no
Putting entire SGA in real memory

increases system performance.
default Value)
2
Maximum Open
50
Cursor
Setting this value high enough prevents

the application from running out of open
cursors. There is no added overhead to
setting this value higher than actually
needed.
Database file
20MB
growth
4
Undo Table
Database file should be large enough to

reduce fragmentation.
100MB
space size
Undo tablespace should be large enough

to accommodate all unexpired undo
entries,otherwise transactions will fail with
an error message : failed to extend
rollbacksegment
Page 38
Chapter 12 - Browser Settings

12.1 Internet Explorer
Sr.
Parameters
No.
1
Default
Value
How To
Remarks
8.0
Check
8.0 version is a reliable and flexible
Value
IE Version
8.0
Web browsing experience with

enhanced privacy features.
2
Service
SP1
SP1
Check
Pack
Internet explorer 8 with SP1 is

designed to make it easy to browse
and interact with sites on an
intranet or on the Internet.
Sun Java
Enable
Enable
Check
plug-in
Java Plug-in technology, included

as part of the Java Runtime
Environment, Standard Edition
(Java SE), establishes a
connection between popular
browsers and the Java platform.
This connection enables applets on
Web sites to be run within a
browser on the desktop.
Temp
593 MB
200 MB
Check
Size of the file where the files from
Internet file
the Internet will be temporarily
size
stored. Decrease in performance if

the value is set too high or too low.
Language
Set
12.2 Mozilla FireFox

Sr.
No.
Parameters
Default
Value
How To
Remark
Value
Page 39
Version
29.0.1
Check
1.5
Implementation of java scripts

differs from version to version. The
recommended version is preferred
Chapter 13 - Network Settings

Sr.
Parameters
No.
1
Default
Value
How To
Remarks
NA
~ 30 ms
Check
LAN speed
NA
~250 ms
Check
WAN speed
NA
1492
Check
64
64
Check
Value
Ping speed
(LAN)
Ping speed
(WAN)
Interface\M
TU
DefaultTTL
Time to Live (TTL) value in the

header of outgoing IP packets
Chapter 14 - Operating System Settings

14.1 Windows 7/Windows Server 2008/ Windows Server 2012
Sr.
Parameters
Default Value
Value
How To
Page file size
5220-8128 MB
At least 1280 MB & not
Check
No.
1
fragmented
2
Virtual Memory
3476 MB
1/3 rd of RAM
Check
30 GB
30 GB
Check
Size
3
Free Hard Disk
Chapter 15 - Configuration Settings of Thumbnail Manager
Page 40
15.1 Thumbnail Manager

Thumbnail manager is the utility used for generating thumbnails of image type documents in
OmniDocs.
15.2 Thumbnail Manager Component Configuration Matrix

There are two xml files and an ini file, which are used as Thumbnail Manager Component
configuration matrix.
1. Omni_Configurations.xml: It is used to specify the Thumbnail Maganer directory/path location and
has only one tag <PathInfo>.
The location of Omni_Configurations.xml file is:
< Drive in which OD Server is installed>\Common Services for J2EE \Thumbnail
Manager\lib\Omni_Configuration.xml
S. No
Variable Name
Description
1.
Name
It represents location name (Replication.log).
2.
Path
It represents actuall path of the Thumbnail Manager
2. ThumnailConfig.xml: It is used to configure the cron trigger, cabinet and log related configuration.
It has two main tags
<General></General>
<cabinets></cabinets>.
Page 41
a) General: This tag encompasses logger and crone trigger tags.

S. No
Variable Name
Description
1.
enablelogger
It represents logger is enabled or not.
2.
Logconfiguration
It represents location of log4j.properties.
3.
CronTrigger
It represents value of cron trigger.
b) Cabinets: All cabinets related tags/info is defined here.

Cabinet: This tag is used to define the cabinet for which you want to configure Thumbnail
Manager.
The location of cabinet file is:
< Drive in which OD Server is installed>\Common Services for J2EE\Thumbnail
Manager\Thumbnail_Config.xml
S. No
Variable Name
Description
1.
cabinetname
Name of the cabinet
2.
jtsip
jts ip address
3.
4.
jtsport
jts port
user
User name for which thumbnail is to be configured.

Thumbnail uses this user credentials for fetching the
documents from server and generating thumbnails
afterwards.
5.
Password
password of user in encrypted form
6.
BatchSize
Number of thumbnails to be shown in one batch
7.
priority
priority of the job
8.
encoding
encoding used is defined in this tag
Page 42
3. IS.ini: It is used by Image Server (ISPACK) and have the following optional tags:
The location of cabinet file is:
<Application sever root path>IS.ini
S. No
Variable Name
Description
1.
LogPath
It represents replication log file name (Replication.log).
2.
SMSTimeOut
It represents SMS time out limit in milliseconds.
3.
4.
SMSReadInterval
It represents SMS read interval in milliseconds.
SMSRetryCount
It represents the number of retry counts for SMS.
5.
SMSGenerateLog
It represents a flag that shows whether the SMS log is to

be generated or not.
6.
IsJNDI
It represents a flag that shows whether JNDI lookup

occurs or not.
7.
ProviderUrl
It represents a protocol that depends upon specific

application sever which is being used.
8.
JNDIServerName
It represents IP address of the application server.
9.
JNDIServerPort
It represents the RMI port or IIOP port number.
10. JNDIContextFactory
It represents that initial context factory depends on the

application server and protocol being used.
11. LookupBean
It represents actual bean for lookup.
NOTE:
IS.ini file has to be copied to Thumbnail directory while configuring Thumbnail Manager.
Page 43
15.3 Steps to configure Thumbnail Schedular/Manager

1. Open Thumbnail Manager\lib\Omni_Configurations.xml and specify the full path of thumbnail
Manager in the path tag.
2. Make the cabinet entry in the ThumbnailConfig.xml
3. Replace ngdbini (take backup) folder in Thumbnail Manager with wrappers ngdbini folder.
4. Replace Thumbnail_lib(take backup) folder jars in Thumbnail Manager with corresponding
wrapper's wrapper_lib folder jars
5. Copy file "IS.ini from location "<Jboss-4.0.2_HOME>\bin" and paste in folder Thumbnail
Manager".
6. Edit run.bat and specify java path and save it.
7. Run the Thumbnail Manager by clicking run.bat
Chapter 16 - Configuration Settings of Alarm Mailer

16.1 Alarm Mailer
Alarm mailer is the utility used for generating emails and sending to the configured user on the
occurrence of certain events/activities like add document, delete document etc.
16.2 Alarm mailer Component Configuration Matrix

An INI is file is used as Alarm Mailer component configuration matrix.
1. Alarm.ini: It is used to configure all alarm mailer related configuration. It has three main tags
a) General: This tag encompasses logger, mail server configuration and user credential tags. All
the tags are self explanatory.
S. No
Variable Name
Description
1.
protocol
It represents protocol used by the mail server.
2.
mailhost
It represents mail server host name
3.
mailserverport
It represents mail server port.
4.
Username
User name of the user
Page 44
5.
Password
Password of the user
6.
sslenabled
set false if ssl not enabled or otherwise
7.
fromaddress
email address of the user configured
8.
webservername
webserver name
9.
webserverport
webserver port
10. enablelogger
set true to enable logger or otherwise
11. logconfiguration
location of log4j.properties
12. contextname
context name
b) Cabinets: All cabinets related tags/info is defined here.

Cabinet: This tag is used to define the cabinet for which you want to configure Alarm Mailer.
S. No
Variable Name
Description
1.
cabinetname
name of the cabinet
2.
jtsip
jts ip address
3.
jtsport
jts port
4.
user
User name for which alarm mailer is to be

configured.Alarm mailer uses this user credentials for
sending the mails/alerts about the events.
5.
Password
Password of user in encrypted form
6.
Polltime
Interval in which Alarm mailer will keep polling for any

events occurred on the server.
Page 45
c) Templates: All email templates are defined in this tag. No need to change
The location of template file is:
< Drive in which OD Server is installed>\Common Services for J2EE\Alarm Mailer\Alarm.ini
<templates>
<AlarmHTML>Alarm.htm</AlarmHTML>
<AlarmTXT>AlarmMailer.txt</AlarmTXT>
<NotesHTML>AlarmNotes.htm</NotesHTML>
<NotesTXT>AlarmNotes.txt</NotesTXT>
<DeleteHTML>Alarm_Doc_Deleted.htm</DeleteHTML>
<DeleteTXT>AlarmDocDeleted.txt</DeleteTXT>
<AddHTML>Alarm_Doc_Added.htm</AddHTML>
<AddTXT>Alarm_Doc_Added.txt</AddTXT>
<AlarmPassTXT>AlaramMailer_UserPass.txt</AlarmPassTXT>
<AlarmPassHTML>AlarmMailPass.htm</AlarmPassHTML>
<ReminderHTML>Reminder.htm</ReminderHTML>
<ReminderTXT>Reminder.txt</ReminderTXT>
<EmptyReminderHTML>EmptyReminder.htm</EmptyReminderHTML>
<EmptyReminderTXT>EmptyReminder.txt</EmptyReminderTXT>
<ResetPasswordHTML>ResetPassword.htm</ResetPasswordHTML>
<ResetPasswordTXT>ResetPassword.txt</ResetPasswordTXT>
<AddUserHTML>AddUser.htm</AddUserHTML>
<AddUserTXT>AddUser.txt</AddUserTXT>
<GeneratePasswordHTML>GeneratePassword.htm</GeneratePasswordHTML>
<GeneratePasswordTXT>GeneratePassword.txt</GeneratePasswordTXT>
<PassExpiryHTML>Pass_Expiry.htm</PassExpiryHTML>
<PassExpiryTxt>Pass_Expiry.txt</PassExpiryTxt>
<PASSWORDGENSUBJECT>NEW USER ADDED WITH
PASSWORD</PASSWORDGENSUBJECT> </templates>
Page 46
16.3 Steps to configure Alarm Mailer

IF Authentication is Enabled on Mailserver
1. Run encryptPassword.bat and provide the password for EMAILID configured on the mailserver.
2. Encrypted password will be generated .For ex hello generates ':M:Y8r:n'
3. The content between the quotes is encrypted password i.e. :M:Y8r:n
4. For copying the encrypted password -->Right click on console and mark the password and then
paste it in */AlarmMailer/Alarm.ini within <password></password> tags.
5. Specify the username and password, mailserverIP, mailserverPort etc in Alarm.ini as follows
depending on Mailserver Settings. For example :
<username>dummyuser</username>
(To be set as blank if Authentication is not enabled on mailserver)
<password>encyptedpassword</password>
(To be set as blank if Authentication is not enabled on mailserver)
<sslenabled>false</sslenabled>
(to be set as false if SSL is not enabled mailserver)
<mailhost>smtp@gmail.com</mailhost>
(can be IP Address or fully qualified domain name of mailserver)
<mailserverport>465</mailserverport>
(PORT ON WHICH SMTP SERVICE IS RUNNING)
6. Replace all the files in the ngdbini folder present in this folder with the corresponding wrapper's
ngdbini folder files.
7. Copy wrapper lib jar files into alarm lib and replace the jars which conflicts.
Specify the cabinet Name and UserName and other configuration within <Cabinet></Cabinet> tag of
Alarm.ini
Page 47
NOTE:
1. THERE SHOULD BE NO TAGS WITH DUPLICATE NAME.
2. NETWORK CONNECTION FROM THE M/c on which service is running to Mailserver should be proper.
3. Check it through Telnet <MAILSERVERIP> <SMTPPORT>
4. The blank value of redirectURL in AlarmMailPass.htm will subsequently login into omnidocs with newly set password
once password is successfully reset using AlarmMailer service.
For Ex-<PROTOCOL>//<SERVER>/ForceChangePassword.jsp?<URLPASSWORD>&redirectURL=
5. If value of redirectURL parameter is set to login.jsp then Login Page of omnidocs will be displayed once password is
successfully reset using AlarmMailer service.
For Ex-<PROTOCOL>//<SERVER>/ForceChangePassword.jsp?<URLPASSWORD>&redirectURL=login.jsp
6. Replace ForceChangePassword.jsp in omnidocs.war. (..\omnidocs\ForceChangePassword.jsp>please take bakcup
before replacing).
7. Take back up of AlarmMailer folder in ..\Common Services for J2EE\AlarmMailer and then replace AlarmMailer folder.
Chapter 17 - Configuration Settings of Action Item

Steps for enabling Action Item on various Application Servers:
FOR JBOSS:
1. Go to
<JBOSS_HOME>\bin\ngdbini\odwebini.
2. Now open admin.ini and replace Provision tag with the following entry:
Provision=11
3. Now open eworkstyle.ini file and replace ProvisioningString tag with the following entry:
ProvisioningString=100010000
4. Restart the JBOSS Server.
NOTE:
Both the eworkstyle.ini should be changed to enable action item.
Page 48
Chapter 18 - Personal Settings Sorting Preferences

Admin Level
S.No.
Parameter
Value
Meaning
s
1
SortFieldId
SortOrderId
Document Name
11
Document Size
Document Type
10
No. Of Pages
Modified Date
Owner
18
Order No.
Ascending
Descending
User Level
Refer Web Desktop Reference Manual section 1.5.16
Page 49
Chapter 19 How to Set UTF-8 encoding Character Set

19.1 - Steps to set UTF-8 encoding Character Set in OmniDocs 8.0
Windows - Jboss-6.1.1 Application Server
1. Go to JBoss installation path.
Page 50
2. Go to bin folder.
Page 51
3. Add following parameter in in run.conf.bat (for Windows) and run.conf (for Linux) under
JAVA_OPTS.
-Dfile.encoding=UTF-8
Page 52
4. Go to:
Jboss installation Path\Server\<JBOSS_INSTANCE>\deploy\jbossweb.sar\server.xml.
Page 53
5. Add following lines in <Service name="jboss.web"> tag:

URIEncoding="UTF-8" useBodyEncodingForURI="true"
6. Restart Jboss-6.1.1 Application Server after above changes.
Page 54
19.2 - Steps to set UTF-8 encoding Character Set in OmniDocs 8.0 Windows - Jboss-6.2.0 EAP Application Server
1. Go to Jboss-6.2.0 EAP installation path.
Page 55
2. Go to bin folder.
Page 56
3. Add following parameter in standalone.conf.bat (for Windows) and standalone.conf (for Linux)
under JAVA_OPTS.
Page 57
4. Go to Jboss EAP installation Path\standalone\configuration\standalone.xml.

5. Add following lines after </extensions> and before <management> tags:
<system-properties>  <property

name="org.apache.catalina.connector.URI_ENCODING" value="UTF-8"/> <property
name="org.apache.catalina.connector.USE_BODY_ENCODING_FOR_QUERY_STRING"
value="true"/> </system-properties>
6. Restart Jboss-6.2.0 EAP Application Server after above changes.
Page 58

Windows - WebSphere 8.5 Application Server
1. Login into WebSphere Administrative Console.
Page 59
2. Expand Servers >> Server Types >> WebSphere Application Servers.
Page 60
Page 61
3. Click on Application Server (JVM) you want to enable UTF-8.

4. Expand Java and Process Management under Server Infrastructure and click on Process
Definition:
Page 62
5. Click on Java Virtual Machine:
Page 63
6. Add following parameter in Generic Java Arguments :
7. Click on OK and save to save data to Master Configuration.

8. Expand Resources >> JDBC >> Data Sources
Page 64
Page 65
9. Click on your respective data source and then click on Custom Properties:
Page 66
10. Click on sendStringParametersAsUnicode Property:
Page 67
11. Modify Property value as True from false:
Page 68
12. Click on OK and Save to save data to Master Configuration:
13. Restart WebSphere 8.5 Application Server.

Windows - WebLogic 12C Application Server
No Specific configuration is required to be done on Weblogic Server for Arabic Locale support.
Page 69
Chapter 20 - How to Configure IVApplet Viewer and OpAllViewer

Steps to change, IVApplet Viewer to OpAllViewer are as follows:1. Select and open eworkstyle.ini file. The location of this file is as follows:Application server root path\ngdbini\odwebini
2. In this file, make changes in EnableDisableOpAllFlag parameter.
Default Value of this parameter is N.
Setting value to N signifies IVApplet will be enabled.
And setting value to Y signifies OpAllViewer will be enabled. For further information refer
EnableDisableOpAllFlag parameter.
3. Save and close the eworkstype.ini file.
4. Now select and open web.xml file. This file is present in the OmniDocs.war/WEB-INF folder of the
application. The location of this war folder depends on the application server in use. Different
locations of this war folder, as per its application server, are as follows: JBOSS Community:
<Server_Installed_Directory>\server\<Instance_name>\deploy
JBOSS EAP:
<Server_Installed_Directory>\standalone\deployments
Weblogic:
<Server_Installed_Directory>\user_projects\domains\<instance_name>\applications
WebSphere 1:
<Server_Installed_Directory>\WebSphere\AppServer\profiles\<profile_name>\installedApps\vm58
0Node03Cell\omnidocs.ear\
WebSphere 2:
<Server_Installed_Directory>\WebSphere\AppServer\profiles\<profile_name>\config\cells\vm607N
ode03Cell\applications\omnidocs.ear\deployments\omnidocs
Page 70
NOTE:
In IBM WebSphere application server, web.xml file is present in two OmniDocs.war/WEB-INF folders. To enable Opall
Viewer, it is necessary to pick web.xml file from the war folder of both these locations and make the necessary
configuration changes in it. The locations of the war folder where the web.xml file is present are provided above.
5. In this file, make changes in EnableDisableOpAllFlag tag.

Default Value of this tag is N.
Setting value to N signifies IVApplet will be enabled.
Setting value to Y signifies OpAllViewer will be enabled. For further information refer Web.xml
section.
6. Save and close the web.xml file.
Appendix A
Following steps should be followed to change parameters of JBoss:
1. Go to JBOSS Home directory. For e.g. C:\jboss3.2.7.
2. Go to bin directory. For e.g. C:\jboss3.2.7\bin.
3. Open the Run.bat file
4. Change the parameters, Xms and Xmx
rem Sun JVM memory allocation pool parameters. Modify as appropriate.
set JAVA_OPTS=%JAVA_OPTS% -Xms512m Xmx1024m "-Dfile.encoding=UTF-8"
5. Save the file.
6. Restart JBOSS.
7. Open mssql-ds.xml from <Jboss Home>\Server\<Jboss Instance>\deploy
8. Add the following line:
<connection-property name="SelectMethod">cursor</connection-property>
Note: This property is not to be set for Mssql 2005 server Data-sources. It is valid only for
Mssql 2000 data-sources.
9. For Mssql 2005 Server Data-sources, open mssql-ds.xml from <Jboss Home>\Server\<Jboss
Instance>\deploy and add the following line:
<check-valid-connection-sql>Select 1</check-valid-connection-sql>
10. Save the file.
Page 71
11. In case of Jboss_3.2.7 or Jboss_4.0.2, open server.xml from <Jboss
Home>\Server\<Jboss
Instance>\deploy \jbossweb-tomcat50.sar folder.

12. Add URIEncoding="UTF-8" parameter to HttpConnector
<Connector port="8080" address="${jboss.bind.address}"
URIEncoding="UTF-8" maxThreads="150" minSpareThreads="25"
maxSpareThreads="75"
enableLookups="false" redirectPort="8443" acceptCount="100" connectionTimeout="20000"

disableUploadTimeout="true"/>
13. In case of Jboss_5.0.1, open server.xml from <Jboss Home>\Server\<Jboss Instance>\deploy
\jbossweb.sar folder.
14. Add URIEncoding="UTF-8" parameter to HttpConnector
<Connector protocol="HTTP/1.1" port="8080" address="${jboss.bind.address}"
connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8"/>
15. Save the file
16. Go to <Jboss Home>\bin\ngdbini. Open server.xml. Change Value of tags as follows:
BatchSize
100
ConnectionLog
False
TransactionLog
False
XMLLog
False
Querytimeout
300
CharacterSet
UTF-8
17. Save the file.

18. Restart Jboss.
19. Go to <Wrapper Installation Directory>\ngdbini. Open NGOWrapper.xml. Change
Value of tags
as follows:
SocketTimeOut
60
CharacterSet
UTF-8
20. Save the file.

21. Restart Wrapper.
Page 72
Appendix B
1. To check the version of IE (Internet Explorer) installed, open IE.
2. Open Help from menu bar and select About Internet Explorer.
3. Check the Version and Latest SP.
Page 73
To enable Sun java plug-in, perform the following steps:

1. Click Tools and then Internet Options
Page 74
2. Select the Security tab, and select the Custom Level button
Page 75
3. Scroll down to Scripting of Java applets.
4. Make sure the Enable radio button is checked.

5. Click OK to save your preference.
Page 76
To set Temp Internet File Size follow these steps:

1. Go to Tools->Internet Option and select the General Tab.
2. Click on the Settings button.
Page 77
3. Set temp file size as 200MB, by making changes in the Disk space to use.
Page 78
To Check Language Preferences,

1. In Internet Explorer, Go to Tools -> Internet options -> Language
Page 79
2. Set Language as en_us for English language and ar_jo for Arabic Jordan and so on.
Page 80
3. Click OK and close browser.
Appendix C
1. To check the version of FireFox installed, open Firefox.
2. Select Help -->About Modzilla Firefox.
3. Check the Version.
Page 81
Appendix D
To check network setting, follow the mentioned steps:
1. Go to command prompt.
2. Ping the desired machine by typing ping <Space> <IP>.
Page 82
3. Check for Ping Speed (LAN). It should be ~30ms.
4. Check the Default TTL value. It should be ~64.
Page 83
Appendix E
Checking page file size:
1. Go to Desktop. Left click on My Computer. Select Properties.
Page 84
2. Select Advanced system settings.
Page 85
3. Click on the Settings button, present in the Performance Section.

4. In the Performance Options dialog box, click on the Advanced tab.
Page 86
5. In the Virtual Memory section, click the Change button.

6. Virtual Memory dialog box appears.
Page 87
7. Disable Automatically manage paging file size for all drives.

8. Enable Custom Size option.
9. Custom Size Change the paging file size for the selected drive and click OK.
Page 88
Checking virtual Memory Size

1. Go to My Computer->Properties->Advanced tab.
Page 89
2. Click the Performance Options button.

3. Check the size of Virtual Memory.
Page 90
Checking free Hard disk

1. Go to My Computer.
2. Right Click on desired drive to view its properties.
3. Amount of Used and Free Space on drive will be displayed.
Page 91

OmniDocs 8.2 Configuration Settings Guide

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

OmniDocs 8.2 Configuration Settings Guide

Caricato da

Copyright:

Formati disponibili

OmniDocs 8.

Newgen Software Technologies Ltd

CHAPTER 12 - BROWSER SETTINGS .......................................................................................................... 39

Chapter 1 - Image Server

1.1 Image Server Components

1.2 Image Server Component Configuration Matrix

OmniDocs 8.2 - Configuration Settings Guide

It contains the following tag:

It represents replication log file

It represents SMS time out limit

It represents SMS read interval in

It represents the number of retry

It represents a flag that shows

whether the SMS log is to be

It represents a flag that shows

whether JNDI lookup occurs or

It represents a protocol that

It represents IP address of the

It represents the RMI port or IIOP

JNDIContextFactory It represents that initial context

OmniDocs 8.2 - Configuration Settings Guide

It represents actual bean for

Provide only if AppServer is

Provide only if AppServer is

Proxy address of proxy

Port of the proxy server which is

A valid user name authenticated

A flag to enable a local copy of

A flag to enable local lookup of

Path of directory where local

Site ID of looked up SMS on the

Provide only if Cabinet Name

OmniDocs 8.2 - Configuration Settings Guide

based SMS lookup is required.

SMS IP of looked up SMS on the

SMS port of looked up SMS on

Provide True to enable

transaction start & end time in

SMS port of machine two in

SMS IP of machine two in cluster

SMS port of machine one in

SMS IP of machine one in cluster

Provide True if SMS is running in

2) Server.ini: It is used by SMS.

It represents Server port (generally 900).

It represents CFG file for sms (volume.cfg) where

OmniDocs 8.2 - Configuration Settings Guide

It represents log file name of SMS (Client. log).

It represents the retry count for SMS operation.

It represents the admin port number of SMS (10000).

It represents the flag for resolving remote client machine

It represents encoding of characters used by SMS.

It represents default connections made by the client to the

host machine. Its default value is 15.

True to enable clients machine IP address.

chunck size of for read & write in KB.

Define Threshold BytesSize of Read, Write and Fetch

Define Threshold time of Read operation.

Define Threshold time of Write operation.

Define Threshold time of Fetch operation.

Define Connection Threshold time in seconds.

Define sleep time of a thread in seconds.

True to enable connection threshold log.

True if Hitachi Content Archival Platform (HCAP) is to be