installation guide probase pos 2 - diebold nixdorf€¦ · 4 > intranet > portfolio > our...

27
INSTALLATION GUIDE ProBase POS 2 Installing JavaPOS, OPOS, POS for .NET and CPOS on Windows May 2019

Upload: others

Post on 15-Oct-2020

54 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

INSTALLATION GUIDE

ProBase POS 2 Installing JavaPOS, OPOS, POS for .NET and CPOS on Windows

May 2019

Page 2: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 2

Imprint

Mathias Janke

Diebold Nixdorf

Systems Group Retail Products

Wohlrabedamm 31

13629 Berlin

[email protected]

Page 3: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 3

Revision history

Version Date Author Comment/Change

1.0 Sep. 2016 Mathias Janke 1st version

2.0 Dec. 2016 Mathias Janke

Typos corrected, chapter JavaPOS configurator and

Verifying the installed configuration updated, chapter

OPOS Configuration Updater added

3.0 Jul. 2017 Mathias Janke Typos corrected; Adaptations for PBP 2.3

4.0 Sep. 2017 Mathias Janke Adaptations for PBP 2.4

5.0 May 2018 Mathias Janke Adaptations for PBP 2.6

6.0 Dec. 2018 Mathias Janke Adaptations for PBP 2.8

7.0 May 2019 Mathias Janke Adaptations for PBP 2.9, small corrections and additional

pictures.

Page 4: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 4

Contents

Introduction ........................................................................................................... 6

Installation of ProBase POS 2 ................................................................................. 7

Prerequisites .............................................................................................................................. 7

Supported Operating Systems ....................................................................................................... 7

Minimum prerequisites ................................................................................................................. 7

Additional prerequisites ................................................................................................................ 8

Product installer variants ............................................................................................................... 8

Installation profiles .................................................................................................................... 8

Interactive installation ............................................................................................................... 9

Silent installation ..................................................................................................................... 14

Unattended installation ........................................................................................................... 14

Updating to new product version ............................................................................................ 15

Changing profile on update or re-installation ............................................................................. 15

Upgrading of older installations before ProBase POS 2.0 ....................................................... 15

Installing additional features ................................................................................................... 15

Installing ProBase Retail in parallel .......................................................................................... 15

Uninstallation of ProBase POS 2 ........................................................................... 16

Interactive uninstallation ......................................................................................................... 16

Silent uninstallation ................................................................................................................. 16

Logging ................................................................................................................. 17

Installation log .......................................................................................................................... 17

Uninstallation log ..................................................................................................................... 17

Command line parameters ................................................................................... 18

Configuration ....................................................................................................... 19

Page 5: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 5

JavaPOS configuration ............................................................................................................. 19

JavaVM configuration .............................................................................................................. 19

OPOS configuration .................................................................................................................. 20

OPOS Configuration Updater ................................................................................................... 20

P4DN configuration .................................................................................................................. 21

Verifying the installed configuration .................................................................... 22

Verifying the JavaPOS installation ........................................................................................... 22

Verifying the OPOS installation ................................................................................................ 24

Verifying the POS for .NET installation .................................................................................... 26

Frequently asked questions (FAQs) ...................................................................... 27

Page 6: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 6

Introduction ProBase POS 2 provides implementations for all programming platforms defined by the international

standard UnifiedPOS1. In particular, these are JavaPOS, OPOS, and POS for .NET. Additionally, an

implementation for C based application called CPOS (not standardized in UnifiedPOS) is provided.

The current product installer for Windows operating systems is based on Inno Setup2, 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. So, 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

Page 7: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 7

Installation of ProBase POS 2 The product installer may 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.

Prerequisites

Supported Operating Systems

ProBase POS supports the following Windows based operating systems:

Windows XP (x86)

POSReady 2009 (x86)

Windows 7 Professional (x86/x64)

POSReady 7 (x86/x64)

Windows 8.1 Professional (x86/x64)

