user guide probase store 1 - diebold nixdorf

77
USER GUIDE ProBase Store 1 JavaPOS, OPOS, POS for .NET and CPOS April 2020

Upload: others

Post on 23-Mar-2022

28 views

Category:

Documents


2 download

TRANSCRIPT

USER GUIDE

ProBase Store 1 JavaPOS™, OPOS, POS for .NET and CPOS

April 2020

Systems Group Retail Products 2

Imprint

Mathias Janke

Diebold Nixdorf

Systems Group Retail Products

Wohlrabedamm 31

13629 Berlin

[email protected]

Systems Group Retail Products 3

Revision history

Version Date Author Comment/Change

1.0 December 2019 Mathias Janke Initial Version

2.0 January 2020 Mathias Janke Final version based on ProBase Store 1.0

2.1 March 2020 Mathias Janke Typos corrected

3.0 April 2020 Denis Kuniß Version corresponding to ProBase Store 1.1

Systems Group Retail Products 4

Copyright and Trademarks Microsoft and Windows are registered trademarks of Microsoft Corporation.

Diebold Nixdorf and BEETLE are registered trademarks of Diebold Nixdorf, Inc.

Linux is a registered trademark of Linus Torvalds.

Red Hat and CentOS are registered trademarks of Red Hat, Inc.

JavaPOS is a trademark of Sun Microsystems, Inc.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.

iButton is a registered trademark of Maxim Integrated

All other company names and trademarks mentioned in this documentation are the property of their

respective owners.

© Copyright 2020 by Diebold Nixdorf Systems GmbH

Systems Group Retail Products 5

Contents

1 References ................................................................................................................. 7

2 Introduction ............................................................................................................... 8

3 General information .................................................................................................. 9

3.1 Background ..................................................................................................................... 9

3.2 Environment at Diebold Nixdorf ..................................................................................... 10

3.3 License agreement / rights of use .................................................................................. 10

4 Architecture and interfaces .................................................................................... 11

4.1 Unified Device Manager ................................................................................................ 11

4.2 JavaPOS guide line ....................................................................................................... 13

4.3 Product installer ............................................................................................................. 13

5 Specifications .......................................................................................................... 17

5.1 Released installer versions ............................................................................................ 17

5.2 Software requirements ................................................................................................... 17

5.3 Supported peripherals ................................................................................................... 22

5.4 Supported operating systems ........................................................................................ 25

5.5 Supported Java Runtime Environments ......................................................................... 25

5.6 Components included ................................................ Fehler! Textmarke nicht definiert.

5.7 Available add-ons .......................................................................................................... 26

6 Installation of ProBase Store ................................................................................. 27

6.1 Prerequisites ................................................................................................................. 27

6.2 Installation under Windows ............................................................................................ 27

6.3 Installation under Linux .................................................................................................. 32

6.4 Update installation ......................................................................................................... 33

6.5 Upgrade installation ....................................................................................................... 33

7 Uninstallation of ProBase Store ............................................................................ 34

7.1 Uninstallation under Windows ........................................................................................ 34

7.2 Uninstallation under Linux ............................................................................................. 35

8 Configuration ........................................................................................................... 37

Systems Group Retail Products 6

8.1 JavaPOS configuration .................................................................................................. 37

8.2 Java VM configuration ................................................................................................... 40

8.3 OPOS configuration ....................................................................................................... 41

8.4 P4DN configuration ....................................................................................................... 42

8.5 CPOS configuration ....................................................................................................... 43

8.6 UDM configuration ......................................................................................................... 43

8.7 D&S Platform T/SOP configuration ................................................................................ 50

9 Logging .................................................................................................................... 52

9.1 Logging during installation ............................................................................................. 52

9.2 Logging during uninstallation ......................................................................................... 53

9.3 JavaPOS logging ........................................................................................................... 53

9.4 JavaPOS Configurator logging ...................................................................................... 57

9.5 OPOS logging................................................................................................................ 57

9.6 P4DN logging ................................................................................................................ 59

9.7 CPOS logging ................................................................................................................ 59

9.8 UDM logging .................................................................................................................. 59

9.9 D&S Platform T/SOP Logging ........................................................................................ 62

10 Programming examples.......................................................................................... 63

10.1 JPOS ............................................................................................................................. 63

10.2 OPOS ............................................................................................................................ 63

10.3 CPOS ............................................................................................................................ 63

10.4 P4DN ............................................................................................................................. 63

11 Tools ........................................................................................................................ 64

11.1 ProBase/JavaPOS Tool Center ..................................................................................... 64

11.2 OPOS UDM Configuration Updater ............................................................................... 66

11.3 Test tools ....................................................................................................................... 66

11.4 D&S Platform T/SOP ..................................................................................................... 72

11.5 PBReport ....................................................................................................................... 74

12 Appendix .................................................................................................................. 75

12.1 End-user license agreement .......................................................................................... 75

Systems Group Retail Products 7

1 References Diebold Nixdorf. (2016). Guide Line Definition for JavaPOS for Linux OS (version 1.6).

Diebold Nixdorf. (2016). Guide Line Definition for JavaPOS for Windows OS (version 1.3).

Diebold Nixdorf. (2017). JavaPOS Unified Device Manager Programmers & User Guide (version 1/14).

Diebold Nixdorf. (2018). Technical Service and Operation (T/SOP) User Manual (version 1450).

Diebold Nixdorf. (2019). Diagnostics and Serviceability Platform Integration Manual (version 1620).

Diebold Nixdorf. (2019). Installation Guide ProBase Store 1 Linux (version 2.0).

Diebold Nixdorf. (2019). Installation Guide ProBase Store 1 Windows (version 2.0).

Diebold Nixdorf. (2019). ProBase Store 1 Migration Guide (version 1.0).

National Retail Federation. (2014). UnifiedPOS Retail Peripheral Architecture (version 1.14.1).

Russell, J., & Laan, M. (2019). Inno Setup Help. Retrieved from Inno Setup Help:

https://www.jrsoftware.org/ishelp/

Systems Group Retail Products 8

2 Introduction ProBase Store, the new middleware product for retail, is the direct successor to the current middleware

products ProBase Retail 1.x and ProBase POS 2.x and is therefore the middleware product for all active

and future DN Retail products.

The content of ProBase Store largely corresponds to the combination of the two previous products

ProBase POS and ProBase Retail. The UnifiedPOS1 interfaces JavaPOS2, OPOS3 and P4DN for POS

peripherals and JavaPOS for cash recyclers and security scales are included. Test and configuration

tools (such as the JavaPOS Configurator or SwingSamples), released firmware versions for the

supported cash recyclers and the D&S Platform with the graphical user interface T/SOP are also part of

ProBase Store.

Following the DN JavaPOS guideline, ProBase Store, like ProBase POS before it, offers automated

integration of JavaPOS add-ons, automated generation of customizable JavaPOS configurations and

separation of configuration and log files from the installation location of ProBase Store.

A new feature of ProBase Store is the use and delivery of standardized OpenNames to simplify the

relationship between hardware and OpenNames.

This user manual is intended to provide an overview of the functions and tools provided with ProBase

Store. Installation and uninstallation, configuration of the individual software layers as well as logging are

dealt with separately.

Supported operating systems, peripherals and cash recycler as well as requirements regarding the Java

runtime environment, system and device drivers, firmware versions and other software frameworks are

also covered in this manual. However, this information may change slightly for each ProBase Store

version. Therefore, please refer to the release notes of the corresponding ProBase Store version, as

they will provide more up-to-date information in this regard.

1 https://www.omg.org/retail/unified-pos.htm 2 www.javapos.com 3 OPOS - OLE for Retail POS

Systems Group Retail Products 9

3 General information

3.1 Background

The increasing use of Microsoft operating systems on retail market systems as well as the associated

standard OPOS in 1994 had at that time led to the first module-based provision of the peripheral drivers

according to the OPOS standard.

With the emerge of the Java technology to be usable for retail branch solutions and the introduction of

this programming language into the POS application world in 1997, it became necessary for Diebold

Nixdorf to provide the corresponding JavaPOS drivers.

Based on evaluation results on Java, a close cooperation between Diebold Nixdorf and its retail

customers developed in the realization of projects based on Java technology. In the past, JOWE4 (Java

OPOS Wrapper) was the first available software / abstraction layer for controlling retail peripherals from

Java applications under Microsoft Windows operating systems.

At the same time, the standard JavaPOS developed under the proactive cooperation of Diebold Nixdorf

in the relevant committees for this technology approach. On the background of the progress in the

international JavaPOS standardization, the retail market could now also be offered a pure JavaPOS

adapted to the current requirements of the market.

About two years later, the standardization committee decided to meet the requirements for the

synchronization of OPOS and JavaPOS and the standard UnifiedPOS was created. UnifiedPOS is an

acronym for Unified Point of Service (UPOS), which is used to unify the OPOS and JavaPOS interfaces.

UPOS is not really a driver implementation, but rather an abstract interface definition. The conversion of

the definition into usable code as driver for POS applications is OPOS (as ActiveX or ATL objects in the

Microsoft world) and JavaPOS (as JAR modules in the Java world and thus for Windows and Linux

operating systems).

Since 2002, with the introduction of the .NET Framework on Microsoft Windows operating systems,

there has been another technology for application programming and starting 2003 there were requests

for a further implementation of UPOS for .NET based POS applications. This POS for .NET (P4DN)

implementation of the UPOS standard is based on the .NET technology of the Microsoft Windows

operating systems.

The provision of these three driver stacks, which have all been implemented according to the same

design principles, has led to ProBase POS/ProBase Retail and now to ProBase Store. The peripheral

interfaces JavaPOS, OPOS and P4DN will be delivered with ProBase Store in the future.

As a further interface, Diebold Nixdorf also offers the interface CPOS for applications, which were

developed in the programming language C. This is also an implementation according to the UPOS

standard; here the access takes place via the usual methods in the C programming world.

The basis of ProBase Store is the implementation of the UPOS standard for JavaPOS, which is always

the interface to the peripheral devices. The interfaces OPOS and P4DN are supported with

simultaneous use of the so-called Unified Device Manager (UDM).

4 no longer supported

Systems Group Retail Products 10

3.2 Environment at Diebold Nixdorf

ProBase Store can be used on all released DN Retail systems under the ProBase Store approved

operating systems.

The approved operating systems for each DN Retail system can be found within the current configurator

in the DN intranet portal (go to Intranet > Portfolio > Our Portfolio > Services > Configurator/Price list). In

case no access is granted to that site, a Diebold Nixdorf account manager has to be contacted.

Details about the supported systems and peripherals as well as dependencies regarding driver and

firmware versions can generally be found in in chapter 5 - Specifications as well as the respective

ProBase Store Release Notes.

3.3 License agreement / rights of use

The software ProBase Store 1 is subject to license and usage conditions. The exact wording of the End

User License Agreement can be found in the appendix, chapter 12.1 - End-user license agreement.

Systems Group Retail Products 11

4 Architecture and interfaces ProBase Store 1 provides the well-known interfaces JavaPOS, OPOS and POS for .NET (P4DN) as well

as CPOS, an interface for C-based applications, for Windows and Linux based operating systems.

These interfaces are all implementations based on the UnifiedPOS specifications with the following

versions:

JavaPOS 1.13

OPOS 1.13

P4DN 1.13

CPOS 1.13

The base of ProBase Store is the JavaPOS of Diebold Nixdorf. The interfaces OPOS, CPOS and P4DN

are supported if the UDM is used at the same time.

The interfaces OPOS 1.6 and 1.3, JavaPOS 1.7 and 1.5 as well as RDI and LRDI are not supported by

ProBase Store and cannot be operated in parallel with the interfaces of ProBase Store.

Note: OPOS and P4DN are reserved for the Windows operating systems, since the basic technology is

only available under Windows.

Note: ProBase Store contains the JavaPOS controls based on UnifiedPOS 1.14 and supports the POS

for .NET Frameworks 1.12 with the functionality specified with UnifiedPOS 1.12 and the POS for

.NET Framework 1.14 with the functionality specified with UnifiedPOS 1.13.

4.1 Unified Device Manager

The UnifiedPOS standard describes the device interfaces independently to the implementation.

Normally, this is done with a Unified Modeling Language (UML). However, different technologies and

implementations are used in the retail sector, for which some separate appendices have been added to

the UnifiedPOS specification. The most important implementations of the standard are:

