3 Installation
Pre-Installation
- Install all the prerequisite software and packages mentioned above
Steps of Installation
- Download and extract the installer zip file (Base).
- Navigate to “<OBAPI INSTALLER DIR>/ installables/OBAPI/BASE/25.1.0.0.0/config.
- Open the “installer.properties” file to maintain key configurations for BASE ENTITY (OBAPI_BU)
IMPORTANT:
- Enter the values right after the “=”sign
- DO NOT change anything to the left of the “=”
- DO NOT change any of the flag values or pre-filled values (such as
WLS_JDBC_DIGX_NAME,WLS_JDBC_DIGX_JNDI, Flag values etc) available in “Factory Shipped” section. - Ensure there is no blank space after “=” sign, except specific flavor specific configuration.
- Throughout this document consider UBS as UBS core banking with OBPM as payments engine.
Only below parameters should be set in installer.properties file
| Component | Parameter | Description | Example |
|---|---|---|---|
| DB details (for OBAPI schema) | OBAPI_DATABASE_HOSTNAME |
Enter the hostname of the database server which would host the database schema for OBAPI | abc.xyc.com |
OBAPI_DATABASE_PORT |
Enter the port number of the database listener | 1521 | |
OBAPI_DATABASE_SID |
Enter the Oracle Service Name for database instance |  |
|
OBAPI_DATABASE_SYS_USER |
Enter the username with 'sys' privileges | Sys | |
POST_FIX |
For OBAPI schema name like "OBAPI_DEV" POST FIX is 'DEV'.
SHOULD BE IN UPPERCASE ONLY. |
DEV | |
OBAPI_DBA_DIRECTORY_NAME |
Enter the directory name in which you want the OBAPI
schema tablespace datafile to be created. Enter Logical name (i.e.
DIRECTORY_NAME column) from
DBA_DIRECTORIES table NOT the physical
path.
|
OBAPI_DIR | |
OBAPI_AUDIT_DBA_DIRECTORY_NAME |
Enter the directory name in which you want the OBAPI
AUDIT tablespace datafile to be created. Enter Logical name (i.e.
DIRECTORY_NAME column) from
DBA_DIRECTORIES table NOT the physical
path.
|
OBAPI_AUDIT_DIR | |
| EHMS DB details (to be configured only in-case of FLAVOR as UBS,FCORE&OBPM) | EHMS_DATABASE_HOSTNAME |
Enter the hostname for EHMS database server | abc.xyz.com |
EHMS_DATABASE_PORT |
Enter the port number of EHMS database listener | 1521 | |
EHMS_SCHEMA_NAME |
Enter the Complete OBAPI-EXT (B1A1) HostInterfaceschema
name you want installer to create as new schema.
SHOULD BE IN UPPERCASE ONLY. |
EHMS182SCHEMA | |
EHMS_DBA_DIRECTORY_NAME |
Enter the directory name in which you want the OBAPI-EXT
(B1A1) schema tablespace datafile to be created. Enter Logical name
(i.e.DIRECTORY_NAME column) from
DBA_DIRECTORIES table NOT the physical
path.
|
OPATCH_LOG_DIR | |
EHMS_DATABASE_SYS_USER |
Enter the username with 'sys' privileges | Sys | |
EHMS_DATABASE_SID |
Enter the EHMS database Service Name |  |
|
EHMS_HOST_SCHEMA_NAME |
Enter the EXISTING EHMS HOST schema name | OBAPIUBS | |
EHMS_CCY(to be configured for UBS
and OBPM HOST only) |
Enter the Country code for EHMS HOME Branch | GB | |
EHMS_HB (to be configured for UBS
and OBPM HOST only) |
Enter the Branch code for code for EHMS HOME Branch | AT3 | |
EHMS_FCORE_FCUBS_SCHEMA_NAME (to be
configured for FCORE HOST only) |
FCORE-FCUBS schema name | FCRUBSHOST | |
| Weblogic server details | MIDDLEWARE_HOME |
Oracle Weblogic Server home path. Example /home/obapiuser/Oracle/Middleware/Oracle_Home - where you have sub-directories like wlserver,oracle_common etc. | /home/obapiuser/Oracle/Middleware/Oracle_Home |
JAVA_HOME |
Path where JAVA (JDK) is installed | /home/obapiuser/jdk17_0_124 | |
DB_EXECUTION_TYPE_HOME |
Path where FLYWAY is installed | /home/obapiuser/(flyway-8.3) | |
| For CX_ORACLE, no need to update/can be empty | [No update required for cx_oracle] | ||
DB_EXECUTION_TYPE |
Database execution type | FLYWAY/CX_ORACLE | |
GRADLE_HOME |
Path where GRADLE is installed | /home/obapiuser/gradle-7.9 | |
INSTALLATION_HOME |
Path where OBAPI is to be installed. All configuration
files will be copied as a sub-directory “config” under this directory.
DO NOT KEEP INSTALLATION_HOME AS MiddlewareHome. |
/home/obapiuser/obapi | |
WLS_DOMAIN_PATH |
Path where OBAPI Weblogic domain should be created. Users can now enter custom path as per their requirements. | /home/obapiuser/domains | |
WLS_CLUSTER_NAME |
Name of cluster; this cluster would have one single managed server. | obapi_cluster | |
WLS_CLUSTER_NODE_HOSTNAME |
Host name or IP address of managed server participating in the cluster. Currently only single node is supported. | abc.xyz.com | |
WLS_ADMIN_SERVER_PORT |
Weblogic AdminServer port. It is the port to access the administration console of the Weblogic server. Generally port 7001 is used as the AdminServer port. Custom port are supported. | 7001 | |
WLS_ADMIN_SERVER_SSL_PORT |
AdminServer SSL port. It is the port used to securely access (https) the administration console of the Weblogic server. | 7002 | |
WLS_NODE_PORT |
Node Manager Port. It is the port used by Node Manager to be configured for OBAPI domain. Generally, 5556 is utilized as Node Manager Port. Custom ports are supported. | 5556 | |
WLS_MS_SERVER_NAME |
Managed server name. This will be the name of the managed server created in the cluster followed by indexes. eg- If this is set as 'clip' managed servers would be clip1. | Clip | |
WLS_MS_SERVER_PORT |
Managed Server Port. Managed server will utilize this port for hosting OBAPI components and associated resources. Custom ports are supported. | 9001 | |
WLS_DOMAIN_NAME |
Enter Weblogic Domain name. | obapi_domain1 | |
WLS_DOMAIN_ADMIN_USER |
Domain user ID. The user id will be used to access the Weblogic Administration console. | weblogic | |
| WLS_NODE_TYPE | Weblogic Node Manager type | Plain/SSL | |
| WLS_MACHINE_NAME | Weblogic Node Manager machine name | obapi_machine | |
| APP_ROOT_DIR | Any empty directory path | /scratch/app/dir | |
WLS_JMS_FILEUPLOAD_PS (to be
configured for all OBAPI supported HOST) |
Set the paths for the persistent store of the FileUpload
JMS modules.
DO NOT KEEP path as INSTALLATION_HOME or as sub directory inside INSTALLATION_HOME. |
/scratch/obapi/ FileUpload | |
WLS_JMS_AUDIT_PS (to be configured
for all OBAPI supported HOST) |
Set the paths for the persistent store of the Audit JMS
modules.
DO NOT KEEP path as INSTALLATION_HOME or as sub directory inside INSTALLATION_HOME. |
/scratch/obapi/Audit | |
WLS_JMS_REPORT_PS (to be configured
for all OBAPI supported HOST) |
Set the paths for the persistent store of the Reports JMS
modules.
DO NOT KEEP path as INSTALLATION_HOME or as sub directory inside INSTALLATION_HOME. |
/scratch/obapi/Reports | |
WLS_JMS_JPA_PS (to be configured for
all OBAPI supported HOST) |
Set the paths for the persistent store of the JPA JMS
modules.
DO NOT KEEP path as INSTALLATION_HOME or as sub directory inside INSTALLATION_HOME. |
/scratch/obapi/JPA | |
WLS_JMS_EXTSYSRECEIVER_PS (to be
configured for all OBAPI supported HOST) |
Set the paths for the persistent store of the
ExtSystemReceiver JMS modules.
DO NOT KEEP path as INSTALLATION_HOME or as sub directory inside INSTALLATION_HOME. |
/scratch/obapi/Receiver | |
WLS_JMS_EXTSYSSENDER_PS(to be
configured for all OBAPI supported HOST) |
Set the paths for the persistent store of the
ExtSystemSender JMS modules.
DO NOT KEEP path as INSTALLATION_HOME or as sub directory inside INSTALLATION_HOME. |
/scratch/obapi/Sender | |
| OBAPI Application Administrator user details | OBAPI_ADMIN_USERNAME |
Set username for OBAPI application Admin user. USERNAME IS CASE SENSITIVE. In-case of OUD as provider username should be the User ID mentioned during user creation steps mentioned in pre-requisite document (refer To create User and mapping it to the Group section) | superadmin |
OBAPI_ADMIN_EMAIL |
Enter the Email ID for OBAPI application admin user. |  |
|
OBAPI_ADMIN_CONTACT_NO |
Enter the mobile number for OBAPI application admin
user.
COUNTRY CODE IS MUST. |
+911234567890 |
Note:
Apart from above any other property values should not be modified.Ensure ORACLE_HOME, JAVA_HOME variable are set and their
binaries are available in PATH variable before proceeding.
Login with OS user which was used to perform OBAPI pre-requisite software installation (or has ownership on Oracle Weblogic home directory)
Ensure OBAPI Installation home and filestore path’s maintained in installer.properties exists and user running the installer has read-write permissions.
Note:
When Proceeding with Product as OBRH or OBAPI+OBRH then only need to update OBRH_config.properties.Navigate to “<OBAPI INSTALLER DIR>/ installables/OBAPI/BASE/25.1.0.0.0/config”
Open the “OBRH_config.properties” file to maintain key configurations for
BASE ENTITY (OBRH).
Description of the illustration instaltn1-1.png
IMPORTANT:
- Enter the values right after the “=”sign
- DO NOT change anything to the left of the “=”
- Ensure there is no blank space after “=” sign, except specific flavor specific configuration. Throughout this document consider UBS as UBS core banking with OBPM as payments engine.
Only below parameters should be set in OBRH_config.properties file
| Component | Parameter | Description | Example |
|---|---|---|---|
| DB details (for OBAPI schema) | OBRH_DATABASE_HOSTNAME | Enter the hostname of the database server which would host the database schema for OBRH | abc.xyc.com |
| OBRH_DATABASE_PORT | Enter the port number of the database listener | 61521 | |
| OBRH_DATABASE_SID | Enter the Oracle Service Name for database instance | obapidb.in.oracle.com | |
| OBRH_DATABASE_SYS_USER | Enter the username with 'sys' privileges | sys | |
| PLATO_SCHEMA_NAME | Enter the PLATO SCHEMA name. | OBRH_PLATO | |
| OBRH_DBA_DIRECTORY_NAME | Enter the directory name in which you want the OBRH schema tablespace datafile to be created. Enter Logical name (i.e. DIRECTORY_NAME column) from DBA_DIRECTORIES table NOT the physical path. | OPATCH_LOG_DIR | |
| Weblogic server details | WLS_OBRH_MS_SERVER_NAME | Managed server name. This will be the name of the managed server created in the cluster. eg- If this is set as “obrh_server” managed servers would be “obrh_server” .. | obrh_server |
| WLS_OBRH_CLUSTER_NAME | Name of cluster; this cluster would have one single managed server. | obrh_cluster | |
| WLS_OBRH_MS_SERVER_PORT | Managed Server Port. Managed server will utilize this port for hosting OBRH components and associated resources. Custom ports are supported. | 7005 |
Note:
: Apart from above any other property values should not be modifiedEnsure ORACLE_HOME, JAVA_HOME variable are set and their binaries are available in PATH variable before proceeding.
Login with OS user which was used to perform OBRH pre-requisite software installation (or has ownership on Oracle Weblogic home directory)
Ensure OBRH and OBAPI+OBRH Installation home and filestore path’s maintained in installer.properties
And OBRH_config.properties exists and user running the installer has read-write permissions.
Installation Steps:
- From your terminal navigate to <OBAPI INSTALLER DIR>/
- Enter the following
command
python3.11 runInstaller.py