Windows 8.1 Industry Embedded (x86/x64)

Windows 10 Professional (x86/x64)

Windows 10 IoT Enterprise (x86/x64)

Minimum prerequisites

The following software must already be installed on the target machine in order to successfully run the

ProBase POS installer:

Java Virtual Machine (JavaVM) (at least version 6)

Note: A JavaVM is also required for the installation profiles OPOS Installation, POS for .NET Installation

and CPOS Installation of the product installer. Especially for this the UDM Default Runtime, a Diebold

Nixdorf distribution package of a Java Runtime Engine (JRE) based on OpenJDK 6 is proposed.

The UDM Default Runtime installation package does not install a publicly available JRE and takes some

other security measures (see separate documentation3). The user profile used for the application must

be added to the user group wndev, so that the UDM DefaultRuntime can be executed.

The installation package of the UDM Default Runtime Engine45 (currently available only as 32-bit

version) is provided with the pre-installations or as a separate download.

3 UDM Security Considerations; Diebold Nixdorf; Denis Kuniss; version 1.0

4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems > System oriented Software > Middleware > ProBase POS

5 ProBase POS 2.1 (32-bit) requires the UDM Default Runtime Engine Version 1.1-3 or newer

Page 8: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 8

Additional prerequisites

In case the POS for .NET Installation or 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 .Net Framework (at least version 2.0 up to 4.0)

Microsoft POS for .Net (version 1.12)

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 .Net Framework (at least version 4.0)

Microsoft POS for .Net (version 1.14)

Additional packages might be required to support certain devices (see chapter Installing additional

features).

Product installer variants

The ProBase POS 2 installer is available as a 32-bit and a 64-bit version for Windows operating systems

following the naming scheme:

WN-ProBasePOS-2.<minor-version>.<build-number>-<architecture>.exe

Example:

WN-ProBasePOS-2.9.16-x86.exe

Note: The setup variants of 32 or 64-bit are based on the process architecture of the application or on

the JavaVM architecture to be used. For example when using a 32-bit application/JavaVM on a 64-bit

Windows, the 32-bit ProBase POS Installer must be used.

Installation profiles

The current product installer for Windows operating systems is based on Inno-Setup, which provides the

concept of installation profiles and can be called interactively as well as remote, silent and unattended.

Here a profile is connected to a certain implementation technology, which allows the programmatic

access to peripheral devices. The concept allows the user to choose the appropriate technology for the

application. The installer ensures that all components for the selected profile are installed correctly and

completely, as well as configured. ProBase POS 2 itself is organized internally in components.

If necessary, the user can also make changes to the selection of the components specified by the

preselected profile by 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 does not

work properly.

Page 9: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 9

The following table shows the currently defined profiles in the product installers for Windows:

Profile Name Profile Meaning

JavaPOS Installation Installation for JavaPOS based applications.

(Installer default profile)

OPOS Installation Installation for OPOS based applications.

Forwards OPOS calls to WN’s JavaPOS implementation using the UDM

technology.

POS for .NET 1.12 Installation Installation for POS for .NET 1.12 based applications.

Forwards POS for .NET calls to WN’s JavaPOS implementation using the

UDM technology.

POS for .NET 1.14 Installation Installation for POS for .NET 1.14 based applications.

Forwards POS for .NET calls to WN’s JavaPOS implementation using the

UDM technology.

CPOS Installation Installation for C based applications.

Forwards C calls to WN’s JavaPOS implementation using the UDM

technology.

Custom Installation For adjustments to the component selection, which were selected by the

previously selected installation profile.

Note: Since OPOS generally exists only as a 32-bit API, the profile OPOS Installation is currently only

available in the 32-bit installer!

It is recommended to use the predefined profiles and to carry out a customized installation only after

consultation with the Diebold Nixdorf support team6.

Interactive installation

The product installer supports interactive installation, where the end-user can select interactively:

the installation profile

