You are on page 1of 125

NCR Retail Platform Software

for Windows
Release 3.0

User’s Guide

20385a

B005-0000-1634
Issue F
The product described in this book is a licensed product of NCR Corporation.
NCR is a registered trademark of NCR Corporation.
NCR RealPOS,, NCR SelfServ, and NCR SelfServ Checkout are either registered trademarks or trademarks of
NCR Corporation in the United States and/or other countries.
Java and MySQL are trademarks of Sun Microsystems.
It is the policy of NCR Corporation (NCR) to improve products as new technology, components, software, and
firmware become available. NCR, therefore, reserves the right to change specifications without prior notice.
All features, functions, and operations described herein may not be marketed by NCR in all parts of the world.
In some instances, photographs are of equipment prototypes. Therefore, before using this document, consult
with your NCR representative or NCR office for information that is applicable and current.
To maintain the quality of our publications, we need your comments on the accuracy, clarity, organization, and
value of this book.
Address correspondence to:
Manager, Information Products
NCR Corporation
2651 Satellite Blvd.
Duluth, GA 30096
Copyright © 2009
By NCR Corporation
Dayton, Ohio U.S.A.
All Rights Reserved
i

Preface
Audience
This book is written for software installer/service personnel, system
integrators, and field engineers.
Notice: This document is NCR proprietary information and is not to
be disclosed or reproduced without consent.
ii

References
• NCR Retail Systems Manager Software User’s Guide
(B005-0000-1518)
iii

Table of Contents

Chapter 1: Client Software Installation


Introduction...............................................................................................1
Workstation Model ............................................................................3
Custom Setup .....................................................................................4
Base Platform Support ..................................................................4
NCR OPOS/JavaPOS....................................................................6
JavaPOS.........................................................................................14
Retail Systems Manager Options ..............................................19
Installing the Retail Platform Software ...............................................20
Retail Platform Software for Windows .MSI Install Parameters .....45
Creating a Client Image.........................................................................46

Chapter 2: Using RSM LE


RSM LE Functionality ..............................................................................1
Unmanaged RSM LE (EUI functionality) .......................................2
Managed RSM LE ..............................................................................4
RSM LE Login.....................................................................................7
Monitor Menu ...........................................................................................9
State of Health ....................................................................................9
Connectivity......................................................................................10
Event Logs.........................................................................................11
Tallies.................................................................................................13
Processes ...........................................................................................15
Services ..............................................................................................16
Administration........................................................................................17
RSM Services ....................................................................................17
Licensing ...........................................................................................20
iv

Alerting..............................................................................................21
Log Event Types ..........................................................................21
Tally Flush Interval .....................................................................22
RSM SNMP Configuration .........................................................23
Critical Events ..................................................................................31
Tally Thresholds...............................................................................35
OS Monitoring..................................................................................38
Data Capture.....................................................................................50
Create Diagnostic File .....................................................................54
Using Peripherals ...................................................................................57
OPOS/JavaPOS Retail Peripherals................................................57
Creating New Profiles.................................................................58
Changing a Profile .......................................................................59
Deleting a Profile .........................................................................60
Diagnostics ...................................................................................61
Platform Devices.....................................................................................62
Power States......................................................................................67
Restrictions ...................................................................................69
v

Revision Record

Issue Date Remarks

A Feb 2005 First issue

B Apr 2005 Various Updates

C Dec 2006 Updates for RSM release 2.1.2

D Jun 2007 Added SNMP Configuration. Various updates for


RSM 2.2

E Jan 2009 Updated for release 3.0

F Sep 2009 Separated into Chapters


Chapter 1: Client Software Installation

Introduction
The Retail Platform Software for Windows CD provides a single
Windows Installer executable that can be used to install NCR OPOS,
NCR JavaPOS, NCR RSM LE, and FitClient Agent software, on NCR
terminals that run Windows XP, WindowsXPe, Windows 2000,
WEPOS, or Windows NT operating systems. The Retail Platform
Software for Windows installation is released on a single LPIN, D370-
0782-0100, eliminating the need of separate media for NCR retail
terminal software components.
The Retail Platform Software for Windows CD provides the following
benefits:
• Single CD distribution for all Retail Platform software.
• Auto-detection of terminal type (if it is running on an NCR Gold
Drive or OS Recovery Image).
• Ability to select complete or custom installation of platform
software.
• Complete installation installs NCR Base Platform, NCR OPOS,
NCR JavaPOS, and RSM LE software. The installation requires
minimal customer input, and only one reboot to install all
components.
• RSM LE is installed to provide access to the OPOS Configuration
and diagnostics locally.
• There is no need to know the order in which to install platform
software. The Retail Platform Software for Windows installation
ensures that all required components are installed and configured
properly.
2 Chapter 1: Client Software Installation

• Custom installation provides the ability to pick and choose


components based on a customer configuration. The Retail
Platform Software for Windows installation ensures that all the
software required in support of a selected component is installed
and configured properly.
• Custom installation selections include:
• NCR Base Platform Support
• NCR OPOS – including the ability to select individual Service
and Control objects
• NCR JavaPOS
• NCR Retail Systems Manager
• NCR FitClient
• NCR Unified POS Services
• Ability to upgrade existing installations.
• Distribution of both “.exe” and “.msi” files to permit partners or
branded applications to bundle platform software installation into
their own Windows Installer applications.
• The Retail Platform Software for Windows “.msi” distribution can
also be uploaded to the RSM SE servers for installation on remote
terminals.
The components of the installation package features and definitions for
the installation options are described in the following sections. The
step-by-step installation procedure is described later in this document.
Chapter 1: Client Software Installation 3

Workstation Model
The workstation model defines the type of system where you are
installing the Retail Platform Software for Windows. The retail
systems are automatically detected, and you are shown the class,
model, and service type that was detected. You can change this
information if it is not correct.

The service types are Assisted and Self Service. The only difference
between these two terminal service types is the set of Printer Finite
State Machine definition files (used by State of Health) that are
installed by default. This minimizes the State of Health changes on an
assisted terminal because an operator is present to fix the problem. For
example, a paper low status is generated on a Self-Service system
indicating the printer on the unattended system needs attention. This
type of alert is not necessary, or even undesirable, for systems where a
cashier is present to handle the condition.
4 Chapter 1: Client Software Installation

Custom Setup

Base Platform Support


The Base Platform software contains software for terminal specific
functionality. The Base Platform software provides functionality used
by some peripherals software and by RSM. In addition to this
functionality, the Base Platform provides:
AMI DMIEdit Utility - This utility is used to update terminal
specific information such as serial number.
AMI Flash Utility - This utility is used to update the system BIOS
on the terminal.
Windows SetCMOS Utility - This utility provides a means to
modify the PC BIOS setup parameters.
Chapter 1: Client Software Installation 5

Windows FlashCCL Utility - This utility obtains Model, Class,


Serial Number, and Version of the terminal; builds an ini file; and
launches WinPhlash (the Flash BIOS Utility) with the proper
command line parameters for the terminal.

If you are on an older terminal, Base System Support with a different


set of options is given in place of the Base Platform support.

Display Panel extension - This feature adds LCD display


properties to the Display folder in the control panel. For legacy
terminals only.
LCD-Off Screensaver - A screensaver that shuts off the LCD panel
after a set period of time.
Windows SetCMOS Utility - This utility provides a means to
modify the PC BIOS setup parameters.
6 Chapter 1: Client Software Installation

Windows FlashCCL Utility - This utility obtains Model, Class,


Serial Number, and Version of the terminal; builds an ini file; and
launches WinPhlash (the Flash BIOS Utility) with the proper
command line parameters for the terminal.

NCR OPOS/JavaPOS
• NCR OPOS – An industry standard interface for accessing and
configuring the retail peripherals. NCR OPOS also provides
interactive and non-interactive diagnostics for analyzing problems
with the peripherals.
• NCR JavaPOS – A wrapper application for OPOS which permits
you to write Java applications using the Retail Controls.
If you install the Retail Platform Software for Windows, and install
OPOS 2.2, then you try to install an older release OPOS over it -- the
install will let you. This is because the “product name” has changed
from OPOS to Retail Platform Software for Windows, and the old
installation can’t detect the newer release. The real problem comes if
you then try to upgrade that older version you just installed back to the
newer version -- the install thinks the newer version is already there,
and doesn’t upgrade. If you get into this situation, you have to
uninstall both the older release and the newer release of OPOS, then
reinstall.
Chapter 1: Client Software Installation 7

Unified POS
OPOS
Control Objects
NCR Control Objects - OPOS 1.3 compliant. NCR Controls
are listed individually.
Common Control Objects - Unified POS 1.8 compliant.
Common Control Objects are listed individually.
Service Objects
NCR OPOS 2.5 - Supports all terminals. Updates to this
feature have been capped. This feature is not being
updated as new features are added to the various terminals.
Service Objects are listed individually.
NCR OPOS 3.9 - Supports RealPOS 20 (RP20), 30, 70, 80,
80C and newer terminals. Updates to this feature will
parallel the NCR JavaPOS 3.9 updates.
Service Objects are listed individually.
8 Chapter 1: Client Software Installation

Utilities
Data Capture Viewer - The Data Capture Viewer displays
trace information obtained from the NCR OPOS 2.5
Controls.
UPS Support - Uninterruptable Power Supply support for
the NCR 7452, 7453, 7456, and 7458 terminals. You must
perform a custom install to select this feature. Although not
configured via an OPOS profile, UPS configuration is
supported from RSM.
NCR Wedge Configuration Utility - The Wedge
configuration utility provides a user friendly interface to
configure various devices attached to the keyboard wedge.
Miscellaneous
Development Tools
Form Designer - The Form Designer is an application
that permits you to design forms in conjunction with the
Form Control.

