OmniDocs 10.1 Installation Guide - Windows

OMNIDOCS 10.
FRESH INSTALLATION
WINDOWS
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
August - 2019
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 Newgen 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 © 2019 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
Newgen OmniDocs 10.1 – Installation Guide on Windows Page 2

TABLE OF CONTENTS
1 OmniDocs 10.1 – JBOSS EAP 6.4 ......................................................................................................................4
1.1 Pre-requisites for Fresh Installation .......................................................................................................................... 4
1.2 OmniDocs 10.1– Installation Steps ............................................................................................................................ 4
2 OmniDocs 10.1 – Oracle WebLogic 12C ......................................................................................................... 29
2.1 Pre-requisites for Fresh Installation ........................................................................................................................ 29
2.2 OmniDocs 10.1 - Installation Steps.......................................................................................................................... 32
3 OmniDocs 10.1 – IBM WebSphere 8.x/9.x .................................................................................................... 74
3.1 Pre-requisites for Fresh Installation ........................................................................................................................ 74
3.2 WebSphere Settings for Secure Profile.................................................................................................................... 75
3.3 OmniDocs 10.1- Installation Steps........................................................................................................................... 81
3.4 Data Source Creation ............................................................................................................................................ 109
3.5 OmniDocs Configuration for Session Management ............................................................................................... 122
3.6 OpAll Configuration for Session Management ....................................................................................................... 127
4 OmniDocs 10.1 – WildFly 11.0.0 Final ......................................................................................................... 131
4.1 Pre-requisites for Fresh Installation ...................................................................................................................... 131
4.2 OmniDocs 10.1 – Installation Steps ....................................................................................................................... 131
5 OmniDocs 10.1 – JBOSS EAP 7.x .................................................................................................................. 156
5.1 Pre-requisites for Fresh Installation ...................................................................................................................... 156
5.2 OmniDocs 10.1 – Installation Steps ....................................................................................................................... 156
6 OmniDocs 10.1 – Upgrade Steps – MSSQL .................................................................................................. 181
6.1 OmniDocs 10.1 – Upgrade Steps ........................................................................................................................... 181
7 OmniDocs 10.1 – Upgrade Steps – Oracle ................................................................................................... 196
8 OmniDocs 10.1 – Upgrade Steps - PostgreSQL ............................................................................................ 211
9 Web API ...................................................................................................................................................... 226

1 OmniDocs 10.1 – JBOSS EAP 6.4
1.1 Pre-requisites for Fresh Installation

 Earlier version of OmniDocs should not be present.
 JDK Version: JDK and JRE 1.7.0_67 or above should be installed on machine.
 Operating System: Windows 7/ Windows Server 2008/12
 Database:
 Microsoft SQL Server  Microsoft Azure
 Oracle  PostgreSQL
 Application Server: Red Hat JBoss-EAP 6.4

 Others: Administrative Rights of the machine.
 Make sure the Application Server is in Stop Mode.
1.2 OmniDocs 10.1– Installation Steps

In order to install OmniDocs 10.1, perform the following steps:
1. Right-click on OmniDocs10.1.exe and select Run as Administrator.
2. Installer Wizard progress bar appears.
Figure 1.1

3. When the setup application is fully loaded, Introduction screen appears.
4. Click Next.
Figure 1.2

5. Choose Install Type screen appears.
6. Select Fresh Installation to perform the fresh installation.
7. Click Next.
Figure 1.3

8. Pre-requisites screen appears.
9. Confirm the mandatory specified pre-requisites by selecting all the check-boxes.
10. Click Next.
Figure 1.4

11. License Agreement screen appears.
12. Accept the terms of License Agreement and click Next to continue with the setup process:
Figure 1.5

13. Application Server screen appears.
14. Select Red Hat JBoss-EAP 6.4 Application Server.
15. Click Next.
Figure 1.6

16. Database Server screen appears.
17. Select the required Database Server.
18. Click Next.
Figure 1.7

19. Automated Configuration screen appears.
20. As per your requirement, select one of the following options:
 Automated Configuration Required to automate the remaining installation process.
 Automated Configuration Not Required
21. Click Next.
Figure 1.8

a. When “Automatic Configuration Required” Is Selected:-
i. Database Information screen appears. Refer the below table to specify the database details:
Database Server IP(For All Databases) IP Address of the Database Server

Database Server User Name(For All Databases) User Name of the Database.
Database Server Password(For All Databases) Password to access the Database.
Database Server Port(For All Databases) JDBC Connection Port on which the Database Server runs.
Cabinet Name(For All Databases) Name of the OmniDocs Cabinet.
Database Service Name(For Oracle Database) Unique name that identifies the Oracle Database Instance
ii. Once all the details are entered, click Next.
Figure 1.9