or a custom installation by selecting/deselecting particular components

the Windows start menu shortcut group

Example: Interactive installation

Note: The installer setup can be cancelled on each step of the process by clicking the [Cancel]

button. If the installation process 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 installer setup if needed.

6 [email protected]

Page 10: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 10

After launching the ProBase POS 2 installer, one of the following welcome-screens will appear.

Dialog: Welcome to Setup Wizard

Click the [Next] button to go on with the setup.

Dialog: License Agreement

Choose [I accept the agreement] after reading.

Click the [Next] button.

Page 11: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 11

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.

Or choose [Custom Installation] and check the features you want to install from the list.

Click the [Next] button.

Page 12: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 12

Dialog: Select Start Menu Folder

Specify a start menu folder for this ProBase POS version.

Click the [Next] button.

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.

Page 13: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 13

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).

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 for post installation actions appearing in this dialog depends on the

selected profile. Typically different JavaPOS configuration alternatives are going to be generated. By

default all check boxes should be remain selected to ensure proper configuration for all parts.

Page 14: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 14

Checkbox Checkbox Meaning

Run initial generation of JavaPOS

configuration written to

‘C:\ProgramData\javapos\all‘

If activated, then the JavaPOS Configurator is started to generate the

JavaPOS configuration(s) "All Device Configuration" and/or "Target

Configuration".

This checkbox is activated by default.

Register UDM Server to be

automatically started on system start

up. (Note: …)

If activated, the startup behavior of the UDM server is changed and the

UDM server is then started at system startup.

Attention: The automatic start after Open() (default behavior of the UDM

server) must also be deactivated. See ProBase POS User Guide

chapter 6.6.1 – UDM server configuration; StartAsChildProcess)

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 activated, then the entire JavaPOS configuration will be imported into

the Windows registry as OPOS configuration.

This checkbox is activated by default.

Silent installation

A silent installation of ProBase POS 2 is possible. For this, the product installer must be called with the

/SILENT parameter via the command line.

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: At silent mode the profile JavaPOS Installation will be installed. If a different selection of

components is required, an unattended installation is to be carried out (see chapter Unattended

installation).

Unattended installation

By using two command line parameters, an unattended installation 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.

Page 15: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 15

Updating to new product version

An already installed ProBase POS product may be updated by a newer version as long as the major

version has not been changed. On an update the profile may change (however, see constraint in the

next sub chapter).

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.

Upgrading of older installations before ProBase POS 2.0

There is no upgrade mechanism for older JavaPOS or ProBase POS versions before version 2.0

available and it is recommended to remove all previous versions of JavaPOS or ProBase POS 1.1.xx

before the installation of ProBase POS 2.x.

Installing additional features

If you need support for USB printers, the WNPOSUSB driver package has to be installed separately.

Please note that the version of WNPOSUSB depends on the Windows version and that WNPOSUSB is

available for the Windows versions starting from Windows XP up to Windows 8.1. Starting with Windows

10, the new DNPOSUSB driver package has to be used.

In addition, if you need support for cash drawers, depending on the POS system, the WN-PORT

package or the WN-CashDrawer-SMBUS package has to be installed separately.

Installing ProBase Retail in parallel

Installing the packages of ProBase Retail and ProBase POS to the same directories may lead to an out

of order situation or limited functionality provided to applications.

Therefore, it is not recommended to install ProBase Retail and ProBase POS in parallel. Currently both

products are not prepared from integration point of view to be installed or being used by one application

in parallel.

Page 16: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 16

Uninstallation of ProBase POS 2 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 for

details.

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 POS Installation-Directory>\Uninstall-WN-ProBasePOS

use the Windows start menu entry Uninstall ProBase POS at the location Start Menu > all programs > Diebold Nixdorf ProBase (xx JVM)

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 won't be created (see chapter Uninstallation log for more details).

Silent uninstallation

Like for the installation, it is also possible to execute the uninstaller silently applying the command line