Include Files - Include files for application


development.
Event Logging Message Files - Event log message dlls.
Provide additional details in the event logs.
Help Files - OPOS Windows Help File version 2.4. This file
is not being updated as new features become available.
The NCR OPOS User’s Guide (B005-0000-1619) and the
UPOS committee documents are being used for OPOS 3.8.
Chapter 1: Client Software Installation 9

NCR OPOS Custom Setup Options


OPOS 2.5 Controls
The following list shows the NCR OPOS service objects that can be
included in the installation. The OPOS Controls and Service objects are
selected independently.
Cash Drawer
NCRPrinter.CashDrawer - Cash Drawer connected to a 7140, 7141,
7152, 7156, 7162, 7166, or 7193 printer.

NCRCashDrawer - Controls the Cash Bases DRUR01, MPU, and


the Tellermate SmarTill cash drawers via serial connection and the
7401, 7448, 7453, 7454, 7455, 7456, 7458, and 7460 Cash Drawer
using the I/O port connection.

Form
NCR5992.Form – Provides forms for the NCR 5992 Capture device.

Hard Totals
NCRHardTotals - Store totals information on Disk or in CMOS (for
a retail workstation).

Keylock
NCRWedge.Keylock - Controls the keylock on a Wedge device.

NCRKeylock – Controls the keylock on the NCR 7448 or a USB


keylock.

Line Display
NCRLineDisplay - Controls various Line Displays.

NCR5945.LineDisplay – Controls the display on the NCR 5945


device.

NCR5991.LineDisplay - Controls the display on the NCR 5991


Signature Capture device.
10 Chapter 1: Client Software Installation

NCR5992.LineDisplay – Controls the display on the NCR 5992


Signature Capture device.

NCRInternational.LineDisplay – Controls the International version


of the 5972 Line Display.

MICR - Magnetic Ink Character Recognition


NCRPrinter.MICR - Controls the Magnetic Ink Character
Recognition (MICR) reader on the NCR 7156 or NCR 7162 printer.

MSR - Magnetic Stripe Reader


NCRWedge.MSR - Controls a magnetic stripe reader that is
attached to a Wedge device.

NCRFitClient.MSR - Controls a magnetic stripe reader that is


attached to a NCR 7401, 7448, 7454, 7455, or NCR 7460
Workstation.

NCR5945.MSR – Controls the magnetic stripe reader on the NCR


5945 device.

NCR5991.MSR - Controls the magnetic stripe reader on the NCR


5991 Signature Capture device.

NCR5992.MSR – Controls the magnetic stripe reader on the NCR


5992 Signature Capture device.

Motion Sensor
NCRMotionSensor – Detects motion on the NCR 7401, 7403, 7404,
7454, and 7455.

PINPad
NCR5945.PINPad – Controls the PINPad on the NCR 5945 device.

NCR5992.PINPad – Controls the PINPad on the NCR 5992


signature capture device.
Chapter 1: Client Software Installation 11

POS Keyboard
NCRPOSKeyboard – Provides keyboard input to an application on
Windows NT 4.0.

NCR5945.POSKeyboard – Controls the keyboard on the NCR 5945


device.

POS Printer
NCRPrinter.POSPrinter - Controls the NCR printer with a serial
interface. (Models: 7156, 7193, 7152, 7166, 7140, 7141, 7162, 1001,
2001, 520, 7161, 7194, 7158, 580, 590, 7166-5005, 7167, 7196, 7196-
3205, 7196-5005, 7196-8005, 7197, 2208, and 200.)

Scale
NCR78xx.Scale - Controls a scale on the NCR 7870 or 7880 Scanner
with a serial interface.

Scanner (Bar Code Reader)


NCR78xx.Scanner - Controls a scanner with a Serial interface.
(Models: 7835, 7836, 7837, 7870, 7872, 7875, 7880, 7882, 7890, and
7892.)

NCRWedge.Scanner - Controls a scanner that is connected to a


Wedge device. (Models: 7837, 7880, and 7890.)

Signature Capture
NCR5991.SigCap - Controls the Signature Capture features of the
NCR 5991 Signature Capture device.

NCR5992.SigCap – Controls the Signature Capture features on the


NCR 5992 Signature Capture device.

Tone Indicator
NCRToneIndicator – Permits tones to be played on the Wedge
speaker.
12 Chapter 1: Client Software Installation

OPOS 3.9 Controls

The following table shows the support for OPOS.

UnifiedPOS Control NCR Devices Supported


Support
Biometrics - Fingerprint Reader YES Integrated or USB
Bump Bar NO
Cash Changer NO
Cash Drawer - On Printer YES NCR 7167, NCR7197 Printers
Cash Drawer - Integrated YES NCR7402/7404/7443/7446/7449/
7456/7457/7458/7459.
NCR 7453-3xxx
CAT - Credit Authorization NO
Term
Check Scanner YES NCR 7167
Coin Dispenser NO
Fiscal Printer NO
Hard Totals YES Disk Based Media
Keylock YES NCR 5932 USB Keyboard,
5953 USB Dynakey, or 5954 USB
Dynakey
Line Display YES NCR 5972 VFD, LCD, and Occular
LCD ( Serial only for all models),
NCR 7402 APA, NCR 7402 2x20.
NCR 7443/7446 2x20
MICR YES Connected to Printer
Motion Sensor YES NCR 7401 and 7402
MSR YES NCR 5932 USB Keyboard,
5953 USB Dynakey, or 5954 USB
Dynakey
PIN Pad NO
Point Card Reader Writer NO
POS Keyboard NO
POS Power NO
POS Printer YES NCR 7156, NCR 7158, NCR 7167,
NCR 7197, K580, K590, 7342-
F306, 7342-F307, 7342-F309,
Chapter 1: Client Software Installation 13

UnifiedPOS Control NCR Devices Supported


Support
H6000
Remote Order Display NO
Scale YES NCR 7872, NCR 7875, 7876, 7878,
7883 (Serial, USB)
Scanner YES ConnectionType:
Note 1: USB – OS supported (Serial, NCR USB, or USB)
HID USB NCR 7872/74/75/76/78
Note2: NCR USB – A USB NCR 7883/84, NCR 7892
scanner connected through a
Virtual Serial COM port NCR 2356
emulation driver. Requires ConnectionType:
additional driver install.
(Serial or NCR USB)
NCR 7837
NCR 7838
NCR 7880, NCR 7882
NCR 2357
3800, 4600, 5600/20
ConnectionType:
(Serial Only)
NCR 7832 (Serial)
ConnectionType:
(USB Only)
NCR 7404EP Advantage (USB)

Signature Capture NO
Tone Indicator YES NCR 5932 USB Keyboard,
5953 USB Dynakey, or 5954 USB
Dynakey
14 Chapter 1: Client Software Installation

JavaPOS
A wrapper application for OPOS which permits you to write Java
applications using the OPOS Retail Controls.

Device Controls
JavaPOS Common Controls 1.9.0 - JavaPOS common
controls released by the UPOS committee.
Device Services
NCR JavaPOS 2.0 with NCR Legacy Loading Scheme -
Uses registry entries for peripheral configuration
parameters.
NCR JavaPOS 2.1 with JCL Support - Uses XML file
entries for peripheral configuration parameters.
NCR JavaPOS 3.9 - Supports the NCR RealPOS 20, 30,
70, 80, 80C and newer terminals. Updates to this feature
will parallel the NCR OPOS 3.9 updates.
Utilities
JCL Editor - This is the Java editor released by the UPOS
committee.
Chapter 1: Client Software Installation 15

The default installation installs only OPOS. If you are going to be


using JavaPOS, you must perform a custom install. The default custom
install screen appears as follows:
16 Chapter 1: Client Software Installation

Select UnifiedPOS → JavaPOS. If you select “This feature will be


installed on local hard drive”, only the JavaPOS 3.8 controls will be
installed.
Chapter 1: Client Software Installation 17

If you wish to install the JavaPOS 2.1 controls or both JavaPOS 2.1 and
3.8, select UnifiedPOS → JavaPOS → Device Services and then
select the versions that you want. Do not choose the JavaPOS 2.0
feature; it is for legacy support.
18 Chapter 1: Client Software Installation

Also, the Biometrics driver is not automatically installed when you


choose to install the 3.8 controls. If you need the Biometrics driver,
expand the NCR JavaPOS 3.8 entry and select Biometrics.
Chapter 1: Client Software Installation 19

Retail Systems Manager Options

Retail Systems Manager - Retail Systems Manager client software


(communicates with the RSM SE Server) and Retail Systems
Manager LE which provides local configuration and diagnostic
capabilities.
RealVNC 3.3.7 - This provides the ability to remotely control a
terminal. This feature used to be installed by default, but nowyou
must select it as part of a custom installation.
FitClient Agent - provides communication and synchronization
with the FitClient Manager Server. FitClient Agent is only
available through a custom install since FitClient Manager has been
replaced by RSM.
FitClient Manager LE - provides local configuration and diagnostic
capabilities. FitClient is not being updated with new features that
are being incorporated into RSM LE. RSM LE is the replacement
product for FitClient LE. FitClient LE is only available if you
choose a Custom Install.
20 Chapter 1: Client Software Installation

Installing the Retail Platform Software


