NCR Retail Controls 3.x User`s Guide for Linux

NCR Retail Controls 3.x User`s Guide for Linux
NCR
Retail Controls 3.x
User’s Guide for Linux
B005-0000-1489
Issue F
The product described in this book is a licensed product of NCR Corporation.
NCR is a registered trademark of NCR Corporation.
NCR RealPOS, NCR 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 Products
NCR Corporation
2651 Satellite Blvd.
Duluth, GA 30096
Copyright © 2007
By NCR Corporation
Dayton, Ohio 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
Retail Controls User’s Guide
References
•
NCR FitClient Software User’s Guide
(B005-0000-1235)
•
Linux Software User’s Guide
(B005-0000-1432)
Retail Controls User’s Guide
Table of Contents
Retail Controls for Linux
Additional Software Requirements ................................. 4
NCR 5932 USB keyboard: ........................................... 4
NCR 5932 Wedge keyboard: ...................................... 4
NCR 788x and NCR 7892 Scanners, NCR 787x
Scanner/Scales with USB connection ....................... 4
Using FitClient Manager LE for Linux ............................ 6
Using Serial Ports ............................................................... 7
Default values in the Configuration Entries tables........ 7
Cash Drawer........................................................................ 8
Cash Drawer Configuration Entries.......................... 8
Printer CashDrawer Configuration Entries ........... 10
Terminal CashDrawer Configuration Entries........ 12
Terminal CashDrawer Data Capture
Configuration Entries ................................................ 13
Hard Totals........................................................................ 15
Hard Totals Configuration Entries.......................... 15
Keylock .............................................................................. 17
Keylock Configuration Entries................................. 17
Line Display ...................................................................... 19
Line Display Configuration Entries – NCR 5972
VFD and LCD ............................................................. 19
Line Display Configuration Entries – NCR 5973... 21
Line Display Configuration Entries – NCR
5975-1xxx 2x20............................................................ 22
Line Display Configuration Entries – NCR
5975-2xxx Graphical .................................................. 23
3
4
Retail Controls User’s Guide
Line Display Configuration Entries – NCR 7402
2x20 .............................................................................. 25
Line Display Configuration Entries – NCR 7402
APA.............................................................................. 26
Line Display Configuration Entries – NCR 744x
2x20 .............................................................................. 27
MICR .................................................................................. 29
DirectIO – MICR Parsing .......................................... 29
DirectIO - Set Remove Non Digits........................... 35
Clear Exception Table................................................ 36
MICR - Magnetic Ink Character Recognition
Configuration Entries ................................................ 37
Motion Sensor ................................................................... 39
Motion Sensor Configuration Entries ..................... 39
MSR .................................................................................... 40
MSR - Magnetic Stripe Reader Configuration
Entries .......................................................................... 40
POS Printer ........................................................................ 42
DirectIO - Raw Output.............................................. 43
DirectIO - Set Barcode Width ................................... 45
DirectIO - Set Bitmap Type....................................... 46
DirectIO - Sound Audible Tone ............................... 47
DirectIO - Set Minimum Number of Characters
Per Line........................................................................ 48
DirectIO - Get the Current Printer Status ............... 49
DirectIO – Get Kiosk Specific Sensor Status........... 51
DirectIO – Set Autoeject Timeout ............................ 52
DirectIO – Eject Receipt............................................. 53
DirectIO – Get Kiosk Specific Status ....................... 54
DirectIO – Change Paper Low Reporting............... 55
DirectIO – Set Black Mark Configuration............... 56
DirectIO – Set Minimum Receipt Length ............... 57
Retail Controls User’s Guide
DirectIO – Set Receipt Retain Length...................... 59
Updated Methods ...................................................... 61
CutPaper Method .................................................. 61
PrintBarCode Method ........................................... 62
PrintBitmap Method ............................................. 64
PrintImmediate Method ....................................... 66
PrintNormal Method............................................. 68
PrintTwoNormal Method..................................... 69
RotatePrint Method ............................................... 71
TransactionPrint Method...................................... 72
POS Printer Configuration Entries .......................... 73
Common Configuration Entries .............................. 73
NCR 71xx Specific Configuration Entries............... 77
Kiosk Specific Configuration Entries ...................... 77
H6000 Specific Configuration Entries ..................... 80
Two-Sided Thermal Printing.................................... 81
Escape Sequences to Control the Two-Sided
Functionality within a Mode................................ 82
Special Escape Sequences to Switch between
Modes ...................................................................... 85
Select Print Side Sequence .................................... 87
OPOS / JavaPOS Mode Functional Definition.. 87
Two Sided Thermal Specific Configuration
Entries .......................................................................... 89
Scale .................................................................................... 94
DirectIO - Scale Status ............................................... 94
DirectIO - Scale Read ROM ...................................... 95
DirectIO - Scale ROM Version.................................. 96
DirectIO - Scale Live Weight .................................... 97
DirectIO - Scale Direct Access .................................. 98
Method Updates......................................................... 99
5
6
Retail Controls User’s Guide
ReadWeight Method Updated in UPOS
Release 1.9............................................................. 99
ZeroScale Method Updated in UPOS
Release 1.9........................................................... 100
Scale Configuration Entries .................................... 102
Scale Data Capture Configuration Entries ........... 103
Scanner............................................................................. 105
DirectIO - Scanner NOT-ON-FILE ........................ 105
DirectIO - Scanner Tone Control ........................... 106
DirectIO - Scanner Reset ......................................... 107
DirectIO - Scanner Status ........................................ 108
DirectIO - Scanner Read ROM ............................... 109
DirectIO - Scanner ROM Version .......................... 110
DirectIO - Scanner Pacesetter Options.................. 111
DirectIO - Scanner Direct Access ........................... 112
Scanner Default Profiles.......................................... 113
Scanner Configuration Entries ............................... 114
Scanner Data Capture Configuration Entries ...... 122
Scanner Frequently Asked Questions ................... 123
7837-3000 and 7838 Scanner setup for UPOS... 123
Money Center Integrated Self Service
Scanner .................................................................. 124
7401/7402 Kiosk Integrated Scanner ................ 124
HID USB Scanner Configuration....................... 125
NCR 2357-xxxx( 3800, 4600, 5600 and 5620)
Scanner setup for UPOS ..................................... 129
NCR 7404 EP Advantage Scanner setup for
UPOS ..................................................................... 130
NCR 2356 Scanner setup for NCR UPOS ......... 131
Tone Indicator ................................................................. 133
DirectIO – Set Keyclick Tone.................................. 133
DirectIO – Set Error Tone........................................ 134
Retail Controls User’s Guide
Tone Indicator Configuration Entries ................... 135
7
8
Retail Controls User’s Guide
Revision Record
Issue
Date
Remarks
A
Feb 2003
First issue
B
Sept 2003 Update Scanner and Scale Configuration
C
Apr 2005
Miscellaneous minor changes
D
Oct 2006
Updates from RC 3.2 to RC 3.8
E
Apr 2007
Update Scanner for 7404 EP Advantage Scanner
and 2356 scanners profile settings and FAQ on
scanner configuration.
Printer TST updates.
F
Aug 2007 Update Scanner for NCR 2356 handheld scanners.
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
Retail Controls for Linux
The following table shows the devices that are supported for this
version of the Retail Controls for Linux.
UPOS Control
NCR Support
Devices Supported
Component ID
Bump Bar
NO
Cash Changer
NO
Terminal Cash Drawer
YES
NCR 7453, 7456, 7457,
7458, 7402, 7443,
7443-21xx, 7446, 7449
Terminals
NCRCashDrawerProcessor
Cash Drawer
YES
NCR 7156, 7158, 7167,
7168, 7194, 7197, 7198
Printers
NCR71xxPrinterCDMICR
CAT - Credit Authorization Term
NO
Check Scanner
NO
Coin Dispenser
NO
Fiscal Printer
NO
Hard Totals
YES
Disk Based Media
NCRHardTotals
Keylock
YES
NCR 5932 Wedge or
USB Keyboard, NCR
5953 Wedge or USB
Dynakey, NCR 5954
USB Dynakey
NCRIOChannelKeylockM
odel
Line Display
YES
NCR 5972 VFD, NCR
5972 LCD, NCR 5972
Occular LCD. Serial
only for all models.
NCR5972LineDisplay
NCR 5973 VFD (Serial
only).
NCR5973LineDisplay
NCR 5975-1xxx, Serial
and USB.
NCR59752x20LineDisplay
NCR 5975-2xxx, Serial
NCR5975IntLineDisp
and USB.
MICR
YES
NCR 7402 2x20
NCR7402LineDisplay2x20
NCR 7402 APA
NCR7402LineDisplayAPA
NCR 7443 2x20, NCR
7446 2x20
NCR744xLineDisplay2x20
Connected to Printer
NCR71xxPrinterCDMICR,
NCRH6xxPrinterHydraMo
del
Motion Sensor
YES
Motion Sensor
YES
MSR
YES
PIN Pad
NO
Point Card Reader Writer
NO
POS Keyboard
NO
POS Power
NO
POS Printer
YES
NCR 7402 Integrated
Motion Sensor
NCRAgentMotionSesnorM
odel
NCR 5932 Wedge or
USB Keyboard, NCR
5953 Wedge or USB
Dynakey, NCR 5954
USB Dynakey
NCRIOChannelMSRModel
NCR 7156, 7158, 7167,
7168, 7194, 7197, 7198,
K580, K590, 7342F306 Printers
NCR71xxPrinterCDMICR,
H6000, H6000II
Printers
NCRK5xxPrinterHydraMo
del,
NCRH6xxxPrinterHydraM
odel
Remote Order Display
NO
Scale
YES
NCR 7872/75/76/83
(Serial, USB)
NCR78xxScannerScale
Scanner
YES
NCR 7880/2 (Serial)
NCR 7883, NCR 7892,
NCR 7872/75/76/78
(Serial, NCR USB,
USB)
NCR78xxScannerScale
Note1: USB – OS supported USB
Note2: Wedge – Wedge support
by connection to a NCR keyboard
or Dynakey. The scanner
interface type is serial.
See Scanner Frequently Asked
Questions (FAQ) section for
scanner configuration settings.
NCR 7837, NCR 7837xxxx, NCR 7838, NCR
2357 (USB, Serial,
NCR USB, Wedge),
NCR 2356 (USB,
Serial, NCR USB,
Wedge)
Signature Capture
NO
Tone Indicator
YES
NCR 5932 Wedge or
USB Keyboard, NCR
5953 Wedge or USB
Dynakey, NCR 5954
USB Dynakey
NCRIOChannelToneIndica
tor
NCR uses standard JavaPOS 1.9 Device Controls as provided by the
JavaPOS committee (they are open source). 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/, then select UnifiedPOS from the
frame on the left.
Additional information on JavaPOS can be obtained from:
http://www.javapos.com and/or
http://www.javapos.com/samplecode.html
This document only describes the NCR-specific differences from the
UPOS 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
The JavaPOS stack is not sufficient to operate the USB keyboard,
Wedge Keyboard, or a USB configuration for the Scanner/Scale.
Kernel patches and/or loadable modules are also needed. A
description of the required modifications for each device is enumerated
below.
NCR 5932 USB keyboard:
A kernel patch, is required. The patch (NCRHID_2_4_18.patch) is
available on the Retail Platform Software for Linux LPIN D370-0549-0000.
NCR 5932 Wedge keyboard:
A kernel patch, is required. The patch (NCRKBStream_2_4_18.patch) is
available on the Retail Platform Software for Linux LPIN D370-0549-0000.
For Red Hat Linux 7.3 users, a bash script has been provided to ensure
the wedge stack is installed correctly. This script is called NCRRetail
and is also available on the Retail Platform Software for Linux LPIN
D370-0549-0000.
NCR 788x and NCR 7892 Scanners, NCR 787x Scanner/Scales
with USB connection
The following loadable modules must be available on the system:
•
usbserial.o
•
io_edgeport.o
•
io_epic.o - See the Third Party LPIN for more information.
•
Usbcore
•
usb-uhci
All but io_epic.o are freely available and downloadable from
kernel.org.
These modules must be loaded. This can be performed dynamically
from the command line as follows:
insmod usbcore <Enter> (may need)
insmod usb-uhci <Enter> (may need)
insmod usbserial.o <Enter>
insmod io_edgeport.o <Enter>
insmod io_epic.o <Enter>
Refer to the NCR Scanner documentation for information on how to
configure these scanners and scanner/scales to communicate with your
platform via USB.
You need to configure the Scanner/Scale into NCR USB/RS-232 for use
with the JavaPOS services and the io_epic.o driver. This is mentioned
because our Scanner/Scales also support IBM USB, neither of which
are native USB.
Using FitClient Manager LE for Linux
The FitClient Manager LE permits you to control power-up
functionality and reports some of the system parameters.
Before you can start the FitClient Manager LE for Linux, you must start
the NCRLoader service as follows:
/usr/local/NCRRetail/bin
./NCRLoader &
Run FitClient Manager in a terminal session or a terminal emulator
window using the following if the FitClient Manager is installed in the
default directory.
/usr/local/NCRRetail/FitClientLE ./NCRFitClientLE.sh
The initial screen appears as follows:
Refer to the NCR FitClient Software User’s Guide (B005-0000-1235) for
additional information on using FitClient Manager LE.
Using Serial Ports
In FitClient, COMX is used to describe serial port X. In Linux, the
serial port naming convention is /dev/ttySY, where Y is a variable
whose value is equal to X-1. For example, COM6 is equivalent to
/dev/ttyS5.
Default values in the Configuration Entries tables
Configuration default values in the Configuration Entry tables only
apply to new controls that you create. When the FitClient Manager LE
Configuration screens are populated, they are set to default
configurations for the particular device. The values of the parameters
in these default configurations may not contain the default values for
the specific parameter.
Cash Drawer
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
The CashDrawer supports 1 or 2 cash drawers connected to the
cashdrawer port of the following terminals:
•
NCR 7453-3xxx
•
NCR 7456
•
NCR 7457
•
NCR 7458
•
NCR 7459
•
NCR 7402
•
NCR 7404
•
NCR 7443
•
NCR 7446
•
NCR 7449
Cash Drawer Configuration Entries
Printer CashDrawer Configuration Entries
Parameter
Description
Valid Values
API Interface
The interface being used, Currently, JavaPOS
is the only valid option.
JavaPOS
Logical Name
The name of a specific configuration.
A configuration name such as
CashDrawer7167,
CashDrawer7167_2 -2, or
CashDrawer7197 -1
Model Class
The cash drawer(s) are connected to a printer.
Therefore, the printer must also be available.
This is the Device Service for the printer.
NCR71xxPrinterCDMICR
Uses
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.
Printer7167
Printer7197
Cash Drawer
Number
Number of the cash drawer to be controlled.
Drawer 1 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:
0 - Report Drawer 1 Only
0 - 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.
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
1 - Report Last Drawer Opened
2 - Report Each Drawer
3 - Don’t Report Statuses
(Default is 1 - Report Last Drawer
Opened
Parameter
Description
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.
Valid Values
2 - 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.
3 - Don’t Report Statuses = 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.
The following configurations have been predefined:
Default Configuration
Description
CashDrawer7167
1 CashDrawer connected to the NCR 7167
printer
CashDrawer7167_2
2 CashDrawers connected to the NCR 7167
printer
CashDrawer7197
CashDrawer connected to the NCR 7197
printer
Terminal CashDrawer Configuration Entries
The config.xml file installed by RPSL contains default Terminal
Cashdrawer profiles named “CashDrawer_1 “ and “CashDrawer_2 “.
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)
com.ncr.retail.jpos.services.cashdra
wer.CashDrawerService
NCR Model Layer
The cash drawer(s) are connected to the
terminal.
ConnectionType
Type of cashdrawer interface to be used.
NCRCashDrawerProcessor
M (default)
Model
Type of cashdrawer.
7443
744321xx
7446
7449
7404
INTEGRATED(default)
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.
POSPrinter\NCRPOSPrinter.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
M – Motherboard (integrated).
Specific terminal model is needed if the
motherboard is not self identifying.
YCableStatus
Report Drawer 1 Only. Backwards
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
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.
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
7both 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.
Terminal CashDrawer Data Capture Configuration Entries
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
API Interface
The interface that is being used.
JavaPOS
Logical Name
The name of a specific configuration.
HardTotals
Model Class
This is the Device Service name for the Hard Totals
NCRHardTotals
Media Type
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 reside on
"Disk"
any device that supports the standard disk I/O operations,
including a network drive or compact flash.
HardTotals
Area File …
The file name of the totals file. This key has a default
value of /usr/local/NCRRetail/HardTotalsArea. If this
file exists, then the Hard Totals service will check for a
Hard Totals signature. If the signature is present, then
the file has already been set up as a Hard Totals file. If
the signature is not present, then the file is not
initialized as a Hard Totals file and the Hard Totals
service will fail to connect. 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:
/usr/local/NCRRetail/Har
dTotalsArea
HardTotals
Size (FileSize)
The size of the totals file, in kilobytes. The default value
is 16. 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: 16
ClusterSize
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
The following configuration has been predefined:
Default Configuration
Description
HardTotals
A 5kb Hard Totals file stored on the current
drive, in the /usr/local/NCRRetail directory
with the name HardTotalsArea. The file
has a cluster size of 512 bytes.
Keylock
The Keylock Control Object supports the keylock on the NCR 5932
Wedge or USB keyboard or the USB Dynakey.
Keylock Configuration Entries
Parameter
Description
Valid Values
API Interface
The interface that is using this control, Currently,
JavaPOS is the only valid option.
JavaPOS
Logical Name
The name of a specific configuration.
NCRKeylock.5932Wedge
NCRKeylock.5932USB
Model Class
NCRIOChannelKeylockMode
l
Clear After
Read
USB Only - Indicates whether the device memory
should be cleared after a read.
False (Read-Only)
Connection
Type
The interface used to connect the Keylock to the
terminal.
USB
Wedge (default)
Device Type
Wedge Only - The subcomponent on the Wedge bus
to use.
Keylock (Read-Only
Device Usage
USB Only -Indicates the usage for this Keylock
device.
1 (Read-Only)
Device Usage
Page
USB Only - Indicates the usage page for this
Keylock device.
65423 (Read-Only)
Number of
Reports
USB Only - Indicates the number of reports for the
Keylock device.
2 (Read-Only)
Product
USB Only - The name of the device supported.
Any HID USB Keylock
5932-50xx USB Keyboard
5932-52xx USB Keyboard
5953-6xxx/5953-80xx USB
Dynakey
5953-85xx/5953-86xx USB
Dynakey
5954 USB Dynakey
Vendor
USB Only - The manufacturer of the Keylock.
NCR
Any Vendor
The following configuration has been predefined:
Default Configuration
Description
NCRKeylock.5932Wedge
Keylock Interface for the NCR
5932 Wedge Keyboard
NCRKeylock.5932USB
Keylock Interface for the NCR
5932 USB Keyboard
Line Display
The Line Display Control Object supports many NCR Line Display
models.
Line Display Configuration Entries – NCR 5972 VFD and LCD
Parameter
Description
Valid Values
API Interface
The interface that is using being used.
JavaPOS
Logical Name
The name of a specific configuration.
Ncr597xlinedisp
ncr597xlinedisp.lcd
Model Class
NCR5972LineDisplay
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
The Line Display operates using character sets, not
Encoding
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.
Screen Saver Style
The style of screen saver to enable after a
predetermined interval of inactivity.
None (Default)
Blank
Walk
Display Type
Is the attached hardware a VFD or an LCD display.
VFD
LCD
Occular LCD
Default Character
Set
The character set to initialize during initial device
enable.
850 - PC Code Page 850
(Default)
101 - Katakana
866 - Cyrillic
102 - 116, external ROM
character sets
PortName
The COM Port where the line display is attached.
COM1 - COM10
COM1 (Default)
BaudRate
The speed for serial communications.
9600 (Read-Only)
DataBits
The number of data bits per byte.
5 - 8 Bits
8 Bits (Default)
Parity
Parity scheme for serial communications.
None (Default)
Even
Odd
StopBits
The number of stop bits per byte.
1 - 2 Bits
1 Bit (Default)
CTSFlowControl
Clear To Send flow control setting.
Enabled (Default)
Disabled
The following configuration has been predefined.
Default Configuration
Description
Ncr597xlinedisp
NCR 597x Line Display with VFD
Ncr597xlinedisp.lcd
NCR 597x Line Display with LCD
Line Display Configuration Entries – NCR 5973
Parameter
Description
Valid Values
API Interface
The interface that is using being used.
JavaPOS
Logical Name
The name of a specific configuration.
Model Class
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
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
The COM Port where the line display is attached.
COM1 - COM10
COM1 (Default)
BaudRate
The speed for serial communications.
19200 (Read-Only)
DataBits
The number of data bits per byte.
8 Bits (Read-Only)
Parity
Parity scheme for serial communications.
None (Read-Only)
StopBits
The number of stop bits per byte.
1 Bit (Read-Only)
CTSFlowControl
Clear To Send flow control setting.
Enabled (Default)
Disabled
Line Display Configuration Entries – NCR 5975-1xxx 2x20
Parameter
Description
Valid Values
API Interface
The interface that is using being used.
JavaPOS
Logical Name
The name of a specific configuration.
Model Class
Connection Type
NCR59752x20LineDispla
y
Serial or USB.
Serial
USB
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.
Screen Saver Style
The style of screen saver to enable after a
predetermined interval of inactivity.
1 to 10
5 (Default)
None (Default)
Blank
Walk
Default Character
Set
The character set to initialize during initial device
enable.
850 - PC Code Page 850
(Default)
101 - Katakana
866 - Cyrillic
102 - 116, external ROM
character sets
PortName
Serial Only - The COM Port where the line display is
attached.
COM1 - COM10
COM1 (Default)
BaudRate
Serial Only - The speed for serial communications.
9600 (Read-Only)
DataBits
Serial Only - The number of data bits per byte.
8 Bits (Read-Only)
Parity
Serial Only - Parity scheme for serial communications.
None (Read-Only)
StopBits
Serial Only - The number of stop bits per byte.
1 Bit (Read-Only)
CTSFlowControl
Serial Only - Clear To Send flow control setting.
Enabled (Default)
Disabled
Device Usage
USB Only -Indicates the usage for this device.
6 (Read-Only)
Device Usage Page
USB Only - Indicates the usage page for this device.
65407 (Read-Only)
Number of Reports
USB Only - Indicates the number of reports for the
device.
2 (Read-Only)
Product
USB Only - The name of the device supported.
5975 2x20 Customer
Display
Vendor
USB Only - The manufacturer of the device.
NCR
ClearAfterRead
USB Only – Clear data after reading from hardware.
True (Read-Only)
Line Display Configuration Entries – NCR 5975-2xxx Graphical
Parameter
Description
Valid Values
API Interface
The interface that is using being used.
JavaPOS
Logical Name
The name of a specific configuration.
Model Class
NCR5975IntLineDisplay
Connection Type
Serial or USB.
Maximum Device
Windows
The maximum number of logical windows that this
device can support at once.
Java Character
The Line Display operates using character sets, not
Serial
USB
1 to 10
10 (Default)
Encoding
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)
BaudRate
Serial Only - The speed for serial communications.
19200 (Read-Only)
DataBits
Serial Only - The number of data bits per byte.
8 Bits (Read-Only)
Parity
Serial Only - Parity scheme for serial communications.
None (Read-Only)
StopBits
Serial Only - The number of stop bits per byte.
1 Bit (Read-Only)
CTSFlowControl
Serial Only - Clear To Send flow control setting.
Enabled (Default)
Disabled
Device Usage
USB Only -Indicates the usage for this device.
4 (Read-Only)
Device Usage Page
USB Only - Indicates the usage page for this device.
65407 (Read-Only)
Number of Reports
USB Only - Indicates the number of reports for the
device.
2 (Read-Only)
Product
USB Only - The name of the device supported.
5975 Graphical Customer
Display
Vendor
USB Only - The manufacturer of the device.
NCR
ClearAfterRead
USB Only – Clear data after reading from hardware.
True (Read-Only)
Line Display Configuration Entries – NCR 7402 2x20
Parameter
Description
Valid Values
API Interface
The interface that is using being used.
JavaPOS
Logical Name
The name of a specific configuration.
Model Class
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 – US English
(Default)
858 - International
English
866 - Cyrillic
101 - Katakana
Command Set
Command set used by the 7402 2x20.
NOTE: Do not change unless the device does not work
with the default setting.
Standard Command Set
(Default)
Legacy Command Set
PortName
The COM Port where the line display is attached.
COM1 - COM10
COM1 (Default)
BaudRate
The speed for serial communications.
9600 (Read-Only)
DataBits
The number of data bits per byte.
8 Bits (Read-Only)
Parity
Parity scheme for serial communications.
None (Read-Only)
StopBits
The number of stop bits per byte.
1 Bit (Read-Only)
Line Display Configuration Entries – NCR 7402 APA
Parameter
Description
Valid Values
API Interface
The interface that is using being used.
JavaPOS
Logical Name
The name of a specific configuration.
Model Class
NCR7402LineDisplayAP
A
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.
Character File
Directory
The 7402 APA Line Display has no internal character
set. The character set used is stored in a file in the
directory specified by this setting.
/use/local/NCRRetail
Default Character
Set
The character set to initialize during initial device
enable.
Unicode (Read-Only)
Screen Mode
Screen size setting in rows x columns.
4x8 (Default)
4x16
8x16
PortName
The COM Port where the line display is attached.
COM1 - COM10
COM1 (Default)
BaudRate
The speed for serial communications.
115200 (Read-Only)
DataBits
The number of data bits per byte.
8 Bits (Read-Only)
Parity
Parity scheme for serial communications.
None (Read-Only)
StopBits
The number of stop bits per byte.
1 Bit (Read-Only)
Line Display Configuration Entries – NCR 744x 2x20
Parameter
Description
Valid Values
API Interface
The interface that is using being used.
JavaPOS
Logical Name
The name of a specific configuration.
Model Class
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 – US English
(Default)
Command Set
Command set used by the 744x 2x20.
RealPOS 20 Standard
Command Set (Default)
PortName
The COM Port where the line display is attached.
ESC/POS Command Set
COM1 - COM10
COM1 (Default)
BaudRate
The speed for serial communications.
4800
9600 (Default)
19200
38400
DataBits
The number of data bits per byte.
8 Bits (Read-Only)
Parity
Parity scheme for serial communications.
None (Default)
Even
StopBits
The number of stop bits per byte.
1 Bit (Read-Only)
MICR
The MICR reader Control Object 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
X
E
T
A
S
$
B
*
MICR substitution symbols for Transit, On-Us, Amount,
Dash, and Space.
Digit, space, or dash.
EPC: Digit.
Transit number: Digit or dash. (For US checks, only
digits are allowed.)
Account number: Digit, space, or dash. (Account number
begins and ends with a digit.)
Serial/sequence number: Digit.
Amount: Digit.
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]
[min+]
Specifies between "min" and "max" characters.
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
E
tT[9]t
X[1+]oX[0+]
a$[10]a
Auxiliary on-us (optional). Bounded on left and right
with On-Us characters. Often used for serial number,
in which case ‘X’ are digits.
EPC character (optional). Immediately precedes
leftmost Transit character.
Transit number (required). Bounded on left and right
with Transit characters.
On-us (optional). (More than one On-Us symbol can
be included.
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
Account is "1234567".
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
Errors
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
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_NON_DIGITS
data
Not Used
object
List of characters to remove
"A"
"T"
"AT"
""
Errors
Remove the account character
Remove the transit character
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
Errors
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
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
API Interface
The interface that is using this control,
Currently, JavaPOS is the only valid option
JavaPOS
Logical Name
The name of a specific configuration
Model Class
MICR7167
NCR71xxPrinterCDMICR,
NCRH6xxxPrinterHydraModel
Uses
The MICR reader is integrated in a retail
printer. Enter the profile name of the
associated POS Printer
Printer7167
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
Refer to the DirectIO "MICR
Parsing" for valid strings
not covered by the default parsing rules.
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
* Exception String X - Additional exception strings may be added as
long as they are in consecutive order. If you skip a number, the code
thinks it’s at the end of the exceptions.
The following configuration has been predefined.
Default Configuration
Description
MICR7167
NCR 7167 Printer with a MICR
reader
Motion Sensor
The Motion Sensor Control Object supports the motion sensor
integrated into the NCR 7402 terminal.
Motion Sensor Configuration Entries
Parameter
Description
Valid Values
API Interface
The interface that is using this control,
Currently, JavaPOS is the only valid option
JavaPOS
Logical Name
The name of a specific configuration
MotionSensor7402
Model Class
NCRAgentMotionSensorModel
The following configuration has been predefined.
Default Configuration
Description
MotionSensor7402
Motion sensor integrated in the
NCR 7402 terminal.
MSR
The MSR reader Control Object supports the MSR located on the NCR
5932 Wedge Keyboard, the NCR 5932 USB Keyboard or the NCR
Dynakey.
MSR - Magnetic Stripe Reader Configuration Entries
Parameter
Description
Valid Values
API Interface
The interface that is being used.
JavaPOS
Logical Name
The name of a specific configuration.
NCRMSR.5932Wedge
NCRMSR.5932USB
Model Class
Read Head Type
NCRIOChannelMSR
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.
Wedge (Default)
USB
Device Usage Page
USB Only. Indicates the usage page for this
MSR Device.
142 (Read-Only)
Device Usage
USB Only. Indicates the usage for this MSR
Device.
1
Number of Reports
USB Only. Indicates the number of reports for
this MSR Device.
1
Product
USB Only. The Product where the USB MSR
device resides.
Any HID USB MSR
5932-50xx USB MSR
5932-52xx/5953-85xx/595386xx/5954/5964-7xxx USB ISO
MSR
5932-52xx/5953-85xx/595386xx/5954/5964-7xxx USB JIS
MSR
5953-6xxx/5953-80xx USB
Dynakey
Vendor
USB Only. The manufacturer of the MSR
device.
NCR
ClearAfterRead
USB Only. Should the device memory be
cleared after a read.
True
DeviceType
Wedge Only. The subcomponent on the
Wedge bus to use.
MSR
Any Vendor
The following configurations have been predefined:
Default Configuration
Description
NCRMSR5932Wedge
MSR on the NCR 5932 Wedge
Keyboard
NCRMSR.5932USB
MSR on the NCR 5932 USB
Keyboard
POS Printer
The Printer Model supports the following NCR printers.
•
7156
•
7158
•
7167
•
7168
•
7194
•
7197
•
7198
•
K580
•
K590
•
7342-F306
In addition, the following printers are supported:
•
H6000
•
H6000II
The Printer Model currently interfaces to the printer over a serial port,
and it will function on any terminal with a standard serial port.
(Future releases may also include support for USB or other interfaces.)
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
metric). 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
Errors
data[0]
Printer Station identifier
object
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.
The only valid width values for the NCR 7158 Slip station are 2 and 4.
A value of 3 gives you the same output as 2.
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
object
Not Used
DirectIO - Set Bitmap Type
Sets a new type for bitmap print processing. This function returns the
previous bitmap type 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_BITMAP_TYPE
data[0]
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
Errors
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
command
NCRDIO_PTR_SOUND_AUDIBLE_TONE
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 is 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 7156 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 66 characters can be printed on a slip line in
standard mode. By calling this DirectIO with Data set to (PTR_S_SLIP
+ 80), the service object selects compressed mode for any SlpLineChars
value, since compressed mode is required to print 80 characters on a
line.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
command
NCRDIO_PTR_SET_MIN_LINE_CHARS_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
Errors
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
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. The variable internal
to the printer service object that is made visible is m_nPrinterStatus.
NCR-specific statuses are returned in the “ResultCodeExtended”
property.Except for those cases where the upper bit is not 0x80000000.
In those cases, see the specific error values that can be returned.
Defined Constant
PRTSTAT_FLAG
PTRSTAT_ALL
PTRSTAT_STATE
PTRSTAT_PRINTER
PTRSTAT_PRINTER_FAULT
PTRSTAT_DRAWER
Printer States
PTRSTAT_OFF_STATE
PTRSTAT_ERROR_STATE
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
Defined Constant
OPOS Printer Sensor values.
PTRSTAT_COVER_OPEN
PTRSTAT_JRN_EMPTY
PTRSTAT_JRN_NEAREND
PTRSTAT_REC_EMPTY
PTRSTAT_REC_LOW
PTRSTAT_SLP_EMPTY
PTRSTAT_SLP_LOW
Description
Cover or door open
Journal out
Journal low
Receipt out
Receipt low
Slip leading edge sensor: no
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_FAU
Auto-recoverable fault, such as
LT
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
NCRDIO_PTR_SENSOR_STATUS
data[0]
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
Errors
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
command
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
PTR_PPS_Paper_Present Presenter paper
present
PTR_PPS_No_Paper
Presenter paper out
PTR_CPC_Paper_Present Cabinet paper
chute: Paper present
PTR_CPC_No_Paper
chute: No paper
PTR_PO_Rotated_90
PTR_PO_Normal
rotated (normal)
object
Errors
Cabinet paper
Presenter rotated
Presenter not
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_REC_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
Errors
0
None
1
6 inches
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 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]
object
Errors
The new receipt retain length. This value is one of:
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.
Updated Methods
CutPaper Method
Additional return values have been added to the CutPaper method.
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
Meaning
JPOS_E_BUSY
Cannot perform while output is in
progress. (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_RPM_NOT_READY: The
receipt Presenter Mechanism on the
K580 printer still has paper in it from
the previous operation, and is not
ready to accept a new operation.. (Can
only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and
online (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN: The
cabinet door on the K580 printer is
open. Output not allowed. (Can only
be returned if AsyncMode is FALSE.)
NCR_EPTR_MECH_ERROR Presenter
mechanism failure (Potential paper
jam)
NCR_EPTR_RPM_PAPER_JAM Paper
jam encountered during printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
PrintBarCode Method
Additional information for the Alignment parameter
Alignment
Placement of the bar code. (See Values below) For
the NCR 7158 printer, the default alignment uses the
full width of the carriage to determine the Left,
Center, and Right positions. The 7158 alignment can
be adjusted to the width of a particular slip by using
the printer’s native “Set Absolute Starting Position”
command to set the Left margin. This command is
sent to the printer using the Direct I/O method
NCRDIO_PTR_RAW_OUTPUT. See Set Absolute
Starting Position below for additional information.
Set Absolute Starting Position
Sets the print starting position to the specified number of dots (up to
the right margin) from the beginning of the line. The print starting
position is reset to the first column after each line.
ASCII:
ESC $ n1 n2
Hexadecimal:
1B 24 n1 n2
Decimal:
27 36 n1 n2
Value of n: Number of dots to be moved from the beginning of the line
Value of n1: Remainder after dividing n by 256.
Value of n2: Integer after dividing n by 256.
The values for n1 and n2 are two bytes in low byte, high byte word
orientation.
Formulas:
Determine the value of n by multiplying the column for the absolute
starting position by 10. The example shows how to calculate column
29 (10 dots per column) as the absolute starting position.
28 x 10 = 280 dots (beginning of column 29)
280/256 = 1, remainder of 24
n1 = 24
n2 = 1
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
JPOS_E_BUSY
Meaning
Cannot perform while output is in
progress.
(Can only be returned if AsyncMode is
FALSE.)
ResultCodeExtended =
NCR_EPTR_RPM_NOT_READY:
The receipt Presenter Mechanism on
the K580 printer still has paper in it
from the previous operation, and is not
ready to accept a new operation..
(Can only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and
online (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN:
The cabinet door on the K580 printer
is open. Output not allowed.
(Can only be returned if AsyncMode
is FALSE.)
NCR_EPTR_MECH_ERROR
Presenter mechanism failure (Potential
paper jam)
NCR_EPTR_RPM_PAPER_JAM
Paper jam encountered during
printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
PrintBitmap Method
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
Meaning
JPOS_E_BUSY
Cannot perform while output is in
progress. (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_RPM_NOT_READY:
The receipt Presenter Mechanism on
the K580 printer still has paper in it
from the previous operation, and is not
ready to accept a new operation..
(Can only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and
online (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN:
The cabinet door on the K580 printer
is open. Output not allowed.
(Can only be returned if AsyncMode
is FALSE.)
NCR_EPTR_MECH_ERROR
Presenter mechanism failure (Potential
paper jam)
NCR_EPTR_RPM_PAPER_JAM
Paper jam encountered during
printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
PrintImmediate Method
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
JPOS_E_BUSY
Meaning
Cannot perform while output is in
progress. (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_RPM_NOT_READY:
The receipt Presenter Mechanism on
the K580 printer still has paper in it
from the previous operation, and is not
ready to accept a new operation..
(Can only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and
online (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN:
The cabinet door on the K580 printer
is open. Output not allowed.
(Can only be returned if AsyncMode
is FALSE.)
NCR_EPTR_MECH_ERROR
Presenter mechanism failure (Potential
paper jam)
NCR_EPTR_RPM_PAPER_JAM
Paper jam encountered during
printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
PrintNormal Method
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
Meaning
ResultCodeExtended = NCR_EPTR_RPM_NOT_READY:
The receipt Presenter Mechanism on the
K580 printer still has paper in it from the
previous operation, and is not ready to
accept a new operation..
(Can only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and online
(Can only be returned if AsyncMode is
FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN:
The cabinet door on the K580 printer is
open. Output not allowed.
(Can only be returned if AsyncMode is
FALSE.)
NCR_EPTR_MECH_ERROR
Presenter mechanism failure (Potential
paper jam)
NCR_EPTR_RPM_PAPER_JAM
Paper jam encountered during printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
PrintTwoNormal Method
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
JPOS_E_BUSY
Meaning
Cannot perform while output is in
progress. (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_RPM_NOT_READY:
The receipt Presenter Mechanism on the
K580 printer still has paper in it from the
previous operation, and is not ready to
accept a new operation..
(Can only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and online
(Can only be returned if AsyncMode is
FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN:
The cabinet door on the K580 printer is
open. Output not allowed.
(Can only be returned if AsyncMode is
FALSE.)
NCR_EPTR_MECH_ERROR
Presenter mechanism failure (Potential
paper jam)
NCR_EPTR_RPM_PAPER_JAM
Paper jam encountered during printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
RotatePrint Method
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
Meaning
JPOS_E_BUSY
Cannot perform while output is in
progress. (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_RPM_NOT_READY:
The receipt Presenter Mechanism on
the K580 printer still has paper in it
from the previous operation, and is not
ready to accept a new operation..
(Can only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and
online (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN:
The cabinet door on the K580 printer is
open. Output not allowed.
(Can only be returned if AsyncMode is
FALSE.)
NCR_EPTR_MECH_ERROR
Presenter mechanism failure (Potential
paper jam)
NCR_EPTR_RPM_PAPER_JAM
Paper jam encountered during printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
TransactionPrint Method
Errors
An exception may be thrown when this method is invoked.
Some possible values of the exception’s ErrorCode property are:
Value
Meaning
JPOS_E_BUSY
Cannot perform while output is in
progress. (Can only be returned if
AsyncMode is FALSE and Control is
PTR_TP_NORMAL.)
ResultCodeExtended =
NCR_EPTR_RPM_NOT_READY:
The receipt Presenter Mechanism on
the K580 printer still has paper in it
from the previous operation, and is not
ready to accept a new operation..
(Can only be returned if AsyncMode is
FALSE.)
JPOS_E_FAILURE
Cannot communicate with the device
even though it is powered up and
online (Can only be returned if
AsyncMode is FALSE.)
ResultCodeExtended =
NCR_EPTR_CDS_DOOR_OPEN:
The cabinet door on the K580 printer is
open. Output not allowed.
(Can only be returned if AsyncMode is
FALSE.)
NCR_EPTR_MECH_ERROR
Presenter mechanism failure (Potential
paper jam)
NCR_EPTR_RPM_PAPER_JAM
Paper jam encountered during printing
NCR_EPTR_RPM_BLACK_MARK
Black mark detection failure. (Not
Currently Implemented)
NCR_EPTR_PRINT_HEAD_FAILURE
Printer head failure (Not Currently
Implemented)
POS Printer Configuration Entries
Common Configuration Entries
The following entries are common to all POS Printers.
Parameter
Description
Valid Values
API Interface
The interface that is using this control,
Currently, JavaPOS is the only valid option
JavaPOS
Logical Name
The name of a specific configuration
A configuration name such as
Printer7167
Printer7197
PrinterK590
Model Class
NCR71xxPrinterCDMICR,
NCRK5xxPrinterHydraModel
, or
NCRH6xxxPrinterHydraMod
el
(Read-Only)
POSPrinter Model
The model number of the attached printer
A configuration name such as
NCR7156
NCR7158
NCR 7167
NCR 7168
NCR 7194
NCR 7197
NCR 7198
NCR K580
NCR K590
NCR 7342-F306
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)
Parameter
Description
Valid Values
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, we will not know which (if any)
requests in the block were printed successfully,
and which were not. In this regard, a smaller
block size may allow more precise error
handling on the part of the application. .
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. The
timeout value must be between 50 and 10000
milliseconds.
50-10000 ms (Default 200
ms)
A higher timeout value will usually allow 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 will be 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,
Parameter
Description
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
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.
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
115200 (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
Eject Slip Feed
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
"" (Default)
Slip insertion will not succeed until we have a
slip inserted status that is stable for this many
milliseconds. If this value is left blank, a
0 - 10000 ms
"" (Default)
(Slip printers only)
Slip In Settle Time
(Slip printers only)
Parameter
Description
printer specific default value is used.
Valid Values
Slip Out Settle Time
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
"" (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 insertion
(Slip printers only)
Slip To Top Of Form
(Slip printers only)
NCR 71xx Specific Configuration Entries
The following entries are specific to the NCR 71xx POS Printers.
Parameter
Description
Valid Values
Color Paper
For the 7167, 7168, 7197 and 7198 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.
Print Integrity Mode
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,
(K580, K590, F306)
Default is 3000ms
Parameter
Description
Valid Values
Auto Eject Delay
Delay in seconds between time the receipt is
cut and when the receipt is automatically
ejected.
0 (No auto eject) (Default)
(K580, K590)
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
Ignore Errors (Default for
F306)
(K580, K590, F306)
Knife Cut Adjustment
Time
(K580, K590)
Black Mark Option
(K590, F306)
Default is 10000ms
Do Not Eject on Enable
(Default)
Do Not Ignore Errors
(Default for K580, K590)
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
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
Parameter
Description
Post-Eject Delay
Time to delay after eject to let the receipt clear
the presenter.
Valid Values
Default is 2000ms for F306
(K580, K590, F306)
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.
Minimum Receipt
Length
Minimum amount of receipt paper to present to
the user.
(K590, F306)
80mm (Default)
82.5mm
114mm
K590 values
90mm
111mm
150mm
225mm
300mm
375mm
450mm
525mm
600mm
F306 values
None
Paper Low Option
(K590)
Determines when the printer will report a paper
low status.
6 inches
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
Receipt Retain Length
(K590)
Determines the portion of each receipt to hold
inside the presenter.
25mm
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.
Specifies the distance between black marks on
the printer paper.
Use Soft Options
Do Not Use Soft Options
(Default)
111mm
127mm
140mm
Parameter
Description
Valid Values
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)
The following configurations have been predefined.
Default Configuration
Description
Printer7167
NCR 7167 Printer
Printer7197
NCR 7197 Printer
PrinterK590
NCR K590 Printer
PrinterF306
NCR 7342-F306 Printer
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
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
Escape Sequence
Functionality
Possible Values
= 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.
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
text = ASCII character to define
pre-defined lines.
ESC [2ST; 3; n !v
[directory/filena
me]
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
Escape Sequence
Functionality
Possible Values
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
text = ASCII string to assign to
the variable. It only allows a
maximum of 57 characters.
Characters beyond 57 are
ignored.
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
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
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
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
(Double Sided Mode with
Single Side Command)
When this mode of operation is selected, the printer
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
Two-Sided Modes
Functionality
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
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
TST 2 Side 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
Parameter
Description
Valid Values
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.
TST Orientation
Determines the orientation of text on the front
and back of the receipt.
Front normal, Back normal
(Default)
Front normal, Back upside down
Front upside down, Back normal
Front upside down, Back upside
down
TST Print Sides
TST Min Receipt Length
TST PreDef Text Front
Determines which side of the receipt is the
front and which is the back.
Normal (Default)
The minimum receipt length, in inches, before
the receipt will be split between front and
back in split receipt mode.
0, 2 – 10 inches.
Enables or disables printing of a predefined
message on the bottom front of each receipt.
Enabled
Swapped: Front data prints on the
back of the receipt, and back data
prints on the front
A value of 0 means there is no
minimum length; however,
receipts shorter than 23.5mm
cannot be split. This is the
default.
Disabled (Default)
Parameter
Description
Valid Values
TST Front Line 1 Text
First line of the front predefined text.
Set this value to a text string, or 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.
TST Front Line 1 Attrib
Attributes for the first line of the front
predefined text.
See the attribute table below for
valid attribute values.
TST Front Line 2 Text
Second line of the front predefined text.
Set this value to a text string, or 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.
TST Front Line 2 Attrib
Attributes for the second line of the front
predefined text.
See the attribute table below for
valid attribute values.
TST PreDef Text Back
Enables or disables printing of a predefined
message on the top back of each receipt.
Enabled
First line of the back predefined text.
Set this value to a text string, or an
empty string.
TST Back Line 1 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.
TST Back Line 1 Attrib
Attributes for the first line of the back
predefined text.
See the attribute table below for
valid attribute values.
TST Back Line 2 Text
Second line of the back predefined text.
Set this value to a text string, or 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.
TST Back Line 2 Attrib
Attributes for the second line of the back
predefined text.
See the attribute table below for
valid attribute values.
TST Reprint On Error
Enables or disables automatic reprint on
errors.
Enabled
Parameter
Description
Valid Values
TST PreDef Reprint
Enables or disables printing of a predefined
message as part of the reprint on error
processing.
Enabled
First line of the reprint on error predefined
text.
Set this value to a text string, or an
empty string.
Disabled (Default)
TST Reprint Line 1 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.
TST Reprint Line 1
Attrib
Attributes for the first line of the reprint on
error predefined text.
See the attribute table below for
valid attribute values.
TST Reprint Line 2 Text
Second line of the reprint on error predefined
text.
Set this value to a text string, or 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.
TST Reprint Line 2
Attrib
Attributes for the second line of the reprint on
error predefined text.
See the attribute table below for
valid attribute values.
TST 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.
TST 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.
TST 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.
TST 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.
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
Scale
The Scale supports many NCR Scanner/Scale devices. See the
supported device table for the Scale models supported.
NCR USB connection type is for use with USB serial emulation driver.
The “Uses” parameter must be set with the scanner profile whose
connection type must be SERIAL.
USB connection type is a HID USB connection and is supported for
NCR 7883, 7872 and 7876 Release 2 scanner/scales.
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
Errors
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
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
Remarks
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
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.
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.
Scale Configuration Entries
Parameter
Description
Valid Values
API Interface
The interface that is using this control,
Currently, JavaPOS is the only valid
option
JavaPOS
Logical Name
The name of a specific configuration
ScaleNCR78xx
Model Class
ScaleModel
Model number of the device
MonitorEnable
Enables the ReadWeight method to return
a continuous weight when a stable weight
is available. Disable returns only a NEW
weight.
NCR78xxScannerScale
NCR 7872 (Default)
NCR 7875
NCR 7876
NCR 7878
NCR 7883
Disabled (Default)
Enabled - Return continuous weight.
Application is responsible for
assuring a stable legal weight.
Metric (USB only)
Selects the scale metric (kg) weight
interface when enabled. Selects the
Engilish (lbs) weight interface when
Disabled (Default) Pounds mode
Enabled – Kilogram mode.
“FiveDigit” weight must be enabled
FiveDigit (USB only)
Uses (Serial only)
disabled. Must match the scale setting.
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 connections the Scale uses the
parameters of the Scanner service object in
addition to the parameters described here.
Therefore, the Scanner parameter entries
must be set up first.
The profile name of the Scanner for
Serial.
“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.
The following configuration has been predefined.
Default Configuration
Description
ScaleNCR78xx
A scale on the NCR 7872
Scale Data Capture Configuration Entries
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.
DirectIO - Scanner Direct Access and DirectIO - Scanner ROM Version
only is supported on models NCR 7837-xxxx, NCR 7838, 3800, 4600,
5600 and 5620/3820.
No DirectIO is supported for model NCR 7837.
NCR USB connection type is for use with USB serial emulation driver.
USB connection type is a HID USB connection and is supported for
NCR 7883 and 7892 Release 2 scanners and 7872, 7876 and 7878 Release
2 scanner/scales.
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.
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 Default Profiles
The following configuration has been predefined as JavaPOS default
profiles in the file config.xml.
Default Configuration
Description
ScannerNCR7882
NCR 7882 Scanner
ScannerNCR7837
NCR 7837 Scanner
ScannerNCR7837_3000
NCR 7837-3000 Scanner
ScannerNCR7838
NCR 7838 Scanner
ScannerNCR7838_SelfService
NCR Kiosk Scanner
ScannerNCR7832
NCR 7832 Scanner
ScannerNCR78xx
NCR 78xx Scanner
ScannerUSB
NCR 78xx USB Scanner
78xx Product ID = 512
7878 Product ID = 528
Scanner.5932Wedge
Scanner in NCR 5932
ScannerNCR7892
NCR 7892 Scanner
ScannerNCR7404
NCR 7404 Kiosk USB Scanner
Scanner2356
NCR 2356-xxxx Serial Scanner
Scanner2356USB
NCR 2356-xxxx USB Scanner
Scanner3800
NCR 2357-3800 Serial Scanner
Scanner4600USB
NCR 2357-4600 USB Scanner
ScannerOther
Other Scanners
Scanner Configuration Entries
Note: COM1 through COM10 correspond to “/dev/ttyS0” through
“/dev/ttyS9”. COM is used as a generic name. /dev/ttyS40 and
ttyS50 were added specifically for IONetworks USB support. They
were left as ttySx because you must lookup the link in Linux for what
port ION selected for use with their USB driver
Parameters
Description
Valid Values
API Interface
The interface that is using this control,
Currently, JavaPOS is the only valid
option
JavaPOS
Logical Name
The name of a specific configuration
You can name your own configuration
names. The following names are supplied
with the install.
ScannerNCR7882
ScannerNCR7837
ScannerNCR7832
ScannerNCR78xx
Scanner.5932Wedge
ScannerNCR7892
ScannerOther
Parameters
Description
Valid Values
Model number of the Scanner connected
to the terminal
NCR 7832
NCR 7837
NCR 7837-1300
NCR 7837-3000
NCR 7838
NCR 7838-SS
NCR 7872
NCR 7875
NCR 7876
NCR 7878
NCR 7880
NCR 7882
NCR 7883
NCR 7892 (Default)
3800
4600
5600
5620/3820
Model Class
Scanner Model
NCR78xxScannerScale
NCR 7838-SS indicates 7838 Self
Service scanner for FastLane and Kiosk
applications.
Connection Type
Describes how the scanner is connected
to the terminal
Serial (Default)
NCR Wedge
USB
EnableIfOff
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
Prefix
Must match the device setting. .Prefix,
prepends a byte or 2 to the device
message. Prefix is not included in BCC
calculation.
None (Default)
Suffix
Must match the device setting. Suffix
prepends a byte or 2 to the device
message. Suffix is included in the BCC
calculation.
None
0x03 (Default)
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)
Set to a value of 1 shall initialize device at
the first device enable after Open.
Parameters
Description
Valid Values
The default behavior shall initialize the
device on the first device enable after
Claim.
The default value is zero.
NCR 7872, 7875, 7876 Common Properties
ScannerScaleFormat
ScannerScaleFormat 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
ScannerScale (Default)
Bcc
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
Enabled (Default)
RemoveSpaces
Applicable only when “CheckDigit” is
“Enabled”. Enables removal of spaces
within a barcode. “Remove” sets
“RemoveSpaces” config file parmater 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
Serial Port Parameters for NCR 7872, 7875, 7883 and Scanner-Only NCR Scanners, NCR 7882, NCR
7892
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, /dev/ttyS49, /dev/ttyS50
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
Parameters
Description
Valid Values
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 7882, 7883 and NCR 7892 Common Properties
Disabled (Disabled)
Enabled
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.
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
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 (Default)
Enabled
DSR Flow Control
Permit serial flow control through the
Data Set Ready (DSR) signal.
Disabled (Default)
Enabled
NCR 7832 and NCR 7837 Common Properties
COM1 - COM10,
COM1 (Default)
Serial Port Properties for Input-Only (7837, Other) Scanners
Parameters
Description
Valid Values
Baud Rate
The communication speed for the
Scanner. The setting must match the
device setting
9600 bps
4800 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
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)
HID USB Parameters for NCR Release2 scanner models: NCR 7872, 7876, 7883 and Scanner-Only NCR
Scanner NCR 7892
Parameters
Description
Valid Values
VendorID
Vendor ID of the HID device.
0x404 (Default)
ProductID
Product ID of the HID device.
0x200 (Default)
DevUsagePage
Device Usage Page of the HID device.
0xFF45 (Default)
DevUsage
Device Usage of the HID device.
0x4A00 (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)
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 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.
0x4A00 (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)
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
HID USB Parameters for NCR Scanner model: NCR 7878
Parameters
Description
Valid Values
VendorID
Vendor ID of the HID device.
0x404 (Default)
ProductID
Product ID of the HID device.
0x210 (Default)
DevUsagePage
Device Usage Page of the HID device.
0xFF45 (Default)
DevUsage
Device Usage of the HID device.
0x4A00 (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)
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)
Enabled
Enable RSS/14.
Enable RSS Expanded.
Enable both.
Default Serial values based on Model setting:
Model
Baud
Parity
Byte
Size
Stop
Bits
7832
9600
None
8
2
7837
9600
Even
7
1
78371300
38400
None
8
1
78373000
7838,
3800,
4600,
5600,
5620
38400
None
8
38400
None
8
Prefix
Suffix
CTS
*
DSR *
DTR *
RTS *
None
0x0D
--
--
--
--
None
0x0D
--
--
--
--
Symbology
ID
0x0D
--
--
--
--
1
Symbology
ID
0x0D
--
--
--
--
1
Symbology
ID
0x0D
--
--
--
--
7838SS
115200
None
8
1
Symbology
ID
0x0D
7872
9600
Odd
7
1
None
0x03
On
On
--
--
7875
9600
Odd
7
1
None
0x03
On
On
--
--
7876
9600
Odd
7
1
None
0x03
On
On
7878
9600
Odd
7
1
None
0x03
On
On
7880
9600
Odd
7
1
None
0x03
--
--
7882
9600
Odd
7
1
None
0x03
--
--
--
--
7883
9600
Odd
7
1
None
0x03
On
On
7892
9600
Odd
7
1
None
0x03
--
--
--
--
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.
For the NCR family of scanners, these settings are known by the
Scanner / Scale Service
Scanner Data Capture Configuration Entries
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
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-0438286appears in RSM as
NCR 7838 Self Service scanner.
7401/7402 Kiosk Integrated Scanner
The Kiosk Integrated Scanner model in RSM should be NCR 7892.
•
Example NCD7492 scanner model: NCR 7892-0908
HID USB Scanner Configuration
Only Release 2 (SA) scanners and scanner/scales support HID USB
connection type to NCR UPOS.
No Release 1 scanners support HID USB. Release 2 scanners a model
number for the scanner with a 2 in the second digit of the model
version number.
Example Release 2 scanner model number: 7872 - 1298 has a model
version 1298 with a '2' in the second position indicating Release 2.
[Scanner Configuration Program Sequences]:
The scanner must be configured to use HID 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 scanner must be configured to use HID USB ASCII data format.
PM 3 2 F S&R
[Scanner Configuration Bytes]:
The Configure Scanner bytes can be set in the scanner profile “Config” entry. The
table below shows the meaning for the configuration bytes NCR specific
restrictions.
See the descriptions below noting the NCR Specific restrictions.
Byte 0 NCR Specific: All bits supported except for Codabar and UPC D1-D5. Tthe
scanner will take either value of 1 or 2 for bits 0-1 and just turn UPC on.
BIT(s)
0-1
2-4
Definition
0 = Invalid
1 = UPC A/UPC E,EAN 8/13 enable
2 = UPC A/UPC E,EAN 8/13, UPC D1..D5
enable
3 = Invalid
0 = Disable 2 and 5 digit periodical add-on
1 = Enable +2 add-ons optional
2 = Enable +5 add-ons optional
3 = Invalid
4 = Enable +2 and +5 optional
5
6
7
5, 6, 7 = Invalid
Code 39 enable
ITF enable
Reserved for Codabar
Byte 1 NCR Specific: Code 93 or the ability to enable/disable scanner
programming via barcodes shall not be supported. All other bits are supported.
BIT(s)
0
1
2
3
4
5
6
7
Byte 1 - Decode and Programming
Reserved for Code 93
Code 128
UPC A to EAN-13 expansion
UPC E to EAN 13 expansion
UPC E to UPC A expansion
Verify 4 digit price check
Enable scanner programming via barcodes
Verify 5 digit price check
Byte 2 NCR Specific: All bits are supported.
BIT(s)
0-5
6
7
Byte 2 - Interleaved 2 of 5, length 1
ITF length #1
Even value 4-32 inclusive
Not defined, must be zero
Configure two ITF lengths
Byte 3 NCR Specific: All bits are supported.
BIT(s)
0
1-2
3-5
6-7
Byte 3 - Beeper Control
Enable good read beep
Beeper duration
0-4 valid Short -- Long
Beeper volume
0-3 low -- high
4-7 invalid
Beeper frequency
0-4 valid low -- high
Byte 4 NCR Specific: All bits are supported.
BIT(s)
0-5
6
Byte 4 - Interleaved 2 of 5, length 2
Interleaved 2 of 5 length #2
Not defined, must be zero
7
Not defined, must be zero
Byte 5 AND Byte 6 NCR Specific: All bits arel NOT supported for minimum
scans per read.
Byte 7 NCR Specific: Laser and motor are tied together in hardware. They have
to be the same values. The values for motor/laser timeouts and the double read
timeout (TBI) shall be supported, the values in this config command have been
altered to match the times valid for the NCR scanner. In other words, you could
set the TBI (double read) timeout to be 700 ms, but we make it 750 because that's
what our H/W can co.
The Scanner does NOT support EAN/JAN-13 Two Label Decoding with this
command.
BIT(s)
0-2
3-4
5-6
7
Byte 7 - Timeouts
Motor Timeout
0 = 60 minutes
1 = 5 minutes
2 = 10 minutes
3 = 15 minutes
4 = 30 minutes
5 = 60 minutes
6 = invalid
7 = invalid
Laser Timeout
0 = 15 minutes
1 = 5 minutes
2 = 10 minutes
3 = 15 minutes
Double Read Timeout
0 = 500 ms
1 = 700 ms
2 = 900 ms
3 = invalid
Enable EAN/JAN-13 Two Label Decoding
Byte 8 NCR Specific: All bits are NOT supported.
BIT(s)
0-1
Byte 8 - Miscellaneous Controls
LED Good Read Duration
0 = 0.50 seconds
1 = 0.75 seconds
2-3
4
5
6
7
2 = 1.00 seconds
3 = invalid
Reserved for Universal Scans per Read
Label Buffering
0 = buffer one label
1 = buffer two labels
Enable/Disable switch controlled beep volume adjustment
0 = disabled
1 = enabled
Reserved for Enable Laser ON/OFF switch
Two Additional configuration bytes follow
NCR 2357-xxxx( 3800, 4600, 5600 and 5620) Scanner
setup for UPOS
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
NCR 2357 – 1300
NCR 2357 – 2000
NCR 2357 – 3000
3800 scanner
5600 scanner
4600 scanner
5620/3820 scanner
[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] (4600 only):
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 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/Retail/eRetailBrowseBy.cfm?pl=&PID=&title=&release=&pl=Retail%20-%20Scanners
Link for the USB Serial Emulation driver:
http://www.ncr.com/support/support_drivers_patches.asp?Class=retail_RealScan
Click on 7838, 2356, 2357 and other hand held scanners and locate the link to
download the Simple COM Port Emulation driver.
NCR 7404 EP Advantage Scanner setup for UPOS
The NCR 7404 EP Advantage Scanner is a Symbol MS3207 USB scanner.
The link to the Symbol User's Guide is shown below. Page 12-4 contains the
programming barcodes to configure the scanner for IBM Table Top Scanner.
This is the only scanner configuration change required to work with NCR
UPOS.
From the MS3207 guide page 12-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 Table Top USB (Use with NCR OPOS)
HID Keyboard Emulation
(Default)
IBM Hand-Held USB
Link to Symbol MS3207 user's guide:
http://support.symbol.com/support/search.do?cmd=displayKC&docType=kc&e
xternalId=6713502apdf&sliceId=pdfPage_1&dialogID=5508160&stateId=1%2
00%205510050
NCR 2356 Scanner setup for NCR UPOS
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.
Below are suggested scanner configuration changes to work with NCR UPOS.
The UPOS scanner profile settings should match the scanner configuration.
For Serial RS-232:
- 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”.
For USB via Virtual COM port 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.
For Serial using RTS signal as scanner enable/disable control:
- Configure scanner using RTS/CTS Option 2.
- Add profile parameter “RTSEnable” with a value of 1, 2 or 3. This
parameter enables using the RTS signal to enable and disable the
scanner for scanning.
Value = 1, No serial commands.
Value – 2, Use configuration commands.
Value = 3, Use configuration and enable/disable commands.
- 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”.
For USB via IBM Emulation:
- Scan the IBM Hand Held or IBM Table Top barcodes. No additional
driver is need for this USB connection.
- No sufifix is used with USB.
Link to NCR 2356 Product guides:
http://www.info.ncr.com/eRetail-FPS-BrowseByResultsMV.cfm?pl=Retail%20%2D%20Scanners&PID=&title=&release=&cat=
&bu=atlanta&sbrn=3&mvc=2356
Link to Symbol Simple COM Port Emulation driver:
http://www5.ncr.com/support/support_drivers_patches.asp?Class=retail_Real
Scan
Click on 2356, 2357 and other hand held scanners and locate the link to
download the Simple COM Port Emulation driver.
Tone Indicator
The Tone Indicator Control Object supports the speaker located on the
NCR 5932 Wedge Keyboard, the NCR 5932 USB Keyboard or the NCR
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.
For USB speakers, the pitch value must be 0 (silent) or a value
between 28 and 42192 hz. For Wedge speakers, the pitch
value must be 0 (silent) or a value between 37 and 20816 hz.
For USB speakers, the duration value must be between 0 and
1024 ms. For Wedge speakers, the duration must be between 0
and 664.
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
DirectIO – Set Error Tone
Sets the error tone played when multiple keys are pressed at the same
time. This command is only supported for Wedge speakers. This
command is always handled synchronously.
Syntax
void directIO (int command, int[] data, Object object) throws
JposException;
Parameter
Description
command
NCRDIO_SET_ERROR_TONE
data[0]
Not used
object
A comma separated string giving the pitch, duration,
and volume of the error tone, in that order.
Tthe pitch value must be 0 (silent) or a value between 37 and
20816 hz.
Tthe duration must be between 0 and 664.
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 error tones.
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
Tone Indicator Configuration Entries
Parameter
Description
Valid Values
API Interface
The interface being used, Currently, JavaPOS
is the only valid option.
JavaPOS
Logical Name
The name of a specific configuration.
A configuration name such as
NCRTone.5932Wedge or
NCRTone.5932USB.
Model Class
Tone 1 Duration
NCRIOChannelToneIndicator
The default duration for tone 1, in milliseconds.
0 – 664 (Wedge)
0 – 1024 (USB)
Tone 1 Volume
Default volume for tone 1, as a percentage of
maximum. 0 is silent, and 100 is full volume.
0 – 100
Tone 2 Duration
The default duration for tone 2, in milliseconds.
0 – 664 (Wedge)
0 – 1024 (USB)
Parameter
Description
Valid Values
Tone 2 Volume
Default volume for tone 2, as a percentage of
maximum. 0 is silent, and 100 is full volume.
0 – 100
Interval Between
Tones
The default pause between tone 1 and tone 2, in
milliseconds.
0 – 60000
ConnectionType
How the speaker is connected to the terminal
Wedge or USB
Tone 1 Pitch
The default pitch for tone 1, in hertz.
37 – 20816 (Wedge)
28 – 42192 (USB)
0 for a silent tone (Wedge or USB)
Tone 2 Pitch
The default pitch for tone 2, in hertz.
37 – 20816 (Wedge)
28 – 42192 (USB)
0 for a silent tone (Wedge or USB)
Device Usage
Page
USB Only. Indicates the usage page for this
device.
65423 (Read only)
Device Usage
USB Only. Indicates the usage for this device.
2 (Read only)
Number of
Reports
USB Only. Indicates the number of reports for
this device.
2 (Read only)
Product
USB Only. The Product where the USB device
resides.
Any HID USB Tone Indicator
5932-50xx USB Keyboard
5932-52xx USB Keyboard
5953-6xxx/5953-80xx USB
Dynakey
5953-85xx/5953-86xx USB
Dynakey
5954 USB Dynakey
Vendor
USB Only. The manufacturer of the device.
NCR
Any Vendor
DeviceType
Wedge Only. The subcomponent on the Wedge
bus to use
OutputOnly (Read only)
The following configurations have been predefined:
Default Configuration
Description
NCRTone.5932Wedge
Speaker on the 5932 Wedge keyboard
NCRTone.5932USB
Speaker on the 5932 USB keyboard
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising