Runnable Installer/Upgrader Jar

Note:

This section describes how to install EFTLink using the installer jar.

Follow the steps below to install EFTLink.

The eftlink-xx.x-installer.jar and eftlink-xx.x-upgrader.jar are runnable and if executed will perform a silent installation/upgrade by default.

To perform a silent installation requires a pre-populated ant.install.properties file to exist within the same directory as the runnable jars.

Property Settings

Lists each mandatory setting for the ant.install.properties file.

Table 2-1 Mandatory Installer Settings

Setting Description Default Example

installDir

Installs EFTLink to the directory specified.

C\:\\eftlink (windows)

/opt/eftlink (linux)

C\:\\eftlink

jreLocation The location of the JRE to be used.

C\:\\jre (windows)

/opt/jre (linux)

C\:\\jre_21
Note: The following settings only apply to the eftlink-25.x-installer.jar and therefore not applicable when running the eftlink-25.x-upgrader.jar.

ServerChannel0

Configures EFTLink eftlinkConfig.properties ServerChannel0 property setting.

 10100

10100

ServerChannel1

Configures EFTLink eftlinkConfig.properties ServerChannel1 property setting.

 10101

10101

installationMode

Installation mode value options are standalone, server, and pedpooling.

 standalone

server
NumServers Determines how many instances of the OPIServer to enable in server mode. In normal stand alone or non-server mode, set this to 0. 0 5
coreSetup coreSetup value options are: singlecore, and multicore. singlecore singlecore
EPSCore<n>

EPSCore< 0 - 5>

Name of EPS subsystem.

Plugin cores must be specified by their full package name, and the package must also be added to the execution class path.

 EPSCore0 = oracle.eftlink.opiretail.OPIRetailCore EPSCore0 = oracle.eftlink.opiretail.OPIRetailCore
CustomFormCore = 0

A core designated to handle custom forms operations.

Only used when coreSetup = multicore.

 CustomFormCore = 0  
EwalletCore

A core designated to handle EWallet operations.

Only used when coreSetup = multicore.

 EwalletCore = 0  
GiftCardCore

A core designated to handle Gift Card operations.

Only used when coreSetup = multicore.

 GiftCardCore = 0  
PayByLinkCore

A core designated to handle PayByLink operations.

Only used when coreSetup = multicore.

 PayByLinkCore = 0  
ReferralCore

A core designated to handle Referrals operations.

Only used when coreSetup = multicore.

 ReferralCore = 0  

Performing an Install/Upgrade

  1. Unzip the vxx.x.x.xxx.installer.zip file somewhere other than the desired target directory which is typically C:\eftlink or /opt/eftlink for Linux.

  2. Make sure that Java is on the path of the system. In Linux, JAVA_HOME is also required to be set.

  3. Navigate to the path where you extracted the installer zip file.

    For example, C:\<user>\Downloads or ~/Downloads).

  4. Review the supplied ant.install.properties file and make changes if necessary.

  5. Open a terminal (using elevated privilege) ensuring the directory is set to where the install/upgrader jars are located.

    Running the installer:

    1. Command to launch the installer.

      *(Windows) java -jar eftlink-(xx.x.x.x)-installer.jar or

      (Linux) sudo . java -jar eftlink-(xx.x.x.x)-installer.jar

      * Please ensure the property key "selectedCore" is populated with the desired core clashpath within the ant.install.properties file before running the jar. If preferred, the installer jar has a graphical user interface which can be accessed during installation by adding "gui" to the end of the command statement (separated by a space). For example eftlink-(xx.x.x.x)-installer.jar gui.

    2. The installation will end with the OPI Service being installed.

    3. Within the EFTLink installation directory, copy from C:\<eftlink installation folder>\keys folder the pos.private.jks and eftlink.public.jks files to the POS (for example, C:\xstoredata\xstore\keys, or prior to version 22 of Xstore in C:\xstore\keys).

    Running the upgrader:

    1. Command to launch the upgrader.

      *(Windows) java -jar eftlink-(xx.x.x.x)-upgrader.jar or

      (Linux) sudo . java -jar eftlink-(xx.x.x.x)-upgrader.jar

    2. Once the upgrade is complete your eftlink installation directory should be updated but all configuration properties settings should have been retained.

  6. Close the terminal and remove installations files / backup files if necessary.

  7. Start EFTLink. In the terminal, navigate to the installation directory, for example, C:\eftlink or /opt/eftlink.

    *Windows: start eftlink.bat

    Linux: ./eftlink.sh start

    *In Windows, you can also start the OPI Server in the services panel.