The Retail Platform Software for Windows (D370-0782-0100) can be
installed from a CD or uploaded to the RSM SE Server or FitClient
Server so that it can be downloaded and installed on the system
terminals. Refer to the RSM File Distribution chapter in the NCR Retail
Systems Manager Software User’s Guide (B005-0000-1518) for additional
information on how to upload applications.
If you are going to be using SNMP, make sure that you have installed
the Microsoft SNMP Service prior to installing RPSW. The RPSW
installation does not ask any questions about the SNMP installation,
but some Microsoft SNMP parameters are configured by the RPSW
install for use with the RSM SNMP agent. With RPSW 2.3 or later, only
the RSM SNMP agent is valid. The SNMP LPIN D370-0512-0100 can
NOT be used with RPSW 2.3 or later. Refer to the NCR Retail Systems
Manager Software User’s Guide (B005-0000-1518) for additional
information on setting up and using SNMP.
The Retail Platform Software comes in two versions.
• Retail Platform Software for Windows.MSI
• Retail Platform Software for Windows.EXE
The EXE version contains the Windows installer package in addition to
the Retail Platform Software, and the file size is larger than the MSI
version.
Remote installs can be performed on *.MSI files. This means that the
application can be pushed from the server to the client without any
action at the client terminal. The Install Parameters (for non-GUI
installation) for the Retail Platform Software are listed in the
“Command line parameters for Retail Platform Software for
Windows.doc” file on the CD.
Chapter 1: Client Software Installation 21

If this is the initial install and you are using the Windows Installer
version of the Retail Platform Software, you need to install the
ISScript.MSI file first. It is on the installation CD. Once it’s installed
on a client, you don’t need to install it again on future installs or
upgrades. You can install it just like any other application. Upload it
to the RSM web site on the server, and access it from the System’s web
browser. If you run the .EXE version of the Retail Platform Software
for Windows, it automatically installs the ISScript file.
Push installs using RSM can’t be done until the Retail Platform
Software for Windows LPIN (with RSM client software) is installed on
the system terminal. Upgrades of RPSW can be installed remotely
using RSM. Refer to the section on using Packages in the NCR Retail
Systems Manager Software User’s Guide (B005-0000-1518) for additional
information on using RSM to remotely upgrade RPSW.
Note: The first 4 steps are for downloading RPSW from RSM SE
installed with web server support. If you are installing RPSW from a
CD, you will start at step 5.
22 Chapter 1: Client Software Installation

1. If the “Retail Platform Software for Windows” software has not been
uploaded to RSM, you must do that first. At the RSM SE or RSM EE
server, Select Site or Enterprise → Files → Web Downloads → Add
File button. Browse for the “Retail Platform Software for
Windows.exe or .msi” file, provide a title that is used in RSM and
select Upload.
Chapter 1: Client Software Installation 23

2. On the client, select Start → Run, and enter the network path to the
RSM server or enter this line in your browser.
Example: http://<server name>/RSM

3. Select OK to run the RSM web site. You may be asked to install
several .cab files when trying to connect to the RSM web site, select
Yes to install them.
24 Chapter 1: Client Software Installation

4. From the client system that is connected to the RSM web site, select
the Site → Files → Web Downloads, then select the file you wish
to open. You are given the option of opening the file or saving it to
disk. Select Open to install RPSW. Note: If Windows Installer 2.0
is installed on your client system, you can only save the file. Then
you can go to the saved directory and run the install.

5. If you are installing from the Windows Installer (.MSI), restart the
system if prompted. If you are installing from the .exe file, the
Windows Installer is installed, then the Retail Platform Software for
Windows package is installed.
Chapter 1: Client Software Installation 25

The Retail Platform Software for Windows tries to detect the current
configuration. Make sure the configuration is correct and select
Confirm. You can select a different configuration if it isn’t correct.

The Service Type can be either Assisted or Self-Service.


The Terminals that are by default classified as Assisted Service are:
7403, 7443, 7446, 7449, 7452, 7453, 7454, 7456, 7457, 7458, 7459, 7460
The Terminals that are by default classified as Self Services are:
7350, 7401, 7402, 7404, 7409
The only difference for these two terminal service types is the set of
Printer Finite State Machine definition files (used by State of Health)
that are installed by default. This minimizes the State of Health
changes on an assisted terminal because an operator is present to fix
the problem. For example, a paper low status is generated on a Self-
Service system indicating the printer on the unattended system needs
attention. This type of alert is not necessary, or even undesirable, for
systems where a cashier is present to handle the condition.
26 Chapter 1: Client Software Installation

6. The Welcome screen is displayed. Select Next.

7. If you have a previous version of OPOS or Logs and Tallies


currently installed, a screen appears with options for dealing with
the existing installation. Select Next.
Chapter 1: Client Software Installation 27

8. The license agreement displays. Read the agreement, then select “I


accept the terms in the license agreement”. Select Next.
28 Chapter 1: Client Software Installation

9. Select the type of installation. Standard installation gives you the


items that are initially selected for the custom installation. In this
case, Custom is selected. Select Next.

If you select Standard install, the next question (step 11) is about
using Common vs. NCR OPOS Control Objects. If you select
Custom install, the custom setup screen displays
Chapter 1: Client Software Installation 29

10. The custom setup permits you to choose the options you wish to
install. Refer to the previous sections in this chapter for an
explanation of the various selections on this and the following
installation screens. You can also change the install directory from
this screen. Select Next.
30 Chapter 1: Client Software Installation

11. If you choose the standard setup, you are given the option as to
which OPOS controls to install. If a Custom Install was chosen,
then the choice of Common vs. NCR OPOS Control Objects is made
as part of selecting the Custom Install options and this screen is not
displayed.
Chapter 1: Client Software Installation 31

12. This screen presents the Retail Controls options. The OPOS
profiles are the configuration information associated with each
retail control. On a new installation, you probably want to Install
Default Profiles. If you select Do Not Install Profiles, none of the
OPOS Profiles are installed. This option is commonly used where
the solution provider installs all of the profiles that are needed for a
specific customer. The Use Saved Profiles setting is shown only if
you are upgrading OPOS and you want to use the same profiles
that were being used with the old version of OPOS. When you start
the Retail Platform Software for Windows installation, it checks to
see if there is already a version of OPOS installed on your system.
If there is, you are given the opportunity to save the profiles. These
are the saved profiles that are used with the Use Saved Profiles
option. Select Next.
32 Chapter 1: Client Software Installation

13. If you chose to install the Java version of the OPOS controls, the
following screen displays telling you to install the Java Runtime
Environment which is available from Sun Microsystems. Select
Next.
Chapter 1: Client Software Installation 33

14. RSM Options. This section permits you to configure either


Managed Terminal or Local Only. The Local Only option may be
used in SNMP configurations or other configurations where no
RSM SE Server is available. When you choose the Managed
Terminal option, you can optionally identify the RSM SE server’s
name or IP address so that the system communicates with a specific
server. In a Dual Server environment, the name or IP address for
both RSM SE servers would be entered. If you do not specify a
server, the system automatically finds one on the network. If you
don’t know your Server Name or IP Address, see your system
administrator.
34 Chapter 1: Client Software Installation

15. This is the password for accessing this system from a remote
location using the RealVNC program. RealVNC is a program that
permits you to access this desktop from a remote terminal. This
screen is only displayed if you selected RealVNC using a custom
install.
Chapter 1: Client Software Installation 35

16. Do you want to modify Internet Explorer browser settings to


permit RSM to function properly? If the option is not selected, you
must manually change the parameters in the following section:

Internet Explorer Prerequisites


The following items must be set when using RSM. If you choose
Modify security settings the RPSW installation will make the
changes for you. If you select Do not modify security settings or if
a patch or another software program changes these values, then
you will have to manually change these settings.
Some settings are necessary for any supported Windows operating
system; some settings are specific to Windows XP Pro SP2 or
greater and Windows XPe SP2 or greater.
Select these settings from Internet Explorer.
36 Chapter 1: Client Software Installation

Blocked Content
In the IE advanced settings, blocked content must be allowed:
A. Go to Internet Explorer, and select Tools → Internet Options
→ Advanced tab → Security section.
B. Check the box to enable “Allow active content to run in files
on My Computer.”

If this option is not set, the user will have to allow the blocked content
manually each time the RSM user interface is initiated.

ActiveX Controls
In the IE security settings, ActiveX controls must be enabled:
A. Go to Internet Explorer, and select Tools → Internet Options
→ Advanced tab → Security tab → Internet Options →
Custom Level button → ActiveX controls and plug-ins
section.
B. Change “Automatic prompting for ActiveX controls” to
Enable.
Chapter 1: Client Software Installation 37

17. If you are running on Windows XP with Service Pack 2 and a


Windows Firewall is enabled, there is another prompt to set up the
ports that can get through the firewall to support RSM.

If the Windows firewall settings are not modified by the RPSW


install or if another firewall in present, you may need to manually
configure the firewall to open ports for RSM communication.

For systems using the Windows Firewall, use Start → Settings →


Control Panel → Windows Firewall → Exceptions tab to open
the required RSM ports, depending on the location and intended
use.
38 Chapter 1: Client Software Installation

If a different firewall is used, then the RSM ports must be opened


using the appropriate procedure for the firewall being used. Refer
to the RSM Network Topology diagram below for specific port
information.
NCR NCR/IIS
REQUIRED PORTS
Customer
Services RSM NCR Edition & Database OPTIONAL PORTS
TCP 8500

User Interface
TCP 80 UDP 69

Database Queries RSM


IE IE

