Installation

Applies to: PayPlus Enterprise v3.2 Last updated: March 2026

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.

#RequirementVerification
1Target server meets hardware requirements (see below)Run systeminfo (Windows) or lshw (Linux) and compare against specifications
2Supported operating system installed and fully patchedOS version verified; current security patches applied
3Java SE 17 (LTS) installed and JAVA_HOME setjava -version returns 17.x.x
4Supported application server installed (WebSphere 9.x or JBoss EAP 7.4)Application server starts successfully
5Oracle 19c or SQL Server 2019 database provisionedDBA confirms database instance created; admin credentials available
6PayPlus database schema user created with required privilegesDBA confirms ppuser account with CREATE TABLE, CREATE SEQUENCE, CREATE INDEX, INSERT, UPDATE, DELETE, SELECT on PayPlus schema
7Ports 8443 (HTTPS), 8080 (HTTP redirect), 9080 (admin) open in firewallNetwork team confirms port access from client workstations and integration hosts
8PayPlus license file (payplus.lic) obtained from vendorLicense file received; validity period covers production go-live date
9Installation media (payplus-enterprise-3.2.0.zip) downloaded and checksum verifiedSHA-256 checksum matches value in release notes
10Outbound 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

ComponentMinimumRecommended (Production)
CPU4 cores, 2.5 GHz8 cores, 3.0 GHz (Intel Xeon or equivalent)
RAM16 GB32 GB (64 GB for high-volume institutions)
Application disk100 GB SSD250 GB SSD, RAID 10
Log / archive disk500 GB2 TB (separate volume from application disk)
Network1 Gbps NICDual 10 Gbps NIC with failover bonding

Software Requirements

ComponentSupported VersionsNotes
Operating SystemRed Hat Enterprise Linux 8.x / 9.x
Windows Server 2019 / 2022
RHEL preferred for production. Windows Server supported for lab and UAT environments.
JavaJava SE 17 LTS (OpenJDK or Oracle JDK)Java 11 supported for v3.1 only. Java 21 not yet certified.
Application ServerIBM WebSphere Application Server 9.0.x
JBoss EAP 7.4.x
WebSphere required for IBM MQ integration. JBoss supported for all other configurations.
DatabaseOracle Database 19c (19.x)
Microsoft SQL Server 2019 / 2022
Oracle RAC supported for high-availability deployments.
JDBC DriverOracle: 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.
  1. Extract the installation archive.
    Extract payplus-enterprise-3.2.0.zip to the installation staging directory. The archive contains: payplus.ear (application archive), install/ (installation scripts), config/ (configuration templates), sql/ (database scripts), and docs/ (release notes).
    unzip payplus-enterprise-3.2.0.zip -d /opt/payplus-install
  2. Copy the license file.
    Copy payplus.lic to config/license/payplus.lic within the extracted archive. The installation script validates the license before proceeding.
  3. Configure the installation properties file.
    Edit install/payplus-install.properties and 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 all CHANGEME values to secure values complying with your institution's password policy.
  4. 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.
  5. Run the application installation script.
    ./install-app.sh --config payplus-install.properties
    The script deploys payplus.ear to the application server, configures data sources, sets environment variables, and creates the PayPlus service.
  6. 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.
  7. Verify the installation.
    Open a browser and navigate to https://<server>:8443/payplus. The PayPlus login page should appear. Log in with the ppAdmin credentials 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 / UAT2g4g
Production — Standard4g8g
Production — High Volume8g16g

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.

  1. Obtain a certificate in PKCS#12 format (.p12) from your institution's PKI team.
  2. Import the certificate into the PayPlus keystore: $PAYPLUS_HOME/config/security/payplus.keystore
  3. Update payplus.properties: set ssl.keystore.path, ssl.keystore.password, and ssl.certificate.alias.
  4. Restart the PayPlus service.

Post-Installation Validation

CheckExpected ResultVerification Method
Web Console loginLogin page loads; admin login succeedsBrowser: https://server:8443/payplus
Database connectivityConnected shown in System > HealthAdmin Console → System → Health Monitor
License validityLicense status shows Valid with expiry dateAdmin Console → System → License
All connectors initializedConnector status shows Standby (not yet configured)Admin Console → Connectors → Status
Audit log activeAdmin login event visible in audit logAdmin Console → Audit → Recent Events
OFAC screening moduleScreening engine shows OnlineAdmin 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.
  1. Back up the database. Take a full database backup immediately before the upgrade. Verify the backup is restorable before proceeding.
  2. Back up the configuration directory. Archive $PAYPLUS_HOME/config/ to a safe location. This preserves all connector settings, compliance rules, and workflow definitions.
  3. Stop the PayPlus service. Confirm all in-flight payments have been processed or safely suspended. Check the payment queue for any pending items.
  4. 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.
  5. Verify database migrations. Review upgrade.log in the installation staging directory. All migrations must complete with status SUCCESS.
  6. Start the PayPlus service and complete the post-installation validation checklist above.
← Introduction Next: User Management →