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

The following section lists all settings supported by the ant.install.properties file.

The only settings that are only applicable for the eftlink-xx.x-upgrader.jar are as follows:

Table 2-1 Mandatory Upgrader Settings

Setting

Default

Description

installDir

C\:\\eftlink (windows) or /opt/eftlink (linux)

Installs EFTLink to the directory specified.

jreLocation

The location of the JRE to be used.

C\:\\jre (windows)

/opt/jre (linux)

Below is a list of the settings for eftlink-xx.x-installer.jar that need to be supplied for silent operation. If you running the installer using the GUI shell all these setting will be set dependent what is set in the user interface.

Table 2-2 Installer Settings

Setting	Default	Description
installDir	C\:\\eftlink (windows) or /opt/eftlink (linux)	Installs EFTLink to the directory specified.
jreLocation	The location of the JRE to be used.	C\:\\jre (windows) /opt/jre (linux)
DisplayLanguage	EN	Configures the Display Language used for EFTLink. Possible values are CN, DE,EN,ES,FR,IT,JP,NL, PT, RU, SV
NextGen	Y (Y = Websockets, N = TCP Sockets)	Controls whether EFTLink is using Websockets or TCP Sockets for communications between the POS and EFTLink
ServerChannel0	10100	Configures ServerChannel0 property setting. Note: This property setting is not used when setting "NextGen" is set to "Y".
ServerChannel1	10101	Configures ServerChannel1 property setting. Note: This property setting is not used when setting "NextGen" is set to "Y".
EftLinkPort	10100	Configures eftLinkPort property setting. Note: This property setting is not used when setting "NextGen" is set to "N".
installationMode	standalone	The Installation mode of EFTLink, possible values are standalone, server, pedpooling.
NumServers	1	Determines how many instances of the OPIServer to enable in server mode. The default is to run EFTLink in a single standalone state where EFTLink is dedicated to a one-to-one relationship with a single POS.
coreSetup	singlecore	Configures whether EFTLink framework is routing all request to one core or multiple active core possible values are singlecore, multicore.
EPSCore<n>	EPSCore0 = oracle.eftlink.opiretail.OPIRetailCore	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.
CustomFormCore	CustomFormCore = 0	A core designated to handle custom forms operations. Only used when coreSetup = multicore
EwalletCore	EwalletCore = 0	A core designated to handle EWallet operations. Only used when coreSetup = multicore
GiftCardCore	GiftCardCore = 0	A core designated to handle Gift Card operations. Only used when coreSetup = multicore
PayByLinkCore	PayByLinkCore = 0	A core designated to handle PayByLink operations. Only used when coreSetup = multicore
ReferralCore	ReferralCore = 0	A core designated to handle Referrals operations. Only used when coreSetup = multicore

Performing an Install/Upgrade

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.
Make sure that Java is on the path of the system. In Linux, JAVA_HOME is also required to be set.
Navigate to the path where you extracted the installer zip file.

For example, C:\<user>\Downloads or ~/Downloads).
Review the supplied ant.install.properties file and make changes if necessary.
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. Once the installation is complete, you will need to copy the newly generated keys folder to the Xstore POS. The required keys differ depending on what installation mode selected during the installation process.
  
  For WebSocket mode, you will need to copy:
  - eftlink.client.p12
  - eftlink.keystore.properties
  For Traditional TCP socket operation, you will need to copy:
  - pos.private.jks
  - eftlink.public.jks
  - comms.keystore.properties
  The location where the keys are stored in Xstore differs depending on version. Prior to version 22, the keys are located in the Xstore installation directory (for example, c:\xstore\keys).
  
  In version 22 and later, the keys are stored within the xstoredata folder (for example c:\xstoredata\xstore\keys).
Running the upgrader:

Note: Whenever possible, it is recommended to use the installer.jar to install a fresh copy of EFTLink, and then use a backup of your previous version to migrate any applicable configuration settings that you wish to retain.
1. 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. Verify the upgrade.
  
  Once the upgrade is complete your eftlink installation directory should be updated but all configuration properties settings should have been retained.
  
  However, due diligence should be performed after the upgrade to ensure the upgrader has not inadvertently retained configuration settings or files that are no longer applicable to the current version of EFTLink. For example, old libraries file may have been retained even though they are no longer required.
  
  Note:
  Some cores have transitioned to using a JSON configuration file, if the upgrader.jar detects that your configuration is stored in a .properties file, it will attempt to generate an equivalent JSON configuration file. Due diligence should be performed after the upgrade to verify that the generated JSON configuration is correct and meets your needs.
  
  Once you are satisfied with the upgraded installation, 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
  
  Note:
  On Windows, you can also start the OPI Server in the services panel.