iii. If connection to the Database is established successfully, Data-base Connection Success screen
appears.
Figure 1.10
 If the specified “Database Information” is incorrect, following error message screen get
pops-up:
Figure 1.11
 Click OK and enter the correct “Database Information” and click Next button.

iv. OmniDocs 10.1 Installation Path screen appears.
v. Click Choose to select the location where you would like to install OmniDocs 10.1. Make sure there
is no space between the characters of the selected path.
vi. Alternatively, click Restore Default Folder to save OmniDocs 10.1 installation in default folder.
vii. Click Next.
Figure 1.12

viii. JBOSS/WildFly HOME Screen appears.
ix. Click Choose to select the location where JBoss-EAP 6.4 is located.
x. Click Next.
Figure 1.13

xi. JBoss/WildFly Port screen appears.
xii. Enter Port Details.
xiii. Click Next.
Figure 1.14

xiv. Choose Java Home Path screen appears.
xv. Click Choose to select the installation location of JDK.
xvi. Click Next.
Figure 1.15

xvii. Pre-Installation Summary screen appears. Review Pre-Installation Summary before continuing
installation procedure.
 Click Previous to go to the previous screen.
 Click Cancel to cancel the setup process.
xviii. Click Install to continue the installation process.
Figure 1.16

xix. Installing OmniDocs 10.1 screen appears. It displays the progress of the files being copied to the
installation folder.
Figure 1.17

xx. In between the installation process, “Start JBoss-EAP/WildFly Server” message appears.
xxi. Start JBoss-EAP 6.4 Server and click OK to close the message box.
Figure 1.18
xxii. “JBossEAP/WildFly Server Status” message box appears.

xxiii. Click YES to confirm that the application server has started.
Figure 1.19

xxiv. After all files are copied to the destination location, Install Complete screen appears.
xxv. Click Done.
Figure 1.20
xxvi. Installation is now complete.

b. When “Automatic Configuration Not Required” Is Selected
i. OmniDocs 10.1 Installation Path screen appears.
ii. Click Choose to select the location where you would like to install OmniDocs 10.1. Make sure there
iii. Alternatively, click Restore Default Folder to save OmniDocs 10.1 installation in default folder.
iv. Click Next.
Figure 1.21

v. JBOSS/WildFly HOME screen appears.
vi. Click Choose to select the location where JBoss-EAP 6.4 is located.
vii. Click Next.
Figure 1.22

viii. JBoss/WildFly Port screen appears.
ix. Enter Port Details.
x. Click Next.
Figure 1.23

xi. Choose Java Home Path screen appears.
xii. Click Choose to select the installation location of JDK.
xiii. Click Next.
Figure 1.24

xiv. Pre-Installation Summary screen appears. Review Pre-Installation Summary before continuing
xv. Click Install to continue the installation process.
Figure 1.25

xvi. Installing OmniDocs 10.1 screen appears. It displays the progress of the files being copied to the
Figure 1.26

xvii. After all files are copied to the destination location, Install Complete screen appears.
xviii. Click Done.
Figure 1.27
xix. Installation is now complete.
NOTE:
Create your cabinet manually from “OmniDocs Server Administration”. Follow the steps given in Chapter-2 of “OmniDocs
10.1 Server Administration Guide”.
Refer OmniDocs 10.1 User Manual and OmniDocs 10.1 Configuration Settings Guide for additional details on configuring
and using the application.
Refer OmniDocs 10.1 Post Deployment Guide.

2 OmniDocs 10.1 – Oracle WebLogic 12C

NOTE:
In case of WebLogic 12.2, JAVA-1.8 minimum is required.
 Operating System: Windows 7/Windows Server 2008/12

 Database:
 Application Server:
 Oracle WebLogic12C (installed using JDK 1.7 or above)
 Oracle WebLogic12.2 (installed using JDK 1.8 or above)
Guidelines for creating domain with other JDK:

1. At the time of creating domain there are two options for selecting JDK.
 Available JDKs (by default WebLogic JDK)
 Other JDK: In other JDK, we can select any other JDK (as we are giving JDK 1.7, select JDK
1.7_67 update and above).
2. Select Other JDK and click on Browse to select JDK path.

Figure 2.1

3. The selected path appears as shown:
Figure 2.2
NOTE:
In case of WebLogic 12.2, JAVA-1.8 minimum would be required.

2.2 OmniDocs 10.1 - Installation Steps
1. Right click on OmniDocs10.1.exe and select Run as Administrator.
Figure 2.3

4. Click Next.
Figure 2.4

7. Click Next.
Figure 2.5

10. Click Next.
Figure 2.6

12. Accept the terms of License Agreement and click Next to continue with the setup process.
Figure 2.7