User
IE
Topology
Workstations

Remote Management
SSL Appliance (Neoteris)

NCR
Firewall
Internet

VPN Customer
Firewall
TCP 8500 HD Customer
Customer Alerts, Asset Info
TCP 5800 Help Desk
Corporate TCP 5900
Hop-Off Server TCP 8500
TCP 80 (& IIS) HD
SNMP SMTP RA TCP 8500 EE/IIS UDP 69

Remote access
Network Mgt. System SMTP Server RSM Routing Agent RSM EE & Database to RSM EE console
via web-browser
TCP 25 TCP 8500
UDP 162 HD
TCP 8502

Stores TCP 5800 TCP 8500


TCP 5900
SE TCP 9971 SE SE
TCP 80 (& IIS) TCP 8500 UDP 67 TCP 2000
UDP 69 UDP 4011 UDP 162
UDP 8501 UDP 69 UDP 53

TCP 8502 TCP 16992 TCP 5800


LE LE LE LE LE LE LE LE LE
UDP 161 UDP 68 TCP 16993 TCP 5900
Chapter 1: Client Software Installation 39

Core RSM Capability


Terminal
• TCP 8502 – Software distribution (rsync)
Server
• TCP 8500 – Main RSM port
• UDP 8501 – Auto-discovery of RSM SE server
• TCP 80 & IIS – Remote (off-box) web-browser access to RSM SE
console (optional)
• UDP 69 – Uploading files (sw packages, license) to RSM SE console
(optional)
Enterprise Server
• TCP 8500 – Main RSM port
• TCP 8502 – Software distribution (rsync)
• TCP 80 & IIS – Remote (off-box) web-browser access to RSM EE
console
• UDP 69 – Uploading files to RSM EE console
(hierarchy, sw packages, license file) (TFTP)

PXE

Terminal
• UDP 68 – DHCP client
Server
• UDP 67 – DHCP server or proxy DHCP server
• UDP 4011 – PXE boot server
• UDP 69 – PXE boot server
40 Chapter 1: Client Software Installation

AMT
Terminal
• TCP 16992 – Small business mode – non-secure (http)
• TCP 16993 – Enterprise mode – secure (TLS) (https)
• UDP 68 – DHCP client
Server
• TCP 9971 – AMT provisioning server (RSM SE)
• TCP 2000 – Remote BIOS configuration (AMT SOL)
• UDP 162 – AMT management server (RSM SE)
• UDP 53 – Proxy Domain Name Server (RSM SE)
• UDP 67 – DHCP server

SNMP
• UDP 161 – SNMP agent
• UDP 162 – SNMP manager (to receive traps)

E-mail Alerts
• TCP 25 – SMTP server

VNC
• TCP 5800 – VNC Java web client access
• TCP 5900 – VNC standard client access

Microsoft SQL Server


• TCP 1433 – If db on separate server from RSM
Chapter 1: Client Software Installation 41

18. The Ready to Install screen displays. If you need to make any
changes, you can use the Back button. When you are ready to
install the Retail Platform Software for Windows, select Install.
42 Chapter 1: Client Software Installation

19. During the installation, setup may find files that should be closed
during the installation, such as the following.

MyApp

Close the file then select Retry.


Chapter 1: Client Software Installation 43

20. When the installation is complete, select Finish.

21. A message displays stating you should reboot the client terminal.
Select Yes.
44 Chapter 1: Client Software Installation

22. After rebooting, if the system and the RSM SE server are connected
in a LAN and you selected Managed Terminal during installation,
the system should automatically become a Managed System.

Open the browser on the system, and type the path to the RSM web
site on the Address line, and then press Enter or select the desktop
icon for RSM LE.

C:\Program Files\NCR\RSM\Website\ConsoleLE.htm

If you run the installation program after the software has been
installed, you are given the option to Modify (Add or Remove
components), Repair (Replace corrupt files), or Remove (removes all
software; RSM, OPOS, JavaPOS, and Base Platform) the current
installation.
Chapter 1: Client Software Installation 45

Retail Platform Software for Windows .MSI Install


Parameters
.MSI files provide another method to install applications remotely
(from the server). This method can be used to install programs that are
built for the Microsoft Windows Installer program (*.MSI).
There is no user interactivity using Remote Install. Therefore, if the
application installation program has parameters that require
interaction, these parameters must be entered in the Install Parameters
field prior to installing the Retail Platform Software on the System.
All properties and values are listed in the “Command line parameters
for Retail Platform Software for Windows.doc” file on the installation
CD.
46 Chapter 1: Client Software Installation

Creating a Client Image


The addition of RPSW and RSM to the Gold Drive images saves the
user from having to install these products individually, but when you
incorporate these Gold Drive images with your applications and then
wish to distribute them to multiple terminals, some issues on terminal
identification must be considered.
Problem: The NCR Retail Platform Software for Windows (RPSW)
software reads and stores terminal-based DMI information to the hard
disk, in either the registry or in a file. The DMI space (firmware on the
processor board) contains information like Terminal Serial number,
class/model, etc. This information is critical because it may be the only
way of identifying the terminal and its version.
This process works fine when each terminal’s hard drive is built up
from scratch at that terminal. Now, with the use of drive duplication
software, this has become an issue because the duplicated terminals
can get the DMI information of the source terminal where the image
was created. Usually, a master disk image is created on a test terminal
and then the software on that terminal is imaged on to all the other
terminals. The problem occurs the first time the test terminal is
rebooted after the RPSW software is installed. During this reboot the
DMI information is read and written to disk. (This data is not modified
on subsequent reboots.) Then, when the image is sent to the other
terminals, the DMI values on the disk do not match what is actually in
DMI on that terminal.
Impact: When this problem occurs, NCR platform software (such as
the Retail Systems Manager (RSM)) shows incorrect DMI information
for any terminals that have been loaded using the image. In addition,
the RSM user interface will show the affected terminals as being in an
unhealthy state when it detects that the board and disk drive DMI
information do not match. (If you do not have RSM State-of-Health,
check the event log for NCRHAL events, which indicate that the
information does not match.)

Action: In order to create a client image, perform the following steps.


Chapter 1: Client Software Installation 47

1. Install RPSW.
2. Install RPSW patches.
3. Configure any RSM LE settings that are common across terminals
such as the system “Custom Tags”.
4. Run the NCRSysPrep utility which is included with RPSW 2.1.1 or
greater. The NCRSysPrep utility can be run for the NCR 7402,
7456, 7457, 7458, and newer terminal images. This utility clears out
the data on the terminal’s hard drive so that the next time the
terminal is loaded or rebooted, the data will be read from the
processor board on the new terminal. The customer can run the
NCRSysPrep on each terminal to clear this error, but the best
solution is to run NCRSysPrep on the terminal being imaged. If
you reboot the terminal after NCRSysPrep is run and the Base
Platform software in RPSW runs again, then the data on the hard
drive will be filled in again and you will have to run NCRSysPrep
again.
5. Run Microsoft SysPrep/fbreseal. Do not reboot after this is done.

Note: It is important that you run NCRSysPrep before you run the
Microsoft sysprep/fbreseal.

6. Create the image.


In order to capture or restore an image, refer to the NCR Partition Image
User’s Guide (B005-0000-1641).
Chapter 2: Using RSM LE

RSM LE Functionality
RSM LE provides peripheral configuration, and local out-of-service
diagnostics. Additional functionality is available if RSM LE is licensed.
• RSM LE has Every Unit Item (EUI) functionality if there is no RSM
license or the RSM license has expired.
• EUI functionality permits you to configure peripherals and run
diagnostics only.
• No login prompt is displayed when LE starts up if you are in EUI
mode.
• Additional functionality is available when you have an RSM license
(monitoring and information).
• RSM LE provides SNMP functionality if you are licensed for it.
For additional information on RSM LE, refer to the NCR Retail Systems
Manager Software User’s Guide (B005-0000-1518).
When you start RSM LE in EUI mode, the following screen is
displayed.
2 Chapter 2: Using RSM LE

As stated, the options available in RSM LE are based on the licensed


features. RSM LE normally gets its license from the RSM SE server it
connects to, though it is possible to add an RSM license file to an
unmanaged RSM LE system. RSM LE has EUI functionality when
either it has no RSM license or the license has expired. The EUI
functionality is typically seen on unmanaged RSM LE systems.
Therefore, the following sections Unmanaged RSM LE and Managed
RSM LE describe features that are typically found, but your license file
may give you different features.

Unmanaged RSM LE (EUI functionality)


If RSM LE is unmanaged (not connected to RSM SE or RSM EE), the
following options are available with EUI functionality.
Platform - The platform devices for your terminal. Some examples
include:
• Audio
• BIOS
• Disks
• Motherboard
Chapter 2: Using RSM LE 3

• Network
• Power States
• Serial Ports
• Touchscreen
• Versioning
Peripherals - The OPOS/Javapos controls selected during installation.
Some examples include:
• Device Assets
• Cash Drawer
• Check Scanner
• Coin Dispenser
• Hard Totals
• Keylock
• Line Display
• MICR
• MSR
• Pin Pad
• POS Keyboard
• POS Printer
• Scale
• Scanner
• Signature Capture
• Tone Indicator
Administration
• RSM Services
• Customer Number
4 Chapter 2: Using RSM LE

• RSM Managed - Enabled/Disabled. Set to Disabled for an


unmanaged system
• Licensing - Nothing changeable
• Current User
• License File
• License Expiration
• Data Capture
• Configuration - Simple/Advanced
• Simple
• Default Setting - No Logging, Error Logging, or Full
Logging
• Advanced
• Trace Mask Settings
• Level Mask Settings
• The list of modules that support data capture. The type of
logging can be changed for each one of the devices.

