Book Template

NCR
Retail Controls 3.x UPOS
User’s Guide for Windows
B005-0000-1619
Issue K
The product described in this book is a licensed product of NCR Corporation.
NCR is a registered trademark of NCR Corporation.
NCR RealPOS, NCR RealPrice, NCR RealScan, NCR EasyPoint and NCR FastLane are either registered
trademarks or trademarks of NCR Corporation in the United States and/or other countries.
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 Solutions Group
NCR Corporation
Discovery Centre, 3 Fulton Road
Dundee, DD2 4SW
Scotland
Internet Address: http://www.info.ncr.com/eFeedback.cfm
Copyright © 2007 - 2010
By NCR Corporation
Duluth, GA U.S.A.
All Rights Reserved
Preface
Audience
This book is written for hardware 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.
2
OPOS
References

NCR Retail Systems Manager Software User's Guide
(B005-0000-1518)

NCR Retail Platform Software for Windows
(B005-0000-1634)
3
Table of Contents
UPOS for Windows
Additional Software Requirements ................................................... 1-5
Using Retail Systems Manager LE for Windows ............................. 1-5
Bold or Unknown Settings............................................................ 1-5
Creating a New Profile ........................................................................ 1-7
Changing a Profile.............................................................................. 1-11
Data Capture ....................................................................................... 1-13
Biometrics – Fingerprint Reader....................................................... 1-16
Biometrics Configuration Entries .............................................. 1-16
Biometrics Data Capture Configuration Entries...................... 1-16
Cash Drawer - Attached to Printer .................................................. 1-18
Cash Drawer Configuration Entries.......................................... 1-18
CashDrawer Data Capture Configuration Entries .................. 1-20
Cash Drawer - Attached to POS Terminal...................................... 1-22
Cash Drawer Configuration ....................................................... 1-23
CashDrawer Configuration Entries........................................... 1-24
CashDrawer Data Capture Configuration Entries .................. 1-25
Hard Totals.......................................................................................... 1-27
Hard Totals Configuration Entries............................................ 1-27
HardTotals Data Capture Configuration Entries .................... 1-28
Keylock ................................................................................................ 1-30
Keylock Configuration Entries................................................... 1-30
Keylock Data Capture Configuration Entries.......................... 1-31
Line Display ........................................................................................ 1-32
NCR5972LineDisplay .................................................................. 1-32
Line Display Configuration Entries .......................................... 1-32
NCR5973LineDisplay .................................................................. 1-34
4
OPOS
Line Display Configuration Entries .......................................... 1-34
NCR59752x20LineDisplay .......................................................... 1-35
Line Display Configuration Entries .......................................... 1-36
NCR5975IntLineDisplay ............................................................. 1-37
Line Display Configuration Entries .......................................... 1-38
NCR7402LineDisplayAPA ......................................................... 1-39
Line Display Configuration Entries .......................................... 1-39
NCR7402LineDisplay2x20 .......................................................... 1-41
Line Display Configuration Entries .......................................... 1-41
NCR7443/7446LineDisplay2x20................................................ 1-43
Line Display Configuration Entries .......................................... 1-43
LineDisplay Data Capture Configuration Entries................... 1-44
MICR .................................................................................................... 1-47
DirectIO – MICR Parsing ............................................................ 1-47
DirectIO - Set Remove Non Digits............................................. 1-52
Clear Exception Table.................................................................. 1-53
MICR - Magnetic Ink Character Recognition Configuration
Entries ............................................................................................ 1-53
MICR Data Capture Configuration Entries.............................. 1-55
MotionSensor ...................................................................................... 1-56
MotionSensor - Motion Sensor Configuration Entries ........... 1-56
Motion Sensor Data Capture Configuration Entries............... 1-57
MSR ...................................................................................................... 1-58
USB Keyboard and Dynakey MSR Configuration Entries..... 1-58
USB Keyboard and Dynakey MSR Configuration Entries..... 1-58
USB Keyboard and Dynakey MSR Data Capture
Configuration Entries .................................................................. 1-60
NCR 5966 MSR Configuration Entries...................................... 1-60
NCR 5966 MSR Configuration Entries...................................... 1-61
NCR 5966 MSR Data Capture Configuration Entries ............. 1-62
NCR ICM 330 USB DIP MSR Configuration Entries .............. 1-62
5
NCR ICM 330 USB DIP MSR Configuration Entries .............. 1-62
NCR ICM 330 USB DIP MSR Data Capture Configuration
Entries ............................................................................................ 1-63
POS Printer .......................................................................................... 1-64
DirectIO - Raw Output................................................................ 1-65
DirectIO - Set Barcode Width ..................................................... 1-67
DirectIO - Set Bitmap Type......................................................... 1-68
DirectIO - Sound Audible Tone ................................................. 1-69
DirectIO - Set Minimum Number of Characters Per Line...... 1-70
DirectIO - Get the Current Printer Status ................................. 1-72
DirectIO – Get Kiosk Specific Sensor Status............................. 1-74
DirectIO – Set Autoeject Timeout .............................................. 1-75
DirectIO – Eject Receipt............................................................... 1-76
DirectIO – Get Kiosk Specific Status ......................................... 1-77
DirectIO – Change Paper Low Reporting................................. 1-78
DirectIO – Set Black Mark Configuration................................. 1-79
DirectIO – Set Minimum Receipt Length ................................. 1-80
DirectIO – Set Receipt Retain Length........................................ 1-82
DirectIO – Get Two Sided Thermal Paper Type...................... 1-83
POS Printer Configuration Entries ............................................ 1-84
Common Configuration Entries ................................................ 1-84
NCR 71xx Specific Configuration Entries................................. 1-88
Kiosk Specific Configuration Entries ........................................ 1-89
H6000 Specific Configuration Entries ....................................... 1-91
Mod34 Specific Configuration Entries ...................................... 1-92
POS Printer Data Capture Configuration Entries ................... 1-93
Two-Sided Thermal Printing...................................................... 1-94
Escape Sequences to Control the Two-Sided
Functionality within a Mode.................................................. 1-96
Special Escape Sequences to Switch between Modes......... 1-99
Select Print Side Sequence .................................................... 1-100
6
OPOS
OPOS / JavaPOS Mode Functional Definition.................. 1-101
Two Sided Thermal Specific Configuration Entries.............. 1-103
Scale .................................................................................................... 1-109
DirectIO - Scale Status ............................................................... 1-109
DirectIO - Scale Read ROM ...................................................... 1-110
DirectIO - Scale ROM Version.................................................. 1-111
DirectIO - Scale Live Weight .................................................... 1-112
DirectIO - Scale Direct Access .................................................. 1-113
Method Updates......................................................................... 1-114
ReadWeight Method Updated in UPOS Release 1.9 ...... 1-114
zeroScale Method Updated in UPOS Release 1.9 ........... 1-115
Event Updates ............................................................................ 1-116
StatusUpdateEvent Updated in Release 1.10 .................... 1-116
Scale Serial or NCR USB Configuration Entries .................... 1-118
Scale Configuration Entries ...................................................... 1-118
Scale USB Configuration Entries ............................................. 1-121
Scale USB Configuration Entries ............................................. 1-121
Scale Data Capture Configuration Entries ............................. 1-122
Scanner............................................................................................... 1-123
DirectIO - Scanner NOT-ON-FILE .......................................... 1-123
DirectIO - Scanner Tone Control ............................................. 1-125
DirectIO - Scanner Reset ........................................................... 1-126
DirectIO - Scanner Status .......................................................... 1-127
DirectIO - Scanner Read ROM ................................................. 1-128
DirectIO - Scanner ROM Version ............................................ 1-129
DirectIO - Scanner Pacesetter Options.................................... 1-130
DirectIO - Scanner Direct Access ............................................. 1-131
Scanner Serial or NCR USB Configuration Entries ............... 1-132
Scanner Serial or NCR USB Configuration Entries........... 1-132
Scanner USB Configuration Entries ........................................ 1-141
Scanner USB Configuration Entries .................................... 1-141
7
Scanner JavaPOS Configuration Entries................................. 1-145
Scanner JavaPOS Default Configuration Entries .............. 1-145
Scale JavaPOS Default Configuration Entries ................... 1-146
Scanner Data Capture Configuration Entries ........................ 1-149
Scanner Frequently Asked Questions ..................................... 1-150
Scanner Software and Manuals ........................................... 1-150
Scanner setup suggestions for NCR UPOS ........................ 1-150
ToneIndicator.................................................................................... 1-162
DirectIO – Set Keyclick Tone.................................................... 1-162
ToneIndicator - Tone Indicator Configuration Entries......... 1-163
Tone Indicator Data Capture Configuration Entries ............ 1-164
8
OPOS
Revision Record
Issue
Date
Remarks
A
Dec 2005 Updates to USB Scale.
B
Apr 2006 Updates for Retail Controls 3.6 scanner/scale
C
May 2006 Updates to POS Printer for Two-Sided Thermal
Printing
D
Aug 2006 Updates to Scanner, Cashdrawer, and POS Printer
E
Jan 2007 Updates to scanner, cashdrawer, line display and
POS printer. Updated RSM screen shots
F
Mar 2007 Update Scanner for 7404 EP Advantage Scanner
profile settings and FAQ on scanner configuration.
G
Apr 2007 Update Scanner for NCR2356 Scanner profile
settings and FAQ on scanner configuration.
Update Scale for zeroScale notes.
Printer TST updates.
H
Aug 2007 Update Scanner for RTS Enable/Disable control
and Scanner FAQ on configuration.
Added the 7194 printer
Fixed several entries throughout that were missing
supported printer models
Updated the list of supported USB Dynakeys for
the MSR, Keylock, and Tone
I
Jan 2008 Changed the title to be consistant with the Linux
version
0BUPOS for Windows
J
Nov 2008 RC 3.9 updates.
Cashdrawer initial status update.
Scanner new models 7874 and 7884. Update
Scanner FAQ
Printer Two Sided Thermal (2ST)
K
Mar 2010 ICM 330 DIP MSR
Scale StatusNotify
Scale USB profile settings
Scanners: NCR 7893, 7409 Integrated (4980)
Scanners USB profile settings
USB MSR additional profile settings
9
1
UPOS for Windows
The following table shows the devices that are supported for this
version of the Retail Controls for Windows.
UnifiedPOS Control
NCR
Support
Devices Supported
Biometrics - Fingerprint Reader
YES
Integrated or USB
Bump Bar
NO
Cash Changer
NO
Cash Drawer - On Printer
YES
NCR 7167, NCR7197 Printers
Cash Drawer - Terminal
YES
NCR7402/7404/7443/7446/7449/
7456/7457/7458/7459.
NCR 7453-3xxx
CAT - Credit Authorization
Term
NO
Check Scanner
NO
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
Remote Order Display
NO
Scale
YES
NCR 7872, 7874, 7875, 7876, 7878,
7883, 7884 (Serial, USB)
Scanner
YES
ConnectionType:
NCR 7156, NCR 7158, NCR 7167,
NCR 7197, K580, K590, 7342F306, 7342-F307, 7342-F309,
H6000
(Serial, NCR USB, or USB)
Note 1: USB – OS supported
HID USB
NCR 7872/74/75/76/78
Note2: NCR USB – A USB
scanner connected through a
Virtual Serial COM port
emulation driver. Requires
additional driver install.
NCR 7883/84, NCR 7892, 7893
NCR 2356 Handhelds
ConnectionType:
(Serial or NCR USB only)
NCR 7837
See Scanner Frequently Asked
Questions (FAQ) section for
scanner configuration settings.
NCR 7838
NCR 7880, NCR 7882
NCR 2357
3800, 4600, 5600/20
ConnectionType:
(Serial Only)
NCR 7832 (Serial)
ConnectionType:
(USB Only)
NCR 7404 Integrated (2357)
NCR 7409 Integrated (4980)
Signature Capture
NO
Tone Indicator
YES
NCR 5932 USB Keyboard,
5953 USB Dynakey, or 5954 USB
Dynakey
NCR uses standard JavaPOS 1.11 Device Controls as provided by the
JavaPOS committee (they are open source).
Similarly, NCR OPOS Service Objects are compatible with the
Common Controls for OPOS 1.11.
The OPOS and JavaPOS specifications have now been combined into
one specification called UPOS (Unified Point of Service). The latest
UPOS specification can be found at: http://www.nrf-arts.org/.
Additional information on JavaPOS can be obtained from:
http://www.javapos.com and/or
http://www.javapos.com/samplecode.html
NCR provides older architecture 2.x OPOS controls and newer
architecture 3.x UPOS (OPOS/JavaPOS) controls. This document
describes only the 3.x controls. The UPOS configuration profile
Programmatic ID determines which NCR control type will be used.
The programmatic ID for UPOS controls is
“ServiceName.DeviceName”.
For example, a 2.x scanner profile will have a programmatic ID of
“NCR78xx.Scanner”. Where “NCR78xx” is the NCR 2.x scanner
service and “Scanner” is the OPOS device name.
A 3.x scanner profile uses the NCR 3.x service object name
“NCROposSO” as the service name. For example, the 3.x scanner’s
service object is “NCROposSO.Scanner”.
This document is intended to describe the NCR 3.x controls and their
configuration. The 2.x controls are explained in the OPOS Windows
Help File (BD90-0264-B).
This document only describes the NCR specific differences from the
UnifiedPOS specification and is to be used in conjunction with that
specification.
The term Retail controls is defined as an overall term which includes
both OPOS and JavaPOS for Linux or Windows. The following table
shows the relationship of some of the terms between OPOS and
JavaPOS.
Retail Controls
JavaPOS
OPOS
Device Control
Control Object
Device Service
Service Object
Additional Software Requirements
Using Retail Systems Manager LE for Windows
The Retail Systems Manager LE permits you to control power-up
functionality and report some of the system parameters.
Note: Make all changes to a peripherals configuration using the Retail
Systems Manager interface. If you change a peripheral’s configuration
directly in the registry, the new value may not be recognized.
Refer to the NCR Retail Systems Manager Software User's Guide (B0050000-1518) for additional information on using Retail Systems Manager
Manager. Additional information on Retail Systems Manager LE is
found in the NCR Retail Platform Software for Windows document
(B005-0000-1634).
Devices are listed in the Device tree in RSM LE only if they are
installed. If only certain controls were installed using the RPSW
custom install, only those peripherals are in the tree.
Bold or Unknown Settings
When using the RSM user interface, if a setting is displayed in bold, it
means that the value has been changed and has not been saved. If a
setting is bold when a page is initially displayed (and therefore the
user didn’t make a change), the RSM UI found an invalid value and is
displaying the default value. Select Save to set this or Cancel/Discard
to leave the setting as is.
If a setting contains a bit mask and it is bold when a page is initially
displayed, the meaning is slightly different. Bit mask settings include
settings like the data capture settings that appear as check boxes in the
RSM UI. Bold still means that the setting is unknown, but it means that
there are undefined bits set. Rather than reverting to a default value
for the entire setting, the valid bits that are set remain set, and the
invalid bits are cleared.
“Unknown” settings means the RSM UI can’t retrieve the setting. The
setting may be missing. If the setting does exist, this may be a sign that
there is a problem with the NCRLoader service.
Creating a New Profile
If you wish to add a new profile for a particular Retail Control, Select
the type of device type on the left side of the screen and then select the
“Create” button.
Enter the Profile name that identifies this particular configuration.
Select the “Service…” line which is the Programmatic ID for the
service. Then select the Programmatic ID for the Retail Control being
used. Other entries may appear depending on the Service Object
selected, such as the Model Layer parameter shown in the following
example.
After these parameters have been entered, select “Create Profile”. The
specific values for the profile with default values assigned are shown.
If you wish to change a particular parameter, select that parameter and
you are provided with the configuration values to select. For example,
if you wish the change the reporting of the method of the Y-Cable
Status shown above, select “Y-Cable Status” and then select a valid
value from the drop down list. After selecting new parameter values,
select the Save button at the bottom of the screen. For additional
information on using the Retail Systems Manager (RSM), refer to the
NCR Retail Systems Manager Software User’s Guide (B005-0000-1518).
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. If you change the Model setting
that identifies the model of the peripheral, other settings may be
affected.
For additional information on using the Retail Systems Manager
(RSM), refer to the NCR Retail Systems Manager Software User’s Guide
(B005-0000-1518).
Data Capture
The Data Capture menu permits you to set the Trace Mask and Level
Mask for the various modules that are used by RSM. Data Capture is
for use by NCR developers when a problem arises with RSM. The
NCR developer will give you information for the Trace Mask and the
Level Mask based on the problem he is trying to solve. The Data
Capture information is accessed from Administration DataCapture
or from each device page Devices XXXX.
You can set the overall Trace Mask and Level Mask settings or you can
set them for a specific module by selecting the module.
The Trace Mask settings include:
The Level Mask settings include:
Biometrics – Fingerprint Reader

The Biometrics Service currently supports and integrated or
external USB Fingerprint Reader.
Biometrics Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
A configuration name such as
NCRBiometrics.0, (Any name you
wish)
Programmatic ID
The Service Object being used by this control.
NCROposSO.Biometrics
NCR Model Layer
The cash drawer(s) are connected to a printer.
Therefore, the printer must also be available.
This is the Device Service for the printer.
NCRDPFingerprintReader
UseSerialNumber
This setting allows a specific Fingerprint
Reader device to be used. This is only necessary
if two or more Fingerprint Readers are
connected to a single terminal. If this value is
not filled in, the Service will use the first
Fingerprint Reader device it finds when
enumerating USB.
Default is empty.
Biometrics Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the Biometrics Service is controlled through settings stored
in the NCRDatacap.conf configuration file. The following example
shows how to enable maximum data capture for all of the Biometrics
components.
[NCROposSO.Biometrics]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRDPFingerprintReader]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Cash Drawer - Attached to Printer
The CashDrawer supports 1 or 2 cash drawers connected to the
following printers:

NCR 7156 Printer.

NCR 7158 Printer.

NCR 7167 Printer.

NCR 7168 Printer.

NCR 7194 Printer.

NCR 7197 Printer.