14. Select Oracle WebLogic 12C Application Server.
15. Click Next.
Figure 2.8

18. Click Next.
Figure 2.9

19. Automated Configuration Screen appears.
Select Automated Configuration Required to automate the remaining installation process.
Select Automated Configuration Not Required.
21. Click Next.
Figure 2.10

a. When “Automatic Configuration Required” Is Selected

Figure 2.11

appears.
Figure 2.12
iv. If connection to the Database fails, Database Connection Failed screen appears:
Figure 2.13
v. Click OK.
 If connection to the Database fails, make corrections to the Database Information and click
Next.
 If Database connection is successful, next screen appears.

vi. OmniDocs 10.1 Installation Path screen appears.
vii. Click Choose to select the location where you would like to install OmniDocs 10.1. Make sure there
viii. Alternatively, click Restore Default Folder to save OmniDocs 10.1 installation in default folder.
ix. Click Next.
Figure 2.14

x. Specify WebLogic Path screen appears.
xi. Click Choose to select the location where WebLogic is installed.
xii. Click Next.
Figure 2.15

xiii. Specify WebLogic Domain Name screen appears.
xiv. Enter the WebLogic Domain Name.
xv. Click Next.
Figure 2.16

xvi. Specify WebLogic Domain Path screen appears.
xvii. Click Choose to select the WebLogic Domain Path.
xviii. Click Next.
Figure 2.17

xix. An instruction box to check Domain appears.
xx. If the Domain is created with jdk 1.7.0_55 or above JDK version, click Continue.
NOTE:
Figure 2.18

xxi. Get WebLogic Server User Name screen appears.
xxii. Enter the UserName.
xxiii. Click Next.
Figure 2.19

xxiv. Get WebLogic Server Password screen appears.
xxv. Enter the Password.
xxvi. Click Next.
Figure 2.20

xxvii. Set Target Server screen appears.
xxviii. Select AdminServer or ManagedServer option.
NOTE:
Select AdminServer option if you want to deploy OmniDocs 10.1 on standalone server. Select ManagedServer option if you
want to deploy OmniDocs 10.1 on Managed Server or on cluster environment.
Figure 2.21

a. If ManagedServer option is selected, you are required to specify the created ManagedServer
name.
b. Specify the Managed Server Name and click Next.
Figure 2.22
NOTE:
Here, the Installer can deploy the product components on any one Managed server, for rest of the Managed Servers; end
user needs to do the manual configuration.

xxix. WebLogic App Server Port screen appears.
a. If the Target Server was selected as AdminServer in the previous step:
 Enter the Port Details.
 Click Next.
Figure 2.23

b. If the Target Server was selected as ManagedServer in the previous step:
 Specify the Admin Server Port and Managed Server Port on which you wish to deploy the
product components.
 Click Next.
Figure 2.24

xxx. Choose Java Home Path screen appears.
xxxi. Click Choose to select the installation location of JDK.
xxxii. Click Next.
Figure 2.25

xxxiii. Pre-Installation Summary screen appears. Review Pre-Installation Summary before continuing
xxxiv. Click Install to continue the installation process.
Figure 2.26

xxxv. Installing OmniDocs 10.1 screen appears. It displays the progress of the files being copied to the
Figure 2.27

xxxvi. Start WebLogic 12C Server dialog box appears.
xxxvii. Start the WebLogic 12C Server.
xxxviii. Click OK.
Figure 2.28
xxxix. “WebLogic Server Status” dialog box appears.

xl. Click YES to confirm that the application server has started.
Figure 2.29

xli. After all files are copied to the destination location, Installation Completed screen appears.
xlii. Click Done.
Figure 2.30
xliii. Installation is now complete.

b. When “Automatic Configuration Not Require” Is Selected
iv. Click Next.
Figure 2.31

v. Specify WebLogic Path screen appears.
vi. Click Choose to select the location where WebLogic is installed.
vii. Click Next.
Figure 2.32

viii. Specify WebLogic Domain Name screen appears.
ix. Enter the WebLogic Domain Name.
x. Click Next.
Figure 2.33

xi. Specify WebLogic Domain Path screen appears.
xii. Click Choose to select the WebLogic Domain Path.
xiii. Click Next.
Figure 2.34

xiv. An instruction box to check Domain appears.
xv. If Domain is created with jdk 1.7.0_55 or above JDK version, click Continue.
NOTE:
Figure 2.35

xvi. Get WebLogic Server User Name screen appears.
xvii. Enter the UserName.
xviii. Click Next.
Figure 2.36

xix. Get WebLogic Server Password screen appears.
xx. Enter the Password.
xxi. Click Next.
Figure 2.37

