Diebold Nixdorf ProBase Store 1 Installation guide

Diebold Nixdorf
Brand
Diebold Nixdorf
Model
ProBase Store 1
Type
Installation guide
INSTALLATION GUIDE
ProBase Store 1
Installing JavaPOS™, OPOS, POS for .NET and CPOS on Windows
January 2023
Systems Group Retail Products 2
Imprint
Mathias Janke
Diebold Nixdorf
Systems Group Retail Products
Wohlrabedamm 31
13629 Berlin
mathias.janke@dieboldnixdorf.com
Systems Group Retail Products 3
Revision history
Version
Date
Author
Comment/Change
1.0
Nov. 2019
Mathias Janke
1st version
2.0
Nov. 2019
Mathias Janke
Typos corrected; chapter UDM configuration added
3.0
Mar. 2020
Mathias Janke
Typos corrected; synchronized with user manual
4.0
April 2020
Denis Kuniß
Version corresponding to ProBase Store 1.1
5.0
Oct. 2020
Mathias Janke
Version corresponding to ProBase Store 1.2
6.0
April 2021
Mathias Janke
Version corresponding to ProBase Store 1.3
7.0
Dec. 2021
Denis Kuniß
Version corresponding to ProBase Store 1.4
8.0
April 2022
Denis Kuniß
Version corresponding to ProBase Store 1.5
9.0
Aug. 2022
Mathias Janke
Version corresponding to ProBase Store 1.6
10.0
Jan. 2023
Mathias Janke
Version corresponding to ProBase Store 1.7
Systems Group Retail Products 4
Contents
Installation ............................................................................................................. 7
Product installer variants ........................................................................................................... 7
Installation profiles .................................................................................................................... 7
Installation requirements .......................................................................................................... 8
Minimum precondition .................................................................................................................. 8
POS for .NET preconditions............................................................................................................ 9
Supported Java Runtime Environments ........................................................................................ 9
Supported operating systems ...................................................................................................... 10
Interactive installation ............................................................................................................. 10
Silent installation ..................................................................................................................... 14
Unattended installation ........................................................................................................... 15
Update installation ................................................................................................................... 15
Changing profile on update or re-installation ............................................................................. 15
Upgrade installation ................................................................................................................. 15
Uninstallation ....................................................................................................... 16
Interactive uninstallation ......................................................................................................... 16
Silent uninstallation ................................................................................................................. 16
Logging ................................................................................................................. 17
Installation log .......................................................................................................................... 17
Uninstallation log ..................................................................................................................... 17
Command line parameters ................................................................................... 18
Configuration ....................................................................................................... 19
JavaPOS configuration ............................................................................................................. 19
Java VM configuration ............................................................................................................. 20
Systems Group Retail Products 5
OPOS configuration .................................................................................................................. 20
P4DN configuration .................................................................................................................. 21
CPOS configuration .................................................................................................................. 22
UDM configuration .................................................................................................................. 22
UDM server configuration ........................................................................................................... 22
UDM client configuration for OPOS ............................................................................................. 23
UDM client configuration for P4DN ............................................................................................. 23
UDM client configuration for CPOS ............................................................................................. 24
D&S Platform T/SOP configuration .......................................................................................... 24
Verifying the installation ...................................................................................... 25
Verifying the JavaPOS installation ........................................................................................... 25
Verifying the OPOS installation ................................................................................................ 27
Verifying the POS for .NET installation .................................................................................... 28
Frequently asked questions (FAQs) ...................................................................... 30
Systems Group Retail Products 6
Introduction
ProBase Store 1 provides implementations for all programming platforms defined by the international
standard UnifiedPOS
1
. These are JavaPOS, OPOS, and POS for .NET. Additionally, an implementation
for C based applications called CPOS (not standardized in UnifiedPOS) is provided.
The current product installer for Windows operating systems is based on Inno Setup
2
, which provides
the concept of profiles. Here, a profile is associated with a particular programming platform providing
programmatic access to peripheral devices. This concept offers the user to choose the right platform he
would like to program in.
Internally, the product is organized in components. The product installer will ensure that all components
needed for the selected programming platform are installed and configured. If the user would like to
adjust the subset of components selected through a profile, he also has the possibility to customize it by
selecting/deselecting components in the custom installation profile. However, the customized subset of
components will not be checked for consistency before the installer continues. Therefore, dependency
errors for lacking packages have to be solved by the user when customizing a profile. Otherwise, the
application may fail at runtime afterwards.
1
https://nrf.com/resources/retail-technology-standards/unifiedpos
2
http://www.jrsoftware.org/isinfo.php
Systems Group Retail Products 7
Installation
The ProBase Store product installer can run in interactive mode as well as in silent mode. It also
provides the possibility of performing so-called unattended installations based on an initial master
installation.
Product installer variants
The installer are available as 32-bit and 64-bit versions for Windows based operating systems. The
installer variants (32 or 64-bit) are based on the process architecture of the application respectively on
the Java Virtual Machine (Java VM) architecture to be used. This means that e.g., when using a 32-bit
application / Java VM on a 64-bit operating system, the 32-bit ProBase Store installer needs to be used
anyway.
The provided product installers follow the naming scheme:
• ProBaseStore-MAJOR.MINOR.BUILD-x64.exe
• ProBaseStore-MAJOR.MINOR.BUILD-x86.exe
Example: ProBaseStore-1.7.32-x86.exe
Installation profiles
The current product installer for Windows operating systems is based on Inno Setup, which offers the
concept of installation profiles and can be used interactively as well as remotely, silent, and unattended.
In case of the ProBase Store installer, a profile is connected to a certain implementation technology,
which allows the programmatic access to peripheral devices. This allows the user to select the
technology that fits the application. The installer ensures that all components for the selected profile are
installed correctly and completely.
If necessary, the user can also make changes to the selection of the components specified by the
preselected profile by further selecting or deselecting components in the Custom Installation profile.
However, the installer cannot perform a consistency check of the components in the modified profile, so
the user must ensure that all required components are installed. Otherwise, the application may not or
may work in a limited way.
The following table shows the currently defined installation profiles:
Profile Name
JavaPOS Installation
(ACO)
JavaPOS Installation
(POS)
Systems Group Retail Products 8
Profile Name
OPOS Installation
(POS)
POS for .NET 1.12 Installation
(POS)
POS for .NET 1.14 Installation
(POS)
CPOS Installation
(POS, for C-applications)
Custom Installation
Note: It is recommended to use the predefined profiles and to perform a customized installation only
after consultation with the Diebold Nixdorf GSE support team.
Installation requirements
The conditions described in this chapter apply to the installation process only. The requirements at
runtime, such as additional system drivers for the devices to be addressed, can be found within the
ProBase Store user manual or release notes
3
.
Note: The installation of ProBase Store requires administrator permissions.
Note: ProBase Store, as the successor to ProBase POS and ProBase Retail, conflicts with these
predecessors, which must be uninstalled in advance. For more details regarding the migration of
an older DN Middleware product to ProBase Store, please refer to the ProBase Store migration
guide.
Minimum precondition
The following software must already be installed on the target computer to run the ProBase Store setup
successfully:
• Java Virtual Machine (version 8)
3
provided with each ProBase Store version; to be found within the ProBase Store installation directory
Systems Group Retail Products 9
For further information, see chapter Supported Java Runtime Environments.
POS for .NET preconditions
In case the POS for .NET 1.12 Installation profile or corresponding POS for .NET components have
been selected (see chapter Interactive installation), ensure that the following software has already been
installed on the target machine:
• Microsoft Point of Service for .NET (version 1.12)
• Microsoft .NET Framework (at least version 2.0 up to 4.0)
In case the POS for .NET 1.14 Installation profile or corresponding POS for .NET components have
been selected (see chapter Interactive installation), ensure that the following software has already been
installed on the target machine:
• Microsoft Point of Service for .NET (version 1.14)
• Microsoft .NET Framework (at least version 4.0)
Supported Java Runtime Environments
The installation of ProBase Store supports the following Java runtime environments (JRE):
• Oracle JRE (version 8)
• OpenJDK (version 8, 11)
• Diebold Nixdorf UDM Runtime (version 8, 11)
Note: For the installation profiles OPOS Installation, POS for .NET Installation and CPOS Installation a
Java VM is required as installation and as runtime requirement.
For these use cases, we recommend the DN UDM Runtime, a Diebold Nixdorf distribution
package of a Java Runtime Environment (JRE) based on OpenJDK 8 or OpenJDK 11, which
installs an embedded Java VM that is not publicly available.
The installation package of the UDM Runtime will be provided with the system pre-installations
or as a separate download on the DN website
4
.
4
> DN website > SUPPORT > Reference Manuals, Drivers and Firmware Downloads > POS-/Kiosk-Systems, Peripherals >
Software Downloads > ProBase Store Download
Systems Group Retail Products 10
Supported operating systems
ProBase Store 1 supports and is released for the following Windows based operating systems:
• Windows 10 IoT Enterprise (x86/x64)
• Windows 10 Professional (x86/x64)
• Windows 8.1 Industry Embedded (x86/x64)
• Windows 8.1 Professional (x86/x64)
• Windows POSReady 7 (x86/x64)
• Windows 7 Professional (x86/x64)
Interactive installation
The product installer provides an interactive mode, where the end user can:
• select one of the pre-defined installation profiles
• customize the installation by selecting/deselecting particular components
• define the Windows start menu shortcut group name
• activate/deactivate post-installation actions
Example: Interactive installation of ProBase Store for 64-bit JVM
Note: The setup can be cancelled on each step by clicking the [Cancel] button. If the setup is
already in the step of copying files, then the installation abort will roll back the changes done
to the system. Before this step, nothing will have happened to your system. By clicking the
[Back] button, you can go a step back in the setup if needed.
After launching the ProBase Store 1 installer, the following welcome screens will appear
Dialog: Welcome to Setup Wizard
➢ Click the [Next] button to go on with the setup.
Systems Group Retail Products 11
Dialog: License Agreement
➢ Choose [I accept the agreement] after reading.
➢ Click the [Next] button.
Dialog: Select Components
In this dialog, one of the predefined installation profiles can be selected. Alternatively, you can create
your own installation using the [Custom Installation] profile and selecting the appropriate components.
➢ Select the components to install by using one of the installation profiles.
➢ Click the [Next] button.
Systems Group Retail Products 12
➢ Alternatively, choose [Custom Installation] and check the features you want to install from the
list.
➢ Click the [Next] button.
Dialog: Select Start Menu Folder
➢ Specify a start menu folder for this ProBase Store version.
➢ Click the [Next] button.
Systems Group Retail Products 13
Dialog: Ready to Install
The installer is ready to proceed with the installation and provides an installation summary for letting
you check all your previously made choices.
➢ Click the [Install] button.
Dialog: Installing
This dialog shows you the current installation step and the overall progress of the installation. Please
wait until the installer finishes this step, except you want to cancel the installation (click the [Cancel]
button if so).
Systems Group Retail Products 14
Dialog: Completing the Setup
If no error had been encountered and everything had been finished successfully, you are going to see
a last dialog, informing you that the installation is complete and providing the possibility to perform
prepared post installation actions.
➢ Click [Finish] to end the installation.
Note: The number of check boxes that appear in this dialog box depends on the selected
installation profile. By default, all checkboxes should remain selected to ensure correct
configurations for all parts.
The following table describes the checkboxes in detail:
Checkbox
Description
Register UDM Server to be
automatically started on system start
up. Note: …
If enabled, the startup behavior of the UDM server will be changed
and the UDM server will then be started at system startup.
Attention: The automatic start after the open() call (default behavior of
the UDM server) needs to be deactivated. For further information, see
the ProBase Store user guide, chapter 8.6.1 - UDM server
configuration.
Note: This checkbox is deactivated by default.
Make an initial import of JavaPOS
open name configurations to
Windows registry to make them
visible for OPOS application
If enabled, the JavaPOS configuration will be imported into the
Windows registry as OPOS configuration.
Note: This checkbox is activated by default.
Silent installation
A silent installation of ProBase Store 1 is possible. For this, the product installer must be called with the
/SILENT parameter via the command line.
Systems Group Retail Products 15
During a silent installation, the wizard and other background windows are not displayed. However, a
window showing the progress of the installation is displayed.
If this window is not to be displayed, you should use the completely silent installation mode with the
/VERYSILENT parameter. The JavaPOS installation profile is installed by default in silent installation
modes.
Note: The silent installation mode installs the installation profile JavaPOS Installation (Cash and POS
Peripherals). If a different selection of components is required, an unattended installation is to be
carried out (see chapter Unattended installation).
Unattended installation
As with silent installation, an unattended installation with command line parameters is also possible.
To do this, a supervised installation on a system must be executed with the parameter
/SAVEINF="pathToFile" in the first step. The following installation must be carried out with all necessary
specifications and settings. These settings and changes to the setup are stored in the specified file.
With this file, the product installer, and the setup parameters /LOADINF="pathToFile" as well as
/SILENT or /VERYSILENT, this recorded installation can now be run automatically, still and unattended
on other systems.
Update installation
An already installed ProBase Store may be updated with a newer version as long as the major version
number between installed version and update does not differ. On an update, the installation profile may
change (however, see constraint in the next sub chapter).
Note: Since ProBase Store strictly separates the installation files from user data, all customer-specific
configuration files (javapos.config.properties) are preserved. However, the derived JavaPOS
configuration will be updated by calling the JavaPOS Configurator as recommended after
changing the software components.
Changing profile on update or re-installation
Due to capabilities of Inno Setup installer mechanism any change of the profile on subsequent
installation attempts (same product version or newer one) will not uninstall components already installed
by the previous installation associated with originally selected profile. However, on uninstallation all
components will be removed as the Inno Setup mechanism maintains an installation history for that.
Upgrade installation
There is no upgrade mechanism for older Middleware installations like JavaPOS 1.7, OPOS 1.6,
ProBase POS or ProBase Retail available. Therefore, it is recommended to remove all these preceding
DN Middleware versions before the installation of ProBase Store 1.x.
For more details regarding the migration from a previous DN Middleware product to ProBase Store,
please refer to the ProBase Store migration guide.
Systems Group Retail Products 16
Uninstallation
The product uninstaller will remove all components, previously installed by the product installer, even if
the profile has been changed by subsequent installation attempts. See Inno Setup documentation
5
for
details.
Note: Since ProBase Store strictly separates installation data from user data, customer-specific
configuration files (javapos.config.properties) and derived configurations are preserved after
uninstalling ProBase Store.
Interactive uninstallation
There are three possibilities offered to run the uninstallation of the product interactively:
• direct call of the uninstaller unins000.exe located under the directory <ProBase Store installation-
directory>\Uninstall-ProBase-Store
• use the Windows start menu entry Uninstall Diebold Nixdorf ProBase Store (xx JVM) at the
location Start Menu > all programs > Diebold Nixdorf ProBase Store (xx JVM)
• or use the Windows system tool with Control Panel > Add or Remove Programs
Note: It is recommended not to call the uninstaller directly from the Windows Explorer, as the
uninstallation log will not be created (see chapter Uninstallation log for more details).
Silent uninstallation
Like for the installation, it is also possible to execute the uninstaller silently by applying the command
line argument /SILENT or /VERYSILENT.
Example:
"C:\Program Files\javapos\ProBase-Store\Uninstall-ProBase-Store\
unins000.exe" /LOG="C:\ProgramData\javapos\wn\logs\uninstall_PBS.log"
/SILENT
Note: Unlike the installation, the uninstallation log is not activated by default, and therefore, it is
recommended to call the uninstaller with the /LOG=”PathToLogFile” switch also (see chapter
Uninstallation log for more details).
5
http://www.jrsoftware.org/ishelp/
Systems Group Retail Products 17
Logging
Installation log
The logging for the installation process is always activated. If the installer is not called with the
parameter /LOG="filename", the setup logging file will be stored in the %TMP% directory
6
with a unique
filename based on the current date according to the pattern Setup Log yyyy-mm-dd #<number>.txt.
Example:
Setup Log 2019-04-16 #002.txt
Note: As a post installation action (if not disabled at the ProBase Store setup), the JavaPOS
Configurator will be started to create an initial JavaPOS configuration. This JavaPOS
configurator run will also be logged. The log file for the JavaPOS configurator is stored within
C:\ProgramData\javapos\wn\log.
Uninstallation log
The logging feature for the uninstallation process cannot be generally activated as it is for the installation
process. Therefore, and in order to activate logging for the uninstallation process, the parameter
/LOG="filename" has to be appended to the uninstaller call.
The uninstallation logging has the following limitations:
• If the uninstaller is called directly (and without giving the /LOG option), then no uninstallation log
is created.
• The uninstaller cannot append a counter to the log file name as the installer can. Therefore, only
one uninstallation log per defined name is possible. If the product has been installed/uninstalled
multiple times, the uninstallation log will always be re-written.
Note: We recommend using the product version number as well as the date and/or the time within the
log file name (e.g. /LOG=%TMP%/Uninstall_<ProBaseStore>-<Version>.<Build>.%DATE%.log).
6
defined as system and/or user environment variable
Systems Group Retail Products 18
Command line parameters
Below you will find a short list of the most important command line parameters supported by the product
installer derived from the Inno Setup installer runtime.
This list is non-exhaustive and shows only the important command switches. For a complete list, please
refer to the Inno Setup official help
7
.
/SILENT
The setup will run silent without displaying the wizard and the background window. However, the
installation progress window is shown as well as error messages during the installation.
/VERYSILENT
The setup will run silent without displaying the wizard, the background window and the progress
windows. Only error messages during the installation are shown.
/LOADINF="filename"
The installer will load the settings from the specified file after having checked the command line. This
file can be prepared using the /SAVEINF= parameter as explained below.
/SAVEINF="pathToFile"
The installer will save the installation settings to the specified file. Do not forget to use quotes if the
filename contains spaces and always use the absolute path to the file.
/LOG
The installer will create a log file in the user's TEMP directory detailing file installation and [Run]
actions taken during the installation process. This can be a helpful debugging aid. For example, if
you suspect a file is not being replaced when you believe it should be (or vice versa), the log file will
tell you if the file was really skipped, and why.
The log file will be created with a unique name based on the current date. (It will not overwrite or
append to existing files.)
The information contained in the log file is technical in nature and therefore not intended to be
understandable by end user. Nor is it designed to be machine-parsable. The format of the file is
subject to change without notice.
/LOG="filename"
Same as /LOG, except it allows specifying a fixed path/filename to be used as log file. If a file with
the specified name already exists, it will be overwritten and if the file cannot be created, the installer
will abort with an error message.
7
http://unattended.sourceforge.net/InnoSetup_Switches_ExitCodes.html
Systems Group Retail Products 19
Configuration
This chapter provides only some basic information regarding the configuration of ProBase Store. For
more details regarding the configuration, please refer to the related subsections within the ProBase
Store user guide.
JavaPOS configuration
ProBase Store provides an automated JavaPOS configuration generation to make integration with
JavaPOS applications easier and more convenient as well as to ensure that ProBase Store updates
become visible to the application environments immediately after the installation and restarting the
application. The automatic configuration is performed by the JavaPOS Configurator provided by
ProBase Store.
The JavaPOS Configurator is a small Java program that lists all JavaPOS files and paths, analyzes all
XML files (JavaPOS configuration files, peripheral configuration files), and generates the combined
JavaPOS system configuration jpos.xml and the file setenv.bat to set all necessary environment
variables.
At the end of the installation process of ProBase Store 1, the JavaPOS Configurator is automatically
started (if not deselected) to generate an initial configuration for JavaPOS.
With config_javapos_startup.vbs contained in the directory <ProBase Store installation directory>\bin,
the JavaPOS Configurator can be started manually, but must be executed with administrator rights to
write the configuration successfully.
The JavaPOS Configurator can also be started from the Windows Start menu. By selecting Start Menu >
All Programs > Diebold Nixdorf ProBase Store (xx-bit JVM) > Configuration > Generate JavaPOS
configuration the script config_javapos_startup.vbs will be started to update the JavaPOS configuration.
Note: If additional packages like ProBase Store add-ons or third party JavaPOS packages have been
installed or the installed packages and/or the customer specific configuration files have been
updated, it is necessary to rerun the JavaPOS Configurator manually.
Note: For this automated JavaPOS configuration generation to work, the involved packages must
follow the DN JavaPOS guideline
8
.
It is possible to customize the output of the JavaPOS Configurator by means of application-specific
configuration files named javapos.config.properties. Such a configuration file shall contain only the
application-specific adaptations that differ from the default configurations of the JavaPOS modules.
These are, for example, adjustments such as the selection of the devices used, the necessary COM port
settings for the RS232 devices if used, or generally all adjustments to JavaPOS configuration
parameters.
This application-specific configuration leads to a separately generated JavaPOS configuration file
jpos.xml.
Due to the JavaPOS configurator and the possibility of application-specific customization, it is not
necessary to change the original XML files in the <ProBase Store installation directory>\xml directory. In
8
JavaPOS General Requirements for Windows; Diebold Nixdorf; Peter Duellings; version 1.3
Systems Group Retail Products 20
addition, this configuration is maintained through update-installations of ProBase Store. Otherwise, the
changes to the original XML-files would be lost.
This customer-specific respectively application-specific configuration is hereinafter referred to as the
target configuration.
At each run, the JavaPOS Configurator checks all available JavaPOS-files (.jar, .xml) and the available
application-based configuration files javapos.config.properties and creates or replaces the existing files
jpos.xml and setenv.bat of the target configuration in the directory C:\ProgramData\javapos.
Note: For reference and test purposes, the JavaPOS Configurator generates or updates an additional
set of configuration files containing all available JavaPOS devices, which are stored in the
directory C:\ProgramData\javapos\all. This configuration is hereinafter referred to as the all-
device configuration.
Java VM configuration
ProBase Store uses JavaPOS as the basis for all interfaces. Therefore, a Java VM is a runtime
requirement for ProBase Store. For more information regarding the runtime requirements please refer to
the ProBase Store user guide or the release notes.
All with ProBase Store provided Java tools will check whether a Java VM is installed. Afterwards, a
suitable Java VM version will be selected from all available Java VM versions. This requires that the
installed Java VM can be found.
If the installed Java VM cannot be found or to overrule the Java VM search algorithm, it is possible to
explicitly specify the Java VM to be used. To do so, the environment variable JAVAPOS_JAVA_HOME
must be defined.
Note: If the environment variable is defined then the JRE at the path defined by this variable is used
regardless of whether the path points to a valid JRE installation or not.
OPOS configuration
The device-specific configurations for OPOS are typically stored in the Windows registry. The OPOS
provided with ProBase Store saves the configuration data in the subkey \OLEforRetail\ServiceOPOS,
depending on the processor architecture, either under HKLM\SOFTWARE or under
HKLM\SOFTWARE\Wow6432Node. Thereunder the devices are grouped into device categories
according to UnifiedPOS.
A change of the configuration must be made directly in the Windows Registry at the end. For this
purpose, the parameters of the desired OPOS device must be edited at the corresponding OpenName
for the device.
Note: Make sure that the changed parameters contain valid values, otherwise the middleware function
will be impaired and unwanted or incorrect operating behavior may occur. A check of the values
or a pre-selection of the values is not done when editing the configuration within the Windows
Registry.
Note: To store the changes in the registry permanently, the Windows Registry editor must be called
with administrator rights.
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30

Diebold Nixdorf ProBase Store 1 Installation guide

Diebold Nixdorf
Brand
Diebold Nixdorf
Model
ProBase Store 1
Type
Installation guide
Download PDF
report

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI

Related papers

Other documents