NCR 7198 Printer.
Cash Drawer Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
A configuration name such as
NCRCashDrawer.0, (Any name
you wish)
Programmatic ID
The Service Object being used by this control.
NCROposSO.CashDrawer
NCR Model Layer
The cash drawer(s) are connected to a printer.
Therefore, the printer must also be available.
This is the Device Service for the printer.
NCR71xxPrinterCDMICRModel
Uses Profile
The printer profile that manages this drawer . It
uses the configuration parameters of the Printer
in addition to the parameters described here.
Therefore, the Printer configuration entries must
be set up first. If you delete the Printer service
object, the cash drawer can not be used.
POSPrinter\NCRPOSPrinter.0
Cash Drawer
Number
Number of the cash drawer to be controlled.
Drawer 1 (default) or Drawer 2
YCableStatus
This setting determines how the cash drawer
status is reported back to the application. This
is intended to permit applications to work
around the hardware limitation caused by the
use of a Y-Cable in order to support two cash
drawers. Most of the settings only have an
effect when used with printers that support dual
cash drawers with a Y-Cable. The following are
the values for this parameter:
Report Drawer 1 Only
Report Drawer 1 Only. Backwards
Compatibility = Reports the cash drawer status
as all previous releases of this OPOS Service
Object. No matter which drawer is open, the
status is always reported as drawer 1.
Report Last Drawer Opened - In this case
when a drawer open is detected, the open status
is reported for the last drawer which was sent an
Open command. If the Open is sent to drawer 1
then drawer 1 shows open, if to drawer 2 then
drawer 2 shows open. If drawer 1 or 2 is
already open, and an Open is sent to the other
drawer, then both drawers report open. Both
drawers remain reporting open until both
drawers are closed, because we cannot detect
If the Printer profile has not been
setup, this field shows “None.”
Report Last Drawer Opened
(default)
Report Each Drawer
Don't Report Status
Parameter
Description
close until both are closed.
Valid Values
Report Each Drawer - This basically reports
exactly what the hardware tells us. If either
drawer 1 or drawer 2 is open, then both drawers
are reported open. If drawer 1 is open then both
1 and 2 report open. If drawer 2 is open then
both 1 and 2 report open. Both are reported
open until both drawers are closed.
Don't Report Status - This affects all cash
drawer types. In this mode the CapStatus
capability reports FALSE, and both drawers
always show closed regardless of the actual
drawer status.
CashDrawer Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the CashDrawer is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the CashDrawer
components.
[NCROposSO.CashDrawer]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR71xxCashDrawerModel(0)]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR71xxCashDrawerModel(1)]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR71xxPrinterCDMICRModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Cash Drawer - Attached to POS Terminal
The CashDrawer supports 1 or 2 cash drawers connected to the
following terminals.

NCR 7403

NCR 7409

NCR 7453 - 3xxx

NCR 7456

NCR 7457

NCR 7458

NCR 7459

NCR 7402

NCR 7404

NCR 7443

NCR 7446