xxii. Set Target Server screen appears.
xxiii. Select AdminServer or ManagedServer option.
NOTE:
Select AdminServer option if you want to deploy OmniDocs 10.1 on standalone server. Select ManagedServer option if you
want to deploy OmniDocs 10.1 on Managed Server or on cluster environment.
Figure 2.38

a. If ManagedServer option is selected, you are required to specify the created ManagedServer
name.
b. Specify the Managed Server Name and click Next.
Figure 2.39
NOTE:
Here, the Installer can deploy the product components on any one Managed server, for rest of the Managed Servers; end
user needs to do the manual configuration.

xxiv. WebLogic App Server Port screen appears.
a. If the Target Server was selected as AdminServer in the previous step:
 Enter the Port Details.
 Click Next.
Figure 2.40

b. If the Target Server was selected as ManagedServer in the previous step:
 Specify the Admin Server Port and Managed Server Port on which you wish to deploy the
product components.
 Click Next.
Figure 2.41

xxv. Choose Java Home Path screen appears.
xxvi. Click Choose to select the installation location of JDK.
xxvii. Click Next.
Figure 2.42

xxviii. Pre-Installation Summary screen appears. Review Pre-Installation Summary before continuing
xxix. Click Install to continue the installation process.
Figure 2.43

xxx. Installing OmniDocs 10.1 screen appears. It displays the progress of the files being copied to the
Figure 2.44

xxxi. Start WebLogic 12C Server dialog box appears.
xxxii. Start WebLogic 12C Server.
xxxiii. Click OK.
Figure 2.45
xxxiv. “WebLogic Server Status” dialog box appears.

xxxv. Click YES to confirm that the application server has started.
Figure 2.46

xxxvi. After all files are copied to the destination location, Install Complete screen appears.
xxxvii. Click Done.
Figure 2.47
xxxviii. Installation is now complete.
NOTE:
10.1 Administration Manual”.
Refer OmniDocs 10.1 Reference Manual and OmniDocs 10.1 Configuration Settings Guide for additional details on
configuring and using the application.

3 OmniDocs 10.1 – IBM WebSphere 8.x/9.x

NOTE:
In case of WebSphere 9.x, JAVA-1.8 minimum is required.
 Operating System: Windows 7/Windows Server 2008/12.

 Database:
 Application Server:
 IBM WebSphere 8.x (installed using JDK 1.7 or above)
 IBM WebSphere 9.x (installed using JDK 1.8 or above)

3.2 WebSphere Settings for Secure Profile
Follow the below steps to do WebSphere settings for secure profile:
1. If WebSphere profile is secure Please Log into the IBM WebSphere Application Server Integrated
Solutions Console.
Figure 3.1
2. Open WAS Admin Console.

3. Click on Servers and expand Server Types.
4. Click on WebSphere application servers.
5. Click on Server1.

Figure 3.2
6. Configuration screen to configure the selected application server appears.
Figure 3.3

7. Navigate to Servers >Application servers > server1 > Ports.
Figure 3.4
8. The following screen appears.
Figure 3.5

9. Change Default values of Port Names to, as given below
Port Name New Port
ORB_LISTENER_ADDRESS 0
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS 0
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS 0
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS 0
10. Save the changes made.
Figure 3.6

11. Expand the tab Security tab in the left-pane of the Administration Console.
12. Click on Global Security.
Figure 3.7
13. Click on RMI/IIOP security option
Figure 3.8

14. Click on Transport and select SSL Supported option for both CSIv2 inbound communications, CSIv2
outbound communications.
Figure 3.9
15. Save the changes made.
Figure 3.10
16. Restart WebSphere Application Server.

3.3 OmniDocs 10.1- Installation Steps
NOTE:
Before initiating the installation process, carry out the following given steps:
a. Go to WebSphere Application Server's profile.
b. Go to properties folder in WebSphere Application Server's profile.
c. Edit soap.client.props in text editor and do the below changes:
d. Search for com.ibm.SOAP.requestTimeout=180 and change value from 180 to 1000.
e. Save property file and restart WebSphere Application Server and start installation process
NOTE:
Refer to WebSphere Configuration for HCP and Amazon Sites of OmniDocs 10.1 Configuration Settings Guide to configure
WebSphere Application Server (WAS) for HCP and Amazon sites.

1. Right click on OmniDocs10.1.exe and select Run as Administrator.
Figure 3.11

4. Click Next.
Figure 3.12

7. Click Next.
Figure 3.13

10. Click Next.
Figure 3.14

Figure 3.15

14. Select IBM WebSphere 8.x/9.x Application Server.
15. Click Next.
Figure 3.16

18. Click Next.
Figure 3.17

21. Click Next.
Figure 3.18