argument /SILENT or /VERYSILENT.

Example:

"C:\Program Files\javapos\WN-ProBasePOS\Uninstall-WN-ProBasePOS\unins000

.exe" /LOG="C:\ProgramData\javapos\wn\logs\uninstall_PBR.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).

Page 17: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 17

Logging

Installation log

Logging the installation process is always activated. If the installer is not called with the parameter

/LOG="filename", the setup log will be stored in the with %TMP% defined directory with a unique

filename based on the current date Setup Log yyyy-mm-dd #<number>.txt.

Example:

Setup Log 2019-04-16 #002.txt

Note: As post installation action (if not disabled), the JavaPOS configurator will be started to create an

initial configuration. This JavaPOS configurator run will also be logged. The log files for the JavaPOS

configurator are stored within C:\ProgramData\javapos\all.

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 to use the product version number as well as the date and/or the time within the

log file name (e.g. /LOG=%TMP%/Uninstall_<ProBase POS> <Version>.<Build>.%DATE%.log).

Page 18: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

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 help7.

/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

Page 19: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 19

Configuration This chapter provides only some basic information regarding the configuration of ProBase POS. For

more details regarding the configuration, please refer to the related subsections within the ProBase POS

User Guide.

JavaPOS configuration

ProBase POS 2 provides an automated JavaPOS configuration generation to make integration with

JavaPOS applications easier and more convenient, and to ensure that ProBase POS updates become

visible to the application environments immediately after the installation and rebooting the applications.

The automatic configuration is performed by the included JavaPOS Configurator.

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 POS 2, 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 POS installation directory>\bin, the

JavaPOS configurator can be started manually. To write successfully the configuration, the JavaPOS

configurator needs administrator rights.

The JavaPOS Configurator can also be started from the Windows Start menu. By selecting Start > All

Programs > Diebold Nixdorf ProBase POS (xx-bit JVM) > Generate JavaPOS configuration the script

config_javapos_startup.vbs will be started to update the JavaPOS configuration.

Note: If additional packages have been installed or the installed packages have been updated, it is

necessary to rerun the JavaPOS Configurator manually.

It is possible to customize the output of the JavaPOS Configurator by means of an application-specific

configuration file 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 used, or generally all adjustments to JavaPOS configuration parameters.

This application-specific configuration generation leads to a separate JavaPOS configuration file

jpos.xml.

JavaVM configuration

ProBase POS uses JavaPOS as the basis for all driver interfaces. A JavaVM is therefore required for

the use of ProBase POS (see chapter Minimum prerequisites).

Normally, JavaPOS verifies whether a JavaVM version is installed and automatically selects a suitable

one from all found JavaVM versions.

Page 20: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 20

Since ProBase POS 2.3, the user has the option to specify explicitly the JavaVM. To do so, a

configuration file called javahome.ini has to be created under <ProBase POS installation

directory>\config, which then contains the variable JAVA_HOME with the path to the desired JavaVM.

Example:

Content of <ProBase POS Installation Directory>\config\javahome.ini

JAVA_HOME=C:\Program Files (x86)\Java\jre1.8.0_121

OPOS configuration

The device-specific configurations for OPOS are typically stored in the Windows registry. The OPOS

supplied with ProBase POS 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 after

UnifiedPOS.

A modification of the configuration can be done directly in the Windows Registry. For this purpose, the

parameters of the desired OPOS device must be edited below the open name for the device.

Note: Make sure that the changed parameters contain valid values as otherwise incorrect 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. In order for the changes to be permanently stored in the registry, the

registry editor must be called with administrator rights.

Alternatively, the OPOS configuration can also be changed via the provided OPOS Config Tool. This

can be done either with the application HWD55ConfUDM.exe from the directory <ProBase POS

installation directory>\opos\common\bin or via the Windows Start menu with OPOS Configuration

