FinnOne Connect

FinnOne Connect 1.0

PD-DEV-NCCM-JP-FLGR-0510-T

Installation Manual
Version No.:1.0
 2006 Nucleus Software Exports Ltd. All rights reserved.

No part of this document may be reproduced or transmitted in any form or by any means,
electronic or otherwise, including photocopying, reprinting, or recording, for any purpose, without
the express written permission of Nucleus Software Exports Ltd.

TRADEMARKS

The names of all other company, brand, product or service names mentioned herein are the
trademarks or registered trademarks of their respective owners.

First Release: 02/2006

Nucleus Software Exports Limited

33-35, Thyagraj Nagar Market,
New Delhi-110 003,
India.
Tel: +91-11-24627552
Fax: +91-11-24620872
E-mail: bdg@nucleussoftware.com
Visit us at: http://www.nucleussoftware.com
Contents

1 Introduction ...................................................................................................................... .........1

1.1 Purpose............................................................................................................. ...................1
1.2 Target Audience........................................................................................................ ............1
1.3 Document Structure........................................................................................................ ......1
1.4 Terms and Conventions......................................................................................... ...............2
1.5 Acronyms and Abbreviations...................................................................... ..........................2
2 Prerequisites............................................................................................................... ...............4
2.1 Hardware Details................................................................................................. .................4
2.2 Software Details....................................................................................... ............................4
2.3 Additional Details................................................................................................. .................5
3 Installation and Deployment...................................................................................... ...............6
3.1 Pre Installation Checks / Preparations........................................................................... .......6
3.2 Installation Procedures - Database................................................................................. ......6
Installation Procedures - Application..................................................................................... .....8
3.3 Post Installation Checks............................................................................ .........................24
3.4 Troubleshooting................................................................................................. .................25

i
 Chapter

1
1 Introduction

The product “FinnOne Connect” is a generic interface which is used to serve as an

information/data exchange between any front end system like Loan Origination/Booking system
where a loan would be applied and “FinnOne” would validate and process the applied loan. The
request data (input) to the Interface and the response which is given back to the front end
system are in XML format which are validated and parsed using FinnOne registered XSD
(schemas).

urpose
The purpose of this document is to provide details of the installation and deployment process of
the application and all the related dependencies.

rget Audience
This manual is intended for the following users:

• Programmers
• Database Administrators
• Data Centre Personnel

ocument Structure
The information in this document is organized for optimum dissemination. This segment explains
how information is distributed in this document, and presents some cues and examples to simplify
finding and understanding information in this document. Table -1 presents an overview of the
chapters in this document.

1
 Table -1: Chapter Overview

# Chapter
1 Introduction
2 Prerequisites
3 Installation
Contents
Introduces FinnOne Connect; defines the purpose, scope,
and intended audience of this document; explains how
information is organized in this document
Lists the hardware, software, and additional prerequisites for
successful installation.
Describes the installation procedure along with pre- and
post-installation checks.

rms and Conventions

This document uses special terms and typographical conventions to help in the identification of
various information types in this document. These cues are designed to simplify the searching
and understanding the information this document contains.

Table 1-2: Conventions Used in The Manual

Convention Usage Example

Boldface Menu options and commands GUI Select Operations > Batch
labels Click OK button
Italics References Refer Figure 1.1
Courier System-generated message Choose another folder
Courier Bold Command line you must enter Run CMD
Title Caps Names of Accessory programs HP OpenView
Names of chapter headings See Chapter 3: Starting Up
[1] Serial number of a book in Look up Chapter 2: System
the order of appearance in Architecture
the References topic in [1]

 Notes. These topics convey

additional information on an
associated topic.
Important:

cronyms and Abbreviations

Please note the acronyms and abbreviations, and their explanations provided in Table 1-3.
They are used in many fundamental definitions and explanations in this document, and are
specific to the information this document contains.

2 © Nucleus Software Exports Limited

 Table 1-3: Acronyms and Abbreviations Used in This Manual

Acronym Explanation
NSEL Nucleus Software Exports Limited
TAT Turn Around Time
XML Extensible Markup Language
XSD Extensible Schema Document
JDK Java Developer Kit
OS Operating System
WAR Web Archive – comprises of the application’s deployable Java
classes
SP Stored Procedure
HTTP Hyper Text Transfer Protocol

3
 Chapter

2
2 Prerequisites
The prerequisites for successfully deploying the application would be to ensure the proper
installation of the following versioned software.

ardware Details

FinnOne™
FinnOne Environment
SIT UAT Production
Database Server Database Server Database Server
HP DL 380 HP DL 380 HP DL 380
Dual CPU Dual CPU Dual CPU
4GB RAM 4GB RAM 4GB RAM
336 GB HDD 336 GB HDD 336 GB HDD

Red Hat Linux Enterprise 3 Red Hat Linux Enterprise 3 Red Hat Linux Enterprise 3

Application Server Application Server Application Server

HP DL 380 HP DL 380 HP DL 380

Dual CPU Dual CPU Dual CPU
4GB RAM 4GB RAM 4GB RAM
200 GB HDD 200 GB HDD 200 GB HDD

Red Hat Linux Enterprise 4 Red Hat Linux Enterprise 4 Red Hat Linux Enterprise 4

©2005, Nucleus Software; All rights reserved 2

CONFIDENTIAL

oftware Details
The required software for the Interface is as follows:

4
 • Java 2 Platform Standard Edition(JDK) 1.5.0

• Application Server - jboss-4.0.2

• Application Server Operating System - Red Hat Enterprise Linux ES release 4 (Nahant
Update 2)

• Database Server - Oracle9i Enterprise Edition Release 9.2.0.4.0

• Database Server Operating System - Red Hat Enterprise Linux ES release 3

dditional Details
In case of installing the Interface application from a remote machine on a Linux server the
following software are required:

 Putty software

Putty software can be downloaded for free from the below link:

http://www.download.com/PuTTY/3000-11138_4-10500630.html

 SSH Secure File Transfer Client

SSH client for Windows can be downloaded from the below link too:

http://www.ssh.com/support/downloads/secureshellwks/

5
 Chapter

3
Installation and Deployment

e Installation Checks / Preparations

1. Kindly take the latest version of the FinnOneConnect folder from CVS and move it to C:\
folder.
2. Install Putty software and SSH client from the machine from where the installation is
going to be made to the Linux server. (Required for Linux OS)

3. It is assumed that installation is being done from remote Windows PC. Access to Linux
server will be through Putty Software.

stallation Procedures - Database

Please follow the below steps for Database setup:

1. Creation of tablespace, users and grants

a. Open Oracle SQL Plus with a DBA user.

b. Run the following script

@C:\FinnConnect\DBScripts\SetUpScripts\User_Create.sql;

2. Creation of Objects

a. Open Oracle SQL Plus with a Finnapi user

b. Run the following script

@C:\FinnConnect\DBScripts\SetUpScripts\FinnOneConnect_wrapper.sql;
 Note: For the “DataRequestXSD” parameter, give the Schema Id which pertains to the
Transaction Request Schema of the FINAPI_ONLINE_XSD_MASTER table.

For “Output_File_Path” parameter, give the folder path where the files need to be
cached or ideally to the datacache folder specified in point 5 of Application Installation.
It varies for Windows and Linux environments accordingly.

The Module_id parameter should be the same as that of the Module Id in

FINAPI_SUPPORTED_PROD_MODULES table.

3. Registration of XSD

a. Open Oracle SQL Plus with a Finnapi user

b. Run the following script

@C:\FinnConnect\DBScripts\SetUpScripts\Register_schemas.sql;

Problems may occur during this step upon registering a XSD (schema) which includes an
unregistered XSD. In such circumstances please register the included XSD first and then
register the XSD including it. In case any undefined error, please contact Nucleus support
person.

4. Creation of XMLTYPE temporary tables, Setup scripts, triggers etc

a. Open Oracle SQL Plus with a Finnapi user.

b. Run the following scripts:

@C:\FinnConnect\DBScripts\SetUpScripts\xmltype_tempTablescr.sql;
@C:\FinnConnect\DBScripts\SetUpScripts\insert_inquiry_xsd_master.sql;
Note: For the above script the “SchemaFilePath” parameter should be the folder path
where the XSDs are placed in the deployable WAR (FinnoneConnect.war).

@C:\FinnConnect\DBScripts\SetUpScripts\insert_inquiry_txn_master.sql;
Note: For the “DataRequestXSD” parameter, give the Schema Id which pertains to the
Transaction Request Schema of the FINAPI_ONLINE_XSD_MASTER table.

@C:\FinnConnect\DBScripts\SetUpScripts\trigger_grant.sql;
@C:\FinnConnect\DBScripts\SetUpScripts\Inquiry_trigger_wrapper.sql;

These scripts need to be run sequentially without errors. In case any error, please stop and
contact Nucleus support person.

5. Please check whether all the objects are compiled.

7
 Installation Procedures - Application

For Windows OS:

1. Login as administrator and unzip the file jboss-4.0.2.zip into a target folder C:\jboss-
4.0.2. This software can be downloaded

2. Set the “JAVA_HOME “, System Variable, under Environment Variables as the root folder
of JDK 1.5.0.This can be done by,

 Click on the “Start” button

 Move to “My Computer” and right click on it and click “Properties”

 In “Properties” go to the “Advanced” tab and click on the “Environment Variables”

button

 Now create a new “System Variable” and give the “Variable name” as “JAVA_HOME”
and the “Variable value” should be the path where jdk1.5 is installed on the machine.
For example: C:\Program Files\Java\jdk1.5.0_05

3. Open the command prompt and go to the path “C:\jboss-4.0.2\bin” and execute the
“run.bat” file to start JBOSS.

8 © Nucleus Software Exports Limited

4. Proper start up is validated upon getting the index page when the http://IP:port URL is
run on the browser. The IP address and the Port would pertain to the server IP address
and the port where the WAR file is deployed.

5. Create four new folders under log, datacache, datapump and logbackup under C:\jboss-
4.0.2.

9
 6. Now put the FinnoneConnect.war (WAR folder in CVS) file under the path “C:\jboss-
4.0.2\server\default\deploy”.

10 © Nucleus Software Exports Limited

7. The folder structure of the FinnoneConnect.war file would be as follows:

11
The WAR file basically contains:

• css folder

• img folder

• js folder

• WEB-INF folder

• xsd folder

• JSPs

• HTMLs

The WEB-INF folder in turn contains the following:

• classes folder (Java class files)

• lib folder containing - classes12.jar, runtime.jar, translator.zip, xdb.jar, xerces.jar,

xmlparserv2.jar

• web.xml

8. Now to deploy the Logging Bean, put nucleus.jar (WAR folder in CVS), executable jar in
“C:\ jboss-4.0.2\server\default\deploy” path and classes12.jar under “C:\ jboss-
4.0.2\server\default\lib” path.

9. Put the following entries in the jbossmq-destinations-service.xml under the C:\jboss-

4.0.2\server\default\deploy\jms path.

<mbean code="org.jboss.mq.server.jmx.Queue"

name="jboss.mq.destination:service=Queue,name=FinnOneConnectAsynchronousTransacti
onLogQueue">

<depends optional-attribute-
name="DestinationManager">jboss.mq:service=DestinationManager</depends>

<depends optional-attribute-
name="SecurityManager">jboss.mq:service=SecurityManager</depends>

<attribute name="MessageCounterHistoryDayLimit">-1</attribute>

<attribute name="SecurityConf">

<security>

12 © Nucleus Software Exports Limited

 <role name="guest" read="true" write="true"/>

<role name="publisher" read="true" write="true" create="false"/>

<role name="noacc" read="false" write="false" create="false"/>

</security>

</attribute>

</mbean>

<mbean code="org.jboss.mq.server.jmx.Queue"

name="jboss.mq.destination:service=Queue,name=FinnOneConnectAsynchronousApplicatio
nLogQueue">

<depends optional-attribute-
name="DestinationManager">jboss.mq:service=DestinationManager</depends>

<depends optional-attribute-
name="SecurityManager">jboss.mq:service=SecurityManager</depends>

<attribute name="MessageCounterHistoryDayLimit">-1</attribute>

<attribute name="SecurityConf">

<security>

<role name="guest" read="true" write="true"/>

<role name="publisher" read="true" write="true" create="false"/>

<role name="noacc" read="false" write="false" create="false"/>

</security>

</attribute>

</mbean>

13
 10. Now put pumpdata.bat, xmlparserv2.jar, j2ee.jar, runtime.jar, log4j-1.2.13.jar
(Utilities\Windows folder in CVS) under the C:\jboss-4.0.2\datapump path.

Note: Make sure that all the jars given in the shell script are in the specified paths.

11. Run the “pumpdata.bat” under the C:\jboss-4.0.2\datapump to cache the master data
files in the path specified (While running the Database script). Alternatively path can be
seen in “OUTPUT_FILE_PATH” column in the FINAPI_ONLINE_MASTER_INTERFACE
table.