Figure 3.19

iii. If connection to the Database is established successfully, Data-base Connection Success dialog box
appears.
Figure 3.20
 If the specified “Database Information” is incorrect, Database Connection Failed dialog box
appears.
Figure 3.21

vii. Click Next.
Figure 3.22

viii. Choose WebSphere Path screen appears.
ix. Click Choose to select the location where WebSphere is installed.
x. Click Next.
Figure 3.23

xi. WebSphere Profile Details screen appears.
xii. Enter the WebSphere Profile Name.
xiii. Click Choose to select the WebSphere Profile Path.
xiv. Enter User ID and Password if Secure Profile check box is selected.
xv. Click Next.
Figure 3.24

xvi. WebSphere App Server Port screen appears.
xvii. Enter the Port Details.
xviii. Click Next.
Figure 3.25

xix. Choose Java Home Path screen appears.
xx. Click Choose to select the installation location of JDK.
xxi. Click Next.
Figure 3.26

xxii. Pre-Installation Summary screen appears. Review Pre-Installation Summary before continuing
xxiii. Click Install to continue the installation process.
Figure 3.27

xxiv. Installing OmniDocs 10.1 screen appears. It displays the progress of the files being copied to the
Figure 3.28

xxv. Start WebSphere Application Server dialog box appears.
xxvi. Start WebSphere Application Server.
xxvii. Click OK.
Figure 3.29
xxviii. “WebSphere Server Status” dialog box appears.

xxix. Click YES to confirm that the application server has started.
Figure 3.30

xxx. Installation Complete screen appears once all files are copied to the destination location.
xxxi. Click Done.
Figure 3.31
xxxii. Installation is now complete.

iv. Click Next.
Figure 3.32

v. Choose WebSphere Path screen appears.
vi. Click Choose to select the location where WebSphere is installed.
vii. Click Next.
Figure 3.33

viii. WebSphere Profile Details screen appears.
ix. Enter the WebSphere Profile Name.
x. Click Choose to select the WebSphere Profile Path.
xi. Enter User ID and Password if Secure Profile check box is selected.
xii. Click Next.
Figure 3.34

xiii. WebSphere App Server Port screen appears.
xiv. Enter the Port Details.
xv. Click Next.
Figure 3.35

xvi. Choose Java Home Path screen appears.
xvii. Click Choose to select the installation location of JDK.
xviii. Click Next.
Figure 3.36

xix. Pre-Installation Summary screen appears. Review Pre-Installation Summary before continuing
xx. Click Install to continue the installation process.
Figure 3.37

xxi. Installing OmniDocs 10.1 screen appears. It displays the progress of the files being copied to the
Figure 3.38

xxii. Start WebSphere Application Server dialog box appears.
xxiii. Start WebSphere Application Server.
xxiv. Click OK.
Figure 3.39
xxv. “WebSphere Server Status” dialog box appears.

xxvi. Click YES to confirm that the application server has started.
Figure 3.40

xxvii. Installation Complete screen appears once all files are copied to the destination location.
xxviii. Click Done.
Figure 3.41
xxix. Installation is now complete.
NOTE:

3.4 Data Source Creation
1. Open the Administration Console and expand the Resources->JDBC->JDBC Providers tab in the left-
pane of the Administration screen.
Figure 3.42

2. Select the Scope as Server1. The list of existing providers will appear. Click New Button to create a
new JDBC Provider.
3. In choose a type of JDBC provider to create, Set the Configuration as
a. Select the database type as “SQL Server”.
b. Select the provider type as “Microsoft SQL Server JDBC Driver”.
c. Select the implementation type as “Connection pool data source”.
4. Click Next.
Figure 3.43

5. In the “Enter Database Class-path information” screen for the new JDBC provider ensure the
following:
Set directory location for MSSQL driver, (sqljdbc41.jar) copied to:
WAS_Home/profiles/<WAS_Profile>/OmniDocs_library folder
Figure 3.44

6. Click Finish on “Create a new JDBC Provider” Screen.
Figure 3.45

7. Click Save link to save workspace changes to the Master Configuration and expand Resources-
>JDBC->JDBC Providers tab in the left-pane of Administration screen.
Figure 3.46

8. Click on JDBC Provider name link.
Figure 3.47

9. Click Data Sources link listed in the Additional Properties section.
Figure 3.48

10. Click on New to create a new data source.
Figure 3.49

11. Specify the following properties for the Data Source.
 Name: Same as OmniDocs Cabinet Name.
 JNDI Name: jdbc/OmniDocs Cabinet Name.
12. Click OK.
Figure 3.50

13. In Specific Properties for the DataSource Screen.
 Database Name: Same as OmniDocs Cabinet Name
 Server Name: IP/ HostName of the machine where SQL Server is installed
 Port No: Port at which SQL server listens. Default is 1433.