NCR 7449
Cash Drawer Configuration
CashDrawer Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
A configuration name such as
NCRCashDrawer.3 (Any name you
wish)
Programmatic ID
(OPSOS)
The Service Object being used by this control.
NCROposSO.CashDrawer
Or
serviceClass
(JavaPOS)
NCR Model Layer
ConnectionType
com.ncr.retail.jpos.services.cashdrawer
.CashDrawerService
The cash drawer(s) are connected to the terminal.
Type of cashdrawer interface to be used.
M – Motherboard (integrated).
U – USB, HID USB to NCR RS485 dongle.
Note: Terminals not specifically listed should use
“M” for Motherboard connection type. The service
object will select the connection type based on the
Motherboard type.
Model
Type of cashdrawer.
NCRCashDrawerProcessor
M (default)
U
7404
7443
744321xx
7446
7449
Note: RS485 requires special hardware.
INTEGRATED(default),
RS485
nDeviceNumber
Number of the cash drawer to be controlled.
Drawer 0 (default) or Drawer 1
Uses Profile
The cashdrawer profile that manages this drawer . It
uses the configuration parameters of the managing
cashdrawer in addition to the parameters described
here. Therefore, the managing cashdrawer
configuration entries must be set up first. If you
delete the managing cashdrawer service object, the
cash drawer can not be used.
CashDrawer\Cashdrawer.0
This setting determines how the cash drawer status
is reported back to the application. This is intended
to permit applications to work around the hardware
limitation caused by the use of a Y-Cable in order to
support two cash drawers. Most of the settings only
have an effect when used with printers that support
dual cash drawers with a Y-Cable. The following
are the values for this parameter:
Report Drawer 1 Only
YCableStatus
Report Drawer 1 Only. Backwards Compatibility
= Reports the cash drawer status as all previous
If the profile has not been setup, this
field shows “None.”
Report Last Drawer Opened (default)
Report Each Drawer
Don't Report Status
Parameter
Description
releases of this OPOS Service Object. No matter
which drawer is open, the status is always reported
as drawer 1.
Valid Values
Report Last Drawer Opened - In this case when a
drawer open is detected, the open status is reported
for the last drawer which was sent an Open
command. If the Open is sent to drawer 1 then
drawer 1 shows open, if to drawer 2 then drawer 2
shows open. If drawer 1 or 2 is already open, and
an Open is sent to the other drawer, then both
drawers report open. Both drawers remain reporting
open until both drawers are closed, because we
cannot detect close until both are closed.
Report Each Drawer - This basically reports
exactly what the hardware tells us. If either drawer
1 or drawer 2 is open, then both drawers are
reported open. If drawer 1 is open then both 1 and 2
report open. If drawer 2 is open then both 1 and 2
report open. Both are reported open until both
drawers are closed.
Don't Report Status - This affects all cash drawer
types. In this mode the CapStatus capability reports
FALSE, and both drawers always show closed
regardless of the actual drawer status.
CashDrawer Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the Terminal CashDrawer is controlled through settings
stored in the NCRDatacap.conf configuration file. The following
example shows how to enable maximum data capture for all of the
CashDrawer components.
[NCROposSO.Cashdrawer]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRCashDrawerModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRCashDrawerHydra]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Hard Totals
Hard Totals provide a method to store various totals information
obtained from the retail application. These totals can be stored on Disk
or any device that supports standard disk I/O such as the network or a
Compact Flash card. The Hard Totals use the synchronous processing
model.
Hard Totals Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
HardTotals.0 (Any name
you wish)
Programmatic ID
This is the Service Object name for the Hard Totals
NCROposSO.HardTotals
NCR Model
Layer
Media Type
NCRHardTotalsRC
Indicates the media on which to store the Hard Totals
data. This value may only be set to Disk. A media type
of disk does not mean that the Hard Totals file must
reside on a local hard drive; the Hard Totals file can
"Disk"
reside on any device that supports the standard disk I/O
operations, including a network drive or compact flash.
HardTotals Area
Filename …
The file name of the totals file. If the file does not
exist, then a file with the requested size is created in
the desired directory. If the directory component of
the file name is invalid, the service object will return
an error at open time.
Example:
C:\Program
Files\NCR\Retail\NCRHT
.001
HardTotals Size
in KB
The size of the totals file, in kilobytes. The default
value is 1024. This value is only used if the specified
disk file does not exist. If a file size is specified, the
size is rounded down to the nearest multiple of the
cluster size (512 bytes for disk).
Example: 1024
ClusterSize in
Bytes
The file system layout within the Hard Totals area. The
Hard Totals file must contain at least 3 clusters to be
useful, 1 cluster for the header, 1 for the file table, and 1
cluster to hold file data. If the size is less than 3
clusters, the size will be set to 3 clusters
Cluster size in bytes
128
256
512 (Default)
1024
HardTotals Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the HardTotals is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the HardTotals
components.
[NCROposSO.HardTotals]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRHardTotals]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Keylock
The Keylock supports the keylock on the NCR 5932 USB keyboard, the
NCR 5953 USB Dynakey, or the NCR 5954 USB Dynakey.
Keylock Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRKeylock.0 (Any name you
wish)
Programmatic
ID
This is the Service Object name for the Hard Totals
NCROposSO.Keylock
NCR Model
Layer
NCRIOChannelKeylockModel
Connection
Type
The device interface used for the Keylock. USB is
the only option.
USB (Read-Only)
Device Usage
Page
USB Configuration - Indicates the usage page for
this Keylock device.
0xFF8F (Read-Only)
Device Usage
USB Configuration -Indicates the usage for this
Keylock device.
1 (Read-Only)
Number of
Reports
USB Configuration - Indicates the number of
reports for the Keylock device.
1 (Read-Only)
Product
USB Only - The name of the device supported.
Any HID USB Keylock (Default)
5932-50xx USB Keyboard
5932-52xx USB Keyboard
5953-6xxxx/80xx USB Dynakey
5953-85xxx/86xx USB Dynakey
5954 USB Dynakey
Vendor
USB Only - The manufacturer of the Keylock.
Any Vendor
NCR (Default)
Clear After
Read
USB Only - Indicates whether the device memory
should be cleared after a read.
False (Read-Only)
Keylock Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the Keylock is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the Keylock
components.
[NCROposSO.Keylock]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRIOChannelKeylockModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Line Display
NCR5972LineDisplay
The Line Display supports the NCR 5972 , LCD, VFD, and VFD
Occular LCD Line Display.
Line Display Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRLineDisplay.0 (Any
name you wish)
Programmatic ID
This is the Service Object name for the Line Display
NCROposSO.LineDisplay
Line Display
Model
NCR5972LineDisplay
Connection Type
Serial is the only option currently available.
Serial
5972 Type
The type of 5972 LCD device
VFD
Ocular VFD
LCD
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
Java Character
Encoding
The Line Display operates using character sets, not
Unicode. As a convenience for the application, the
Line Display supports this parameter to automatically
map Unicode strings into a particular character set
using the specified Java Character Encoding type string.
It is still the responsibility of the application to select
the correct character set programmatically. The valid
values for this parameter can be found in the Sun Java
online documentation at URL.
http://java.sun.com/products/jdk/1.2/docs/guide/internet
/encoding.doc.html. If this parameter is omitted, or its
value is an empty string, the application is assumed to
be providing strings with character values between
0000 and 00FF where each character is already the
correct value for the currently selected character set.
Default Character
Set
The character set to initialize during initial device
enable.
1 to 10
5 (Default)
VFD
850 - International
(Default)
101 - Katakana
866 - Cyrillic
102 - 116, external ROM
character sets
LCD
850 - International
Ocular LCD
858 - International
Screen Saver Style
The style of screen saver to enable after a
predetermined interval of inactivity.
Off (Default)
Screen Blanking
Walking Text
Power Saver
Turn the low power state option after inactivity, On or
Off.
Off (Default)
On
PortName
The COM Port where the line display is attached.
COM1 - COM10
COM1 (Default for VFD
and LCD)
COM5 (Default for
Ocular LCD)
Baud Rate
Baud rate for serial communications
Not changeable
Data Bits
Number of data bits
Not changeable
CTS Flow Control
CTS flow control setting
Not changeable
NCR5973LineDisplay
The Line Display supports the NCR 5973 International Line Display.
Line Display Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRLineDisplay.0 (Any
name you wish)
Programmatic ID
This is the Service Object name for the Line Display
NCROposSO.LineDisplay
Line Display
Model
NCR5973LineDisplay
Connection Type
Serial is the only option currently available.
Serial
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
1 to 10
10 (Default)
Java Character
The Line Display operates using character sets, not
Unicode. As a convenience for the application, the
Encoding
Line Display supports this parameter to automatically
map Unicode strings into a particular character set
using the specified Java Character Encoding type string.
It is still the responsibility of the application to select
the correct character set programmatically. The valid
values for this parameter can be found in the Sun Java
online documentation at URL.
http://java.sun.com/products/jdk/1.2/docs/guide/internet
/encoding.doc.html. If this parameter is omitted, or its
value is an empty string, the application is assumed to
be providing strings with character values between
0000 and 00FF where each character is already the
correct value for the currently selected character set.
Default Character
Set
The character set to initialize during initial device
enable.
850 – International
English
932 – Japanese (Default)
950 – Traditional Chinese
936 – Simplified Chinese
949 - Korean
PortName
Serial only - The COM Port where the line display is
attached.
COM1 - COM10
COM1 (Default)
Baud Rate
Baud rate for serial communications
Not changeable
Start Bit
Number of start bits per byte
Not changeable
Data Bits
Number of data bits per byte
Not changeable
Stop Bits
Number of stop bits per byte
Not changeable
Parity
Parity scheme for RS-232 communications
Not changeable
CTS flow control
CTS flow control setting
Not changeable
NCR59752x20LineDisplay
The Line Display supports the NCR 5975-1xxx 2x20 Line Display
connected either by Serial or USB.
Line Display Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRLineDisplay.0 (Any
name you wish)
Programmatic ID
This is the Service Object name for the Line Display
Line Display
Model
NCROposSO.LineDisplay
NCR59752x20LineDispla
y
Connection Type
Serial or USB.
Serial
USB
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
1 to 10
5 (Default)
Java Character
Encoding
The Line Display operates using character sets, not
Unicode. As a convenience for the application, the
Line Display supports this parameter to automatically
map Unicode strings into a particular character set
using the specified Java Character Encoding type string.
It is still the responsibility of the application to select
the correct character set programmatically. The valid
values for this parameter can be found in the Sun Java
online documentation at URL.
http://java.sun.com/products/jdk/1.2/docs/guide/internet
/encoding.doc.html. If this parameter is omitted, or its
value is an empty string, the application is assumed to
be providing strings with character values between
0000 and 00FF where each character is already the
correct value for the currently selected character set.
Default Character
Set
The character set to initialize during initial device
enable.
850 - International
(Default)
101 - Katakana
866 - Cyrillic
102 - 116, external ROM
character sets
Screen Saver Style
The style of screen saver to enable after a
predetermined interval of inactivity.
Off (Default)
Blank
Walk
Power Saver
Turn the low power state option after inactivity, On or
Off.
Off (Default)
On
PortName
Serial only - The COM Port where the line display is
attached.
COM1 - COM10
COM1 (Default)
Baud Rate
Baud rate for serial communications
Not changeable
Start Bit
Number of start bits per byte
Not changeable
Data Bits
Number of data bits per byte
Not changeable
Stop Bits
Number of stop bits per byte
Not changeable
Parity
Parity scheme for RS-232 communications
Not changeable
CTS flow control
CTS flow control setting
Not changeable
NCR5975IntLineDisplay
The Line Display supports the NCR 5975-2xxx Grpahical
(International) Line Display connected either by Serial or USB.
Line Display Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRLineDisplay.0 (Any
name you wish)
Programmatic ID
This is the Service Object name for the Line Display
Line Display
Model
NCROposSO.LineDisplay
NCR5975IntLineDisplay
Connection Type
Serial or USB.
Serial
USB
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
1 to 10
10 (Default)
Java Character
Encoding
The Line Display operates using character sets, not
Unicode. As a convenience for the application, the
Line Display supports this parameter to automatically
map Unicode strings into a particular character set
using the specified Java Character Encoding type string.
It is still the responsibility of the application to select
the correct character set programmatically. The valid
values for this parameter can be found in the Sun Java
online documentation at URL.
http://java.sun.com/products/jdk/1.2/docs/guide/internet
/encoding.doc.html. If this parameter is omitted, or its
value is an empty string, the application is assumed to
be providing strings with character values between
0000 and 00FF where each character is already the
correct value for the currently selected character set.
Default Character
Set
The character set to initialize during initial device
enable.
850 – International
English
932 – Japanese (Default)
950 – Traditional Chinese
936 – Simplified Chinese
949 - Korean
PortName
Serial only - The COM Port where the line display is
attached.
COM1 - COM10
COM1 (Default)
Baud Rate
Baud rate for serial communications
Not changeable
Start Bit
Number of start bits per byte
Not changeable
Data Bits
Number of data bits per byte
Not changeable
Stop Bits
Number of stop bits per byte
Not changeable
Parity
Parity scheme for RS-232 communications
Not changeable
CTS flow control
CTS flow control setting
Not changeable
NCR7402LineDisplayAPA
The Line Display supports the APA Line Display on the NCR 7402.
Line Display Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRLineDisplay.0 (Any
name you wish)
Programmatic ID
This is the Service Object name for the Line Display
Line Display
Model
NCROposSO.LineDisplay
NCR7402LineDisplayAPA
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
Java Character
Encoding
The Line Display operates using character sets, not
Unicode. As a convenience for the application, the
Line Display supports this parameter to
automatically map Unicode strings into a particular
character set using the specified Java Character
Encoding type string. It is still the responsibility of
the application to select the correct character set
programmatically. The valid values for this
parameter can be found in the Sun Java online
documentation at URL.
http://java.sun.com/products/jdk/1.2/docs/guide/inter
net/encoding.doc.html. If this parameter is omitted,
or its value is an empty string, the application is
1 to 10
5 (Default)
assumed to be providing strings with character
values between 0000 and 00FF where each character
is already the correct value for the currently selected
character set.
Default Character
Set
The character set to initialize during initial device
enable.
ANSI (Default)
Unicode
Default Screen
Mode
The Row and Column resolution.
4x8 (Default)
4x16
8x16
Character File
Directory
Where character renderings are located
C:\Program
Files\NCR\Retail Controls
PortName
The COM Port where the line display is attached.
COM1 - COM10
NCR7402LineDisplay2x20
The Line Display supports the 2x20 Line Display on the NCR 7402.
Line Display Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRLineDisplay.0 (Any
name you wish)
Programmatic ID
This is the Service Object name for the Line Display
NCROposSO.LineDisplay
Line Display
Model
NCR7402LineDisplay2x2
0
Connection Type
Serial is the only option currently available.
Serial
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
1 to 10
5 (Default)
Java Character
Encoding
The Line Display operates using character sets, not
Unicode. As a convenience for the application, the
Line Display supports this parameter to automatically
map Unicode strings into a particular character set
using the specified Java Character Encoding type string.
It is still the responsibility of the application to select
the correct character set programmatically. The valid
values for this parameter can be found in the Sun Java
online documentation at URL.
http://java.sun.com/products/jdk/1.2/docs/guide/internet
/encoding.doc.html. If this parameter is omitted, or its
value is an empty string, the application is assumed to
be providing strings with character values between
0000 and 00FF where each character is already the
correct value for the currently selected character set.
Default Character
Set
The character set to initialize during initial device
enable.
437, 858, 866, 101
(Default 437)
PortName
The COM Port where the line display is attached.
COM1 - COM10
(Default COM3)
NCR7443/7446LineDisplay2x20
The Line Display supports the 2x20 Line Display on the NCR 7402.
Line Display Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRLineDisplay.0 (Any
name you wish)
Programmatic ID
This is the Service Object name for the Line Display
NCROposSO.LineDisplay
Line Display
Model
NCR744xLineDisplay2x2
0
Connection Type
Serial is the only option currently available.
Serial
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
1 to 10
5 (Default)
Java Character
Encoding
The Line Display operates using character sets, not
Unicode. As a convenience for the application, the
Line Display supports this parameter to automatically
map Unicode strings into a particular character set
using the specified Java Character Encoding type string.
It is still the responsibility of the application to select
the correct character set programmatically. The valid
values for this parameter can be found in the Sun Java
online documentation at URL.
http://java.sun.com/products/jdk/1.2/docs/guide/internet
/encoding.doc.html. If this parameter is omitted, or its
value is an empty string, the application is assumed to
be providing strings with character values between
0000 and 00FF where each character is already the
correct value for the currently selected character set.
Default Character
Set
The character set to initialize during initial device
enable.
437
PortName
The COM Port where the line display is attached.
COM1 - COM10
(Default COM3)
LineDisplay Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the LineDisplay is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the LineDisplay
components.
[NCROposSO.LineDisplay]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR5972LineDisplay]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR5973LineDisplay]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR59752x20LineDisplay]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR5975IntLineDisplay]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR7402LineDisplayAPA]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR7402LineDisplay2x20]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR744xLineDisplay2x20]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
MICR
The MICR reader supports the MICR connected to one of the
supported NCR Printers.
DirectIO – MICR Parsing
The MICR_ADD_EXCEPTION method adds a special case MICR
parsing template string to the service object's MICR parsing template
list.
MICR data consists of digits, spaces, and four special MICR symbols:
Transit, On-Us, Amount, Dash. In the following discussion, and in the
DirectIO command NCRDIO_MICR_ADD_EXCEPTION, these
characters are used to describe MICR format data. Using this DirectIO
Command with NCRDIO_MICR_ADD_EXCEPTION has the effect of
adding these special MICR template strings to the persistent storage in
addition to adding them to the parsing template list temporarily stored
in memory.
t o a - space
MICR substitution symbols for Transit, On-Us, Amount, Dash,
and Space.
X Digit, space, or dash.
E EPC: Digit.
T Transit number: Digit or dash. (For US checks, only digits are allowed.)
A Account number: Digit, space, or dash. (Account number begins and ends
with a digit.)
S Serial/sequence number: Digit.
$ Amount: Digit.
B Series of blanks (spaces) and/or dashes. Optional unless a repeat count is
given.
* Trailer: Series of any digits, dashes, and spaces followed by an optional
amount field. (= "X[0+]a$[10]aB" if amount present and "X[0+]" if not).
An optional repeat count may follow any character except *:
[count] Specifies exactly "count" characters.
[min-max] Specifies between "min" and "max" characters.
[min+] Specifies at least "min" characters.
The general MICR data format is:
oX[1+]o EtT[9]t X[1+]oX[0+] a$[10]a
The fields are:
oX[1+]o Auxiliary on-us (optional). Bounded on left and right with On-Us
characters. Often used for serial number, in which case 'X' are digits.
E EPC character (optional). Immediately precedes leftmost Transit
character.
tT[9]t Transit number (required). Bounded on left and right with Transit
characters.
X[1+]oX[0+] On-us (optional). (More than one On-Us symbol can be included.
a$[10]a Amount (optional). Bounded on left and right with Amount characters.
The transit number and amount can always be found and properly parsed. The
placement of the serial and account numbers, however, varies between banks.
In addition, the Auxiliary On-Us and the On-Us fields may contain other bankspecific data.
To handle the majority of cases, the following default handling of serial and
account numbers is performed:
Case (1): Serial number in Auxiliary On-Us field. Account number in On-Us
field from first digit to the On-Us symbol, not including spaces and dashes
before the On-Us.
"BoS[1+]oBEtT[9]tBA[1+]Bo*"
Serial number is the number S[1+]
Account number is the number A[1+].
Example:
"o9876o t123456789t 12-345-6789 o 6666 a0000054321a"
Transit: "123456789"
Amount:
"0000054321"
Account:
"12-345-6789"
Serial: "9876"
EPC: ""
** If the RemoveNonDigits string contains an 'A', then Account is "123456789".
Case (2): Account number in On-Us field from first digit to the On-Us
symbol, not including spaces and dashes before the On-Us. Serial number in
On-Us field after the On-Us symbol. Must be three or more digits.
"BEtT[9]tBo[0-1]A[1+]BoBS[3+]*"
Account number is the number A[1+], if present.
Serial number is the number S[3+]
Example:
"5t123456789t 12 345-67 o 6666"
Transit: "123456789"
Amount:
""
Account:
"12 345-67"
Serial: "6666"
EPC: "5"
** If the RemoveNonDigits string contains an 'A', then Account is "1234567".
Case (3): Serial number in On-Us field from first digit to next non-digit; must
be between three and five digits. Account number in On-Us field from first
digit after the serial number to the On-Us symbol, not including spaces and
dashes before the On-Us.
"BEtT[9]tBS[3-5]B[1+]A[1+]Bo*"
Serial number is the number S[3-5]
Account number is the number A[1+].
Example:
"t12345-789t 555 12 345-67 o 66"
Transit: "12345-789"
Amount:
""
Account:
"12 345-67"
Serial: "555"
EPC: ""
** If the RemoveNonDigits string contains a 'T', then Transit is "12345789".
** If the RemoveNonDigits string contains an 'A', then Account is "1234567".
Example:
"t123456789t 555 12 345-67 o 66 a0000054321a"
Transit: "123456789"
Amount:
"0000054321"
Account:
"12 345-67"
Serial: "555"
EPC: ""
** If the RemoveNonDigits string contains an 'A', then Account is "1234567".
Case (4): Account number in On-Us field from first digit to the On-Us
symbol, not including spaces and dashes before the On-Us.
"BEtT[9]tBA[1+]Bo*"
No serial number.
Account number is the number A[1+].
Example:
"t123456789t 55 12 345-67 o 66"
Transit: "123456789"
Amount:
""
Account:
"55 12 345-67"
Serial: ""
EPC: ""
** If the RemoveNonDigits string contains an 'A', then Account is "551234567".
Case (5): Serial number in On-Us field from first digit to the On-Us symbol,
must be three or more digits. Account number in second On-Us field from the
first digit after the On-Us symbol that ended the serial number to the On-Us
symbol, not including spaces and dashes before the On-Us.
"BtT[9]tBS[3+]BoBA[1+]o*",
Serial number is the number S[3+].
Account number is the number A[1+].
Example:
"t12345-789t 555 o 12 345-67 o 66"
Transit: "12345-789"
Amount:
""
Account:
"12 345-67"
Serial: 555
EPC: ""
** If the RemoveNonDigits string contains a 'T', then
Transit is "12345789".
** If the RemoveNonDigits string contains an 'A', then
"1234567".
Account is
If the default handling is not correct for some banks, then exception strings
can be added for these cases. The exception strings shall be formatted as in
these examples.
Example exception string "t061000052tBA[10-12]o*":
This string requires that the EPC and Serial Number be absent.
If Micr Data is: "t061000052t 123 456 789o"
Transit: "061000052"
Amount:
""
Account:
"123 456 789"
Serial: ""
EPC: ""
** If the RemoveNonDigits string contains an 'A', then Account is "123456789".
(Without the exception, then default case (3) would have returned "123" as the
serial number and "456 789" (** or 456789) as the account number.)
If MICR Data is: "t061000052t 123456789012o3333a0000054321a"
Transit: "061000052"
Amount:
"0000054321"
Account:
"123456789012"
Serial: ""
EPC: ""
(Note that the "3333" between the On-Us and Amount symbols is ignored.
Without the exception, then default case (2) would have returned "3333" as
the serial number.)
Example exception string "t052000113tBS[3]BA[7-10]o*":
This string requires that the EPC be absent.
If Micr Data is: "t052000113t 123 456 789o"
Transit: "052000113"
Amount:
""
Account:
"456 789"
Serial: "123"
EPC: ""
** If the RemoveNonDigits string contains an 'A', then Account is "456789".
Example exception string "tTTT00011TtBS[2]A[10]S[3]o*":
This string requires that the EPC be absent.
If MICR Data is: "t99-000119t 123 456 7890987o a9876543210a"
Transit: "99-000119"
Amount:
"9876543210"
Account:
"3 456 7890"
Serial: "12987"
EPC: ""
** If the RemoveNonDigits string contains a 'T',
then Transit is "99000119".
** If the RemoveNonDigits string contains an 'A', then Account is "34567890".
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
Errors
command
NCRDIO_MICR_ADD_EXCEPTION
data
Not Used
object
String to add to the exception list (See
command description)
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The string contains invalid characters.
DirectIO - Set Remove Non Digits
Sets space and dash removal from account and transit numbers. The
following strings are valid:

"A": Remove spaces and dashes from within AccountNumber.
Some banks use these for readability.

"T": Remove spaces and dashes from within TransitNumber.
Some countries may use these.

"AT": Remove spaces and dashes from within AccountNumber
and TransitNumber.
"": Do not remove spaces and dashes from either AccountNumber or
TransitNumber.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_MICR_SET_REMOVE_NO
N_DIGITS
Errors
data
Not Used
object
List of characters to remove
"A"
Remove the account character
"T" Remove the transit character
"AT" Remove both characters
"" Do not remove any characters
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The string contains invalid characters.
Clear Exception Table
Clears, the MICR Exception Table in temporary system memory, the
configuration data, or both.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
Errors
command
NCRDIO_MICR_CLEAR_EXCEPTIONS
data
0 = Clear all exception strings
1 = Clear exception strings entered via
DirectIO
2 = Clear exception strings entered via
configuration data
object
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL
Unsupported data value entered, the
function failed.
MICR - Magnetic Ink Character Recognition Configuration
Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRMICR.0 (Any name you wish)
Programmatic ID
This is the Service Object name for the
MICR
NCROposSO.MICR
NCR Model Layer
NCR71xxPrinterCDMICRModel,
NCRH6xxxPrinterHydraModel, or
NCRMod34PrinterHydraModel
Uses
The MICR reader is integrated in a retail
printer. Enter the profile name of the
associated POS Printer
Any POS Printer profile for a printer
with a MICR reader
Exception String 0
The ExceptionString entries are used to add
exception patterns for MICR check parsing
to handle special formatted checks that are
not covered by the default parsing rules.
Refer to the DirectIO "MICR
Parsing" for valid strings
Exception String 1
The ExceptionString entries are used to add
exception patterns for MICR check parsing
to handle special formatted checks that are
not covered by the default parsing rules.
Refer to the DirectIO "MICR
Parsing" for valid strings
Remove Non-Digits
RemoveNonDigits is used to remove digits
from parsed MICR data. Digits may be
removed from transit numbers, account
numbers, both, or neither.
Don't remove digits from MICR data
Remove from transit numbers
Remove from account numbers
Remove from transit and account
numbers
Return Error Data
In some cases, a failed MICR read may
return some MICR data. ReturnErrorData
determines if we should parse and return
any data read as part of a failed MICR read.
If enabled, the error data is returned in
MICR error events.
Return partial data
Don't return partial
MICR Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the MICR is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the MICR components.
[NCROposSO.MICR]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR71xxMICRModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR71xxPrinterCDMICRModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
MotionSensor
The Motion Sensor supports the motion sensors integrated into the
NCR 7401 and 7402 terminals.
MotionSensor - Motion Sensor Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRMotionSensor.0 (Any name you
wish)
Programmatic ID
This is the Service Object name for the Motion
Sensor
NCROposSO.MotionSensor
NCR Model Layer
NCRSystemMonitorEventModel
Motion Sensor Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the Motion Sensor is controlled through settings stored in
the NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the Motion Sensor
components.
[NCROposSO.MotionSensor]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRSystemMonitorEventModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
MSR
USB Keyboard and Dynakey MSR Configuration Entries
This MSR configuration supports the MSR located on the NCR 5932
USB Keyboard, the NCR 5953 USB Dynakey, or the NCR 5954
Dynakey.
USB Keyboard and Dynakey MSR Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRMSR.0 (Any name you wish)
Programmatic ID
This is the Service Object name for the MICR
NCROposSO.MSR
NCR Model Layer
Read Head Type
NCRIOChannelMSRModel
Type of MSR Hardware Reader. Different
hardware is required for each format. A type
of "ISO" indicates that ISO and JIS Type I
cards can be read. A type of "JIS" indicates
"ISO" (Default)
"JIS"
that JIS Types I and II cards can be read.
ConnectionType
How the MSR is connected to the terminal.
USB (Default)
Device Usage Page
USB Configuration - Indicates the usage page
for this MSR Device.
0x8E (Read-Only)
Device Usage
USB Configuration - Indicates the usage for
this MSR Device.
1 (Read-Only)
Device Path
USB Configuration – Specifies the USB device
path using the “DevPath” entry in the
$NCR$\Config\IOManager\HIDDevices.conf
file for the device.
0 (Default)
Number of Reports
USB Configuration - Indicates the number of
reports for this MSR Device.
1 (Read-Only)
Product
The Product where the USB MSR device
resides.
Any HID USB MSR (Default)
5932-50xx USB Keyboard
5953-6xxx/80xx USB Dynakey
5953-85xx/86xx, 5932-52xx, 5954,
5964 USB MSR (ISO)
5953-85xx/86xx, 5932-52xx, 5954,
5964 USB MSR (JIS)
Vendor
The manufacturer of the MSR device.
Any Vendor
NCR (Default)
ClearAfterRead
Should the device memory be cleared after a
read.
True (Read-Only)
TrackError
TrackError = "1" -> Ignores error data on
track one.
0 (Default)
Example: 5.1
= "2" ignores errors on track two.
= "4" ignores errors on track three.
= "8" ignores errors on track four.
= "F" ignores errors on all tracks (1-4).
These values can also be used in combination
(ex. "3" will ignore errors on track one and
track two). Not all MSR heads support four
data tracks.
AllTracksError
AllTracksErrors = "0" -> If all tracks have
errors will appear as no MSR swipe occurred
The TrackError registry setting must also be
set for this value to work.
1 (Default)
USB Keyboard and Dynakey MSR Data Capture Configuration
Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the MSR is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the MSR components.
[NCROposSO.MSR]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRIOChannelMSRModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
NCR 5966 MSR Configuration Entries
This MSR configuration supports the MSR located on the NCR 5966
Display.
NCR 5966 MSR Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRMSR.5966 (Any name you
wish)
Programmatic ID
This is the Service Object name for the MICR
NCR Model Layer
Poll Rate
NCROposSO.MSR
NCR5966MSR
The maximum rate at which the device will be
polled to see if a card has been swiped,
specified in milliseconds.
100 – 2000. Default is 250.
NCR 5966 MSR Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the MSR is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the MSR components.
[NCROposSO.MSR]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR5966MSR]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
NCR ICM 330 USB DIP MSR Configuration Entries
This MSR configuration supports the NCR ISM 330 USP dip MSR
supported by the 7409 and some FastLane systems.
NCR ICM 330 USB DIP MSR Configuration Entries
NEED A NEW IMAGE FROM RSM CONFIGURATION
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRMSR.330DIP (Any name you
wish)
Programmatic ID
This is the Service Object name for the MICR
NCROposSO.MSR
NCR Model Layer
NCRICM330DIPMSR
NCR ICM 330 USB DIP MSR Data Capture Configuration
Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the MSR is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the MSR components.
[NCROposSO.MSR]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRICM330DIP]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
POS Printer
The POS Printer supports the following NCR printers.

7156

7158

7167

7168

7194

7197

7198

K580

K590

7342-F306

7342-F307

7342-F309
In addition, the following printers are supported:

H6000

H6000II