Managed RSM LE
If RSM LE is being managed by RSM SE, additional functionality is
provided in RSM LE. The additional information includes; monitoring,
logs and tallies, and alerting. In addition to the options for the
unmanaged RSM LE interface, the Managed RSM LE interface
includes:
Monitor
• State Of Health
• Connectivity
• Event Logs
• Tallies
Chapter 2: Using RSM LE 5

• Processes
• Services
Platform
• Audio
• BIOS
• Disks
• Memory - Not in EUI RSM LE
• Motherboard
• Network
• Operating System - Not EUI RSM LE
• Power States
• Serial Ports
• Software - Not in EUI RSM LE
• Touchscreen
• Versioning
Peripherals - The same as available for EUI RSM LE
Administration
• RSM Services
• Customer Number.
• RSM Managed - Enabled/Disabled. Set to Enabled for a
managed system.
• RSM Server Discovery - Whether this system discovers the RSM
Server dynamically or uses a fixed address.
• Connected RSM Server - The address of the RSM SE Server that
this RSM LE system has connected to.
6 Chapter 2: Using RSM LE

• Logical System Name - An identifying name for this system


that can be used to identify this system by a name other than its
computer name, at RSM Servers. For example, it may be
desirable to use names like Lane 1 or Bakery to identify the
location or usage of the system.
• Custom Tags - Permit you to group systems into various roles
such as the functional area in the store, a region in the country,
or any other grouping you wish.
• OS Monitor - Enabled/Disabled.
• File Agent - This must be enabled to support file distributions.
• Software Agent - This must be enabled to support software
execution in packages scheduled from RSM SE and EE servers.
• Default Destination Directory - The default destination
directory used for packages that contain distributed files but no
destination directory is defined in the package.
• Licensing - Nothing changeable
• Current User
• License File
• License Expiration
• Alerting - Permits filtering events from the Windows event log, but
filtered events are still used for critical events and State Of Health.
• Log Event Types: Error, Warning, Information, Success Audit,
Failure Audit.
• Tally Flush Interval - The frequency at which tally values are
flushed from memory to persistent storage. For clients, this will
also trigger sending any tally updates to RSM SE.
• SNMP Agent - If installed and licensed. Enable/disable.
• Critical Events - You can change the threshold information for the
various types of critical events. You can also view the meanings of
various types of event messages.
Chapter 2: Using RSM LE 7

• Tally Thresholds - You can change the tally threshold values for the
various retail peripherals.
• OS Monitoring
• Configure the monitoring of system wide CPU and memory
usage, disks and files, and processes and services.
• Data Capture - The same as available for unmanaged RSM LE.

RSM LE Login
When managed RSM LE with a license is started, you are prompted for
a login. The “Guest” username does not require a password, but it
only gives you read-only privileges. If RSM is operating in Every Unit
Item (EUI) mode, you are not prompted for a login, but you are
automatically logged in with privileges to configure peripherals and
run diagnostics only.
The NCRRetailer login permits access to the features you have
licensed. You obtain this file and password information from NCR.
The NCRRetailer login has a password that changes daily.
The NCRService login is used by NCR personnel, and it has full access
to all the features in the system. The NCRService login has a password
that changes daily.
8 Chapter 2: Using RSM LE

After you have logged into RSM LE with RSM SE installed, the
following screen is displayed.

The following sections show the features available when using RSM
LE.
Note: The functionality present is based on the license file, and
unlicensed features are not available.
Chapter 2: Using RSM LE 9

Monitor Menu
The Monitor Menu section is not included with RSM LE EUI without a
license.

State of Health
The State of Health screen is the first screen shown after you log in.
RSM has the ability to determine the state of health of managed
components. State of health determination is derived using events
logged by managed components. These events are then driven
through a finite state machine to determine the current state of health.
NCR terminals and peripherals have been instrumented to log the
events needed to drive this state machine and allow RSM to determine
their current state of health.
State-of-health is a key component of RSM and therefore is easily
visible from the RSM user interface. At RSM LE, State of Health
monitors the peripherals attached to the system, and reports problems
that are encountered, from the platform devices.
10 Chapter 2: Using RSM LE

The State of Health screen displays information on the current status of


a System.
• State Of Health Alerts - defined by information provided by the
Retail Controls, Platform devices, or RSM software. State Of
Health does not require that the Alert configuration parameters be
defined. The alerts include:
• Healthy Alerts
• Attention Soon Alerts
• Attention Now Alerts
• Event Alerts - Set up at the System Level
• Informational Events Alerts
• Warning Events Alerts
• Error Events Alerts
• Tally Alerts - Set up at the System Level
• Tally Threshold Alerts

Connectivity
The Connectivity screen shows the current connection status to RSM
EE.
Chapter 2: Using RSM LE 11

Event Logs
The Event Logs section shows all the information contained in the
Application, System, and Security logs. One screen of log entries is
displayed at a time and you use the Previous Set or Next Set button
to move through the entries. The logs may also be cleared using the
Clear Logs button.
12 Chapter 2: Using RSM LE

Selecting a log entry provides the following information.

• Description - Description of the entry


• Type - Error, Warning, Information, Success Audit, Failure Audit
• Date - Date of the entry
• Time - Time of the entry
• Source - Software that logged the event
• Category - Classification of the event
• Event - A number identifying the particular event ID for this source
• User - Name of the User when the event occurred
• Computer - Name of the computer where the event occurred
• Resolution Information (if licensed)
Chapter 2: Using RSM LE 13

Tallies
Tallies are available when RPSW is installed and licensed with RSM.
Tallies are not available with RSM LE every unit item functionality.
Tallies are maintained for each peripheral. These tallies are counts of
both good and bad information that are incremented until reset by a
user. The good tallies allow comparison of bad to good counts, as well
as assisting in proactive maintenance of devices. Refer to the OPOS
Help file or the NCR Retail Controls 3.x UPOS User's Guide for Windows
(B005-0000-1619) for a listing of the tallies for the various devices.
In addition to the RPSW peripherals, tallies may also be maintained by
any software using the NCR Store Minder tally interface to create and
increment tallies. Refer to the RSM SDK LPIN (G370-2800-0100).
14 Chapter 2: Using RSM LE

When you select a tally, you get the following parameters:

• Tally Type - Either Software or Hardware


• Tally Value - The current count for the tally
• Tally Threshold Alert - Enabled/Disabled
• Tally Threshold - The number of times a certain operation is
performed before an alert is sent. See the Tally Thresholds section.
• Reset Tally - Reset the current tally
The Flush Tallies button moves the tallies stored in memory to
permanent storage so the current values may be viewed in the RSM
user interface. Tallies are also flushed periodically (see the Tally Flush
Interval section). Flushing tallies to permanent storage also triggers
sending any updated tallies to RSM SE.
Chapter 2: Using RSM LE 15

Processes
The Processes screen is selected from Monitor → Processes. It shows
the processes that are running and their CPU utilization percentage.
16 Chapter 2: Using RSM LE

Services
The Services screen is selected from Monitor → Services. It shows the
Services that are installed and their Stopped/Started state.
Chapter 2: Using RSM LE 17

Administration
The Administration section is included in all versions of RSM LE. The
features include:
• RSM Services
• Licensing
• Alerting (if licensed)
• Critical Events (if licensed)
• Tally Thresholds (if licensed)
• OS Monitoring (if licensed)
• Data Capture

RSM Services
The Services menu for RSM LE is used with a system that is being
managed by an RSM server. If you are running the RSM LE in an
unmanaged, local environment, you won’t need to use any of these
features.
18 Chapter 2: Using RSM LE

If you select the Administration → RSMServices menu, you can


change the following:

Customer Number
The customer number is used to identify the customer using RSM.
The Customer Number is shown on the contract with NCR.

RSM Managed
Enabled/Disabled - Indicates whether this system is managed by
an RSM SE Server. If this is set to enabled, it is assumed that this
RSM LE system will be managed by a RSM SE Server and the
Customer Number field is not changeable at RSM LE. This is
because the RSM SE system manages the Customer Number.

RSM Server Discovery


Dynamic/Fixed - Determines if a managed client gets the address
of the managing server dynamically or whether you assign a fixed
address for the SE Server.

Connected RSM Server


If RSM Server Discovery is Dynamic, this shows the last RSM SE
Server that the client communicated with.

RSM Server (Primary)


If RSM Server Discovery is Fixed, this field is for setting the name
or IP address of the server.

RSM Server (Secondary)


In a dual server environment, this field is for setting the name or IP
address of the secondary server.

Logical System Name


An identifying name for this system that can be used to identify
this system by a name other than its computer name, at RSM
Servers. For example, it may be desirable to use names like Lane 1
or Bakery to identify the location or usage of the system
Chapter 2: Using RSM LE 19

Custom Tag
Permit you to group systems into various roles such as the
functional area in the store, a region in the country, or any other
grouping you wish.

OS Monitor
Enable/Disable the monitoring of the Operating System.

File Agent
This must be enabled to support file distribution packages
scheduled from RSM SE or RSM EE.

Software Agent
This must be enabled to support software execution in packages
scheduled from RSM SE and EE servers.

Default Destination Directory


The default destination directory used for packages that contain
distributed files but no destination directory is defined in the
package.
20 Chapter 2: Using RSM LE

Licensing
The licensing section shows the current licensing information. These
are all information fields and cannot be changed on this screen.