OPOS (since 1994)

JavaPOS (since 1998)

POS for .NET (since 2006)

Hardware manufacturers needs to offer all three implementations to support the entire UnifiedPOS

standard. Differences in the implementation technologies and therefore in the methods, properties and

events, as well as differences between Windows and Linux operating systems, can lead to different

behavior of the addressed hardware although the implementations all follow the same standard. Further

requirements of the application developers to support other technologies (for example in the Linux area

further non-Java based API) have not been taken into account yet.

Normally, there is no way to allow an application written in a particular technology to access a

UnifiedPOS device interface written in another technology. This usually requires an adapter or wrapper.

Diebold Nixdorf has developed the Unified Device Manager based on the different implementation

technologies, the different operating system types (Windows and Linux) as well as the different

implementations of the UnifiedPOS standard.

The Unified Device Manager provides a socket-based client-server construct, which uses JavaPOS for

the communication with the hardware and provides all other implementation technologies according to

Systems Group Retail Products 12

the UnifiedPOS standard via generic service objects. This approach is also important for JavaPOS as

soon as the UDM client and the UDM server are to be used on different devices (e.g., mobile POS).

The following figure shows the UDM architecture as it is provided for Windows.

Figure 1: UDM architecture under Windows

The generic service objects convert the method calls of the application into corresponding JavaPOS

calls, just as the answers from JavaPOS are converted back into the target implementation for the

application. For the application itself, the UDM and the shared JavaPOS are presented transparently.

This results in the following advantages for the customer:

An identical behavior of the device services under OPOS, JavaPOS, POS for .NET and CPOS

In the OPOS area, the common controls can be used again

Coexistence of Diebold Nixdorf device services or service objects with those of third-party

manufacturers is possible

UnifiedPOS remains the standard long-term constant

A common software stack for POS peripherals, SCO and ACO systems

Harmonized interfaces for applications such as TP.net, TPiSCAN and retail partner applications

Systems Group Retail Products 13

4.2 JavaPOS guide line

By working with the UPOS standard, it turned out that not everything has been standardized or that

there are no guidelines for the implementation. As a result, Diebold Nixdorf, together with selected

partners and customers, developed a JavaPOS guideline56 that includes the following topics:

Packaging and delivery of JavaPOS components

Configuration of the JavaPOS modules to the desired hardware

Handling additional functions for firmware and device settings

Handling of additional inventory and statistic data by JavaPOS

Integration of JavaPOS components from different manufacturers

Focus of this guideline is to simplify the integration of JavaPOS components from different

manufacturers through uniform installation routines. The integration is not done by copying individual

JAR files, but by referencing them. By embedding the JAR files into compliant installers, they are

automatically updateable without manual adaptation.

Starting with ProBase POS 2 and now with ProBase Store 1 also, Diebold Nixdorf follows this DN

JavaPOS guideline.

The biggest differences to the previous architecture, which was implemented in the ProBase POS 1.1

and ProBase Retail 1.2 versions, can be seen in the various installation paths, the folder structures

contained in them and the locations of files and user data such as JAR files, dynamic link libraries,

shared objects, log files and configuration files defined by the policy. The requirements for the paths to

be used correspond to the usual standards of the operating systems (e.g. Linux -> LSB) plus the

necessary extensions for using the JavaPOS architecture.

To minimize the integrational effort, Diebold Nixdorf provides with the JavaPOS Configurator in ProBase

Store 1 a tool, which generates a common system configuration from the individual JavaPOS

components of several manufacturers generated according to the directive. Using application-specific

configuration files, this system configuration can be further customized by the JavaPOS Configurator.

4.3 Product installer

4.3.1 Variants

ProBase Store 1 product installer are available as 32-bit and 64-bit versions for Windows and Linux

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:

Windows

ProBaseStore-MAJOR.MINOR.BUILD-x64.exe

ProBaseStore-MAJOR.MINOR.BUILD-x86.exe

Linux

5 JavaPOS General Requirements for Linux; Diebold Nixdorf; Peter Duellings; version 1.6 6 JavaPOS General Requirements for Windows; Diebold Nixdorf; Peter Duellings; version 1.3

Systems Group Retail Products 14

dn-probase-store-MAJOR.MINOR.BUILD-i386.rpm

dn-probase-store-MAJOR.MINOR.BUILD-x86_x64.rpm

Example: ProBaseStore-1.0.48-x86.exe

For a detailed listing of supported operating systems, see chapter 5.4 - Supported operating systems.

The currently available ProBase Store installer are listed in chapter 5.1 - Released installer versions.

4.3.2 Installation profiles

Windows

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 or 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 Profile Meaning

JavaPOS Installation

(Cash and POS Peripherals)

Installation profile for JavaPOS based applications.

Supports all Cash recycler and POS peripherals, including D&S

T/SOP.

Note: Installer default profile

JavaPOS Installation

(POS Peripherals)

Installation profile for JavaPOS based applications.

Note: Supports POS peripherals only.

OPOS Installation

(POS Peripherals)

Installation profile for OPOS based applications.

Forwards OPOS calls to DN’s JavaPOS implementation using the

UDM technology.

Note: Supports POS peripherals only.

POS for .NET 1.12 Installation

(POS Peripherals)

Installation profile for POS for .NET 1.12 based applications.

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

the UDM technology.

Note: Supports POS peripherals only.

Systems Group Retail Products 15

Profile Name Profile Meaning

POS for .NET 1.14 Installation

(POS Peripherals)

Installation profile for POS for .NET 1.14 based applications.

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

the UDM technology.

Note: Supports POS peripherals only.

CPOS Installation

(POS Peripherals, for C-applications)

Installation profile for C based applications.

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

technology.

Note: Supports POS peripherals only.

Custom Installation Installation profile for customizing the component selection,

preselected by the previously chosen installation profile.

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

available at the 32-bit installer.

Note: It is recommended to use the predefined profiles and to perform a customized installation only

after consultation with the Diebold Nixdorf support team7.

Linux

The current product installer for Linux operating systems bases on the Red Hat Package Manager

(RPM) and does not provide any profiles. All dependencies to other packages will be checked by the

Package Manager and, if possible, automatically resolved.

The following table provides an overview of the implementations or rather profiles delivered with the

respective product installers, as there are significant differences between the 32- and 64-bit versions,

respectively between the Windows and Linux installers.

API Name Windows 32-bit Java VM

Windows 64-bit Java VM

Linux 32-bit Java VM

Linux 64-bit Java VM

JavaPOS x x x x

OPOS x -

POS for .NET x x

CPOS x x x x

7 GSE; mail to [email protected]

Systems Group Retail Products 16

4.3.3 Default paths

Windows

ProBase Store 1 will be installed in C:\Program Files\javapos\ProBase-Store for architecture identical

installations (e.g. 32-bit on 32-bit Windows) and in C:\Program Files (x86)\javapos\ProBase-Store for

architecture-non-identical installations (32-bit on 64-bit Windows) (in the document further referred to as

<ProBase Store installation directory> or <PBS installation directory>).

User data such as configuration files and log files are stored in subdirectories under

C:\ProgramData\javapos according to the DN JavaPOS guideline.

In the Windows Start menu, the ProBase Store installer adds all links and subfolders in the directory

Diebold Nixdorf ProBase Store (xx JVM) by default. Here xx is equal to 32-bit or 64-bit, depending on

the ProBase Store installer.

Note: Windows 10 does not know multiple level of sub folder within the Start menu.

Linux

On Linux, ProBase Store 1 will be installed in the directory /opt/wn/javapos.

Configuration files are stored in subdirectories under /etc/opt and log files are stored in /var/log/wn

according to the DN JavaPOS guideline.

4.3.4 Special features

ProBase Store 1 not only consist of UnifiedPOS implementations such as JavaPOS, OPOS and P4DN

or the Unified Device Manager, but also offers a range of tools for diagnosis, configuration, testing and

logging purposes. Further information can be found in the chapter 8 - Configuration, 9 - Logging and 11 -

Tools.

In the last stages of the setup the product installer runs per default some of these tools to configure the

previously installed components, creates scheduled respectively auto start tasks or sets up services for

these tools.

Windows

If the OPOS profile or the OPOS UDM adapter in the Custom Installation profile has been selected, the

product installer will call the OPOS UDM Configuration Updater once and set up a permanent task for

the OPOS UDM Configuration Updater in Windows. By default, this task will be executed at each system

start and user login. Further information can be found in chapter 11.2 - OPOS UDM Configuration

Updater.

Note: It is recommended to restart the system after the installation, since the final configuration takes

place in the start phase.

Systems Group Retail Products 17

5 Specifications

5.1 Released installer versions

Windows

ProBaseStore-1.1.102-x86.exe (for 32-bit Java VM)

ProBaseStore-1.1.102-x64.exe (for 64-bit Java VM)

Linux

dn-probase-store-1.1.89-i386.rpm (for 32-bit Java VM)

dn-probase-store-1.1.89-x86_64.rpm (for 64-bit Java VM)

5.2 Software requirements

5.2.1 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 in chapter

5.2.2 - Runtime requirements or within the ProBase Store release notes.

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.

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

For further information, see chapter 5.5 - Supported Java Runtime Environments.

5.2.1.2 Additional preconditions

In case the POS for .NET 1.12 Installation profile (see chapter 4.3.2 - Installation profiles) or