12. After all the Master XMLs have been cached, start the JBOSS application server by
executing “run.bat “ to deploy the WAR file and the server log upon completion of proper
deployment would be similar to the below screen shot:

14 © Nucleus Software Exports Limited

Make sure at this point that the Queues are “bound”, the nucleus.jar and FinnoneConnect.war
are deployed without any errors.

13. Now run the SecurityXML.html by modifying the IP address accordingly in the html. Upon
running it, an entry would be inserted in FINNAPI_SEC_MODULE_SESSION table. Use
the values in this table i.e. SESSION_ID and MODULE_ID values for tags
<externalsystemid> and <sessionid> in the testing Master and Transaction HTMLs in the
next step.

15
 C:\
SecurityXML.html

14. Now invoke the application using the attached test html simulators. Modify the values of
IP, Port and <masterid> / <transactionid> Tags accordingly to check for the response in
case of master request html and inquiry html respectively.

Master

C:\Documents and
Settings\Administrator\Desktop\MasterXML.htm

Transaction

C:\ InquiryXML.html

The response for the request might be similar to the below screenshot.

16 © Nucleus Software Exports Limited

15. In a circumstance when several instances of the JBOSS are running on the same server
errors might occur due to port clashes. In such a case change the HTTP port in
server.xml in “C:\jboss-4.0.2\server\default\deploy\jbossweb-tomcat55.sar” path and use
this port to invoke the servlet.

17
 16. Also change the ports under Class loading, JNDI (listening and the RMIPort), Invokers to
the JMX node (RMIObjectPort, ServerBindPort) in jboss-service.xml under “C:\jboss-
4.0.2\server\default\conf” path.

17. Upon altering the xml files restart JBOSS (By running the run.bat, as mentioned above)
and check the application by invoking through HTML simulator as mentioned above.

Note: Changes need to be made in application.properties file under the folder structure

(\src\nucleus\core\applicationparameters)

related to Database Configuration Settings. Making sure that all the changes made are

pointing to correct database, after changes been made, prepare a

new nucleus.jar file which contains the changed imformation and make sure to

deploy the same jar file in the JBOSS Server, and place the changed

application.properties file in FinnoneConnect.war under WEB-INF folder

(\classes\nucleus\core\applicationparameters)

18 © Nucleus Software Exports Limited

For Linux OS:

1. Ask the Administrator to create a user under the /home directory as /home/<user name> on
the Application server.

2. Put the jboss-4.0.2.tar.gz file in this directory. (This software can be easily downloaded)

3. Extract the file using the following command on the command prompt

Extract gunzip < jboss-4.0.2.tar.gz | tar xvf –

4. After extracting the file go to path “/home/<user name>/jboss-4.0.2/bin” and run the run.sh
script.

5. Proper startup of JBOSS is validated by getting the JBOSS index page upon running the
URL http://ServerIP:Port.

19
 6. Now create four new folders log, datapump, datacache and logbackup under the path
“/home/<username>” using “mkdir <folder name>”.

7. Put the FinnoneConnect.war file and “nucleus.jar” (from WAR folder in CVS) under the
path “/home/<username>/jboss-4.0.2/server/default/deploy” and classes12.jar under
“/home/<username>/jboss-4.0.2/server/default/lib” path and put similar entries for the Log
queues as given in point number 9 of Windows installation.

20 © Nucleus Software Exports Limited

8. In the path “/home/<username>/datapump” put the shell script “pumpdata.sh” and
xmlparserv2.jar, j2ee.jar, log4j-1.2.13.jar (Utilities\Linux folder in CVS) to generate master
data cache files.

Note: Make sure that all the jars given in the shell script are in the specified paths.

9. Upon running the shell script (./pumpdata.sh) the files would be cached in the path
specified earlier. (While running the Database script). Alternatively path can be seen in
“OUTPUT_FILE_PATH” column in the FINAPI_ONLINE_MASTER_INTERFACE table.

10. After the Master XMLs have been cached properly, start the JBoss server running the
“./run.sh” command. Also at this step it must be checked from the server log that the

21
 queues are “bound”, nucleus.jar and the FinnoneConnect.war are deployed properly
without errors on startup.

11. Upon proper startup, run the SecurityXML.html by modifying the IP address accordingly
in the html. Upon running it, an entry would be inserted in
FINNAPI_SEC_MODULE_SESSION table. Use the values in this table i.e. SESSION_ID
and MODULE_ID values for tags <externalsystemid> and <sessionid> in the testing
Master and Transaction HTMLs in the next step.