Current User
The current user is the user who is currently logged into this
session of RSM LE.

License File
This shows the name of the license file currently in use.

License Expiration
This is the expiration date for the license file.
Chapter 2: Using RSM LE 21

Alerting
The Alerting section permits you to change the settings for the logs and
tallies and permits you to configure the SNMP Agent.

Log Event Types


Select the event types that will be logged to the Windows event log.
All types not selected will be excluded from the event log, but are still
used for determining State of Health and critical events. If none of the
event types are selected, the event filter is disabled and all event types
are logged. The types include:
• Error
• Warning
• Information
• Success Audit
22 Chapter 2: Using RSM LE

• Failure Audit

Tally Flush Interval


The frequency at which tally values are flushed from memory to
persistent storage. The default is 60 minutes.
Chapter 2: Using RSM LE 23

Flushing tallies to permanent storage also triggers sending any tally


updates to the RSM SE server. Frequent tally flushes can create
unnecessary system overhead and can slow down system response
time.at RSM SE.

RSM SNMP Configuration


Perform the following to configure RSM SNMP. Using the RSM LE
user interface, navigate to Administration → Alerting → SNMP
Agent and enable the SNMP Agent. Review the other SNMP settings
to see if any other changes are desired.
Note that the Microsoft SNMP Agent must be running to be able to use
the RSM SNMP Agent.

The SNMP agent is disabled by default and must be enabled by the


user. Your RSM license must also permit the use of SNMP.
After the SNMP agent has been enabled, the various types of traps and
other settings are shown.
24 Chapter 2: Using RSM LE

For additional information on the SNMP Agent, refer to the RSM


SNMP Agent chapter in the Retail Systems Manager Software User’s Guide
(B005-0000-1518).

State of Health Alerts


SNMP traps may be sent for State of Health (SOH) changes. There are
different traps for the various types and severities of State of Health
changes. You may configure which types of traps are sent from the
system. For example, you may choose to send Overall alerts for all
severities but may choose to send Device Alerts only for states that
require attention.
The types of SOH alerts (Overall, Category, System, and Device) are
described in the sections that follow. For each SOH alert type, the
severities are the same. The severities are:
• Healthy
• Attention Soon
• Attention Now
• Not Configured
• Unknown
Chapter 2: Using RSM LE 25

Overall Alerts
Overall traps may be sent for changes in the overall status of the
terminal or kiosk. This is a roll up of the statuses of the terminal based
on the status of all devices.
The Overall traps may be filtered by severity. The “Suppress Overall
Alerts with…” setting in the RSM UI allows configuration of which
Overall traps should be sent or suppressed. Checking the alert means
that it will be suppressed. Select Administration → Alerting → SNMP
Agent - Suppress Overall Alerts with.

This is an example where all overall alerts are suppressed.


Category Alerts
Category traps may be sent for changes in the State of Health
categories on the terminal or kiosk. Category is a sub-classification of
the terminal, peripheral, or peripheral device state. These categories
include Configuration, Hardware, Maintenance, OPOS, and UPOS.
The Category traps may be filtered by severity. The “Suppress
Category Alerts with…” setting in the RSM UI allows configuration of
which Category traps should be sent or suppressed. Checking the alert
means that it will be suppressed. Select Administration → Alerting
→ SNMP Agent - Suppress Category Alerts with.
26 Chapter 2: Using RSM LE

This is an example where all category alerts are suppressed.


System Alerts
System traps may be sent for changes in the system State of Health for
a terminal or kiosk. This is the state of the base system, not the state of
peripherals or other devices in the system.
The System traps may be filtered by severity. The “Suppress System
Alerts with…” setting in the RSM UI allows configuration of which
System traps should be sent or suppressed. Checking the alert means
that it will be suppressed. Select Administration → Alerting → SNMP
Agent - Suppress System Alerts with.

This is an example where no system alerts are suppressed.


Chapter 2: Using RSM LE 27

Device Alerts
Device traps may be sent for changes in the State of Health for a
peripheral or device on a terminal or kiosk. The State of Health for
each device on the system is monitored separately.
The Device traps may be filtered by severity. The “Suppress Device
Alerts with…” setting in the RSM UI allows configuration of which
Device traps should be sent or suppressed. Checking the alert means
that it will be suppressed. Select Administration → Alerting → SNMP
Agent - Suppress Device Alerts with.

This is an example where no device alerts are suppressed.

Critical Event Alerts


Traps may be sent when an event is logged and reaches a configured
Critical Event threshold. Although the content of the trap is similar to
the Store Minder Event Traps from the NCR Retail SNMP Agent, the
Critical Event traps for the RSM SNMP Agent are sent only for events
configured as Critical Events through RSM, not for all events logged.
The Critical Event traps may be filtered by severity. The “Suppress
Critical Event Alerts with…” setting in the RSM UI allows
configuration of which Critical Event traps should be sent or
suppressed. Checking the alert means that it will be suppressed.
Select Administration → Alerting → SNMP Agent - Suppress
Critical Event Alerts with.
28 Chapter 2: Using RSM LE

This is an example where the Information, Success Audit, and Failure


Audit critical event alerts are suppressed.

Tally Alerts
Traps may be sent when a tally reaches a tally threshold configured
through RSM. Note that Tally Threshold Traps are new in the RSM
SNMP Agent and were not supported in the NCR Retail SNMP Agent.
The Tally Threshold traps may be filtered. The “Suppress Tally Alerts
with…” setting in the RSM UI allows configuration of whether Tally
Threshold traps should be sent or suppressed. Checking the alert
means that it will be suppressed. Select Administration → Alerting
→ SNMP Agent - Suppress Tally Alerts.

Trap Queue Configuration


State of Health and Critical Event traps share one queue. Tally traps
are in a separate queue. The configuration values below apply to both
queues.
Chapter 2: Using RSM LE 29

Maximum Alerts in Queue


Select Administration → Alerting → SNMP Agent - Maximum Alerts
in Queue.

Maximum Alerts in Queue defines the length of the internal queue for
TRAP events. If the queue becomes full, TRAP events will be dropped
(based on this value). Possible values are 10 through 1000. Default:
256.
When Full Queue
Select Administration → Alerting → SNMP Agent - When Queue
Full.

This determines the strategy for managing the internal TRAP queue
when the queue becomes full and a new TRAP event is created. The
possible values are:
1 - Discard Old Alerts (overwrite older TRAP events) (Default)
2 - Discard New Alerts (ignore new TRAP events)

Heartbeat Configuration
Heartbeat Interval
The interval (in seconds) between which the RSM SNMP Agent will
send a periodic heartbeat trap. A zero (0) value indicates that no
heartbeat trap should be sent. Possible values are 0 through 86400
seconds (24 hours).
30 Chapter 2: Using RSM LE

Select Administration → Alerting → SNMP Agent - Heartbeat


Interval.

Traps per Heartbeat


This is the total number of traps to be sent for a single heartbeat.
Possible values are 0 through 16. Select Administration → Alerting
→ SNMP Agent - Traps per Heartbeat.

Delay between Traps


The time (in centi-seconds) between traps in a single heartbeat.
Possible values are 0 through 3000. Select Administration → Alerting
→ SNMP Agent - Delay Between Traps.
Chapter 2: Using RSM LE 31

Critical Events
In the Critical Events section, you can change and view the threshold
information for the various critical errors that were automatically set
up during the RPSW installation. You can also add your own
additional events.
32 Chapter 2: Using RSM LE

Select Administration → Critical Events. You can then go through


the different event sets by selecting Next Set or Previous Set.
Optionally, you can select the Critical Event Set line and use the drop-
down list to select the set as shown in the following.
Chapter 2: Using RSM LE 33

After an event set has been chosen, you can select a specific error and
change the threshold information.

The fields are setup as follows:


• Source - Event source
• Event ID
• FSMID - If the event message contains the Finite State Machine ID
(FSMID) field to specify the instance of the monitored item (profile
name for peripherals, process name for process monitoring, file
name for file monitoring), this field can be used to configure a
critical event for a specific FSMID.
• Threshold - How many times the event should occur before an alert
is sent.
• Count - Current count of how many times the event has occurred.
• Reset Count - Reset the count value when the threshold occurs or
don’t reset the count.
• Command Line (optional) - Command line to run when the
threshold is reached.
34 Chapter 2: Using RSM LE

When you select the Add Event button, you select the Group;
Application, Security, or System and then the parameters are the same
as the modify explained above.
If licensed, an additional Message Files tab is provided on this screen.
The message files tab allows viewing the messages in the event
message files registered, for any event source. This is useful for
determining what the critical events mean and for determining what
events the user wants to configure. You can choose the message Group
and then you can choose a source within that group. The message file,
message numbers and descriptions appear for that source.

Group - Application, Internet Explorer, Security, or System


Source - Source of the event
Message File - Path of the message file
No. of Event Messages - Number of event messages in the message file
Event Messages Set - Displays the message set for sources with many
messages. Use the Next Set or Previous Set to access other sets for
the source.
Chapter 2: Using RSM LE 35

Choosing the message set provides the following information:


• Event ID
• Message - The message description. Select the message to view the
entire message.
• Type - The type of message, ex. Warning
• Message Source File - Location of the file containing the message.
• Resolution - If this feature is licensed, this may contain information
about how to correct the problem

Tally Thresholds
Tallies are counts of the number of times a certain operation is
performed. For example, the number of track 1 reads on the Magnetic
Stripe Reader. A tally threshold is the number of tallies recorded for a
device when you wish to be notified.
There are multiple ways to set tally thresholds:
36 Chapter 2: Using RSM LE