corresponding POS for .NET components have been selected (see chapter 6.2.1 - 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 (see chapter 4.3.2 - Installation profiles) or

corresponding POS for .NET components have been selected (see chapter 6.2.1 - Interactive

installation), ensure that the following software has already been installed on the target machine:

Microsoft Point of Service for .NET (version 1.14)

Systems Group Retail Products 18

Microsoft .NET Framework (at least version 4.0)

5.2.2 Runtime requirements

The conditions described in this chapter only apply to the runtime of ProBase Store components. The

requirements for the installation process can be found in chapter 5.2.1 - Installation requirements or

within the ProBase Store release notes.

5.2.2.1 Minimum precondition

The following software must be installed on the target system to use ProBase Store:

Java Virtual Machine (version 8)

For further information, see chapter 5.5 - Supported Java Runtime Environments.

5.2.2.2 Additional preconditions

In case the POS for .NET 1.12 Installation profile or corresponding POS for .NET components have

been selected during the installation of ProBase Store, the following software has to be installed on the

target machine in order to use the POS for .NET 1.12 API:

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 during the installation of ProBase Store, the following software has to be installed on the

target machine in order to use the POS for .NET 1.14 API:

Microsoft Point of Service for .NET (version 1.14)

Microsoft .NET Framework (at least version 4.0)

5.2.2.3 Driver dependencies

Some devices require additional system driver installed on the target system, which are not part of this

product.

Note: Further information regarding the correct driver version for each ProBase Store version can be

found at the related ProBase Store release notes. The table below may not be actual.

Note: The system drivers are aligned to the bit architecture of the underlying operating system.

Whereas the product is aligned to the bit architecture of the used JRE. This means, the ProBase

Store for 32-bit JVM still requires 64-bit drivers on a 64-bit Windows.

Driver Operating System Affected Devices

probase_fo_usb_drivers_cineo_32bit.msi

(version 1.4.31)

Windows® XP™,

Windows® POSReady 2009™,

32 bit of

Windows® 7™,

Windows® POSReady 7™,

Windows® 8.1™

CINEO C6010, C6020;

iButton, Special Electronics

at ACO and kiosk systems

Systems Group Retail Products 19

probase_fo_usb_drivers_cineo_64bit.msi

(version 1.4.31)

64 bit of Windows® 7™,

Windows® POSReady 7™,

Windows® 8.1™

CINEO C6010, C6020;

iButton, Special Electronics

at ACO and kiosk systems

BNR_USB_Driver_2.1.0.zip

Windows® XP™ SP2,

Windows® 7™,

Windows® 8™,

Windows® POSReady 7™

iCash20

WN_POSUSB_Driver-2.50.0.0-44-setup.exe

Windows® XP™ (32 bit only),

Windows® POSReady 2009™

(32 bit only),

Windows® 8.1™,

Windows® 7™ (64-bit only),

Windows® POSReady 7™

(64-bit only),

non-HID, non-cash USB

devices

DN_POSUSB_Driver-3.00.0.0-3-setup.exe

Windows® 10™

Windows® 7™ (32 bit only),

Windows® POSReady 7™ (32

bit only),

(Note: Windows® 7™ 64-bit

and Windows® POSReady 7™

64-bit are not supported yet,

especially for iCash45!),

non-HID, non-cash USB

devices

CINEO C6010, C6020;

iButton, Special Electronics

at ACO and kiosk systems,

Retail Control Box/Board,

iCash45

DN_CashdrawerSMBus_Driver-1.4.0.0-1-

setup.exe

Windows® XP™ (32 bit only),

Windows® POSReady 2009™

(32 bit only),

Windows® 7™,

Windows® POSReady 7™,

Windows® 8.1

Windows® 10 (64 bit only)

cash drawers at BEETLE

/M-III (Kx, Mx, Ox, Rx

Mainboards)

WN_CashdrawerSMBus_Driver-4.0.10.0-01-

setup

Windows® XP™ (32 bit only),

Windows® POSReady 2009™

(32 bit only),

Windows® 7™,

Windows® POSReady 7™,

Windows® 8.1,

Windows® 10 (64 bit only)

cash drawers at BEETLE

/iPOS+ Advanced, BEETLE

/iPOS+ systems, and

BEETLE A1150 systems

Note: This is a different

driver than the previous one,

despite the same name.

WN_Port_Driver-1.0.0.1-2-setup.exe

Windows® XP™ (32 bit only),

Windows® POSReady 2009™

(32 bit only),

Windows® 7™,

Windows® POSReady 7™,

Windows® 8.1™

Windows® 10 (64 bit only)

cash drawers at BEETLE

/MII+ /SII+, /Express,

/Fusion (and older) systems

w/ mainboards G1, G41, H1,

I1, Jx;

mechanical keylock at PS/2

POS keyboard

Systems Group Retail Products 20

DN_CDC_Virtual_COM_Port-1.0.0.0-2-

setup.exe

Windows® XP™ (32 bit only),

Windows® POSReady 2009™

(32 bit only),

Windows® 7™,

Windows® POSReady 7™,

Windows® 8.1™

Windows® 10 (64 bit only)

iCash30

Note: The driver packages will be provided with the system pre-installations or as a separate download

on the DN website8.

5.2.2.4 Firmware dependencies

The firmware versions listed below are the minimum version for ProBase Store. Newer firmware

versions may work. The respective tested and supported firmware versions can be found in the release

notes of the individual ProBase Store versions.

Note systems

The note systems have been tested with a Diebold Nixdorf test currency data set.

System Component Firmware Version

Booter Version

Remarks

C6010

BVM (MOVE_PWXX)

RM3_POS SELV5

CEL_POS SELV5

SEL_PS

1340

2632

1022

1026

1002

1011

1011

C6020

BVM (MOVE_AWAA)

RM3_ATS SELV5

CEL_ATS SELV5

SEL_PS SELV5

SHUTTER

1341

2632

1022

1026

1050

1002

1011

1011

1010

iCash20 MEI

0130

2000

for standard version of iCash20

and iCash20 with UV sensor

(Russia only)

for standard version of iCash20

Advance9

8 > DN website > SUPPORT > Reference Manuals, Drivers and Firmware Downloads > POS-/Kiosk-Systems,

Peripherals

9 iCash20 Advance = iCash20 with new HW revision level

Systems Group Retail Products 21

iCash40 Firmware

UBA-

500(EUR5)-

SH2-RTQ ID-

003 V101-16

Coin systems

The coin systems have been tested with the EUR currency data set.

System Component Firmware Version

Booter Version

Remarks

C1010 Acceptor Firmware

CLS Firmware

CoinInput Firmware

Hopper Firmware

PowerBoard Firmware

0454.0230

1507.0030

0469.0016

1004.0032

0465.0201

Firmware Bundle 0042

C1030 CM3S-R_FW 1116 Firmware Bundle 58

iCash45 Firmware 1.24

5.2.2.5 T/SOP preconditions

To use T/SOP from the D&S platform, the following software must be installed on the target system:

Java Virtual Machine (version 8)

As ProBase Store does have the same requirement as minimum precondition, no further actions are

necessary for T/SOP as part of the ProBase Store installation.

Note: T/SOP for Windows is currently only available as 32-bit version. In case of the ProBase Store

installer for 64-bit Java VM, a fitting 32-bit Java Runtime is included within the T/SOP

component.

Note: Depending on the function to be used, a user verification via CrypTA stick or smartcard is

required.

Windows

For more information, see the Diagnostics and Serviceability Platform Integration Manual with

INTEGRATIONMANUAL.pdf at <Diagserv installation directory>\doc.

Note: The <Diagserv installation directory> depends on the architecture of the ProBase Store installer

and can either be %ProgramFiles%\Diebold Nixdorf\Diagserv or

%ProgramFiles(x86)%\Diebold Nixdorf\Diagserv.

Linux

Systems Group Retail Products 22

For more information, see the Diagnostics and Serviceability Platform Integration Manual with

INTEGRATIONMANUAL.pdf at <Diagserv installation directory>/doc.

Note: The <Diagserv installation directory> is currently defined as /opt/dn/diagserv.

5.3 Supported peripherals

Below is a list of the devices supported by ProBase Store. Please note that this list may be subject to

minor changes for each ProBase Store version. The list that matches the respective ProBase Store

version is part of the corresponding release notes.

Belt

Belt of DN Portal Scanner

CashChanger

DN cash changer CINEO C1010

DN cash changer CINEO C1020

DN cash changer CINEO C1030

DN cash changer iCASH 15

DN cash changer iCASH 15e

DN cash changer CINEO C6010

DN cash changer CINEO C4060

DN cash changer CINEO C6020

DN cash changer Value Line 0x0x

DN cash changer iCASH 10

DN cash changer iCASH 100

DN cash changer iCASH 20

DN cash changer iCASH 30

DN cash changer iCASH 50

DN cash changer iCASH 40

DN cash changer iCASH 45

CashDrawer

Cash drawer port of DN Modular POS systems

Cash drawer port of DN All-in-One POS systems

Cash drawer port of DN POS printer

Cash drawer port of DN fiscal printer

Cash drawer port of DN Multi I/O Hub

FiscalPrinter

DN fiscal printer MF-TH210 Hungary with AEE

DN fiscal printer MF-TH230+ Hungary with AEE

DN fiscal printer MF-TH230+ Romania (incl. CommModule)

DN fiscal printer MF-TH230+ Italy with FFC

DN fiscal printer MF-TH320 Hungary with AEE

DN fiscal printer TH230-MF Bulgaria (incl. TaxTerminal)

Systems Group Retail Products 23

DN fiscal printer MF-TH250 Bulgaria

DN TSE Germany (web service)

HardTotal

Non-volatile memory mapped on hard drive or flash memory

ItemDispenser

Item dispenser of DN Portal Scanner

Keylock

DN waiter key lock connected to DN POS keyboards

DN key lock connected to DN POS keyboards

DN electronic keylock (OLITRONIC) connected to DN BEETLE /iPOS

DN electronic keylock (OLITRONIC) USB

DN BA8x Waiter Lock (iButton)

DN BA9x Waiter Lock (iButton)

DN electronic keylock (OLITRONIC) connected to DN ACO SEL (special electronic)

DN electronic keylock SKH301-001 connected to BEETLE /iPOS plus

LineDisplay

DN two-line line display BA63

DN four-line line display BA66

DN line display BA63 / BA66 connected to DN POS printer ND77, ND210, TH230, TH230+

DN line display BA63 / BA66 connected via DN fiscal printer MF-TH210 (AEE), MF-TH230+

(AEE and FFC), TH230-MF, MF-TH250, MF-TH320 (AEE)

DN customer display VFD connected to DN BEETLE /iPOS plus

DN virtual line display

MICR

DN two-station thermal printer TH320

DN two-station thermal printer TH420

MotionSensor

DN motion sensor at COM port (RS232)

Sensormatic AMB9010IPS as motion sensor

MSR

DN MSR connected via WN POS keyboards

MSR Nidec Sankyo Corporation ICM330

MSR 213U connected to BEETLE /iPOS plus

DN MSR connected to WN BA7x, BA8x, BA9x, BEETLE /FUSION, BEETLE /iPOS, SNIkey

Systems Group Retail Products 24

POSKeyboard

DN TAxx keyboard with related sub-devices keylock and MSR

DN BA8x keyboard connected to DN BA8x displays

POSPrinter

DN three-station matrix printer ND77

DN single-station matrix printer ND210

DN single-station thermal printer TH180

DN single-station thermal printer TH210

DN single-station thermal printer TH230

DN single-station thermal printer TH230+

DN single-station thermal printer TH250

DN two-station thermal printer TH320

DN two-station thermal printer TH420

DN single-station thermal printer TP07

DN single-station thermal printer TP07c

DN single-station kiosk printer VKP80III

RFIDScanner

DN BA9x NFC/RFID-Reader

Scale

All Bizerba checkout scales named DN WExx

Datalogic Magellan 8202 scanner/scale

Datalogic Magellan 8502 scanner/scale

Shekel security scale

Mettler ARIVA checkout scale

Mettler VIVA checkout scale

Mettler Spider Toledo security scale

Security scales using MT-SICS protocol

Item scales using SASI protocol

Scanner

DN ELxx scanner with WN communication protocol NIXDORF RS232C Mode A or B

DN ELxx scanner with default settings mode according to IBM´s 'USB OEM POS Device

Interface Specification' labelled as 'IBM Hand-held USB' or 'IBM Table Top USB'

Motorola Symbol scanner (formerly Symbol Technologies, Inc.) supporting the WN

communication protocol NIXDORF RS232C Mode A

Motorola Symbol scanner (formerly Symbol Technology, Inc.) that comply with IBM´s 'USB OEM

POS Device Interface Specification", version 1.29

DN BA9x BCR module

Image scanner of DN Portal Scanner

Systems Group Retail Products 25

ToneIndicator

DN internal BEETLE POS system loudspeaker

DN ACO SEL (special electronic) at OPT

DN ACO SEL (special electronic) at CINEO C1030

DN ACO SEL (special electronic) at DN ACO-Kiosk-Box

DN Special Electronic V4

DN ACO SEL (special electronic)

DN ACO SEL (special electronic) at DN SCO compact

DN LED-Status-Box Pole light R/G/B

DN Mini LED Pole light R/G

DN TH250 tone indicator

5.4 Supported operating systems

ProBase Store 1 supports and is released for the following operating systems:

Windows

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)

Linux

WNLPOS 4 (i386/x86_64)

WNLPOS 3 (i386)

5.5 Supported Java Runtime Environments

The installation of ProBase Store supports the following Java runtime environments (JRE):

Oracle JRE (version 8)

OpenJDK (version 8)

Diebold Nixdorf UDM Runtime (version 8)(Windows only)

Note: Newer Java runtime environments (Java 9 and above) are currently not supported.

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, 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 website10.

10 > DN website > SUPPORT > Reference Manuals, Drivers and Firmware Downloads > POS-/Kiosk-Systems,

Peripherals > Software Downloads > ProBase Store Download

Systems Group Retail Products 26

5.6 Available add-ons

Windows

Peripherals Installer

version

Support of

32-bit Java VM

Support of

64-bit Java VM

Scale Transaction Module 1.8.3 x x

Linux

Peripherals Installer

version

Support of

32-bit Java VM

Support of

64-bit Java VM

Scale Transaction Module 1.8.3 x x

Note: The current STM add-on does not support ProBase Store out-of-the-box, but can manually be

adapted. The next version 1.9 of STM will fully support ProBase Store.

Systems Group Retail Products 27

6 Installation

6.1 Prerequisites

The installation of ProBase Store should only be carried out on the operating systems supported by

ProBase Store (see chapter 5.4 - Supported operating systems).

The use of ProBase Store and the installation of ProBase Store require additional software components

and / or frameworks (see chapter 5.2 - Software requirements).

6.2 Installation under Windows

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.

For more information on the installation, refer to the ProBase Store 1 Installation Guide for Windows.

6.2.1 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

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, one of the following welcome screens will appear

Dialog: Welcome to Setup Wizard

Systems Group Retail Products 28

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

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 29

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 30

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 31

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. Typically, the JavaPOS configuration generation check box appears. By

default, all checkboxes should remain selected to ensure correct configuration for all parts.

The following table describes the checkboxes in details:

Checkbox Description

Run initial generation of JavaPOS