Program under Start > All Programs > Diebold Nixdorf ProBase POS (xx-bit JVM) > OPOS (UDM) >

OPOS Common.

OPOS Configuration Updater

With the installation profile OPOS Installation, a scheduled task for the OPOS UDM Configuration

Updater is set up by the product installer. For this, the Windows tool Task Scheduler will be used. The

name of the task is OPOSUDMConfigurationUpdater and the task is called at every system start and

also every user login. The OPOS configuration, which is stored in the Windows Registry, will be checked

and, if necessary, updated.

Starting with ProBase POS, the OPOS configuration stored in the Windows Registry is based on the

JavaPOS configuration (JavaPOS XML files) provided with ProBase POS. The OPOS Configuration

Updater

does not overwrite existing values,

adds new values.

checks for OPOS UDM OpenNames (all with suffix _UDM), whether corresponding JavaPOS

OpenNames exists. If not, these entries will be deleted.

Page 21: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 21

The OPOS Configuration Updater can be found in the directory <ProBase POS installation

directory>\oposudm\bin as OPOSUDMConfigUpdater.exe and requires administrative rights to write the

entries in the Windows Registry permanently.

Note: The OPOS Configuration Updater is executed automatically after the manual start of the

JavaPOS Configurator. However, we recommend restarting the POS system every time the system

configuration has changed so that the changed settings and affected libraries are reloaded.

P4DN configuration

The configuration of the POS for .NET interface above the UDM server/client can be set/changed using

the tools and methods provided by the POS for .NET Framework from Microsoft.

With the script UDM.posdm.bat provided by ProBase POS under <ProBase POS Installation

Directory>\p4dn112\bin or under <PBP Installation Directory>\p4dn\bin, a simple POS for.NET

configuration can be realized for test purposes. To do this, the script file must be edited and the

references to the JavaPOS OpenNames to be used entered accordingly.

Example:

Part of <ProBase POS Installation Directory>\p4dn112\bin\UDM.posdm.bat

REM configure here the JavaPOS open names you want to use

SET JAVAPOS_BumpBar_NAME=

SET JAVAPOS_CashChanger_NAME=

SET JAVAPOS_CashDrawer_NAME=

SET JAVAPOS_FiscalPrinter_NAME=

SET JAVAPOS_Keylock_NAME=

SET JAVAPOS_LineDisplay_NAME=WN_BA63_USB

SET JAVAPOS_MICR_NAME=

SET JAVAPOS_MSR_NAME=

SET JAVAPOS_POSKeyboard_NAME=

SET JAVAPOS_POSPower_NAME=

SET JAVAPOS_POSPrinter_NAME=WN_TH250_USB

SET JAVAPOS_Scale_NAME=

SET JAVAPOS_Scanner_NAME=

SET JAVAPOS_ToneIndicator_NAME=

SET JAVAPOS_Belt_NAME=

SET JAVAPOS_RFIDScanner_NAME=

Note: The underlying device-specific configuration is the all device configuration of JavaPOS. Further

information can be found in the ProBase POS User Guide chapter 6.1.1 - The JavaPOS Configurator

output.

Page 22: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 22

Verifying the installed configuration

Verifying the JavaPOS installation

The JavaPOS installation comes with a set of tools bunched by a graphical wrapper for user

convenience. This JavaPOS Tool Center is located in the <ProBase POS installation directory> within

the subdirectory \bin as start_probaseToolCenter.bat and can also be started via the Windows start

menu at Start Menu > Diebold Nixdorf ProBase POS (xx JVM) > ProBase Tool Center, where xx can be

32-bit or 64-bit.

The JavaPOS Tool Center looks like following:

Figure 1: Welcome screen of JavaPOS Tool Center

A click to the button [SwingSamples] will start an interactive Java program for testing the access to and

some basic functions of the perihperals. It allows to select a category and an open name, to configure

the port and exposes the JavaPOS API as graphical interface:

Page 23: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 23