C:\
SecurityXML.html

12. Now invoke the application using the attached test html simulators. Modify the values of
IP, Port and <masterid> / <transactionid> Tags accordingly to check for the response in
case of master request html and inquiry html respectively.

Master

C:\Documents and
Settings\Administrator\Desktop\MasterXML.htm

Transaction

C:\ InquiryXML.html

The response for the request might be similar to the below screenshot.

22 © Nucleus Software Exports Limited

13. Upon startup of JBoss, in case of running various instances on the same server, errors
may occur due to port clashes in such a case, change the http port in server.xml file in
the “ /jboss-4.0.2/server/default/deploy/jbossweb-tomcat55.sar “ path and use this port to
invoke the startup servlet.

23
 14. Also change the Ports under Class Loading, JNDI (listening and RMIPort), Invokers to
the JMX node (RMIObjectPort, ServerBindPort) in jboss-service.xml under “/jboss-
4.0.2/server/default/conf” path.

15. After altering the ports restart JBoss and check the application by invoking through HTML
simulator as mentioned above.

Application.properties:

This is the only properties file which is being used and comes with the WAR file itself
under the path “FinnoneConnect.war\WEB-INF\classes\nucleus\core\applicationparameters”.

Pertaining to Server logging, API_LogFile property must be altered to point to the folder
where the logs need to be created. In case of Linux it may be like,
API_LogFile=N#//home//<username>//log//ServerApplicationLog.apilog.html. In case of windows
it is like,

API_LogFile=N#C:\\<log folder>\\ServerApplicationLog.apilog.html.

The API_LogLevel property can be altered to set the log levels accordingly.

The API_LogPlace property can be altered to set the type of logging.

The API_LogLayout property can be modified to set the layout of the log file generated.

For Service or datarefresher logging, the following parameters can be modified:

DP_LogPlace for changing the type of logging.

DP_LogFile for specifying the path and name where the log file needs to be created during the
datacache process.

DP_LogLayout to set the layout of the log file generated.

DP_LogLevel for setting the log level.

All the properties must be also changed in the Application.properties inside nucleus.jar
accordingly for Windows and Linux.

ost Installation Checks

In case of Windows, in order to check for successful installation, please follow the given steps:

1. Through command prompt, please go to the directory where JBOSS is installed (JBOSS
folder will be found where zip file is unzipped). For example if the root folder is jboss-4.0.2,
then type the following command to go to the bin directory of JBOSS.

24 © Nucleus Software Exports Limited

 cd jboss-4.0.2\bin

2. Type run.bat and enter to start JBOSS and wait till the WAR is deployed.

3. Give a Master request, inquiry request or a transaction request to check if the server
returns a proper response as mentioned above

In case of Linux:

1. From a remote system log on to the Linux server using the Putty software using the
username and password.

2. By default we will be under /home/<username> directory and get into the bin directory of
JBOSS by typing,

cd jboss-4.0.2/bin/

3. Now type ./run.sh to start JBOSS and deploy the WAR which is already put under the
server path.

4. Give a Master request, inquiry request or a transaction request to check if the server
returns a proper response as mentioned above

oubleshooting
In case of any errors which may arise due to posting Japanese characters in the request, kindly
check for the below points:

1. Make sure that the html formed is UTF-8 encoded i.e. the Japanese characters should be
properly formed upon clicking the test html file in the browser (default encoding utf-8).

2. In case of Windows, check the NLS_LANG parameter in regedit is

AMERICAN_AMERICA.JA16SJIS.

3. In case of Linux, the NLS_LANG parameter should be set to

AMERICAN_AMERICA.JA16SJIS in the environment variable.

In case of any errors which might occur during start up of JBOSS please check for the
following points:

1. Make sure the JAVA_HOME environment variable points to the jdk1.5.0 environment
because JBOSS by default takes this java compiler and the WAR is also jdk1.5.0
compiled.

25
 In case of any errors which might occur like Address already in use due to JMS (Java
Messaging Service) during start up of JBOSS please check for the following points:

1. Change the “ServerBindPort” attribute value of uil2-service.xml under the C:\ jboss-
4.0.2\server\default\deploy\jms path to a different value.

JavaDocs:

Please find the Java documentation for the Java classes which comprise the application
WAR file.

C:\ Temp\ Doc.zip

26 © Nucleus Software Exports Limited