configuration written to

‘C:\ProgramData\javapos\all‘

If enabled, the JavaPOS Configurator will be started to generate the

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

Configuration".

Note: This checkbox is activated by default.

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

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.

Systems Group Retail Products 32

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

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 6.2.3 - Unattended installation).

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

6.3 Installation under Linux

The current ProBase Store installer is based on the RPM Package Manager, which is common on “Red

Hat”-based operating systems. Please note that RPM does not natively support an interactive user

mode.

The installation of ProBase Store can normally be started from the desktop with a double click on the

installation package or can be started from the terminal console by using of the following command:

rpm -ihv dn-probase-store-<version number>-<architecture>.rpm

Example:

rpm -ihv dn-probase-store-1.1.89-x86_64.rpm

After the RPM Package Manager has solved all dependencies, the ProBase Store 1 components are

installed. The installation progress and further information will be displayed on the console or the

progress window.

Note: The product installer will always install the complete content including the Diagnostic and

Serviceability platform tool T/SOP, the Unified Device Manager (UDM) server and UDM C-client

with the CPOS API. To use the UDM server, CPOS and T/SOP, further configurations are

required.

Further details on the installation can be found within the ProBase Store 1 Installation Guide for Linux.

Systems Group Retail Products 33

6.4 Update installation

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

between installed version and update does not differ.

Note: Since ProBase Store strictly separates the installation files from user data, all customer-specific

configuration files (javapos.config.properties) are preserved.The derived JavaPOS configuration

will be updated by calling the JavaPOS Configurator, which is necessary after changing the

software components.

Further information can be found in the ProBase Store Installation Guides.

6.5 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 of 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 34

7 Uninstallation

7.1 Uninstallation under Windows

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

7.1.1 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 9.2 - Logging during uninstallation for more

details).

7.1.2 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 9.2

- Logging during uninstallation for more details).

11 http://www.jrsoftware.org/ishelp/

Systems Group Retail Products 35

7.2 Uninstallation under Linux

In order to uninstall ProBase Store 1, the RPM Package Manager is used as in the installation. The

following call on the terminal console deletes all installed ProBase Store components and services, even

if they have been modified subsequently:

rpm –e dn-probase-store-1.<minor version>.<build number>-<architecture>

or

rpm –e dn-probase-store

Example:

rpm –e dn-probase-store-1.1.89-x86_64

On WNLPOS 4 the system tool Software at Applications > System Tools can also be used to remove

ProBase Store. Search for the packages containing dn-pro, uncheck the ProBase Store package and

apply these changes to remove the ProBase Store package.

Figure 2: WNLPOS 4-system tool - Software

Systems Group Retail Products 36

Note: On WNLPOS 3 the system tool is called Add/Remove Software and can be found under

System > Administration. Search for the packages containing dn-pro, uncheck the ProBase

Store package and apply these changes to remove the ProBase Store package.

Figure 3: WNLPOS 3-system tool - Add/Remove Software

Systems Group Retail Products 37

8 Configuration

8.1 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 on Windows or setenv.sh on Linux OS

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.

Windows

With config_javapos_startup.vbs contained in the directory <ProBase Store installation

directory>\bin, the JavaPOS Configurator can be started manually, but has to 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 have to

follow the DN JavaPOS guidelines12.

Linux

With config_javapos_startup.sh contained in the directory <ProBase Store installation directory>/bin,

the JavaPOS Configurator can be started manually, but has to be executed with root privileges to write

the configuration successfully.

Note: If additional packages like ProBase Store add-ons or third party JavaPOS packages have been

installed or the installed packages have been updated, it is necessary to start the JavaPOS

Configurator manually.

Note: For this automated JavaPOS configuration generation to work, the involved packages have to

follow the DN JavaPOS guideline13.

12 JavaPOS General Requirements for Windows; Diebold Nixdorf; Peter Duellings; version 1.3 13 JavaPOS General Requirements for Linux; Diebold Nixdorf; Peter Duellings; version 1.6

Systems Group Retail Products 38

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 needs to 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 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

under Windows or <ProBase Store installation directory>/xml under Linux. In 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.

8.1.1 The JavaPOS Configurator output

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 under

Windows or jpos.xml and setenv.sh of the target configuration in /etc/opt/javapos under Linux.

Note: For reference and test purposes, the JavaPOS Configurator generates or updates an additional

set of configuration files, which are located in the directory C:\ProgramData\javapos\all under

Windows, or /etc/opt/wn/javapos/all under Linux. This configuration includes all available

devices and is hereinafter referred to as the all device configuration.

8.1.2 Customizing the JavaPOS Configurator output

Windows

To customize the output of the JavaPOS Configurator, each of the configuration files

javapos.config.properties must be stored in a separate directory that is meaningfully named after the

application. These directories containing the configuration files have to be located below the directory

C:\ProgramData\javapos.

Note: A template for javapos.config.properties can be found in the directory

C:\ProgramData\javapos\app1.

Linux

In order to customize the output of the JavaPOS configurator, each of the configuration files

javapos.config.properties must be stored in an own directory that is meaningfully named after the

application. These directories containing the configuration files have to be located below the directory

/etc/opt.

Note: A template for javapos.config.properties can be found in the directory /etc/opt/javapos/app1.

8.1.2.1 Customization with javapos.config.properties

The so-called properties file should select all the devices used by the application and contain the

necessary changes to the device configuration parameters

Systems Group Retail Products 39

Note: Only the differences compared to the original configuration as supplied with ProBase Store or

other manufacturer-specific products are necessary.