Mod34 (receipt and slip stations only); this is an RS485 printer
supported only on the 7459 terminal.
The Printer Model currently interfaces to the printer over a serial port,
and it functions on any terminal with a standard serial port.
DirectIO - Raw Output
This function is used to send data directly to the printer without
having the Control manipulate that data in any way. This command
can be used to access printer specific functions that are not provided by
the Control.
Note: Do not use this function to alter any of the printer's physical printing
characteristics (such as character pitch, lines per inch, margins or other such
metrics). The Control knows nothing about the information that has been sent to
the printer. If this command is used to alter any of the printer's physical printing
characteristics, the Control may not be able to perform further requests correctly.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_RAW_OUTPUT
data[0]
Printer Station identifier
object
Errors
Data being sent to the printer. The data
must be of type java.lang.String.
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The printer station is invalid.
DirectIO - Set Barcode Width
Sets a new width for printing barcodes. The legal values for this option
vary by printer model and should be determined from the printer's
manual. This function returns the barcode width in the Data field and
can therefore be used to determine what the current value is by
sending in an illegal value and ignoring the error returned.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
Command
NCRDIO_PTR_SET_BARCODE_WIDTH
data
Horizontal size of the barcode, in dots
object
Not Used
DirectIO - Set Bitmap Type
Sets a new type for bitmap print processing.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
data[0]
NCRDIO_PTR_SET_BITMAP_TYPE
bitmap type
NCRDIO_BITMAP_TYPE_DEFAULT
NCRDIO_BITMAP_TYPE_HIGHQ
NCRDIO_BITMAP_TYPE_LOWQ
NCRDIO_BITMAP_TYPE_HIGHQ_DL
NCRDIO_BITMAP_TYPE_LOWQ_DL
object
Errors
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The bitmap type constant was invalid.
DirectIO - Sound Audible Tone
Sounds a tone from the printer a specified number of times. The repeat
count value can only range between 1 and 20. If a repeat count value
less than one is sent, OPOS_E_ILLEGAL is returned.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_SOUND_AUDIBLE_T
ONE
Errors
data[0]
Repeat count
object
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The printer cannot sound an audible tone or a
repeat count of less than 1 or greater than 20 was selected.
DirectIO - Set Minimum Number of Characters Per Line
Sets the minimum number of characters per line that are used when
choosing a station's print mode. The mode (generally either standard
or compressed printing) that is selected will be sufficient to print a line
whose width is the greater of this value and the most recently set
XxxLineChars property.
For example, the application needs to print on the 7167 slip in
compressed mode, so that 40 characters of print data can fit on a small
form. If SlpLineChars is set to 40, the service object normally selects
standard mode, since up to 45 characters can be printed on a slip line in
standard mode. By using this DirectIO to set the minimum number of
characters per line to 55, the service object selects compressed mode for
any SlpLineChars value, since compressed mode is required to print 55
characters on a line.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_SET_MIN_LINE_CH
ARS_MODE
data[0]
Upper word (data[0] & 0xFFFF0000):
Station
Lower word (data[0] & 0x0000FFFF);
Minimum number of characters
Upon return, data[0] contains the
previous minimum number of characters
per line.
object
Errors
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL if the printer station cannot support the request
number of characters or the station is invalid (in this case the
extended result code is set to (NCR_EPTR_STATION).
DirectIO - Get the Current Printer Status
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
Errors
command
NCRDIO_PTR_GET_PRINTER_STATUS
data[0]
The status is stored in data[0].
object
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
If successful, the following table provides a detailed description of the
data returned. It is described in Bit Mask form.
Defined Constant
PRTSTAT_FLAG
PTRSTAT_ALL
PTRSTAT_STATE
PTRSTAT_PRINTER
PTRSTAT_PRINTER_FAULT
PTRSTAT_DRAWER
Printer States
PTRSTAT_OFF_STATE
PTRSTAT_ERROR_STATE
OPOS Printer Sensor values.
PTRSTAT_COVER_OPEN
PTRSTAT_JRN_EMPTY
PTRSTAT_JRN_NEAREND
PTRSTAT_REC_EMPTY
PTRSTAT_REC_LOW
PTRSTAT_SLP_EMPTY
Description
Always On
All statuses
All state flags
All printer statuses
All printer faults/failures
All drawer statuses
Printer is off
Printer is in error: Not accepting
requests
Cover or door open
Journal out
Journal low
Receipt out
Receipt low
Slip leading edge sensor: no
Defined Constant
PTRSTAT_SLP_LOW
Description
paper
Slip trailing edge sensor: Low on
paper
Printer Slip sensor values.
PTRSTAT_SLP_TOF
Slip top of form sensor on
PTRSTAT_SLP_BOF
Slip bottom of form sensor on
Printer states only available when real-time commands are
supported.
PTRSTAT_SLP_SELECTED
Slip selected
PTRSTAT_SLP_WAITING
Printer waiting for insertion
Printer failure conditions. Support varies by printer.
PTRSTAT_AUTORECOVER_FA Auto-recoverable fault, such as
ULT
temperature fault
PTRSTAT_MOTOR_FAULT
Motor fault
PTRSTAT_KNIFE_FAULT
Knife fault
PTRSTAT_FAILURE
Unrecoverable error
Drawer states.
PTRSTAT_DWR1_OPEN
Drawer 1 open
PTRSTAT_DWR2_OPEN
Drawer 2 open
DirectIO – Get Kiosk Specific Sensor Status
Returns the value of one of the kiosk specific sensors.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
data[0]
NCRDIO_PTR_SENSOR_STATUS
The sensor to check
PTR_Cabinet_Door_Switch
PTR_Presenter_Paper_Sensor
PTR_Cabinet_Paper_Chute
PTR_Presenter_Orientation
On return, data[0] holds the sensor
value. This will be one of:
PTR_CDS_Door_Open
PTR_CDS_Door_Closed
PTR_PPS_Paper_Present
PTR_PPS_No_Paper
PTR_CPC_Paper_Present
PTR_CPC_No_Paper
PTR_PO_Normal
PTR_PO_Rotated_90
object
Errors
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The sensor constant was invalid.
DirectIO – Set Autoeject Timeout
Sets the autoeject timeout for the K580 or K590 kiosk printer. This
time-out is the delay between the time a receipt is presented, and when
it is auto ejected onto the floor.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_AUTOEJECT_TIMEOUT
data[0]
The new timeout, in seconds. This
value may be either 20, 40, 60, or 80. Use
the value JPOS_FOREVER to indicate that
the receipt should not be automatically
ejected.
object
Errors
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL – The attached printer does not support receipt
ejection, or the autoeject value was invalid.
DirectIO – Eject Receipt
Ejects the receipt from the K580 or K590 kiosk printer.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
Errors
NCRDIO_PTR_EJECT_RECEIPT
data[0]
Not used
object
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL – The attached printer does not support receipt
ejection.
DirectIO – Get Kiosk Specific Status
Returns the kiosk specific status bits.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_GET_KIOSK_STATUS
data[0]
On return,data[0] holds the kiosk
specific status bits. This will be a
combination of the following values:
PTR_CDS_Door_Open Cabinet
door open
PTR_CDS_Door_Closed Cabinet
door closed
object
Errors
PTR_PPS_Paper_Present
paper present
Presenter
PTR_PPS_No_Paper
paper out
Presenter
PTR_CPC_Paper_Present
paper chute: Paper present
Cabinet
PTR_CPC_No_Paper
paper chute: No paper
Cabinet
PTR_PO_Rotated_90
rotated
Presenter
PTR_PO_Normal
not rotated (normal)
Presenter
Not Used
An exception may be thrown when this method is invoked.
DirectIO – Change Paper Low Reporting
Changes the paper low reporting for the K590 kiosk printer.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_SET_PAPER_LOW
data[0]
The new paper low reporting value.
This will be one of:
0 - Paper is low if 50 feet or less remains
1 - Paper is low if 10 feet or less remains
2 – Disable paper low reporting
object
Errors
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The paper low value was invalid, or the printer does
not allow the paper low setting to be changed from software.
DirectIO – Set Black Mark Configuration
Changes the black mark configuration for the K590 kiosk printer. The
black mark setting determines how paper cuts are performed relative
to black marks on the back of the printer paper.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_SET_BLACK_MARK
data[0]
The new black mark setting. This
will be one of:
0 - Document Mode (Ignore black marks
when cutting paper)
1 - Normal Mode (Cut at first black mark
beyond printing)
2 - Advance Mode (Cut at 2nd black mark
beyond printing)
object
Errors
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The black mark value was invalid, or the printer does
not allow the black mark setting to be changed from software.
DirectIO – Set Minimum Receipt Length
Changes the minimum receipt length for the K590 or F306 kiosk
printer.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_SET_MINIMUM_RE
C_LEN
data[0]
The new minimum receipt length.
For the K590, this value is one of:
1
90mm
2
111mm
3
150mm
4
225mm
5
300mm
6
375mm
7
450mm
8
525mm
9
600mm
For the F306, this value is one of:
object
0
None
1
6 inches
Not Used
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The minimum receipt length value was invalid, or the
printer does not allow the minimum receipt length to be changed from
software.
DirectIO – Set Receipt Retain Length
Changes the receipt retain length for the K590 kiosk printer.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_SET_REC_RETAIN_LEN
data[0]
The new receipt retain length. This
value is one of:
object
Errors
1
25mm
2
50mm
3
75mm
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The receipt retain length value was invalid, or the
printer does not allow the receipt retain length to be changed from software.
DirectIO – Get Two Sided Thermal Paper Type
Returns the type of paper in the receipt station. This command is only
valid if two sided thermal paper detection is enabled in the
configuration entries.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_PTR_2ST_PAPER_TYPE
data[0]
On return, data[0] holds the paper type.
This will be one of:
PTR_2ST_PAPER_UNKNOWN: Paper
type is unknown
PTR_2ST_PAPER_SINGLE: Single sided
paper
PTR_2ST_PAPER_DOUBLE: Double
sided paper
object
Errors
Not Used
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL – Two sided thermal paper detection is not enabled for
this printer.
POS Printer Configuration Entries
Common Configuration Entries
The following entries are common to all POS Printers.
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRPOSPrinter.0 (Any name you
wish)
Programmatic ID
This is the Service Object name for the POS
Printer
NCROposSO.POSPrinter
NCR Model Layer
NCR71xxPrinterCDMICRModel supports the
71xx printers
NCR71xxPrinterCDMICRModel,
NCRK5xxPrinterHydraModel,
NCRH6xxxPrinterHydraModel,
or NCRMod34PrinterHydraModel
NCRK5xxPrinterHydraModel supports the
kiosk printers
NCRH6xxxPrinterHydraModel supports the
H6000 printers
Parameter
Description
Valid Values
NCRMod34PrinterHydraModel supports the
Mod3/4
POSPrinter Model
The model number of the attached printer
7156
7158
7167
7168
7194
7197
7198
7401-K580
7401-K59x
7342-F306
H6000
H6000II
Mod34
Connection Type
Defines how the printer is connected to the
terminal.
Serial (Read-Only)
Escape Sequence
Module
The POS printer makes use of an escape
sequence module to translate from API
specific escape sequences to printer specific
sequences. The default parser module,
UPOSParsers, supports the OPOS/JavaPOS
escape sequences.
NCRUPOSPrinterParsers
AutoLineFeed
AutoLineFeed determines if the printer should
append a line feed to the last line of a print
request, if a line feed is not already present.
Append a line feed if not already
present
Do Not append line feeds
(Default)
Asynchronous Block
Size
Asynchronous print requests are grouped into
logical units called asynchronous blocks. The
Asynchronous Block Size determines the
number of requests in each block.
1 or more (Default 10)
The status of the printer is checked at the end
of each asynchronous block, rather than after
each request. Thus, larger block sizes will
reduce the number of status requests issued,
and thereby improve performance. However,
if a printer failure occurs, you do not know
Parameter
Description
which (if any) requests in the block were
printed successfully, and which were not. In
this regard, a smaller block size may permit
more precise error handling on the part of the
application. .
Valid Values
Asynchronous Block
Status Timeout
The Asynchronous Block Status Timeout
value is the maximum time (in milliseconds)
to wait before terminating an asynchronous
block. This is useful if the application stops
sending print requests before an asynchronous
block is full; the block will eventually time
out, and the status of the requests in the block
will be determined and reported to the
application.
50-10000 ms (Default 200 ms)
A higher timeout value will usually permit
more requests to be combined into each
asynchronous block, thereby improving
performance. If the timeout value is too large,
and the application is not printing lines
frequently, then there are longer delays before
the status of each request is determined.
Print Status Wait Time
This is the maximum time to wait for a
buffered status response.
5000 – 30000 ms
30000 (Default)
Heart Beat Poll Time
The Heartbeat Poll Time determines how
often heartbeat requests are sent to the printer.
Heartbeat requests are used to verify that the
printer is still responsive. A smaller poll time
results in faster detection when the printer
goes offline or becomes unresponsive. This
comes at the cost of performance, as time
spent processing heartbeat requests is time
that could have been spent on other print
requests.
500 – 10000 ms
1000 (Default)
Java Character Encoding
The POS Printer operates using character sets,
not Unicode. As a convenience for the
application, the POS Printer supports this
parameter to automatically map Unicode
strings into a particular character set using the
specified Java Character Encoding type
string. It is still the responsibility of the
application to select the correct character set
programmatically. The valid values for this
parameter can be found in the Sun Java online
Parameter
Description
documentation at URL:
http://java.sun.com/products/jdk/1.2/docs/gui
de/internet/encoding.doc.html. If this
parameter is omitted, or its value is an empty
string, the application is assumed to be
providing strings with character values
between 0000 and 00FF where each character
is already the correct value for the currently
selected character set.
Valid Values
Port Name
Serial Only. The serial port that is connected
to the printer.
COM1 – COM10
COM1 (Default)
Baud Rate
Serial Only. Specifies the speed for serial
communications
9600 bps
19200 bps
38400 bps
57600 bps
115200 bps (Default)
Data Bits
Serial Only. The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits
8 bits (Default)
Parity
Serial Only. Specifies the parity scheme for
serial communications
None (Default)
Even
Odd
Stop Bits
Serial Only. The number of stop bits to use
for serial communications.
1 bit (Default)
2 bits
EjectSlipFeed
EjectSlipFeed determines the number of lines
to feed the slip as part of slip removal
processing. Negative values indicate a
reverse feed, and positive values indicate a
forward feed. If this value is left blank, a
printer specific default value is used.
-100 – 100
-25 (Default)
Slip insertion will not succeed until you have
a slip inserted status that is stable for this
many milliseconds. If this value is left blank,
a printer specific default value is used.
0 - 10000 ms
500 ms (Default)
Slip removal will not succeed until we have a
slip out status that is stable for this many
milliseconds. If this value is left blank, a
printer specific default value is used.
0 - 10000 ms
500 ms (Default)
Indicates if the printer should reposition the
slip to the top of form after a slip is inserted
Reposition the slip after insertion
(Default)
Do not reposition the slip after
(Slip printers only)
SlipInSettleTime
(Slip printers only)
SlipOutSettleTime
(Slip printers only)
SlipToTopOfForm
(Slip printers only)
Parameter
Description
Valid Values
insertion
NCR 71xx Specific Configuration Entries
The following entries are specific to the NCR 71xx POS Printers.
Parameter
Description
Valid Values
ColorPaper
For the 7167 and the 7197 printers, this
determines the type of Thermal Color paper
being used. It defines the number of colors
supported by the paper.
Thermal station contains
monochrome paper (Default)
Thermal station contains two color
paper.
PrintIntegrityMode
Enables or disables print integrity mode. If
disabled, receipt printing performance is
improved, but there is a chance that some
requests are reported as successful even
though they actually failed.
Print Integrity mode disabled
(Default)
Print integrity mode enabled
Kiosk Specific Configuration Entries
The following entries apply only to the kiosk printers, i.e. the K580, K590, and 7342-F306.
The kiosk printers also use the common entries presented in the table above.
Parameter
Description
Valid Values
Bitmap Load Eject Delay
Image downloads may cause problems if
paper is in the presenter. When downloading
an image, first delay for the specified time,
eject the receipt, and then download the
image.
0 – 15000ms,
Delay in seconds between time the receipt is
cut and when the receipt is automatically
ejected.
None (Default)
(K580, K590, F306)
Auto Eject Delay
(K580, K590)
Default is 3000ms
20
40
60
80
Eject Adjustment Time
(K580, K590)
Eject On Enable
(K580, K590)
Ignore Paper In Presenter
Errors
When a print request spans multiple tickets,
the default timeout for completion of a status
request may not be long enough. For each
ticket required, we add the eject adjustment
time and the knife cut adjustment time to the
default timeout for a status request.
0 – 30000ms
If set to true, the printer will eject paper in the
presenter at enable time.
Eject on Enable
If True, ignore Paper-In-Presenter errors
(K580, K590)
Black Mark Option
(K590, F306)
Do Not Eject on Enable (Default)
Ignore Errors (Default for F306)
Do Not Ignore Errors (Default for
K580, K590)
(K580, K590, F306)
Knife Cut Adjustment
Time
Default is 10000ms
When a print request spans multiple tickets,
the default timeout for completion of a status
request may not be long enough. For each
ticket required, we add the eject adjustment
time and the knife cut adjustment time to the
default timeout for a status request.
0 – 30000ms
Determines where receipt is cut in relation to
black marks on the back of the paper.
Document mode - Printer
ignores black marks on
paper. This is the default.
Default is 6000ms
Normal mode – Paper is cut
Parameter
Description
Valid Values
at the first black mark on the
paper after printing completes
Advance mode – Paper is cut at
the second black mark on the
paper after printing completes
Pre-Eject Delay
(K580, K590, F306)
Time to delay before attempting an eject to
allow presentation of the receipt.
0 – 15000ms
Default is 2000ms for K580
Default is 1500ms for K590
Default is 2000ms for F306
Post-Eject Delay
(K580, K590, F306)
Time to delay after eject to let the receipt
clear the presenter.
3000 – 8000ms
Default is 5000ms for K580
Default is 1500ms for K590
Default is 1500ms for F306
Line Size
(K590)
Selects the width of the paper in use for this
printer.
80mm (Default)
82.5mm
114mm
Minimum Receipt
Length
Minimum amount of receipt paper to
present to the user.
(K590, F306)
K590 values
90mm
111mm
150mm
225mm
300mm
375mm
450mm
525mm
600mm
F306 values
None
6 inches
Paper Low Option
(K590)
Determines when the printer will report a
paper low status.
Report paper low when 50
feet or less paper remains
(Default)
Report paper low when 10
feet or less paper remains
Disable paper low reporting
Parameter
Description
Valid Values
Receipt Retain Length
Determines the portion of each receipt to hold
inside the presenter.
25mm
(K590)
50mm
75mm
Use Soft Options
(K590)
Black Mark Distance
(F306)
If True, the Receipt Retain Length and
Minimum Receipt Length registry values will
be saved to the printer.
Use Soft Options
Specifies the distance between black marks
on the printer paper.
111mm
127mm
140mm
Do Not Use Soft Options
(Default)
152mm
H6000 Specific Configuration Entries
The following configuration entries are specific to the H6000 and H6000II printers.
Parameter
Description
Valid Values
Reverse Slip Removal
Reverse Slip Removal indicates if the printer
should eject slips from the front of the printer
rather than the top.
Eject slips from the front of the
printer
Eject slips from the top of the
printer (Default)
Mod34 Specific Configuration Entries
The Mod34 printer is an RS485 printer. The Mod34 is supported only on 7459 terminals
with a special USB to RS485 dongle card installed. The following configuration entries
relate to the connection between the terminal and the printer. The required values for the
Mod34 printer are included. The Mod34 does not use the serial port related entries in the
table of common POS Printer configuration entries.
Parameter
Description
Valid Values
Connection Type
Connection Type specifies how the printer is
connected to the retail terminal.
USB
Product ID
The product on which the USB POS Printer
resides.
NCR RS485 Dongle
Vendor ID
The manufacturer of the POS Printer device.
NCR
Device Usage Page
The usage page for this POS Printer device.
0xFF8B
Device Usage
The usage for this POS Printer device.
6
Number of Reports
The number of reports for this POS Printer
device.
5
Clear After Read
Indicates if the device memory should be
cleared after a read.
Enabled
The following entries also apply only to the Mod3/4 printer.
Parameter
Description
Valid Values
Receipt Image
Correction
Receipt images with no pixels on in columns
0 - 94 are misaligned on some printers which
emulate the Mod34. This entry corrects this
problem by turning on one pixel per image
line for all such images.
Enable Receipt Image Correction
Slip Image Correction
Some printers which emulate the Mod34
truncate the leftmost 70-74 columns of slip
images. This entry corrects this problem by
using an alternate set of slip metrics.
Enable Slip Image Correction
Postal Mode enables USPS specific printer
Enable Postal Mode
PostalMode
Disable Receipt Image Correction
(Default)
Disable Slip Image Correction
(Default)
Parameter
Description
features.
Valid Values
Disable Postal Mode (Default)
POS Printer Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the POS Printer is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the POS Printer
components.
[NCROposSO.POSPrinter]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR71xxPOSPrinterModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCR71xxPrinterCDMICRModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRK5xxPOSPrinterModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRK5xxPrinterHydraModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRH6xxxPOSPrinterModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRH6xxxPrinterHydraModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRMod34POSPrinterModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRMod34PrinterHydraModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Two-Sided Thermal Printing
This section defines the OPOS / JavaPOS implementation for the 2sided thermal (2ST) printer. It defines the NCR proprietary
enhancements to the OPOS / JavaPOS standard to allow an application
to fully control the printing of both sides of the thermal receipt station.
This functionality currently supports the 7168-xxxx and 7198-xxxx
printers.
There are two methods of printing on the back side of the receipt
paper:

Proprietary enhancements to the transactionPrint method to
allow full control on both sides.

Proprietary escape sequences to control various two-sided thermal
printing.
The two-sided thermal print station has four modes of operation:
1. Single Sided Mode
– The printer only prints on the front side of the paper.
2. Double Sided Mode with Single Side Command (Split Receipt)
–
Normal print operations are buffered at the printer, executed
and split between front and back side when a knife cut is
encountered.
3. Double Sided Mode with Double Side Command (Full Control)
– The side desired to print on is selected, and the data to print are
sent to it. After the data for both sides are defined, a begin print, or
knife cut command is issued to print the two-sided receipt.
4. Double Sided Mode with Predefined Data (Static Reverse Image)
– Data to print is sent to the printer. A predefined image is selected
from previously-defined images. When a print command or knife
cut is received, the data is printed on the front side, and the
predefined image selected is printed on the back.
Note: Refer to OPOS / JavaPOS Mode Functional Definition below for a
detailed functional explanation on each mode.
All four modes of the 2-Sided thermal printing are supported by the
OPOS / JavaPOS implementation. The commands and features that are
available through OPOS vary with each mode. The selection of the
mode to be used is defined by a configuration option, although it can
be set dynamically by the use of a proprietary escape sequence.
The printer is initialized to the mode specified in the configuration at
DeviceEnable time. The application can change the mode dynamically
during operation, but it reverts back to the configured option if the
device is disabled, and later re-enabled.
Escape Sequences to Control the Two-Sided Functionality
within a Mode
The following escape sequences are used to control the two-sided
functionality through OPOS / JavaPOS. These escape sequences take
advantage of the OPOS / JavaPOS “Pass through embedded data”
escape sequence. All of these escape sequences must be wrapped by
this “Pass through embedded data ESC|#E” to be recognized.
The values set by these escape sequences are only valid for the current
instance of the OPOS / JavaPOS service. If the device is set to disabled,
then the configured settings are restored on the next enable.
The functionality provided by these escape sequences depends on the
current TST2SideMode configuration setting. For some settings, they
may be ignored and have no effect. All numeric parameters are ASCII
characters for numeric values.
Escape Sequence
Functionality
Possible Values
ESC [2ST; 1; 1; n !v
Sets the front side
print orientation
n = 0 : No rotation of printing
Sets the back side
print orientation
n = 0 : No rotation of printing
Switches Front / Back
printing
n = 0 : Normal (front side faces
toward front of the printer)
ESC [2ST; 1; 2; n !v
ESC [2ST; 1; 3; n !v
= 1 : 180-degree rotation (upside
down)
= 1 : 180-degree rotation (upside
down)
= 1 : Swapped (front side faces
away from the front of the
Escape Sequence
Functionality
Possible Values
printer)
ESC [2ST; 1; 4; n !v
ESC [2ST; 2; 1; n !v
ESC [2ST; 2; 2; n !v
ESC [2ST; 2; 3; x; y; z !v
Enables / disables
predefined Reprint on
Error message
n = 0 : Disable
Enables / disables
predefined Bottom
Front message
n = 0 : Disable
Enables / disables
predefined Top Back
message
n = 0 : Disable
Sets attributes for a
predefined Bottom
Front / Top Back /
Reprint message
x = 0 : Front
= 1 : Enable
= 1 : Enable
= 1 : Enable
= 1 : Back
= 2 : Reprint
y = 1 : First Line
= 2 : Second Line
z = 0x1 : Double High
0x4 : Double Wide
0x10 : Emphasize Mode
0x40 : 1 Dot Underline Mode
0x100 : Inverse Video
0x400 : Italic
0x1000 : 2 Dot Underline
Mode
0x4000 : Alternate Color
Adding all attribute values
together would equal to 0x5555.
Escape Sequence
Functionality
Possible Values
Note: Parameter z is coded as
ASCII characters, but they
represent a Hex-based number.
ESC [2ST; 2; 4; x; y !v
[text]
Sets the string for a
predefined Bottom
Front / Top Back /
Reprint message
x = 0 : Front
= 1 : Back
= 2 : Reprint
y = 1 : First Line
= 2 : Second Line
= ASCII character to define
pre-defined lines.
text
ESC [2ST; 3; n !v
[directory/filename]
Activates predefined
back side image or
loads a specified
image.
n = 1-25 : Corresponds to the
PreDefinedImageX options. If
the PreDefinedImageX option
for n does not exist, it is
ignored.
= 0 : Corresponds to the
directory and filename of the
predefined image file.
ESC [2ST; 4; n !v [text]
Defines variable print
data. It allows a
dynamic definition of
predefined variables
embedded in static
images.
n = 1-50 : Corresponds to the
variable to define
= ASCII string to assign to
the variable. It only allows a
maximum of 57 characters.
Characters beyond 57 are
ignored.
text
The escape sequences defined above that set the 2ST modes and change
the pre-defined text values must be sent in their own Transaction print.
They should be sent either before any Receipt is printed or between
Receipt Transaction prints. They should not be sent as part of a Receipt.
This is because they do not take effect until the next Transaction print.
The only exception is the ESC [2ST; 4; n !v [text] which defines the
dynamic data for pre-defined variables in reverse side images. This
escape sequence is intended to define text to be printed as part of the
current Receipt.
Special Escape Sequences to Switch between Modes
The following escape sequence is used to dynamically change the way
OPOS / JavaPOS handles two-sided printing. Because this sequence is
changing the mode of operation it is only valid under certain
conditions. It will set the mode in the same manner as if the
DeviceEnable had been performed with this mode configured in the
TST2SideMode option.
Escape Sequence
Functionality
Possible Values
ESC [2ST; 5; n !v
Sets the printer’s
mode of operation
n = 0 : Single Sided Mode
This parameter is only valid
immediately after a knife cut,
before any other print orientation
is sent to the printer. It is ignored
if the printer is already processing
data.
= 1 : Double Sided Mode with
Single Side Command
If in mode 0, this is valid only if
there are no outstanding print
operations. If in a two-sided
mode, the same restrictions as
Escape Sequence
Functionality
Possible Values
listed in mode 0 apply.
= 2 : Double Sided Mode with
Double Side Command
If in mode 0, this is valid only if
there are no outstanding
operations. If in a two-sided
mode, the same restrictions in
mode 0 apply.
= 3 : Double Sided Mode with
Predefined Data
If in mode 0, this is valid only if
there are no outstanding
operations. If in a two-sided
mode, the same restrictions in
mode 0 apply.
Select Print Side Sequence
This special sequence is only valid when mode 2 (Double Sided Mode
with Double Side Command) is selected. If any other mode is selected,
it is ignored. This sequence must be sent in a separate print line, with
no other data.
This escape sequence is used within a transactionPrint to designate
which side of the thermal paper, subsequent print operations are
performed.
Escape Sequence
Functionality
Possible Values
ESC [2ST; 6; n !v
Selects the side to
print data on
n = 0 : Send data to front side of
paper
= 1 : Send data to back side of
Escape Sequence
Functionality
Possible Values
paper
Once this command is issued, all print operations continue to be sent to
that side of the paper until the sequence is sent again to change it, or
until a transactionPrint(PTR_TP_NORMAL) is issued.
After transaction printing has completed, the current side is always
reset to the front side of the paper.
OPOS / JavaPOS Mode Functional Definition
Single Sided Mode (TST2SideMode = 0)
This is the default mode of operation. When this setting is selected, the
OPOS / JavaPOS Service sets the printer to this mode at DeviceEnable
time. None of the other two-sided configuration options is processed.
Any two-sided NCR proprietary escape sequences are ignored, except
for the escape sequence that switches modes. In this mode, the printer
functions the same as all previous thermal receipt printers.
Two-Sided Modes (TST2SideMode = 1, 2, 3)
Once a two-sided mode is entered, the application can ONLY print
using the OPOS / JavaPOS transactionPrint method. The reason for
this restriction is due to error-handling. Because the printer has to
buffer all data before printing, there is no way to determine errors on a
line level. Due to this buffering, errors can only be recovered at a
transaction level. Therefore we enforce the use of transaction printing
only while in a two-sided mode.
While a two-sided mode is active, any print operation attempted
outside of a transaction print results in an OPOS_E_ILLEGAL error.
The only exception is a PrintNormal containing only the escape
sequence to switch to another two-sided mode, or to switch to singlesided mode.
Two-Sided Modes
Functionality
TST2SideMode = 1
When this mode of operation is selected, the printer
Two-Sided Modes
Functionality
(Double Sided Mode with
Single Side Command)
buffers all print commands sent to it until a paper
cut command is issued. At that time, it splits the
receipt and prints it between the front and back.
All of the two-sided escape sequences and settings
are valid except for those that deal with a
predefined back side image, or selecting a specific
print side.
TST2SideMode = 2
(Double Sided Mode with
Double Side Command)
This mode of operation is the one that gives the
application the most flexibility in two-sided
printing. It allows the application to define and
print anything they want on both sides of the paper
dynamically.
See Select Print Side Sequence for special ESC
sequence only available in this mode.
TST2SideMode = 3
(Double Sided Mode with
Predefined Data)
As with all of the TST2SideMode settings, this mode
is initiated at DeviceEnable time, or with the select
mode escape sequence. At enable time, the Service
Object loads the predefined image file from the
configuration setting of PreDefinedImage1 and
enables the two-sided mode. If this mode is selected
but the TSTPreDefinedImage1 is not populated, any
existing predefined image in the printer is cleared.
All of the two-sided escape sequences are valid for
this mode of operation except for the Select Print
Side sequence.
The ESC [2ST; 3; n !v [directory / filename]
activates the predefined back side image and can be
used to change the image that is being used for the
back side of the paper. If this sequence is sent with
n = 0 but no [directory / filename] parameter, it
is assumed that the user wants to erase the existing
predefined image and clears it.
The above sequence is ONLY VALID after a knife
Two-Sided Modes
Functionality
cut, and before any other print operation is sent to
the printer. If any other print operation is sent to the
printer before this sequence, then it is ignored.
Two Sided Thermal Specific Configuration Entries
The following configuration entries apply to NCR two sided thermal printers.
Parameter
Description
Valid Values
Two Sided Thermal Print
Mode
Determines the initial two sided thermal
mode, which is set at enable time.
Single sided: Print to the front of
the receipt only. In this mode, all
of the other two sided thermal
configuration entries are ignored.
This is the default.
Split Receipt: Data is buffered
until a knife cut is received. After
the knife cut, the printer will split
the print lines, printing roughly
half the data on the front of the
receipt and half on the back
Full Control: The application
must explicitly switch between
print sides using the Select Print
Side sequence. This mode gives
the application maximum control
over what is printed on each side
of the receipt.
Static Reverse Side Image: Data
is buffered until a knife cut is
received. After the knife cut, all
print data is sent to the front of the
receipt. The back of the receipt
will contain a static image as
defined using the
TSTPreDefinedImageX
configuration data entries or the
ESC [2ST; 3 escape sequence.
Parameter
Description
Valid Values
Two Sided Paper Type
Detection
Enables or disables two sided thermal paper
detection
Enabled (Default for F309)
Two Sided Thermal
Orientation
Determines the orientation of text on the front
and back of the receipt.
Front normal, Back normal
(Default)
Disabled (Default for 7168, 7198)
Front normal, Back upside down
Front upside down, Back normal
Front upside down, Back upside
down
Two Sided Thermal Print
Sides
Determines which side of the receipt is the
front and which is the back.
Front and back normal (Default)
Two Sided Thermal
Minimum Receipt
Length
The minimum receipt length, in inches, before
the receipt will be split between front and
back in split receipt mode.
2 – 10 inches.
Two Sided Thermal
Enable Front Predefined
Text
Enables or disables printing of a predefined
message on the bottom front of each receipt.
Enabled
Two Sided Thermal
Predefined Front Line 1
Text
First line of the front predefined text.
Set this value to a text string, or an
empty string.
Two Sided Thermal
Predefined Front Line 1
Attributes
Attributes for the first line of the front
predefined text.
See the attribute table below for
valid attribute values.
Two Sided Thermal
Predefined Front Line 2
Text
Second line of the front predefined text.
Set this value to a text string, or an
empty string.
Front and back swapped: Front
data prints on the back of the
receipt, and back data prints on the
front
No minimum: There is no
minimum length; however,
receipts shorter than 23.5mm
cannot be split. This is the
default.
Disabled (Default)
“-1” indicates that this line should
not be loaded to the printer. This
is the default. A value of “-1”
reduces the time required to
enable the printer.
“-1” indicates that this line should
not be loaded to the printer. This
is the default. A value of “-1”
reduces the time required to
enable the printer.
Parameter
Description
Valid Values
Two Sided Thermal
Predefined Front Line 2
Attributes
Attributes for the second line of the front
predefined text.
See the attribute table below for
valid attribute values.
Two Sided Thermal
Enable Back Predefined
Text
Enables or disables printing of a predefined
message on the top back of each receipt.
Enabled
Two Sided Thermal
Predefined Back Line 1
Text
First line of the back predefined text.
Set this value to a text string, or an
empty string.
Two Sided Thermal
Predefined Back Line 1
Attributes
Attributes for the first line of the back
predefined text.
See the attribute table below for
valid attribute values.
Two Sided Thermal
Predefined Back Line 2
Text
Second line of the back predefined text.
Set this value to a text string, or an
empty string.
Two Sided Thermal
Predefined Back Line 2
Attributes
Attributes for the second line of the back
predefined text.
See the attribute table below for
valid attribute values.
Two Sided Thermal
Reprint After Errors
Enables or disables automatic reprint on
errors.
Enabled
Two Sided Thermal
Enable Predefined
Reprint Text
Enables or disables printing of a predefined
message as part of the reprint on error
processing.
Enabled
Two Sided Thermal
Predefined Error Reprint
Line 1 Text
First line of the reprint on error predefined
text.
Set this value to a text string, or an
empty string.
Two Sided Thermal
Predefined Error Reprint
Attributes for the first line of the reprint on
error predefined text.
Disabled (Default)
“-1” indicates that this line should
not be loaded to the printer. This
is the default. A value of “-1”
reduces the time required to
enable the printer.
“-1” indicates that this line should
not be loaded to the printer. This
is the default. A value of “-1”
reduces the time required to
enable the printer.
Disabled (Default)
Disabled (Default)
“-1” indicates that this line should
not be loaded to the printer. This
is the default. A value of “-1”
reduces the time required to
enable the printer.
See the attribute table below for
valid attribute values.
Parameter
Line 1 Attributes
Description
Valid Values
Two Sided Thermal
Predefined Error Reprint
Line 2 Text
Second line of the reprint on error predefined
text.
Set this value to a text string, or an
empty string.
Two Sided Thermal
Predefined Error Reprint
Line 2 Attributes
Attributes for the second line of the reprint on
error predefined text.
See the attribute table below for
valid attribute values.
Two Sided Thermal End
Transaction Auto Knife
Enables or disables automatic knife cuts at the
end of each transaction. A knife cut is
required to initiate printing of the receipt.
This is only for Split Receipt and Static
Reverse Side Image modes.
Enabled (Default): A knife cut is
automatically issued at the end of
each transaction.
Two Sided Thermal
Predefined Image 1
File defining a reverse side image for use in
Pre-Defined image mode.
Fully qualified file name of a
reverse side image file. Default
value is an empty string. Once an
empty string or invalid file name
is found, no more predefined
image entries are read.
Two Sided Thermal
Predefined Image 2
File defining a reverse side image for use in
Pre-Defined image mode.
Fully qualified file name of a
reverse side image file. Default
value is an empty string.
Two Sided Thermal
Predefined Image 3
File defining a reverse side image for use in
Pre-Defined image mode.
Fully qualified file name of a
reverse side image file. Default
value is an empty string.
“-1” indicates that this line should
not be loaded to the printer. This
is the default. A value of “-1”
reduces the time required to
enable the printer.
Disabled: The application must
issue the knife cut to initiate
printing.
Note: If predefined text is defined either as NULL or Text Data and
preeefined modes are enabled, DeviceEnable may take up to 20 seconds
due to loading or clearing of these strings in memory. To enable
predefined modes but not load strings, use -1 in the text field.
Attribute Table for Predefined Text Attribute Values
Add text attribute values (Hex) together to obtain final value of desired
text attribute option.
Predefined Text Attribute Value
Text Attribute
0x1
Double High
0x4
Double Wide
0x10
Emphasize Mode
0x40
1 Dot Underline
0x100
Inverse Video
0x400
Italic
0x1000
2 Dot Underline
0x4000
Alternate Color
Note: The predefined image files must have the following format:
Macro Select, Define Macro, Print Commands, End Macro Define, Data for Bitmaps
1F 67 xx
1D 3A
various
1D 3A
various
Two Sided Thermal Paper Type Events
If two sided paper type detection is enabled in the printer
configuration entries, the application will receive DirectIO events when
the type of paper in the receipt station changes. The DirectIO events
contain the following data:
Parameter
Description
Event Number
NCR_PTR_DIOE_2ST_PAPER_SENSOR
Data
Holds the new paper type. This will be
one of:
PTR_2ST_PAPER_UNKNOWN:
Paper type is unknown
PTR_2ST_PAPER_SINGLE: Single
sided paper
PTR_2ST_PAPER_DOUBLE:
Double sided paper
object
Not Used
Scale
The Scale supports many NCR Scanner/Scale devices. See the
supported device table for the Scale models supported.
“Serial or NCR USB” connection type is for use with either serial or
USB Scanner using a serial emulation driver. The serial emulation
driver is installed when the USB scanner is first attached to the
terminal. This driver creates a virtual serial COM port which is used
just like any COM port. The “Uses” parameter must be set with the
scanner profile whose connection type must be “SERIAL or NCR USB”.
USB connection type is a HID USB connection and is supported for
NCR 7872, 7874, 7875, 7876, and 7878 scanner/scales.
7874 and 7878 scales have a 15Kg maximum weight which is different
from the other scales. Make sure the profile “Model” property matches
the sale model being used.
The “Uses” parameter must be set to NONE for a USB connection type.
DirectIO - Scale Status
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAL_STATUS (601).
data
Not Used.
object
Returns the status string direct from the
scale. You must know the scale interface
to decode the string.
DirectIO - Scale Read ROM
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAL_READROM (602).
data
Address to read from.
object
Returns 30 bytes of ROM data.
DirectIO - Scale ROM Version
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAL_ROM_VERSION (603).
data
Not Used.
object
Returns the ROM version number.
DirectIO - Scale Live Weight
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
Errors
command
NCRDIO_SCAL_LIVE_WEIGHT (604).
data
Returns the weight prodivde by the low
level "monitor" scale firmware command.
object
Not Used.
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
Value
Meaning
JPOS_E_FAILURE
The device cannot perform the requested
procedure, even though the device is
connected to the system, powered on,
and on-line.
JPOS_E_TIMEOUT
A stable non-zero weight was not
available before Timeout milliseconds
elapsed.
JPOS_E_EXTENDED
ResultCodeExtended =
JPOS_ESCAL_OVERWEIGHT: The
weight was over MaximumWeight.
NCR_ESCAL_UNSTABLE: The scale
reading is not stable.
NCR_ESCAL_ZEROWEIGHT: The scale
is not registering a weight.
NCR_ESCAL_UNDERZERO: The scale is
reading less than zero weight.
DirectIO - Scale Direct Access
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAL_DIRECT (605).
data
False (0), no data is returned.
object
String to send to the scale, including the
suffix and BCC character (if needed) or
the string data returned from the scale.
Method Updates
ReadWeight Method Updated in UPOS Release 1.9
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
Remarks
command
ReadWeight
data
If AsyncMode is FALSE, Points to the
number where the weight is returned;
else must be zero..
object
The number of milliseconds to wait for a
settled weight before failing the method.
If zero, the method attempts to read the
scale weight, then returns the appropriate
status immediately.
If JPOS_FOREVER (-1), the method waits
as long as needed until a weight is
successfully read or an error occurs.
Call to read a weight from the scale.
Release 1.0 – 1.2
The weighing process is performed synchronously and the
method will return after finishing the weighing process. The
weight is returned at pWeightData,
Release 1.3 and later
If AsyncMode is FALSE, then ReadWeight operates
synchronously, as with earlier releases.
If AsyncMode is TRUE, the weighing process is performed
asynchronously. The method will initiate a read, then return
immediately. If the method returns a success status, the weighing
process is started and a DataEvent containing the weight in its
Status parameter indicates its completion.
The weight has an assumed decimal place located after the
“thousands” digit position. For example, an actual value of 12345
represents 12.345, and an actual value of 5 represents 0.005.
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
Value
Meaning
E_TIMEOUT A stable non-zero weight was not available before timeout
milliseconds elapsed (only if AsyncMode is false).
E_EXTENDED ErrorCodeExtended = ESCAL_OVERWEIGHT: The weight
was over MaximumWeight. This can only be returned if AsyncMode is false.
The following standard extended error codes have been added in Release 1.9
as
possible values of the exception’s ErrorCode property: E_EXTENDED
ErrorCodeExtended = ESCAL_UNDER_ZERO: The scale is reporting a weight
that is less than zero due
to a calibration error. The scale should be recalibrated.
This can only be returned if AsyncMode is false. E_EXTENDED
ErrorCodeExtended = ESCAL_SAME_WEIGHT: The scale is reporting that the
item/weight on the scale
is identical to the previously reported Item/weight; i.e., the item has not been
removed from the scale. This can only be returned if AsyncMode is false and
the scale hardware directly supports this capability.
zeroScale Method Updated in UPOS Release 1.9
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
zeroScale
Remarks
If CapZeroScale is true, sets the current scale weight to zero. It
may be used for initial calibration, or to account for tare weight
for the scale.
Note: zeroScale method may return an unsuccessful resultcode
due to the length of time required for a scale to execute a zero
scale. The application should retry the method on a failed
condition.
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
Value
Meaning
E_ILLEGAL CapZeroScale is false.
E_TIMEOUT CapZeroScale is true but the command failed in executing
the operation with the device.
Event Updates
StatusUpdateEvent Updated in Release 1.10
<< event >>
upos::events::StatusUpdateEvent
Status: int32 { read-only }
Description
Attributes
Notifies the application that there is a change in the power status
of a Scale device. If the StatusNotify property is
SCAL_SN_ENABLED, this event can also notify the application
that there is a change in the Scale device weight. If the property
StatusNotify is true when the scale is enabled, an immediate
StatusUpdateEvent should be generated to notify the
application of the current state of the scale.
This event contains the following attribute:
Attribute
Type
Description
Status
int32
Reports a change in the power state of a Scale
device.
Note that Release 1.3 added Power State Reporting with additional Power
reporting StatusUpdateEvent values. The Update Firmware capability, added in
Release 1.9, added additional Status values for communicating the status/progress
of an asynchronous update firmware process.
See “StatusUpdateEvent” description on page 66. Added in Release 1.9 and
delivered if StatusNotify is set to SCAL_SN_ENABLED.
Value
Meaning
SCAL_SUE_STABLE_WEIGHT
Scale weight is stable. The
ScaleLiveWeight property is
updated before event delivery.
SCAL_SUE_WEIGHT_UNSTABLE Scale weight is unstable.
SCAL_SUE_WEIGHT_ZERO Scale weight is zero.
SCAL_SUE_WEIGHT_OVERWEIGHT Scale weight is overweight.
SCAL_SUE_NOT_READY
Scale is not ready to weigh.
SCAL_SUE_WEIGHT_UNDER_ZERO Scale weight is under zero.
Remarks
Enqueued when the Scale device detects a
power state change or a status change.
See Also “Events” on page 15, ScaleLiveWeight Property,
StatusNotify Property.
Scale Serial or NCR USB Configuration Entries
Scale Serial or NCR USB configuration uses a COM port for
communication to the device. For SERIAL connection type, the COM
port is a hardware port on the terminal. For NCR USB connection
type, the COM port is a virtual COM port created by a Serial Emulation
Driver installed the first time the device is connected to the terminal.
Serial or NCR USB Scale profiles must set the “Uses” parameter to
point to the scanner profile for the device.
Scale Configuration Entries
Parameter
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRScale.7872 (Any name you wish)
Programmatic ID
This is the Service Object name for the
Scale
NCROposSO.Scale
NCR Model Layer
Connection Type
NCR78xxScannerScale
Describes how the scanner is connected to
the terminal only for USB connections.
USB
For HID USB connection type is USB.
Note: All other connection types used the
“Uses” parameter and the scanner profile
ConnectionType.
ScaleModel
Model number of the device
NCR 7872 (Default)
NCR 7874
NCR 7875
NCR 7876
NCR 7878
NCR 7883
NCR 7884
MonitorEnable
Enables the ReadWeight method to return
a continuous weight when a stable weight
is available. Disable returns only a NEW
weight.
Disabled (Default)
Enabled - Return continuous weight.
Application is responsible for assuring
a stable legal weight.
StatusNotifyTime
When property “StatusNotify” is set to
ENABLED, this value sets the internal
poll time to deliver an event of the current
scale state or a weight when a stable
weight is available. Only CHANGED
scale status produces a new event.
200ms
300ms (Default)
This is the vendor USB ID.
0 (Default)
Vendor ID(USB
Only)
500ms
1 sec
NCR
Another vendor value
Product ID(USB
Only)
This is the scale USB product ID
0 (Default)
NCR 78xx
NCR 7874
NCR 7878
NCR 7884
Device Path(USB
only)
USB Configuration – Specifies the USB
device path using the “DevPath” entry in
the
$NCR$\Config\IOManager\HIDDevices.c
onf file for the device.
0 (Default)
Device Usage (USB
only)
USB Usage value.
0x6E00(Read Only)
Device Usage Page
(USB only)
USB Usage Page
0xFF45 (Read Only)
Metric (USB only)
Selects the scale metric (kg) weight
Disabled (Default) Pounds mode
Example: 5.1
FiveDigit (USB only)
Uses (Serial or NCR
USB only)
interface when enabled. Selects the
Engilish (lbs) weight interface when
disabled. Must match the scale setting.
Enabled – Kilogram mode.
“FiveDigit” weight must be enabled
when in Kilogram mode.
Selects the number of digits returned from
a weight request. When disabled, 4 digits
of weight is returned with a accuracy to the
hundredths. When Enabled the Weight
returned shall be 5 digits with an accuracy
of thousandths.
Disabled (Default) 4 Digit
Enabled – 5 Digit
For Serial and NCR USB connections the
Scale uses the parameters of the Scanner
service object in addition to the parameters
described here. Therefore, the Scanner
parameter entries (using the
NCROposS).Scanner Programmatic ID)
must be set up first.
The profile name of the Scanner for
Serial or NCR USB.
“FiveDigit” must be enabled when
“Metric” is enabled. 4 Digit is not
support in Kilogram mode.
None (blank) for USB.
For a USB connection the “Uses”
parameter is not needed and shall be
empty.
Require Max Weight
(Serial or NCR USB
only) *
*Future releases will
support this feature
for USB
ConnectionType as
well.
If Require Max Weight is enabled, the
device enable will fail if the scale request
max weight command does not return a
response.
If Require Max Weight is disabled, the
device enable will succeed even if the
scale request max weight command does
not return a response.
If no response is received, a constant value
based on the scale model will be used for
max weight.
Disabled (Default).
Enabled.
Scale USB Configuration Entries
Scale USB configuration uses the operating system USB driver as a
Human Interface Device (HID). See the Scanner FAQ section for
device programming instructions.
USB Scale profiles must set the “Uses” parameter to “NONE”. The
USB Scale does not use the scanner profile settings for its connection.
Scale USB Configuration Entries
Scale Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the Motion Sensor is controlled through settings stored in
the NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the Scale components.
[NCROposSO.Scale]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRScale]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRScannerHydra]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Scanner
The Scanner supports many NCR Scanner devices. See the supported
device table for the Scanner models supported.
All DirectIO is supported for NCR 787x, 788x and 7892 serial or NCR
USB scanners.
DirectIO - Scanner Direct Access and DirectIO - Scanner ROM Version
only is supported on models NCR 7837-xxxx, NCR 7838, 3800, 4600
and 5620 serial scanners and NCR 2356 USB scanners.
No DirectIO is supported for model NCR 7837, 2356 or 2357 serial
scanners. These scanners are not command controlled and only receive
tag data.
Serial signal line control of scanner enable/disable is limited to NCR
2356 and NCR 2357 serial scanners.
NCR USB connection type is for use with USB serial emulation driver.
Serial signal line control of enable/disable is not supported for NCR
USB connection types.
USB connection type is a HID USB connection and is supported for
newer NCR 78xx scanner/scales and NCR 2356 Handheld scanners.
See the Scanner FAQ section for scanner configuration suggestions.
DirectIO - Scanner NOT-ON-FILE
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_NOT_ON_FILE (508)
data
Not Used.
object
Not Used.
Note: The service object will automatically disable the scanner after the NOF
command is sent. The application MUST also set deviceEnabled property to
Disabled to make the UPOS state match the scanner.
DirectIO - Scanner Tone Control
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_TONE (501)
data
SCAN_TONE_BEEP (1001)
SCAN_TONE_ENABLE (1002)
SCAN_TONE_DISABLE (1003)
object
Not Used.
DirectIO - Scanner Reset
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_RESET (502)
data
Not Used.
object
Not Used.
DirectIO - Scanner Status
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_STATUS (503)
data
Not Used.
object
Status string (direct from scanner). You
must know the scanner interface to
decode the string.
DirectIO - Scanner Read ROM
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_READROM (504)
data
Address to read from.
object
Returns 30 bytes of ROM data.
DirectIO - Scanner ROM Version
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_ROM_VERSION (505)
data
Not Used.
object
Returns the ROM version ID.
DirectIO - Scanner Pacesetter Options
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_PACESETTER (506)
data
Requested sub-command
PACESETTER_READ_GOOD (1101)
PACESETTER_READ_NO_READS
(1102)
PACESETTER_READ_OVERPRINT
(1103)
PACESETTER_READ_UNDERPRINT
(1104)
PACESETTER_READ_MISS_MARGIN
(1105)
PACESETTER_RESET (1106)
PACESETTER_ENABLE_MODE_3
(1107)
PACESETTER_DISABLE_MODE_3
(1108)
object
Not Used.
If the command is successful, and a READ
sub-command (1101-1105) was issued, the
tally value is placed in data.
NOTE: The Pacesetter command is only supported on the
NCR 7875, scanner.
DirectIO - Scanner Direct Access
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SCAN_DIRECT (507)
data
False (0), no data is returned.
object
String to send to the scanner, including
the suffix and BCC character (if needed)
or the string data returned from the
scanner.
Note: For models NCR 7837-xxxx and 7838, the string should be the
command string without the Menu command prefix and the command suffix.
Both are added by the service object..
Scanner Serial or NCR USB Configuration Entries
Scanner Serial or NCR USB configuration uses a COM port for
communication to the device. For SERIAL connection type, the COM
port is a hardware port on the terminal. For NCR USB connection
type, the COM port is a virtual COM port created by a Serial Emulation
Driver installed the first time the device is connected to the terminal.
Scanner Serial or NCR USB Configuration Entries
Parameters
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRScanner.7872 (Any name you wish)
Programmatic ID
This is the Service Object name for the
Scale
NCROposSO.Scanner
NCR Model Layer
Scanner Model
NCR78xxScannerScale
Model number of the Scanner connected
to the terminal.
NCR 7838-SS indicates 7838 Self
NCR 2356
NCR 2357
NCR 7832
NCR 7837
NCR 7837-1300
Parameters
Description
Service scanner for FastLane and Kiosk
applications.
NCR 7404EP Advantage Kiosk
integrated scanner is the NCR Omni
Directional scanner. The only connection
type is USB.
NCR 7409 integrated scanner for driver’s
license scanning is scanner model 4980.
The only connection type is USB.
Connection Type
Describes how the scanner is connected
to the terminal.
SERIAL is RS232 connection.
Valid Values
NCR 7837-3000
NCR 7838
NCR 7838-SS
NCR 7872
NCR 7874
NCR 7875
NCR 7876
NCR 7878
NCR 7880
NCR 7882
NCR 7883
NCR 7884
NCR 7892
NCR 7893
4980
3800
4600
5600
5620/3820
NCR Omni Directional
Other
Serial or NCR USB (Default)
USB
Wedge
NCR USB connection is USB with a
Serial emulation driver installed to
provide a virtual COM port.
HID USB connection is USB.
EnableIfOff
Prefix
Suffix
EnableItOff value of 1 causes the model
to succeed DeviceEnable when the device
is powered off. This is for models that
support power reporting and
automatically initialize and enable the
device when power is applied.
Fail Enable (Default)
Succeed Enable
Must match the device setting. .Prefix,
prepends a byte or 2 to the device
message. Prefix is not included in BCC
calculation.
None (Default)
Must match the device setting. Suffix
prepends a byte or 2 to the device
message. Suffix is included in the BCC
calculation.
0x03 (Default)
Note: Not supported for USB.
Note: Not supported for USB.
Note: Not supported for USB.
Parameters
Description
Valid Values
InitDevice*
Determines when device
initialization occurs. Device
initialization occurs at Device
Enable but for better performance,
initialization shall occur only at the
FIRST Device Enable after either
Open or Claim.
0x00 (Default)
Not visible with
RSM/LE
Set to a value of 1 shall initialize
device at the first device enable
after Open.
The default behavior shall initialize
the device on the first device enable
after Claim.
The default value is zero.
NCR 7872, 7874,7875, 7876, 7878, 7883, 7884 Serial and NCR USB Properties
MessageFormat
MessageFormat applies to scanner/scale
devices only. ScannerScale devices
default to a message format of
ScannerScale. Re-programming a
scannerscale device to scanner-only mode
will default to a message format of
Scanner Only.
Scanner Only (Default 7832, 7837 7837xxxx, 7838, 7883, 7892)
ScannerScale (Default 7872, 7875, 7876)
Block Check Characters(BCC) Exclusive OR of all bytes in a message
except the prefix byte. Default is Enabled
for scanner/scale devices. Default is
Disabled for scanner/scale devices reprogrammed to Scanner Only.
Disabled (Default 7832, 7837, 7838, 7883,
7892)
Enabled (Default 7872, 7875, 7876)
RemoveSpaces
Applicable only when “CheckDigit” is
“Enabled”. Enables removal of spaces
within a barcode. “Remove” sets
“RemoveSpaces” config file parameter to
1.
Do not remove (Default)
Remove
CheckDigit
Applicable only to barcodes that support
a check digit. Enables calculation of a
check digit for barcodes received from
the scanner without a check digit.
“Enabled” sets “AutoCD” config file
parameter to 1.
Disabled (Default)
Enabled
Bcc
Note: Not supported for USB.
Note: Not supported for USB.
Parameters
Description
Valid Values
Serial Port Parameters for NCR 7872, 7874, 7875, 7876, 7880, 7883, 7884 and Scanner-Only NCR
Scanners, NCR 7882, NCR 7892, NCR 7893
Port Name
Serial port name connected to the device.
USB devices using IO Network drivers
must assign the port used by the driver
COM1 - COM10
COM1 (Default)
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
9600 bps (Default)
4800 bps
Data Bits
The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits (Default)
8 bits
Parity
Serial Only. Specifies the parity scheme
for serial communications
None
Even
Odd (Default)
Stop Bits
Serial Only. The number of stop bits to
use for serial communications.
1 bit (Default)
2 bits
CTS Flow Control
Permit serial flow control through the
Clear to Send (CTS) signal.
Disabled
Enabled (Default)
DSR Flow Control
Permit serial flow control through the
Data Set Ready (DSR) signal.
Disabled
Enabled (Default)
NCR 7880, 7882, 7892 and 7893 Common Properties
Bcc
Block Check Characters(BCC) Exclusive OR of all bytes in a message
except the prefix byte.
Proqgramming
Sequence
For models that support programming
sequences. The string is sent to the
device verbatim during initialization.
Disabled (Disabled)
Enabled
Parameters
Description
Valid Values
Port Name
Serial port name connected to the device.
USB devices using IO Network drivers
must assign the port used by the driver
NCR Version
NCR Release File Version of the Service
Object.
ASCII Text
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
9600 bps (Default)
4800 bps
Data Bits
The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits (Default)
8 bits
Parity
Serial Only. Specifies the parity scheme
for serial communications
None
Even (Default)
Odd
Stop Bits
Serial Only. The number of stop bits to
use for serial communications.
1 bit (Default)
2 bits
CTS Flow Control
7837 Only)
Permit serial flow control through the
Clear to Send (CTS) signal.
Disabled (Default)
Enabled
DSR Flow Control
(7837 Only)
Permit serial flow control through the
Data Set Ready (DSR) signal.
Disabled (Default)
Enabled
NCR 7837 Properties
COM1 - COM10,
COM1 (Default)
Serial Port Properties for Input-Only (7837) Scanners
Parameters
Description
Valid Values
Port Name
Serial port name connected to the device.
USB devices using IO Network drivers
must assign the port used by the driver
COM1 – COM10,
COM1 (Default)
NCR Version
NCR Release File Version of the Service
Object.
ASCII Text
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
38400 bps (Default)
Data Bits
The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits
8 bits(Default)
Parity
Serial Only. Specifies the parity scheme
for serial communications
None(Default)
Even
Odd
Stop Bits
Serial Only. The number of stop bits to
use for serial communications.
1 bit (Default)
2 bits
CTS Flow Control
7837 Only)
Permit serial flow control through the
Clear to Send (CTS) signal.
Disabled (Default)
Enabled
DSR Flow Control
(7837 Only)
Permit serial flow control through the
Data Set Ready (DSR) signal.
Disabled (Default)
Enabled
AimerLED
Scanner Aimer LEDs brightness control.
100 (Default)
0, 50%, 100%
LightLED
Illumination LEDs control. Sets LEDs
either ON or OFF while reading.
?? (Default), Disabled, Enabled
NCR 7837-xxxx, 7838, 2357-xxxx Properties
115200 bps (Default 7838-SS)
Disabled = OFF
Value of “??” means DO NOT MODIFY.
(*See Note)
AllSymbologies
Send command to enable all supported
barcode symbologies.
Disabled (Default), Enabled
ReadTimeout
Manual mode timeout from enable to
when the LEDs go off. Value 0 sets the
timeout to infinite.
?? (Default) (*See Note)
Range: 0-300000 (ms)
TriggerMode
Trigger mode for starting a read Manual
or Presentation mode.
MANUAL (Default)
MANUAL - trigger mode 0
Manual requires scanner trigger press.
PRESENTATION - trigger mode 3
Presentation detects barcode in scanner
view.
Value of “??” means DO NOT MODIFY.
Parameters
Description
Valid Values
AuxLED
Auxliary LEDs present in 7838-SS only.
Default (“??”)(*See Note)
0 = Off
1 = On
2 = Follow Trigger
3 = Follow LightLED (Default 7838-SS)
ScannerScaleACK
Use to decrease time to enable/disable by
not waiting for device ACK to command.
0 (Default)
Value 1 – Ignore disable ACK.
Default is wait for all ACKs.
Value 2 – Ignore enable ACK
Value 3 – Ignore enable and disable ACK.
*Note: For 7837 and 7838 scanners, value “??” indictes this parameter will not be configured and the
setting in the scanner shall be used. This improves performance by not initializing parameters not
configured.
NCR2356 Serial or NCR USB Properties
Port Name
Serial port name connected to the device.
USB devices using IO Network drivers
must assign the port used by the driver
COM1 - COM10,
COM1 (Default)
Serial Port Properties for Input-Only (Other) Scanners
NCR Version
NCR Release File Version of the Service
Object.
ASCII Text
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
9600 bps (Default)
4800 bps
Data Bits
The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits
8 bits (Default)
Parity
Serial Only. Specifies the parity scheme
for serial communications
None (Default)
Even
Odd
Stop Bits
Serial Only. The number of stop bits to
use for serial communications.
1 bit (Default)
2 bits
RTSEnable
Serial (RTS) Enable/Disable scanning
control through the Clear to Send (CTS)
signal.
Disabled (Default)
Enabled
.
NCR 2356 Serial with Enable/Disable Control
Parameters
Description
Valid Values
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
9600 bps (Default)
4800 bps
Data Bits
The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits
8 bits (Default)
Parity
Serial Only. Specifies the parity scheme
for serial communications
None (Default)
Even
Odd)
Stop Bits
Serial Only. The number of stop bits to
use for serial communications.
1 bit
2 bits (Default)
RTSEnable
Serial (RTS) Enable/Disable scanning
control through the Clear to Send (CTS)
signal.
Enabled
Port Name
Serial port name connected to the device.
USB devices using IO Network drivers
must assign the port used by the driver
NCR Version
NCR Release File Version of the Service
Object.
ASCII Text
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
9600 bps (Default)
4800 bps
Data Bits
The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits
8 bits (Default)
Parity
Serial Only. Specifies the parity scheme
for serial communications
None (Default)
Even
Odd
Stop Bits
Serial Only. The number of stop bits to
use for serial communications.
1 bit (Default)
2 bits
CTS Flow Control
7837 Only)
Permit serial flow control through the
Clear to Send (CTS) signal.
Disabled (Default)
Enabled
DSR Flow Control
(7837 Only)
Permit serial flow control through the
Data Set Ready (DSR) signal.
Disabled (Default)
Enabled
Other Properties
COM1 - COM10,
COM1 (Default)
Serial Port Properties for Input-Only (Other) Scanners
Parameters
Description
Valid Values
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
9600 bps (Default)
4800 bps
Data Bits
The number of bits in the bytes
transmitted and received
5 bits
6 bits
7 bits
8 bits (Default)
Parity
Serial Only. Specifies the parity scheme
for serial communications
None (Default)
Even
Odd)
Stop Bits
Serial Only. The number of stop bits to
use for serial communications.
1 bit
2 bits (Default)
Serial Port Properties for NCR 7832 Scanners
Wedge Properties
Connection Type
Indicates the subcomponent on the
Wedge bus to use.
Serial (Default)
Scanner USB Configuration Entries
Scale USB configuration uses the operating system USB driver as a
Human Interface Device (HID).
Only Release 2 (SA) or later scanners and scanner/scales support HID
USB connection type to NCR UPOS. SA scanners and scales (7875,
7876, 7883, 7892) all have the same HID USB product ID (0x200).
Only PXA or later scanner and scales (7874, 7878, 7884, 7893) support
HID USB with unique USB product IDs.
See the Scanner FAQ section for device programming instructions.
Scanner USB Configuration Entries
HID USB Parameters for NCR 7872 7874, 7876, 7878, 7883, 7884, 7892 and NCR 7893
Connection Type
Describes how the scanner is connected to the
terminal. HID USB connection type is USB.
USB
VendorID
Vendor ID of the HID device.
NCR [0x404] (Default)
Any Vendor [0]
ProductID
Product ID of the HID device.
78xx Scanner [0x200] (Default)
7878 Scanner [0x210]
7884 Scanner [0x211]
7874 Scanner [0x212]
7884 Scanner [0x213]
Any Scanner [0]
DevUsagePage
Device Usage Page of the HID device.
0xFF45 (Default)
DevUsage
Device Usage of the HID device.
0x4A00 (Default)
Device Path
USB Configuration – Specifies the USB device
path using the “DevPath” entry in the
$NCR$\Config\IOManager\HIDDevices.conf file
for the device.
0 (Default)
Example: 5.1
Reports
Number of reports of the HID device.
2 (Default)
ClearAfterRead
Clear buffer after read.
true (Default)
Config
Configuration 9 bytes in hex, 2 hex digits per byte.
“” (Default)
Example: 0108004B3B02000015
LabelID
RSS
Enable use of NCR specific symbology IDs.
Enable this parameter if an application decodes the
symbology ID characters within the scan data.
Enabling uses the NCR symbology IDs in the scan
data. If UPOS property ScanDataType is used,
leave this parameter disabled.
Disabled (Default)
Enable RSS barcodes to be read.
Disabled (Default)
Enable RSS/14.
Enable RSS Expanded.
Enable both.
Enabled
HID USB Parameters for NCR 2356 Scanner
Connection Type
Describes how the scanner is connected to the
terminal. HID USB connection type is USB.
USB
Scanner Model
Model number of the Scanner connected to the
terminal.
NCR 2356
VendorID
Vendor ID of the HID device.
0x5E0 (Default)
ProductID
Product ID of the HID device.
0x1400 (Default)
DevUsagePage
Device Usage Page of the HID device.
0xFF45 (Default)
DevUsage
Device Usage of the HID device.
0x4B00 (Default)
Device Path
USB Configuration – Specifies the USB device
path using the “DevPath” entry in the
$NCR$\Config\IOManager\HIDDevices.conf file
for the device.
0 (Default)
Reports
Number of reports of the HID device.
2 (Default)
ClearAfterRead
Clear buffer after read.
true (Default)
Config
Configuration 9 bytes in hex, 2 hex digits per byte.
“” (Default)
LabelID
Enable use of NCR specific symbology IDs.
Enable this parameter if an application decodes the
symbology ID characters within the scan data.
Enabling uses the NCR symbology IDs in the scan
data. If UPOS property ScanDataType is used,
leave this parameter disabled.
Example: 5.1
Example: 0108004B3B02000015
Disabled (Default)
Enabled
HID USB Parameters for NCR 7404 EP Advantage Scanner
Connection Type
Describes how the scanner is connected to the
terminal. HID USB connection type is USB.
USB
Scanner Model
Model number of the Scanner connected to the
terminal.
NCR 7404EP Advantage
NCR 7404EP Advantage is the Kiosk scanner for
the 7404EP Advantage Kiosk.
VendorID
Vendor ID of the HID device.
0x5E0 (Default)
ProductID
Product ID of the HID device.
0x1400 (Default)
DevUsagePage
Device Usage Page of the HID device.
0xFF45 (Default)
DevUsage
Device Usage of the HID device.
0x4B00 (Default)
Device Path
USB Configuration – Specifies the USB device
path using the “DevPath” entry in the
$NCR$\Config\IOManager\HIDDevices.conf file
for the device.
0 (Default)
Reports
Number of reports of the HID device.
2 (Default)
ClearAfterRead
Clear buffer after read.
true (Default)
Configuration 9 bytes in hex, 2 hex digits per byte.
“” (Default)
Config
Example: 5.1
Example: 0108004B3B02000015
LabelID
Enable use of NCR specific symbology IDs.
Enable this parameter if an application decodes the
symbology ID characters within the scan data.
Enabling uses the NCR symbology IDs in the scan
data. If UPOS property ScanDataType is used,
leave this parameter disabled.
Disabled (Default)
Enabled
Scanner JavaPOS Configuration Entries
JavaPOS configuration profiles are by default maintained in the file
config.xml. Config.xml is installed as part of the NCR Retail Platform
Software for Windows install. The installed config.xml file contains
default profiles for many NCR devices. RSM can be used to create and
modify JavaPOS profiles.
Scanner JavaPOS Default Configuration Entries
The following is a sampling of profiles that have been predefined as
JavaPOS default profiles in the file config.xml. This is NOT a complete
list.
Default Configuration
Description
ScannerNCR78xx
NCR 78xx Scanner Serial or NCR USB
ScannerUSB
NCR 78xx USB Scanner
Produce ID = 0 (Any Scanner)
78xxProduct ID = 512
Scanner.7874USB
NCR 7874 USB Scanner
Produce ID = 0 (Any Scanner)
7874 Product ID = 530
Scanner.7884USB
NCR 7884 USB Scanner
Produce ID = 0 (Any Scanner)
7884 Product ID = 529
Scanner.7878USB
NCR 7878 USB Scanner
Produce ID = 0 (Any Scanner)
7878 Product ID = 528
ScannerNCR7892
NCR 7892 Scanner Serial or NCR USB
ScannerNCR7404
NCR 7404 Kiosk USB Scanner
Scanner2356
NCR 2356-xxxx Serial Scanner Serial
or NCR USB
Scanner2356USB
NCR 2356-xxxx USB Scanner
ScannerOther
Other Scanners
Scale JavaPOS Default Configuration Entries
The following is a sampling of profiles that have been predefined as
JavaPOS default profiles in the file config.xml. This is NOT a complete
list.
Default Configuration
Description
Scale78xx
Scale – Serial or NCR USB
Uses ScannerNCR78xx
profile.nner
ScaleUSB
NCR 78xx USB Scale
78xx Product ID = 512
7878 Product ID = 528
Uses profile is NOT USED and
should be deleted or blank.
Scale.7874
Scale – Serial or NCR USB
Uses 7874 scanner profile
Scale.7874USB
NCR 7874 Scale – USB
Uses Blank.
Defaults set for Pounds.
Metric and 5Digit properties
should be set for Kilograms.
Scale.7878USB
NCR 7878 Scale – USB
Uses Blank.
Defaults set for Pounds.
Metric and 5Digit properties
should be set for Kilograms.
Serial Default values based on Model setting:
Model
Baud
Parit
y
Byte
Size
Stop
Bits
Prefix
Suffix
CTS
*
DSR *
DTR *
RTS *
7832
9600
None
8
2
None
0x0D
--
--
--
--
7837
9600
Even
7
1
None
0x0D
--
--
--
--
78371300
38400
None
8
1
Label ID
0x0D
--
--
--
--
78373000
7838,
3800,
4600,
5600,
5620/
3820
7838-SS
38400
None
8
1
Label ID
0x0D
--
--
--
--
38400
None
8
1
Label ID
0x0D
--
--
--
--
115200
None
8
1
Label ID
0x0D
7872/4
9600
Odd
7
1
None
0x03
On
On
--
--
7875
9600
Odd
7
1
None
0x03
On
On
--
--
--
--
7876/8
9600
Odd
7
1
None
0x03
On
On
7880
9600
Odd
7
1
None
0x03
--
--
7882
9600
Odd
7
1
None
0x03
--
--
7883/4
9600
Odd
7
1
None
0x03
On
On
7892
9600
Odd
7
1
None
0x03
--
--
--
--
2356
9600
None
8
1
None
0x0D
**
--
--
--
Other
9600
None
8
1
None
None
Off
Off
On
On

*Signifies that these parameter are not configurable. These settings
are provided for informational purposes only, and this information
is targeted for those individuals using the "other" model setting.

** Optionally controlled by the service object to enable/disable
scanning when the scanner configuration enables this feature.
Scanner Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the Scanner is controlled through settings stored in the
NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the Scanner
components.
[NCROposSO.Scanner]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRScanner]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRScannerHydra]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
Scanner Frequently Asked Questions
Scanner Software and Manuals
[Link for NCR UPOS updates via Retail Platform Software for Windows
installs and patches]:
http://www5.ncr.com/support/support_drivers_patches.asp?Class=E
xternal/SelfServPlatformSoftware\display
[Link for Scanner Manuals]:
http://www.info.ncr.com/Point-Of-Sale/Browse-Search/eRetailBrowseBy.cfm?pl=&PID=&title=&release=&pl=Retail%20%20Scanners
[Link for Scanner firmware updates]:
http://www5.ncr.com/support/support_drivers_patches.asp?Class=r
etail_RealScan
Scanner setup suggestions for NCR UPOS

NCR 78xx Scanner Configuration for USB Serial Emulation mode
USB Serial Emulation mode scanner configuration must use “SERIAL
or NCR USB” connection type with NCR UPOS. NCR USB uses a
serial emulation driver installed when the scanner is first connected to
the terminal. This driver creates a virtual COM port to be used just like
serial scanner communication.
[Scanner Configuration for USB Serial Emulation Mode ]:
To set USB Serial Emulation Mode in the scanner configuration, use
NCR Scanner programming tags to perform the following: Program
Mode (PM) followed by the hex digits shown and followed by Save
and Reset (S&R).
PM 1 0 E 0 S&R

NCR 78xx Scanner Configuration for USB Mode
NCR USB scanner configuration must use “USB” connection type with
NCR UPOS. “USB” connection type uses the operating system USB
drivers for a HID USB device.
Only Release 2 (SA) or later scanners and scanner/scales support HID
USB connection type to NCR UPOS. SA scanners and scales all have
the same HID USB product ID (0x200).
Only PXA or later scanner and scales support HID USB with unique
USB product IDs.
No Release 1 scanners support HID USB.
[Scanner Configuration Program Sequences for USB]:
The scanner must be configured to use IBM USB as the communications
setting. Program Mode (PM) followed by the hex digits shown and followed by
Save and Reset (S&R).
PM 1 0 D S&R
The default data format for IBM USB is BCD. NCR UPOS will correctly handle
either BCD or ASCII data format. The scanner can optionally be configured to
use HID USB ASCII data format by using the following programming
sequence.
PM 3 2 F S&R
[Scanner Not On File for USB]:
The scanner must be configured to use IBM USB as the communications
setting. Not On File is UPOS directIO command 508. Sending the NOF to
the scanner causes 3 error beeps and disables the scanner.
[Scanner Configuration Bytes]:
The Scanner Configuration bytes can be set in the scanner profile “Config”
entry. Not all configuration combination are supported. See the scanner
documentation for NCR specific restrictions.

NCR 2356 Scanners
NCR product number 2356 –xxxx handheld scanner Product Guide link is
given below for information on configuring the scanner to match the UPOS
profile settings created using RSM.
[Serial RS-232]:
Below are suggested scanner configuration changes to work with NCR UPOS.
The UPOS scanner profile settings should match the scanner configuration.
[Serial scanner input only]:
NCR UPOS supports NCR 2356 serial scanners as input only, no command
support. Scan the configuration barcode on page 2-9 to select RS-232
terminal interface. This also adds a CR-LF suffix. You must match the suffix
with the UPOS profile settings. The default UPOS profile provided by NCR
has a CR (0x0D) as the suffix. To set the suffix to CR only see the note below
under Suffix.
[Suffix]:
To add a carriage return suffix (0x0D):
5-14 Symbol LS4278 Product Reference Guide
If a carriage return/enter is required after each scanned bar code, scan the
following bar codes in order:
1. Scan Options
2. <DATA> <SUFFIX>
3. Enter (on page 5-15).
Any suffix can be appended to scan data for use in data editing.
To set a value for a suffix:
1. Change the scan data format by scanning the appropriate Scan Data
Transmission Format on page 5-14. - Scan Options, <DATA> <SUFFIX>
2. Scan the appropriate suffix bar code on page 5-14. - Scan Suffix
3. Scan a four-digit number (i.e., four bar codes from Appendix D, Numeric
Bar Codes) that corresponds to that value. - Example: 1013 (Carriage
return/Enter)
F-2 Symbol LS4278 Product Reference Guide Table F-1. ASCII Value
Standard Default Parameters Table Ascii value = 1013 for the Enter (Carriage
Return) character.
[Prefix]:
The default UPOS profile has a prefix of none. The scanner default is none.
[Barcode Symbology ID]:
NCR UPOS will provide barcode decoding of the scan data type of the
scanner for either AIM IDs or Code ID symbology IDs when the UPOS
property DecodeData is set TRUE.
To configure the scanner to send a Symbology ID with the barcode:
1. scan the AIM ID barcode at User Preferences 5-13. - AIM Code ID Character
[PDF417 Barcodes] :
PDF417 barcodes are supported by the scanner and NCR UPOS. There
could be suffix configuration issues depending on whether non-printable
characters appear in the PDF417 tag. If non-printable characters are present,
configuration of the scanner suffix must not match any of the character
combinations. NCR UPOS does support 2 character suffix combinations.
[Serial using RTS signal as scanner enable/disable control]:
Serial communications with the scanner is limited to input data only. To allow
control of the scanning, NCR UPOS supports using serial signal lines to
enable and disable the scanner for scanning.
Set RSM profile parameter “CTSControl..” to “Enabled”
The actual profile parameter “RTSEnable” value shall be either 0 (Disabled)
or 1(Enabled).
Configure scanner using RTS/CTS Option 2. When Option 2 is selected, RTS
is always high or low (user-programmed logic level). However, the scanner
waits for CTS to be asserted before transmitting data. If CTS is not asserted
within Host Serial Response Time-out (default), the scanner issues an error
indication and discards the data.
Select AIM symbology ID prefix
Set data format to <Prefix><Data><Suffix>
Configure scanner for a suffix to match the UPOS profile. Default is usually a
carriage return (0x0D) or carriage return, line feed (0x0D 0x0A). To Set
Carriage Return(0x0D) Suffix. Scan the “Suffix” barcode and ASCII number
value = 1013 plus “Save”.
[USB Serial Emulation Driver]:
To connect the scanner via USB, a virtual COM port driver must be installed.
This driver allows the scanner to communicate via USB but provides a virtual
serial COM port for NCR UPOS to connect internally to the USB port. The
links below are for downloading the required driver.
To configure the scanner for USB via serial emulation driver, , scan the
“Simple COM Port Emulation” barcode. Install the “Simple COM Port
Emulation” driver. See the link below. Use Windows Device Manager to
view the “Human Interface Devices” key. Set the UPOS profile port name to
the virtual COM port created under the key for “Communication Virtual
Port(Port n)”.
No sufifix can be used. The scanner cannot be configured for a suffix. Match
the UPOS profile using a “None” suffix selection.
[NCR 2356 configuration for USB Mode]:
NCR USB scanner configuration must use “USB” connection type with
NCR UPOS. “USB” connection type uses the operating system USB
drivers for a HID USB device.
Scanner Configuration Program Sequences for USB:
-
Scan the IBM Hand Held barcodes. No additional driver is
need for this USB connection.
No sufifix is used with USB.
[Scanner USB Configuration Bytes]:
The Scanner Configuration bytes can be set in the scanner profile “Config”
entry. Not all configuration combination are supported. See the scanner
documentation for NCR 2356 specific restrictions.
[Link for User’s Guide]
http://www.info.ncr.com/Point-Of-Sale/Browse-Search/eRetailBrowseBy.cfm?pl=&PID=&title=&release=&pl=Retail%20-%20Scanners
[Link for the NCR 2356 USB Serial Emulation driver]
Click on the link below and locate the link to download the Simple COM Port
Emulation driver.
http://www5.ncr.com/support/support_drivers_patches.asp?Class=External/Pe
ripherals/Scanner/2356/display_Symbol

NCR 7409 Integrated 4980 Scanner
The NCR 7409 Integrated Scanner is a Honeywell MS4980 USB scanner.
Use RSM to create a new scanner profile with the following properties:
- Service = NCROposSO.Scanner
- Model Layer = NCR78xxScannerScale
- Model = 4980 or Self Service 4980
- Vendor ID = 3118 (0x0C2E)
- Product ID = 9
- DevUsagePage = 65349 (0xFF45)
- DevUsage = 19200 (0x4B00)
See the NCR 7409 Implementation Guide or the Scanner Configuration Guide
for the configuration barcodes.
To work with NCR UPOS, configure the scanner interface for IBM OEM
Handheld Scanner (0x4B00).
NOTE:: To scan configuration barcodes you MUST press the button on
the scanner.
Windows GUI Tool: MetroSet2.exe is a Windows application for creating
configuration barcodes and flashing.
Windows Remote Flashing Tool: AutoSet3.exe is a Windows command
line application for remote flashing.
To configure the 4980 scanner:
1. Scan barcode 999970 (Load integrated full speed USB IBM/OEM
defaults).
2. Scan barcode 127917 (Enable Idle Mode Illumination)
3. Scan barcode 4279150 (Max Idle Mode Illumination Power)
OR
1.
2.
3.
4.
5.
Scan barcode 316430 (IBM OEM scanner 0x4B00 HandHeld)
Scan barcode 116603 (Disable Carriage Return suffix)
Scan barcode 116602 (Disable LF suffix)
Scan barcode 127917 (Enable Idle Mode Illumination)
Scan barcode 4279150 (Max Idle Mode Illumination Power)
EasyID Driver License Sample Configuration:
EasyID is a firmware plug-in for the MS4980 scanner that can decode driver
license PDF 417 barcodes and return the license fields in a preset format.
To configure EasyID and the data format use either the EasyID Software
Manual or the Metroset2 application.
Sample Configuration:
John,Doe,90 Coles Rd,Blackwood,NJ,08012,01/01/1968
1. Scan barcode 990201 (Enable EasyID).
2. Scan barcode 990214 (Start Standard Configuration)
3. Scan barcode 99022f12 (First Name)
4. Scan barcode 99022f14 (Last Name)
5. Scan barcode 99022f71 (Street)
6. Scan barcode 99022f74 (City)
7. Scan barcode 99022f75 (State)
8. Scan barcode 99022f76 (Postal)
9. Scan barcode 99022f18 (Date of Birth)
10. Scan barcode 99022s, (Comma)
11. Scan barcode 99022d0 (MM/DD/YYYY)
12. Scan barcode 990215 (End Configuration)
Additional scanner configuration changes may be required for kiosk
applications. For example, driver’s license solutions may require firmware and
configuration changes.

NCR 7404 EP Advantage Integrated Scanner
The NCR 7404 EP Advantage Scanner is a Symbol MS3207 USB scanner.
Use RSM to create a new scanner profile with the following properties:
- Service = NCROposSO.Scanner
- Model Layer = NCR78xxScannerScale
-
Model = NCR 2356 or NCR Omni Directional
The link to the NCR 7404 Implementation Guide is shown below. Page 9-4
contains the programming barcodes to configure the scanner for IBM Table
HandHeld.
This is the only scanner configuration change required to work with NCR
UPOS.
From the MS3207 guide page 9-4:
USB Device Type
Select the desired USB device type.
Note:When changing USB Device Types, the scanner automatically
restarts and issues the standard startup beep sequences.
- IBM HandHeld USB
(Use with NCR OPOS)
7404 Scanner Implementation Guide
Look for the Symbol MS3207 section 9-4.

7837-3000 and 7838 Scanner setup for UPOS
The 7838 User's Guide is missing the second page of the Programming Chart
(TAR 295385). The programming chart is needed for program sequences in
setting the scanner. The 7837 User's Guide has the programming charts.
[Suffix]:
The default UPOS profile has suffix set to CR (0x0D) for all communication
with the scanner. To set the scanner to this suffix see page 4-3 of the User's
Guide.
[Prefix]:
The default UPOS profile has a prefix of none. The scanner default is none.
[Barcode Symbology ID]:
NCR UPOS will provide barcode decoding of the scan data type of the
scanner Code ID symbology IDs when the UPOS property DecodeData is set
TRUE.
The scanner User's Guide Page 4-3 starts the description.
To program for use with UPOS DecodeData property = TRUE:
1. Scan Clear All Prefixes barcode
2. Scan Add Prefix, scan the character barcode in appendix for the
following "995C80", Save.
To program for use with UPOS DecodeData property = FALSE and set for
NCR symbology ID:
1. Scan Clear All Prefixes barcode
2. Scan Add Prefix, follow the instructions for adding a specific prefix
to a specific symbology, Save.
[PDF417 Barcodes]:
PDF417 barcodes are supported by the scanner and NCR UPOS. There
could be suffix configuration issues depending on whether non-printable
characters appear in the PDF417 tag. If non-printable characters are present,
configuration of the scanner suffix must not match any of the character
combinations. NCR UPOS does support 2 character suffix combinations.
[RS-232]:
Scan the configuration barcode on page 2-9 to select RS-232 terminal
interface. This also adds a CR-LF suffix. You must match the suffix with the
UPOS profile settings. The default UPOS profile provided by NCR has a CR
(0x0D) as the suffix. To set the suffix to CR only see the note above.
[NCR USB]:
To connect the scanner via USB, a virtual COM port driver must be installed.
This driver allows the scanner to commuicate via USB but provides a virtual
serial COM port for NCR UPOS to connect internally to the USB port. The
links below are for downloading the required driver.
To configure the scanner scan the configuration barcode at the top of page 111 of the scanner User's Guide for "USB COM Port Emulation". When you
plug in the scanner to the USB port, the OS will request a driver for the device.
Point the OS to the location of the USB COM port emulation driver INF file to
have the OS install the driver. When the install is finished a COM port will
have been added to the terminal devices. Update the NCR UPOS profile to
this COM port.
http://www.ncr.com/en/support/support_drivers_patches.asp
Example driver file 35354004.zip, 05/17/2004, 100 KB (USB Serial Emulator
Driver for Win98 1.10.000, Win 2000 & XP 1.10.003)

Money Center Integrated Self Service Scanner
The Integrated Self Service Scanner 497-0438286 appears in RSM as
NCR 7838 Self Service scanner.

7401/7402 Kiosk Integrated Scanner
The Kiosk Integrated Scanner model in RSM should be model NCR
7892.

NCR 2357-xxxx( 3800, 4600, 5600 and 5620) Scanners
The User's Guide for these models can be found on the NCR website using
the NCR 2357 model number. The User's Guide has the programming charts
needed for changing scanner setup as noted below.
NCR 2357 – 1000 3800 scanner
NCR 2357 – 1300 5600 scanner
NCR 2357 – 2000 4600 scanner
NCR 2357 – 3000 5620 scanner
[Serial scanner input only]:
NCR UPOS supports NCR 2357 serial scanners as input only, no command
support. Scan the configuration barcode on page 2-9 to select RS-232
terminal interface. This also adds a CR-LF suffix. You must match the suffix
with the UPOS profile settings. The default UPOS profile provided by NCR
has a CR (0x0D) as the suffix. To set the suffix to CR only see the note below
under Suffix.
[Suffix]:
The default UPOS profile has suffix set to CR (0x0D) for all communication
with the scanner. To set the scanner to this suffix see page 4-3 of the User's
Guide.
[Prefix]:
The default UPOS profile has a prefix of none. The scanner default is none.
[Barcode Symbology ID]:
NCR UPOS will provide barcode decoding of the scan data type of the
scanner for either AIM IDs or Code ID symbology IDs when the UPOS
property DecodeData is set TRUE.
The scanner User's Guide Page 4-3 starts the description.
To program for use with UPOS DecodeData property = TRUE:
1. Scan Clear All Prefixes barcode
2. Scan Add Prefix, scan the character barcode in appendix for the
following "995C80", Save.
To program for use with UPOS DecodeData property = FALSE and set for
NCR symbology ID:
1. Scan Clear All Prefixes barcode
2. Scan Add Prefix, follow the instructions for adding a specific prefix
to a specific symbology, Save.
[PDF417 Barcodes] :
PDF417 barcodes are supported by the scanner and NCR UPOS. There
could be suffix configuration issues depending on whether non-printable
characters appear in the PDF417 tag. If non-printable characters are present,
configuration of the scanner suffix must not match any of the character
combinations. NCR UPOS does support 2 character suffix combinations.
[Serial using RTS signal as scanner enable/disable control]:
Serial communications with the scanner is limited to input data only. To allow
control of the scanning, NCR UPOS supports using serial signal lines to
enable and disable the scanner for scanning. Configure the scanner with
"Matrix RTS/CTS Mode 3 Enable" barcode.
Set RSM profile parameter “CTSControl..” to “Enabled”
The actual profile parameter “RTSEnable” value shall be either 0 (Disabled)
or 1(Enabled).
[USB Serial Emulation Driver]:
To connect the scanner via USB, a virtual COM port driver must be installed.
This driver allows the scanner to communicate via USB but provides a virtual
serial COM port for NCR UPOS to connect internally to the USB port. The
links below are for downloading the required driver.
To configure the scanner scan the configuration barcode in the middle of page
1-3 of the scanner User's Guide for "USB COM Port Emulation". When you
plug in the scanner to the USB port, the OS will request a driver for the device.
Point the OS to the location of the USB COM port emulation driver INF file to
have the OS install the driver. When the install is finished a COM port will
have been added to the terminal devices. Update the NCR UPOS profile to
this COM port.
Link for User’s Guide:
http://www.info.ncr.com/Point-Of-Sale/Browse-Search/eRetailBrowseBy.cfm?pl=&PID=&title=&release=&pl=Retail%20-%20Scanners
Link for the USB Serial Emulation driver:
http://www5.ncr.com/support/support_drivers_patches.asp?Class=External/Pe
ripherals/Scanner/7838/display_HHP
ToneIndicator
The Tone Indicator supports the following devices:

NCR 5932 USB Keyboard

NCR 5953 USB Dynakey

NCR 5954 USB Dynakey
DirectIO – Set Keyclick Tone
Sets the tone played each time a key is pressed on the keyboard. This
command is always handled synchronously.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter Description
command
NCRDIO_SET_KEYCLICK_TONE
data[0]
Not used
object
A comma separated string giving the
pitch, duration, and volume of the
keyclick tone, in that order.
The pitch value must be 0 (silent) or a
value between 28 and 42192 hz.
The duration value must be between 0
and 1024 ms.
Volume is expressed as a percentage of
maximum volume, with 0 being silent
and 100 being maximum volume.
Use the string “0,0,0” to disable keyclicks.
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception's ErrorCode property are:
JPOS_E_ILLEGAL - The pitch, duration, or volume was missing
from the string
ToneIndicator - Tone Indicator Configuration Entries
Parameters
Description
Valid Values
Profile Name
The name of a specific configuration.
NCRToneIndicator.0 (Any name you
wish)
Programmatic ID
This is the Service Object name for the
Scale
NCROposSO.ToneIndicator
NCR Model Layer
NCRIOChannelToneIndicator
Connection Type
Indicates the means by which the Tone
Indicator is connected to the terminal
USB
Product
The Product on which the USB Tone
Indicator resides
Any HID USB Tone Indicator
5932-50xx USB Keyboard
5932-52xx USB Keyboard
5953-6xxx/80xx USB Dynakey
5953-85xx/86xx USB Dynakey
5954 USB Dynakey
Parameters
Description
Valid Values
Vendor
The manufacturer of the Tone Indicator
device
NCR, Any Vendor
Inter-Tone Wait
The number of milliseconds between
tones 1 and 2.
0 - 60,000 ms
Duration of Tone 1
The duration of the first tone in
milliseconds
0 - 1024 ms
Pitch of Tone 1
The pitch of the first tone in Hertz.
0 = Silent, 28 - 42192 hz
Volume of Tone 1
The volume of the first tone as a percent
of the maximum tone.
Percent of full volume
Duration of Tone 2
The duration of the second tone in
milliseconds
0 - 1024 ms
Pitch of Tone 2
The pitch of the second tone in Hertz.
0 = Silent, 28 - 42192 hz
Volume of Tone 2
The volume of the second tone as a
percent of the maximum tone.
Percent of full volume
Device Usage Page
USB Configuration - Indicates the usage
page for this Tone Indicator device.
0xFF8F (Read-Only)
Device Usage
USB Configuration -Indicates the usage
for this Tone Indicator device.
2 (Read-Only)
Number of Reports
USB Configuration - Indicates the
number of reports for the Tone Indicator
device.
2 (Read-Only)
Tone Indicator Data Capture Configuration Entries
Refer to the Data Capture section in this document for details on
changing the Data Capture settings using the RSM user interface. This
is the recommended way to change the Data Capture settings. Data
capture for the Tone Indicator is controlled through settings stored in
the NCRDatacap.conf configuration file. The following example shows
how to enable maximum data capture for all of the Tone Indicator
components.
[NCROposSO.ToneIndicator]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault = F
[NCRIOChannelToneIndicatorModel]
LevelMask = 0xFFFFFFFF
TraceMask = 0xFFFFFFFF
UseDefault =
Download PDF