• Default tally thresholds are installed with RPSW. The default tally
thresholds are based on the default profiles. If the default profiles
are not used, the default tally thresholds should be replaced with
tally thresholds for the peripheral profiles used.
• An alternate set of tally thresholds can be installed with RPSW
using a command line parameter to specify a .reg file containing
tally thresholds.
You can go through the device tallies by selecting Next Set or
Previous Set.
Chapter 2: Using RSM LE 37

To add a new tally threshold, select the Administration → Tally


Thresholds → Add Threshold button. Enter the information and
select Add Threshold.

• Source - The device that the tally is defined for.


• Tally - The description for the tally.
• Threshold - The number of times that the tally can occur before you
are notified that the tally limit has been reached.
• Reset Tally - Reset the tally “When Threshold Occurs” or “Never”.
After a tally threshold has been set up, it can be removed by selecting
the tally threshold and then selecting the Remove Tally button.
38 Chapter 2: Using RSM LE

OS Monitoring
Operating System (OS) Monitoring provides a display of various
features that can be measured by the operating system. There are three
sections defined for OS Monitoring as shown with the tabs.
• CPU & Memory
• Disks & Files
• Processes & Services

The CPU & Memory section defines:

System-wide Monitor
• System-wide monitoring - You can enable/disable monitoring of
the CPU/memory usage for the overall system.
• Monitor Interval - This time (in seconds) determines how often the
system-wide monitoring occurs.
Chapter 2: Using RSM LE 39

• System-wide start up delay - This permits you to set the monitoring


to start after the system is fully up. The default values are selected
so that all OS monitoring does not start at the same time.

CPU Usage
• Maximum CPU Usage - You define the highest reading for CPU
usage of the entire system before an alert of the condition is
generated.
• High Usage Tolerance - This is the amount of time (in seconds) that
the CPU can maintain the “Maximum CPU Usage” level before an
event for the condition is generated.

Memory Usage
• Maximum Memory Usage - This is the amount of memory (in KB)
that can be used before an event for the condition is generated.

The Disk & Files section defines:


40 Chapter 2: Using RSM LE

Disk Space
• Disk Space Monitoring - You can enable/disable monitoring of the
disk drives.
• Disk Monitor Interval - The number of minutes between checking
of disk free space. If this is zero, disk monitoring is only done at
the startup of NCRLoader.
• Disk Start Up Delay - This permits you to set the monitoring to
start after the system is fully up. The default values are selected so
that all OS monitoring does not start at the same time.
• Monitored Disks - The logical drives to monitor. Only Fixed drives
are monitored. The options include: ”All Disks” or “Specific
Disks”. If “All Disks” is selected, all drives will be monitored.
• Logical Drive… - You can select a logical drive (or all drives) to
monitor.
• Attention Soon Warning - When the disk drive reaches this
(percentage) capacity, an “Attention Soon Warning” alert is sent.
• Attention Now Warning - When the disk drive reaches this
(percentage) capacity, an “Attention Now Warning” alert is sent.
The Attention Now Warning value should be greater than the
Attention Soon Warning.
• Monitor interval… - This time (in minutes) determines how often
the drives are checked.

S.M.A.R.T Drive
• S.M.A.R.T. Drive Monitoring - You can enable/disable monitoring
of the S.M.A.R.T drives.
• S.M.A.R.T. Monitor Interval - This time (in minutes) determines
how often the drives are checked. If this is zero, SMART disk
monitoring will only be done at the startup of NCRLoader.
• S.M.A.R.T. Start Up Delay - This permits you to set the monitoring
to start after the system is fully up. The default values are selected
so that all OS monitoring does not start at the same time.
Chapter 2: Using RSM LE 41

• Drives Monitored - You can select a S.M.A.R.T drive (or all drives)
to monitor. If “All Drives” is selected, all physical disks connected
will be monitored.

File
• File Monitoring - You can enable/disable the monitoring of files.
• Monitor Interval - This time (in minutes) determines how often the
files are checked. If this is zero, the monitoring will only be done at
the startup of NCRLoader.
• File Start Up Delay - This permits you to set the monitoring to start
after the system is fully up. The default values are selected so that
all OS monitoring does not start at the same time.

Files Monitored
You can add files to be monitored by RSM. To do this, select the Add
button.
1. Select File, then OK.
42 Chapter 2: Using RSM LE

2. Enter the parameters.


• File Name - This is filled with the name of the file that you wish to
monitor.
• Path… - Enter the directory path to the file being monitored.
• Presence… - Select the type of monitoring you want.
• Not Monitored - The presence of file is not monitored.
• Present - Make sure the file is present.
• Not Present - Make sure the file is NOT present.
• Maximum File size - The maximum file size for the file before an
event is triggered. Zero disables maximum file size monitoring.
• Version - Monitor for the version of the file to verify that the correct
version is present. Leaving it blank disables version monitoring.
• Select Add.
Chapter 2: Using RSM LE 43

The following shows that the file was added.

To stop the monitoring for a file, select the line containing the name of
the file, and then select Remove. Confirm the removal by selecting
OK.
44 Chapter 2: Using RSM LE

The Processes & Services section defines:

Processes
• Process Monitoring - You can enable/disable the monitoring of
processes.
• Process Monitor Interval - This time (in minutes) determines how
often the processes are checked. It this is zero, process monitoring
will only be done at startup of NCRLoader.
• Process Start Up Delay - The number of minutes before process
monitoring starts after this module is started by NCRLoader.
Chapter 2: Using RSM LE 45

You can add Processes to be monitored by RSM. To do this, select the


Add button, select Process, then OK.

• Process… - Enter the process to be monitored.


• Path… - Enter the directory path of the process. If the path is not
specified, the process monitoring will check for any process
matching the process name. If a path is specified, both the process
name and path are checked by process monitoring.
• Minimum Instances… - The minimum number of copies of the
process that can be running at the same time. If zero, minimum
instance monitoring is disabled.
• Maximum Instances… - The maximum number of copies of the
process that can be running at the same time. If zero, maximum
instance monitoring is disabled.
• Maximum CPU Usage - The maximum percentage of CPU usage
that the process can use without generating an alert. If zero, CPU
usage is not monitored.
• High Usage Tolerance - This is the maximum number of seconds
the “Maximum CPU Usage” can last until an event is generated.
46 Chapter 2: Using RSM LE

• Maximum Memory Usage - The maximum amount of Memory (in


MB) that the process can use without generating an event. If zero,
process memory usage is not monitored.
• Maximum Handle Count… - The maximum number of handles the
process can use without generating an event. If zero, handle count
is not monitored.
• Maximum Thread Count… - The maximum number of threads the
process can use without generating an event. If zero, process
thread count is not monitored.
Select Add when complete.

To stop monitoring a Process, select the line containing the name of the
Process, and then select Remove. Confirm the removal by selecting
OK.
Chapter 2: Using RSM LE 47

Services
• Service Monitoring - You can enable/disable the monitoring of
Services.
• Service Monitor Interval - This time (in minutes) determines how
often the Services are checked.
• Service Start Up Delay - The number of minutes before service
monitoring starts after this module is started by NCRLoader.
You can add Services to be monitored by RSM. To do this, select the
Add button, select Service, then OK.
48 Chapter 2: Using RSM LE

• Service - Enter the Service to be monitored.


• Startup Type - Specifies whether to monitor the Startup Type of the
service, and if monitored, what Startup Type is expected. If the
actual Startup Type is not the same as this setting, then an event is
logged.
• Automatic
• Manual
• Disable
• Not Monitored
• Status - Specifies whether to monitor the Status of the service, and
if monitored, what Status is expected. If the actual Status is not the
same as this setting, an event is logged.
• Started
• Stopped
• Not Monitored
Select Add when complete.
Chapter 2: Using RSM LE 49

To stop monitoring a Service, select the line containing the name of the
Service, and then select Remove. Confirm the removal by selecting
OK.
50 Chapter 2: Using RSM LE

Data Capture
Data Capture is for use by NCR developers when a problem arises
with NCR software. The NCR developer will give you information for
the Trace Mask and the Level Mask, based on the problem he is trying
to solve.
Data Capture information is accessed from Administration
→ DataCapture.

You can configure data capture for either Simple logging or Advanced
(more detailed) Logging by selecting Configuration.
Chapter 2: Using RSM LE 51

If you select Simple configuration, you can then set the default logging
option by selecting Default Setting. Simple configurations permit
easily selecting the most commonly used data capture settings.
52 Chapter 2: Using RSM LE

Then for each module, you can select from the following.

If you select Advanced logging from the Configuration option, you


can select the options for the Trace Mask and Level Mask.
Chapter 2: Using RSM LE 53

You can set the overall Trace Mask and Level Mask settings (as shown
below) or you can set them for a specific module by selecting the
module.
The Trace Mask settings include:

The Level Mask settings include:


54 Chapter 2: Using RSM LE

There are two versions of Data Capture:


The version used with OPOS 2.x, the NCRFSM, and RSM SNMP have
different mask settings than shown in the previous screens. When you
change the masks for this version of Data Capture, the software that is
writing to data capture must be restarted. For example, in the case of
OPOS, you may have to restart the retail application if that is what has
loaded the OPOS controls.
The version used by Retail Controls 3.x, RSM, and the Base Platform
modules is the version with the settings shown in the previous screens.
In RPSW 2.3 and later and RSM 2.1 and later, the settings take effect
immediately after they are saved through the RSM user interface. In
older releases, these data capture settings do not take effect until the
NCRLoader service is restarted.
For Retail Controls, data capture settings are also listed with the profile
settings. OPOS 2.x data capture settings are set only with the profile
settings and are per profile. Retail Controls 3.x data capture settings
may be set on the data capture page or with the profile settings. The
Retail Controls 3.x data capture settings are per module, not per
profile.