The file can contain comments (beginning with the comment symbol #) and should contain rows with

<name> - <value> pairs.

Mainly, the file contains two types of information - a definition of used jposEntries for the intended

configuration and definitions of property values for these jposEntries.

Definition of OpenNames

JposEntries are specified by their names (JposEntry property "logicalDeviceName"; also known as

OpenName). In addition, each JposEntry can be assigned a name, which is more convenient for the

application or is used by the application by default.

Syntax:

jpos.names=<Name1>,<Name2>,<Name3>,…

jpos.name.<Name1>=<Original-OpenName1>

jpos.name.<Name2>=<Originalname2>

jpos.name.<Name3>=<Originalname3>

Example:

# this is a comment

jpos.names=printer1,scanner1,cashdrawer1

jpos.name.printer1=DN_POSPrinter_TH250_COM

jpos.name.scanner1=DN_Scanner_Generic_HandHeld_USB

jpos.name.cashdrawer1=DN_CashDrawer_ModularPOS_DEV1

In this example, the application uses OpenNames "printer1", "scanner1" and "cashdrawer1", where the

names "DN_POSPrinter_TH250_COM", "DN_Scanner_Generic_HandHeld_USB" and

"DN_CashDrawer_ModularPOS_DEV1" are the original names as they are defined in the original XML

files supplied by the manufacturer.

Definition of property values

The definition of property values is intended for all JposEntry properties, which differ from the original

values, as defined in the original XML files provided by the manufacturer.

This can be used, for example, if an RS232 device is connected to a different COM port, as defined in

the original XML file, or the signaling time of the scanner must be adjusted.

Syntax:

jposentry.<New-OpenName>.<Property-Name>=<New-Value>

jposentry.<Original-OpenName>.<Property-Name>=<New-Value>

Example:

# this is a comment

Systems Group Retail Products 40

jposentry.scanner1.beepDuration=2

# the POS printer is connected to COM1 instead of COM2

jposentry.DN_POSPrinter_TH250_COM.portName=COM1

# We are using a cash drawer reporting the status in inverted manner

jposentry.cashdrawer1.invertedStatusPolarity=true

Note: By defining property values, you can also define new properties that were not previously

contained in the original XML files. These are then added to the configuration.

Definition of special property values

For individual JPOSEntries, references to other JPOSEntries are defined using special property values.

This is done, for example, in case of so-called Hydra devices like cash drawer connected to the printer

or at keyboards with a defined key table. This applies to the known property values "uses", "keyTable",

"infoUsedBy", "logicalNameMCSIF", "logicalNameTLQIF" and "sHydraProfileName".

The definition of the property value "uses" can contain a prefix (the class name of the referenced

device).

Example:

# Definition of open names:

# jpos.names=printer,cashdrawer

# jpos.name.printer=DN_POSPrinter_TH230_COM

# jpos.name.cashdrawer=DN_CashDrawer_DEV1_POSPrinter_TH230_COM

# Definition of a uses property for the

# DN_CashDrawer_DEV1_POSPrinter_TH230 cashdrawer

# Configuration without the prefix POSPrinter

jposentry.cashdrawer.uses="DN_POSPrinter_TH230_COM"

# Configuration with the prefix POSPrinter

jposentry.WN_CD1_TH320_COM.uses="DN_POSPrinter_TH230_COM"

Note: If these special property values do not contain a reference or a reference that does not exist in

the configuration, a corresponding warning is written to the JavaPOS configurator log.

8.2 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

chapter 5.2 - Software requirements or the release notes.

Normally, JavaPOS checks whether a Java VM is installed and selects a suitable version from all

available Java VM. 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

has to be defined.

Note: If the environment variable is defined then the JRE at the path defined by this variable is used

regardless whether the path points to a valid JRE installation or not.

Systems Group Retail Products 41

8.3 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

accordingly the OLE for POS specification (appendix to the UnifiedPOS specification).

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: In order to store the changes in the registry permanently, the Windows Registry editor must be

called with administrator rights.

Alternatively, the OPOS configuration can also be changed per OPOS Config Tool provided with

ProBase Store. The OPOS configuration tool is located in the directory <ProBase Store installation

directory>\opos\common\bin as HWD55ConfUDM.exe. It can also be started over the Windows Start

Menu as OPOS Configuration program within Start Menu > Diebold Nixdorf ProBase Store (32-bit

JVM) > Programming Platforms > OPOS > OPOS Common .

Systems Group Retail Products 42

Figure 4: OPOS Config Tool

Also in the tool, the devices are grouped into device categories that can be selected from the tabs in the

tool. The device to be changed must be selected from the Variants of Peripheral drop-down list. The

configuration parameters displayed in the list Current Parameters can then be changed via the selection

in Possible Values.

Note: Changing the OPOS configuration with the tool is the recommended way because the

parameters can only contain valid values through the predefined selection.

Note: The OPOS configuration tool must be started with administrator rights so that the changes can

be permanently transferred to the registry.

8.4 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 Store under <ProBase Store installation

directory>\p4dn112\bin or under <ProBase Store 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 must be entered accordingly.

Systems Group Retail Products 43

Example:

Part of <ProBase Store installation directory>\p4dn\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=DN_LineDisplay_BA63_USB

SET JAVAPOS_MICR_NAME=

SET JAVAPOS_MSR_NAME=

SET JAVAPOS_POSKeyboard_NAME=

SET JAVAPOS_POSPower_NAME=

SET JAVAPOS_POSPrinter_NAME=DN_POSPrinter_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 Chapter 8.1.1 - The JavaPOS Configurator output.

8.5 CPOS configuration

The CPOS interface does not have a separate configuration above the UDM server/client. Here, the

JavaPOS configuration is used.

8.6 UDM configuration

ProBase Store uses the Unified Device Manager (UDM), a server-client architecture based on sockets,

in order to be able to provide the OPOS, POS for .NET and CPOS interfaces on the basis of JavaPOS

and, on the other hand, to provide a remote capability. The configuration of the UDM is done on the

UDM server side via call parameters at the start of the UDM server. The UDM client (OPOS, P4DN

and/or CPOS), however, is configured via environment variables.

8.6.1 UDM server configuration

The UDM server delivered with ProBase Store is already configured and ready to use with default

settings for POS systems.

Windows

In order to simplify the integration of the UDM server into the productive system, the UDM server was

configured by default to an automatic startup behavior. The UDM server is automatically started on the

Systems Group Retail Products 44

first open() call on a device from the UDM client. This automatic startup behavior can currently only be

used with OPOS, P4DN and CPOS under Windows.

Note: If this startup behavior is to be changed, the configuration of the corresponding UDM client must

also be changed. Further information can be found in the following chapters 8.6.4 (for CPOS),

8.6.2 (for OPOS) and 8.6.3 (for P4DN).

After changing the startup behavior, the UDM server needs to be started manually via UDMServer.exe

and terminated via StopUDMServer.exe. The executable files start the similar-sounding batch files

UDMServer.exe.bat and StopUDMServer.exe.bat and are stored as well as the batch-files under

<ProBase Store installation directory>\bin.

Note: The batch file StopUDMServer.exe.bat can only stop the UDM server if the same watchfile is

referenced (to be set within the batch-file).

If necessary, the settings for the UDM server can be changed by modifying the script files

UDMServer.setup.bat and UDMServer.exe.bat, stored within the directory <ProBase Store

installation directory>\bin.

The following parameters for the UDM server can be changed in the batch file UDMServer.setup.bat.

Variable/Parameter Meaning

JAVAPOS_DATA_HOME Directory of the JavaPOS configuration.

Default is C:\ProgramData\javapos\wn

UDM_DATA_HOME Directory of the UDM server configuration.

Default is C:\ProgramData\javapos\wn\udmserver

UDM_LOG_FILE Directory and name of the UDM log file.

Default is "%UDM_LOG_HOME%\udm-

server.port%UDM_PORT%.%USERNAME%.log"

UDM_LOG_HOME Directory of the UDM log file.

Default is C:\ProgramData\javapos\wn\log\udm

UDM_NUM_CONNECTIONS Maximum number of parallel connections.

Default is 5

UDM_PORT Defines a port for the TCP/IP socket connection.

Default is 1131

WATCHFILE Directory and name of the UDM server watchfile. Used to restart

automatically the UDM server as long as the file exists.

Default is %UDM_DATA_HOME%\delete_for_stopping_udm

Further parameters for the UDM server can be changed in the batch file UDMServer.exe.bat.

Variable/Parameter Meaning

Systems Group Retail Products 45

UDM_SERVER_LOGGING Enables or disables the logging for the UDM server.

Default is „“ (empty)

Linux

The following parameters for the UDM server can be changed in the shell script udmStartServer.sh in

the directory <ProBase Store installation directory>\bin.

Variable/Parameter Meaning

UDM_HOME Directory of the ProBase Store installation.

Default is /opt/wn/javapos

UDM_VAR_DIR Directory of the UDM log file.

Default is /var/opt/wn/udm

UDM_ETC_DIR Directory of the UDM server configuration;

Default is /etc/opt/wn/jpos-all

UDM_PORT Defines a port for the TCP/IP socket connection.

Default is 1131

WATCHFILE Directory and name of the UDM server watchfile. Used to restart the UDM

server automatically as long as the file exists.

Default is $WATCHFILE_DIR/delete_for_stopping_udm

WATCHFILE_DIR Directory for the UDM Server watchfile.

Default is $UDM_VAR_DIR

With ProBase Store, a daemon/service to manage the UDM server is provided. To start, stop or restart

the UDM server or to query the status of the service the following command needs to be called from the

terminal console.

service wn-udm <start | stop | restart | status>

Example: Start of the UDM servers

service wn-udm start

Note: The UDM server can also be started manually via udmStartServer.sh to be found under

<ProBase Store installation directory>/bin. The UDM server is then started as a process in the

terminal console and can be terminated by closing the terminal console.

8.6.2 UDM client configuration for OPOS

The UDM client for OPOS delivered with ProBase Store is already configured and ready for use with the

standard settings for POS systems.

Systems Group Retail Products 46

In order to simplify the integration of the UDM server into the productive system, the UDM server was

configured by default to an automatic startup behavior. The UDM server is automatically started on the

first open() call on a device from the OPOS UDM client.

If this startup behavior is to be changed, the parameter StartAsChildProcess must be changed in the

Windows Registry under HKLM\SOFTWARE\Wincor Nixdorf\UDM\Server.

For further information, please refer to chapter 5.1.4 of the UDM User Guide under <ProBase Store

installation directory>\doc.

Variable/Parameter Meaning

StartAsChildProcess Enables automatic starting of the UDM server if the parameter is set to a

value of 1 or greater. A value of 0 disables the automatic start and the UDM

server has to be started independently before the application starts. Default

is 1

Note: If this startup behavior is to be changed, the configuration of the UDM server must also be

adjusted. For more information, see chapter 8.6.1 - UDM server configuration.

If necessary, the default settings for the OPOS UDM client can be modified using the environment

variables listed in the table below.

Environment Variable Meaning

WN_JAVAPOS_UDM_LOGFILE Name und path of the log file of the OPOS UDM client.

If “stdout” is used, then the log output will be directed to

standard output (e.g. terminal console on display);

Default is „“ (leer)

WN_JAVAPOS_UDM_PORT The port number of the socket connection of the UDM

server;

Default is 1131

WN_JAVAPOS_UDM_HOST The hostname on which the UDM server is running.

Typically, the application is running on the same system (in

this case it is localhost).

Default is 127.0.0.1

WN_JAVAPOS_UDM_MAXLINE The maximum size (number of characters) that can be

transmitted through the socket connection using a

UnifiedPOS call;

Default is 128.000

WN_JAVAPOS_UDM_MAXSTRINGPROP The maximum size (number of characters) that a string

variable can have during a transmission by means of a

UnifiedPOS call;

Systems Group Retail Products 47

Environment Variable Meaning

Default is 64.000

WN_JAVAPOS_UDM_CONNECTION_TIMEOUT Time in milliseconds that the UDM client waits for a

successful socket connection;

Default is 60.000 ms (= 60 s)

Note: Environment variables can be created or changed temporarily with the command set at the

command line or within the application start script. Environment variables can also be created or

changed permanently via the system tools such as Control Panel > System > Advanced system

settings > Advanced > Environment variables or the Windows Registry.

8.6.3 UDM client configuration for P4DN

The UDM client for P4DN delivered with ProBase Store is already configured and ready for use with the

standard settings for POS systems.

In order to simplify the integration of the UDM server into the productive system, the UDM server was

configured by default to an automatic startup behavior. The UDM server is automatically started on the

first open() call on a device from the UDM client.

If this startup behavior is to be changed, the parameter StartAsChildProcess in the configuration file

P4DNUDMAdapter.config, stored under <ProBase Store installation directory>\p4dn\bin, must be

changed.

Variable/Parameter Meaning

StartAsChildProcess Enables automatic starting of the UDM server if the parameter is set to a

value of 1 or greater. A value of 0 disables the automatic start and the UDM

server has to be started independently before the application starts. Default

is 1

Further information can be found in chapter 5.1.4 of the UDM User Guide stored under <ProBase Store

installation directory>\doc.

Note: If this startup behavior is to be changed, the configuration of the UDM server must also be

adjusted. For more information, see chapter 8.6.1 - UDM server configuration.

If necessary, the default settings for the P4DN UDM client can be changed by changing parameters

within the configuration file P4DNUDMAdapter.config under <ProBase Store installation

directory>\p4dn\bin.

The following parameters are part of the <P4DNUDMAdapter> section within the configuration file.

Parameter Meaning

Systems Group Retail Products 48

port The port number of the socket connection of the UDM

server;

Default is 1131

host The hostname on which the UDM server is running.

Typically, the application is running on the same system (in

this case it is localhost).

Default is 127.0.0.1

reconnectTimeout Time in milliseconds that the UDM client waits for a

successful socket connection;

Default is 4.000 ms (= 4 s)

latencyTime Time in milliseconds, the UDM client waits, before

responding to a connection error with an error message;

Default is 1.000 ms (= 1 s)

ClientCreationStrategy Defines the connection strategy (number of socket

connections) between UDM client and UDM server.

The following parameters are part of the <log4net> section within the configuration file.

Parameter Meaning

file value Name und path of the log file;

Default is „C:\ProgramData\javapos\P4DNUDMAdapter.log“

appendToFile Determines whether the log entries are appended to the

existing file or whether the file is created again;

Default is „true“

level value Defines the log level;

Default is „INFO“

Further information can be found in the POS for .NET UDM adapter documentation

P4DNUDMAdapter.txt stored under <ProBase Store installation directory>\p4dn\doc.

8.6.4 UDM client configuration for CPOS

The UDM client for CPOS delivered with ProBase Store is already configured and ready for use with the

standard settings for POS systems.

If necessary, the default settings for the CPOS UDM client can be modified using the environment

variables listed in the table below.

Environment Variable Meaning

WN_JAVAPOS_UDM_LOGFILE Name und path of the log file of the CPOS UDM client.

Systems Group Retail Products 49

Environment Variable Meaning

If “stdout” is used, then the log output will be directed to

standard output (e.g. terminal console on display);

Default is „“ (leer)

WN_JAVAPOS_UDM_PORT The port number of the socket connection of the UDM

server;

Default is 1131

WN_JAVAPOS_UDM_HOST The hostname on which the UDM server is running.

Typically, the application is running on the same system (in

this case it is localhost).

Default is 127.0.0.1

WN_JAVAPOS_UDM_MAXLINE The maximum size (number of characters) that can be

transmitted through the socket connection using a

UnifiedPOS call;

Default is 128.000

WN_JAVAPOS_UDM_MAXSTRINGPROP The maximum size (number of characters) that a string

variable can have during a transmission by means of a

UnifiedPOS call;

Default is 64.000

WN_JAVAPOS_UDM_CONNECTION_TIMEOUT Time in milliseconds that the UDM client waits for a

successful socket connection;

Default is 60.000 ms (= 60 s)

Windows

Note: On Windows, environment variables can be created or changed temporarily with the command

set at the command line or within the application start script. Environment variables can also be

created or changed permanently via the system tools such as Control Panel > System >

Advanced system settings > Advanced > Environment variables or the Windows Registry.

Linux

Note: On Linux, environment variables can be created or modified easily in the application start script

using the command export. Environment variables can also be stored permanently under

/etc/profile.d in a separate sh- (bash shell) or csh-file (C shell) with an own filename and therein

with the command export. In this case, a system restart is necessary that the changes can take

effect.

Example:

Content of /etc/profile.d/activate-udm-cclient-logging.sh

# Setting the Environment Variable WN_JAVAPOS_UDM_LOGFILE

export WN_JAVAPOS_UDM_LOGFILE=/var/opt/wn/log/udm-cclient.log

Systems Group Retail Products 50

Note: Please make sure that the user does have the necessary execution rights for this script file.

Also, make sure that the logfile-path exists and that the user does have the write rights for

this folder.

Windows

In order to simplify the integration of the UDM server into the productive system, the UDM server was

configured by default to an automatic startup behavior. The UDM server is automatically started on the

first open() call on a device from the CPOS UDM client.

If this startup behavior is to be changed, the parameter StartAsChildProcess must be changed in the

Windows Registry under HKLM\SOFTWARE\Wincor Nixdorf\UDM\Server.

For further information, please refer to chapter 5.1.4 of the UDM User Guide under <ProBase Store

installation directory>\doc.

Variable/Parameter Meaning

StartAsChildProcess Enables automatic starting of the UDM server if the parameter is set to a

value of 1 or greater. A value of 0 disables the automatic start and the UDM

server has to be started independently before the application starts. Default

is 1

Note: If this startup behavior is to be changed, the configuration of the UDM server must also be

adjusted. Further information can be found in chapter 8.6.1 - UDM server configuration.

8.7 D&S Platform T/SOP configuration

The Diagnostics and Serviceability platform offers various setting and configuration parameters, which

are used to vary and control the behavior and the appearance of D&S and T/SOP.

Windows

The main parameters for the configuration are located in the configuration file config.properties in the

directory <Diagserv installation directory>/configuration.

Note: The <Diagserv installation directory> depends on the architecture of the ProBase Store installer

and can either be %ProgramFiles%\Diebold Nixdorf\Diagserv or

%ProgramFiles(x86)%\Diebold Nixdorf\Diagserv.

For more information, see the Diagnostics and Serviceability Platform Integration Manual with

INTEGRATIONMANUAL.pdf at <Diagserv installation directory>\doc.

Linux

The main parameters for the configuration are located in the configuration file config.properties in the

directory <Diagserv installation directory>\configuration.

Note: The <Diagserv installation directory> is currently defined as /opt/dn/diagserv.

Systems Group Retail Products 51

For more information, see the Diagnostics and Serviceability Platform Integration Manual with

INTEGRATIONMANUAL.pdf at <Diagserv installation directory>/doc.

All configuration parameters are set by using key/value pairs. If a configuration key is omitted, the D&S

platform assumes its defined default value. All lines beginning with a # sign will be ignored and can be

used for comments in the configuration file.

Note: After modifications to the configuration file, the D&S platform has to be restarted to make the

changes take effect.

Note: D&S and T/SOP require a Java VM. Depending on the Java VM used, it may be necessary to

make the location known to T/SOP via environment variables.

The logging concept of D&S (server) and T/SOP (GUI) is based on the Logback logging framework. The

configuration of this logging framework is based on XML files, which define the various logging

parameter.

Windows

D&S and T/SOP have their own logging configuration:

logback-diagserv.xml stored in directory

<Diagserv installation directory>\configuration\diagserv

logback-tsopgui.xml stored in directory

<Diagserv installation directory>\configuration\tsopgui

To modify the logging behavior these configuration files have to be adapted appropriately. Each

modification is hot plugged and will have immediate effect after saving the configuration file.

Linux

D&S and T/SOP have their own logging configuration:

logback-diagserv.xml stored in directory

<Diagserv installation directory>/configuration/diagserv

logback-tsopgui.xml stored in directory

<Diagserv installation directory>/configuration/tsopgui

To modify the logging behavior these configuration files have to be adapted appropriately. Each

modification is hot plugged and will have immediate effect after saving the configuration file.

Systems Group Retail Products 52

9 Logging Based on the current implementation of ProBase Store, additional log files of the subjacent software

layers can be required when using the OPOS, P4DN or CPOS API.

Example:

When using OPOS, logs/traces of the following layers can be required:

OPOS (Service Object, Control Object)

UDM Client

UDM Server

JavaPOS (Device Service, Device Controls)

9.1 Logging during installation

Windows

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% directory14 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.

Linux

The current ProBase Store installer is based on RPM Package Manager, which does not provide

additional options to log the installer activities separately. All activities of the RPM package will be

registered within the /var/lib/rpm database. This database can be queried at any time and the output

can be formatted as needed and be saved to a dedicated file.

Note: As post installation action, 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 /var/log/wn/javapos.

14 defined as system and/or user environment variable

Systems Group Retail Products 53

9.2 Logging during uninstallation

Windows

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_<ProBaseStore>-<Version>.<Build>.%DATE%.log).