Figure 3.51

14. Click Finish on ‘Summary’ Screen of Data Source.
Figure 3.52

15. Click Save link, and save workspace changes to the Master Configuration.
Figure 3.53

16. Click on the newly created Data Source. Click Custom Properties link in the Additional Properties
pane. Add following Custom properties for the data source:
 User: SQL Server User Name
 Password: SQL Server User’s password
Figure 3.54
17. Click Save link, and save workspace changes to the Master Configuration.
NOTE
To know in detail about cabinet creation refer to Chapter 2 “OmniDocs Service Administration” module of OmniDocs
Server Reference Manual.

3.5 OmniDocs Configuration for Session Management
1. Open the Administration Console, by typing the following URL in the address bar of the browser.
http://IP-Address of the WebSphere Application Server Machine: <WC_adminhost end
point>/admin
2. Expand Applications tab in the left-pane of the Administration Console and click Enterprise
Application Link. Click on the link for “OmniDocs” Application. The Configuration screen for
“OmniDocs” appears.
3. Click on Session Management under Web Module Properties.
Figure 3.55

4. Check Override session management checkbox.
Figure 3.56

5. Click on Enable Cookies link under general properties:
Figure 3.57

6. Make JSESSIONID text in small case and uncheck “Set Session cookies to HTTP Only to help prevent
cross-site scripting attacks” option and click OK.
Figure 3.58

7. Save the changes in Master Configurations.
Figure 3.59
8. Stop and Start OmniDocs application.

3.6 OpAll Configuration for Session Management
1. Open the Administration Console, by typing the following URL in the address bar of the browser:
http://IP-Address of the WebSphere Application Server Machine: <WC_adminhost end
point>/admin.
2. Expand Applications tab in the left-pane of the Administration Console and click Enterprise
Application Link. Click on the link for “OpAll” Application. The Configuration screen for “OpAll”
appears.
3. Click on Session Management under Web Module Properties.
Figure 3.60

4. Mark Override session management checkbox.
Figure 3.61
5. Click on Enable Cookies link under general properties:
Figure 3.62

6. Make JSESSIONID text in small case and uncheck “Set session cookies to HTTPOnly to help prevent
cross-site scripting attacks” option and click OK.
Figure 3.63
7. Save the changes in Master Configurations
Figure 3.64

8. Stop and Start OpAll application.
Figure 3.65

4 OmniDocs 10.1 – WildFly 11.0.0 Final

 JDK Version: JDK and JRE 1.8 (or above) should be installed on machine.
 OPERATING SYSTEM: Windows 7/Windows Server 2008/12.
 Database:
 Application Server: Red Hat WildFly 11.0.0 Final

4.2 OmniDocs 10.1 – Installation Steps

Figure 4.1

4. Click Next.
Figure 4.2

7. Click Next.
Figure 4.3

10. Click Next.
Figure 4.4

Figure 4.5

13. Application Server Screen appears.
14. Select Red Hat WildFly 11.0.0 Final Application Server.
15. Click Next.
Figure 4.6

18. Click Next.
Figure 4.7

21. Click Next.
Figure 4.8


Figure 4.9

appears.
Figure 4.10
 If the specified “Database Information” is incorrect, Database Connection Failed dialog box
appears.
Figure 4.11

vii. Click Next.
Figure 4.12

viii. JBOSS/WildFly Home screen appears.
ix. Click Choose to select the location where WildFly is located.
x. Click Next.
Figure 4.13

xi. JBoss/WildFly Port screen appears.
xii. Enter WildFly port number in Port Details text box.
xiii. Click Next.
Figure 4.14

xvi. Click Next.
Figure 4.15

Figure 4.16

Figure 4.17

xx. In between the installation process, “Start Jboss-EAP/WildFly Server” message appears.
xxi. Start WildFly Server and click OK to close the message box.
Figure 4.18
xxii. “JBossEAP/WildFly Server Status” message box appears.

xxiii. Click YES to confirm that the application server has started.
Figure 4.19

xxiv. After all files are copied to the destination location, Install Complete screen appears.
xxv. Click Done.
Figure 4.20
xxvi. Installation is now complete.

ii. Click Choose to select the location where you would like to install OmniDocs 10.1. Make sure
there is no space between the characters of the selected path.
iv. Click Next.
Figure 4.21

v. JBOSS/WildFly HOME screen appears.
vi. Click Choose to select the location where WildFly is installed.
vii. Click Next.
Figure 4.22

x. Click Next.
Figure 4.23

xii. Click Choose to select the installation location of JDK.
xiii. Click Next.
Figure 4.24

Figure 4.25

