Installation
Before You Begin
Installation must be performed by a qualified system administrator with DBA access to the target database server. Do not install PayPlus Enterprise on a server running other financial applications. Review the full prerequisites checklist before starting the installation.
Pre-Installation Checklist
Complete all items in this checklist before beginning installation. Installation will fail if prerequisites are not met.
| # | Requirement | Verification |
|---|---|---|
| 1 | Target server meets hardware requirements (see below) | Run systeminfo (Windows) or lshw (Linux) and compare against specifications |
| 2 | Supported operating system installed and fully patched | OS version verified; current security patches applied |
| 3 | Java SE 17 (LTS) installed and JAVA_HOME set | java -version returns 17.x.x |
| 4 | Supported application server installed (WebSphere 9.x or JBoss EAP 7.4) | Application server starts successfully |
| 5 | Oracle 19c or SQL Server 2019 database provisioned | DBA confirms database instance created; admin credentials available |
| 6 | PayPlus database schema user created with required privileges | DBA confirms ppuser account with CREATE TABLE, CREATE SEQUENCE, CREATE INDEX, INSERT, UPDATE, DELETE, SELECT on PayPlus schema |
| 7 | Ports 8443 (HTTPS), 8080 (HTTP redirect), 9080 (admin) open in firewall | Network team confirms port access from client workstations and integration hosts |
| 8 | PayPlus license file (payplus.lic) obtained from vendor | License file received; validity period covers production go-live date |
| 9 | Installation media (payplus-enterprise-3.2.0.zip) downloaded and checksum verified | SHA-256 checksum matches value in release notes |
| 10 | Outbound connectivity to payment networks confirmed (or deferred to connector configuration) | Network team confirms outbound routes to FedLine, SWIFTNet, TCH RTP, or test endpoints as applicable |
System Requirements
Hardware Requirements
| Component | Minimum | Recommended (Production) |
|---|---|---|
| CPU | 4 cores, 2.5 GHz | 8 cores, 3.0 GHz (Intel Xeon or equivalent) |
| RAM | 16 GB | 32 GB (64 GB for high-volume institutions) |
| Application disk | 100 GB SSD | 250 GB SSD, RAID 10 |
| Log / archive disk | 500 GB | 2 TB (separate volume from application disk) |
| Network | 1 Gbps NIC | Dual 10 Gbps NIC with failover bonding |
Software Requirements
| Component | Supported Versions | Notes |
|---|---|---|
| Operating System | Red Hat Enterprise Linux 8.x / 9.x Windows Server 2019 / 2022 | RHEL preferred for production. Windows Server supported for lab and UAT environments. |
| Java | Java SE 17 LTS (OpenJDK or Oracle JDK) | Java 11 supported for v3.1 only. Java 21 not yet certified. |
| Application Server | IBM WebSphere Application Server 9.0.x JBoss EAP 7.4.x | WebSphere required for IBM MQ integration. JBoss supported for all other configurations. |
| Database | Oracle Database 19c (19.x) Microsoft SQL Server 2019 / 2022 | Oracle RAC supported for high-availability deployments. |
| JDBC Driver | Oracle: ojdbc11.jar SQL Server: mssql-jdbc-12.x.jar | Drivers must be copied to the application server's lib directory before deployment. |
| Browser (Web Console) | Chrome 120+, Firefox 120+, Edge 120+ | Internet Explorer not supported. |
Installation Procedure
Note
Run all installation commands as a dedicated service account (e.g.,
ppinstall), not as root or a domain administrator. The service account must have read/write access to the installation target directory.
-
Extract the installation archive.
Extractpayplus-enterprise-3.2.0.zipto the installation staging directory. The archive contains:payplus.ear(application archive),install/(installation scripts),config/(configuration templates),sql/(database scripts), anddocs/(release notes).unzip payplus-enterprise-3.2.0.zip -d /opt/payplus-install
-
Copy the license file.
Copypayplus.lictoconfig/license/payplus.licwithin the extracted archive. The installation script validates the license before proceeding. -
Configure the installation properties file.
Editinstall/payplus-install.propertiesand set the following required values:install.dir=/opt/payplus appserver.type=jboss appserver.home=/opt/jboss-eap-7.4 db.type=oracle db.host=dbserver01.bank.internal db.port=1521 db.name=PPDB db.user=ppuser db.password=CHANGEME payplus.admin.user=ppAdmin payplus.admin.password=CHANGEME
Change allCHANGEMEvalues to secure values complying with your institution's password policy. -
Run the database schema installation script.
cd /opt/payplus-install/install ./install-db.sh --config payplus-install.properties
The script creates all required tables, sequences, indexes, and initial reference data. Verify the output for any ORA- or SQL Server errors before proceeding. -
Run the application installation script.
./install-app.sh --config payplus-install.properties
The script deployspayplus.earto the application server, configures data sources, sets environment variables, and creates the PayPlus service. -
Start the PayPlus service.
systemctl start payplus # Linux (systemd) # or, on Windows: net start "PayPlus Enterprise"
Wait approximately 60–90 seconds for the application to fully initialize. -
Verify the installation.
Open a browser and navigate tohttps://<server>:8443/payplus. The PayPlus login page should appear. Log in with theppAdmincredentials configured in step 3. The system dashboard should display with all services showing Online status.
Database Setup
Oracle Database
Before running the installation script, create the PayPlus database user with the following grants:
-- Run as DBA CREATE USER ppuser IDENTIFIED BY "SecurePassword123!"; GRANT CONNECT, RESOURCE TO ppuser; GRANT CREATE TABLE, CREATE SEQUENCE, CREATE INDEX TO ppuser; GRANT UNLIMITED TABLESPACE TO ppuser; ALTER USER ppuser DEFAULT TABLESPACE payplus_data TEMPORARY TABLESPACE temp;
SQL Server
-- Run as sa or sysadmin CREATE DATABASE payplus_db; CREATE LOGIN ppuser WITH PASSWORD = 'SecurePassword123!'; USE payplus_db; CREATE USER ppuser FOR LOGIN ppuser; ALTER ROLE db_owner ADD MEMBER ppuser;
Production Hardening
Do not grant
db_owner in production. After the initial schema installation completes, reduce the PayPlus database user to minimum required privileges: SELECT, INSERT, UPDATE, DELETE, and EXECUTE on PayPlus schema objects only. Contact your PayPlus DBA support representative for the post-install privilege reduction script.
Application Server Configuration
JVM Heap Settings
The default JVM heap settings are suitable for test environments. Adjust for production based on expected payment volume:
| Environment | -Xms (Initial Heap) | -Xmx (Max Heap) |
|---|---|---|
| Development / UAT | 2g | 4g |
| Production — Standard | 4g | 8g |
| Production — High Volume | 8g | 16g |
Set heap values in $PAYPLUS_HOME/bin/payplus-env.sh (Linux) or payplus-env.bat (Windows):
JAVA_OPTS="-Xms4g -Xmx8g -XX:+UseG1GC -XX:MaxGCPauseMillis=200"
HTTPS / TLS Configuration
PayPlus Web Console requires HTTPS. Configure a TLS certificate from your institution's PKI or a trusted CA before go-live. Self-signed certificates are acceptable for lab environments only.
- Obtain a certificate in PKCS#12 format (
.p12) from your institution's PKI team. - Import the certificate into the PayPlus keystore:
$PAYPLUS_HOME/config/security/payplus.keystore - Update
payplus.properties: setssl.keystore.path,ssl.keystore.password, andssl.certificate.alias. - Restart the PayPlus service.
Post-Installation Validation
| Check | Expected Result | Verification Method |
|---|---|---|
| Web Console login | Login page loads; admin login succeeds | Browser: https://server:8443/payplus |
| Database connectivity | Connected shown in System > Health | Admin Console → System → Health Monitor |
| License validity | License status shows Valid with expiry date | Admin Console → System → License |
| All connectors initialized | Connector status shows Standby (not yet configured) | Admin Console → Connectors → Status |
| Audit log active | Admin login event visible in audit log | Admin Console → Audit → Recent Events |
| OFAC screening module | Screening engine shows Online | Admin Console → Compliance → Screening Status |
Upgrading from a Previous Version
Upgrade Requires Maintenance Window
Upgrading PayPlus Enterprise requires a planned maintenance window. Stop all active payment processing before the upgrade begins. Coordinate with your operations and payments teams to schedule the window during a low-volume period.
- Back up the database. Take a full database backup immediately before the upgrade. Verify the backup is restorable before proceeding.
- Back up the configuration directory. Archive
$PAYPLUS_HOME/config/to a safe location. This preserves all connector settings, compliance rules, and workflow definitions. - Stop the PayPlus service. Confirm all in-flight payments have been processed or safely suspended. Check the payment queue for any pending items.
- Run the upgrade script. Extract the new version archive and run
upgrade.sh --from 3.1 --config payplus-install.properties. The upgrade script applies database schema migrations and redeploys the application. - Verify database migrations. Review
upgrade.login the installation staging directory. All migrations must complete with statusSUCCESS. - Start the PayPlus service and complete the post-installation validation checklist above.