Linux

Like the installation, the uninstallation has the same logging mechanism. All activities of the ProBase

Store RPM package are registered or de-registered within the /var/lib/rpm database.

9.3 JavaPOS logging

The WN logger named JavaPOS logging is based on the open source logging concept log4j15 and uses

the log4j libraries derived from it in version 1.2.17.

The JavaPOS logging can be activated with different degrees and different depths. It is possible to

define logging globally, for individual device classes or for special devices. It is also possible to use

different log levels, whereby the DEBUG log level should be sufficient.

For more information about the JavaPOS Logging concept, including general and advanced

configuration details, see the documentation LoggingConcept.html under <ProBase Store installation

directory>\doc\html (or <ProBase Store installation directory>/doc/html under Linux).

Windows

The JavaPOS Logging is generally active. The detail level and extent is determined by the WN logger

configuration wn-logger.properties under <ProBase Store installation directory>\config.

To adjust the WN logger output, the following parameters can be modified.

15 http://logging.apache.org/log4j/1.2/

Systems Group Retail Products 54

Parameter Meaning

log4j.appender.rollingfile.File Path and name for the log file;

Default is C:/ProgramData/javapos/wn/log/javapos.log

Note: The path disclosure has to be done with slashes „/“

instead the usual backslashes „\“ (Linux style).

log4j.appender.rollingfile.MaxFileSize The maximum size for the log file;

Default is 1MB

log4j.appender.rollingfile.MaxBackupIndex Maximum number of log file backups for log file rotation;

Default is 10

Linux

The JavaPOS logging is generally active. The detail level and extent is defined by the WN logger

configuration wn-logger.properties under <ProBase Store configuration directory>/config.

To adjust the WN logger output, the following parameters can be modified.

Parameter Meaning

log4j.appender.rollingfile.File Path and name for the log file;

Default is var/log/wn/javapos/javapos.log

log4j.appender.rollingfile.MaxFileSize The maximum size for the log file;

Default is 1MB

log4j.appender.rollingfile.MaxBackupIndex Maximum number of log file backups for log file rotation;

Default is 10

With default settings, the WN-logger records only a few diagnostic information. There are two methods

to enable logging for JavaPOS devices.

1. General activation of the logging for all JavaPOS devices by simply commenting out the line with

log4j.rootLogger=DEBUG, rollingfile and commenting the line with log4j.rootLogger=INFO,

diagnostics.

2. Activate the logging for individual device classes, devices (via the OpenNames) or even individual

JavaPOS layers (Device Controls, Device Services, DCAL) by commenting out the already specified

lines or by adding additional entries according to the rules described within LoggingConcept.html.

Systems Group Retail Products 55

Example:

Activate the logging generally by changing the logging level from the default diagnose INFO

information level to DEBUG information level.

Part of the content of the file <ProBase Store installation directory>\config\wn-logger.properties

#########################################################################

# the diagnostic logging configuration is always on by default

#log4j.rootLogger=INFO, diagnostics

# for enabling extensive logging for all devices, comment the following

line in and the line above out

log4j.rootLogger=DEBUG, rollingfile

#########################################################################

Example:

Activate the logging for individual device classes, here POSKeyboard and POSPrinter.

Part of the content of the file <ProBase Store installation directory>\config\wn-logger.properties

...

#########################################################################

# For enabling the logging for a particular JavaPOS device our logger

names are built from the UnifiedPOS programmatic category name, e.g.

POSPrinter, and the open name from the JavaPOS configuration. Let the

rootLogger untouched then.

# So, the configuration patter for enabling the DEBUG logging for a

particular device is:

# log4j.logger.<UPOS category name>.<open name>=DEBUG[,<list of

appenders>]

# e.g., log4j.logger.POSPrinter.DN_POSPrinter_TH230_COM=DEBUG, rollingfile

#########################################################################

# If you have only one device per category the easiest way to enable

extensive logging for a particular device only is by commenting in the

particular category specific line below

...

# log4j.logger.PINPad=DEBUG, rollingfile

# log4j.logger.PointCardRW=DEBUG, rollingfile

log4j.logger.POSKeyboard=DEBUG, rollingfile

# log4j.logger.POSPower=DEBUG, rollingfile

log4j.logger.POSPrinter=DEBUG, rollingfile

...

Example:

Systems Group Retail Products 56

Activate the logging especially for the POS printer TH230 COM and the line display BA63 COM.

Part of the content of the file <ProBase Store installation directory>\config\wn-logger.properties

...

#########################################################################

# If you have only one device per category the easiest way to enable

extensive logging for a particular device only is by commenting in the

particular category specific line below

...

log4j.logger.LineDisplay.DN_LineDisplay_BA63_COM=DEBUG, rollingfile

...

log4j.logger.POSPrinter.DN_POSPrinter_TH230_COM=DEBUG, rollingfile

...

Systems Group Retail Products 57

9.4 JavaPOS Configurator logging

The JavaPOS Configurator, a small Java program, generates information about the configuration

generation at each call and forwards it to stdout. ProBase Store provides various scripts to access the

JavaPOS Configurator and to write the output of the JavaPOS Configurator into defined log files.

Windows

The output of the JavaPOS Configurator, called by the batch script config_javapos_startup.bat, is still

directed to stdout. Only the vbs script config_javapos_startup.vbs directs the output of the JavaPOS

Configurator to the defined log-file.

The output from the JavaPOS Configurator is then written into the log file

config_javapos_startup.bat.log under C:\ProgramData\javapos\wn\log.

Linux

The output from the JavaPOS Configurator is written into the log file config_javapos_startup.sh.log under /var/log/wn/javapos by the (bash) shell-script config_javapos_startup.sh.

At the end of each ProBase Store 1 installation, the JavaPOS Configurator will be executed as a post-install action to create an initial JavaPOS configuration. This option is activated by default. The log files generated during installation differ from the normal log files of the JavaPOS Configurator in the name. As a result, these log files are not overwritten by the normal calls of the JavaPOS Configurator.

Windows

The output from the JavaPOS Configurator during the installation is written into the log file

config_javapos_startup.bat.log under C:\ProgramData\javapos\wn\log.

Linux

The output from the JavaPOS Configurator during the installation is written into the log file

install_run_config_javapos_startup.sh.log under var/log/wn/javapos.

9.5 OPOS logging

The tracing for OPOS devices can, like the configuration, be set either directly in the Windows Registry

or with the OPOS Config Tool. The tracing configuration for the individual OPOS Service Objects is

stored within the Registry below the subkey \OLEforRetail\ServiceOPOS and for the OPOS Control

Objects below the subkey \OLEforRetail\ControlOPOS.

To activate the appropriate tracing, the parameter Level must be changed to a value greater than 0. The

parameter FileName can be used to adjust the path and filename for the trace file.

Example:

Tracing activated at the OPOS Service Object for POSPrinter TH230

[HKLM\SOFTWARE\OLEforRetail\ServiceOPOS\POSPrinter\WN_TH230_USB_UDM\Trace]

"FileLenMax"="1024"

"FileName"="C:\Temp\SO_POSPrinter_UDM.txt"

"Level"="1"

Systems Group Retail Products 58

Example:

Tracing activated at the OPOS Control Object for POSPrinter

[HKLM\SOFTWARE\OLEforRetail\ControlOPOS\POSPrinter\Trace]

"FileLenMax"="1024"

"FileName"="C:\Temp\CO_Ptr.txt"

"Level"="1"

Note: In order for the changes to be stored permanently in the registry, the registry editor must be

called with administrator rights.

Alternatively, the tracing for the OPOS devices can also be changed either with the application

HWD55ConfUDM.exe from the directory <ProBase Store installation directory>\opos\common\bin or

via the Windows Start menu with OPOS Configuration Program under Start Menu > All Programs >

Diebold Nixdorf ProBase Store (xx-bit JVM) > OPOS (UDM) > OPOS Common.

Figure 5: OPOS Config Tool

Systems Group Retail Products 59

The ServiceObject Trace Information and ControlObject Trace Information sections can be used to

enable the tracing for the current device or the used control object, and to modify the output.

To activate the appropriate tracing, the parameter Level must be changed to a value greater than 0. The

parameter FileName can be used to adjust the path and filename for the trace file.

Note: The OPOS configuration tool must be started with administrator rights so that the changes are

permanently transferred to the registry.

9.6 P4DN logging

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

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

9.7 CPOS logging

The CPOS interface does not have separate logging above the UDM server/client because the

application directly uses the UDM C-client layer.

9.8 UDM logging

9.8.1 UDM server logging

Windows

The logging for the UDM server can be activated in the batch file UDMServer.exe.bat in the directory

<ProBase Store installation directory>\bin.

Variable/Parameter Meaning

UDM_SERVER_LOGGING Enables or disables the logging for the UDM server;

Default is „“ (empty)

The name and directory for the log file of the UDM server can be changed in the batch file

UDMServer.setup.bat in the directory <ProBase Store installation directory>\bin.

Variable/Parameter Meaning

UDM_LOG_FILE Directory and name of the UDM log file.

Default is "%UDM_LOG_HOME%\udm-

server.port%UDM_PORT%.%USERNAME%.log"

UDM_LOG_HOME Directory of the UDM log file.

Default is C:\ProgramData\javapos\wn\log\udm

Systems Group Retail Products 60

Note: If the startup behavior of the UDM server has been changed in the Windows registry, the logging

of the UDM server can also be configured in the Windows registry. For further information,

please refer to chapter 5.1.4 of the UDM User Guide under <ProBase Store installation

directory>\doc.

Linux

The logging for the UDM server can be activated with the shell script setlogging_udmserver.sh from

the directory <ProBase Store installation directory>/bin. Two log-levels are possible, which are

passed to the script via parameter with the value 1 or 2. The meaning of the values is as follows.

1 disables logging / activates normal logging

2 enables extended logging

Example:

Call of the shell script from the terminal

sh setlogging_udmserver.sh 1

Note: The log file wn-udm.log is written to /var/opt/wn and automatically rotated by means of log file

rotation.

9.8.2 UDM client logging - OPOS

The logging for the UDM client for OPOS is activated and configured with the environment variable

WN_JAVAPOS_UDM_LOGFILE.

Environment Variable Meaning

WN_JAVAPOS_UDM_LOGFILE Name und path of the log file of the UDM C-client.

If “stdout” is used, then the logging output will be directed to standard

output (e.g. terminal console on display);