Figure 4.26

xviii. Click Done.
Figure 4.27
NOTE:

5 OmniDocs 10.1 – JBOSS EAP 7.x

 JDK Version: JDK and JRE 1.8 (or above) should be installed on machine.
 Operating System: Windows 7/Windows Server 2008/12.
 Database:
 Microsoft SQL Server Microsoft Azure
 Application Server: Red Hat JBoss EAP 7.x

5.2 OmniDocs 10.1 – Installation Steps

Figure 5.1

4. Click Next.
Figure 5.2

7. Click Next.
Figure 5.3

10. Click Next.
Figure 5.4

12. Accept the terms of License Agreement and click Next to continue with the setup process.
Figure 5.5

14. Select Red Hat JBOSS EAP 7.x Application Server.
15. Click Next.
Figure 5.6

18. Click Next.
Figure 5.7

21. Click Next.
Figure 5.8

a. When “Automatic Configuration Required” Is Selected

Figure 5.9

iii. If connection to the Database is established successfully, Database Connection Success dialog box
appears.
Figure 5.10
If the specified “Database Information” is incorrect, Database Connection Failed dialog box
appears.
Figure 5.11
In case of failure, click OK and enter the correct “Database Information” and then click Next.

vii. Click Next.
Figure 5.12

viii. JBOSS/WildFly HOME screen appears.
ix. Click Choose to select the location where JBOSS 7.x is located.
x. Click Next.
Figure 5.13

xi. JBOSS/WildFly Port screen appears.
xii. Enter Port Details.
xiii. Click Next.
Figure 5.14

xvi. Click Next.
Figure 5.15

Figure 5.16

Figure 5.17

xx. In between the installation process, “Start JBOSS EAP/WildFly Server” message appears.
xxi. This message asks user to start JBOSS EAP Server to continue deployment process.
xxii. Start JBOSS 7 Server.
xxiii. Click OK.
Figure 5.18
xxiv. “JBOSSEAP/WildFly Server Status” message box appears.

xxv. Click YES to confirm that the application server has started.
Figure 5.19

xxvi. After all files are copied to the destination location, Install Complete screen appears.
xxvii. Click Done.
Figure 5.20
xxviii. Installation is now complete.

iv. Click Next.
Figure 5.21

v. JBOSS/WildFly Home screen appears.
vi. Click Choose to select the location where JBOSS 7 is located.
vii. Click Next.
Figure 5.22

x. Click Next.
Figure 5.23

xii. Click Choose, to select the installation location of JDK.
xiii. Click Next.
Figure 5.24

Figure 5.25

Figure 5.26

xviii. Click Done.
Figure 5.27
NOTE:
10.1 Service Administration Guide”.

Refer OmniDocs 10.1 Reference Manual and OmniDocs 10.1 Configuration Settings Guide for additional details on
configuring and using the application.

6 OmniDocs 10.1 – Upgrade Steps – MSSQL
6.1 OmniDocs 10.1 – Upgrade Steps

To upgrade OmniDocs 10.1 in SQL Database Server, follow the given steps:
1. Start your Application Server.
2. Start Wrapper.
3. Start OSA (OmniDocs Service Administrator)
a. To start it, visit the OSA folder present in the installed location of OmniDocs 10.1 and click on
RunAdmin.bat file.
4. OmniDocs Service Administrator starts.
Figure 6.1

5. Enter the Login Password and click OK.
Figure 6.2

6. On successful login, the screen appears as:
Figure 6.3

7. Click on Register.
8. Register New Server screen appears.
a. Select the Server Type.
b. Provide IP Address.
c. Enter the Admin Port number.
d. Click OK.
Figure 6.4

9. The screen appears with “Registration successful” status as:
Figure 6.5

10. Select the “Server Type” and click on Connect.
11. Connection with the Server Type starts and displays Connection successful status.
Figure 6.6

12. Click on Manage button.
Figure 6.7

13. Select the Server Type from the left panel.
14. Click on Stop to stop the Server Type.
Figure 6.8

15. Click on Associate to associate the cabinet.
Figure 6.9

16. To associate the cabinet, select the Database Type and then click on Next.
Figure 6.10

17. Under Cabinet Properties tab,
a. Specify the new Cabinet Name.
b. Provide the Database Server Name where the cabinet exists.
c. Specify the Database User Name for accessing the specified cabinet.
d. Specify the Database Password for accessing the specified cabinet.
e. Click Next.
Figure 6.11

18. Under Connection tab,
a. Specify the Maximum number of database connection that can be made available to the
cabinet.
b. Specify the Minimum number of database connection that can be made available to the
cabinet.
c. Specify the Query Timeout period (in seconds) for this cabinet.
d. Specify the Refresh Interval period (in minutes) for this cabinet.
e. Click Done.
Figure 6.12