Create Diagnostic File


To simplify retrieval of information for problem resolution, a GDF (Get
Diagnostics File) zip file can be created rather than gathering the files
individually. The GDF feature is available with RPSW 2.3 or RSM 2.1
and higher. If running an earlier version of RPSW/RSM, then the files
must be gathered manually.
A GDF file is a zipped file containing the following:
• Windows System and Application Event logs (*.evt)
• Dr. Watson log file (drwtsn32.log)
• NCR registry key (HKLM\SOFTWARE\NCR)
• OLEforRetail key (HKLM\SOFTWARE\OLEforRetail)
Chapter 2: Using RSM LE 55

• NCR configuration files


• NCR log files
• RSM license files (Program Files\NCR\RSM\Website\XML\*.dat)
• RSM local databases

When a problem occurs, the files should be retrieved immediately. If


the NCRLoader service is restarted or the system is rebooted, then new
log files are created and the old files are renamed to *.bak and older
*.bak files are lost. This also occurs when a log file reaches its
maximum size. If the log files are not retrieved immediately when the
problem occurs, then information about the problem may be lost.
To create a GDF file, use the RSM UI. Select the system or server from
which the information is to be retrieved. Select the Administration
→ DataCapture page. Click on the “Create Diagnostic File” button.
56 Chapter 2: Using RSM LE

A utility to create the GDF file is then launched on the system where
the information is to be gathered. The filename is of the following
form so that creating a file does not overwrite the files previously
created:
<product>_<date>_<time>.zip
For example: RPSW_20060810_133314.zip

The GDF file created is stored in C:\Program Files\NCR\RSM\Diags


on the system where the information is gathered. Note that there is
currently no file retrieval in RSM to get the file from a remote system,
so it must be manually retrieved.
If you are unable to use the UI to create the GDF file, then the zip file
may be created from a command prompt. The command file for
creating the file from a command prompt is RSMlogs.cmd
Chapter 2: Using RSM LE 57

Using Peripherals
Peripherals consist of OPOS/JavaPOS retail peripherals and the Device
Assets.

OPOS/JavaPOS Retail Peripherals


Each of the retail peripherals on the left side has a configuration screen
and a Diagnostics button so that you can test the functionality of the
terminal. If both OPOS and JavaPOS are installed, you can choose the
desired interface by selecting the OPOS or JavaPOS tab.

When RPSW is installed, the default profiles for the retail peripherals
you chose are installed. These profiles provide some default
configurations for the most common uses of the peripherals. You can
change a profile’s configuration or create new configurations based on
your needs.
58 Chapter 2: Using RSM LE

Creating New Profiles


When creating a new profile, select the Device category. In this
example we are adding a new printer, so the POS Printer Device was
chosen. Then select Create. You add a new profile by supplying a
profile name (if your application is to use this profile, the name needs
to match the name your application is using for the device) and the
Programmatic ID (Service Object that the profile is to use). The
Programmatic ID is different depending on whether you are using
OPOS 2.x, JavaPOS 2.x, OPOS 3.x, or JavaPOS 3.x. The OPOS 3.x
Service Objects always have the format “NCROposSO.XXXXXXX. It is
preferable to use the OPOS 3.x objects because of future enhancements
that are being planned. If you choose a 3.x profile, the Model Layer
parameter appears so you can choose a particular set of profile
parameter values which are used as a starting point for the new profile.
The Model parameter is available for 2.x profiles after the profile is
created.
The profile name “My Printer” was chosen, the service object is the
“NCRPrinter.POSPrinter” object, and the profile is based on the printer
model “200” profile. Select Create profile.
Chapter 2: Using RSM LE 59

Changing a Profile
To change a profile, select one of the available profiles from the drop-
down list and select OK.

You can change any parameter that is not grayed out by selecting that
parameter and making the changes. Fields in bold font are changes
that haven’t been saved. After making the changes, select Save.
60 Chapter 2: Using RSM LE

Deleting a Profile
Select the Delete button to remove a profile. Select the profile name to
delete and select Delete.
Chapter 2: Using RSM LE 61

Diagnostics
Two different types of Diagnostics may be performed. Interactive
Diagnostics usually require interaction from the user (swipe a card,
scan an item). Non-interactive Diagnostics usually test the internal
software and/or hardware and do not require user interaction. To run
printer diagnostics, select Peripherals → POS Printer(Desired Profile)
→ Diagnostics button, then Local Attended Diagnostics.

The printer test permits you to select a specific print station and other
parameters associated with that printer. When you press the Print
button, information should be printed on the selected printer.
62 Chapter 2: Using RSM LE

Platform Devices
There are a few system devices that are not controlled by OPOS or
JavaPOS software, and they may provide some configuration
information or other information about the device. The devices that
are not controlled by OPOS or JavaPOS include the following:

Audio
• Audio volume
• Diagnostics button tests Stereo, Left, or Right Speaker

BIOS
BIOS Information
• BIOS Version
• BIOS Release Date
• BIOS Vendor
• BIOS ROM Size
• BIOS OEM String
Chapter 2: Using RSM LE 63

System Information
• NCR Class & Model
• NCR Serial Number
• Manufacturer
• Motherboard ID
• Browser Button (for AMT if installed)

Disks - Provides information for each drive in the system


Disk Information
• Number of Physical Disks
• Physical Drive 0 Size
• Number of Logical Disks
• Logical A Type (for each drive in the system)
• Logical C Type
• Logical C Total Size
• Logical C Free Space
• Logical D Type
• Diagnostics button permits you to select the drive and then that
drive’s properties are shown.
• SMART drive information where available.

Display (legacy systems only)


• Panel Type
• Brightness
• Contrast
• Screen Blank Delay
64 Chapter 2: Using RSM LE

Memory - If licensed
• Physical Memory
• Available Memory
• Memory Usage
• Page File Size
• Available Page File Size

Motherboard
• NCR Class & Model
• NCR Serial Number
• Manufacturer
• Manufacturer ID
• Processor
• System-wide CPU Usage

Hardware Monitor Information


• Processor Temperature
• System Temperature
• Processor Fan
• VCORE Voltage
• Various Voltages (based on terminal type)

Network
• Computer Name
• Number of Adapters
• Adapter 1 MAC Address (for each adapter)
Chapter 2: Using RSM LE 65

• Adapter 1 IP Address (for each adapter)


• TCP and UDP port usage
• Diagnostics button permits you to test Ethernet or WaveLAN
communications. If hardware specific diagnostics are not available
for the network adapter, selecting Ethernet, brings up the Control
Panel so that you can check the Network Connections.

Operating System - If licensed


• Version
• Build
• Service pack
• Hot fixes
• User Name
• System Drive
• System Root
• WinDir
• Temp
• OS
• Path
• ClassPath

OS Image
• NCR Part Number
• NCR LPIN
• NCR Version

Power States (refer to the following section)


66 Chapter 2: Using RSM LE

Serial Ports
• Identifies the COM Ports attached to the system.
• Diagnostics button permits you to choose a COM port, and then a
turnaround test is performed if a turnaround plug is installed on
that port.

Software - If licensed
Lists the software installed on the system.

Touchscreen
• Controller
• Diagnostics button to test a touchscreen

UPS (only if installed with custom install).

Versioning
Version numbers for the modules in the following categories:
• RSM Version
Common
• Common Kernel Drivers
• Common Libraries
• Common IO Libraries
• Common OSAL Libraries
• Common Utilities
Platform
• Platform Agents
• Platform HAL
Chapter 2: Using RSM LE 67

• Platform Kernel Drivers


• Platform Libraries
AMT support for NCR POS terminals with AMT support (7459) is a
feature requiring RSM Server support and is described in the NCR
Retail Systems Manager User’s Guide (B005-0000-1518).

Retail Controls
• JavaPOS Retail Controls
• Retail Control Models
• OPOS Retail Controls
• RSM

These devices may generate critical events, such as when the disk
becomes full.

Power States
The Power States for a System can be controlled within RSM. The
following control is provided:
• Restart
• Shutdown
• Daily Reset
• Daily Wake Up (wake on alarm)
• Power Switch (on terminals that support power switch disable)
• Reboot Type (cold/warm)
• Boot Order (normal/network)
68 Chapter 2: Using RSM LE

The various models of retail systems support different power states. To


access the Power States, select Platform → Power States.
Chapter 2: Using RSM LE 69

Restrictions
Standby is supported only if the system and the operating system
support ACPI and standby. Standby is not supported on Windows
NT.
Some of the 7402, 7457-4xxx, and 7458-4xxx terminal systems do not
wake (Wake-on-LAN or Daily Wake Up) from the off state (depending
on the BIOS version). All versions do wake from Standby.
Some systems may require OS, network driver configuration, or BIOS
changes to enable Wake-on-LAN.
The Power Switch enabled/disabled setting is supported only on the
following systems:
• 7452
• 7453
• 7456
• 7457-1xxx and 2xxx
• 7458-1xxx and 2xxx

The Reboot Type and Boot Order settings which affect the
corresponding BIOS settings are supported only on the following
systems:
• 7402
• 7403
• 7457-4xxx
• 7458-4xxx
• 7459

You might also like