Default is „“ (leer)

Note: On Windows, environment variables can be created or changed temporarily with the command

set at the command line or within the application start script. Environment variables can also be

created or changed permanently via the system tools such as Control Panel > System >

Advanced system settings > Advanced > Environment variables or the Windows Registry.

9.8.3 UDM client logging – P4DN

The logging settings for the UDM client for P4DN are consolidated in the section <log4net> within the

configuration file P4DNUDMAdapter.config under <ProBase Store installation directory>\p4dn\bin.

Parameter Meaning

file value Name und path of the log file;

Default is „C:\ProgramData\javapos\wn\log\P4DNUDMAdapter.log“

Systems Group Retail Products 61

appendToFile Determines whether the log entries are appended to the existing file or

whether the file is created again;

Default is „true“

level value Defines the log level;

Default is „INFO“

For more information, see the P4DN UDM adapter documentation P4DNUDMAdapter.txt under

<ProBase Store installation directory>\p4dn\doc.

9.8.4 UDM client logging – CPOS

The logging for the UDM client for CPOS is activated and configured with the environment variable

WN_JAVAPOS_UDM_LOGFILE.

Environment Variable Meaning

WN_JAVAPOS_UDM_LOGFILE Name und path of the log file of the UDM C-client.

If “stdout” is used, then the logging output will be directed to standard

output (e.g. terminal console on display);

Default is „“ (leer)

Windows

Note: On Windows, environment variables can be created or changed temporarily with the command

set at the command line or within the application start script. Environment variables can also be

created or changed permanently via the system tools such as Control Panel > System >

Advanced system settings > Advanced > Environment variables or the Windows Registry.

Linux

Note: On Linux, environment variables can be created or modified easily in the application start script

using the command export. Environment variables can also be stored permanently under

/etc/profile.d in a separate sh- (bash shell) or csh-file (C shell) with an own filename and which

contains the command export. In this case, a system restart is necessary that the changes can

take effect.

Example:

Content of /etc/profile.d/activate-udm-cclient-logging.sh

# Setting the Environment Variable WN_JAVAPOS_UDM_LOGFILE

export WN_JAVAPOS_UDM_LOGFILE=/var/opt/wn/log/udm-cclient.log

Note: Please make sure that this script file does have the necessary user rights for execution. Also,

make sure that the logfile-path exists and has the necessary write rights for the user. User rights

can be changed with the command chmod.

Systems Group Retail Products 62

9.9 D&S Platform T/SOP Logging

The logging concept of D&S (server) and T/SOP (GUI) is based on the Logback logging framework. The

configuration of this logging framework is based on XML files, which define the various logging

parameter.

Windows

D&S and T/SOP have their own logging configuration:

logback-diagserv.xml stored in directory <Diagserv installation

directory>\configuration\diagserv

logback-tsopgui.xml stored in directory <Diagserv installation

directory>\configuration\tsopgui

Note: The <Diagserv installation directory> depends on the architecture of the ProBase Store installer

and can either be %ProgramFiles%\Diebold Nixdorf\Diagserv or

%ProgramFiles(x86)%\Diebold Nixdorf\Diagserv.

To modify the logging behavior these configuration files have to be adapted appropriately. Each

modification is hot plugged and will have immediate effect after saving the configuration file.

For more information, see the Diagnostics and Serviceability Platform Integration Manual with

INTEGRATIONMANUAL.pdf at <Diagserv installation directory>\doc.

Linux

D&S and T/SOP have their own logging configuration:

logback-diagserv.xml stored in directory <Diagserv installation

directory>/configuration/diagserv

logback-tsopgui.xml stored in directory <Diagserv installation

directory>/configuration/tsopgui

Note: The <> under Linux is currently defined as /opt/dn/diagserv.

To modify the logging behavior these configuration files have to be adapted appropriately. Each

modification is hot plugged and will have immediate effect after saving the configuration file.

For more information, see the Diagnostics and Serviceability Platform Integration Manual with

INTEGRATIONMANUAL.pdf at <Diagserv installation directory>/doc.

Systems Group Retail Products 63

10 Programming examples ProBase Store also provides programming examples for the interfaces JavaPOS, OPOS and CPOS.

These are only intended as an aid to the application developer and do not claim to be complete and

correct.

10.1 JPOS

Windows

The JavaPOS programming examples are located in the directory <ProBase Store installation

directory>\doc\examples.

Linux

The JavaPOS programming examples are located in the directory <ProBase Store installation

directory>/doc/examples.

10.2 OPOS

The OPOS programming examples are located in the directory <ProBase Store installation

directory>\opos\common\Samples.

10.3 CPOS

Windows

The CPOS programming examples are located in the directory <ProBase Store installation

directory>\cpos-udm\samples.

Linux

The CPOS programming examples are located in the directory <ProBase Store installation

directory>/cpos-udm/samples.

10.4 P4DN

The POS for .NET programming examples are located in the directory <ProBase Store installation

directory>\p4dn\doc\examples.

Systems Group Retail Products 64

11 Tools

11.1 ProBase/JavaPOS Tool Center

The ProBase or JavaPOS Tool Center is a central hub for all the JavaPOS configuration and test tools

provided with ProBase Store. Additional submenus or the corresponding tools can be started via the

respective buttons. The JavaPOS configuration loaded with the JavaPOS Tool Center startup is basis

for most of these tools.

Windows

The ProBase Tool Center can be started either from the Windows Start menu at Start Menu > All

Programs > Diebold Nixdorf ProBase (xx JVM) > Tools > ProBase Tool Center or directly with the

batch file start_probaseToolCenter.bat from the directory <ProBase Store installation directory>\bin.

Linux

The JavaPOS Tool Center can be started directly with the Shell-script start_probaseToolCenter.sh

from the directory <ProBase Store installation directory>/bin.

The ProBase/JavaPOS Tool Center is then presented as follows.

Figure 6: ProBase Tool Center

Systems Group Retail Products 65

The most important functions/tools would be:

Logging Configuration

SwingSamples

Toggle JavaPOS Configuration

11.1.1 Logging Configuration

The Logging Configurator makes it possible to modify the JavaPOS logging configuration file using a

graphical user interface.

After the start, the Logging Configurator then presents itself as follows.

Figure 7: Logging Configurator – Simple Mode

As described in chapter 9.3 - JavaPOS logging, the JavaPOS logging is generally activated. The depth

and scope can be adapted to the requirements by appropriate configuration. The Logging Configurator

helps to adjust the JavaPOS logging configuration file via a graphical user interface. There are two

modes for this purpose - the simple mode, which allows maximum settings at the OpenName level, or

the expert mode, in which the complete scope of JavaPOS logging can be configured.

Note: Currently the Logging Configurator only works if a target configuration is available.

For more information about the JavaPOS Logging concept, including general and advanced

configuration details, see the documentation LoggingConcept.html under <ProBase Store installation

directory>\doc\html (or <ProBase Store installation directory>/doc/html under Linux).

11.1.2 JCL Editor

The JCL editor allows modifying JavaPOS XML configuration files (original, as well as the result from the

JavaPOS Configurator).

Systems Group Retail Products 66

With the use of the JavaPOS Configurator and the application-specific configuration file

javapos.config.properties, this editor is no longer necessary and should not be used any further.

Changes to the original JavaPOS XML configuration files would be lost in a SW update and changes to

the JavaPOS Configurator result would be lost after a restart from the JavaPOS Configurator. For more

information, see chapter 8.1 - JavaPOS configuration.

11.1.3 Toggle JavaPOS configuration

The Toggle JavaPOS configuration () button switches between the JavaPOS configurations all device

configuration and target configuration. The JavaPOS configuration selected is then loaded and all tools

started by the ToolCenter will then be restarted with the new configuration.

The JavaPOS configuration used by the POS application is not affected.

11.1.4 SwingSamples

The tool JavaPOS SwingSamples is a basic test tool to test and visualize the basic communication as

well as class-specific basic methods with the peripheral devices via JavaPOS. The most important

UnifiedPOS properties, methods and events are used here.

Note: This tool does not claim to be a complete implementation of the UnifiedPOS specification.

11.2 OPOS UDM Configuration Updater

With the installation profile OPOS Installation, a planned 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 as well as on

every user login. The OPOS configuration, which is stored in the Windows Registry, is checked and, if

necessary, updated.

With ProBase Store, this OPOS configuration in the Windows Registry is based on the JavaPOS XML

files provided with ProBase Store. 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.

The OPOS Configuration Updater can be found in the directory <ProBase Store 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

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

11.3 Test tools

11.3.1 SwingSamples

The SwingSamples are a basic test tool to test the selected JavaPOS configuration for the respective

peripheral devices. For this purpose, category-specific basic methods are offered for the peripheral

devices.

Note: The test scope of SwingSamples does not cover all methods defined in UnifiedPOS.

Systems Group Retail Products 67

The SwingSamples can be started either via the Tool Center (see chapter 11.1 - ProBase/JavaPOS

Tool Center) or directly via the respective call scripts.

Windows

<ProBase Store installation directory>\bin\start_jartpack.bat

Linux

<ProBase Store installation directory >/bin/start_jartpack.sh

Note: Calling the SwingSamples directly via the scripts will start the SwingSamples with the target

configuration.

After the start, the SwingSamples then presents itself as follows.

Figure 8: JavaPOS SwingSamples

After selecting a device category, a JavaPOS device (OpenName) and possibly necessary

communication port parameters, either a simple test or an extended test can be called. In order to start

the extended test, the checkbox for [Extended Test] has to be selected. The test is started by clicking

[Submit].

Systems Group Retail Products 68

The Simple Test mode

Figure 9: SwingSamples - Simple Test

By clicking on the button [TEST: "WN_TH230_U1_USB"] (or similar with other JavaPOS devices) the

simple test can be executed. The result is displayed in the box below.

Systems Group Retail Products 69

The Extended Test mode:

Figure 10: SwingSamples - Extended Test

The extended test mode is somewhat more complex and thus offers better test and analysis

possibilities.

Each test usually begins by clicking [open], clicking [claim], and checking the [DeviceEnabled] checkbox.

In a few cases, the device classes do not support the claim() command, so that must be omitted.

Afterwards the other offered methods can be used for testing.

11.3.2 OPOS Config Tool

A simple communication test is also provided with the OPOS Config Tool to check the basic device

interface configuration directly.

The OPOS configuration tool is located in the directory <ProBase Store installation

directory>\opos\common\bin as HWD55ConfUDM.exe. It can also be started over the Windows Start

Menu as OPOS Configuration program within Start Menu > Diebold Nixdorf ProBase Store (32-bit

JVM) > Programming Platforms > OPOS > OPOS Common .

After the start, the OPOS Config Tool presents itself as follows.

Systems Group Retail Products 70

Figure 11: OPOS Config Tool

Clicking [TEST] starts a new dialog window.

Figure 12: OPOS Config Tool - Simple Test

After selecting a device category and an OpenName from the list, a simple communication test for the

selected device can be started using [Run the test]. The test result is displayed in the box below.

Systems Group Retail Products 71

11.3.3 OPOS Sample Programs

The following class-specific OPOS Sample Programs are delivered and offered with ProBase Store.

TestSample FiscalPrinter

TestSample HardTotals

TestSample Keyboard Keylock MSR

TestSample LineDisplay

TestSample Printer CashDrawer MICR LineDisplay

TestSample Scale

TestSample ScaleTransaction

TestSample Scanner

TestSample UPS

You can start the OPOS test samples (using the example of the test sample for fiscal printers) either via

the Windows Start menu with Start menu > All Programs > Diebold Nixdorf ProBase (xx JVM) >

Programming Platforms > OPOS > OPOS Common > TestSample FiscalPrinter or directly via the

executable FPrinter.exe under <ProBase Store installation

directory>\opos\common\Samples\FiscalPrinter.

The OPOS test sample then presents itself as follows.

Figure 13: OPOS TestSample - Fiscal Printer

Each test usually begins by choosing an OpenName, and then clicking [Open], clicking [Claim], and

checking the [DeviceEnabled] checkbox. In a few cases, the device classes do not support the claim()

command, so that must be omitted. Afterwards the other offered methods can be used for testing.

For the other test tools, it is analogous.

Systems Group Retail Products 72

11.3.4 P4DN test tool – Microsoft POS Tester

ProBase Store does not provide a stand-alone test tool for the POS for .NET API. Here the tool