19. Select the Cabinet and click on UpgradeCabinet button.
Figure 6.13

20. A confirmation message appears to upgrade the selected cabinet.
Figure 6.14

21. Click Yes to continue the upgrade.
22. The Upgrade Cabinet successful appears.
Figure 6.15

7 OmniDocs 10.1 – Upgrade Steps – Oracle
To upgrade OmniDocs 10.1 in Oracle Database Server, follow the given steps:
2. Start Wrapper.
 To start it, visit the OSA folder present in the installed location of OmniDocs 10.1 and click on
RunAdmin.bat file.
Figure 7.1

Figure 7.2

Figure 7.3

 Select the Server Type.
 Provide IP Address.
 Enter the Admin Port number.
 Click OK.
Figure 7.4

9. The screen appears with Registration successful status as:
Figure 7.5

10. Select the Server Type and click on Connect.
Figure 7.6

Figure 7.7

Figure 7.8

Figure 7.9

16. Under Database tab,
a. Select the Database Type
b. Provide the Port Number.
c. Specify the Service Name.
d. Click on Next.
Figure 7.10

b. Provide the Database Server IP where the cabinet exists.
c. Specify the Database User Name for accessing the specified cabinet (same as Cabinet Name).
d. Specify the Database Password for accessing the specified cabinet (same as Cabinet Name).
e. Click Next.
Figure 7.11

cabinet.
cabinet.
e. Click Done.
Figure 7.12

Figure 7.13

Figure 7.14

Figure 7.15

8 OmniDocs 10.1 – Upgrade Steps - PostgreSQL

To upgrade OmniDocs 10.1 in PostgreSQL Database server, follow the given steps:
2. Start Wrapper.
a. To start it, visit the OSA folder present in the installed location of OmniDocs 10.1 and click on
RunAdmin.bat file.
Figure 8.1

Figure 8.2

Figure 8.3

a. Select the Server Type.
b. Provide IP Address.
c. Enter the Admin Port number.
d. Click OK.
Figure 8.4

9. The screen appears with Registration successful status as:
Figure 8.5

10. Select the Server Type and click on Connect.
Figure 8.6

Figure 8.7

Figure 8.8

Figure 8.9

16. Under the Database Tab,
a. Select the Database Type.
b. Provide the Port Number.
c. Click on Next.
Figure 8.10

b. Provide the Database Server IP where the cabinet exists.
c. Specify the Database User Name for accessing the specified cabinet.
d. Specify the Database Password for accessing the specified cabinet.
e. Click Next.
Figure 8.11

cabinet.
cabinet.
e. Click Done.
Figure 8.12

Figure 8.13

Figure 8.14

Figure 8.15

9 Web API
NOTE:
This Web API – Upgrade is applicable for all the OmniDocs 10.1 supported application servers.
To upgrade Web API, carry out the following steps:-

1. Access the following location in existing application server:-
Application server root path\bin\ngdbini\odwebini\
2. Copy following 2 files present in the opened location:-
 ApplicationConfiguration.xml
 Criteria.xml
3. Paste both the copied file in the below given location of the new application server.
Application server root path\bin\ngdbini\odwebini\

OmniDocs 10.1 Installation Guide - Windows

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

OmniDocs 10.1 Installation Guide - Windows

Uploaded by

Copyright:

Available Formats

OMNIDOCS 10.

Newgen Software Technologies Ltd

Newgen Software Technologies Limited,

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 2

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 3

1.1 Pre-requisites for Fresh Installation

 Application Server: Red Hat JBoss-EAP 6.4

1.2 OmniDocs 10.1– Installation Steps

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 4

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 5

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 6

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 7

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 8

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 9

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 10

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 11

Database Server IP(For All Databases) IP Address of the Database Server

ii. Once all the details are entered, click Next.

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 12

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 13

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 14

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 15

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 16

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 17

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 18

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 19

xxii. “JBossEAP/WildFly Server Status” message box appears.

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 20

xxvi. Installation is now complete.

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 21

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 22

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 23

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 24

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 25

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 26

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 27

xix. Installation is now complete.

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 28

2.1 Pre-requisites for Fresh Installation

 Operating System: Windows 7/Windows Server 2008/12

Guidelines for creating domain with other JDK:

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 29

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 30

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 31

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 32

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 33

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 34

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 35

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 36

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 37

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 38

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 39

Database Server IP(For All Databases) IP Address of the Database Server

ii. Once all the details are entered, click Next.

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 40

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 41

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 42

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 43

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 44

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 45

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 46

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 47

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 48

Newgen OmniDocs 10.1 – Installation Guide on Windows Page 49