Figure 2: JavaPOS Swing Samples

Note: When starting the JavaPOS Tool Center, the configuration “all devices” will be loaded as default

configuration.

With the button8 [Toggle JavaPOS configuration (current is 'all devices')] the configuration can be

switched to the configuration “target configuration”. In this case the JavaPOS Tool Center will be

restarted and will load the customized target configuration. To customize the configuration with the

JavaPOS Configurator please refer to ProBase POS User Guide chapter 6.1 - JavaPOS configuration

for more details. If not done yet, then a sample target configuration will be loaded.

Switching back to the previous configuration is possible by clicking the now changed button [Toggle

JavaPOS configuration (current is 'target configuration')].

8 The button does not exist before ProBase POS 2.2.

Page 24: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 24

Figure 3: Welcome screen of JavaPOS Tool Center – target configuration

Verifying the OPOS installation

The OPOS installation profile comes with an OPOS configuration tool for structured editing of the OPOS

configuration stored at the Windows registry. This tool also provides some basic testing facilities to verify

the configuration and to check the connection to the configured peripheral device.

The OPOS configuration program must be run with administrator rights and is located in the directory

<ProBase POS installation directory>\opos\common\bin as HWD55ConfUDM.exe. It can also be started

over the Windows Start Menu with Start Menu > Diebold Nixdorf ProBase POS (32-bit JVM) > OPOS

UDM > OPOS Common > OPOS Configuration program.

The OPOS configuration program looks like follows:

Page 25: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 25

Figure 4: OPOS Configuration Tool

After having checked and adapted the device configuration by using the category specific tabs, selecting

the requested open name at the drop-down menu [Variants of Peripheral] and modifying the parameter

values, the configuration can be tested by using the button [Test] on the right side of the window. This

will start the test dialog:

Figure 5: OPOS’ simple test tool

Page 26: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 26

After selecting a short cut or device open name at the list box, a click on the button [Run the test] below

the list box will start a simple connection test.

Note: If the test fails on the OPOS DeviceEnabled property access, please check the configuration

and/or the peripheral connections for data and power.

Please Note: OPOS uses the UDM Server. Depending on the UDM Server start behavior configuration,

it may be necessary to start the UDM Server manually.

Verifying the POS for .NET installation

At this time, there is no tool for validating the POS for .NET installation provided with ProBase POS.

However, the application example coming with the Microsoft POS for .NET SDK may be utilized for this.

Note: The intended devices have to be configured beforehand (through modifying the file

UDM.posdm.bat within the directory <ProBase POS Installation Directory>\p4dn\bin, for more details

please refer to chapter P4DN configuration).

Please Note: P4DN uses the UDM Server. Depending on the UDM Server start behavior configuration,

it may be necessary to start the UDM Server manually.

Page 27: INSTALLATION GUIDE ProBase POS 2 - Diebold Nixdorf€¦ · 4 > Intranet > Portfolio > Our Portfolio > Software Solutions > Retail Software Solutions > System Software & Operating

Systems Group Retail Products 27

Frequently asked questions (FAQs) Q: I have a problem that I cannot solve by myself. Where can I get help?

A: Please contact [email protected] and append a description about your

hardware and software configuration as well as all of the created log files. See chapter Logging

for details if you are not sure where to find them. Providing all the log files is important for solving

your problem as quickly and accurately as possible.

Q: Why do I need JavaPOS and a JavaVM to run an OPOS or POS for .NET application?

A: Diebold Nixdorf provides with ProBase POS the UnifiedPOS implementations for POS peripheral

devices only as JavaPOS implementations. However, there are generic mapper implemented

and also part of ProBase POS, which exposes the functionality provided by JavaPOS to the

OPOS and POS for .NET platform such that applications can utilize JavaPOS transparently.

These mapper forwards OPOS and POS for .NET calls to the appropriate JavaPOS method as

remote procedure calls in a client/server architecture (called Unified Device Manager).