Microsoft POS Tester from the POS for .NET Framework from Microsoft is to use.

Please note that the test tool is only available if the POS for .NET SDK has been installed by the POS

for .NET Framework Installer.

The Microsoft POS Tester can only be started via the TestApp.exe application under

%ProgramFiles%\Microsoft Point Of Service\SDK\Samples\Sample Application respectively under

%ProgramFiles(x86)%\Microsoft Point Of Service\SDK\Samples\Sample Application.

The Microsoft POS Tester then presents itself as follows.

Figure 14: Microsoft POS Tester (P4DN test tool)

Each test usually begins by choosing an OpenName, and then clicking [Open], clicking [Claim], and

checking the [DeviceEnabled] checkbox. In a few cases, the device classes do not support the claim()

command, so that must be omitted. Afterwards, the offered, dynamically appearing methods can be

used for testing.

11.4 D&S Platform T/SOP

The Diagnostics & Serviceability (D&S) platform is a client/server application consisting of a server

component called D&S and a user interface called T/SOP. The D&S is a daemon process running in the

background, collecting all necessary information to provide additional benefit to the user. T/SOP instead

is a user interface displaying the provided information to the user. T/SOP can be started at any point

while D&S is running. Either it can be started as an independently running application, or it can act as a

service-providing application that is started by another application (e.g., another SOP).

Windows

Systems Group Retail Products 73

T/SOP can be started either from the Windows Start menu at Start Menu > All Programs > Diebold

Nixdorf ProBase (xx JVM) > Tools > Diagnostic and Serviceability Platform > TSOP or directly with

the executable tsopstart.exe from the directory <Diagserv installation directory>\bin.

Note: The <Diagserv installation directory> depends on the architecture of the ProBase Store installer

and can either be %ProgramFiles%\Diebold Nixdorf\Diagserv or

%ProgramFiles(x86)%\Diebold Nixdorf\Diagserv.

Linux

T/SOP can be started directly with the Shell-script tsopstart.sh respectively tsopstart_x64.sh from the

directory /opt/dn/diagserv/bin.

Depending on the configured devices, T/SOP may then presents as follows.

Figure 15: T/SOP

Note: The D&S service needs to be started before T/SOP.

For more information about the usage and features of T/SOP, see the Technical Service and Operation

(T/SOP) User Manual with USERMANUAL_PROBASE_RETAIL.pdf at %ProgramFiles%\Diebold

Nixdorf\Diagserv\doc respectively %ProgramFiles(x86)%\Diebold Nixdorf\Diagserv\doc under

Windows or at /opt/dn/diagserv/doc under Linux.

Systems Group Retail Products 74

11.5 PBReport

PBReport is a small pre-configured command line tool for gathering all relevant log files, configuration

files as well as configuration information for the installed DN platform software e.g. ProBase Store to

help with the analysis of a problem reported.

This tool may be started from other applications (e.g. T/SOP), but can also be started manually.

Windows

To run PBReport, call pbreport.cmd from the directory <PBReport installation directory> at the

command line.

PBReport generates an archive file named PBReport.7z and stores this archive at the location defined

within the command line script pbreport.cmd. At default, the location is defined with

%ProgramData%\Diebold Nixdorf\RSS\PBReport.

Note: Starting PBReport with the executable instead of the command line script will save the output at

<PBReport installation directory>\log\PBreport.

Linux

To run PBReport, call pbreport.py from the directory /opt/dn/pbreport at the terminal. The complete

command may include several parameter as well as the sudo command.

sudo pbreport.py [-d] [-l] [-i] [-h]

For further information, see the PBReport documentation at opt/dn/pbreport/pbreport.html.

Note: The sudoers configuration comes with the RPM package. With the preceding sudo, pbreport

starts with root privileges. For collecting /var/log/messages and other system relevant files, root

privileges are required. Furthermore, the user calling sudo must be part of the group wndev.

Systems Group Retail Products 75

12 Appendix

12.1 End-user license agreement

End-User License Agreement ProBase Store IMPORTANT - READ CAREFULLY

This End User License Agreement ("EULA") is a legal agreement between the licensee, either an

individual or a single entity (“you”) and Wincor Nixdorf International GmbH (“Diebold Nixdorf”) for the

Diebold Nixdorf Software that accompanies this EULA as well as possibly associated media, related

documentation and Internet-based services ("Software"). An amendment or addendum to this EULA

may accompany the Software. YOU AGREE TO BE BOUND BY THE TERMS OF THIS EULA BY

DOWNLOADING, INSTALLING, COPYING, OR USING THE SOFTWARE. DO NOT INSTALL, COPY,

OR USE THE SOFTWARE, IF YOU DO NOT AGREE.

1. GRANT OF LICENSE.

Intellectual property rights in the Software are owned by Diebold Nixdorf and made available to you

under a restricted license as set out in this EULA. Any rights not expressly granted are reserved by

Diebold Nixdorf.

Diebold Nixdorf grants you the following rights provided that you comply with all terms and conditions of

this EULA:

Diebold Nixdorf grants you a non-exclusive, non-transferable right to permanent use of the Software

only in conjunction with hardware products from Diebold Nixdorf. Use of the Software in conjunction

with non-Diebold Nixdorf hardware products is not permitted hereunder.

You may copy the Software for data protection, archiving and backup purposes. However, only the

strictly necessary amount of backup copies may ever be stored.

You may enhance the Software with third party software via the defined interfaces.

In case you received the Software together with hardware of Diebold Nixdorf, you may only transfer

the right of use granted to you to a third party only in full and together with ownership of the

hardware supplied with it and/or ownership of the original data carrier supplied by Diebold Nixdorf

and only in full acknowledge of this EULA by the third party.

2. OTHER RIGHTS AND LIMITATIONS.

You hereby expressly guarantee that you will not copy, modify, rent, sale, distribute or transfer any part

of the Software except within the scope of the rights of use granted within this EULA.

3. RESERVATION OF RIGHTS AND OWNERSHIP.

Diebold Nixdorf or its suppliers own the title, copyright, and other intellectual property rights in the

Software. The Software is protected by copyright and other intellectual property laws and treaties.

Diebold Nixdorf reserves all rights not expressly granted to you in this EULA. This EULA does not grant

you any rights to trademarks of Diebold Nixdorf.

Systems Group Retail Products 76

4. USER RESTRICTIONS.

You may not decompile, disassemble or reverse engineer the Software, except and only to the extent

that such activity is expressly permitted by applicable law notwithstanding this limitation.

You may not rent, lease, lend or provide commercial hosting services with the Software.

5. DISCLAIMER.

You may reach third-party sites through the usage of the Software or associated media or services.

Diebold Nixdorf does not control third-party sites and Diebold Nixdorf is not responsible for the contents

of any third-party sites, any links contained in third-party sites, or any changes or updates to third-party

sites. Diebold Nixdorf is providing these links and access to third-party sites and services to you only as

a convenience, and the inclusion of any link or access does not imply an endorsement by Diebold

Nixdorf of the third-party site or service.

6. ADDITIONAL SOFTWARE/SERVICES.

This EULA applies to updates, enhancements, add-on components, or Internet-based services

components, of the Software that Diebold Nixdorf may provide to you or make available to you after the

date you obtain your initial copy of the Software, unless they are accompanied by separate terms. For

the avoidance of this EULA does not provide any binding obligation for Diebold Nixdorf for the delivery of

any future update, upgrade or new releases. Diebold Nixdorf reserves the right to discontinue any

Internet-based services provided to you or made available to you through the use of the Software.

7. TERMINATION.

This EULA is effective from the date on which the Software is downloaded by you until terminated.

Diebold Nixdorf may terminate the license granted to you under this EULA by written notice at any time

without stating a reason. Diebold Nixdorf shall have the right to immediately terminate the license of use

under this EULA for cause in case you fail to comply with any provision of this Agreement and you do

not cure the relevant breach within a reasonable time frame after written notification of Diebold Nixdorf.

Upon termination, you must immediately destroy all copies of the Software or return all copies of the

Software to Diebold Nixdorf.

8. EXCLUSION OF WARRANTIES.

To the maximum extent permitted by applicable law, Diebold Nixdorf and its suppliers or its resellers

provide the Software and support services (if any) AS IS AND WITH ALL FAULTS, and hereby disclaim

all other warranties and conditions, whether express, implied or statutory, including, but not limited to,

any (if any) implied warranties, duties or conditions of merchantability, of fitness for a particular purpose,

of reliability or availability, of accuracy or completeness of responses, of results, of workmanlike effort, of

lack of viruses, and of lack of negligence, all with regard to the Software, and the provision of or failure

to provide support or other services, information, software, and related content through the Software or

otherwise arising out of the use of the Software. ALSO, THERE IS NO WARRANTY OR CONDITION

OF TITLE, QUIET ENJOYMENT, QUIET POSSESSION, CONCORDANCE TO DESCRIPTION OR

NON-INFRINGEMENT WITH REGARD TO THE SOFTWARE. Modifications and amendments to the

Software may occur without notice.

9. EXCLUSION OF INCIDENTAL, CONSEQUENTIAL AND CERTAIN OTHER DAMAGES.

IN NO EVENT SHALL DIEBOLD NIXDORF OR ITS SUPPLIERS OR RESELLER BE LIABLE FOR ANY

INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, INDIRECT, OR CONSEQUENTIAL DAMAGES

WHATSOEVER (INCLUDING, BUT NOT LIMITED TO, DAMAGES FOR LOSS OF PROFITS OR

CONFIDENTIAL OR OTHER INFORMATION, FOR BUSINESS INTERRUPTION, FOR PERSONAL

INJURY, FOR LOSS OF PRIVACY, FOR FAILURE TO MEET ANY DUTY INCLUDING OF GOOD

FAITH OR OF REASONABLE CARE, FOR NEGLIGENCE, AND FOR ANY OTHER PECUNIARY OR

OTHER LOSS WHATSOEVER) ARISING OUT OF OR IN ANY WAY RELATED TO THE USE OF OR

Systems Group Retail Products 77

INABILITY TO USE THE SOFTWARE, THE PROVISION OF OR FAILURE TO PROVIDE SUPPORT

OR OTHER SERVICES, INFORMATON, SOFTWARE, AND RELATED CONTENT THROUGH THE

SOFTWARE OR OTHERWISE ARISING OUT OF THE USE OF THE SOFTWARE, OR OTHERWISE

UNDER OR IN CONNECTION WITH ANY PROVISION OF THIS EULA, EVEN IN THE EVENT OF THE

FAULT, TORT (INCLUDING NEGLIGENCE), MISREPRESENTATION, STRICT LIABILITY, BREACH

OF CONTRACT OR BREACH OF WARRANTY OF DIEBOLD NIXDORF OR ANY SUPPLIER, AND

EVEN IF DIEBOLD NIXDORF OR ANY SUPPLIER HAS BEEN ADVISED OF THE POSSIBILITY OF

SUCH DAMAGES.

10. LIMITATION OF LIABILITY AND REMEDIES.

Notwithstanding any damages that you might incur for any reason whatsoever (including, without

limitation, all damages referenced herein and all direct or general damages in contract or anything else),

the entire liability of Diebold Nixdorf and any of its suppliers or resellers under any provision of this

EULA and your exclusive remedy hereunder shall be limited to the greater of the actual damages you

incur in reasonable reliance on the Software but in maximum up to the amount actually paid by you for

the Software. The foregoing limitations and exclusions shall apply to the maximum extent permitted by

applicable law, even if any remedy fails its essential purpose.

11. APPLICABLE LAW.

This EULA is governed by the laws of the Federal Republic of Germany. The application of the United

Nations Convention of Contracts for the International Sale of Goods is expressly excluded. Place of

Jurisdiction is Düsseldorf, Germany.

12. ENTIRE AGREEMENT; SEVERABILITY.

This EULA (including any addendum or amendment to this EULA which accompanies the Software) is

relating to the Software and the support services (if any) the entire agreement between you and Diebold

Nixdorf. It supersedes all prior or contemporaneous oral or written communications, proposals and

representations with respect to the Software or any other subject matter covered by this EULA. To the

extent the terms of any Diebold Nixdorf policies or programs for support services conflict with the terms

of this EULA, the terms of this EULA shall precede. If any provision of this EULA is held to be void,

invalid, unenforceable or illegal, the other provisions shall continue in full force and effect.