WOSA/XFS - pudn.comread.pudn.com/downloads756/ebook/3008325/wosa_ncr.pdf · WOSA/XFS - Programmer’s Reference Manual Overview WOSA/XFS - Programmer’s Reference Manual v Overview

WOSA/XFSProgrammer’s Reference Manual

B006-0000-6001Issue 109/1997

WOSA/XFS Programmer’s Reference Manual

The product described in this book is a licensed product of NCR Corporation.

Trademark Information

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:

NCR (Scotland) Ltd.Information ProductsKingsway WestDundee ScotlandDD2 3XX

Copyright © 1997By NCR CorporationDayton, Ohio U.S.A.All Rights Reserved

AT&T -- PROPRIETARYUse pursuant to Company Instructions

WOSA/XFS - Programmer’s Reference Manual

WOSA/XFS - Programmer’s Reference Manual i

Federal Communications Commission (FCC) Radio Frequency Interference Statement 0

Note: This equipment has been tested and found to comply with the limits fora Class A digital device, pursuant to Part 15 of the FCC Rules. These limitsare designed to provide reasonable protection against harmful interferencewhen the equipment is operated in a commercial environment. Thisequipment generates, uses, and can radiate radio frequency energy and, if notinstalled and used in accordance with the instruction manual, may causeharmful interference to radio communications. Operation of this equipmentin a residential area is likely to cause harmful interference in which case theuser will be required to correct the interference at his own expense.

Canadian Class A Device Declaration 0

This digital apparatus does not exceed the Class A limits for radio noiseemissions from digital apparatus set out in the Radio InterferenceRegulations of the Canadian Department of Communications.

Le présent appareil numérique n’émet pas de bruits radioélectriquesdépassant les limites applicables aux appareils numériques de la classe Aprescrites dans le Réglement sur le brouillage radioélectrique édicté par leministrère des Communications du Canada.

Information to User 0

This equipment must be installed and used in strict accordance with themanufacturer’s instructions. However, there is no guarantee that interference toradio communications will not occur in a particular commercial installation. If thisequipment does cause interference, which can be determined by turning theequipment off and on, the user is encouraged to consult an NCR servicerepresentative immediately.

Caution NCR Corporation is not responsible for any radio or television interference causedby unauthorised modifications of this equipment or the substitution or attachmentof connecting cables and equipment other than those specified by NCR. Suchunauthorized modifications, substitutions, or attachments may void the user’sauthority to operate the equipment. The correction of interference caused by suchunauthorized modifications, substitutions, or attachments will be the responsibilityof the user.


ii WOSA/XFS - Programmer’s Reference Manual



WOSA/XFS - Programmer’s Reference ManualTable of Contents

WOSA/XFS Programmer’s Reference Manual iii

Contents

Overview ...................................................................................................... iPurpose and Audience ........................................................................... i

What is in this Publication ..................................................................... iHow To Use This Guide ........................................................................ i

Pre-requisite ........................................................................................... iRevision Record..................................................................................... i

Chapter 1WOSA/XFS - An Introduction................................................................. 1-1

What is WOSA/XFS.......................................................................... 1-1The WOSA/XFS Architecture ...........................................................1-2

The XFS Manager.............................................................................. 1-3The Service Provider .........................................................................1-3

Requirements For WOSA/XFS .........................................................1-4

Chapter 2Developing an Application Using WOSA/XFS.......................................2-1

Setting up the Development Environment.........................................2-1

Sample Application with Description................................................2-2Bringing in the WOSA/XFS headers and definitions........................ 2-3

Function Prototypes ...........................................................................2-3Functions Used ..................................................................................2-3

Installing the SP set on an SST.......................................................... 2-6Installing the application on an SST ..................................................2-6

Troubleshooting WOSA/XFS............................................................ 2-6

Chapter 3Device Class Interface.............................................................................. 3-1

Service Provider Components ...........................................................3-1Configurable Parameters....................................................................3-1

Capabilities ........................................................................................3-1Conformance Matrices.......................................................................3-1

Deviations ..........................................................................................3-1


iv WOSA/XFS Programmer’s Reference Manual


Application Guidelines ......................................................................3-1Currency Dispenser Module.....................................................................3-2

Depository ..............................................................................................3-19Receipt and Journal Printers ...................................................................3-25

Statement Printer ....................................................................................3-45Passbook Printer .....................................................................................3-59

Text Terminal Unit .................................................................................3-76Vendor Dependent Mode .......................................................................3-92

Pinpad and Key Library .........................................................................3-95Sensors and Indicators Unit ...........................................................3-136

Identity Card Unit ..........................................................................3-143

References References ............................................................................................... R-1


WOSA/XFS - Programmer’s Reference ManualOverview

WOSA/XFS - Programmer’s Reference Manual v

Overview 0

Purpose and Audience 0

This publication provides programmers with NCR specific information needed todevelop WOSA/XFS compliant applications to run on 56XX and 58XX NCR Self-Service Financial Terminals.

This book assumes that the reader has a working knowledge of writingapplications for the operating environment being used, and that appropriatemanuals and references for this environment are available.

What is in this Publication 0Chapter 1 - Introduction

This chapter presents a high level description of the WOSA/XFS architecture andcomponents, and lists the requirements for running a WOSA/XFS application onNCR Self-Service Terminals.

Chapter 2 - Developing an Application Using WOSA/XFS

This chapter describes the process of developing, debugging and installing aWOSA/XFS application on an SST.

Chapter 3 - Device Class Interface

This section describes NCR specific implementation details of the WOSA/XFSService Provider set.

How To Use This Guide 0

This guide is not intended to be used in isolation but in conjunction with theWOSA/XFS Revision 2.00 Programmer’s Reference documents which are freelyavailable and contained in the WOSA/XFS Software Developers Kit (SDK) whichcan be found on the Microsoft World Wide Web page http://www.microsoft.com/,as well as in Microsoft Developer Network (MSDN) products.

Pre-requisite 0

The WOSA/XFS Manager Version 2.00 or above must be installed on the SelfService Terminal before the NCR Service Provider set can be used. The Managerprovides the API interface for the application. The WOSA/XFS Manager iscontained within the WOSA/XFS Software Developers Kit (SDK).

Revision Record 0

This is the initial release of the Publication.

WOSA/XFS - Programmer’s Reference ManualOverview

vi WOSA/XFS - Programmer’s Reference Manual





Chapter 1

WOSA/XFS - An Introduction 1-1What is WOSA/XFS 1-1The WOSA/XFS Architecture 1-2The XFS Manager 1-3The Service Provider 1-3Requirements For WOSA/XFS 1-4





WOSA/XFS - Programmer’s Reference ManualWOSA/XFS - An Introduction

WOSA/XFS - Programmer’s Reference Manual 1-1

1

WOSA/XFS - An Introduction 1

What is WOSA/XFS ? 1

'Windows Open Services Architecture' (WOSA), comprises a family of stable,open-ended interfaces for enterprise computing environments. These interfaceshide system complexities from users and application developers.

Using WOSA, you can seamlessly integrate Windows and Windows-basedapplications with all the services and enterprise capabilities that you need. WOSAincludes the following interfaces:

l Open Database Connectivity (ODBC) for standard access to databases.

l Messaging Application Programming Interface (MAPI) for standard access to messaging services.

l Communications support, including Windows SNA, RPC and Sockets.

The Banking Solutions Vendor Council (BSVC), an organization of leadingvendors of information technology to the financial services industry, has extendedWOSA by defining a Windows-based client-server architecture for financialapplications. These extensions, appropriately called Extensions for FinancialServices (XFS), include a set of APIs and SPIs common to multiple financialapplications.

At the time of developing this manual, WOSA/XFS includes specifications to thefollowing financial peripherals:

Device Class Class Name

Printers PTR

Identification Card Units IDC

Cash Dispensers CDM

PINpads PIN

Check Readers and Scanners CHK

Depository Units DEP

Text Terminal Units TTU

Sensors and Indicators Units SIU

Vendor Dependent Mode VDM

Cameras CAM

The Device Class InterfaceWOSA/XFS - An Introduction

1-2 WOSA/XFS - Programmer’s Reference Manual


The WOSA/XFS Architecture 1

As depicted below, WOSA/XFS, just like other WOSA elemets, defines thefollowing:

l a set of APIs

l a corresponding set of SPIs

l supporting services providing access to financial services for Windows-based applications.

WOSA Extensions for Financial Services Architecture

WOSA/XFS Manager

ServiceProviders

ConfigurationInformation

Windows-basedApplications

WOSA/XFS APIs

WOSA/XFS SPIs




The XFS Manager 1

A pre-requiste with all implementations of the WOSA/XFS is the vendor-independent XFS Manager. The application communicates with service providers,via the XFS Manager, using the API set. You can invoke most of these APIs either"synchronously" or "asynchronously".

In the former case, the Manager blocks the application until the API completes itsfunction. In the latter, the application regains control immediately. However, therequested function is performed in parallel.

The XFS Manager maps the specified API to the corresponding SPI. It then routesthis request to the appropriate service provider. The Manager uses configurationinformation to route the API that is directed at a "logical service" to the properservice provider entry point. The entry point is always local, although the finaltarget may be remote.

The Service Provider 1

The Service Provider is the vendor-dependent component of the WOSA/XFSsolution. The primary functions of the service providers are to:

l translate generic service requests to service-specific commands,

l route the requests to either a local service or device, or to one on a remote system, effectively defining a peer-to-peer interface among service providers,

l arbitrate access by multiple applications to a single service or device, providing exclusive access when requested,

l manage hardware interfaces to services or devices, and

l manage the asynchronous nature of the services and devices in an appropriate manner, always presenting this capability to the XFS Manager and the applications via Windows messages.

Look up Reference 1 for the definition of the functionality of services, of thearchitecture, and of the API and SPI sets.




Requirements For WOSA/XFS 1

Platforms

NCR supports a service provider set for the personS Platform for Windows NTD531-0300-000 running on 56XX & 58XX SSTs.

In addition, the WOSA/XFS solution requires the WOSA/XFS Manager Ver. 2.00(or above), and one or more components of the NCR WOSA/XFS Windows-NTService Provider set (Product ID:D531-0289-0000), which supports the followingdevices:

l Currency Dispenser Service Provider

l Envelope Depository/Dispenser Service Provider

l Night Safe Depository Service Provider

l Identification Card Service Provider

l Passbook Printer Service Provider

l Receipt/Journal Printer Service Provider

l Statement Printer Service Provider

l Pinpad Service Provider

l Sensors and Indicators Service Provider

l Text Terminal Service Provider

l Vendor Dependent Mode Service Provider

Application Requirements

NCR's SP set supports user-defined, WOSA compliant applications.

Hardware Requirements

The following is the minimum recommended configuration for the PC core of theSST on which the NCR Service Providers run:

56XX/58XX SSTs

l PC/AT 486 DX-2

l 32 MB RAM

l 1.44 MB FDD

l 540 MB Hard Disk

l VGA Color/Mono Monitor

l CD-ROM Drive



Chapter 2

Developing an Application Using WOSA/XFS 2-1Setting up the Development Environment 2-1Sample Application with Description 2-2Bringing in the WOSA/XFS headers and definitions 2-3Function Prototypes 2-3Functions Used 2-3Installing the SP set on an SST 2-6Installing the application on an SST 2-6Troubleshooting WOSA/XFS 2-6




WOSA/XFS - Programmer’s Reference ManualDeveloping an Application Using WOSA/XFS


2

Developing an Application Using WOSA/XFS 2

This chapter describes how to develop a WOSA/XFS application on your Self-Service Terminals.

Setting up the Development Environment 2

This section describes how to set up your PC for developing WOSA/XFSapplication. It also provides information on the different libraries, header files andthe compiler options to be used.

It is mandatory to have the following software installed in your PC before you startdeveloping a WOSA/XFS application:

l WINDOWS NT 4.00 or higher

l Microsoft Visual C++ 4.0 or higher

l WOSA/XFS Manager, version 2.XX or higher, with the followingcomponents:

Libraries:

MSXFS.LIB - Basic XFS API and SPI functionsXFS_CONF.LIB - Configuration functionsXFS_SUPP.LIB - Support functions

Header files:

XFSSPI.HXFSAPI.HXFSADMIN.HXFSCONF.H

XFSCDM.H XFSDEP.H XFSIDC.H XFSPIN.H XFSPTR.H XFSSIU.H

XFSTTU.H XFSVDM.H

Compiler Options

All structures passed to/returned by the WOSA/XFS sub-system are byte aligned.Byte alignment MUST be set to 1 either by using the #pragma pack(1) pragma, orby setting the byte alignment to 1 under the Build->Settings->Compiler->Code Generation Option.




Sample Application with Description 2

The 'C' code in the figure below illustrates how you would program yourapplication to use the WOSA/XFS API to gain control of the NCR CDM SP andmake the dispenser dispense £120. After this dispense, for the sake of the example,the application releases the SP for use by other applications and closes its sessionwith the XFS Manager. With the CDM SP locked, your application could havegone on to control a series of CDM activities. Having closed the session with theCDM, it could also have gone on and worked with other financial peripheralsbefore "cleaning up" and ending its session with the XFS manager. Note that thisapplication should be linked with MSXFS.LIB.

int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nShowCmd){

HSERVICE hService=0;BOOL fSuccess=EXIT_SUCCESS; // Default return

if(Wfs_Startup()){

// Session established with XFS Managerif(Wfs_Open(&hService)){

// Session established with CDM SPif(Wfs_Lock(hService)) // CDM SP locked for exclusive use{

Wfs_ExecuteDispense(hService);// Dispense billsWfs_Unlock(hService); // Release the CDM SP

}else // Lock failed{

fSuccess=EXIT_FAILURE;}Wfs_Close(hService);

}else // Wfs_Open failed{

fSuccess=EXIT_FAILURE;}Wfs_Cleanup();

}else // Wfs_Startup failed{

fSuccess=EXIT_FAILURE;}

return fSuccess;}




Bringing in the WOSA/XFS headers and definitions 2

Before your application could use the WOSA/XFS API to perform the taskillustrated above, you would first have to bring in the appropriate headers andmake the following definitions:

Note: RECOGNISED_VERSIONS specifies the range of service provider interface versions that can be accommodated.

Function Prototypes 2

Before you can compile the sample code the compiler requires that the followingfunction prototypes be declared:

Functions Used 2

The functions to dispense £ 120 are as follows

#include <xfscdm.h> // For the cash dispenser#include <xfsspi.h> // Service Provider interface#include <xfsadmin.h> // XFS Manager support functions

#define RECOGNISED_VERSIONS 0x00000202 // See Note#define TWO_MINUTES 02*60*1000#define TEN_MINUTES 10*60*1000#define TEN_SECONDS 10*1000#define EXIT_SUCCESS 0#define EXIT_FAILURE -1#define WFS_TRACE NONE 0

BOOL Wfs_Startup (void);BOOL Wfs_Open(LPHSERVICE lphService);BOOL Wfs_Lock(HSERVICE hService);BOOL Wfs_ExecuteDispense(HSERVICE hService);BOOL Wfs_Unlock(HSERVICE hService);BOOL Wfs_Close(HSERVICE hService);BOOL Wfs_Cleanup(void);

BOOL Wfs_Startup(void){

WFSVERSIONWfsVersion;

return (WFSStartUp(RECOGNISED_VERSIONS, &WfsVersion) == WFS_SUCCESS);

}




BOOL Wfs_Open(LPHSERVICE lphService){

WFSVERSIONSvcVersion, SpiVersion;char szLogicalName[]="CurrencyDispenser1";

return (WFSOpen (szLogicalName, // Logical nameWFS_DEFAULT_HAPP, // App handle"WOSA_TEST", // App IDWFS_TRACE_NONE, // Trace LevelTWO_MINUTES, // TimeoutRECOGNISED_VERSIONS, // Srvc Versions&SvcVersion, // Returned version&SpiVersion, // Returned SPI versionlphService // Returned service handle ) == WFS_SUCCESS);

}

BOOL Wfs_Lock(HSERVICE hService){

LPWFSRESULTlpResult=NULL;

if(WFSLock(hService, TEN_SECONDS, &lpResult) == WFS_SUCCESS){

// Free the result structure returned by SPif(WFSFreeResult(lpResult) != WFS_SUCCESS){

// Failed to free the result structurereturn FALSE;

}}else {

// WFSLock Failedreturn FALSE;

}return TRUE;

}




BOOL Wfs_ExecuteDispense(HSERVICE hService){

WFSCDMDISPENSE tDispense;WFSCDMDENOMINATION tDenomination;LPWFSRESULT lpResult=NULL;HRESULT hResult=WFS_SUCCESS;ULONG ulaValues[5];

tDispense.usTellerID = 0;tDispense.usMixNumber = WFS_CDM_INDIVIDUAL;tDispense.bPresent = TRUE;tDispense.usPosition = WFS_CDM_POSCENTER;

ulaValues[0] = 0;ulaValues[1] = 2; // 2 £5 billsulaValues[2] = 2; // 2 £10 billsulaValues[3] = 2; // 2 £20 billsulaValues[4] = 1; // 1 £50 bill

tDenomination.lpulValues = ulaValues;

strncpy(tDenomination.cCurrencyID, "GBP", 3);

tDenomination.ulAmount = 120;tDenomination.usCount = 5;tDenomination.ulCashBox = 0;tDispense.lpDenomination = &tDenomination;

hResult = WFSExecute( hService, WFS_CMD_CDM_DISPENSE,&tDispense,TWO_MINUTES,&lpResult

);

// Free the result structure allocated by the SPWFSFreeResult(lpResult);

return(hResult == WFS_SUCCESS);}

BOOL Wfs_Unlock(HSERVICE hService){

return(WFSUnlock(hService) == WFS_SUCCESS);}

BOOL Wfs_Close(HSERVICE hService){

return(WFSClose (hService) == WFS_SUCCESS);}




Note:

1 The range of the Service Provider versions that the application can support isspecified in the sixth parameter of the WFSOpen( ) call. For example, if therange is from 1.07 to 2.00, then it should be specified as 0x02000107.

2 The range of the XFS Manager versions that the application can support isfrom 1.0 to 2.0. This is specified as the first parameter in the WFSStartUp( )call.

Installing the SP set on anSST 2

NCR's WOSA/XFS Service Provider set is packaged using the Component Definition Tool and is installed in a manner similar to the Ulysses platform. To install the SP set, insert the product diskette into drive Aand run SETUP.EXE. Setup can also be invoked via the 'Add/Remove Programs' option of the Control Panel.

Once the SP set is installed, a new option Wosa_Xfs is added to NT’s Start Menu with options WOSA_XFS Install and WOSA_XFS DeInstall to update/de-install the SP set respectively.

Installing the application onan SST 2

There is nothing special about the way one installs an application on an SST.Installation consists of simply coping the necessary files to the SST disk andsetting up the environment, or using standard packaging tools to do the same.

Troubleshooting WOSA/XFS2 The following points should be borne in mind while running a WOSA/XFSapplication:

1 The path containing the Service Provider DLLs and executables must beincluded in the PATH variable. If it is not, the SPs will fail to initialize.

2 If an improper shutdown of a Service Provider occurs (the Service Providerwas not closed using WFSClose), the next attempt to startup the applicationwill fail. Although terminating the SP using ‘PVIEW’ is a quick remedy, itmay have undesirable side effects. Re-booting the SST is recommended inthese circumstances.

BOOL Wfs_Cleanup(void){

return(WFSCleanUp () == WFS_SUCCESS);}




3 Service Providers do not co-operate with the Ulysses System Application(UlSysApp.exe) in maintaining counts. The implication of this is that, if notesfor example, are dispensed using UlSysApp, then the actual count (ulCount)of notes reported by the WFS_INF_CDM_CASH_UNIT_INFO command arenot guaranteed to be accurate.

Debugging a WOSA/XFS Application 2

Extensive validation and tracing has been built into the WOSA/XFS ServiceProviders to aid the debugging of WOSA/XFS applications. All the inputparameters are validated, and errors detected are logged in a per-service providertrace file, provided that tracing has been enabled. The trace files also contain a logof the EXECUTE/GETINFO command output structure (if applicable), which issent along with the EXECUTE/GETINFO command completion message.

Tracing can be enabled in the following two ways:

l By specifying an appropriate dwTraceLevel in WFSOpen/AsyncOpen

l By using the WFMSetTraceLevel function

(For more details refer to WFSOpen/AsyncOpen & WFMSetTraceLevel APIdefinitions in Reference 1).

The trace files, whose name and location are stored in the registry underSERVICE_PROVIDERS\XXX\GENERAL_CONFIGS\TraceFileName, whereXXX is the service class (CDM, PIN, PTR etc.), are circular files with a maximumsize of 500 K Bytes. The point in the file at which the last write has occurred isfollowed by the line,

"**** WRAP STARTS FROM HERE ****"

Since tracing is a performance overhead, it is recommended that it be turned ononly while developing an application.

In addition to the trace files described above, .LOG files with names likeXXX_SPX, XXX_WFP, XXX_SPP & XXX_DBG may be created in the log filedirectory specified in the registry. These files which are created by variouscomponents of the SP, contain low level debugging information for use by NCRsupport personnel. These files should be purged periodically.




WOSA/XFS Programmer’s Reference ManualTable of Contents



Chapter 3

Device Class Interface 3-1Service Provider Components 3-1Configurable Parameters 3-1Capabilities 3-1Conformance Matrices 3-1Deviations 3-1Application Guidelines 3-1

Currency Dispenser Module 3-2

Depository 3-19

Receipt and Journal Printers 3-25

Statement Printer 3-45

Passbook Printer 3-59

Text Terminal Unit 3-76

Vendor Dependent Mode 3-92

Pinpad and Key Library 3-95

Sensors and Indicators Unit 3-136

Identity Card Unit 3-143

WOSA/XFS Programmer’s Reference ManualTable of Contents




WOSA/XFS - Programmer’s Reference ManualDevice Class Interface


3

Device Class Interface 3

This chapter describes the NCR Service Providers from various perspectives. Theinformation presented here is not intended to be used in isolation, but together withthe WOSA/XFS Device Class Interface Specifications, published by the BSVC.

Each device class description has the following sections:

Service Provider

Configurable Parameters 3

Capabilities 3

Conformance Matrices 3

These matrices tabulate the interpretation of the WOSA specifications for theCommands, Errors and Events. A Conformance Level assigned to eachcommand/error/event, that indicates the extent to which the command/error/eventconforms to the specifications. Conformance levels can take values 2 (fullycompliant), through 1 (compliant with some deviations) to 0 (not supported).

Note: 'Conformance Level' is abbreviated as 'CL' throughout these tables.

Deviations 3

Application Guidelines 3

This section provides tips/guidelines to application developers.

WOSA/XFS - Programmer’s Reference ManualCurrency Dispenser Module



Currency Dispenser Module 3

Service Provider Components 3

3

Default Logical Service Names 3

3

Device DLL Name SP Executable

Currency Dispenser cdm_spx.dllcdm_wfp.dllcdm_ipc.dllcdm.dll

cdm.exe

Logical Name Description

CurrencyDispenser1 The logical name of CDM service provider

Currency Dispenser Module

3-3

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

\CD

M k

ey:

Par

amet

er

Des

crip

tion

Per

mis

sibl

e V

alue

s

GE

NE

RA

L_C

ON

FIG

S\M

axB

ills

Max

imu

m n

umb

er o

f n

ote

s th

at t

he

dis

pen

ser

can

dis

pen

se.

Co

nfig

ura

ble

onl

y on

56

XX

an

d5

8X

X s

erie

s m

ach

ines

.

Pe

rmis

sib

le

valu

es

ran

ge

fro

m

40

b

ills

to

am

axi

mum

o

f 5

0 bi

lls.

Def

au

lts

to

40

ifn

ot/i

nco

rre

ctly

sp

ecifi

ed.

Sp

ecify

ing

a v

alue

gre

ate

r th

an 4

0 m

ust

on

ly b

eu

sed

wh

ere

th

e c

urr

ency

ha

s be

en p

re-q

ual

ified

fo

rth

at

num

ber

on

th

e

Cur

renc

y D

isp

ense

r d

evic

e.O

the

rwis

e th

is

may

le

ad

to

serio

usl

y d

egra

ded

per

form

anc

e fr

om t

he

curr

en

cy d

isp

ense

r.

GE

NE

RA

L_C

ON

FIG

S\S

usp

end

Tim

eou

tD

ura

tion

in

m

inu

tes,

fo

r w

hic

h

the

d

evic

esh

ou

ld b

e s

usp

end

ed w

hen

use

r ta

mp

erin

g is

susp

ecte

d.

1-1

5 m

inu

tes

with

a d

efa

ult

of

5 m

inut

es.

GE

NE

RA

L_C

ON

FIG

S\C

urr

en

cyID

Typ

e1-

4U

sed

inte

rnal

ly b

y th

e S

P to

sto

re th

e C

urr

ency

d

eno

min

atio

n o

f th

e n

otes

in c

ass

ett

es 1

-4.

Ma

y b

e p

re-s

et

for

app

lica

tions

tha

t d

o n

ot

issu

e a

W

FS

_C

MD

_C

DM

_S

ET

_C

AS

H_

UN

IT_

INF

O

or

a W

FS

_CM

D_

CD

M_

EN

D_

EX

CH

AN

GE

co

mm

and

pri

or

to p

erfo

rmin

g a

W

FS

_CM

D_

CD

M_

DE

NO

MIN

AT

E o

r a

W

FS

_CM

D_

CD

M_

DIS

PE

NS

E.

Cu

rre

ncy

IDs

as s

pec

ified

by IS

O.

No

te t

hat

no

er

ror

chec

kin

g is

pe

rfo

rme

d o

n t

his

str

ing

.

GE

NE

RA

L_C

ON

FIG

S\V

alu

esT

ype

1-4

Use

d in

tern

ally

by

the

SP

to s

tore

the

Cu

rren

cy

den

om

inat

ion

of

the

not

es in

ca

sse

ttes

1-4

.

ID o

f th

e n

ote

s in

ca

sse

ttes

1-4

. M

ay b

e p

re-s

etfo

r ap

plic

atio

ns

tha

t do

n

ot

issu

e a

WF

S_C

MD

_C

DM

_S

ET

_C

AS

H_U

NIT

_IN

FO

or

a

WF

S_

CM

D_

CD

M_E

ND

_E

XC

HA

NG

Eco

mm

and

p

rior

to

pe

rfo

rmin

g

aW

FS

_CM

D_

CD

M_

DE

NO

MIN

AT

E o

r a

W

FS

_CM

D_

CD

M_

DIS

PE

NS

E.

Valu

e o

f b

ills

in c

asse

tte

typ

es

1-4

.


3-4

Cap

abili

ties

3

Cap

abili

tyV

alue

Log

ica

l Ser

vice

Cla

ssW

FS

_S

ER

VIC

E_

CL

AS

S_

CD

M

Typ

e O

f P

hys

ical

De

vice

WF

S_

CD

M_

TY

PE

AT

MA

CH

INE

Ma

xBill

s4

0-5

0

Ma

xCo

ins

0

Co

mp

ou

nd D

evic

eFA

LS

E

Sh

utte

rFA

LS

E

Ret

ract

(M

ech

anis

m)

TR

UE

Sa

fe D

oor

FAL

SE

Co

ins

FAL

SE

Cyl

ind

ers

FAL

SE

Cas

hBo

xFA

LS

E

Cas

hIn

FAL

SE

Ref

illFA

LS

E

Au

toD

ep

osi

tFA

LS

E

Van

dal

Che

ckT

RU

E

Inte

rme

dia

teS

tack

er

TR

UE

Bill

sTa

ken

Se

nsor

TR

UE

Ou

tpu

tPo

sitio

nsW

FS

_C

DM

_P

OS

CE

NT

ER


3-5

Con

form

ance

Mat

rix -

Com

man

ds

3

WO

SA

Com

man

dC

LC

omm

ents

WF

S_

INF

_CD

M_

STA

TU

S2

lfw

Devi

ce o

f W

FS

_C

DM

_D

EV

PO

WE

RO

FF,

WF

S_

CD

M_

DE

VB

US

Y a

nd

WF

S_

CD

M_

DE

VN

OD

EV

ICE

are

nev

er r

etur

ne

d.

lfw

Sa

feD

oor

is a

lwa

ys W

FS

_C

DM

_DO

OR

NO

TS

UP

PO

RT

ED

.

lfw

Dis

pen

ser r

efle

cts

the

sta

te o

f th

e d

ispe

nse

r ca

sh u

nit

as

of t

he

las

tex

ecu

te c

omm

an

d th

at

had

de

vice

inte

ract

ion.

llp

pO

utp

utP

osi

tion

s->

fwP

osi

tion is

alw

ays

WF

S_

CD

M_P

OS

CE

NT

ER

.

llp

pO

utp

utP

osi

tion

s->

fwS

hutt

er

will

be

WF

S_C

DM

_S

HT

UN

KN

OW

N i

fth

e d

evic

e w

as

off-

line

wh

en t

he

com

man

d w

as

issu

ed

.

llp

pO

utp

utP

osi

tion

s->

fwO

utp

utP

osi

tion is

alw

ays

W

FS

_C

DM

_C

TN

OT

SU

PP

OR

TE

D.

llp

pO

utp

utP

osi

tion

s->

fwT

ran

spor

t w

ill b

e W

FS

_C

DM

_T

PU

NK

NO

WN

if

the

dev

ice

wa

s o

ff-lin

e w

hen

th

e co

mm

and

wa

s is

sue

d.

WF

S_

INF

_CD

M_

CA

PA

BIL

ITIE

S2

No

ne

WF

S_

INF

_CD

M_

CA

SH

_U

NIT

_IN

FO

2l

usN

um

be

r, th

e lo

gic

al n

um

ber

of

the

cas

h u

nit,

beg

ins

at 0

fo

r th

e st

ruct

ure

poin

ted

to b

y th

e fir

st e

lem

ent

of lpp

Lis

t. T

his

val

ue

is a

lso

, im

plic

itly,

the

typ

e o

f th

e c

ash

un

it st

ruct

ure

. T

here

fore

, if

ther

e a

re n

o c

ash

un

its o

f ty

pe1,

th

ere

will

stil

l b

e a

cash

un

it st

ruct

ure

re

turn

ed f

or

typ

e 1

(a

ltho

ugh

it

will

sp

eci

fy t

hat

this

ca

sh u

nit

typ

e i

s m

issi

ng)

. T

he

Pu

rge

bin

is

the

first

elem

ent

in t

he

arr

ay

as it

do

es n

ot h

ave

a l

og

ical

Typ

e l

ike

th

e r

est

of

the

cass

ette

s.

lcU

nitI

D is

no

t u

sed

.

llp

pL

ist-

>u

sSta

tus

of

WF

S_

CD

M_

STA

TC

UN

OVA

L an

dW

FS

_C

DM

_S

TAT

CU

NO

RE

F a

re n

eve

r re

turn

ed

.

llp

pL

ist-

>lp

Ph

ysic

alP

ositi

on

Na

me in

dica

tes

the

na

me

an

d p

osi

tion

of

the

phys

ica

l ca

sh u

nit,

wh

en t

her

e is

on

ly o

ne

ph

ysic

al c

asse

tte

ass

oci

ate

d w

ithth

e lo

gic

al c

ass

ette

.

llp

pL

ist-

>lp

pPh

ysic

al->

ulC

ou

nt is

alw

ays

zero

(0

).

WF

S_

INF

_CD

M_

TE

LLE

R_

INF

O0

No

ne

WF

S_

INF

_CD

M_

TE

LLE

R_

PO

SIT

ION

S0

No

ne

WF

S_

INF

_CD

M_

CU

RR

EN

CY

_E

XP

2T

his

com

ma

nd

retu

rns

the

cu

rren

cy e

xpo

nen

t st

ruct

ure

s o

f th

e cu

rren

cie

s sp

eci

fied

the

cu

rren

cy e

xpo

nen

ts f

ile.

(Re

fer

Ap

plic

atio

n G

uid

elin

es.

)


3-6

WF

S_

INF

_CD

M_

MIX

_T

YP

ES

2In

th

e c

ase

of

Mix

Tab

les

(u

sMix

Typ

e =

WF

S_

CD

M_

MIX

TAB

LE),

usS

ub

Typ

e is

alw

ays

0. T

his

is b

ecau

se c

om

man

d W

FS

_CM

D_

CD

M_

SE

T_

MIX

_TA

BL

E,

has

no

pro

visi

on

to

sp

eci

fy

wh

eth

er

the

Mix

Tab

le

is

of

the

WF

S_

CD

M_

MIX

_M

INIM

UM

_N

UM

BE

R_

OF

_BIL

LS

ty

pe

or

the

WF

S_

CD

M_

MIX

_E

QU

AL

_EM

PT

YIN

G_

OF

_C

AS

H_

UN

ITS

typ

e.

WF

S_

INF

_CD

M_

MIX

_TA

BLE

2us

Co

ls is

alw

ays

4,

as

the

re a

re 4

typ

es o

f ca

sh u

nits

su

ppo

rte

d b

y th

e 5

6X

Xdi

spe

nser

.

WF

S_

INF

_CD

M_

PR

ES

EN

T_S

TAT

US

2N

one

WF

S_

CM

D_

CD

M_

DE

NO

MIN

ATE

1l

usTe

llerI

D is

not

use

d.

llp

De

nom

inat

ion

->u

sCo

unt m

ust

alw

ays

be

5.

llp

De

nom

inat

ion

->u

lVa

lues[

], th

e va

lue

of

note

s to

be

den

om

ina

ted

, sh

ou

ld b

esp

ecifi

ed i

n t

he

ord

er r

etu

rned

by

the

WF

S_

INF

_C

DM

_C

AS

H_U

NIT

_IN

FO

com

man

d.

Hen

ce,

the

fir

st e

lem

ent

of

the

arra

y sh

ou

ld a

lway

s b

e 0

for

the

Re

ject

Bin

, th

e se

con

d s

ho

uld

ind

icat

e th

e n

um

be

r o

f n

ote

s fr

om

ca

sse

tte

typ

e 1

and

so

on

.

llp

De

nom

inat

ion

->u

lCa

shB

ox m

ust

alw

ays

be

zero

(0)

.

WF

S_

CM

D_

CD

M_

DIS

PE

NS

E1

lus

Telle

rID

is n

ot u

sed

.

lus

Po

sitio

n is

ign

ore

d a

s th

ere

is o

nly

on

e di

spe

nse

po

sitio

n.

llp

De

nom

inat

ion

->u

sCo

unt m

ust

alw

ays

be

5.

llp

De

nom

inat

ion

->u

lVa

lues[

], th

e v

alu

e o

f n

ote

s to

be

dis

pen

sed,

sh

oul

d b

esp

ecifi

ed i

n t

he

ord

er r

etu

rned

by

the

WF

S_

INF

_C

DM

_C

AS

H_U

NIT

_IN

FO

com

man

d.

Hen

ce,

the

fir

st e

lem

ent

of

the

arra

y sh

ou

ld a

lway

s b

e 0

for

the

Re

ject

Bin

, th

e se

con

d s

ho

uld

ind

icat

e th

e n

um

be

r o

f n

ote

s fr

om

ca

sse

tte

typ

e 1

and

so

on

.

llp

De

nom

inat

ion

->u

lCa

shB

ox m

ust

alw

ays

be

zero

(0)

.

WF

S_

CM

D_

CD

M_

PR

ES

EN

T2

No

ne

WF

S_

CM

D_

CD

M_

RE

JEC

T2

No

ne

WF

S_

CM

D_

CD

M_

RE

TR

AC

T2

lpu

sRetr

act

Are

a is ig

no

red

as

ther

e is

on

ly o

ne r

eje

ct b

in.

WF

S_

CM

D_

CD

M_

CA

SH

_IN

0N

one

WF

S_

CM

D_

CD

M_

OP

EN

_SH

UT

TE

R0

No

ne

WO

SA

Com

man

dC

LC

omm

ents


3-7

WF

S_

CM

D_

CD

M_

CLO

SE

_S

HU

TT

ER

0N

one

WF

S_

CM

D_

CD

M_

SE

T_

TE

LLE

R_

INF

O0

No

ne

WF

S_

CM

D_

CD

M_

SE

T_

CA

SH

_U

NIT

_IN

FO

2l

usTe

llerI

D is

ign

ore

d

lus

Co

un

t sh

oul

d a

lwa

ys b

e 5

.

llp

pL

ist-

>u

sNu

mb

er, th

e lo

gic

al

nu

mb

er

of

the

ca

sh u

nit,

beg

ins

at 0

fo

r th

est

ruct

ure

po

inte

d to

by

the

firs

t e

lem

ent

of

lpp

Lis

t. T

his

valu

e is

als

o, i

mp

licitl

y,th

e ty

pe o

f th

e c

ash

un

it st

ruct

ure

. Th

ere

fore

, if t

he

re a

re n

o c

ash

un

its o

f typ

e 1

,th

ere

will

stil

l be

a c

ash

uni

t st

ruct

ure

fo

r ty

pe 1

(al

tho

ugh

it

will

sp

ecify

th

atth

is c

ash

uni

t ty

pe

is m

issi

ng

). T

he R

ejec

t B

in is

co

nsi

de

red

as

Typ

e 0

, he

nce

itco

rres

po

nd

s to

the

fir

st s

tru

ctu

re p

oin

ted

to

by

lppL

ist.

llp

pL

ist-

>cU

nitI

D is

no

t u

sed

.

lS

tru

ctu

re lp

pL

ist-

>lp

pP

hys

ical

is ig

no

red

.

WF

S_

CM

D_

CD

M_

STA

RT

_E

XC

HA

NG

E2

lIn

pu

t st

ruct

ure

WF

SC

DM

STA

RT

EX

is ig

no

red

.

lus

Telle

rID

shou

ld b

e ig

no

red

.

lus

Co

un

t is a

lwa

ys 5

.

llp

pL

ist-

>lp

Ph

ysic

alP

ositi

on

Na

me ref

lect

s th

e n

ame

of

the

Ph

ysic

al C

asse

tte

ifth

e lo

gic

al c

ass

ette

re

fers

to

on

e p

hys

ical

cas

sett

e.

llp

pL

ist-

>lp

pPh

ysic

al->

ulC

ou

nt w

ill a

lwa

ys b

e z

ero

(0

).

WF

S_

CM

D_

CD

M_

EN

D_E

XC

HA

NG

E2

lus

Telle

rID

is ig

no

red

.

lus

Co

un

t mu

st a

lwa

ys b

e 5

.

llp

pL

ist-

>u

sNu

mb

er, th

e lo

gic

al

nu

mb

er

of

the

ca

sh u

nit,

beg

ins

at 0

fo

r th

est

ruct

ure

po

inte

d to

by

the

firs

t e

lem

ent

of

lpp

Lis

t. T

his

valu

e is

als

o, i

mp

licitl

y,th

e ty

pe o

f th

e c

ash

un

it st

ruct

ure

. Th

ere

fore

, if t

he

re a

re n

o c

ash

un

its o

f typ

e 1

,th

ere

will

stil

l be

a c

ash

uni

t st

ruct

ure

fo

r ty

pe 1

(al

tho

ugh

it

will

sp

ecify

th

atth

is c

ash

un

it ty

pe

is m

issi

ng

). T

he

Re

ject

Bin

is c

onsi

der

ed

as

Typ

e 0

.

llp

pL

ist-

>cU

nitI

D is

no

t u

sed

.

lS

tru

ctu

re lp

pL

ist-

>lp

pP

hys

ical

is ig

no

red

.

WF

S_

CM

D_

CD

M_

OP

EN

_SA

FE

_D

OO

R0

No

ne

WF

S_

CM

D_

CD

M_

CH

EC

K_

VAN

DA

LIS

M2

No

ne

WO

SA

Com

man

dC

LC

omm

ents


3-8

WF

S_

CM

D_

CD

M_

CA

LIB

RAT

E_

CA

SH

_U

NIT

2l

usN

um

be

r ass

um

es v

alu

es f

rom

1 t

o 4

co

rres

pon

din

g to

the

Typ

e o

f the

ca

sse

tte

that

ne

eds

to b

e c

onf

igur

ed

.

lus

Nu

mO

fBill

s, th

e m

axim

um

num

ber

of

bill

s th

at

can

be

use

d t

o c

on

figu

re t

he

cass

ette

is 4

0.

WF

S_

CM

D_

CD

M_

SE

T_

TE

LLE

R_

PO

SIT

ION

S0

No

ne

WF

S_

CM

D_

CD

M_

CA

SH

_IN

_S

TAR

T0

No

ne

WF

S_

CM

D_

CD

M_

CA

SH

_IN

_E

ND

0N

one

WF

S_

CM

D_

CD

M_

CA

SH

_IN

_R

OL

LBA

CK

0N

one

WF

S_

CM

D_

CD

M_

SE

T_

MIX

_TA

BLE

1l

If th

e S

ST

file

sys

tem

is

FAT

, th

e m

ixta

ble

file

nam

e lp

szN

am

e, sh

ou

ld n

ot

exce

ed e

igh

t ch

arac

ters

.

lus

Ro

ws c

ann

ot

exce

ed 5

00.

lus

Co

ls m

ust

alw

ays

be

4 as

th

ere

a 4

Typ

es o

f ca

sh u

nits

.

WO

SA

Com

man

dC

LC

omm

ents


3-9

Con

form

ance

Mat

rix -

Err

ors

3

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_

INF

_CD

M_

STA

TU

SN

one

2N

one

WF

S_

INF

_CD

M_

CA

PA

BIL

ITIE

SN

one

2N

one

WF

S_

INF

_CD

M_

CA

SH

_U

NIT

_IN

FO

No

ne2

No

ne

WF

S_

INF

_CD

M_

CU

RR

EN

CY

_E

XP

No

ne2

No

ne

WF

S_

INF

_CD

M_

MIX

_T

YP

ES

No

ne2

No

ne

WF

S_

INF

_CD

M_

MIX

_TA

BLE

WF

S_

ER

R_

CD

M_

INVA

LID

MIX

NU

MB

ER

2N

one

WF

S_

INF

_CD

M_

PR

ES

EN

T_S

TAT

US

No

ne2

No

ne

WF

S_

CM

D_

CD

M_

DE

NO

MIN

ATE

WF

S_

ER

R_

CD

M_

CA

SH

UN

ITE

RR

OR

2N

one

WF

S_

ER

R_

CD

M_

EX

CH

AN

GE

AC

TIV

E2

No

ne

WF

S_

ER

R_

CD

M_

INVA

LID

CU

RR

EN

CY

2N

one

WF

S_

ER

R_

CD

M_

INVA

LID

DE

NO

MIN

AT

ION

2N

one

WF

S_

ER

R_

CD

M_

INVA

LID

MIX

NU

MB

ER

2N

one

WF

S_

ER

R_

CD

M_

TE

LLE

RID

0N

ot

supp

ort

ed

WF

S_

ER

R_

CD

M_

NO

CU

RR

EN

CY

MIX

2N

one

WF

S_

ER

R_

CD

M_

NO

TD

ISP

EN

SA

BLE

2N

one

WF

S_

ER

R_

CD

M_

TO

OM

AN

YB

ILLS

2N

one

WF

S_

ER

R_

CD

M_

TO

OM

AN

YC

OIN

S0

No

t su

ppo

rte

d

WF

S_

CM

D_

CD

M_

DIS

PE

NS

EW

FS

_E

RR

_C

DM

_C

AS

HU

NIT

ER

RO

R2

No

ne

WF

S_

ER

R_

CD

M_

EX

CH

AN

GE

AC

TIV

E2

No

ne

WF

S_

ER

R_

CD

M_

INVA

LID

CU

RR

EN

CY

2N

one

WF

S_

ER

R_

CD

M_

INVA

LID

DE

NO

MIN

AT

ION

2N

one

WF

S_

ER

R_

CD

M_

INVA

LID

MIX

NU

MB

ER

2N

one

cont

inu

ed

...


3-10

WF

S_

CM

D_

CD

M_

DIS

PE

NS

EW

FS

_E

RR

_C

DM

_IN

VAL

IDP

OS

ITIO

N0

No

t su

ppo

rte

d

WF

S_

ER

R_

CD

M_

INVA

LID

TE

LLE

RID

0N

ot

supp

ort

ed

WF

S_

ER

R_

CD

M_

NO

CU

RR

EN

CY

MIX

2N

one

WF

S_

ER

R_

CD

M_

NO

TD

ISP

EN

SA

BLE

2N

one

WF

S_

ER

R_

CD

M_

PO

SIT

ION

LO

CK

ED

2N

one

WF

S_

ER

R_

CD

M_

SA

FE

DO

OR

OP

EN

0N

ot

supp

ort

ed

WF

S_

ER

R_

CD

M_

TO

OM

AN

YB

ILLS

2N

one

WF

S_

ER

R_

CD

M_

TO

OM

AN

YC

OIN

S0

No

t su

ppo

rte

d

WF

S_

CM

D_

CD

M_

PR

ES

EN

TW

FS

_E

RR

_C

DM

_E

XC

HA

NG

EA

CT

IVE

2N

one

WF

S_

ER

R_

CD

M_

NO

BIL

LS2

No

ne

WF

S_

ER

R_

CD

M_

SH

UT

TE

RN

OT

OP

EN

2N

one

WF

S_

ER

R_

CD

M_

SH

UT

TE

RO

PE

N2

No

ne

WF

S_

ER

R_

CD

M_

PR

ER

RO

RN

OB

ILLS

2N

one

WF

S_

ER

R_

CD

M_

PR

ER

RO

RB

ILLS

0N

ot

supp

ort

ed

WF

S_

ER

R_

CD

M_

PR

ER

RO

RU

NK

NO

WN

2N

one

WF

S_

CM

D_

CD

M_

RE

JEC

TW

FS

_E

RR

_C

DM

_E

XC

HA

NG

EA

CT

IVE

2N

one

WF

S_

ER

R_

CD

M_

NO

BIL

LS0

No

t su

ppo

rte

d

WF

S_

CM

D_

CD

M_

RE

TR

AC

TW

FS

_E

RR

_C

DM

_B

ILLS

TAK

EN

2N

one

WF

S_

ER

R_

CD

M_

EX

CH

AN

GE

AC

TIV

E2

No

ne

WF

S_

ER

R_

CD

M_

INVA

LID

RE

TR

AC

T0

No

ne

WF

S_

ER

R_

CD

M_

SH

UT

TE

RN

OT

CL

OS

ED

2N

one

WF

S_

ER

R_

CD

M_

NO

BIL

LS2

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-11

WF

S_

CM

D_

CD

M_

SE

T_

CA

SH

_U

NIT

_IN

FO

WF

S_

ER

R_

CD

M_

CA

SH

UN

ITE

RR

OR

0N

one

WF

S_

ER

R_

CD

M_

INVA

LID

CA

SH

UN

IT2

No

ne

WF

S_

ER

R_

CD

M_

INVA

LID

TE

LLE

RID

0N

one

WF

S_

ER

R_

CD

M_

EX

CH

AN

GE

AC

TIV

E2

No

ne

WF

S_

CM

D_

CD

M_

STA

RT

_E

XC

HA

NG

EW

FS

_E

RR

_C

DM

_E

XC

HA

NG

EA

CT

IVE

2N

one

WF

S_

ER

R_

CD

M_

INVA

LID

TE

LLE

RID

0N

one

WF

S_

CM

D_

CD

M_

EN

D_E

XC

HA

NG

EW

FS

_E

RR

_C

DM

_N

OE

XC

HA

NG

EA

CT

IVE

2N

one

WF

S_

ER

R_

CD

M_

INVA

LID

CA

SH

UN

IT2

No

ne

WF

S_

ER

R_

CD

M_

INVA

LID

TE

LLE

RID

0N

one

WF

SC

MD

_CD

M_

CH

EC

K_

VAN

DA

LIS

MW

FS

_E

RR

_C

DM

_E

XC

HA

NG

EA

CT

IVE

2N

one

WF

S_

CM

D_

CD

M_

CA

LIB

RAT

E_

CA

SH

_U

NIT

WF

S_

ER

R_

CD

M_

EX

CH

AN

GE

AC

TIV

E2

No

ne

WF

S_

ER

R_

CD

M_

CA

SH

UN

ITE

RR

OR

2N

one

WF

S_

CM

D_

CD

M_

SE

T_

MIX

_TA

BLE

WF

S_

ER

R_

CD

M_

INVA

LID

MIX

NU

MB

ER

2N

one

WF

S_

ER

R_

CD

M_

INVA

LID

MIX

TAB

LE2

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-12

Con

form

ance

Mat

rix -

Eve

nts

3

WO

SA

Eve

ntC

LC

omm

ents

WF

S_S

RV

E_

CD

M_S

AF

ED

OO

RO

PE

N0

No

ne

WF

S_S

RV

E_

CD

M_S

AF

ED

OO

OR

CL

OS

ED

0N

on

e

WF

S_

US

RE

_C

DM

_C

AS

HU

NIT

TH

RE

SH

OL

D2

Thi

s e

ven

t is

ge

nera

ted

wh

en

the

nu

mb

er

of

no

tes

in

a cu

rre

ncy

ca

sset

te

falls

be

low

ulM

inim

um

fo

r th

at c

asse

tte

. It

is a

lso

ge

ner

ate

dw

he

n th

e h

ard

wa

re d

ete

cts

a c

ass

ette

lo

w o

nb

ills.

In

th

e ca

se

of

the

Re

ject

C

ass

ett

e, t

he

eve

nt

is g

en

erat

ed w

hen

th

e n

um

be

r o

f n

ote

s in

the

Re

ject

B

in

exce

eds

ulM

axi

mu

m o

f th

eR

eje

ct C

asse

tte

.

WF

S_S

RV

E_

CD

M_C

AS

HU

NIT

INF

OC

HA

NG

ED

2N

on

e

WF

S_S

RV

E_

CD

M_T

EL

LER

INF

OC

HA

NG

ED

0N

on

e

WF

S_E

XE

E_

CD

M_D

ELA

YE

DD

ISP

EN

SE

0N

on

e

WF

S_E

XE

E_

CD

M_S

TA

RT

DIS

PE

NS

E0

No

ne

WF

S_E

XE

E_

CD

M_C

AS

HU

NIT

ER

RO

R2

No

ne

WF

S_S

RV

E_

CD

M_B

ILLS

TA

KE

N2

No

ne

WF

S_E

XE

E_

CD

M_P

AR

TIA

LDIS

PE

NS

E0

No

ne

WF

S_

EX

EE

_C

DM

_SU

BD

ISP

EN

SE

OK

0N

on

e

WF

S_

EX

EE

_C

DM

_IN

PU

TR

EF

US

E0

No

ne





1 Data concerning cassette types, currencies, values and note counts arepersistent across sessions. They can be set at any time using the either of thefollowing commands:WFS_CMD_CDM_END_EXCHANGE orWFS_CMD_CDM_SET_CASH_UNIT_INFO Since the default values for these quantities are inappropriate for a workingsystem, an application should be capable of performing either of thefollowing:WFS_CMD_CDM_END_EXCHANGE or WFS_CMD_CDM_SET_CASH_UNIT_INFO. This has to be performed when you run the application for the first time, afterthe dispenser NVRAM has been cleared or the relevant registry entries havebeen deleted.

2 Developers should be careful of the following three hardware related issuesthat have a bearing on the accuracy of cash totals:

l The CDM will regard a cassette as empty if it has a low level of cash andif it fails to pick a note successfully.

l If a cassette containing n notes has exactly n notes picked up i.e. it isemptied of notes, the CDM will not detect that the cassette as empty untilthe next attempt to pick the notes is made.

l The CDM cannot determine the number of notes present in a cassette.This implies that there is no way for the SP to be 100% accurate abouthow many notes are in the CDM. However, the counts will be accurate.

The implications regarding the behaviour of the SPI are significant. If theSP-maintained totals differ from the apparent state of the cassette, then ithas to be resolved. If the firmware detects a cassette as empty, thecassette's usStatus field (in the WFSCDMCASHUNIT structure) will beset to WFS_CDM_STATCUEMPTY. If there is a discrepancy betweenthe two, the ulCount data could be non-zero. The hardware cannotguarantee that either of the totals is accurate.

3 The WFS_INF_CDM_CURRENCY_EXP command returns an array ofpointers to the structures giving the currency exponent for the currency ineach of these structures. This information is not maintained within the SP, butis stored in an external Currency Exponents file called "currency.exp" bydefault. Alternatively, a name could be created in the registry, such asWOSA/XFS\SERVICE_PROVIDERS\CDM\EXPONENTS\Filename,whichcontains the path\name of the currency exponents file. This file should containonly one currency and exponent on a line. A sample exponents file is shownbelow.




4 The WFS_INF_CDM_MIX_TABLE command retrieves the house mix tablespecified by the input parameter lpusMixNumber as a pointer to aWFSCDMMIXTABLE structure. The SP maintains house mix tables as flatfiles, whose names are stored in the Windows NT registry as values under the“WOSA/XFS\SERVICE_PROVIDERS\CDM\MixTable” key. A sample isgiven below:

The application refers to a particular mix table by setting lpszName (in structures WFSCDMMIXTABLE/ WFSCDMMIXTYPE) to the name of the mix table file.

During initialization, the SP reads and validates the mix tables, and if noerrors are encountered, adds them to an internal database. Mix tables thatcontain either format or content errors, are discarded and will not be availableto the application.

If the “MixTable” key does not exist, or if there are no values under it, then nomix tables are available to the application immediately after startup. Theapplication should use the WFS_CMD_CDM_SET_MIX_TABLE commandto define them. When this is done, the SP creates a new mix table file and addsthis file name to the Windows Registry. The application may also use the

; Lines beginning with semi-colons, and blank lines are ignored. Each line; should be of the form:; XXX: n; where XXX is the three-letter ISO currency ID and n is the (signed) exponent.; If less than three letters are used, spaces should not be inserted.;; Only one currency and exponent is allowed per line. However, the number ; of exponents is limited only by system resources.

; The SP performs no consistency checking on this file. So, if multiple; definitions are included, both will be read and both will be presented by; the WFS_INF_CDM_CURRENCY_EXP function. The SP will, however, perform a syntax; check (if the file is found) and will fail to initialize if an error is found. GBP:0DEM:-2 LIT:2

Level 1 WOSA/XFS\

Level 2 SERVICE_PROVIDERS\

Level 3 CDM\

Level 4 MixTable\Mixtable1 = <File Name 1>..Mixtable i = <File Name i >




WFS_CMD_CDM_SET_MIX_TABLE command to modify an existing mixtable.

The following is a sample mix table file:

5 A WFS_CMD_CDM_REJECT command must be performed after anyFATAL device faults are cleared by operator intervention.

6 If the Currency Dispenser is configured, there is no need to calibrate thedevice. If the device is not configured, the application should issue aWFS_CMD_CDM_CALIBRATE_CASH_UNIT command on initial power-up. If this is not done, the Bill Widths and Singularities will be set to default(Bill width will be set to USA test dollar width and singularity to 0FFH). Thisensures that ALL bills are rejected prior to the correct configuration.

7 Bills of the same type but with different widths, (for example old style andnew issue bills, should be put in different cassette types. The different sizescan then be configured using theWFS_CMD_CDM_CALIBRATE_CASH_UNIT command.

8 The transaction time for a dispense can be reduced if an application performsa STACK (WFS_CMD_CDM_DISPENSE with bPresent = FALSE) followedby a PRESENT instead of performing a WFS_CMD_CDM_DISPENSE withbPresent = TRUE, when there are operations which can be done between the

COMMENT: Lines beginning with the keyword comment are ignored.COMMENT: MIXNUMBER should be unique for each mix table and greaterCOMMENT: than 2. (0-2 are predefined algorithms). COMMENT: A mix table must define all 4 MIXHEADER columns. If lessCOMMENT: than 4 cash units are used, the values in the unused COMMENT: column should be equated to zero.COMMENT: A mix table can have a maximum of 500 rows. NAME: MixTble3MIXNUMBER: 3ROWS: 10COLS: 4MIXHEADER: 500; 100; 50; 10;AMOUNT: 500; 1; 0; 0; 0;AMOUNT: 1000; 2; 0; 0; 0;AMOUNT: 1500; 2; 5; 0; 0;AMOUNT: 2000; 4; 0; 0; 0;AMOUNT: 2000; 0; 20; 0; 0;AMOUNT: 2500; 4; 5; 0; 0;AMOUNT: 2500; 4; 0; 10; 0;AMOUNT: 3000; 6; 0; 0; 0;AMOUNT: 3000; 0; 30; 0; 0;AMOUNT: 3500; 7; 0; 0; 0;END:




STACK and PRESENT commands. If this is done, the STACK command willmove the bills to a position near the exit after it has reported the response tothe STACK command. This reduces the time to PRESENT the bills.

9 The STACK can be optimized by carefully selecting the pick module whereeach cassette will be inserted. The cassette type with most bills picked pertransaction should be inserted in the top pick module. The cassette type withthe least bills picked per transaction should be placed in the bottom pickmodule. If no cassette type is to be used more than any other, the cassettesshould be so arranged that the one to be picked first is in the top pick moduleand the cassette to be picked from next is below it.

10 The CDM SP and device drivers attempt to recover from shutter jamconditions. If after repeated attempts, the error condition persists, the devicegoes into a fatal state. A condition that can be cleared only by operatorintervention via the VDM. The following table lists the error conditions fromwhich the SP attempts to recover, and the action to be taken for othercommonly occurring errors.


3-17

Err

or C

ondi

tion

Rec

over

y A

ctio

n

Exi

t S

hut

ter

Jam

me

d C

lose

d p

rior

to

a P

rese

nt

If in

a P

rese

nt

seq

uen

ce t

he

exit

shut

ter

is j

amm

ed

sh

ut,

or

forc

ed

ope

n w

hile

the

bill

s a

re m

ovi

ng

tow

ard

s th

e e

xit,

th

e b

ills

are

pur

ge

d a

nd

thre

e sh

utt

er

reco

very

att

emp

ts a

re m

ade

. If

th

e sh

utt

er

still

fails

to

op

era

te o

n t

he r

etr

ies,

th

e C

DM

SP

en

ters

a s

uspe

nd

sta

te f

or

'Su

spe

ndT

imeo

ut'

min

ute

s,d

urin

g

wh

ich

a

ll C

DM

co

mm

an

ds

that

h

ave

de

vice

in

tera

ctio

n

will

re

turn

WF

S_

ER

R_

DE

V_N

OT

_R

EA

DY

.O

n e

xpiry

of

this

pe

riod

, th

e C

DM

SP

will

atte

mpt

to

cle

ar t

he

tra

nsp

ort

, an

d if

su

cces

sfu

l, re

sum

es

nor

mal

op

era

tion

. If

the

sh

utte

r co

ntin

ues

to

rem

ain

jam

me

d, t

he

SP

will

att

em

pt

to c

lear

th

e er

ror

onc

e ag

ain

. If

this

att

emp

t fa

ils,

the

devi

ce g

oe

s in

to a

fat

al s

tate

, fo

llow

ing

wh

ich

, al

l co

mm

and

sis

sued

to

th

e d

evi

ce w

ill r

etu

rn W

FS

_E

RR

_H

AR

DW

AR

E_

ER

RO

R.

Rec

ove

ry n

ow

re

qui

res

op

erat

or

inte

rve

ntio

n vi

a V

DM

.

Exi

t S

hu

tter

Ja

mm

ed O

pe

n pr

ior

to a

Ret

ract

/Rej

ect

If t

he

exi

t sh

utte

r is

ja

mm

ed

ope

n b

efo

re a

RE

TR

AC

T o

r a

RE

JEC

T c

om

ma

nd

wh

en n

ote

s w

ere

pre

sen

ted

by

a p

revi

ou

s co

mm

and

, th

ree

att

em

pts

a

re

mad

e

to

clo

se

the

sh

utte

r.

If

this

is

uns

ucce

ssfu

l, an

y st

ack

ed

bill

s w

ill b

e p

urg

ed,

an

d t

hre

e m

ore

shu

tter

reco

very

att

em

pts

are

ma

de.

If

the

sh

utte

r co

ntin

ues

to

rem

ain

ja

mm

ed

, th

e C

DM

SP

en

ters

a s

usp

end

sta

te f

or

'Su

spe

ndT

imeo

ut'

min

ute

s,

du

ring

w

hich

a

ll C

DM

co

mm

an

ds

that

h

ave

de

vice

in

tera

ctio

n

will

re

turn

WF

S_

ER

R_

DE

V_N

OT

_R

EA

DY

.O

n e

xpir

y o

f th

is p

erio

d,

the

CD

M S

P w

ill a

tte

mp

t to

cle

ar

the

tran

spo

rt a

nd

if s

ucce

ssfu

l, re

sum

es

nor

mal

op

era

tion

. If

the

sh

utte

r co

ntin

ues

to

rem

ain

jam

me

d, t

he

SP

will

att

em

pt

to c

lear

th

e er

ror

onc

e ag

ain

. If

this

att

emp

t fa

ils,

the

devi

ce g

oe

s in

to a

fat

al s

tate

, fo

llow

ing

wh

ich

, al

l co

mm

and

sis

sued

to

th

e d

evi

ce w

ill r

etu

rn W

FS

_E

RR

_H

AR

DW

AR

E_

ER

RO

R.

Rec

ove

ry n

ow r

equ

ires

op

era

tor

inte

rven

tion

via

VD

M.

Pu

rge

Bin

Ove

rfill

sen

sor

blo

cked

T

he

Tra

nsp

ort

is r

un

fo

r an

ad

diti

ona

l 3

seco

nds

in a

n a

ttem

pt

to c

lea

r th

e b

ills

into

th

e b

in.

If t

his

fails

, no

fu

rthe

r a

uto

ma

tic r

ecov

ery

is a

ttem

pted

by

the

SP

. R

ecov

ery

now

req

uire

s o

pe

rato

r in

terv

entio

n v

ia V

DM

.


3-18

Rej

ect

Bin

mis

sin

gN

o a

uto

ma

tic r

ecov

ery

by

SP

. R

equ

ires

ope

rato

r in

terv

entio

n v

ia V

DM

.

Pic

k fa

ilure

du

e t

o b

ad m

edia

A c

ass

ett

e lo

w a

nd

pic

k fa

ilure

ind

icat

es t

hat

th

e c

asse

tte

is e

mp

ty.

Oth

erw

ise,

th

e fa

ult

is a

fa

ilure

to p

ick.

If

mo

re t

ha

n o

ne c

asse

tte

of

the

sa

me

Typ

e is

inst

alle

d,

an a

ttem

pt

will

be

ma

de

to d

isp

ense

from

th

e o

ther

cas

sett

es w

hen

on

e g

oes

emp

ty.

If a

pic

k a

ttem

pt

fails

, a

ll pi

cke

d b

ills

will

be

purg

ed a

nd

th

e o

per

atio

n w

ill b

e re

pe

ated

up

to

th

ree

time

s.

If

thes

e

atte

mp

ts

fail,

th

e

SP

re

po

rts

a

Ca

sh

Un

it er

ror

(WF

S_

ER

R_

CD

M_

CA

SH

UN

ITE

RR

OR

). N

o f

urt

her

rec

ove

ry a

tte

mp

ts w

ill b

e m

ade.

If a

cas

sett

e is

no

t lo

w o

n b

ills,

an

d th

ere

are

re

pea

ted

pic

k fa

ils d

ue

to b

ad n

ote

s, t

he

sta

tus

of

the

cass

ett

e w

ill

be

m

ark

ed

as

W

FS

_C

DM

_S

TA

TC

UIN

OP

o

n th

e th

ird

cons

ecut

ive

fa

iled

WF

S_

CM

D_

CD

M_

DIS

PE

NS

E c

om

man

d w

hic

h fa

iled

du

e t

o a

pic

k fa

il fr

om a

par

ticu

lar

cass

ett

e.

In t

his

ca

se,

reco

very

of

the

cass

ette

typ

e m

arke

d a

s W

FS

_C

DM

_ST

AT

CU

INO

P,

req

uire

s o

per

ato

rin

terv

entio

n v

ia V

DM

.

Cas

sett

e

Ino

pera

ble

d

ue

to

a

na

ttem

pt

to

pic

k fr

om

an

em

pty

cass

ett

e.

Th

e S

P p

erf

orm

s n

o au

tom

atic

rec

ove

ry.

Aft

er t

he

cass

ette

is

repl

enis

hed

an

d t

he

Sta

rt E

xch

an

gean

d

En

d

Exc

han

ge

com

man

ds

are

p

erfo

rme

d,

the

st

ate

o

f th

e ca

sse

tte

w

ill

be

set

toW

FS

_C

DM

_S

TA

TC

UO

K o

r W

FS

_C

DM

_S

TA

TC

ULO

W,

as

the

case

ma

y b

e.

Err

or C

ondi

tion

Rec

over

y A

ctio

n

WOSA/XFS - Programmer’s Reference ManualDepository



Depository 3




Envelope Depository/Dispenser edep_spx.dlledep_wfp.dlledep_ipc.dlledep.dll

edep.exe

Nightsafe Depository ndep_spx.dllndep_wfp.dllndep_ipc.dllndep.dll

ndep.exe

Logical Name. Description

Envelope1 The logical name of the Envelope Depository service provider

NightSafe1 The logical name of the Nightsafe Depository service provider

Depository

3-20

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

\ED

EP

(N

DE

P)

key.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

GE

NE

RA

L_C

ON

FIG

S\V

aria

nt

Varia

nt

of t

he

dev

ice

.S

TAN

DA

RD

_D

EP

- S

tan

dar

d D

ep

osi

tory

B

AS

IC_N

SD

- B

asic

nig

hts

afe

EN

HA

NC

ED

_N

SD

- E

nh

anc

ed n

igh

tsa

fe

GE

NE

RA

L_C

ON

FIG

S\D

isp

ense

rTyp

eTy

pe

of

dis

pen

ser

use

d.

NO

NE

- d

isp

en

ser

is n

ot p

rese

nt

MO

TO

RIZ

ED

- d

isp

en

ser

is m

oto

r-d

rive

n

an

d en

velo

pes

are

dis

pen

sed

t

o t

he

use

r

GE

NE

RA

L_C

ON

FIG

S\S

usp

end

Tim

eou

tD

ura

tion

in s

eco

nd

s fo

r w

hic

h t

he

dev

ice

sh

ou

ld b

e s

usp

end

ed

wh

en u

ser

tam

pe

ring

is s

uspe

cted

.

Pe

rmis

sib

le v

alu

es r

ang

e fr

om 1

- 1

5 m

inu

tes

with

a d

efa

ult

of

5 m

inu

tes.

Ap

plic

ab

le o

nly

to

th

e E

nve

lope

De

po

sito

ry

SP

.

GE

NE

RA

L_C

ON

FIG

S\T

imeo

ut

Du

ratio

n in

mill

ise

con

ds

for

wh

ich

th

e N

igh

tsaf

e D

ep

osito

ry

SP

wa

its fo

r a

bag

-dro

p s

witc

h tr

ansi

tion

bef

ore

lock

ing

th

e d

epo

sito

ry d

oo

r, f

ollo

win

g a

de

posi

t co

mm

and

. T

his

tim

eou

t a

ssu

me

s si

gnifi

can

ce if

th

e b

ag-d

rop

sw

itch

is

fau

lty.

If n

ot

spec

ified

, d

efa

ult

to 6

0 se

con

ds.

Depository

3-21

Cap

abili

ties

3 3

Cap

abili

tyV

alu

e (E

nvel

ope

Dep

osito

ry)

Val

ue

(Nig

htsa

fe D

epos

itory

)

De

pos

itory

Typ

eE

NV

ELO

PE

NIG

HT

SA

FE

Env

elo

pe

Su

ppl

yE

NV

MO

TO

RIZ

ED

EN

VN

ON

E

De

p T

ran

spo

rtT

RU

EFA

LS

E

Pri

nte

rT

RU

EFA

LS

E

Ton

er

TR

UE

FAL

SE

Sh

utt

er

TR

UE

TR

UE

Pri

ntO

nR

etra

cts

FALS

EFA

LS

E

Ret

ract

To

Dep

osi

tFA

LSE

FAL

SE

Ma

xNum

Cha

rs8

00

Depository

3-22

Con

form

ance

Mat

rix -

Com

man

ds3

Con

form

ance

Mat

rix -

Err

ors

3

WO

SA

Com

man

dC

L C

omm

ents

WF

S_

INF

_DE

P_

STA

TU

S1

fwTo

ne

r re

port

s W

FS

_D

EP

_T

ON

LO

W e

ven

if t

he

ink

cart

ridg

e is

em

pty

. (W

FS

_D

EP

_T

ON

EM

PT

Y is

not

re

por

ted

).

WF

S_

INF

_DE

P_

CA

PA

BIL

ITIE

S2

No

ne

WF

S_

CM

D_

DE

P_

EN

TR

Y1

If a

dep

osi

t co

uld

no

t b

e c

om

ple

ted

du

e t

o a

n in

corr

ect

en

velo

pe

size

, an

atte

mpt

is m

ade

to

clea

r th

e t

rans

port

an

d d

epo

sit

the

en

velo

pe

in t

he

de

pos

itory

bin

. T

he

en

velo

pe i

s no

tej

ecte

d.

WF

S_

CM

D_

DE

P_

DIS

PE

NS

E2

No

ne

WF

S_

CM

D_

DE

P_

RE

TR

AC

T1

Prin

ting

on

a r

etr

act

ed e

nve

lope

is n

ot

sup

po

rte

d.

WF

S_

CM

D_

DE

P_

CLE

AR

_T

RA

NS

PO

RT

2N

on

e

WF

S_

CM

D_

DE

P_

RE

SE

T_

CO

UN

T2

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_

CM

D_

DE

P_

EN

TR

YW

FS

_E

RR

_D

EP

_E

NV

JAM

ME

D2

No

ne

WF

S_

ER

R_

DE

P_

DE

PF

ULL

2N

one

WF

S_

ER

R_

DE

P_

CO

NT

MIS

SIN

G2

No

ne

WF

S_

ER

R_

DE

P_

EN

VS

IZE

2N

one

WF

S_

ER

R_

DE

P_

PT

RFA

IL2

Ret

urn

ed

whe

n t

he

prin

ter

fails

be

cau

se t

he

pri

nth

ead

is r

emo

ved.

Fai

lure

of

the

prin

ter

for

oth

er

rea

son

s w

ill n

ot

be

rep

ort

ed

.

WF

S_

ER

R_

DE

P_

SH

TN

OT

CLO

SE

D2

No

ne

WF

S_

ER

R_

DE

P_

SH

TN

OT

OP

EN

ED

2N

one

WF

S_

ER

R_

DE

P_

DE

PU

NK

NO

WN

2N

one

WF

S_

CM

D_

DE

P_

DIS

PE

NS

EW

FS

_E

RR

_D

EP

_E

NV

EM

PT

Y2

No

ne

WF

S_

ER

R_

DE

P_

EN

VJA

MM

ED

2N

one

WF

S_

ER

R_

DE

P_

SH

TN

OT

OP

EN

ED

2N

one

Depository

3-23

Con

form

ance

Mat

rix -

Eve

nts

3

App

licat

ion

Gui

delin

es3

1In

th

e N

igh

tsaf

e d

ep

osito

ry,

if th

e b

ag-

dro

p s

witc

h is

stu

ck in

th

e O

N p

osi

tion

, it

is n

ot

po

ssib

le t

o d

ete

rmin

ew

het

her

th

e d

epo

sit

ha

s b

een

mad

e o

r n

ot.

Th

is m

ay

cau

se t

he

de

po

sit

cou

nt

to b

e in

acc

ura

te.

In t

his

case

, th

eW

FS

_CM

D_

DE

P_

EN

TR

Y c

om

ma

nd

will

re

turn

a W

FS

_E

RR

_D

EP

_D

EP

UN

KN

OW

N e

rro

r, i

rre

spec

tive

of

wh

eth

er t

he

dep

osi

t w

as c

om

plet

ed s

ucc

essf

ully

or

not

.

2In

th

e E

nve

lop

e d

epo

sito

ry,

the

da

ta t

o b

e p

rinte

d o

n th

e e

nve

lop

e b

y th

e cu

sto

me

r sh

ou

ld b

e in

up

perc

ase

. T

he

low

erca

se a

lph

abet

s ar

e n

ot

supp

ort

ed

in t

he N

CR

AS

CII

ch

ara

cter

set

.

3T

he

En

velo

pe D

epo

sito

ry S

P a

nd

de

vice

driv

ers

atte

mp

t to

re

cove

r fr

om E

nve

lope

Jam

co

nd

itio

ns.

If

afte

rre

pe

ated

att

empt

s, t

he

err

or c

ond

itio

n p

ers

ists

, th

e d

evic

e g

oe

s in

to a

fat

al s

tate

, a

con

diti

on

that

ca

n b

e c

lea

red

on

ly b

y o

per

ato

r in

terv

en

tion

via

th

e V

DM

. T

he

follo

win

g t

ab

le l

ists

th

e er

ror

con

diti

on

s fr

om

wh

ich

the

SP

atte

mpt

s to

re

cove

r, a

nd

the

act

ion

to

be

tak

en fo

r ot

her

co

mm

onl

y o

ccu

rrin

g e

rro

rs.

4In

th

e e

ven

t an

en

velo

pe

is a

cce

pte

d in

res

po

nse

to

a W

FS

_CM

D_

DE

P_

EN

TR

Y c

omm

and

, an

d t

his

en

velo

pe

cau

ses

the

de

posi

t bi

n t

o o

verf

ill,

the

SP

ge

ner

ate

s a

WF

S_

EX

EE

_D

EP

_E

NV

DE

PO

SIT

ED

eve

nt

an

d r

etu

rns

WF

S_E

RR

_D

EP

_D

EP

FU

LL.

WO

SA

Eve

ntC

LC

omm

ents

WF

S_

SR

VE

_D

EP

_TA

KE

N2

Non

e

WF

S_

EX

EE

_D

EP

_E

NV

DE

PO

SIT

ED

2N

one

WF

S_

EX

EE

_D

EP

_D

EP

OS

ITE

RR

OR

2N

one

WF

S_

US

RE

_D

EP

_DE

PT

HR

ES

HO

LD2

Non

e

WF

S_

US

RE

_D

EP

-TO

NE

RT

HR

ES

HO

LD1

Gen

era

ted

w

hen

th

e

prin

ter

ton

er

is

low

( fw

Ton

er=

WF

S_D

EP

_T

ON

LOW

). N

ot

gen

era

ted

whe

nth

e p

rinte

r ru

ns

ou

t o

f to

ner

WF

S_

US

RE

_D

EP

-EN

VT

HR

ES

HO

LD2

Non

e

WF

S_

US

RE

_D

EP

-CO

NT

INS

ER

TE

D2

Non

e

WF

S_

US

RE

_D

EP

-CO

NT

RE

MO

VE

D2

Non

e

Depository

3-24

Err

or C

ondi

tion

Rec

over

y A

ctio

n

Env

elo

pe

jam

me

d in

tr

ansp

ort

with

use

r ac

cess

.T

he

SP

su

spe

nds

op

era

tion

fo

r 'S

usp

en

dTim

eou

t' se

con

ds,

du

ring

whi

ch a

ll E

DE

P c

om

man

ds

that

ha

ve d

evi

ce in

tera

ctio

n w

ill r

etu

rn W

FS

_E

RR

_DE

V_

NO

T_

RE

AD

Y.

On

exp

iry

of

this

per

iod,

th

e d

epo

sito

ry is

co

nsi

de

red

to

be

hea

lthy

until

th

e n

ext

com

ma

nd is

issu

ed

. If

the

jam

co

ndi

tion

pe

rsis

ts,

the

devi

ce g

oes

into

a f

ata

l st

ate

, fo

llow

ing

whi

ch,

all

com

man

ds

issu

ed

to

the

dev

ice

will

re

turn

WF

S_

ER

R_H

AR

DW

AR

E_

ER

RO

R.

Re

cove

ry n

ow

req

uire

s o

per

ato

r in

terv

entio

n v

ia V

DM

.

Sh

utte

r Ja

mm

ed

Sh

ut/O

pen

Th

e S

P m

ake

s 1

5 a

ttem

pts

to

ope

n/c

lose

th

e s

hut

ter.

If

the

se a

tte

mp

ts f

ail,

th

e S

P s

usp

end

sop

era

tion

for

'Su

spen

dT

ime

out'

seco

nd

s, d

urin

g w

hic

h a

ll E

DE

P c

omm

and

s th

at h

ave

dev

ice

inte

ract

ion

will

re

turn

WF

S_

ER

R_D

EV

_N

OT

_R

EA

DY

. O

n e

xpir

y o

f th

is p

erio

d, t

he

de

posi

tory

is c

on

sid

ere

d t

o b

e h

ealth

y un

til t

he

ne

xt c

omm

and

isis

sue

d.

If th

e j

am c

on

ditio

n p

ers

ists

, th

e de

vice

goe

s in

to a

fat

al

sta

te,

follo

win

g w

hich

, a

llco

mm

and

s is

sue

d t

o th

e d

evic

e w

ill r

etu

rn W

FS

_E

RR

_HA

RD

WA

RE

_E

RR

OR

.R

eco

very

no

w r

equ

ires

op

era

tor

inte

rven

tion

via

VD

M.

Tra

nsp

ort

Jam

with

out

acce

ss,

cau

sed

by

an

inte

rna

l en

velo

pe ja

m.

No

auto

mat

ic r

eco

very

. R

equ

ires

op

era

tor

inte

rven

tion

via

VD

M.

De

posi

t B

in o

verf

ille

dN

o au

tom

atic

re

cove

ry.

Req

uire

s o

pe

rato

r in

terv

entio

n v

ia V

DM

.

WOSA/XFS - Programmer’s Reference ManualReceipt and Journal Printers



Receipt and Journal Printers 3


3



Receipt Printer (all variants) rptr_spx.dllrptr_wfp.dll rptr_ipc.dll rptr.dll

rptr.exe

Journal Printer (all variants) jptr_spx.dlljptr_wfp.dll jptr_ipc.dll jptr.dll

jptr.exe


ReceiptPrinter1 The logical name of the receipt printer service provider.

JournalPrinter1 The logical name of the journal printer service provider.

Receipt and Journal Printers

3-26

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

ke

y

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

\RP

TR

(JP

TR

) ke

y:

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

FO

RM

S\F

OR

M_

FIL

E_P

AT

HT

he

pat

h t

o t

he f

orm

file

de

finiti

on

s d

irect

ory

.A

ny

valid

ab

solu

te p

ath

ME

DIA

\ME

DIA

_FIL

E_

PA

TH

Th

e p

ath

to

the

med

ia f

ile d

efin

itio

ns d

irect

ory

An

y va

lid a

bso

lute

pat

h

ER

RO

R_

FIL

E_

PAT

H\P

TR

_E

RR

OR

_F

ILE

_PAT

HP

ath

of

the

dire

cto

ry in

wh

ich

initi

aliz

atio

n e

rro

rs

are

logg

ed

.A

ny

valid

ab

solu

te p

ath

.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

GE

NE

RA

L_C

ON

FIG

S\V

aria

nt

Varia

nt

of t

he

re

ceip

t/jo

urn

al p

rinte

r.T

he

fo

llow

ing

va

rian

ts a

re s

up

por

ted

by

the

rec

eip

t p

rinte

r se

rvic

e p

rovi

de

r:

lN

O_

BLA

CK

_M

AR

K (

no

bla

ck m

ark

rec

eipt

pri

nte

r)

lN

O_

BLA

CK

_M

AR

K_

TH

ER

MA

L

(no

bla

ck m

ark,

th

erm

al r

ece

ipt

prin

ter)

lB

LAC

K_

MA

RK

(b

lack

ma

rk r

ecei

pt p

rint

er)

lB

LAC

K_

MA

RK

_T

HE

RM

AL

(b

lack

mar

k, t

he

rmal

re

ceip

t p

rinte

r)

lN

O_

BLA

CK

_M

AR

K_

SID

EW

AY

S_

NO

RM

AL

(n

o b

lack

mar

k, c

om

bin

ed

side

wa

ys/n

orm

al m

od

e re

ceip

t p

rinte

r)

lN

O_

BLA

CK

_M

AR

K_

TH

ER

MA

L_

SID

EW

AY

S_

NO

RM

AL

(n

o b

lack

mar

k,

the

rma

l, co

mbi

ned

sid

ew

ays/

no

rmal

mod

e r

ece

ipt

prin

ter)

lB

LAC

K_

MA

RK

_S

IDE

WA

YS

_N

OR

MA

L

(bla

ck m

ark,

co

mb

ined

sid

ew

ays/

nor

mal

mo

de

rec

eip

t p

rinte

r)

lB

LAC

K_

MA

RK

_T

HE

RM

AL

_S

IDE

WA

YS

_N

OR

MA

L (

bla

ck m

ark,

the

rma

l, co

mbi

ned

sid

ew

ays/

nor

mal

mod

e r

ece

ipt

prin

ter)

.

Th

e f

ollo

win

g v

aria

nts

are

su

pp

orte

d b

y th

e jo

urn

al p

rint

er

serv

ice

pro

vid

er:

lS

TD

(st

and

ard

jou

rna

l prin

ter)

lS

TD

_TH

ER

MA

L (

stan

dar

d t

her

mal

jou

rnal

pri

nte

r).


3-27

Cap

abili

ties

3

Cap

abili

tyV

alue

(R

ecei

pt P

rinte

r)V

alue

(Jo

urna

l Prin

ter)

Co

mp

ou

ndF

ALS

EFA

LS

E

Res

olu

tion

LO

WL

OW

Rea

d F

orm

Su

ppo

rtF

ALS

EFA

LS

E

Writ

e F

orm

Sup

po

rtT

RU

E (

text

on

ly)

TR

UE

(te

xt o

nly

)

Ext

ents

Sup

po

rtF

ALS

EFA

LS

E

Su

pp

ort

ed

Con

trol

sE

JEC

T,

FLU

SH

FL

US

H

Ret

ract

Bin

cap

aci

ty0

0

Sta

cker

cap

aci

ty0

0


3-28

Con

form

ance

Mat

rix -

Com

man

ds

WO

SA

Com

man

dC

LC

omm

ents

WF

S_

INF

_PT

R_

STA

TU

S2

fwD

evi

ce o

f th

e W

FS

_P

TR

_D

EV

PO

WE

RO

FF,

WF

S_

PT

R_

DE

VB

US

Y a

nd

WF

S_P

TR

_D

EV

NO

DE

VIC

E a

re n

eve

r re

turn

ed

.

WF

S_

INF

_PT

R_

CA

PA

BIL

ITIE

S2

No

ne

WF

S_

INF

_PT

R_

FO

RM

_LI

ST

2N

on

e

WF

S_

INF

_PT

R_

ME

DIA

_LIS

T2

No

ne

WF

S_

INF

_PT

R_

QU

ER

Y_

FO

RM

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

ME

DIA

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

FIE

LD2

N

on

e

WF

S_

CM

D_

PT

R_

CO

NT

RO

L_M

ED

IA1

lD

oes

no

t g

ene

rate

th

e e

ven

t W

FS

_S

RV

E_

PT

R_M

ED

IA_

TAK

EN

fo

r th

e re

ceip

t p

rinte

rS

erv

ice

Pro

vid

er.

Thi

s ev

ent

is n

ot

app

licab

le t

o t

he

jou

rnal

pri

nte

r.

lT

he

o

nly

co

ntr

ol

cod

es

sup

por

ted

ar

e

WF

S_

PT

R_C

TR

LE

JEC

T

and

WF

S_P

TR

_C

TR

LF

LUS

H.

Th

e co

de

W

FS

_P

TR

_CT

RL

CU

T

is

imp

lem

ente

d

like

WF

S_P

TR

_C

TR

LE

JEC

T.

WF

S_

CM

D_

PT

R_

PR

INT

_F

OR

M1

lS

up

por

ts o

nly

low

res

olu

tion.

lD

oes

no

t re

turn

th

e er

ror

cod

e W

FS

_E

RR

_PT

R_

ME

DIA

SK

EW

ED

.

lO

nly

su

pp

ort

s co

ntr

ol

cod

es

WF

S_

PT

R_C

TR

LE

JEC

T

and

W

FS

_PT

R_

CT

RL

FLU

SH

.W

FS

_PT

R_

CT

RL

CU

T is

imp

lem

ente

d li

ke W

FS

_P

TR

_CT

RL

EJE

CT.

lT

he

fo

rm/f

ield

de

finiti

ons

sh

ou

ld s

atis

fy t

he

follo

win

g c

ond

itio

ns:

lO

rien

tatio

n c

ann

ot b

e L

AN

DS

CA

PE

fo

r th

e jo

urn

al p

rin

ter.

lS

KE

W s

hou

ld n

ot b

e g

rea

ter

than

zer

o.

lS

IDE

ca

n o

nly

be

FR

ON

T.

lT

YP

E c

an o

nly

be

TE

XT.

lG

RA

PH

ICS

can

on

ly b

e B

ES

TF

IT (

de

fau

lt).

lB

AR

CO

DE

can

on

ly b

e N

ON

E (

defa

ult)

.

lS

TY

LE c

an

be

NO

RM

AL

(de

fau

lt) o

r D

OU

BLE

.

lH

OR

IZO

NTA

L ju

stifi

catio

n ca

n o

nly

be

LE

FT (

def

au

lt), R

IGH

T o

r C

EN

TE

R.

cont

inu

ed

...


3-29

Con

form

ance

Mat

rix -

Err

ors

3

WF

S_

CM

D_

PT

R_

PR

INT

_F

OR

M1

lC

OLO

R c

an o

nly

be

BLA

CK

.

lF

ON

T s

ho

uld

be

on

e o

f th

e f

ollo

win

g:

INT

ER

NA

TIO

NA

L1

INT

ER

NA

TIO

NA

L2

INT

ER

NA

TIO

NA

L3

INT

ER

NA

TIO

NA

L4

INT

ER

NA

TIO

NA

L5

AR

AB

IC1

AR

AB

IC2

AR

AB

IC3

AR

AB

IC4

A

RA

BIC

5

lP

OIN

TS

IZE

is n

ot

sup

port

ed (

igno

red)

.

lC

PI

can

be

7.0

or

14

.0 f

or t

he

re

ceip

t an

d jo

urn

al p

rinte

rs.

Ho

we

ver,

if C

PI

is s

pec

ified

as 1

4.0

, th

en

CA

SE

sho

uld

no

t b

e D

OU

BL

E.

No

te t

hat

a C

PI

of

14

.0 o

r 7

.0 is

inva

lidfo

r L

AN

DS

CA

PE

ori

enta

tion

fo

r th

e re

ceip

t pr

inte

r. H

ere

, th

e d

efa

ult

is 8

.5 a

nd

ifsp

ecifi

ed,

the

CP

I sh

ou

ld b

e 8

.5.

lLP

I ca

n o

nly

ta

ke v

alu

es b

etw

een

1.0

an

d 9

.0.

lF

OR

MAT

is n

ot

sup

po

rte

d (ig

no

red

).

lM

edia

def

initi

on

s sh

ou

ld s

atis

fy t

he f

ollo

win

g c

on

diti

on

s:

lT

YP

E c

an o

nly

be

GE

NE

RIC

(de

fau

lt).

lP

RIN

TAR

EA

, R

ES

TR

ICT

ED

, F

OLD

, S

TAG

GE

RIN

G,

PA

GE

an

d

LIN

ES

ar

e

not

supp

ort

ed a

nd

sho

uld

no

t b

e sp

ecifi

ed.

l S

IZE

wid

th s

ho

uld

be

<=

40

.

WF

S_

CM

D_

PT

R_

RE

AD

_F

OR

M0

No

t ap

plic

able

WF

S_

CM

D_

PT

R_

RA

W_

DAT

A2

No

ne

WF

S_

CM

D_

PT

R_

ME

DIA

_E

XT

EN

TS

0N

ot

app

licab

le

WF

S_

CM

D_

PT

R_

RE

SE

T_

CO

UN

T0

No

t ap

plic

able

WF

S_

CM

D_

PT

R_

RE

AD

_IM

AG

E0

No

t ap

plic

able

WO

SA

Com

man

dC

LC

omm

ents


3-30

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_

INF

_PT

R_

FO

RM

_LIS

TN

on

e2

No

ne

WF

S_

INF

_PT

R_

ME

DIA

_LI

ST

No

ne

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

FO

RM

WF

S_

ER

R_I

NVA

LID

_P

OIN

TE

R

2R

etu

rne

d

if th

e in

pu

t p

oin

ter

is

NU

LL

or

inva

lid.

WF

S_

ER

R_P

TR

_ F

OR

MIN

VAL

ID2

Ret

urn

ed

wh

en t

he

for

m d

efin

itio

n s

peci

fied

do

es

no

t sa

tisfy

th

e

con

diti

on

s g

ive

n

in

the

com

ma

nd

con

form

ance

m

atr

ix

for

the

CM

D_

PT

R_P

RIN

T_

FO

RM

com

ma

nd.

WF

S_

ER

R_P

TR

_ F

OR

MN

OT

FO

UN

D2

Ret

urn

ed

wh

en

th

e fo

rm n

am

e sp

eci

fied

wa

sn

ot f

ou

nd

in th

e fo

rm d

efin

itio

n fil

es

at s

tart

up.

WF

S_

INF

_PT

R_

QU

ER

Y_

ME

DIA

WF

S_

ER

R_I

NVA

LID

_P

OIN

TE

R2

Ret

urn

ed

if

the

inp

ut

poi

nte

r is

N

ULL

o

rin

valid

.

WF

S_

ER

R_P

TR

_ M

ED

IAN

OT

FO

UN

D2

Ret

urn

ed

wh

en t

he

med

ia n

am

e sp

ecifi

ed w

as

no

t fo

und

in

th

e m

edi

a

def

initi

on

fil

es

atst

artu

p.

WF

S_

ER

R_P

TR

_ M

ED

IAIN

VALI

D2

Ret

urn

ed

whe

n t

he

med

ia d

efin

itio

n s

peci

fied

do

es

no

t sa

tisfy

th

e co

nditi

on

s g

ive

n in

com

ma

nd

con

form

ance

m

atr

ix

for

the

CM

D_

PT

R_P

RIN

T_

FO

RM

com

ma

nd.

WF

S_

INF

_PT

R_

QU

ER

Y_

FIE

LDW

FS

_E

RR

_IN

VAL

ID_

PO

INT

ER

2R

etu

rne

d

if th

e in

pu

t p

oin

ter

is

NU

LL

or

inva

lid.

WF

S_

ER

R_P

TR

_ F

OR

MIN

VAL

ID2

Ret

urn

ed

wh

en t

he f

orm

def

initi

on

sp

eci

fied

inth

e

inp

ut

stru

ctur

e

do

es

not

satis

fy

the

con

diti

ons

gi

ven

in

co

mm

an

d co

nfo

rma

nce

ma

trix

fo

r th

e C

MD

_P

TR

_P

RIN

T_

FO

RM

com

ma

nd.

WF

S_

ER

R_P

TR

_ F

OR

MN

OT

FO

UN

D

2R

etu

rne

d w

hen

th

e fo

rm n

ame

spec

ified

in

th

ein

pu

t st

ruct

ure

was

no

t fo

und

in

th

e f

orm

file

sa

t st

art

up

.

con

tinu

ed

....


3-31

WF

S_

INF

_PT

R_

QU

ER

Y_

FIE

LDW

FS

_E

RR

_PT

R_

FIE

LDN

OT

FO

UN

D2

Ret

urn

ed

wh

en t

he

fie

ld n

ame

spe

cifie

d i

n t

he

inp

ut

stru

ctu

re d

oe

s n

ot b

elo

ng t

o t

he

spe

cifie

dfo

rm.

WF

S_

ER

R_P

TR

_ F

IELD

INVA

LID

2R

etu

rne

d

wh

en

the

fie

ld

defin

itio

n s

peci

fied

do

es

no

t sa

tisfy

th

e co

nditi

on

s g

ive

n in

com

ma

nd

con

form

ance

m

atrix

fo

rC

MD

_P

TR

_PR

INT

_F

OR

M c

omm

and

.

WF

S_

CM

D_

PT

R_

CO

NT

RO

L_M

ED

IAW

FS

_E

RR

_IN

VAL

ID_

PO

INT

ER

2R

etu

rne

d

if th

e in

pu

t p

oin

ter

is

NU

LL

or

inva

lid.

WF

S_

ER

R_P

TR

_ N

OM

ED

IAP

RE

SE

NT

2R

etu

rne

d w

he

n th

e p

rinte

r is

out

of

pa

per

.

WF

S_

ER

R_P

TR

_ F

LUS

HFA

IL2

Ne

ver

gen

era

ted

si

nce

th

e

da

ta

is

alw

ays

flush

ed

to

the

de

vice

.

WF

S_

ER

R_P

TR

_ R

ET

RA

CT

BIN

FU

LL

0N

ot

app

licab

le

WF

S_

ER

R_P

TR

_ S

TAC

KE

RF

UL

L0

No

t ap

plic

able

WF

S_

ER

R_P

TR

_ P

AG

ET

UR

NFA

IL

0N

ot

app

licab

le

WF

S_

ER

R_P

TR

_ M

ED

IAT

UR

NFA

IL0

No

t ap

plic

able

WF

S_

CM

D_

PT

R_

PR

INT

_FO

RM

W

FS

_E

RR

_IN

VAL

ID_

PO

INT

ER

2R

etu

rne

d

if th

e in

pu

t p

oin

ter

is

NU

LL

or

inva

lid.

WF

S_

ER

R_P

TR

_ F

LUS

HFA

IL2

Ad

diti

ona

l err

or

cod

e.

Ret

urn

ed

wh

en

th

e p

rint

form

com

ma

nd a

ttem

pts

to

prin

t d

ata

ab

ove

or

bef

ore

th

e c

urre

nt

posi

tion

of

the

prin

t he

ad.

WF

S_

ER

R_P

TR

_ F

OR

MIN

VAL

ID2

Ret

urn

ed

wh

en t

he f

orm

def

initi

on

sp

eci

fied

inth

e

inp

ut

stru

ctur

e

do

es

not

satis

fy

the

con

diti

ons

gi

ven

in

co

mm

an

d co

nfo

rma

nce

ma

trix

fo

r th

e C

MD

_P

TR

_P

RIN

T_

FO

RM

com

ma

nd.

WF

S_

ER

R_P

TR

_ F

OR

MN

OT

FO

UN

D2

Ret

urn

ed

wh

en t

he

form

nam

e sp

ecifi

ed i

n t

he

inp

ut

stru

ctu

re

wa

s n

ot

foun

d

in

the

fo

rmd

efin

itio

n f

iles

at s

tart

up.

cont

inu

ed

...

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-32

WF

S_

CM

D_

PT

R_

PR

INT

_FO

RM

W

FS

_E

RR

_PT

R_

ME

DIA

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e m

ed

ia n

ame

spec

ified

in th

ein

pu

t st

ruct

ure

w

as

not

fo

und

in

th

e m

ed

iad

efin

itio

n f

iles

at s

tart

up.

WF

S_

ER

R_P

TR

_ M

ED

IAIN

VALI

D2

Ret

urn

ed

whe

n t

he

med

ia d

efin

itio

n s

peci

fied

in

the

inp

ut

stru

ctu

re

do

es

no

t sa

tisfy

th

eco

nd

itio

ns

give

n

in

com

ma

nd

con

form

an

cem

atr

ix

for

the

CM

D_

PT

R_

PR

INT

_F

OR

Mco

mm

an

d.

WF

S_

ER

R_P

TR

_ M

ED

IAS

KE

WE

D

0N

eve

r re

turn

ed.

as S

kew

ca

nno

t b

e d

etec

ted

WF

S_

ER

R_P

TR

_ M

ED

IAO

VE

RF

LO

W2

Ret

urn

ed

w

hen

th

e p

rint

dat

a o

verf

low

s th

em

ed

ia b

ou

nda

ries.

WF

S_

ER

R_P

TR

_ F

IELD

SP

EC

FAIL

UR

E2

Ret

urn

ed

whe

n a

fie

ld i

s sp

ecifi

ed t

wic

e in

th

ein

pu

t.

WF

S_

ER

R_P

TR

_ F

IELD

ER

RO

R2

Ret

urn

ed

if a

n er

ror

occ

urs

wh

ile p

roce

ssin

g a

fie

ld.

WF

S_

CM

D_

PT

R_

RE

AD

_F

OR

MW

FS

_E

RR

_PT

R_

RE

AD

NO

TS

UP

PO

RT

ED

2R

ead

is n

ot

sup

por

ted

by

the

rec

eip

t/jo

urn

al

pri

nte

r.

WF

S_

ER

R_P

TR

_ F

OR

MIN

VAL

ID

0N

eve

r re

turn

ed

WF

S_

ER

R_P

TR

_ F

OR

MN

OT

FO

UN

D0

Ne

ver

retu

rned

WF

S_

ER

R_P

TR

_ M

ED

IAN

OT

FO

UN

D0

Ne

ver

retu

rned

WF

S_

ER

R_P

TR

_ M

ED

IAIN

VALI

D0

Ne

ver

retu

rned

WF

S_

ER

R_P

TR

_ M

ED

IAS

KE

WE

D0

Ne

ver

retu

rned

WF

S_

ER

R_P

TR

_ F

IELD

SP

EC

FAIL

UR

E0

Ne

ver

retu

rned

WF

S_

ER

R_P

TR

_ F

IELD

ER

RO

R0

Ne

ver

retu

rned

WF

S_

CM

D_

PT

R_

RA

W_

DA

TAN

on

e2

No

ne

WF

S_

CM

D_

PT

R_

ME

DIA

_E

XT

EN

TS

WF

S_

ER

R_P

TR

_E

XT

EN

TN

OT

SU

PP

OR

TE

D2

De

vice

do

es

no

t re

po

rt e

xten

ts.

WF

S_

CM

D_

PT

R_

RE

SE

T_C

OU

NT

No

ne

2N

on

e

WF

S_

CM

D_

PT

R_

RE

AD

_IM

AG

EN

on

e2

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-33

Con

form

ance

Mat

rix -

Eve

nts

3

WO

SA

Eve

ntC

L C

omm

ents

WF

S_

EX

EE

_P

TR

_N

OM

ED

IA2

No

ne

WF

S_

EX

EE

_P

TR

_M

ED

IAIN

SE

RT

ED

0N

ot

app

licab

le

WF

S_

EX

EE

_P

TR

_F

IELD

ER

RO

R2

No

ne

WF

S_

EX

EE

_P

TR

_F

IELD

WA

RN

ING

2N

on

e

WF

S_

US

RE

_P

TR

_R

ET

RA

CT

BIN

TH

RE

SH

OLD

0N

ot

app

licab

le

WF

S_

SR

VE

_P

TR

_M

ED

IATA

KE

N0

No

t ge

ner

ate

d fo

r th

e

rece

ipt

prin

ter.

N

ot

app

licab

le t

o t

he

jou

rnal

pri

nte

r.

WF

S_

SR

VE

_P

TR

_M

ED

IAIN

SE

RT

ED

0N

ot

app

licab

le

WF

S_

US

RE

_P

TR

_P

AP

ER

TH

RE

SH

OLD

2N

on

e

WF

S_

US

RE

_P

TR

_T

ON

ER

TH

RE

SH

OL

D1

The

rib

bon

be

ing

‘C

lose

to

Rep

lace

’/‘R

ep

lace

No

w’

is

rep

ort

ed

a

s T

ON

ER

L

OW

/TO

NE

RO

UT

.




PRINTER FORMS 3

In the implementation of forms, the form and field definitions are stored in filescalled "Form Definition Files". The names of the directories containing these filesare stored separately in the Windows NT Registry. Each file may contain one ormore form definitions. The form definition files are read and parsed during theinitialization of the service provider, and are validated in the following two stages:

Start-up validation:

When the SP is started, all the form definition files are opened and verified forsyntax, 'Required Fields' and content. Here, the syntax refers to the validkeywords, non-duplication of keywords and matching BEGIN/END. The requiredfields are form SIZE, form LANGUAGE , field SIZE and field POSITION .Content is the value of the keywords that must be within the capabilities of thedevice. The form definitions are converted to an 'in-core' representation called asthe 'Forms Database'. Errors found during this initial validation are recorded in theForms Database and are logged in an error log file. The location of the error logfile is specified in the registry.

Runtime Validation:

Runtime validation is performed when an INFO or an EXECUTE commandconcerned with forms such as QUERY_FORM, QUERY_FIELD, PRINT_FORMor READ_FORM is received. It verifies that the form SIZE and field POSITIONvalues contained in the definition do not conflict with the device capabilities. Forexample, it verifies that the width of the form specified is not greater than 40 forthe 40-column printers.

Runtime validation also checks the following:

l A value has been provided for REQUIRED fields.

l No value is supplied for the STATIC fields and READ only fields.

l A WRITE only field is not specified in the READ_FORM command.

Errors encountered while parsing the form definition files are logged in an errorlogfile.




Form Parser Error Messages and Limits 3

Form parser error messages are stored in error log files with names of the form "XXXX_FRM.LOG"

where

XXXX = RPTR for the receipt printer

JPTR for the journal printer

SPTR for the statement printer

PPTR for the passbook printer

The path where these files are created is a default to root (‘\’). But, it can beconfigured in the Registry.

Form Parser Messages 3

The Form definition files are parsed during the startup. Any information regardingthe files read and errors encountered (if any), is stored in the printer error logfile.The messages generated by the form definition parser are as following:

Parser Messages:

When the read function encounters an error, it is recorded in the error log file. Anerror message specifying the type of error and the line number is also recorded.The read function tries to continue as far as possible. In order to do so, it aborts theprocessing of a line or a keyword section, and continues with the next line. Thismay result in further errors.

Message Description

"Textfile Parser for XFSFORMS Version x.x" The first line of the errorlog file, giving the versionnumber of the readfunction.

"File <file name>" Indicates the opened files.The messages followingthereafter concern this file.

"Form <form name> read successfully" Indicates the successfulreading of the form.

"Parsed OK" Indicates the successfulreading and parsing of thelast listed file.

"n error(s) found while parsing" Indicates the unsuccessfulreading of the last listedfile, and contains n errors.


3-36

Err

or M

essa

ges

Err

or M

essa

geD

escr

iptio

n

"Err

or

fou

nd

in li

ne n

"A

n er

ror

has

occ

urr

ed

in t

he

nth

lin

e o

f the

form

/me

dia

def

initi

on

file

.

"Err

or

wh

ile t

ryin

g t

o o

pen

file

"A

n er

ror

has

occ

urr

ed

wh

ile o

pen

ing

an

inp

ut f

ile.

"Err

or:

co

uld

not

allo

cate

mem

ory"

An

erro

r h

as o

ccu

rre

d w

hile

allo

catin

g m

em

ory

.

"Err

or

wh

ile t

ryin

g t

o r

ead

fro

m f

ile"

An

erro

r h

as o

ccu

rre

d w

hile

rea

din

g t

he

inp

ut

file.

"Lin

e n:

lin

e co

ntin

uatio

n c

hara

cte

r in

valid

ated

" T

he

read

fu

nct

ion

ha

s fo

und

a c

ha

ract

er

afte

r th

e li

ne

co

ntin

uat

ion

sym

bol (

\).

Th

e r

est

of

the

line

is ig

no

red

.

"Lin

e n:

str

ing

term

inat

ion

ch

arac

ter

no

t fo

und

."

T

he

read

fu

nct

ion

did

no

t fin

d a

str

ing

te

rmin

atio

n c

ha

ract

er,

i.e.

a C

R/L

F w

as

en

cou

nte

red

first

. A s

trin

g te

rmin

atio

n c

ha

ract

er

is in

sert

ed

at t

he

en

d o

f th

e d

ata

that

ha

s be

en r

ead

for

this

line.

"Lin

e n:

ke

ywo

rd e

xpec

ted

."T

he

rea

d fu

nct

ion

exp

ect

ed t

o f

ind

a k

eyw

ord

with

its

valu

es.

The

en

tire

keyw

ord

sec

tion

isig

no

red

.

"Lin

e n:

arg

um

ent

is m

issi

ng

."T

he

rea

d fu

nct

ion

exp

ecte

d to

fin

d a

no

the

r a

rgu

me

nt

for

this

key

wo

rd.

Th

e w

ho

le k

eyw

ord

sect

ion

is ig

no

red

.

"Lin

e n:

wro

ng

typ

e of

arg

um

ent

."T

he

rea

d fu

nctio

n e

xpe

cted

to

fin

d a

diff

eren

t so

rt o

f ar

gu

men

t fo

r th

is k

eyw

ord

. T

he

wh

ole

keyw

ord

sec

tion

is ig

nore

d.

"Lin

e n:

th

e n

ame

of

the

form

is m

issi

ng

."T

he

form

nam

e is

mis

sin

g,

i.e.

the

rea

d fu

nct

ion

has

fou

nd

onl

y th

e k

eyw

ord

XF

SF

OR

M a

nd

no

thin

g f

ollo

win

g i

t. T

he f

orm

will

no

t b

e i

nse

rted

in

to t

he

form

s d

ata

bas

e.

Th

e p

ars

ing

fun

ctio

n c

on

tinu

es l

oo

kin

g f

or

the

nex

t X

FS

FO

RM

fo

rmn

am

e. A

mis

sin

g f

orm

na

me

may

resu

lt in

fu

rth

er

erro

rs.

"Lin

e n:

th

e re

st o

f lin

e is

no

t e

mp

ty."

Th

e re

ad

fu

nct

ion

has

rea

d a

ke

ywor

d s

ectio

n s

ucce

ssfu

lly,

bu

t th

e r

est

of

the

line

is

not

em

pty

. Th

e re

st is

ign

ore

d.

"Lin

e n:

a s

trin

g w

as e

xpe

cted

."T

he

read

fu

nct

ion

is lo

oki

ng

fo

r a

str

ing

("s

trin

g")

as

an

inp

ut.

Th

e w

hole

key

wo

rd s

ectio

n is

ign

ore

d.

"Lin

e n:

th

is is

th

e se

cond

occ

urre

nce

of a

key

wo

rd"

Th

e re

ad

fu

nct

ion

has

en

cou

nte

red

a s

eco

nd

occ

urr

ence

of

a k

eyw

ord

. T

his

ke

ywo

rd (

and

its

valu

es)

is ig

nor

ed

.

"Lin

e n:

th

e ke

ywo

rd X

FS

FO

RM

is e

xpe

cted

."T

he

rea

d fu

nct

ion

was

exp

ectin

g a

lin

e X

FS

FO

RM

fo

rmn

am

e. It

ig

nore

s th

is l

ine

, bu

tco

ntin

ues

exp

ectin

g X

FS

FO

RM

fo

rmn

am

e.


3-37

"Lin

e n:

th

e n

ame

of

the

field

is m

issi

ng.

"T

he

rea

d f

un

ctio

n h

as f

oun

d t

he

lin

e X

FS

FIE

LD

fie

ldn

am

e, w

ith t

he

field

nam

e m

issi

ng.

Th

is li

ne

is ig

no

red

. T

he

pars

ing

fu

nct

ion

will

stil

l exp

ect

to r

ead

fo

rm k

eyw

ord

se

ctio

ns

and

will

pro

du

ce e

rro

rs f

or f

ield

ke

ywo

rd s

ectio

ns

it d

oes

not

reco

gni

ze.

"Lin

e n:

a w

ord

is t

oo

lon

g to

be

pro

cess

ed.

"A

wo

rd in

th

e in

pu

t fil

e is

to

o lo

ng

, i.e

. >

10

0 ch

ara

cte

rs. T

his

se

ctio

n is

ign

ore

d.

"Lin

e n:

an

inte

ger

wa

s ex

pec

ted

."T

he

read

fun

ctio

n e

xpe

cted

to

re

ad a

n in

teg

er.

Th

is k

eyw

ord

se

ctio

n is

ign

ore

d.

"Lin

e n:

a r

eq

uire

d k

eyw

ord

is m

issi

ng

."T

he

read

fun

ctio

n d

id n

ot

find

all

the

RE

QU

IRE

D k

eyw

ord

s.

"Lin

e n:

th

e ke

ywo

rd U

NIT

is m

issi

ng

in t

he

fo

rm

def

initi

on

."

Th

e ke

ywo

rd s

ect

ion

UN

IT i

s m

issi

ng

in

th

e fo

rm d

efin

itio

n.

Th

e f

orm

will

no

t b

e i

nser

ted

into

th

e fo

rms

data

bas

e.

"Lin

e n:

th

e ke

ywo

rd S

IZE

is m

issi

ng

in t

he

form

d

efin

itio

n."

Th

e ke

ywor

d s

ectio

n S

IZE

is

mis

sing

in

the

fo

rm d

efin

ition

. T

he

fo

rm w

ill n

ot

be

ins

erte

din

to t

he

form

s da

tab

ase

.

"Lin

e n:

th

e ke

ywo

rd L

AN

GU

AG

E is

mis

sin

g in

th

e

form

de

finiti

on.

"T

he

keyw

ord

se

ctio

n L

AN

GU

AG

E is

mis

sing

fro

m t

he f

orm

def

initi

on

. T

he f

orm

will

no

t be

inse

rted

into

the

form

s d

atab

ase

.

"Lin

e n:

th

e ke

ywo

rd P

OS

ITIO

N is

mis

sin

g in

th

e fie

ld d

efin

itio

n."

One

o

f th

e tw

o

keyw

ord

se

ctio

ns

PO

SIT

ION

o

r F

OL

LOW

S

is

man

dat

ory

fo

r a

field

de

finiti

on.

Ne

ither

one

ha

s be

en d

efin

ed

fo

r th

is f

ield

. T

he f

ield

will

no

t b

e in

sert

ed in

to t

hefo

rms

dat

aba

se r

eco

rd o

f th

e c

urre

nt f

orm

.

"Lin

e n:

th

e ke

ywo

rd S

IZE

is m

issi

ng

in t

he

field

d

efin

itio

n."

Th

e ke

ywo

rd S

IZE

is

mis

sin

g in

th

e f

ield

de

finiti

on.

Th

e fie

ld w

ill n

ot

be

inse

rted

in

to t

hed

efin

itio

n o

f th

e c

urr

en

t fo

rm.

"Lin

e n:

a f

ield

can

no

t F

OLL

OW

itse

lf."

Th

e va

lue

of

the

keyw

ord

FO

LLO

WS

is e

qu

al t

o th

e n

ame

of t

his

fie

ld.,

i.e.

th

e f

ield

wo

uld

follo

w it

self.

Th

is k

eyw

ord

sec

tion

is ig

no

red

.

"Lin

e n:

tw

o f

ield

s h

ave

th

e sa

me

field

na

me

s."

Th

is f

ield

has

th

e sa

me

field

nam

e as

an

oth

er

field

th

at h

as

alre

ady

bee

n re

ad

suc

cess

fully

into

th

e c

urr

ent

fo

rm d

efin

itio

n. T

his

fie

ld is

ign

ore

d.

"Lin

e n:

tw

o f

orm

s h

ave

the

sam

e f

orm

nam

es.

"T

his

fo

rm h

as

the

sa

me

form

na

me

as

an

oth

er f

orm

tha

t ha

s a

lrea

dy

been

re

ad s

ucc

essf

ully

,e

ither

fro

m t

he c

urr

en

t in

pu

t fil

e o

r fr

om a

pre

viou

s in

pu

t fil

e. T

his

for

m is

ign

ore

d.

"Lin

e n:

an

OR

op

era

tor

was

exp

ect

ed in

th

e d

efin

itio

n o

f th

e fie

ld s

tyle

."A

n O

R o

per

ato

r w

as

exp

ecte

d w

hen

rea

din

g v

alu

es f

or

the

ST

YLE

ke

ywo

rd o

f a

field

de

finiti

on.

Th

is k

eyw

ord

se

ctio

n is

ign

ore

d.

"Lin

e n:

a v

alu

e h

as o

ccu

rre

d t

wic

e in

th

e d

efin

itio

n

of

the

field

sty

le."

One

val

ue

was

giv

en t

wic

e w

hile

rea

din

g t

he

valu

es

for

the

key

wo

rd S

TY

LE i

n a

field

de

finiti

on.

"Lin

e n:

ke

ywo

rd B

EG

IN w

as

exp

ecte

d."

Th

e ke

ywo

rd B

EG

IN w

as

exp

ecte

d an

d n

ot

foun

d.

Th

e p

arsi

ng

fu

nctio

n w

ill i

gno

re t

hew

hole

fie

ld o

r th

e fo

rm t

hat

it h

as

sta

rte

d r

ead

ing

. T

his

will

re

sult

in f

urt

he

r er

rors

.

Err

or M

essa

geD

escr

iptio

n


3-38

"Lin

e n:

no

form

s h

ave

be

en r

ead

. ch

eck

if fi

le is

e

mp

ty."

No

form

s h

ave

be

en r

ead

succ

ess

fully

fro

m t

he in

pu

t fil

e.

Th

is m

igh

t b

e d

ue

to

th

e in

pu

t fil

eb

ein

g e

mp

ty.

"Lin

e n:

lin

e is

to

o lo

ng t

o p

roce

ss."

A li

ne

in t

he

inp

ut f

ile is

to

o lo

ng

, >

50

0 c

hara

cte

rs.

Th

e p

arsi

ng

fun

ctio

n ig

no

res

the

rest

of

the

line

and

co

ntin

ue

s re

adin

g.

"Lin

e n:

the

field

sp

eci

fied

with

FO

LLO

WS

do

es

no

t e

xist

."T

he

po

sitio

n o

f a

fie

ld w

as s

pe

cifie

d w

ith F

OL

LOW

S

field

X.

field

X h

ow

eve

r co

uld

no

t be

fou

nd

in t

he

def

initi

on

of

the

curr

en

t fo

rm.

Th

e re

ad f

un

ctio

n c

hec

ks w

he

ther

th

e f

ield

ha

s a

valid

P

OS

ITIO

N

def

initi

on

an

d

use

s th

is

inst

ead.

If

th

e

field

d

oes

n

ot

hav

e

a va

lidP

OS

ITIO

N d

efin

itio

n, i

t is

dis

card

ed

.

"Lin

e n:

no

fie

lds

have

be

en r

ead

for

th

is f

orm

."N

o fie

lds

are

def

ined

or

no

fie

lds

are

su

cces

sfu

lly r

ead

for

th

e c

urr

ent

fo

rm.

"Lin

e n:

th

ere

are

fiel

ds

follo

win

g ea

ch o

ther

in a

cy

cle

."S

ever

al f

ield

s th

at

use

the

FO

LLO

WS

de

finiti

on

an

d c

reat

e a

cyc

le.

(e.g

. fie

ld1

FO

LLO

WS

field

2,

field

2 F

OLL

OW

S f

ield

3,

field

3 F

OL

LOW

S f

ield

1).

Th

is e

rro

r is

gen

era

ted

fo

r ea

chfie

ld i

n t

he c

ycle

. T

he

re

ad f

un

ctio

n c

he

cks

wh

eth

er e

ach

fie

ld h

as

a va

lid P

OS

ITIO

Nd

efin

itio

n an

d u

ses

this

inst

ead

. If

the

fie

ld d

oes

no

t h

ave

a v

alid

PO

SIT

ION

def

initi

on

, it

isd

isca

rded

.

"Lin

e n:

a f

ield

ha

s o

verf

low

ed

th

e fo

rm d

efin

itio

n."

A f

ield

ove

rflo

ws

the

fo

rm,

i.e.

field

po

sitio

n +

fie

ldsi

ze >

fo

rmsi

ze.

Th

is f

ield

is d

isca

rded

.

"Lin

e n:

th

is is

no

t a

valid

va

lue

fo

r th

is k

eyw

ord

."A

n in

teg

er

> 0

is e

xpe

cted

as

a va

lue

.

Err

or M

essa

geD

escr

iptio

n




Form Parser Limits 3

The following are the limits of the Form Parser:

PRINTER MEDIA 3

The WOSA/XFS Printer Device class functionality is based on the "forms" model.Media definitions are the descriptions of the print media present on the SelfService Terminal. These definitions contain details about the media such as theprintable area, restricted area and type of fold (for passbooks). A PRINT_FORMcommand uses this information for printing on media with the help of a formdefinition as a format.

In the implementation of forms, the media definitions are stored in files called"Media Definition Files". The names of these files are stored separately in theWindows NT Registry. Each file may contain one or more media definitions.Media definition files are read and parsed during initialization of the serviceprovider.

As in the case of form definitions, media validation is performed in the followingtwo stages:


When the SP starts up, all media definition files are opened and verified for syntax,'required fields' and content. Here, syntax refers to valid keywords, non-duplication of keywords and matching BEGIN/END. Required fields are mediaSIZE, media UNIT and media TYPE. Content is the value of the keywords whichmust be within the capabilities of the device. The media definitions are convertedto an 'in-core' representation called the 'Media Database'. Errors found during thisinitial validation, are recorded in the Media Database and logged in an error logfile. The location of the error log file is specified in the registry.

Runtime validation:

Runtime validation is done when the info or execute command, concerned withmedia (such as QUERY_MEDIA, PRINT_FORM or READ_FORM) are received.It verifies that the media SIZE, etc. do not conflict with the capabilities of thedevice. For example, it verifies that the width of the media specified is not greaterthan 40 for the 40 - column printers.

Errors encountered while parsing media definition files are logged in a media errorlogfile.

Maximum line length (including line continuation) 500 characters

Maximum token (terminated by white space characters) length

100 characters

Maximum quoted (in "") string length 100 characters

Maximum filename length 100 characters

Maximum number of components in an OR list 10

Maximum Length of a component in an OR list 20




Media Parser Error Messages and Limits 3

Media parser error messages are stored in error log files with names of the form "XXXX_MED.LOG"

where

XXXX = RPTR for the receipt printer

JPTR for the journal printer

SPTR for the statement printer

PPTR for the passbook printer

The path where these files are created is default to root (‘\’). But it can be

configured in the Registry.

Media Parser Messages 3

Media definition files are parsed during startup. Any information regarding thefiles that are read and the errors encountered (if any), is stored in the printer mediaerror. The messages generated by the media definition parser are as following:

Parser Messages:

When the read function encounters an error, it is recorded in the error log file. Anerror message specifying the type of error and the line number is also recorded.The read function tries to continue as far as possible. In order to do so, it aborts theprocessing of a line or a keyword section and continues with the next line. Thismay result in further errors.

"Textfile Parser for XFSMEDIA Version x.x" First line of the error log file,giving the version number ofthe read function.

"File <file name>" Indicates the opened files.The messages followingthereafter concerns this file.

"Form <media file name> read successfully" Indicates the successfulreading of the media file.

"Parsed OK" Indicates the successfulreading and parsing of thelast listed file.

"n error(s) found while parsing" Indicates the unsuccessfulreading of the last listed file,and contains n errors.


3-41

Err

or M

essa

ges:

Err

or M

essa

geD

escr

iptio

n

"Err

or

fou

nd

in li

ne n

"A

n e

rro

r h

as o

ccur

red

on

the

nt

h lin

e o

f th

e m

edia

de

finiti

on f

ile.

"Err

or

wh

ile t

ryin

g t

o o

pen

file

"A

n e

rror

has

occ

urr

ed

wh

ile o

pen

ing

an

inp

ut

file

.

"Err

or:

co

uld

not

allo

cate

mem

ory"

An

err

or h

as o

ccu

rre

d w

hile

allo

catin

g m

emo

ry.

"Err

or

wh

ile t

ryin

g t

o r

ead

fro

m f

ile"

An

err

or h

as o

ccu

rre

d w

hile

rea

din

g f

rom

th

e in

pu

t fil

e.

"Lin

e n:

lin

e co

ntin

uatio

n c

hara

cte

r in

valid

ated

" T

he r

ead

fu

nctio

n h

as f

oun

d a

ch

ara

cter

afte

r th

e l

ine

co

ntin

uat

ion

sym

bol

(\).

Th

e r

est

of

the

line

is ig

no

red

.

"Lin

e n:

str

ing

term

inat

ion

ch

arac

ter

no

t fo

und

."

T

he r

ead

fu

nct

ion

did

no

t fin

d a

str

ing

te

rmin

atio

n c

ha

ract

er,

i.e.

a C

R/L

F w

as e

nco

un

tere

dfir

st.

A s

trin

g t

erm

inat

ion

ch

ara

cte

r is

ins

erte

d a

t th

e e

nd

of

the

da

ta t

ha

t h

as b

een

rea

d fo

rth

is li

ne.

"Lin

e n:

ke

ywo

rd e

xpec

ted

."T

he r

ead

fu

nct

ion

exp

ect

ed

to f

ind

a ke

ywor

d w

ith it

s va

lue

s. T

he

entir

e ke

ywo

rd s

ectio

n is

igno

red.

"Lin

e n

: ar

gu

men

t is

mis

sin

g."

The

re

ad f

un

ctio

n e

xpe

cted

to

fin

d a

no

the

r ar

gu

me

nt f

or

this

ke

ywo

rd.

Th

e w

ho

le k

eyw

ord

sect

ion

is ig

no

red

.

"Lin

e n

: w

ron

g t

ype

of a

rgu

me

nt."

The

re

ad f

un

ctio

n e

xpec

ted

to

find

a d

iffe

ren

t so

rt o

f a

rgu

me

nt

for

this

ke

ywor

d.

Th

e w

ho

leke

ywo

rd s

ect

ion

is ig

no

red

.

"Lin

e n

: th

e n

ame

of

the

form

is m

issi

ng

."T

he n

ame

of

a f

orm

is

mis

sin

g, i.

e. t

he

rea

d f

un

ctio

n f

ou

nd o

nly

th

e k

eyw

ord

XF

SM

ED

IAa

nd n

oth

ing

follo

win

g it

. T

he f

orm

will

not

be

inse

rted

into

the

me

dia

da

tab

ase.

Th

e p

ars

ing

fun

ctio

n c

ontin

ues

lo

oki

ng

fo

r th

e n

ext

XF

SM

ED

IA

me

dia

na

me.

A m

issi

ng

for

m n

am

ere

sults

in f

urt

he

r er

rors

.

"Lin

e n

: th

e re

st o

f lin

e is

no

t e

mp

ty."

The

re

ad f

unct

ion

ha

s re

ad a

key

wo

rd s

ect

ion

su

cces

sfu

lly,

bu

t th

e r

est

of

the

lin

e i

s no

te

mp

ty.

The

re

st o

f th

e li

ne

is ig

nore

d.

"Lin

e n

: a

stri

ng

was

exp

ect

ed."

The

re

ad f

unct

ion

wa

s lo

oki

ng

fo

r a

str

ing

("s

trin

g")

as a

n in

pu

t. T

he

wh

ole

key

wo

rdse

ctio

n is

ign

ore

d.

"Lin

e n

: th

is is

th

e se

cond

occ

urre

nce

of a

key

wo

rd"

The

rea

d f

un

ctio

n h

as e

nco

un

tere

d w

ith t

he s

eco

nd

occ

urr

ence

of

a ke

ywo

rd.

Thi

s ke

ywo

rd(a

nd

its

valu

es)

is ig

nore

d.

"Lin

e n

: th

e ke

ywo

rd X

FS

ME

DIA

is e

xpec

ted.

"T

he r

ead

fun

ctio

n w

as e

xpec

ting

a lin

e X

FS

ME

DIA

m

ed

ian

am

e. It

ig

no

res

this

lin

e, b

ut

con

tinu

es

exp

ect

ing

XF

SM

ED

IA

med

iana

me.

"Lin

e n

: a

wor

d is

to

o lo

ng

to b

e p

roce

sse

d."

A w

ord

in t

he

inp

ut

file

is t

oo

lon

g, i

.e.

> 1

00

ch

ara

cter

s. T

his

sect

ion

is ig

nore

d.


3-42

"Lin

e n

: an

inte

ger

wa

s ex

pec

ted

."

The

re

ad f

un

ctio

n e

xpec

ted

to

rea

d a

n in

teg

er.

Thi

s ke

ywo

rd s

ectio

n is

ign

ore

d.

"Lin

e n

: a

req

uire

d k

eyw

ord

is m

issi

ng

."T

he r

ead

fu

nct

ion

did

no

t fin

d a

ll th

e re

qu

ired

key

wo

rds.

"Lin

e n

: th

e ke

ywo

rd U

NIT

is m

issi

ng

in t

he

fo

rm

def

initi

on

."

The

ke

ywo

rd s

ect

ion

UN

IT i

s m

issi

ng

in

th

e m

ed

ia d

efin

ition

. T

he

me

dia

will

not

be

inse

rted

into

th

e m

ed

ia d

atab

ase

.

"Lin

e n

: th

e ke

ywo

rd S

IZE

is m

issi

ng

in t

he

form

d

efin

itio

n."

The

ke

ywor

d s

ectio

n S

IZE

is

mis

sing

in

th

e m

ed

ia d

efin

ition

. T

he m

edia

will

no

t be

inse

rted

into

th

e m

ed

ia d

atab

ase

.

"Lin

e n

: tw

o m

edia

s h

ave

the

sa

me

med

ia n

am

es.

"T

his

me

dia

ha

s th

e

sam

e m

ed

ia

nam

e

as

ano

ther

m

ed

ia,

tha

t h

as

alre

ady

bee

n re

adsu

cce

ssfu

lly e

ither

fro

m t

he

curr

ent

in

pu

t fil

e o

r fr

om

a p

revi

ous

inpu

t fil

e.

Th

is m

edi

a is

igno

red.

"Lin

e n

: ke

ywo

rd B

EG

IN w

as

exp

ecte

d."

The

key

wo

rd B

EG

IN w

as

exp

ect

ed a

nd n

ot

fou

nd

. T

he p

arsi

ng

fun

ctio

n w

ill i

gn

ore

the

wh

ole

med

ia it

has

sta

rted

re

adin

g. T

his

ma

y re

sult

in fu

rthe

r e

rro

rs.

"Lin

e n

: no

form

s h

ave

be

en r

ead

. ch

eck

if fi

le is

e

mp

ty."

No

me

dia

ha

s b

een

read

su

cces

sful

ly f

rom

the

inp

ut

file

. T

his

mig

ht b

e d

ue

to t

he

inp

ut

file

bei

ng

em

pty

.

"Lin

e n

: lin

e is

to

o lo

ng t

o p

roce

ss."

A li

ne

in t

he

inp

ut f

ile is

to

o lo

ng

, >

50

0 ch

ara

cter

s. T

he

pa

rsin

g f

un

ctio

n ig

nore

s th

e r

est

of

the

line

an

d co

ntin

ues

rea

din

g.

"Lin

e n

: th

is is

no

t a

valid

va

lue

fo

r th

is k

eyw

ord

."A

n in

teg

er >

0 is

exp

ecte

d a

s a

va

lue.

Err

or M

essa

geD

escr

iptio

n




Media Parser Limits 3

The following are limits of the Media Parser


1 If two fields overlap, the field defined first in the form definition hasprecedence. Consequently, only a part of the second field will be printed.

2 Double width characters always start in odd numbered columns.Consequently, a space may precede a change from single to double widthmode.

3 The following table lists the limits for the Print command. If these limits arecrossed, an error code WFS_ERR_INVALID_DATA will be returned and anerror message is written to the trace file.

4 If while printing a form, the SP encounters a data that overflows a field, ittruncates the field and logs a message in the trace file. But, it still continuesprinting returning WFS_ERR_INVALID_DATA after printing all thespecified fields.

5 Case change will take place only if the active font supports it.



100 characters





Description Limit

Print Buffer size 2000

Maximum number of batches (batch - string on a particular line for a particular field) that can be printed

100

Maximum number of fields that can be specified as input to the WFS_CMD_PTR_PRINT_FORM command

50

Maximum length of an input string for a field 100


3-44

6T

he

Re

ceip

t an

d J

ou

rna

l P

rin

ter

SP

s an

d d

evic

e d

rive

rs a

ttem

pt t

o r

eco

ver

from

so

me

tra

nsp

ort

an

d m

edia

rela

ted

erro

rs.

If a

fter

rep

eat

ed a

tte

mp

ts,

the

err

or

con

diti

on

pe

rsis

ts,

the

dev

ice

go

es i

nto

a f

ata

l st

ate.

Aco

nd

itio

n th

at c

an b

e c

lea

red

on

ly b

y o

per

ato

r in

terv

en

tion

via

th

e V

DM

. T

he

follo

win

g ta

ble

lis

ts t

he

err

or

con

diti

ons

fro

m w

hic

h t

he

SP

att

emp

ts t

o r

eco

ver,

an

d t

he

actio

n t

o b

e t

ake

n f

or

oth

er

com

mo

nly

occ

urr

ing

err

ors

.

* R

ece

ipt

Pri

nter

onl

y

Err

or C

ondi

tion

Rec

over

y A

ctio

n

Bla

ck M

ark

Err

or

caus

ed b

y 8

succ

essi

ve f

ailu

res

tofe

ed

to

a b

lack

mar

k.*

No

aut

om

atic

rec

ove

ry.

Re

quir

es o

pera

tor

inte

rve

ntio

n v

ia V

DM

Tra

nsp

ort

Jam

ca

use

d b

y th

e f

ailu

re o

f a

rece

ipt

tocl

ear

th

e kn

ife e

dg

e af

ter

a p

rint

op

era

tion

.*D

rive

r m

akes

3 a

tte

mp

ts t

o c

lear

tra

nsp

ort.

If

thes

e a

tte

mp

ts f

ail,

the

con

diti

on

mu

st b

e r

emo

ved

by

op

era

tor

inte

rve

ntio

n v

ia V

DM

.

Pa

rtia

l p

rinte

r re

ceip

t in

tr

ansp

ort

ca

used

b

y a

po

wer

failu

re d

urin

g a

pri

nt o

per

atio

n.*

Driv

er

au

tom

atic

ally

fe

eds

to b

lack

mar

k, a

nd

cu

ts a

nd

pre

sen

ts t

he

rece

ipt

bef

ore

the

nex

t p

rint

. C

an a

lso

be

clea

red

by

pre

ssin

g t

he

pap

er lo

ad s

witc

h.

Pa

per

Lo

w d

urin

g a

prin

t o

per

atio

n.R

eple

nis

h th

e p

ape

r ro

ll. T

he

driv

er a

uto

mat

ical

ly d

etec

ts r

epla

cem

ent.

Pa

per

Ou

t ca

use

d b

y pa

per

ru

nnin

g o

ut

du

ring

a p

rint

op

era

tion

or,

in

the

ca

se o

f th

e re

ceip

t pr

inte

r, 8

0re

ceip

ts b

ein

g p

rinte

d s

ince

a p

ap

er l

ow

co

nditi

on

is

det

ecte

d.

Rep

len

ish

the

pap

er

roll.

Th

e d

river

au

tom

atic

ally

det

ects

rep

lace

men

t.

Pa

per

Ou

t o

r Ja

m b

efo

re T

ran

spo

rt c

au

sed

by

a p

rint

com

ma

nd

bei

ng is

sued

wh

en

no

pap

er

is lo

ad

ed.

Th

e d

rive

r tr

eats

thi

s as

a m

echa

nis

m e

rro

r. N

o a

uto

mat

ic r

ecov

ery

. R

equ

ires

op

erat

or

inte

rve

ntio

n vi

a V

DM

.

Rec

eip

t/Jo

urn

al P

rinte

r O

pen

Au

tom

atic

ally

cle

are

d w

he

n th

e p

rinte

r un

it is

clo

sed.

WOSA/XFS - Programmer’s Reference ManualStatement Printer



Statement Printer 3


3


3


Statement Printer (all variants) sptr_spx.dllsptr_wfp.dllsptr_ipc.dllsptr.dll

sptr.exe


StatementPrinter1 Logical name of the statement printer service provider.

Statement Printer

3-46

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

ke

y.

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

er v

alu

es

are

sto

red

un

de

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

\SP

TR

key

:

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

\FO

RM

S\F

OR

M_

FIL

E_

PA

TH

Th

e p

ath

to

th

e fo

rm f

ile d

efin

itio

ns.

An

y va

lid a

bso

lute

pat

h.

\ME

DIA

\ME

DIA

_F

ILE

_P

AT

HT

he

pat

h t

o t

he m

edia

file

de

finiti

ons

.A

ny

valid

ab

solu

te p

ath

.

\ER

RO

R_F

ILE

_P

AT

H\P

TR

_E

RR

OR

_F

ILE

_P

AT

HP

ath

to

sto

re t

he

erro

r fil

e f

or

log

gin

g e

rro

rs t

hat

o

ccu

r d

urin

g in

itia

liza

tion

.A

ny

valid

ab

solu

te p

ath

.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

GE

NE

RA

L_C

ON

FIG

S\V

aria

nt

Var

ian

t o

f th

e h

ard

wa

re in

stal

led

on

AT

M.

Th

e fo

llow

ing

va

rian

ts a

re s

up

port

ed b

y th

e st

atem

en

t pr

inte

r S

P.

ST

D_

ST

AT

EM

EN

T -

sta

nda

rd s

tate

men

t B

UN

CH

ER

_ST

AT

EM

EN

T

- b

un

cher

sta

tem

en

t C

OM

BIN

AT

ION

_S

TA

TE

ME

NT

_P

AS

SB

OO

K -

co

mb

ina

tion

s

tate

men

t/p

ass

bo

ok

GE

NE

RA

L_C

ON

FIG

S\S

usp

end

Tim

eo

utT

ime

fo

r w

hic

h t

he

dev

ice

is

susp

end

ed

wh

en c

ust

om

er t

amp

erin

g is

su

spec

ted

.T

ime

in s

eco

nds

. Def

aults

to

300

sec

s.

GE

NE

RA

L_C

ON

FIG

S\M

edia

Len

gth

Sta

tem

en

t pr

inte

r m

ed

ia le

ng

th.

Sta

tem

en

t pa

per

leng

th in

inch

es.

Val

ues

of

Med

iaL

eng

thca

n b

e 4”

or

6”.

Def

aults

to

4”.

GE

NE

RA

L_C

ON

FIG

S\C

omb

ined

Sp

ecifi

es w

he

the

r th

e s

tate

me

nt

pri

nte

r is

a co

mb

ine

d s

tate

men

t p

ass

bo

ok p

rin

ter.

Val

ues

ca

n b

e

l0

if n

ot c

om

bin

ed

l1

if co

mb

ined

Def

aul

ts t

o 0

.

GE

NE

RA

L_C

ON

FIG

S\M

axM

edi

aRe

tra

cted

Max

imu

m m

edia

ite

ms

that

th

e r

etra

ct b

inca

n h

old

.10

by

defa

ult

for

the

stat

emen

t p

rinte

r (6

bu

nch

es,

i.e

.m

axi

mu

m o

f 1

0 x

6 =

60

sta

tem

ent

s fo

r th

e b

un

che

rva

rian

t).

GE

NE

RA

L_C

ON

FIG

S\M

axM

edi

aOnS

tack

erM

axim

um

med

ia it

em

s th

at c

an b

e st

ack

ed

by t

he

bu

nch

er s

tate

me

nt

prin

ter.

10 b

y d

efa

ult

for

the

bu

nch

er

varia

nt

of t

he

stat

eme

nt

prin

ter.

Statement Printer

3-47

Cap

abili

ties

Cap

abili

tyV

alu

e

Co

mp

ou

ndT

RU

E (

for

com

pou

nd

sta

tem

ent

/ p

assb

ook

pri

nte

r)F

ALS

E (

for

sta

nda

rd a

nd

bu

nch

er

stat

emen

t-o

nly

prin

ters

)

Res

olu

tion

LOW

Rea

d F

orm

Su

ppo

rtF

AL

SE

Wri

te F

orm

Su

pp

ort

TR

UE

(o

nly

text

)

Ext

ents

Sup

po

rtF

ALS

E

Su

pp

orte

d C

on

trol

s C

UT

, E

JEC

T,

FL

US

H,

RE

TR

AC

T, S

TA

CK

(S

TA

CK

on

ly f

or

bu

nch

er v

aria

nts

)

Asy

nch

ron

ous

me

dia

acc

epta

nce

FA

LSE

Ret

ract

Bin

cap

aci

ty1

0 fo

r th

e s

tan

da

rd a

nd

th

e co

mb

ina

tion

sta

tem

ent/

pa

ssb

oo

k p

rinte

r.6

x 1

0 =

60

fo

r th

e bu

nch

er

stat

emen

t p

rinte

r.

Sta

cker

cap

aci

ty1

0 x

10

= 1

00

fo

r b

unc

her

sta

tem

en

t pr

inte

r.1

0 fo

r st

and

ard

sta

tem

ent

an

d c

om

bin

ed s

tate

me

nt/

pas

sbo

ok

prin

ter.

Statement Printer

3-48

Con

form

ance

Mat

rix -

Com

man

ds3

WO

SA

Com

man

dC

LC

omm

ents

WF

S_

INF

_PT

R_

ST

AT

US

1l

fwD

evi

ce o

f W

FS

_P

TR

_D

EV

PO

WE

RO

FF,

WF

S_

PT

R_

DE

VB

US

Y a

nd

WF

S_

PT

R_D

EV

NO

DE

VIC

E a

re n

eve

r re

turn

ed.

lu

sRetr

act

Cou

nt fie

ld

ind

icat

es

the

to

tal

nu

mb

er

of

item

s in

th

e re

trac

t b

in.

For

th

eco

mb

ina

tion

stat

emen

t/p

assb

ook,

th

is i

s th

e su

m o

f th

e st

ate

me

nts

an

d p

ass

bo

oks

pre

sen

t in

the

retr

act

bin

.

WF

S_

INF

_PT

R_

CA

PA

BIL

ITIE

S2

No

ne

WF

S_

INF

_PT

R_

FO

RM

_LI

ST

2N

on

e

WF

S_

INF

_PT

R_

ME

DIA

_LI

ST

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

FO

RM

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

ME

DIA

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

FIE

LD

2N

on

e

WF

S_

CM

D_

PT

R_C

ON

TR

OL_

ME

DIA

1l

Su

pp

ort

s o

nly

the

follo

win

g co

ntr

ol c

ode

s:

lW

FS

_P

TR

_CT

RL

CU

T,

lW

FS

_P

TR

_CT

RL

EJE

CT,

lW

FS

_P

TR

_CT

RL

RE

TR

AC

T

lW

FS

_P

TR

_CT

RL

FLU

SH

lW

FS

_P

TR

_CT

RL

STA

CK

(B

un

che

r va

rian

t o

nly.

)

lW

FS

_P

TR

_CT

RL

CU

T w

ill r

esu

lt in

cu

ttin

g a

s w

ell a

s ej

ectin

g t

he

sta

tem

en

t.

lU

nsu

pp

ort

ed

con

tro

l cod

es

are

ign

ore

d.

lIf

the

con

trol

cod

es

WF

S_P

TR

_C

TR

LR

ET

RA

CT

an

d W

FS

_P

TR

_C

TR

LEJE

CT

are

sp

ecifi

edto

geth

er,

th

e e

rro

r co

de

WF

S_

ER

R_

INVA

LID

_D

ATA

is r

etu

rne

d.

lIf

WF

S_

PT

R_

CT

RLF

LU

SH

is s

pec

ified

, w

itho

ut a

ny

prin

ted

sta

tem

ent

be

ing

pre

sen

t fr

om

ap

revi

ous

WF

S_

CM

D_P

TR

_P

RIN

T_F

OR

M c

omm

and

, n

o e

rro

r is

gen

era

ted

. In

ste

ad,

a n

ew

stat

em

ent

is m

ove

d t

o t

he p

rint

po

sitio

n.

lH

ow

eve

r, in

th

e ab

ove

cas

e, W

FS

_P

TR

_C

TR

LRE

TR

AC

T a

nd

WF

S_

PT

R_

CT

RLE

JEC

T w

illre

turn

the

err

or c

od

e W

FS

_E

RR

_P

TR

_N

OM

ED

IAP

RE

SE

NT

.

Statement Printer

3-49

WF

S_

CM

D_

PT

R_P

RIN

T_

FO

RM

1l

Rig

ht

alig

ned

fie

lds

are

no

t su

pp

ort

ed.

lS

up

po

rts

onl

y lo

w r

esol

utio

n. O

ther

res

olu

tion

s ar

e ig

nore

d.

lD

oe

s n

ot

retu

rn e

rro

r co

de

WF

S_

ER

R_P

TR

_M

ED

IAS

KE

WE

D.

lS

up

po

rts

onl

y th

e fo

llow

ing

con

tro

l co

des:

lW

FS

_P

TR

_CT

RL

CU

T,

lW

FS

_P

TR

_CT

RL

EJE

CT

lW

FS

_P

TR

_CT

RL

RE

TR

AC

T

lW

FS

_P

TR

_CT

RL

FLU

SH

lW

FS

_P

TR

_CT

RL

STA

CK

(B

un

che

r va

rian

t o

nly)

lW

FS

_P

TR

_CT

RL

CU

T w

ill r

esu

lt in

cu

ttin

g a

s w

ell a

s ej

ectin

g t

he

sta

tem

en

t.

lU

nsu

pp

ort

ed

con

tro

l cod

es

are

ign

ore

d.

lIf

co

ntr

ol

cod

es W

FS

_P

TR

_C

TR

LR

ET

RA

CT

an

d W

FS

_P

TR

_CT

RL

EJE

CT

are

sp

ecifi

edto

geth

er,

th

e e

rro

r co

de

WF

S_

ER

R_

INVA

LID

_D

ATA

is r

etu

rne

d.

lT

he f

orm

an

d f

ield

s sp

eci

fied

fo

r p

rintin

g s

ho

uld

sat

isfy

th

e f

ollo

win

g c

on

diti

on

s:

lO

rien

tatio

n c

ann

ot

be

LA

ND

SC

AP

E.

lS

KE

W c

an

onl

y b

e 0

.

lS

IDE

can

on

ly b

e F

RO

NT.

lT

YP

E c

an

on

ly b

e T

EX

T.

lG

RA

PH

ICS

ca

n o

nly

be

BE

ST

FIT

(de

fau

lt).

lB

AR

CO

DE

ca

n o

nly

be

NO

NE

(d

efa

ult)

.

lS

TY

LE

can

on

ly

be

NO

RM

AL

(d

efa

ult)

o

r D

OU

BLE

fo

r th

e

com

bin

atio

nst

ate

men

t/p

ass

bo

ok

pri

nte

r.

Ho

wev

er,

for

the

sta

nda

rd s

tate

me

nt-o

nly

and

bun

cher

sta

tem

ent

varia

nts,

ST

YL

E c

anh

ave

valu

es

NO

RM

AL

(de

fau

lt),

DO

UB

LE, B

OL

D a

nd U

ND

ER

.

lH

OR

IZO

NTA

L ju

stifi

catio

n c

an o

nly

be

LE

FT (

de

fau

lt),

RIG

HT

or

CE

NT

ER

.

lV

ER

TIC

AL

just

ifica

tion

can

be

TO

P (

defa

ult)

, C

EN

TE

R,

BO

TT

OM

or

JUS

TIF

Y.

lC

OL

OR

ca

n o

nly

be

BLA

CK

.

cont

inu

ed

...

WO

SA

Com

man

dC

LC

omm

ents

Statement Printer

3-50

WF

S_

CM

D_

PT

R_P

RIN

T_

FO

RM

1l

FO

NT

sho

uld

be

one

of

the

follo

win

g:

INT

ER

NA

TIO

NA

L1

INT

ER

NA

TIO

NA

L2

INT

ER

NA

TIO

NA

L3

INT

ER

NA

TIO

NA

L4

INT

ER

NA

TIO

NA

L5

AR

AB

IC1

AR

AB

IC2

AR

AB

IC3

AR

AB

IC4

AR

AB

IC5

lP

OIN

TS

IZE

is n

ot

sup

por

ted

an

d if

sp

eci

fied

is (

ign

ore

d).

lC

PI

can

be

5.0

, 1

0.0

(de

fau

lt),

12

.0 o

r 1

7.1

4.

Ho

wev

er,

if C

PI

is s

pe

cifie

d a

s o

the

r th

an1

0.0

(d

efa

ult)

, th

en

CA

SE

sh

oul

d n

ot

be

DO

UB

LE.

lC

AS

E c

han

ge

is e

ffect

ive

on

ly if

th

e fo

nt

sup

po

rts

it.

lL

PI

can

on

ly t

ake

va

lue

s b

etw

een

1.0

and

9.0

. Th

e fo

llow

ing

res

tric

tion

s a

lso

ap

ply

:

lT

wo

mu

lti-li

ne f

ield

s (f

ield

s w

ith h

eig

ht

> 1

), s

ay f

ield

1 an

d f

ield

2 h

avin

g d

iffer

ent

valu

es f

or

LPI s

ho

uld

sat

isfy

th

e fo

llow

ing

co

nditi

on

s:

- fie

ld1

y!=

fie

ld2

y a

nd

- fie

ld1

y >

= f

ield

2y

+ f

ield

2he

igh

t -

1i.e

. tw

o m

ulti

-lin

e f

ield

s h

avin

g d

iffe

ren

t va

lues

for

LP

I sh

ould

no

t ov

erla

p.

lF

OR

MA

T is

not

sup

po

rte

d, a

nd

if s

pec

ified

is ig

no

red

.

lT

he m

edia

sp

ecifi

ed f

or

pri

ntin

g s

hou

ld s

atis

fy t

he

follo

win

g co

nd

ition

s:

lT

YP

E c

an

on

ly b

e G

EN

ER

IC (

def

aul

t).

lR

ES

TR

ICT

ED

, F

OL

D,

ST

AG

GE

RIN

G,

PA

GE

an

d L

INE

S a

re n

ot

sup

po

rte

d,

and

if

spe

cifie

d a

re ig

nore

d

lS

IZE

wid

th s

hou

ld b

e <

= 8

0

lS

IZE

he

igh

t sh

ou

ld b

e <

= 2

3 f

or S

tate

me

nt

prin

ter

with

4"

me

dia

,

lS

IZE

he

igh

t <=

39

for

Sta

tem

ent

pri

nte

r w

ith 6

" m

edia

.

WF

S_

CM

D_

PT

R_P

RIN

T_

FO

RM

1N

on

e

WF

S_

CM

D_

PT

R_R

EA

D_

FO

RM

0N

on

e

WF

S_

CM

D_

PT

R_R

AW

_DA

TA

1T

he r

aw d

ata

inp

ut

is p

ass

ed

to

th

e p

rinte

r w

ithou

t in

terp

reta

tion

. U

nsu

pp

orte

d c

on

tro

l co

des

are

repl

aced

by

the

cha

ract

er

']'.

The

ra

w d

ata

is a

lwa

ys p

rint

ed f

rom

the

fir

st li

ne,

firs

t co

lum

n o

nw

ard

s.

WO

SA

Com

man

dC

LC

omm

ents

Statement Printer

3-51

WF

S_

CM

D_

PT

R_M

ED

IA_

EX

TE

NT

S0

No

ne

WF

S_

CM

D_

PT

R_R

ES

ET

_C

OU

NT

2N

on

e

WF

S_

CM

D_

PT

R_R

EA

D_

IMA

GE

0N

on

e

WO

SA

Com

man

dC

LC

omm

ents

Statement Printer

3-52

Con

form

ance

Mat

rix -

Err

ors

3

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_I

NF

_PT

R_

FO

RM

_LIS

TN

on

e2

No

ne

WF

S_I

NF

_PT

R_

ME

DIA

_LI

ST

No

ne

2N

on

e

WF

S_I

NF

_PT

R_

QU

ER

Y_

FO

RM

WF

S_E

RR

_IN

VA

LID

_P

OIN

TE

R2

Ret

urn

ed

if t

he

inpu

t p

oin

ter

is N

ULL

or

inva

lid.

WF

S_E

RR

_P

TR

_FO

RM

INV

ALI

D2

Ret

urn

ed

w

hen

th

e fo

rm

de

finiti

on

spe

cifie

dd

oes

n

ot

satis

fy

the

co

nd

itio

ns

giv

en

in

th

eco

mm

and

co

nfo

rma

nce

mat

rix

for

the

CM

D_

PT

R_

PR

INT

_F

OR

M c

om

man

d.

WF

S_E

RR

_P

TR

_FO

RM

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e fo

rm n

am

e s

pe

cifie

d i

s no

tfo

und

in t

he

form

file

s a

t st

art

up

.

WF

S_I

NF

_PT

R_

QU

ER

Y_

ME

DIA

WF

S_E

RR

_IN

VA

LID

_P

OIN

TE

R2

Ret

urn

ed

if t

he

inpu

t p

oin

ter

is N

ULL

or

inva

lid.

WF

S_E

RR

_P

TR

_ME

DIA

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e m

edia

na

me

sp

eci

fied

is n

ot

foun

d in

th

e m

edia

file

s.

WF

S_E

RR

_P

TR

_ME

DIA

INV

ALI

D2

Ret

urn

ed

wh

en

th

e m

edia

d

efin

itio

n

spec

ified

do

es

no

t sa

tisfy

th

e

con

diti

ons

giv

en

inco

mm

and

co

nfo

rma

nce

mat

rix

for

the

CM

D_

PT

R_

PR

INT

_F

OR

M c

om

ma

nd

.

WF

S_I

NF

_PT

R_

QU

ER

Y_

FIE

LD

WF

S_E

RR

_IN

VA

LID

_P

OIN

TE

R2

Ret

urn

ed

if t

he

inpu

t p

oin

ter

is N

ULL

or

inva

lid.

WF

S_E

RR

_P

TR

_FO

RM

INV

ALI

D2

Ret

urn

ed

wh

en t

he

form

de

finiti

on

sp

ecifi

ed i

nth

e

inp

ut

stru

ctu

re

do

es

no

t sa

tisfy

th

eco

nd

ition

s gi

ven

in

co

mm

and

co

nfo

rman

cem

atr

ix

for

the

CM

D_

PT

R_

PR

INT

_F

OR

Mco

mm

and

.

WF

S_E

RR

_P

TR

_FO

RM

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e f

orm

na

me

spe

cifie

d in

the

inp

ut

stru

ctu

re is

no

t fo

und

in t

he

form

file

s.

con

tinu

ed

....

Statement Printer

3-53

WF

S_I

NF

_PT

R_

QU

ER

Y_

FIE

LD

WF

S_E

RR

_P

TR

_FIE

LDN

OT

FO

UN

D2

Ret

urn

ed

wh

en

the

fie

ld n

am

e s

pe

cifie

d in

the

inp

ut

stru

ctu

re

is

no

t fo

un

d in

th

e fo

rmd

efin

itio

n.

WF

S_E

RR

_P

TR

_FIE

LDIN

VA

LID

2R

etu

rne

d

whe

n

the

fie

ld

defin

itio

n

spec

ified

do

es

no

t sa

tisfy

th

e

con

diti

ons

giv

en

inco

mm

and

co

nfo

rma

nce

mat

rix

for

the

CM

D_

PT

R_

PR

INT

_F

OR

M c

om

ma

nd

.

WF

S_C

MD

_P

TR

_CO

NT

RO

L_M

ED

IAW

FS

_ER

R_

INV

AL

ID_

PO

INT

ER

2R

etu

rne

d w

hen

th

e co

ntr

ol i

npu

t is

no

t pa

sse

d t

oth

e

com

ma

nd

, o

r if

the

prin

ter

is

NU

LL

or

inva

lid.

WF

S_E

RR

_IN

VA

LID

_D

AT

A2

Ret

urn

ed

w

hen

an

u

nkn

ow

n co

ntr

ol

code

fo

rd

wM

ed

iaC

ont

rol is

sp

eci

fied

in t

he

inp

ut.

Als

o

retu

rne

d

wh

en

WF

S_

PT

R_

CT

RL

EJE

CT

and

W

FS

_P

TR

_C

TR

LRE

TR

AC

T

com

man

ds

are

sp

eci

fied

tog

eth

er.

WF

S_E

RR

_P

TR

_NO

ME

DIA

PR

ES

EN

T2

Gen

era

ted

whe

n t

he p

rint

er

is o

ut

of p

aper

.

WF

S_E

RR

_P

TR

_FLU

SH

FA

IL0

Nev

er

ge

nera

ted

sin

ce t

he d

ata

is a

lwa

ys f

lush

edto

th

e d

evic

e.

WF

S_E

RR

_P

TR

_RE

TR

AC

TB

INF

UL

L2

Gen

era

ted

wh

en

th

e r

etr

act

bin

ha

s m

ore

th

an 1

0m

ed

ia

item

s in

it.

F

or

the

com

bin

atio

nst

atem

ent/

pas

sboo

k,

this

is

th

e

sum

o

f th

est

atem

ents

and

pas

sbo

oks

in t

he

retr

act

bin

.

WF

S_E

RR

_P

TR

_ST

AC

KE

RF

UL

L2

Gen

era

ted

w

hen

th

e st

ack

er

has

st

acke

d

10

stat

emen

ts (

bu

nch

er s

tate

me

nt

prin

ter

on

ly).

Ret

urn

ed

on

ly w

he

n W

FS

_P

TR

_C

TR

LST

AC

Kco

mm

and

is s

pec

ified

in t

he

inp

ut.

WF

S_E

RR

_P

TR

_PA

GE

TU

RN

FA

IL0

No

ne

WF

S_E

RR

_P

TR

_ME

DIA

TU

RN

FA

IL0

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Statement Printer

3-54

WF

S_C

MD

_P

TR

_PR

INT

_FO

RM

WF

S_E

RR

_IN

VA

LID

_P

OIN

TE

R2

Ret

urn

ed

wh

en t

he

inp

ut

stru

ctu

re i

s n

ot

pas

sed

to t

he

com

man

d,

or

if th

e p

rinte

r is

NU

LL

or

inva

lid.

WF

S_E

RR

_IN

VA

LID

_D

AT

A2

Ret

urn

ed

w

hen

an

u

nkn

ow

n co

ntr

ol

code

fo

rd

wM

ed

iaC

ont

rol is

sp

eci

fied

in t

he

inp

ut.

Als

o

retu

rne

d

wh

en

WF

S_

PT

R_

CT

RL

EJE

CT

and

W

FS

_P

TR

_C

TR

LRE

TR

AC

T

com

man

ds

are

sp

eci

fied

tog

eth

er.

WF

S_E

RR

_P

TR

_FO

RM

INV

ALI

D2

Ret

urn

ed

wh

en t

he

form

de

finiti

on

sp

ecifi

ed i

nth

e

inp

ut

stru

ctu

re

do

es

no

t sa

tisfy

th

eco

nd

ition

s gi

ven

in

the

com

ma

nd c

on

form

ance

ma

trix

fo

r th

e C

MD

_P

TR

_P

RIN

T_

FO

RM

com

ma

nd.

WF

S_E

RR

_P

TR

_FO

RM

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e f

orm

na

me

spec

ified

inth

e in

put

stru

ctu

re is

no

t fo

un

d in

th

e fo

rm f

iles.

WF

S_E

RR

_P

TR

_ME

DIA

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e m

edia

na

me

spe

cifie

d i

n t

hein

pu

t st

ruct

ure

is n

ot

foun

d in

th

e m

edia

file

s.

WF

S_E

RR

_P

TR

_ME

DIA

INV

ALI

D2

Ret

urn

ed

wh

en

th

e m

ed

ia d

efin

itio

n s

peci

fied

inth

e

inp

ut

stru

ctu

re

do

es

no

t sa

tisfy

th

eco

nd

ition

s gi

ven

in

the

com

ma

nd c

on

form

ance

ma

trix

fo

r th

eW

FS

_CM

D_

PT

R_

PR

INT

_FO

RM

co

mm

and

.

WF

S_E

RR

_P

TR

_ME

DIA

SK

EW

ED

0N

eve

r re

turn

ed.

Ske

w c

ann

ot

be

det

ecte

d

WF

S_E

RR

_P

TR

_ME

DIA

OV

ER

FL

OW

2R

etu

rne

d

wh

en

the

prin

t d

ata

o

verf

low

s th

em

ed

ia b

ou

nda

ries.

WF

S_E

RR

_P

TR

_FIE

LDS

PE

CF

AIL

UR

E2

Ret

urn

ed

whe

n a

fie

ld i

s sp

eci

fied

tw

ice

in

the

inp

ut.

WF

S_E

RR

_P

TR

_FIE

LDE

RR

OR

2R

etu

rne

d if

an

err

or

occ

urr

ed w

hile

pro

cess

ing

afie

ld.

con

tinu

ed

...

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Statement Printer

3-55

WF

S_C

MD

_P

TR

_PR

INT

_FO

RM

WF

S_E

RR

_P

TR

_FLU

SH

FA

IL2

Ad

diti

on

al

erro

r co

de.

Re

turn

ed w

he

n th

e p

rint

form

co

mm

and

tr

ies

to

prin

t d

ata

ab

ove

o

rb

efo

re t

he

cur

rent

po

sitio

n o

f th

e p

rin

t he

ad.

WF

S_E

RR

_P

TR

_RE

TR

AC

TB

INF

UL

L2

Gen

era

ted

a

fter

10

ca

ptu

res

ha

ve

be

enp

erfo

rme

d.

WF

S_E

RR

_P

TR

_ST

AC

KE

RF

UL

L2

Gen

era

ted

w

hen

th

e st

ack

er

has

st

acke

d

10

stat

emen

ts (

bu

nch

er s

tate

me

nt

prin

ter

on

ly).

No

prin

ting

is d

one

if t

he s

tack

er is

ful

l.

WF

S_E

RR

_P

TR

_PA

GE

TU

RN

FA

IL0

No

ne

WF

S_E

RR

_P

TR

_ME

DIA

TU

RN

FA

IL0

No

ne

WF

S_C

MD

_P

TR

_RE

AD

_F

OR

MW

FS

_ER

R_

PT

R_R

EA

DN

OT

SU

PP

OR

TE

D2

Rea

d is

no

t su

ppo

rted

by

the

stat

eme

nt

prin

ter.

WF

S_E

RR

_P

TR

_FO

RM

INV

ALI

D0

Nev

er

retu

rned

WF

S_E

RR

_P

TR

_FO

RM

NO

TF

OU

ND

0N

eve

r re

turn

ed

WF

S_E

RR

_P

TR

_ME

DIA

NO

TF

OU

ND

0N

eve

r re

turn

ed

WF

S_E

RR

_P

TR

_ME

DIA

INV

ALI

D0

Nev

er

retu

rned

WF

S_E

RR

_P

TR

_ME

DIA

SK

EW

ED

0N

eve

r re

turn

ed

WF

S_E

RR

_P

TR

_FIE

LDS

PE

CF

AIL

UR

E0

Nev

er

retu

rned

WF

S_E

RR

_P

TR

_FIE

LDE

RR

OR

0N

eve

r re

turn

ed

WF

S_E

RR

_P

TR

_RE

TR

AC

TB

INF

UL

L0

Nev

er

retu

rned

WF

S_E

RR

_P

TR

_ST

AC

KE

RF

UL

L0

Nev

er

retu

rned

WF

S_E

RR

_P

TR

_PA

GE

TU

RN

FA

IL0

Nev

er

retu

rned

WF

S_E

RR

_P

TR

_ME

DIA

TU

RN

FA

IL0

Nev

er

retu

rned

WF

S_C

MD

_P

TR

_RA

W_D

AT

AN

on

e0

No

ne

WF

S_C

MD

_P

TR

_ME

DIA

_E

XT

EN

TS

WF

S_E

RR

_P

TR

_EX

TE

NT

NO

TS

UP

PO

RT

ED

2T

he

dev

ice

do

es n

ot

rep

ort

ext

en

ts.

WF

S_C

MD

_P

TR

_RE

SE

T_C

OU

NT

No

ne

0N

on

e

WF

S_C

MD

_P

TR

_RE

AD

_IM

AG

EN

on

e0

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Statement Printer

3-56

Con

form

ance

Mat

rix -

Eve

nts

3

WO

SA

Eve

ntC

LC

omm

ents

WF

S_

EX

EE

_P

TR

_N

OM

ED

IA2

No

ne

WF

S_

EX

EE

_P

TR

_M

ED

IAIN

SE

RT

ED

0N

on

e

WF

S_

EX

EE

_P

TR

_F

IEL

DE

RR

OR

2N

on

e

WF

S_

EX

EE

_P

TR

_F

IEL

DW

AR

NIN

G2

No

ne

WF

S_

SR

VE

_P

TR

_M

ED

IAT

AK

EN

2N

on

e

WF

S_

SR

VE

_P

TR

_M

ED

IAIN

SE

RT

ED

0N

on

e

WF

S_

US

RE

_P

TR

_P

AP

ER

TH

RE

SH

OLD

2G

en

erat

ed

onl

y w

he

n a

prin

t (W

FS

_C

MD

_P

TR

_P

RIN

T_

FO

RM

or

WF

S_

CM

D_P

TR

_R

AW

_D

AT

A)

is a

tte

mp

ted

.

WF

S_

US

RE

_P

TR

_T

ON

ER

TH

RE

SH

OLD

2G

en

erat

ed

onl

y w

he

n a

prin

t (W

FS

_C

MD

_P

TR

_P

RIN

T_

FO

RM

or

WF

S_

CM

D_P

TR

_R

AW

_D

AT

A)

is a

tte

mp

ted

.

WF

S_

US

RE

_P

TR

_R

ET

RA

CT

BIN

TH

RE

SH

OL

D2

Ge

ner

ate

d af

ter

10

ca

ptu

res

hav

e b

een

per

form

ed.

WOSA/XFS - Programmer’s Reference ManualStatement Printer



PRINTER FORMS 3

Refer to the Printer Forms section of the Receipt and Journal Printers DeviceClass.


The following guidelines are in addition to those for the Receipt and Journalprinters.

1 An error file (sptr_frm.log) is created during the parsing of the form definitionfiles. All the errors during the parse run are logged into this error file. Thecause of error/s can be found by examining this file. Similarly, an error file(sptr_med.log) is created while parsing of the media definition files. All theerrors during the parse run are logged into this error file. The cause of error/scan be found by examining this file.

2 Any statement present at the time of SP initialization is captured. Similarly,for the combination statement/passbook printer, a statement or passbookpresent is captured.

3 For the combination statement/passbook printers, ensure that all thetransactions with the statement printer end with an eject or a capture beforeissuing commands to the passbook printer. If a printed statement is presentunder the head, and a print command is given to the passbook printer, a systemescape might take place.

4 A statement is printed with the line "INITIALIZING STATEMENTPRINTER" during initialization. This is then captured and retracted into theretract bin to update the status.

5 The timeouts specified should be long enough (> 30s approx.) for printing,stacking, capturing and ejecting a statement. Especially, the buncher varianttakes a long time. The correct timeouts can be found out by trial-and-error.

6 In case a customer tampering is suspected, the commands issued after thecommand that have sensed the conditions are not accepted for the period(SuspendTimeout) specified in the registry. These commands will return withthe error code WFS_ERR_DEV_NOT_READY. Also, if any statement ispresent in the transport, it is captured. The status is checked at intervals ofSuspendTimeout seconds, and a system status change event is generated if thedevice status changes.

7 The Statement SP and device driver attempt to recover from some transportand media related errors. If after repeated attempts, the error conditionpersists, the device goes into a fatal state. A condition that can be cleared onlyby operator intervention via the VDM. The following table lists the errorconditions from which the SP attempts to recover, and the action to be takenfor other commonly occurring errors.

Statement Printer

3-58

Err

or C

ondi

tion

Rec

over

y A

ctio

n

Pa

per

Lo

w d

urin

g a

prin

t o

per

atio

n.

Rep

len

ish

the

med

ia.

Th

e d

rive

r au

tom

atic

ally

det

ects

rep

lace

men

t.

Cap

ture

Bin

fu

llE

mpt

y th

e ca

ptu

re b

in.

Th

e d

river

au

tom

atic

ally

res

ets

the

cap

ture

co

unt.

Fo

rm J

am d

urin

g c

aptu

re

No

aut

om

atic

rec

ove

ry.

Re

quir

es o

pera

tor

inte

rve

ntio

n v

ia V

DM

.

Pa

per

Lo

ad E

rro

rN

o a

uto

ma

tic r

eco

very

. Re

quir

es o

pera

tor

inte

rve

ntio

n v

ia V

DM

.

Me

dia

Jam

No

aut

om

atic

rec

ove

ry.

Re

quir

es o

pera

tor

inte

rve

ntio

n v

ia V

DM

.

Cu

sto

mer

ta

mp

erin

g d

urin

g ca

ptu

re.

Wh

en t

he

driv

er

de

tect

s a

sta

tem

en

t st

uck

in

the

thro

at

of

the

prin

ter

wh

ich

can

no

t b

ep

ulle

d i

n,

the

SP

ass

um

es t

hat

cu

stom

er t

ampe

ring

has

occ

urr

ed a

nd

en

ters

a s

usp

end

stat

e fo

r 'S

usp

end

Tim

eo

ut'

min

ute

s,

du

ring

w

hich

al

l co

mm

and

s th

at

hav

e

dev

ice

inte

ract

ion

will

re

turn

WF

S_

ER

R_

DE

V_

NO

T_R

EA

DY

.O

n e

xpiry

of

this

pe

riod

, th

e S

P c

hec

ks t

he

sta

tus

of

the

dev

ice,

an

d i

f it

is f

oun

d t

o b

eh

ealth

y, r

esu

me

s n

orm

al o

per

atio

n.

If u

ser

tam

per

ing

per

sist

s, t

he

dev

ice

go

es

into

a f

atal

stat

e,

follo

win

g

wh

ich

a

ll co

mm

and

s is

sued

to

th

e

de

vice

w

ill

retu

rnW

FS

_E

RR

_H

AR

DW

AR

E_E

RR

OR

.R

ecov

ery

now

req

uire

s o

pe

rato

r in

terv

entio

n v

ia V

DM

.

Cla

mp

Jam

med

Clo

sed

(Bu

nch

er

varia

nt

on

ly)I

f th

e p

rinte

r d

rive

r d

ete

cts

the

cla

mp

in a

do

wn

pos

itio

n b

efo

re p

ape

r is

fed

to

the

prin

t-h

ead

at t

he

star

t o

f a

sta

tem

en

t pr

int

ope

ratio

n,

the

SP

ass

um

es

tha

t cu

sto

mer

ta

mp

erin

gh

as o

ccu

rred

an

d en

ters

a s

usp

end

sta

te f

or '

Su

spen

dT

ime

ou

t' m

inut

es,

du

ring

wh

ich

all

com

man

ds

tha

t ha

ve d

evi

ce in

tera

ctio

n w

ill r

etu

rn W

FS

_E

RR

_D

EV

_N

OT

_RE

AD

Y.

On

exp

iry o

f th

is p

erio

d,

the

SP

ch

ecks

th

e s

tatu

s o

f th

e d

evic

e, a

nd

if

it is

fo

und

to

be

hea

lthy,

re

sum

es

no

rma

l op

erat

ion

. If

use

r ta

mp

erin

g p

ersi

sts,

th

e d

evic

e g

oe

s in

to a

fat

alst

ate,

fo

llow

ing

w

hic

h

all

com

man

ds

issu

ed

to

the

d

evi

ce

will

re

turn

WF

S_

ER

R_

HA

RD

WA

RE

_ER

RO

R.

Rec

ove

ry n

ow r

equ

ires

op

era

tor

inte

rven

tion

via

VD

M.

WOSA/XFS - Programmer’s Reference ManualPassbook Printer



Passbook Printer 3



3


Passbook Printer pptr_spx.dllpptr_wfp.dllpptr_ipc.dllpptr.dll

pptr.exe


PassbookPrinter1 Logical name of the passbook printer service provider.

Passbook Printer

3-60

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

ke

y.

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

\PP

TR

key

:

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

\FO

RM

S\F

OR

M_

FIL

E_

PA

TH

Th

e p

ath

to

the

form

file

de

finiti

on

s.A

ny

valid

ab

solu

te p

ath

.

\ME

DIA

\ME

DIA

_F

ILE

_P

AT

HT

he

pat

h t

o t

he m

edia

file

de

finiti

ons

.A

ny

valid

ab

solu

te p

ath

.

\ER

RO

R_F

ILE

_P

AT

H\P

TR

_E

RR

OR

_F

ILE

_P

AT

HP

ath

to

sto

re t

he

erro

r fil

e f

or

log

gin

g er

rors

th

at

occ

ur

dur

ing

initi

aliz

atio

n.

An

y va

lid a

bso

lute

pat

h.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

GE

NE

RA

L_C

ON

FIG

S\V

aria

nt

Var

ian

t o

f th

e ha

rdw

are

inst

alle

d o

n t

he

AT

M.

Th

e f

ollo

win

g v

aria

nts

are

sup

por

ted

for

the

pas

sbo

ok

prin

ter:

MA

GN

ET

IC-

M

agn

etic

pa

ssb

oo

k p

rinte

rN

ON

_M

AG

NE

TIC

-

No

n-m

agn

etic

pas

sbo

ok

pri

nter

GE

NE

RA

L_C

ON

FIG

S\S

usp

end

Tim

eou

tT

ime

fo

r w

hic

h t

he

devi

ce is

su

spe

nde

d w

hen

cu

sto

me

r ta

mp

erin

g is

sus

pect

ed.

Tim

e in

se

con

ds.

Def

aul

ts t

o 3

00

seco

nds

.

Passbook Printer

3-61

Cap

abili

ties

3

GE

NE

RA

L_C

ON

FIG

S\M

agF

orm

atM

agn

etic

form

at t

o b

e us

ed w

hile

acc

eptin

g a

p

assb

oo

k, r

eadi

ng

fro

m m

agn

etic

tra

ck f

rom

a

pas

sbo

ok

or

wri

ting

to

ma

gne

tic t

rack

of a

p

assb

oo

k.

Can

be

on

e of

th

e f

ollo

win

g:

lD

IN

lIB

M

lIS

O

lN

ON

E (

if no

ma

gne

tic s

trip

e)

If n

ot

spec

ified

, d

efau

lts t

o N

ON

E

GE

NE

RA

L_C

ON

FIG

S\B

arco

de

Fo

rmat

Bar

cod

e f

orm

at t

o b

e u

sed

wh

ile d

efin

ing

the

b

arco

de

sca

n.

Can

be

on

e of

th

e f

ollo

win

g:

lN

CR

lF

UJI

TS

U_

ST

D

lIB

M_

ST

D

lF

UJI

TS

U_

FR

EE

lIB

M_

FR

EE

If n

ot

spec

ified

, d

efau

lts t

o F

UJI

TS

U_

ST

D

GE

NE

RA

L_C

ON

FIG

S\M

axM

ed

iaR

etr

act

edM

axim

um

me

dia

ite

ms

tha

t th

e re

trac

t bi

n c

an

ho

ld.

Dev

ice

cap

abili

ty is

cur

rent

ly 1

0.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

Cap

abili

tyV

alu

e

Co

mp

ou

ndT

RU

E

Res

olu

tion

LOW

Rea

d F

orm

Su

ppo

rtT

RU

E. (

MS

F a

nd

Pag

emar

k. M

SF

is s

up

por

ted

by

MA

GN

ET

IC v

aria

nts

o

nly)

Wri

te F

orm

Su

pp

ort

TR

UE

. (T

EX

T a

nd M

SF

. M

SF

is s

up

port

ed b

y M

AG

NE

TIC

va

rian

ts o

nly)

Ext

ents

Sup

po

rtF

ALS

E

Su

pp

ort

ed

con

tro

lsE

JEC

T,

FL

US

H,

RE

TR

AC

T

Asy

nch

ron

ou

s m

ed

ia a

ccep

tan

ceF

ALS

E

Ret

ract

Bin

cap

aci

ty1

0

Sta

cker

cap

aci

ty0

Passbook Printer

3-62

Con

form

ance

Mat

rix -

Com

man

ds3

WO

SA

Com

man

dC

LC

omm

ents

WF

S_

INF

_PT

R_

ST

AT

US

1l

. fwD

evi

ce o

f W

FS

_PT

R_

DE

VP

OW

ER

OF

F, W

FS

_P

TR

_D

EV

BU

SY

an

d

WF

S_

PT

R_

DE

VN

OD

EV

ICE

are

ne

ver

retu

rned

lu

sRetr

act

Cou

nt fiel

d in

dic

ate

s th

e to

tal n

um

be

r of

ite

ms

in th

e re

tra

ct b

in. F

or

the

co

mb

inat

ion

st

atem

ent/

pa

ssb

oo

k, t

his

is t

he s

um

of

the

sta

tem

en

ts a

nd

pa

ssb

ook

s p

rese

nt

in t

he

retr

act

bin

.

lT

he s

tatu

s co

mm

and

, if

not

pre

ced

ed

by

a P

RIN

T_

FO

RM

or

a R

EA

D_

FO

RM

com

ma

nd w

ill

no

t re

turn

th

e la

test

re

ple

nish

me

nt

info

rmat

ion

.

WF

S_

INF

_PT

R_

CA

PA

BIL

ITIE

S2

No

ne

WF

S_

INF

_PT

R_

FO

RM

_LI

ST

2N

on

e

WF

S_

INF

_PT

R_

ME

DIA

_LI

ST

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

FO

RM

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

ME

DIA

2N

on

e

WF

S_

INF

_PT

R_

QU

ER

Y_

FIE

LD

2N

on

e

WF

S_

CM

D_

PT

R_C

ON

TR

OL_

ME

DIA

1l

Su

pp

ort

s on

ly t

he f

ollo

win

g co

ntr

ol c

ode

s:

lW

FS

_P

TR

_C

TR

LE

JEC

T

lW

FS

_P

TR

_C

TR

LR

ET

RA

CT

lW

FS

_P

TR

_C

TR

LF

LUS

H.

lN

on

-su

ppo

rted

co

ntr

ol c

od

es a

re ig

nore

d.

lIf

the

co

ntr

ol c

ode

s W

FS

_PT

R_

CT

RL

RE

TR

AC

T a

nd

WF

S_

PT

R_C

TR

LE

JEC

T a

re s

pec

ified

to

geth

er,

th

e e

rro

r co

de

WF

S_

ER

R_

INVA

LID

_D

ATA

is r

etu

rne

d.

lA

CO

NT

RO

L_M

ED

IA c

om

ma

nd,

with

ou

t a

pass

bo

ok

pre

sen

t in

th

e p

rinte

r w

ill r

etu

rn t

he

err

or

cod

e W

FS

_E

RR

_P

TR

_NO

ME

DIA

PR

ES

EN

T.

Passbook Printer

3-63

WF

S_

CM

D_

PT

R_P

RIN

T_

FO

RM

1l

Rig

ht

alig

ned

fie

lds

are

no

t su

pp

orte

d.

lS

up

po

rts

only

low

res

olu

tion

. Oth

er r

eso

lutio

ns

are

ign

ore

d.

lD

oe

s n

ot

retu

rn e

rro

r co

de

WF

S_E

RR

_P

TR

_M

ED

IAS

KE

WE

D.

lIf

th

ere

are

mul

tiple

MS

F f

ield

s in

a f

orm

de

finiti

on,

on

ly P

OS

ITIO

N,

SIZ

E,

TY

PE

, C

LA

SS

a

nd A

CC

ES

S n

eed

to

be

sp

eci

fied

in t

he

fie

ld d

efin

itio

n o

f ty

pe M

SF.

Oth

er v

alu

es

are

ig

nore

d.

lA

n M

SF

fie

ld d

efin

itio

n s

hou

ld s

atis

fy t

he f

ollo

win

g c

on

diti

on

s:

lP

OS

ITIO

N x

sho

uld

sp

ecify

th

e be

gin

nin

g o

f th

e s

tore

d d

ata

. PO

SIT

ION

y

is ig

no

red

.

lT

YP

E s

ho

uld

be

MS

F.

lA

CC

ES

S s

ho

uld

be

WR

ITE

or

RE

AD

WR

ITE

.

lIf

CL

AS

S is

STA

TIC

, IN

ITIA

LVA

LUE

mu

st b

e s

pe

cifie

d.

lIt

is a

ssu

me

d t

hat

if th

ere

are

mu

ltipl

e f

ield

s o

f ty

pe

MS

F in

a fo

rm, t

hey

will

be

de

fined

co

nse

cutiv

ely

in t

he

form

def

initi

on

file

.

lS

up

po

rts

only

the

fo

llow

ing

con

tro

l cod

es:

lW

FS

_P

TR

_C

TR

LE

JEC

T,

lW

FS

_P

TR

_C

TR

LR

ET

RA

CT

lW

FS

_P

TR

_C

TR

LF

LUS

H.

lU

nsu

pp

ort

ed c

on

tro

l cod

es

are

ign

ore

d.

lIf

co

ntro

l co

des

WF

S_P

TR

_C

TR

LR

ET

RA

CT

an

d W

FS

_P

TR

_CT

RL

EJE

CT

are

sp

ecifi

ed

toge

the

r, t

he

err

or

cod

e W

FS

_E

RR

_IN

VAL

ID_

DAT

A w

ill b

e re

turn

ed.

lT

he f

orm

an

d f

ield

s sp

eci

fied

fo

r p

rintin

g s

ho

uld

ad

her

e t

o fo

llow

ing

:

lO

rien

tatio

n c

ann

ot

be

LA

ND

SC

AP

E

lS

KE

W c

an

onl

y b

e 0

.

lS

IDE

can

on

ly b

e F

RO

NT.

lT

YP

E c

an

on

ly b

e T

EX

T, M

SF

or

PA

GE

MA

RK

.

lG

RA

PH

ICS

can

onl

y b

e B

ES

TF

IT (

de

fau

lt).

lB

AR

CO

DE

ca

n o

nly

be

NO

NE

(d

efa

ult)

.

lS

TY

LE c

an o

nly

be

NO

RM

AL

(de

fau

lt) a

nd D

OU

BLE

fo

r th

e c

om

bin

atio

n st

atem

ent/

pa

ssb

oo

k p

rinte

r.

con

tinu

ed

....

WO

SA

Com

man

dC

LC

omm

ents

Passbook Printer

3-64

WF

S_

CM

D_

PT

R_P

RIN

T_

FO

RM

1l

HO

RIZ

ON

TAL

just

ifica

tion

ca

n o

nly

be

LE

FT (

de

fau

lt),

RIG

HT

or

CE

NT

ER

.

lV

ER

TIC

AL

just

ifica

tion

can

be

TO

P (

de

fau

lt),

CE

NT

ER

, B

OT

TO

M o

r JU

ST

IFY.

lC

OLO

R c

an

on

ly b

e B

LAC

K.

lIf

a p

rint

or

a r

ead

is a

tte

mp

ted

to

or

fro

m a

fie

ld o

f T

YP

E M

SF

an

d if

the

ho

rizo

nta

l m

agn

etic

str

ipe

re

ader

is a

bse

nt,

the

fie

ld e

rro

r W

FS

_E

RR

_P

TR

_FIE

LDIN

VAL

ID is

re

turn

ed.

lF

ON

T in

th

e fie

ld d

efin

itio

n s

hou

ld b

e o

ne o

f th

e fo

llow

ing

:

INT

ER

NA

TIO

NA

L1

INT

ER

NA

TIO

NA

L2

INT

ER

NA

TIO

NA

L3

INT

ER

NA

TIO

NA

L4

INT

ER

NA

TIO

NA

L5

AR

AB

IC1

AR

AB

IC2

AR

AB

IC3

AR

AB

IC4

AR

AB

IC5

lP

OIN

TS

IZE

is n

ot

sup

por

ted

an

d if

sp

ecifi

ed,

is ig

nor

ed

.

lC

PI

can

be

5.0

, 1

0.0

(d

efa

ult)

, 12

.0 o

r 1

7.1

4.

How

ever

, if

CP

I is

sp

ecifi

ed a

s 1

0.0

(d

efa

ult)

, th

e C

AS

E s

hou

ld n

ot

be D

OU

BL

E.

lC

AS

E c

ha

nge

is e

ffect

ive

on

ly if

th

e a

ctiv

e f

on

t su

pp

orts

it.

lL

PI

is n

ot

sup

por

ted

, an

d if

spe

cifie

d, i

s ig

no

red

.

lF

OR

MA

T is

no

t su

pp

ort

ed

, an

d if

spec

ified

, is

igno

red.

lT

he m

edia

sp

ecifi

ed f

or

prin

ting

sh

ould

sa

tisfy

th

e fo

llow

ing

con

diti

ons:

lT

YP

E c

an

on

ly b

e P

AS

SB

OO

K (

def

au

lt).

lS

IZE

wid

th s

hou

ld b

e <

= 8

0.

con

tinu

ed

....

WO

SA

Com

man

dC

LC

omm

ents

Passbook Printer

3-65

WF

S_

CM

D_

PT

R_P

RIN

T_

FO

RM

1l

PR

INTA

RE

A w

idth

sh

ou

ld b

e <

= S

IZE

wid

th.

lP

RIN

TAR

EA

heig

ht s

hou

ld b

e <

= S

IZE

he

igh

t.

lP

RIN

TAR

EA

x s

ho

uld

be

<=

SIZ

E wid

th.

lS

IZE

wid

th s

hou

ld b

e >

= P

RIN

TAR

EA

x +

PR

INT

AR

EA

wid

th.

lP

RIN

TAR

EA

y s

ho

uld

be

<=

SIZ

E heig

ht.

lS

IZE

he

igh

t >=

PR

INTA

RE

A y

+ P

RIN

TAR

EA

heig

ht +

2 *

STA

GG

ER

ING

.

lR

ES

TR

ICT

ED

x sh

oul

d b

e <

= S

IZE

wid

th.

lS

IZE

wid

th >

= R

ES

TR

ICT

ED

x +

RE

ST

RIC

TE

D w

idth

.

lR

ES

TR

ICT

ED

y <

= R

ES

TR

ICT

ED

heig

ht.

lS

IZE

he

igh

t >=

RE

ST

RIC

TE

D y

+ R

ES

TR

ICT

ED

he

igh

t + 2

* S

TA

GG

ER

ING

.

WF

S_

CM

D_

PT

R_R

EA

D_

FO

RM

1l

Do

es

no

t re

turn

err

or

cod

e W

FS

_ER

R_

PT

R_

ME

DIA

SK

EW

ED

.

lA

CO

NT

RO

L_M

ED

IA c

om

man

d,

with

ou

t a

pas

sbo

ok

pre

sen

t in

sid

e th

e p

rint

er w

ill r

etu

rnth

e e

rror

co

de

WF

S_

ER

R_

PT

R_

NO

ME

DIA

PR

ES

EN

T.

lS

up

po

rts

only

the

fo

llow

ing

con

tro

l cod

es:

lW

FS

_P

TR

_C

TR

LEJE

CT,

lW

FS

_P

TR

_C

TR

LRE

TR

AC

T

lW

FS

_P

TR

_C

TR

LFL

US

H.

lN

on

-su

ppo

rted

co

ntr

ol c

od

es a

re ig

nore

d.

lIf

co

ntr

ol

cod

es W

FS

_P

TR

_C

TR

LRE

TR

AC

T a

nd

WF

S_P

TR

_C

TR

LEJE

CT

are

sp

ecifi

edto

geth

er,

th

e e

rro

r co

de

WF

S_

ER

R_

INVA

LID

_D

ATA

will

be

retu

rne

d.

lO

nly

MS

F fi

eld

s (t

ho

se s

tore

d o

n t

he m

agn

etic

str

ipe

) a

nd t

he

pag

em

ark

ca

n b

e re

ad.

lO

nly

PO

SIT

ION

, S

IZE

, C

LA

SS

and

AC

CE

SS

ne

ed t

o b

e s

pec

ified

in t

he

field

de

finiti

on o

fM

SF

typ

e f

ield

s. O

ther

va

lue

s a

re ig

no

red

.

lT

he v

alu

es

in t

he f

ield

def

initi

on

of

an

MS

F f

ield

sh

oul

d s

atis

fy t

he

follo

win

g c

on

diti

ons:

lP

OS

ITIO

N x

sho

uld

sp

ecify

th

e be

gin

nin

g o

f th

e s

tore

d d

ata

. PO

SIT

ION

y

is ig

no

red

.

lT

YP

E s

ho

uld

be

MS

F.

lA

CC

ES

S c

an

be

RE

AD

or

RE

AD

WR

ITE

.

lIf

CL

AS

S is

STA

TIC

, IN

ITIA

LVA

LUE

mu

st b

e s

pe

cifie

d.

cont

inu

ed

...

WO

SA

Com

man

dC

LC

omm

ents

Passbook Printer

3-66

WF

S_

CM

D_

PT

R_R

EA

D_

FO

RM

1l

It i

s as

sum

ed

that

if

ther

e a

re m

ultip

le f

ield

s o

f ty

pe

MS

F i

n a

for

m,

the

y w

ill b

e d

efin

edco

nse

cutiv

ely

in t

he

form

def

initi

on

file

.

lA

ll va

lues

in

th

e f

ield

def

initi

on

with

typ

e P

AG

EM

AR

K a

re i

gno

red.

Fo

r 'F

RE

E'

bar

code

form

ats

, th

e va

lue

retu

rne

d b

y th

e P

AG

E_

NU

MB

ER

co

mm

an

d w

ill b

e r

etu

rne

d as

de

scri

bed

in R

ef 2

4 . It

is t

he a

ppl

ica

tions

res

pon

sib

ility

to

inte

rpre

t th

e co

des

.

lT

he f

orm

an

d f

ield

s sp

eci

fied

fo

r p

rintin

g s

ho

uld

sat

isfy

th

e f

ollo

win

g c

on

ditio

ns:

lO

rien

tatio

n c

ann

ot

be

LA

ND

SC

AP

E

lS

KE

W c

an

onl

y b

e 0

.

lT

YP

E c

an

on

ly b

e M

SF

or

PA

GE

MA

RK

.

lIf

a r

ead

is

atte

mp

ted

fro

m a

fie

ld o

f T

YP

E M

SF

an

d i

f th

e ho

rizo

nta

l m

ag

net

ic s

trip

ere

ader

is a

bse

nt,

the

fie

ld e

rro

r W

FS

_E

RR

_P

TR

_FIE

LDIN

VALI

D is

ret

urn

ed

.

lT

he m

edia

sp

ecifi

ed f

or

prin

ting

sh

ould

sa

tisfy

th

e fo

llow

ing

con

diti

ons:

lT

YP

E c

an

on

ly b

e P

AS

SB

OO

K (

def

au

lt).

lS

IZE

wid

th s

hou

ld b

e <

= 8

0.

lP

RIN

TAR

EA

wid

th s

ho

uld

be

<=

SIZ

E wid

th.

lP

RIN

TAR

EA

heig

ht s

hou

ld b

e <

= S

IZE

he

igh

t.

lP

RIN

TAR

EA

x s

ho

uld

be

<=

SIZ

E wid

th.

lS

IZE

wid

th s

hou

ld b

e >

= P

RIN

TAR

EA

x +

PR

INT

AR

EA

wid

th.

lP

RIN

TAR

EA

y s

ho

uld

be

<=

SIZ

E heig

ht.

lS

IZE

he

igh

t >=

PR

INTA

RE

A y

+ P

RIN

TAR

EA

heig

ht +

2 *

STA

GG

ER

ING

sta

gg

eri

ng.

lR

ES

TR

ICT

ED

x sh

oul

d b

e <

= S

IZE

wid

th.

lS

IZE

wid

th >

= R

ES

TR

ICT

ED

x +

RE

ST

RIC

TE

D w

idth

.

lR

ES

TR

ICT

ED

y <

= R

ES

TR

ICT

ED

heig

ht.

lS

IZE

he

igh

t >=

RE

ST

RIC

TE

D y

+ R

ES

TR

ICT

ED

he

igh

t + 2

* S

TA

GG

ER

ING

st

ag

geri

ng.

WF

S_

CM

D_

PT

R_R

AW

_DA

TA

1T

he r

aw

dat

a in

pu

t is

pas

sed

to

th

e p

rinte

r w

itho

ut

inte

rpre

tatio

n.

Un

sup

por

ted

co

ntr

ol c

od

es

are

re

pla

ced

by

the

ch

ara

cte

r ']'

.The

ra

w d

ata

is a

lwa

ys p

rint

ed f

rom

the

fir

st li

ne,

firs

t co

lum

n

on

war

ds.

WF

S_

CM

D_

PT

R_M

ED

IA_

EX

TE

NT

S0

No

ne

WF

S_

CM

D_

PT

R_R

ES

ET

_C

OU

NT

2N

on

e

WF

S_

CM

D_

PT

R_R

EA

D_

IMA

GE

0N

on

e

WO

SA

Com

man

dC

LC

omm

ents

Passbook Printer

3-67

Con

form

ance

Mat

rix -

Err

ors

3

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_

INF

_P

TR

_F

OR

M_

LIS

TN

on

e2

No

ne

WF

S_

INF

_P

TR

_M

ED

IA_L

IST

No

ne

2N

on

e

WF

S_

INF

_P

TR

_Q

UE

RY

_FO

RM

WF

S_

ER

R_

INV

ALI

D_

PO

INT

ER

2R

etu

rne

d

if th

e in

put

po

inte

r is

N

UL

L o

rin

valid

.

WF

S_

ER

R_

PT

R_

FO

RM

INV

ALI

D2

Ret

urn

ed

wh

en

th

e fo

rm

def

initi

on

spe

cifie

dd

oes

n

ot

satis

fy

the

con

diti

ons

giv

en

in

com

ma

nd

con

form

ance

m

atrix

fo

r th

eC

MD

_P

TR

_P

RIN

T_

FO

RM

co

mm

an

d.

WF

S_

ER

R_

PT

R_

FO

RM

NO

TF

OU

ND

2R

etu

rne

d w

he

n t

he

form

nam

e sp

ecifi

ed i

s no

tfo

und

in t

he

form

file

s.

WF

S_

INF

_P

TR

_Q

UE

RY

_ME

DIA

WF

S_

ER

R_

INV

ALI

D_

PO

INT

ER

2R

etu

rne

d

if th

e in

pu

t p

oin

ter

is

NU

LL

or

inva

lid.

WF

S_

ER

R_

PT

R_

ME

DIA

NO

TF

OU

ND

2R

etu

rne

d w

he

n t

he

med

ia n

ame

sp

ecifi

ed is

no

tfo

und

in t

he

med

ia f

iles.

WF

S_

ER

R_

PT

R_

ME

DIA

INV

AL

ID2

Ret

urn

ed

wh

en t

he

me

dia

def

initi

on

sp

ecifi

edd

oes

not

satis

fy

the

con

diti

on

s gi

ven

in

com

man

d

con

form

ance

m

atrix

fo

r th

eC

MD

_P

TR

_P

RIN

T_

FO

RM

co

mm

an

d.

WF

S_

INF

_P

TR

_Q

UE

RY

_FIE

LDW

FS

_E

RR

_IN

VA

LID

_P

OIN

TE

R2

Ret

urn

ed

wh

en t

he

inp

ut

po

inte

r is

NU

LL o

rin

valid

.

WF

S_

ER

R_

PT

R_

FO

RM

INV

ALI

D2

Ret

urn

ed

wh

en t

he

form

de

finiti

on s

pec

ified

in

the

in

pu

t st

ruct

ure

d

oe

s n

ot

satis

fy

the

con

diti

ons

giv

en

in

com

ma

nd

co

nfo

rman

cem

atr

ix

for

the

C

MD

_P

TR

_P

RIN

T_

FO

RM

com

man

d.

WF

S_

ER

R_

PT

R_

FO

RM

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e f

orm

na

me

sp

eci

fied

in

the

inp

ut

stru

ctu

re is

no

t fo

und

in f

orm

file

.

con

tinu

ed

....

Passbook Printer

3-68

WF

S_

INF

_P

TR

_Q

UE

RY

_FIE

LDW

FS

_E

RR

_P

TR

_F

IEL

DN

OT

FO

UN

D2

Ret

urn

ed

wh

en t

he f

ield

na

me

sp

ecifi

ed i

n t

hein

pu

t st

ruct

ure

is

n

ot

fou

nd

in

th

e

form

def

initi

on

.

WF

S_

ER

R_

PT

R_

FIE

LD

INV

ALI

D2

Ret

urn

ed

w

hen

th

e

field

d

efin

itio

n

spec

ified

doe

s n

ot

satis

fy

the

cond

itio

ns

giv

en

in

the

com

man

d

con

form

an

ce

mat

rix

for

CM

D_

PT

R_

PR

INT

_F

OR

M c

om

ma

nd

.

WF

S_

CM

D_

PT

R_

CO

NT

RO

L_M

ED

IAW

FS

_E

RR

_IN

VA

LID

_P

OIN

TE

R2

Ret

urn

ed

if

the

inp

ut

po

inte

r is

N

ULL

o

rin

valid

.

WF

S_

ER

R_

INV

ALI

D_

DA

TA

2R

etu

rne

d w

he

n an

un

kno

wn

co

ntr

ol

cod

e f

or

dw

Me

dia

Con

tro

l is s

pe

cifie

d in

th

e in

pu

t.A

lso

re

turn

ed w

hen

WF

S_

PT

R_

CT

RL

EJE

CT

and

W

FS

_P

TR

_CT

RL

RE

TR

AC

T

com

man

ds

are

sp

eci

fied

tog

eth

er.

WF

S_

ER

R_

PT

R_

NO

ME

DIA

PR

ES

EN

T2

Gen

era

ted

wh

en n

o p

ass

bo

ok i

s pr

ese

nt i

n t

hep

rinte

r.

WF

S_

ER

R_

PT

R_

FLU

SH

FA

IL0

Nev

er

gen

era

ted

si

nce

the

dat

a is

a

lwa

ysflu

she

d to

th

e d

evic

e.

WF

S_

ER

R_

PT

R_

RE

TR

AC

TB

INF

ULL

2G

ene

rate

d w

hen

th

e re

tra

ct b

in h

as m

ore

th

an1

0 m

edi

a ite

ms

in

it.

For

th

e co

mb

inat

ion

stat

emen

t/p

assb

ook,

th

is

is

the

sum

o

f th

est

atem

ents

an

d p

ass

bo

oks

pre

sen

t in

th

e r

etr

act

bin

.

WF

S_

ER

R_

PT

R_

ST

AC

KE

RF

ULL

0N

on

e

WF

S_

ER

R_

PT

R_

PA

GE

TU

RN

FA

IL0

No

ne

WF

S_

ER

R_

PT

R_

ME

DIA

TU

RN

FA

IL0

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Passbook Printer

3-69

WF

S_

CM

D_

PT

R_

PR

INT

_F

OR

MW

FS

_E

RR

_IN

VA

LID

_P

OIN

TE

R2

Ret

urn

ed

wh

en

the

in

put

stru

ctu

re

poin

ter

isN

ULL

or

inva

lid.

WF

S_

ER

R_

INV

ALI

D_

DA

TA

2R

etu

rne

d

whe

n

an

un

know

n

cont

rol

cod

e is

spec

ified

for d

wM

ed

iaC

on

tro

l in t

he

inp

ut.

Als

o r

etu

rned

whe

n W

FS

_P

TR

_C

TR

LE

JEC

Tan

d W

FS

_PT

R_

CT

RLR

ET

RA

CT

are

sp

ecifi

edto

ge

ther

.

WF

S_

ER

R_

PT

R_

FO

RM

INV

ALI

D2

Ret

urn

ed

wh

en t

he

form

de

finiti

on s

pec

ified

in

the

in

pu

t st

ruct

ure

d

oe

s no

t ad

her

e

toco

nd

ition

s g

iven

in

co

mm

an

d

con

form

ance

ma

trix

fo

r th

e

CM

D_

PT

R_

PR

INT

_F

OR

Mco

mm

and

.

WF

S_

ER

R_

PT

R_

FO

RM

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e f

orm

na

me

sp

eci

fied

in

the

inp

ut

stru

ctu

re is

no

t fo

und

in t

he

form

s fil

e.

WF

S_

ER

R_

PT

R_

ME

DIA

NO

TF

OU

ND

2R

etu

rne

d w

hen

th

e m

edia

na

me

sp

eci

fied

in t

hein

pu

t st

ruct

ure

is n

ot

foun

d in

th

e m

edia

file

s.

WF

S_

ER

R_

PT

R_

ME

DIA

INV

AL

ID2

Ret

urn

ed

wh

en t

he

me

dia

def

initi

on

sp

ecifi

edin

th

e in

put

stru

ctu

re

doe

s n

ot

satis

fy

the

con

diti

ons

giv

en

in

th

e c

om

man

d c

on

form

ance

ma

trix

fo

r th

eW

FS

_C

MD

_P

TR

_P

RIN

T_

FO

RM

co

mm

and

.

WF

S_

ER

R_

PT

R_

ME

DIA

SK

EW

ED

0N

eve

r re

turn

ed

. S

kew

ca

nno

t b

e d

etec

ted

WF

S_

ER

R_

PT

R_

ME

DIA

OV

ER

FLO

W2

Ret

urn

ed

wh

ene

ver

the

prin

t d

ata

ove

rflo

ws

the

me

dia

bo

und

arie

s.

con

tinue

d...

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Passbook Printer

3-70

WF

S_

CM

D_

PT

R_

PR

INT

_F

OR

MW

FS

_E

RR

_P

TR

_F

IEL

DS

PE

CF

AIL

UR

E1

Ret

urn

ed

wh

en

a f

ield

is

spec

ified

tw

ice

in

the

inp

ut.

WF

S_

ER

R_

PT

R_

FIE

LD

ER

RO

R2

Ret

urn

ed

if

an

err

or

occ

urr

ed

wh

ile p

roce

ssin

ga

field

.

WF

S_

ER

R_

PT

R_

FLU

SH

FA

IL2

Ad

diti

on

al e

rro

r co

de

. R

etu

rne

d w

hen

th

e p

rint

form

co

mm

an

d

trie

s to

p

rint

da

ta

abo

ve

or

bef

ore

th

e c

urr

ent

po

sitio

n o

f th

e p

rint

he

ad.

WF

S_

ER

R_

PT

R_

RE

TR

AC

TB

INF

ULL

2G

ene

rate

d

afte

r 1

0

cap

ture

s ha

ve

be

enp

erfo

rmed

.

WF

S_

ER

R_

PT

R_

ST

AC

KE

RF

ULL

0N

on

e

WF

S_

ER

R_

PT

R_

PA

GE

TU

RN

FA

IL0

No

ne

WF

S_

ER

R_

PT

R_

ME

DIA

TU

RN

FA

IL0

No

ne

WF

S_

CM

D_

PT

R_

RE

AD

_F

OR

MW

FS

_E

RR

_P

TR

_R

EA

DN

OT

SU

PP

OR

TE

D0

No

ne

WF

S_

ER

R_

PT

R_

FO

RM

INV

ALI

D2

Ret

urn

ed

wh

en t

he

form

de

finiti

on s

pec

ified

in

the

in

pu

t st

ruct

ure

d

oe

s n

ot

satis

fy

the

con

diti

ons

giv

en

in

th

e c

om

man

d c

on

form

ance

ma

trix

fo

r th

e

CM

D_

PT

R_

PR

INT

_F

OR

Mco

mm

and

.

WF

S_

ER

R_

PT

R_

FO

RM

NO

TF

OU

ND

2N

on

e

WF

S_

ER

R_

PT

R_

ME

DIA

NO

TF

OU

ND

2N

on

e

WF

S_

ER

R_

PT

R_

ME

DIA

INV

AL

ID2

Ret

urn

ed

wh

en t

he

me

dia

def

initi

on

sp

ecifi

edin

th

e in

put

stru

ctu

re

doe

s n

ot

satis

fy

the

con

diti

ons

giv

en

in

com

ma

nd

co

nfo

rman

cem

atr

ix

for

the

WF

S_

CM

D_

PT

R_

PR

INT

_F

OR

M c

om

man

d.

con

tinue

d...

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Passbook Printer

3-71

WF

S_

CM

D_

PT

R_

RE

AD

_F

OR

MW

FS

_E

RR

_P

TR

_M

ED

IAS

KE

WE

D0

Nev

er

retu

rne

d s

ince

ske

w c

ann

ot

be d

ete

cted

.

WF

S_

ER

R_

PT

R_

FIE

LD

SP

EC

FA

ILU

RE

2R

etu

rne

d w

he

n a

fie

ld i

s sp

ecifi

ed t

wic

e i

n t

hein

pu

t.

WF

S_

ER

R_

PT

R_

FIE

LD

ER

RO

R2

Ret

urn

ed

if

an

err

or

occ

urr

ed

wh

ile p

roce

ssin

ga

field

.

WF

S_

ER

R_

PT

R_

RE

TR

AC

TB

INF

ULL

2G

ene

rate

d

afte

r 1

0

cap

ture

s ha

ve

be

enp

erfo

rmed

.

WF

S_

ER

R_

PT

R_

ST

AC

KE

RF

ULL

0N

on

e

WF

S_

ER

R_

PT

R_

PA

GE

TU

RN

FA

IL0

No

t su

ppo

rted

WF

S_

ER

R_

PT

R_

ME

DIA

TU

RN

FA

IL0

No

t su

ppo

rted

WF

S_

CM

D_

PT

R_

RA

W_

DA

TA

No

ne

No

ne

WF

S_

CM

D_

PT

R_

ME

DIA

_E

XT

EN

TS

WF

S_

ER

R_

PT

R_

EX

TE

NT

NO

TS

UP

PO

RT

ED

2T

he

dev

ice

do

es n

ot r

ep

ort

ext

en

ts.

WF

S_

CM

D_

PT

R_

RE

SE

T_

CO

UN

TN

on

e0

No

ne

WF

S_

CM

D_

PT

R_

RE

AD

_IM

AG

EN

on

e0

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Passbook Printer

3-72

Con

form

ance

Mat

rix -

Eve

nts

3

PR

INT

ER

FO

RM

S3

Ref

er

to t

he

Pri

nte

r F

orm

s se

ctio

n o

f th

e R

ece

ipt

and

Jo

urn

al P

rinte

rs d

evi

ce c

lass

.

WO

SA

Eve

ntC

LC

omm

ents

WF

S_

EX

EE

_P

TR

_N

OM

ED

IA2

No

ne

WF

S_

EX

EE

_P

TR

_M

ED

IAIN

SE

RT

ED

2N

on

e

WF

S_

EX

EE

_P

TR

_F

IEL

DE

RR

OR

2N

on

e

WF

S_

EX

EE

_P

TR

_F

IEL

DW

AR

NIN

G2

No

ne

WF

S_

SR

VE

_P

TR

_M

ED

IAT

AK

EN

2N

on

e

WF

S_

SR

VE

_P

TR

_M

ED

IAIN

SE

RT

ED

0N

on

e

WF

S_

US

RE

_P

TR

_P

AP

ER

TH

RE

SH

OLD

0N

on

e

WF

S_

US

RE

_P

TR

_T

ON

ER

TH

RE

SH

OLD

1G

ene

rate

d o

nly

if a

prin

t (W

FS

_CM

D_

PT

R_

PR

INT

_FO

RM

or

WF

S_

CM

D_

PT

R_R

AW

_DA

TA

) is

att

em

pte

d.

WF

S_

US

RE

_P

TR

_R

ET

RA

CT

BIN

TH

RE

SH

OLD

2G

ene

rate

d a

fter

10

cap

ture

s ha

ve b

een

p

erfo

rme

d.

WOSA/XFS - Programmer’s Reference ManualPassbook Printer




1 An error file (pptr_frm.log) is created during the parsing of the formdefinitions files. All the errors during the parse run are logged into this errorfile. The cause of error/s can be found by examining this file.

2 Similarly, an error file (pptr_med.log) is created during parsing of the mediadefinitions files. All the errors during the parse run are logged into this errorfile. The cause of error/s can be found by examining this file.

3 Any passbook present at the time of SP initialization is captured. Similarly, forthe combination statement/passbook printer, a statement or passbook presentis captured.

4 For the combination statement/passbook printer, ensure that all thetransactions with the passbook printer end with an eject or capture, beforeissuing commands to the statement printer. If a passbook is present under thehead and a print command is given to the statement printer, a system escapemay take place.

5 The timeouts specified should be long enough (> 20s approx) for printing,capturing and ejecting a passbook. The correct timeouts can be found out bytrial-and-error.

6 When customer tampering is suspected, commands issued after the commandthat have sensed the conditions are not accepted for the suspend period(SuspendTimeout) specified in the registry. These commands will return withthe error code WFS_ERR_DEV_NOT_READY. Also, if any statement ispresent in the transport, it is captured. The status is checked everySuspendTimeout seconds and a system status change event is generated if thestatus changes.

7 If two fields overlap, the field defined first in the form definition hasprecedence. Consequently, only part of the second field will be printed.

8 Double width characters always start in odd numbered columns.Consequently, a space may precede a change from single to double widthmode.

9 Case change will take place only if the active font supports it.

10 Buffer limits are as described in the ‘Print Command Limits’ of the Statement Printer section of this document.

11 The Passbook SP and device driver attempt to recover from some transportand media related errors. If after repeated attempts, the error conditionpersists, the device goes into a fatal state, a condition that can be cleared onlyby operator intervention via the VDM. The following table lists the errorconditions from which the SP attempts to recover, and the action to be takenfor other commonly occurring errors.

Passbook Printer

3-74

Err

or C

ondi

tion

Rec

over

y A

ctio

n

Pa

ssb

oo

k ja

m d

uri

ng

Eje

ctW

hen

th

e d

evi

ce d

rive

r d

ete

cts

a p

ass

bo

ok

jam

du

rin

g a

n e

ject

op

era

tion,

it

ma

kes

3 a

tte

mp

ts t

o c

lear

the

jam

. If

th

ese

att

empt

s fa

il, t

he

SP

ass

um

es

that

cu

sto

me

r ta

mp

erin

g h

as o

ccu

rred

an

d e

nte

rs a

su

spe

nd s

tate

for

'Su

spe

ndT

imeo

ut'

min

ute

s,

dur

ing

w

hic

h

all

com

man

ds

tha

t h

ave

d

evi

ce

inte

ract

ion

w

ill

retu

rnW

FS

_E

RR

_DE

V_

NO

T_

RE

AD

Y.

On

exp

iry o

f th

is p

erio

d,

the

SP

ch

ecks

th

e st

atu

s o

f th

e d

evic

e,

an

d i

f it

is f

ou

nd

to b

e h

ealth

y, r

esu

me

sn

orm

al

ope

ratio

n.

If

use

r ta

mp

erin

g

pers

ists

, th

e d

evic

e

go

es

into

a

fa

tal

stat

e,

follo

win

g w

hic

h

all

com

ma

nds

issu

ed t

o t

he

dev

ice

will

ret

urn

WF

S_E

RR

_H

AR

DW

AR

E_

ER

RO

R.

Rec

ove

ry n

ow

re

qui

res

op

erat

or

inte

rve

ntio

n vi

a V

DM

.T

he d

rive

r al

so m

ain

tain

s a

co

un

t o

f co

nsec

utiv

e ja

ms

tha

t g

ets

cle

are

d o

n a

su

cces

sfu

l acc

ep

t-ca

ptu

re/e

ject

seq

uen

ce.

If t

his

co

unt

exc

eed

s 2

0,

the

SP

re

turn

s W

FS

_E

RR

_HA

RD

WA

RE

_E

RR

OR

ope

rato

r in

terv

entio

nvi

a V

DM

is r

equ

ired

to

cle

ar t

he

erro

r.

Pa

ssb

oo

k Ja

m d

urin

g A

cce

pt

Whe

n t

he

dri

ver

dete

cts

a p

ass

bo

ok

stu

ck i

n t

he

thro

at

of

the

pri

nte

r w

hic

h c

ann

ot b

e p

ulle

d i

n, it

ma

kes

7a

ttem

pts

to

mo

ve t

he

pas

sbo

ok

into

th

e p

rint

er.

If t

he

se a

ttem

pts

fai

l, th

e S

P a

ssum

es t

hat

cust

om

erta

mp

erin

g

has

oc

curr

ed

an

d e

nte

rs

a su

spe

nd

sta

te

for

'Su

spen

dT

ime

out

' m

inu

tes,

d

urin

g w

hich

a

llco

mm

an

ds t

hat

hav

e d

evic

e in

tera

ctio

n w

ill r

etu

rn W

FS

_E

RR

_D

EV

_NO

T_

RE

AD

Y.

On

exp

iry o

f th

is p

erio

d,

the

SP

ch

ecks

th

e st

atu

s o

f th

e d

evic

e,

an

d i

f it

is f

ou

nd

to b

e h

ealth

y, r

esu

me

sn

orm

al

ope

ratio

n.

If

use

r ta

mp

erin

g

pers

ists

, th

e d

evic

e

go

es

into

a

fa

tal

stat

e,

follo

win

g w

hic

h

all

com

ma

nds

issu

ed t

o t

he

dev

ice

will

ret

urn

WF

S_E

RR

_H

AR

DW

AR

E_

ER

RO

R.

Rec

ove

ry n

ow

re

qui

res

op

erat

or

inte

rve

ntio

n vi

a V

DM

.

Rea

d E

rro

rsIf

th

e d

evic

e d

rive

r e

nco

unte

rs a

rea

d f

ailu

re,

it m

ake

2 m

ore

re

ad a

tte

mp

ts b

efo

re r

epo

rtin

g a

re

ad e

rro

r.T

he S

P m

ain

tain

s a

cou

nt

of

con

secu

tive

rea

d e

rror

s fo

r ea

ch t

rack

whi

ch i

s cl

eare

d b

y a

su

cce

ssfu

l re

adfr

om

th

e a

ppro

pria

te t

rack

. If

th

is c

ou

nt e

xce

eds

20,

th

e S

P r

etu

rns

WF

S_

ER

R_

HA

RD

WA

RE

_ER

RO

R a

nd

cont

inu

es

to d

o s

o u

ntil

th

e co

nd

itio

n is

cle

are

d b

y o

per

ato

r in

terv

entio

n v

ia V

DM

.

Passbook Printer

3-75

Wri

te E

rro

rsIf

th

e d

evi

ce d

rive

r en

cou

nte

rs a

wri

te f

ailu

re,

it m

ake

2 m

ore

writ

e a

ttem

pts

bef

ore

re

port

ing

a w

rite

erro

r.T

he S

P m

ain

tain

s a

cou

nt

of

con

secu

tive

wri

te e

rro

rs fo

r ea

ch t

rack

wh

ich

is c

lear

ed

by

a su

cce

ssfu

l wri

te t

oth

e a

ppr

op

riate

tra

ck.

If t

his

cou

nt e

xcee

ds

20

, th

e S

P r

etu

rns

WF

S_E

RR

_H

AR

DW

AR

E_

ER

RO

R a

nd

cont

inu

es

to d

o s

o u

ntil

th

e co

nd

itio

n is

cle

are

d b

y o

per

ato

r in

terv

entio

n v

ia V

DM

.

Bla

nk

Tra

ck E

rror

The

SP

mai

nta

ins

a c

ou

nt

of

con

secu

tive

bla

nk t

rack

s fo

r a

ll tr

ack

s w

hich

is c

lear

ed

by

a s

ucc

essf

ul r

ead

toth

e a

ppr

op

riate

tra

ck.

If t

his

cou

nt e

xcee

ds

24

, th

e S

P r

etu

rns

WF

S_E

RR

_H

AR

DW

AR

E_

ER

RO

R a

nd

cont

inu

es

to d

o s

o u

ntil

th

e co

nd

itio

n is

cle

are

d b

y o

per

ato

r in

terv

entio

n v

ia V

DM

.

Pa

ssb

oo

k Ja

m d

urin

g a

ccep

tW

hen

th

e d

rive

r de

tect

s a

pa

ssb

oo

k st

uck

in

th

e th

roa

t o

f th

e p

rin

ter

wh

ich

can

not

be

pu

lled

in,

it m

ake

s 7

att

emp

ts t

o m

ove

th

e p

assb

oo

k in

to t

he

pri

nter

. If

th

ese

att

emp

ts f

ail,

the

SP

ass

umes

tha

t cu

sto

mer

tam

per

ing

h

as

occu

rred

a

nd

en

ters

a

susp

en

d st

ate

fo

r 'S

usp

end

Tim

eo

ut'

min

ute

s,

dur

ing

whi

ch

all

com

ma

nds

tha

t h

ave

dev

ice

inte

ract

ion

will

ret

urn

WF

S_

ER

R_

DE

V_N

OT

_R

EA

DY

.O

n e

xpiry

of

this

pe

riod

, th

e S

P c

hec

ks t

he

sta

tus

of

the

dev

ice

, a

nd

if

it is

fo

un

d to

be

hea

lthy,

re

sum

es

no

rma

l o

pera

tion

. If

u

ser

tam

per

ing

pe

rsis

ts,

the

dev

ice

g

oes

in

to

a

fata

l st

ate,

fo

llow

ing

wh

ich

a

llco

mm

an

ds is

sued

to

th

e d

evic

e w

ill r

etu

rn W

FS

_ER

R_

HA

RD

WA

RE

_E

RR

OR

.R

eco

very

no

w r

eq

uire

s o

per

ato

r in

terv

en

tion

via

VD

M.

Err

or C

ondi

tion

Rec

over

y A

ctio

n

WOSA/XFS - Programmer’s Reference ManualText Terminal Unit



Text Terminal Unit 3




Enhanced Operator Panel ttu_spx.dllttu_wfp.dllttu_ipc.dllttu.dll

ttu.exe


TextTerminalUnit1 The logical name of the TTU service provider

Text Terminal Unit

3-77

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

_R

OO

T\S

ER

VIC

E_

PR

OV

IDE

RS

\TT

U k

ey.

NO

TE

:

Th

e k

eym

ap f

ile d

efin

es t

he

map

pin

g o

f ke

ys t

o k

eyco

de

s a

nd

has

th

e f

ollo

win

g s

tru

ctu

re:

Key

Po

sitio

nK

ey c

od

eE

na

ble/

Dis

able

<0

-24

><

0-F

F>

<0

or

1>

A li

ne

with

a s

emic

olo

n (

';')

in t

he

firs

t co

lum

n is

tre

ated

as

a co

mm

ent.

Cap

abili

ties

3

Par

amet

erD

escr

iptio

n P

erm

issi

ble

Val

ues

GE

NE

RA

L_C

ON

FIG

S\V

aria

nt

Dev

ice

va

rian

t.E

OP

- E

nh

ance

d O

pe

rato

r P

ane

l

GE

NE

RA

L_C

ON

FIG

S\K

eyc

lick

En

abl

es/

Dis

abl

es

the

keyc

lick.

0-

D

isab

le k

eyc

lick

1-

E

na

ble

s ke

yclic

k

GE

NE

RA

L_C

ON

FIG

S\C

har

set

Se

lect

s th

e ch

ara

cter

set

.S

ET

1 -

Sel

ects

se

t 1

SE

T2

- S

elec

ts s

et

2 S

ET

3 -

Sel

ects

se

t 3

SE

T4

- S

elec

ts s

et

4 S

ET

5 -

Sel

ects

se

t 5

GE

NE

RA

L_C

ON

FIG

S\K

eym

apK

eym

ap f

ile.

An

y va

lid f

ile,

stru

ctu

red

as

de

scri

bed

in n

ote

1 b

elo

w.

GE

NE

RA

L_C

ON

FIG

S\F

orm

Tra

ceP

ars

er t

race

file

.A

ny

valid

pat

h/fi

lena

me

.

GE

NE

RA

L_C

ON

FIG

S\F

orm

s D

irT

he

pat

h t

o t

he f

orm

file

de

finiti

on

s.A

ny

valid

ab

solu

te p

ath

.

Cap

abili

tyV

alue

Typ

e

FIX

ED

Res

olu

tion

s3

2x1

6

No

. o

f LE

Ds

3

Su

pp

ort

ed

Key

s N

UM

ER

IC +

HE

XA

DE

CIM

AL

Text Terminal Unit

3-78

Ke

ybo

ard

Lo

ckFA

LS

E

Dis

pla

y L

igh

tsFA

LS

E

Cu

rso

rFA

LS

E

Fo

rms

TR

UE

Bee

pT

RU

E

Ke

ybo

ard

Buf

fer

size

33

Cap

abili

tyV

alue

Text Terminal Unit

3-79

Con

form

ance

Mat

rix -

Com

man

ds3

WO

SA

Com

man

d C

LC

omm

ents

WF

S_

INF

_TT

U_

ST

ATU

S2

lfw

Devi

ce o

f WF

S_

TT

U_

DE

VP

OW

ER

OF

F, W

FS

_T

TU

DE

VN

OD

EV

ICE

an

d

WF

S_

TT

U_

DE

VU

SE

RE

RR

OR

are

nev

er

retu

rne

d.

lw

Keyb

oard

is a

lway

s W

FS

_T

TU

_K

BD

ON

.

WF

S_

INF

_TT

U_

CA

PA

BIL

ITIE

S2

lT

he

LE

Ds

are

map

ped

as

follo

ws:

wL

ED

s[0

] =

S

up

erv

iso

r L

ED

wL

ED

s[1

] =

In

-ser

vice

LE

Dw

LE

Ds[

2]

=

Err

or

LED

WF

S_

INF

_TT

U_

FO

RM

_L

IST

2If

no

form

s a

re d

efin

ed,

lpsz

Fo

rmL

ist w

ill p

oin

t to

an

em

pty

dou

ble

nu

ll ch

ara

cter

te

rmin

ate

d

stri

ng (

i.e.

"\0

")

WF

S_

INF

_TT

U_

QU

ER

Y_

FO

RM

2N

on

e

WF

S_

INF

_TT

U_

QU

ER

Y_

FIE

LD2

No

ne

WF

S_

CM

D_

TT

U_

BE

EP

1l

Diff

ere

nt

typ

es o

f b

eep

s a

re n

ot-

supp

ort

ed.

All

be

ep t

ypes

def

ault

to a

54

0 H

z, 1

00m

s b

eep

lW

FS

_T

TU

_B

EE

PC

ON

TIN

UO

US

is a

ctio

ned

as

a p

erio

dic

be

ep w

ith a

per

iod

icity

of 2

00

ms

an

d a

dut

y cy

cle

of

50%

.

WF

S_

CM

D_

TT

U_

CLE

AR

SC

RE

EN

2N

on

e

WF

S_

CM

D_

TT

U_

DIS

PL

IGH

T2

Th

e co

mm

and

alw

ays

re

turn

s W

FS

_S

UC

CE

SS

but

is n

ot

act

ion

ed.

WF

S_

CM

D_

TT

U_

SE

T_

LED

1B

linki

ng L

ED

s a

re n

ot

sup

po

rted

. H

en

ce,

WF

S_

SE

T_

LED

SLO

WF

LAS

H,

WF

S_

SE

T_

LED

ME

DIU

MF

LA

SH

an

d W

FS

_SE

T_

LE

DQ

UIC

KF

LA

SH

are

act

ione

d a

s W

FS

_S

ET

_LE

DC

ON

TIN

UO

US

.

WF

S_

CM

D_

TT

U_

SE

T_

RE

SO

LU

TIO

N2

No

ne

WF

S_

CM

D_

TT

U_

DIS

PL

AY

_F

OR

M2

No

ne

WF

S_

CM

D_

TT

U_

RE

AD

_F

OR

M2

lIf

no

fiel

ds

are

rea

d, lpsz

Fie

lds w

ill p

oin

t to

an

em

pty

do

ub

le n

ull

cha

ract

er

term

ina

ted

str

ing

. (i

.e. "

\0")

.

lIf

th

e C

AN

CE

L ke

y is

pre

sse

d, t

he

retu

rned

str

ing

will

con

sist

of

the

field

s al

rea

dy r

ead

.

lIf

a t

imeo

ut

occ

urs

or

the

com

man

d is

can

celle

d v

ia W

FS

Can

celA

syn

cReq

ues

t, t

he r

etu

rned

st

ring

is N

ULL

.

Text Terminal Unit

3-80

WF

S_

CM

D_

TT

U_

WR

ITE

1l

WF

S_

TT

U_

PO

SR

EL

ATIV

E is

no

t su

pp

ort

ed.

lA

ttrib

ute

s W

FS

_T

TU

_T

EX

TU

ND

ER

LIN

ED

, W

FS

_T

TU

_T

EX

TIN

VE

RT

ED

an

d

WF

S_

TT

U_

TE

XT

FL

AS

H a

re a

ccep

ted

bu

t a

ctio

ned

as

nor

mal

tex

t.

WF

S_

CM

D_

TT

U_

RE

AD

1l

WF

S_

TT

U_

PO

SR

EL

ATIV

E is

no

t su

pp

ort

ed.

lA

ttrib

ute

s W

FS

_T

TU

_T

EX

TU

ND

ER

LIN

ED

, W

FS

_T

TU

_T

EX

TIN

VE

RT

ED

an

d

WF

S_

TT

U_

TE

XT

FL

AS

H a

re a

ccep

ted

an

d a

ctio

ned

as

nor

mal

tex

t.

lW

FS

_T

TU

_K

EYA

LPH

AN

UM

ER

IC is

no

t su

ppo

rte

d.

lIf

th

e C

AN

CE

L ke

y is

pre

sse

d, t

he

retu

rned

str

ing

will

con

sist

of t

he

char

act

ers

alre

ad

y re

ad

.

lIf

a t

imeo

ut

occ

urs

or

the

com

man

d is

can

celle

d v

ia W

FS

Can

celA

syn

cReq

ues

t, t

he r

etu

rned

st

ring

is N

ULL

.

WO

SA

Com

man

d C

LC

omm

ents

Text Terminal Unit

3-81

Con

form

ance

Mat

rix -

Err

ors

3

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_

INF

_TT

U_

QU

ER

Y_

FO

RM

WF

S_

ER

R_

TT

U_

FO

RM

NO

TF

OU

ND

2N

one

WF

S_

ER

R_

TT

U_

FO

RM

INVA

LID

2R

etu

rne

d u

nde

r th

e f

ollo

win

g c

on

diti

on

s:

lA

re

quir

ed k

eyw

ord

is f

oun

d t

o b

e m

issi

ng

in t

he

form

def

initi

on

du

ring

sta

rtu

p.

lN

o f

ield

s ar

e f

ou

nd

for

the

fo

rm d

urin

g

sta

rtu

p.

lT

he

dim

ensi

ons

of t

he fo

rm e

xcee

d th

e

curr

ent

reso

lutio

n o

f th

e sc

ree

n.

WF

S_

INF

_TT

U_

QU

ER

Y_

FIE

LDW

FS

_E

RR

_T

TU

_F

OR

MN

OT

FO

UN

D2

No

ne

WF

S_

ER

R_

TT

U_

FO

RM

INVA

LID

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lA

“re

qu

ired”

ke

ywor

d is

fou

nd

to

be

mis

sin

g in

th

e fo

rm d

efin

ition

du

rin

g st

artu

p.

lN

o f

ield

s ar

e f

ou

nd

for

the

fo

rm d

uri

ng

star

tup

.

lT

he

dim

ensi

ons

of t

he

form

exc

eed

the

cu

rren

t re

solu

tion

of

the

scre

en.

lA

req

ues

t is

mad

e to

ret

urn

de

tails

of a

ll th

e

field

s, a

nd

at

leas

t o

ne

of

the

m is

inva

lid a

s d

escr

ibe

d ab

ove

.

WF

S_

ER

R_

TT

U_

FIE

LD

NO

TF

OU

ND

2N

one

con

tinu

ed

...

Text Terminal Unit

3-82

WF

S_

INF

_TT

U_

QU

ER

Y_

FIE

LDW

FS

_E

RR

_T

TU

_F

IEL

DIN

VAL

ID2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lA

re

quir

ed k

eyw

ord

is f

oun

d t

o b

e m

issi

ng

in t

he

field

de

finiti

on

du

ring

sta

rtu

p.

lA

fiel

d h

eig

ht

gre

ater

th

an 1

is s

pe

cifie

d in

th

e f

orm

de

finiti

on.

lA

n in

valid

val

ue

is s

pec

ified

for

one

or

mo

re o

f th

e k

eyw

ord

s.

lT

YP

E,

CL

AS

S,

KE

YS

, A

CC

ES

S,

OV

ER

FL

OW

, S

TY

LE a

nd

HO

RIZ

ON

TAL

.

lD

ispl

ayin

g t

he f

ield

at

the

pos

itio

n

spec

ified

in t

he

field

de

finiti

on

cau

ses

the

fie

ld t

o o

verf

low

the

scr

een

.

WF

S_

CM

D_

TT

U_

BE

EP

WF

S_

ER

R_

INVA

LID

DAT

A0

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lB

EE

P_O

N a

nd

BE

EP

_O

FF

are

re

que

ste

d

tog

eth

er.

lA

n in

valid

bee

p t

ype

is s

pec

ified

.

WF

S_

CM

D_

TT

U_

CLE

AR

SC

RE

EN

WF

S_

ER

R_

INVA

LID

DAT

A0

Ret

urn

ed

wh

en t

he

rect

ang

le t

o b

e c

lear

ed

is n

ot

with

in t

he

curr

ent

scre

en

res

olu

tion

.

WF

S_

CM

D_

TT

U_

DIS

PL

IGH

TW

FS

_S

UC

CE

SS

2A

lwa

ys r

etu

rned

bu

t n

ot

actio

ned

.

WF

S_

CM

D_

TT

U_

SE

T_

LED

WF

S_

ER

R_

TT

U_

INVA

LID

LED

2R

etur

ne

d w

hen

w

Le

d is

no

t b

etw

een

0 a

nd

2 (

bo

th

incl

usi

ve).

WF

S_

ER

R_

INVA

LID

_D

ATA

0R

etur

ne

d w

hen

fw

Com

man

d is in

valid

.

WF

S_

CM

D_

TT

U_

SE

T_

RE

SO

LU

TIO

NW

FS

_E

RR

_T

TU

_R

ES

NO

TS

UP

P2

No

ne

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Text Terminal Unit

3-83

WF

S_

CM

D_

TT

U_

DIS

PL

AY

_F

OR

MW

FS

_E

RR

_T

TU

_F

OR

MN

OT

FO

UN

D2

No

ne

WF

S_

ER

R_

TT

U_

FO

RM

INVA

LID

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lA

re

quir

ed k

eyw

ord

is f

oun

d t

o b

e m

issi

ng

in t

he

form

de

finiti

on d

uri

ng

star

tup

.

lN

o f

ield

s ar

e f

ou

nd

for

the

fo

rm d

uri

ng

star

tup

.

lT

he

dim

ensi

ons

of t

he

form

exc

eed

the

cu

rren

t re

solu

tion

of

the

scre

en.

WF

S_

ER

R_

TT

U_

ME

DIA

OV

ER

FLO

W2

Ret

urn

ed

wh

en

dis

pla

ying

th

e p

rovi

ded

inp

ut

wo

uld

ca

use

s th

e f

ield

to

ove

rflo

w t

he

form

.

WF

S_

ER

R_

TT

U_

FIE

LD

SP

EC

FAIL

UR

E2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lA

fie

ld i

s sp

eci

fied

mo

re t

ha

n on

ce i

n t

he

inp

ut.

lIn

pu

t h

as

no

t b

een

pro

vid

ed

fo

r a

RE

QU

IRE

D f

ield

.

lA

fie

ld

spec

ified

in

th

e

inp

ut

do

es

not

bel

ong

to

th

e fo

rm.

lA

fie

ld s

pe

cifie

d in

th

e in

pu

t is

fo

und

to

be

inva

lid.

(See

co

mm

en

t fo

rW

FS

_E

RR

_T

TU

_F

IEL

DIN

VAL

ID

inW

FS

_IN

F_

QU

ER

Y_

FIE

LD)

WF

S_

ER

R_

TT

U_

FIE

LD

ER

RO

R2

Ret

urn

ed

wh

en t

he p

rovi

de

d in

put

exc

eed

s th

e f

ield

wid

th

an

d

an

actio

n o

f T

ER

MIN

ATE

h

as

bee

nsp

ecifi

ed fo

r O

VE

RF

LOW

in t

he f

orm

def

initi

on

.

WF

S_

ER

R_

INVA

LID

_D

ATA

0R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lA

n

inva

lid

poi

nte

r is

sp

eci

fied

for

lpsz

Fo

rmN

am

e or l

psz

Fie

lds.

lA

n in

valid

val

ue

is p

rovi

ded

fo

r b

Cle

arS

cre

en.

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Text Terminal Unit

3-84

WF

S_

CM

D_

TT

U_

RE

AD

_F

OR

MW

FS

_E

RR

_T

TU

_F

OR

MN

OT

FO

UN

D2

No

ne

WF

S_

ER

R_

TT

U_

FO

RM

INVA

LID

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lA

req

uire

d k

eyw

ord

is f

ou

nd

to b

e m

issi

ng

in t

he

form

de

finiti

on d

uri

ng

star

tup

.

lN

o f

ield

s a

re f

oun

d f

or t

he f

orm

du

ring

star

tup

.

lT

he

d

ime

nsi

on

s o

f th

e

form

e

xce

ed

the

curr

ent

reso

lutio

n o

f th

e sc

reen

WF

S_

ER

R_

TT

U_

FIE

LD

SP

EC

FAIL

UR

E2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lA

fie

ld i

s sp

eci

fied

mo

re t

ha

n on

ce i

n t

he

inp

ut.

lA

re

qui

red

fie

ld

is

no

t sp

ecifi

ed

in

the

inp

ut.

lA

fie

ld s

upp

lied

in

the

in

pu

t is

no

t p

art

of

the

fo

rm.

lA

fie

ld s

peci

fied

in t

he

inp

ut w

as

fou

nd t

ob

e in

valid

. (S

ee

com

men

t fo

rW

FS

_E

RR

_T

TU

_F

IEL

DIN

VAL

ID

inW

FS

_IN

F_

QU

ER

Y_

FIE

LD)

lA

fie

ld s

up

plie

d in

th

e in

pu

t o

verf

low

s th

esc

reen

.

WF

S_

ER

R_

TT

U_

KE

YC

AN

CE

LE

D2

Re

turn

ed

whe

n

the

R

EA

D_F

OR

M

com

man

d

iste

rmin

ate

d

by

pre

ssin

g

the

CA

NC

EL

ke

y.

The

retu

rne

d st

ring

co

nta

ins

the

ch

ara

cter

s e

nte

red

befo

re t

he

CA

NC

EL

key

wa

s p

ress

ed.

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

Text Terminal Unit

3-85

WF

S_

CM

D_

TT

U_

WR

ITE

WF

S_

ER

R_

INVA

LID

DAT

A3

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lW

FS

_T

TU

_P

OS

RE

LAT

IVE

is

sp

eci

fied

for

fwM

ode

.

lA

n

inva

lid

loca

tion

is

spe

cifie

d fo

r th

ew

rite.

lT

he

su

pp

lied

str

ing

ove

rflo

ws

the

scr

een.

lA

n in

valid

attr

ibu

te is

spe

cifie

d f

or t

he

text

.

lA

bu

ffer

of

len

gth

gre

ate

r th

an 2

000

byt

es

is s

pec

ified

for

lpsT

ext.

WF

S_

CM

D_

TT

U_

RE

AD

WF

S_

ER

R_

TT

U_

KE

YC

AN

CE

LE

D2

Th

e k

eys

en

tere

d u

pto

the

tim

e t

he

CA

NC

EL

key

isp

ress

ed

will

be

ret

urn

ed

in

lpsz

Inp

ut.

WF

S_

ER

R_

INVA

LID

DAT

A0

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s

lW

FS

_T

TU

_P

OS

RE

LAT

IVE

is

sp

ecifi

ed

for

fwM

ode

.

lA

fie

ld o

verf

low

s th

e s

cree

n.

lA

n in

valid

val

ue

is s

pec

ified

for

fwE

cho

Mo

de.

lA

n in

valid

val

ue

is s

pec

ified

for

fwK

eys

.

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents




Forms Interpretation 3

The implementation of forms is based on the following basic assumptions aboutfields and their attributes:

l ACCESS of a field is its primary attribute. Other attributes are validated withrespect to ACCESS.

l CLASS is an attribute of WRITE only fields and has no relevance whilereading a form.

l TYPE and KEYS are attributes of READ only fields and have no relevancewhile displaying a form.

l All other field attributes apply to both READ and WRITE fields.

l A read form command is usually preceded by a display form command. If anapplication provides a value for a read-write field in a display form command,the SP 'remembers' this value. If no keys are entered for that field in thefollowing read form, it returns that value. If a key is pressed, the entered key/sare superimposed on the 'remembered' value, and returned to the application.For example, if a value of '100,000.00' was specified for a read-write field in adisplay form, and then you enter '452' in the read form following the displayform, the string '452,000.00' will be returned to the application at the end ofthe read form.

l If there is no 'remembered' initial value when a read form command is issued,then the INITIALVALUE, (if one is specified in the form definition), is usedinstead. If neither is available, the field is blank at the start of the read-form.

l If an initial value is supplied but the format (an echo image as described inReference 25) is not, a default echo image consisting of n asterisks will beused, where n equals the number of characters in the INITIALVALUE string.

l If a format is provided without an initial value, then the field will be blank atthe start of the read operation.

l Initial values for fields of TYPE PASSWORD are ignored.

Forms Validation 3

Forms validation is performed in two stages; during start-up and at runtime.


When the SP starts up, all form definition files are opened and verified for syntax,'required fields' and content. Here, syntax refers to valid keywords, non-duplication of keywords, and matching BEGIN/END. Required fields are formSIZE, form LANGUAGE , field SIZE and field POSITION , and content is thevalue of the keywords, which must be within the capabilities of the device. Theform definitions are converted to an 'in-core' representation called the 'FormsDatabase'. Errors found during this initial validation are recorded in the FormsDatabase and logged in an error log file 'ttu_form.log'. The location of this errorlog file is specified in the registry.




Runtime validation:

Runtime validation is performed when QUERY_FORM, QUERY_FIELD,DISPLAY_FORM or READ_FORM are requested. It verifies that the form SIZEand field POSITION values contained in the definition do not conflict with thecapabilities of the device. For example, either of the co-ordinates of a fieldposition exceeding the resolution of the device. Runtime validation is requiredbecause the resolution of the TTU may be modified at any time using theWFS_TTU_SET_RESOLUTION command, which could render a form that isvalid for one resolution, invalid for another.

Runtime validation also verifies the following:

l All REQUIRED fields have been specified in the input.

l No value is supplied for STATIC fields. (See note 3 below).

l WRITE only fields are not specified in the READ_FORM command.

l READ only fields are not specified in the DISPLAY_FORM command.

The ACCESS attribute of a field is interpreted as follows:

The CLASS of a field is interpreted as follows:

WRITE Writing relates to displaying data on the screen. Thus,WRITE fields are those which the application canupdate on the display.

READ Reading relates to reading from the keyboard. Thus,READ fields are those which the application can readfrom the keyboard.

READ/WRITE These fields have a combination of the properties ofREAD and WRITE fields. The fields wouldtypically be used to display an initial value and thenread data from that field.

OPTIONAL These are fields for which the application need notsupply values. If a value is supplied, the field isprocessed, else it is ignored.

STATIC These are fields which the application cannotmanipulate. The values of these fields are contained inthe INITIALVALUE of the field. The application MUSTNOT provide values for such fields. If it does, the valueis ignored. No error is generated as the specificationdoes not provide an appropriate error code

REQUIRED These are fields for which the application MUSTprovide values.




Form Parser Error Messages and Limits 3

This section describes the limits of the TTU forms parser as well as the errormessages that may be generated by the forms parser. These error messages arelogged in the forms trace file, whose location is specified in the registry.

Form Parser Limits 3

The following are limits of the Form Parser:



100 characters





Text Terminal Unit

3-89

For

m P

arse

r M

essa

ges

3

Th

e f

ollo

win

g t

abl

e li

sts

the

erro

rs/w

arn

ing

mes

sag

es g

ene

rate

d b

y th

e fo

rm p

arse

r. T

hes

e e

rro

rs g

et lo

gg

ed

in t

he

fo

rms

trac

efile

wh

ose

nam

e an

d lo

catio

n a

re s

pe

cifie

d in

th

e r

egi

stry

.

Err

or M

essa

geD

escr

iptio

n

Err

or:

Fo

rm D

efin

itio

n fil

e n

ot f

ou

nd

- <

form

file

nam

e>

Th

e s

pe

cifie

d fo

rm d

efin

ition

co

uld

no

t b

e fo

und

.

Err

or:

Line

n:I

nter

na

l Err

or.

Un

know

n f

ield

typ

eA

n in

tern

al e

rro

r h

as o

ccu

rre

d w

hic

h p

reve

nts

fu

rth

er p

roce

ssin

g.

Err

or:

Line

n:I

nter

na

l Err

or

<e

rror

no.

>A

n in

tern

al m

em

ory

allo

catio

n e

rro

r h

as o

ccu

rre

d w

hic

h p

reve

nts

fu

rth

er p

roce

ssin

g.

Wa

rnin

g:L

ine n

:Un

exp

ect

ed k

eyw

ord

<ke

ywo

rd>

An

un

exp

ecte

d k

eyw

ord

<ke

ywo

rd>

ha

s b

een

en

cou

nte

red

. A

ke

ywo

rd is

un

exp

ecte

d if

it a

pp

ears

ou

t o

f p

lace

in t

he

form

d

efin

itio

n.

Wa

rnin

g:F

orm

<fo

rm n

am

e>

:Req

uire

d K

eyw

ord

<ke

ywo

rd>

Mis

sin

gR

equ

ired

ke

ywo

rd <

keyw

ord

> is

no

t sp

eci

fied

in th

e fo

rm d

efin

itio

n.

Wa

rnin

g:F

orm

<fo

rm n

am

e>

:Mu

ltip

le o

ccur

renc

es o

f ke

ywo

rd <

keyw

ord

>T

he

key

wo

rd <

keyw

ord

> h

as

ap

pear

ed

mu

ltip

le t

imes

in t

he

fo

rm

def

initi

on

. T

he

last

occ

urr

en

ce o

verw

rite

s a

ll p

revi

ou

s o

ccu

rren

ces.

Wa

rnin

g:F

orm

<fo

rm n

am

e>

:No

Fie

lds

No

fie

lds

hav

e b

een

de

fined

for

<fo

rm n

am

e>

.

Wa

rnin

g:F

orm

<fo

rm n

am

e>

:Fie

ld <

field

nam

e>:

Req

uire

d K

eyw

ord

<

keyw

ord

> M

issi

ng

Req

uire

d k

eyw

ord

<ke

ywo

rd>

is n

ot

spe

cifie

d in

th

e d

efin

itio

n o

f fie

ld <

field

nam

e>.

Wa

rnin

g:F

orm

<fo

rm n

am

e>

:Fie

ld <

field

nam

e>:

Mu

ltip

le O

ccu

rre

nce

s o

f K

eyw

ord

<ke

ywo

rd>

Th

e k

eyw

ord

<ke

ywo

rd>

ha

s a

ppe

are

d m

ulti

ple

tim

es in

th

e

def

initi

on

of

field

<fie

ld n

am

e>

.

Wa

rnin

g:L

ine n

:Inva

lid T

YP

E <

stri

ng>

An

inva

lid v

alu

e <

stri

ng>

is s

peci

fied

for

the

att

ribu

te T

YP

E.

Wa

rnin

g:L

ine n

:Inva

lid C

LA

SS

<st

ring

>A

n in

valid

va

lue

<st

ring

> is

spe

cifie

d f

or

the

attr

ibu

te C

LA

SS

.

Wa

rnin

g:L

ine n

:Inva

lid K

EY

S <

strin

g>

An

inva

lid v

alu

e <

stri

ng>

is s

peci

fied

fo

r th

e a

ttrib

ute

KE

YS

.

Wa

rnin

g:L

ine n

:Inva

lid A

CC

ES

S <

strin

g>

An

inva

lid v

alu

e <

stri

ng>

is s

peci

fied

fo

r th

e a

ttrib

ute

AC

CE

SS

.

Wa

rnin

g:L

ine n

:Inva

lid O

VE

RF

LO

W <

strin

g>

An

inva

lid v

alu

e <

strin

g>

is s

pec

ified

for

the

attr

ibut

e O

VE

RF

LO

W.

Wa

rnin

g:L

ine n

:Inva

lid S

TY

LE

<st

ring

>A

n in

valid

va

lue

<st

ring

> is

spe

cifie

d f

or

the

attr

ibu

te S

TY

LE

.

Wa

rnin

g:L

ine n

:Inva

lid H

OR

IZO

NTA

L <

stri

ng>

An

inva

lid v

alu

e <

stri

ng>

is s

peci

fied

for

the

att

ribu

te

HO

RIZ

ON

TAL

.

Wa

rnin

g:L

ine n

:Lin

e t

oo lo

ng

Th

e li

ne

is t

oo

lon

g t

o b

e p

roce

ssed

.

Text Terminal Unit

3-90

Wa

rnin

g:L

ine n

:Inva

lid k

eyw

ord

<st

ring

>A

n in

valid

ke

ywo

rd <

stri

ng>

is e

nco

un

tere

d. A

key

wo

rd is

inva

lid if

it

is n

ot

on

e o

f th

e k

eyw

ord

s de

fine

d in

th

e f

orm

'Def

initi

on

Syn

tax'

d

escr

ibe

d in

Re

fere

nce

7.

Wa

rnin

g:L

ine n

:Inva

lid in

teg

er v

alu

eA

n in

valid

str

ing

is s

pec

ified

for

an in

teg

er v

alu

e. T

he

stri

ng

is

inva

lid if

it is

of

0 le

ng

th o

r gr

eat

er t

han

th

e m

axi

mu

m le

ng

th o

f a

toke

n sp

ecifi

ed in

the

pre

vio

us s

ect

ion

, or

if it

co

nta

ins

non

-nu

me

ric

cha

ract

ers

.

Wa

rnin

g:L

ine n

:Inva

lid q

uo

ted

str

ing

An

inva

lid s

trin

g is

spe

cifie

d fo

r a

qu

ote

d st

ring

. Th

e st

ring

is in

valid

if it

is o

f 0

le

ngt

h o

r g

reat

er t

ha

n t

he

ma

xim

um

len

gth

of

a t

oke

nsp

ecifi

ed i

n t

he

pre

vio

us

sect

ion,

or

if it

is n

ot

encl

ose

d i

n d

ou

ble

qu

otes

(""

).

Wa

rnin

g:L

ine n

:Inva

lid t

oke

nA

to

ken

in t

he in

put

is in

valid

. A

to

ken

is in

valid

if it

s le

ng

th is

0 o

rg

rea

ter

tha

n th

e m

axi

mu

m le

ngt

h o

f a

toke

n s

pe

cifie

d in

th

e p

revi

ou

sse

ctio

n.

Wa

rnin

g:L

ine n

:Inva

lid O

R li

stA

n i

nva

lid O

R c

om

bin

atio

n o

f st

ring

s is

sp

ecifi

ed.

An

OR

lis

t is

inva

lid

if th

e

nu

mb

er

of

com

po

nen

t st

ring

s is

gr

eat

er

than

th

em

axi

mum

, o

r th

e le

ng

th o

f a

ny

on

e co

mp

on

ent

strin

g is

gre

ate

r th

an

the

max

imu

m s

pec

ified

in t

he p

revi

ou

s se

ctio

n.

Err

or M

essa

geD

escr

iptio

n




Default Keyboard Mapping 3

At startup, the Operator keyboard keys are mapped according to the key map filespecified in the registry. Keys not specified in the key map file will be mapped asfollows:

3


1 The OVERWRITE overflow action is not supported for any type of field.

2 Only the NORMAL attribute is supported. UNDER, INVERTED andFLASHING are accepted, but treated as NORMAL.

3 CENTER alignment is supported only for WRITE fields.

4 The Format string is relevant only to READ and READWRITE fields. 'EchoImages' are as defined in the Echo commands section of Reference 25.

5 The Initial value is relevant only to WRITE and READWRITE fields.

Key EOP

Position Code Description

01 31H ‘1’

02 32H ‘2’

03 33H ‘3’

04 F2H CANCEL

05 34H ‘4’

06 35H ‘5’

07 36H ‘6’

08 FFH CLEAR

09 37H ‘7’

10 38H ‘8’

11 39H ‘9’

12 F1H ENTER

13 E0H ‘00’

14 30H ‘0’

15 2EH ‘.’

16 FEH RUBOUT

17 41H ‘A’

18 42H ‘B’

19 43H ‘C’

20 44H ‘D’

21 45H ‘E’

22 46H ‘F’

23 NA UNUSED

24 NA UNUSED

WOSA/XFS - Programmer’s Reference ManualVendor Dependent Mode



Vendor Dependent Mode 3


3


Configurable Parameters 3

The VDM Service Provider has no configurable parameters.

3

Capabilities 3

The VDM Device Class has no defined capabilities.


None vdm_spx.dllvdm_wfp.dllvdm_ipc.dllvdm.dll

vdm.exe


VendorDependentMode1 The logical name of the Vendor Dependent Mode Service Provider




Conformance Matrix - Commands 3

3

Conformance Matrix - Events 3

3


1 When a VDM Entry/Exit request is issued, the SP posts a service event to allthe registered applications, in response to which, all registered applicationsare expected to send in an acknowledgment. The SP waits indefinitely for theacknowledgments. When in this state, the VDM will ignore all Entry/Exitrequests. It is therefore mandatory for all registered applications toacknowledge.

2 The VDM SP also expects an acknowledgment from the application thatissued the VDM Entry/Exit request.

3 The VDM SP does not interact with the hardware of the SST. It does not sensesupervisor switch changes, nor does it provide any additional functionalityapart from that specified in reference 8.

4 The VDM SP should be used together with a Vendor Dependent Application(VDA) which provides the functionality for the vendor dependent mode. Thisfunctionality may include sensing the supervisor switch and invokingUlysses’s System Application. The structure of a VDA is depicted as follows:

WOSA Command CL Comments

WFS_INF_VDM_STATUS 1 wDevice that specifies the status of Vendor DependentMode service class will always beWFS_VDM_DEVONLINE.

WFS_INF_VDM_CAPABILITIES 2 None

WFS_CMD_VDM_ENTER_MODE_REQ 2 None

WFS_CMD_VDM_ENTER_MODE_ACK 2 None

WFS_CMD_VDM_EXIT_MODE_REQ 2 None

WFS_CMD_VDM_EXIT_MODE_ACK 2 None

WOSA Event CL Comments

WFS_SRVE_VDM_ENTER_MODE_REQ 2 None

WFS_SRVE_VDM_EXIT_MODE_REQ 2 None

WFS_SYSE_VDM_MODEENTERED 2 None

WFS_SYSE_VDM_MODEEXITED 2 None




#include <xfsapi.h>#include <xfsvdm.h>

HSERVICE hVDMSp;// hService of the VDM SPWinMain(){

. . . .

. . . .

WFSStartUp(.., ..);

WFSOpen("VendorDependentMode1" , . . . ., &hVDMSp );

WFSRegister(hVDMSp, SERVICE_EVENTS|SYSTEM_EVENTS);

while(GetMessage(. ., . ., 0, 0)){

TranslateMessage(. . .);DispatchMessage(. . .);

}}

long PASCAL VDA_WndProc(HWND hWnd,UINT uiMsg,WPARAM wParam,LPARAM lParam){

LPWFSRESULT lpWFSResult=(LPWFSRESULT)lParam;

switch (uiMsg){case WFS_SERVICE_EVENT:

switch(lpWFSResult->u.dwEventID){

case WFS_SRVE_VDM_EXIT_MODE_REQ:WFSExecute(hVDMSp, WFS_CMD_VDM_EXIT_MODE_ACK, . . .);break;

case WFS_SRVE_VDM_ENTER_MODE_REQ:WFSExecute(hVDMSp, WFS_CMD_VDM_ENTER_MODE_ACK, . . .);break;

}break;

case WFS_SYSTEM_EVENT:switch( lpWFSResult->u.dwEventID ){

case WFS_SYSE_VDM_MODEENTERED:// Invoke Diagnostic Programbreak;case WFS_SYSE_VDM_MODEEXITED:// Cleanupbreak;

}break;

case WM_DESTROY:CloseVDMService(hVDMSp, . . .);lRetVal = WFSCleanUp();PostQuitMessage(0);break;

default: return DefWindowProc(hWnd,uiMsg,wParam,lParam);}return (0L);

}

WOSA/XFS - Programmer’s Reference ManualPinpad and Key Library



Pinpad and Key Library 3

Pinpad


Default Logical Service Name 3

Devices DLL Name(s)SP Executable

Basic Alpha Pinpad Encryptor (BAPE) Encryptor Keyboard Controller (EKC)

pin_spx.dllpin_wfp.dllpin_ipc.dllpin.dll

pin.exe


Pinpad1 The logical name of PIN Keypad Service Provider

Pinpad and Key Library

3-96

Con

figur

able

Par

amet

ers

3

Th

e fo

llow

ing

co

nfig

ura

ble

pa

ram

eter

s, s

tore

d in

th

e re

gis

try

und

er

the

WF

S_C

FG

_H

KE

Y_

XF

S_

RO

OT

\SE

RV

ICE

_P

RO

VID

ER

S\P

IN k

ey, a

re u

sed

by

the

PIN

Key

pad

Ser

vice

Pro

vid

er a

nd

th

e K

ey L

ibra

ry.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

GE

NE

RA

L_C

ON

FIG

S\V

aria

nt

Varia

nt

of t

he

en

cryp

tor

dev

ice

.0

1 f

or

BA

PE

va

rian

t, a

nd

05

fo

r E

KC

var

ian

t.

GE

NE

RA

L_C

ON

FIG

S\N

um

OfI

niti

alK

eys

Nu

mb

er o

f in

itial

ke

ys t

hat

sh

ou

ld b

e im

po

rte

d

bef

ore

a W

OS

A a

pp

lica

tion

com

es u

p.

In t

he

ran

ge

1 to

100

, b

oth

incl

usi

ve.

If N

um

OfIn

itial

Ke

ys is

0,

the

n n

o in

itia

l/ma

ster

ke

y is

req

uir

ed t

o b

e lo

ade

d b

efo

re s

tart

ing

up

th

e ap

plic

atio

n.

GE

NE

RA

L_C

ON

FIG

S\K

eyI

D1

Tem

po

rary

en

cryp

tion

key

-id

1.

In t

he

ran

ge

1 to

100

, b

oth

incl

usi

ve.

It sh

ould

b

e d

iffe

ren

t fr

om

ke

yid

2,

ivid

1 a

nd

ivid

2.

GE

NE

RA

L_C

ON

FIG

S\K

eyI

D2

Tem

po

rary

en

cryp

tion

key

-id

2.

In t

he

ran

ge

1 to

100

, b

oth

incl

usi

ve.

It sh

ould

b

e d

iffe

ren

t fr

om

ke

yid

1,

ivid

1 a

nd

ivid

2.

GE

NE

RA

L_C

ON

FIG

S\I

VID

1Te

mp

ora

ry in

itial

izat

ion

ve

cto

rid1

.In

th

e ra

ng

e 1

to 1

00,

bo

th in

clu

sive

. It

shou

ld

be

diff

ere

nt

fro

m k

eyi

d1

, ke

yid

2 a

nd

ivid

2.

GE

NE

RA

L_C

ON

FIG

S\I

VID

2Te

mp

ora

ry in

itial

izat

ion

ve

cto

r id

2.

In t

he

ran

ge

1 to

100

, b

oth

incl

usi

ve.

It sh

ould

b

e d

iffe

ren

t fr

om

ke

yid

1,

keyi

d2

an

d iv

id1

.


3-97

Th

e

follo

win

g

par

amet

ers

are

u

sed

on

ly

by

the

PIN

K

eyp

ad

S

ervi

ce

Pro

vid

er

softw

are

a

nd

are

st

ore

d

in

the

regi

stry

u

nd

er

the

WF

S_C

FG

_H

KE

Y_

XF

S_

RO

OT

/SE

RV

ICE

_P

RO

VID

ER

S/P

IN k

ey

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

KE

YB

OA

RD

\Va

rian

tVa

rian

t of

th

e c

ard

hold

er k

eyb

oa

rd (

CK

M)

dev

ice

.S

hou

ld b

e e

ither

21

, 2

2,

23,

41

, 4

2,

43

, 6

1,

62,

63

, A

1,A

2, A

3,

C1

, C2

, C

3, E

1, E

2 o

r E

3.

KE

YB

OA

RD

\FK

En

ter

Key

po

sitio

n c

ode

fo

r th

e E

NT

ER

fu

nct

ion

ke

y.In

the

ran

ge

0 t

o 6

4. V

alu

e 0

ind

ica

tes

tha

t th

e E

NT

ER

fun

ctio

n ke

y is

no

t su

pp

ort

ed

for

the

CK

M v

aria

nt.

KE

YB

OA

RD

\FK

En

terC

CC

ontr

ol c

od

e fo

r E

NT

ER

fu

nct

ion

ke

y.In

th

e r

ang

e 0

to

25

5.

KE

YB

OA

RD

\FK

Ca

ncel

Key

po

sitio

n c

ode

fo

r th

e C

AN

CE

L fu

nct

ion

key.

In t

he

ran

ge

0 to

64

. Va

lue

0 in

dic

ates

th

at th

e C

AN

CE

Lfu

nct

ion

key

is n

ot

sup

po

rte

d fo

r th

e C

KM

va

riant

.

KE

YB

OA

RD

\FK

Ca

ncel

CC

Con

tro

l co

de

for

CA

NC

EL

fun

ctio

n ke

y.In

th

e r

ang

e 0

to

25

5.

KE

YB

OA

RD

\FK

Cle

ar

Th

e k

ey p

osi

tion

co

de f

or

the

CL

EA

R f

un

ctio

n k

ey.

In t

he

ra

nge

0 t

o 6

4. V

alu

e 0

indi

cate

s th

at

the

CLE

AR

fun

ctio

n ke

y is

no

t su

pp

ort

ed

for

the

CK

M v

aria

nt.

KE

YB

OA

RD

\FK

Cle

arC

CC

ontr

ol c

od

e fo

r C

LE

AR

fu

nct

ion

key

.In

th

e r

ang

e 0

to

25

5.

KE

YB

OA

RD

\FK

Ba

cksp

ace

Key

po

sitio

n c

ode

fo

r th

e B

AC

KS

PA

CE

fu

nct

ion

key

.In

th

e

rang

e

0

to

64

. Va

lue

0

in

dic

ates

th

at

the

BA

CK

SP

AC

E

fun

ctio

n

key

is

not

sup

po

rte

d fo

r th

eC

KM

var

ian

t.

KE

YB

OA

RD

\FK

Ba

cksp

aceC

CC

ontr

ol c

od

e fo

r B

AC

KS

PA

CE

fu

nct

ion

ke

y.In

th

e r

ang

e 0

to

25

5.

KE

YB

OA

RD

\FK

He

lpK

ey p

osi

tion

co

de f

or

the

HE

LP

fu

nct

ion

ke

y.In

th

e r

ang

e 0

to

64

. Va

lue

0 i

nd

ica

tes

that

th

e H

EL

Pfu

nct

ion

key

is n

ot

sup

po

rte

d fo

r th

e C

KM

va

riant

.

KE

YB

OA

RD

\FK

He

lpC

CC

ontr

ol c

od

e fo

r H

EL

P f

un

ctio

n k

ey.

In t

he

ran

ge

0 t

o 2

55.

KE

YB

OA

RD

\FK

De

cPo

int

Key

po

sitio

n c

ode

fo

r th

e D

EC

PO

INT

fu

nctio

n k

ey.

In

the

ra

nge

0

to

6

4.

Valu

e

0

ind

icat

es

tha

t th

eD

EC

PO

INT

fu

nctio

n k

ey is

no

t su

pp

ort

ed

for

the

CK

Mva

rian

t.

KE

YB

OA

RD

\FK

De

cPo

intC

CC

ontr

ol c

od

e fo

r D

EC

PO

INT

fu

nctio

n k

ey.

In t

he

ran

ge

0 t

o 2

55.

KE

YB

OA

RD

\FK

00

Key

po

sitio

n c

ode

fo

r th

e 00

fun

ctio

n ke

y.In

th

e ra

ng

e 0

to

64

. V

alue

0 i

ndi

cate

s th

at t

he 0

0fu

nct

ion

key

is n

ot

sup

po

rte

d fo

r th

e C

KM

va

riant

.

KE

YB

OA

RD

\FK

00

CC

Con

tro

l co

de

for

00 fu

nct

ion

key.

In t

he

ran

ge

0 t

o 2

55.


3-98

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

use

d o

nly

by

the

Ke

y L

ibra

ry,

and

are

sto

red

in t

he

reg

istr

y un

de

r th

e

WF

S_

CF

G_

HK

EY

_X

FS

_R

OO

T/S

ER

VIC

E_

PR

OV

IDE

RS

/PIN

/KE

YL

IB ke

y.

Cap

abili

ties

3

KE

YB

OA

RD

\FK

00

0K

ey p

osi

tion

co

de f

or

the

000

fu

nct

ion

key

.In

th

e ra

ng

e 0

to 6

4.

Valu

e 0

ind

ica

tes

that

th

e 0

00

fun

ctio

n ke

y is

no

t su

pp

ort

ed

for

the

CK

M v

aria

nt.

KE

YB

OA

RD

\FK

00

0C

CC

ontr

ol c

od

e fo

r 00

0 f

un

ctio

n k

ey.

In t

he

ran

ge

0 t

o 2

55.

KE

YB

OA

RD

\FD

K0

1C

C-0

8C

CC

ontr

ol c

od

e fo

r F

DK

01-

08

ke

y.In

th

e r

ang

e 0

to

25

5.

KE

YB

OA

RD

\Act

ivat

or0

1-1

6C

ontr

ol c

od

e fo

r A

CT

IVA

TO

R_

01

-16

In

the

ran

ge

0

to

255

. V

alu

e 0

in

dic

ate

s it

as

unsu

pp

ort

ed

.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ue

Rep

osi

tory

Nam

e an

d lo

catio

n o

f th

e K

ey

Rep

osi

tory

.A

ny

abs

olu

te p

ath

+fil

en

ame.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

Cap

abili

tyV

alue

(E

KC

/BA

PE

)

fwT

ype

TY

PE

EP

P |

TY

PE

ED

M

bC

om

po

und

FALS

E

usK

eyN

um10

0 f

or

BA

PE

en

cryp

tor,

an

d 3

00

fo

r E

KC

enc

rypt

or

fwA

lgor

ithm

sC

RY

PT

DE

SE

CB

| C

RY

PT

DE

SC

BC

| C

RY

PT

DE

SM

AC

fwP

inF

orm

ats

FO

RM

362

4 |

FO

RM

AN

SI

| FO

RM

ISO

0 |

FO

RM

ISO

1 | F

OR

ME

CI2

| F

OR

ME

CI3

| F

OR

MV

ISA

fwD

eriv

atio

nA

lgor

ithm

s0

fwP

rese

nta

tion

Alg

ori

thm

s0

fwD

isp

lay

DIS

PN

ON

E

bID

Con

ne

ctFA

LSE


3-99

fwID

Ke

yID

KE

YIM

PO

RT

fwV

alid

atio

nA

lgo

rithm

sD

ES

| V

ISA

Cap

abili

tyV

alue

(E

KC

/BA

PE

)

fwT

ype

TY

PE

EP

P |

TY

PE

ED

M


3-100

Con

form

ance

Mat

rix -

Com

man

ds3

WO

SA

Com

man

dC

LC

omm

ents

WF

S_

INF

_PIN

_STA

TU

S1

lfw

De

vice

o

f W

FS

_P

IN_

DE

VP

OW

ER

OF

F

an

d W

FS

_P

IN_

DE

VN

OD

EV

ICE

a

ren

eve

r re

turn

ed.

WF

S_P

IN_D

EV

US

ER

ER

RO

R w

ill b

e r

etu

rned

if

the

ke

y re

po

sito

ryco

nfig

ura

tion

is in

corr

ect

or a

n e

rro

r o

ccur

s w

hile

re

trie

vin

g t

he

en

cryp

tor

stat

us

from

the

ke

y re

po

sito

ry.

lfw

En

cSta

t can

ass

um

e th

e f

ollo

win

g v

alu

es:

lW

FS

_P

IN_E

NC

UN

DE

FIN

ED

-

if th

e k

ey r

epo

sito

ry c

onf

igu

ratio

n i

s in

corr

ect

or

has

an

erro

r w

hile

get

ting

th

e e

ncr

ypto

r st

atu

s fr

om t

he

key

rep

osi

tory

.

lW

FS

_P

IN_E

NC

RE

AD

Y -

if t

he

en

cryp

tor

is in

itia

lize

d,

and

at

leas

t o

ne

wo

rkin

gke

y is

imp

orte

d in

th

e en

cryp

tor.

lW

FS

_P

IN_E

NC

INIT

IALI

ZE

D -

if

the

en

cryp

tor

is i

niti

aliz

ed,

an

d n

o w

ork

ing

key

is im

por

ted

in t

he

encr

ypto

r.

lW

FS

_P

IN_E

NC

NO

TIN

ITIA

LIZ

ED

- if

th

e en

cryp

tor

is n

ot in

itial

ized

.

lW

FS

_P

IN_E

NC

NO

TR

EA

DY

- i

f th

e en

cryp

tor

is n

ot

initi

aliz

ed,

and

at l

east

one

key

is im

por

ted

in t

he

encr

ypto

r.

WF

S_

INF

_PIN

_CA

PA

BIL

ITIE

S2

No

ne

WF

S_

INF

_PIN

_KE

Y_

DE

TAIL

1T

he in

put

pa

ram

ete

r lp

sKeyN

am

e will

be

inte

rpre

ted

as fo

llow

s:

lF

irst

th

e ke

y re

po

sito

ry w

ill b

e s

ear

che

d f

or

the

encr

yptio

n k

ey a

s sp

ecifi

ed b

y th

elp

sKe

yNa

me.

lIf

the

en

cryp

tion

key

lpsK

eyN

ame is

no

t pre

sen

t in

the

key

rep

osito

ry, t

hen

the

key

rep

osi

tory

will

be

se

arch

ed f

or

the

key-

cou

ple

as

spe

cifie

d b

y th

e

lpsK

eyN

am

e.

lIf

th

e e

ncr

yptio

n

key

an

d

key-

cou

ple

, bo

th

cou

ld

no

t be

fo

un

d in

th

e ke

yre

po

sito

ry,

the

n W

FS

_E

RR

_PIN

_KE

YN

OT

FO

UN

D e

rror

is r

etu

rne

d.

lIn

cas

e of

a k

ey-c

ou

ple

, tw

o e

ncry

ptio

n k

ey d

eta

ils (

thre

e W

FS

PIN

KE

YD

ETA

ILp

oin

ters

) ar

e re

turn

ed

in o

utp

ut p

ara

met

ers,

eac

h o

ne g

ivin

g e

ncry

ptio

n k

ey

det

ails

for

keys

for

min

g t

he

key-

cou

ple

.

WF

S_

INF

_PIN

_FU

NC

KE

Y_

DE

TAIL

2N

on

e


3-101

WF

S_

CM

D_

PIN

_C

RY

PT

1l

The

in

put

pa

ram

ete

rs

lpsK

ey

and

lpsS

tart

Va

lue

Ke

y sh

ou

ld s

pe

cify

the

en

cryp

tion

key

nam

e as

reg

iste

red

with

th

e k

ey r

epo

sito

ry.

lT

he in

put

pa

ram

ete

r lpxK

eyE

ncK

ey (lp

xSta

rtVa

lue),

if u

sed

, sh

oul

d h

ave

lp

xKeyE

ncK

ey-

>u

sLe

ng

th as

EN

CR

YP

TIO

N_

KE

Y_

LEN

GT

H

(IN

ITIA

LIZ

ATIO

N_

VE

CT

OR

_L

EN

GT

H)

and

lpxK

eyE

ncK

ey-

>lp

bDa

ta sp

eci

fyin

g t

he a

ctu

al v

alu

e.

lT

he in

put

pa

ram

ete

r lpxC

rypt

Da

ta s

hou

ld n

ot

be

NU

LL.

lF

or

MA

Cin

g, l

pxC

ryp

tDa

ta->

usL

en

gth s

ho

uld

no

t b

e 0

or

com

pre

sse

d d

ata

le

ngt

hsh

ou

ld n

ot

be

0.

lF

or

de

cryp

tion,

lpxC

rypt

Da

ta->

usL

en

gth s

hou

ld b

e m

ulti

ple

of

8 b

yte

s.

WF

S_

CM

D_

PIN

_IM

PO

RT

_K

EY

2l

The

inpu

t p

ara

me

ter lpsK

ey s

ho

uld

spe

cify

th

e e

ncr

yptio

n k

ey n

am

e o

r in

itia

liza

tion

ve

cto

r na

me

as

regi

ster

ed

with

th

e ke

y re

posi

tory

.

lT

he in

pu

t pa

ram

eter

lp

sEn

cKe

y sh

ould

sp

ecify

the

enc

rypt

ion

ke

y na

me

as

reg

iste

red

with

th

e ke

y re

pos

itory

.

lT

he i

np

ut

par

am

eter

lpxI

den

t can

be

use

d t

o p

ass

a s

ecre

t ke

yspa

ce p

ass

wo

rd w

hen

imp

ort

ing

a k

ey

for

the

EK

C e

ncry

pto

r. I

n th

is c

ase

, lp

xIde

nt-

>u

sLe

ng

th sh

oul

d b

e s

etto

P

AS

SW

OR

D_

LEN

GT

H

and

lpxI

den

t->

lpb

Va

lue

sho

uld

sp

eci

fy

the

valu

e

of

pas

swo

rd in

he

x.

lT

he in

put

pa

ram

ete

r lpxV

alu

e->

usL

en

gth s

ho

uld

be

set

to

EN

CR

YP

TIO

N_

KE

Y_

LE

NG

TH

(o

r IN

ITIA

LIZ

ATIO

N_

VE

CT

OR

_LE

NG

TH

) a

nd

lpxV

alu

e->

lpb

Da

ta sh

ou

ld s

pec

ify t

he

actu

al k

ey v

alu

e.

lT

he v

alu

e of

inp

ut p

ara

me

ter

fwU

se s

hou

ld m

atc

h th

at

sto

red

in t

he

key

rep

osi

tory

fo

r th

e e

ncr

yptio

n ke

y b

ein

g im

po

rte

d.

WF

S_

CM

D_

PIN

_D

ER

IVE

_K

EY

0N

on

e

WF

S_

CM

D_

PIN

_G

ET

_P

IN1

Inp

ut p

ara

me

ters

u

sMin

Len,

bA

uto

En

d an

d cE

cho a

re ig

nore

d.

lT

he f

ollo

win

g v

alu

es

will

be

re

turn

ed fo

r th

e o

utp

ut

para

met

er

wC

om

ple

tion e

ven

th

ou

gh

th

ey a

re d

efin

ed

onl

y fo

r th

e ex

ecu

te e

ven

t:

lW

FS

_P

IN_

CO

MP

CL

EA

R

lW

FS

_P

IN_

CO

MP

BA

CK

SP

AC

E

lIf

an

y u

nuse

d k

ey is

pre

sse

d,

or a

ny

un

know

n k

ey

code

is r

ece

ive

d, t

hen

th

e ex

ecu

te

eve

nt w

ill s

how

ulD

igit

par

am

ete

r a

s 0

x00

an

d th

e c

om

ma

nd

will

be

com

ple

ted

as

if it

is c

ance

lled

.

WO

SA

Com

man

dC

LC

omm

ents


3-102

WF

S_

CM

D_

PIN

_L

OC

AL_

DE

S1

lIn

put

pa

ram

ete

r lpsV

alid

atio

nD

ata,

if

no

n-N

UL

L, s

ho

uld

co

nta

in c

har

act

ers

havi

ng

valu

es in

th

e r

ang

e 0

x30

-0x3

9 an

d 0

x41

-0x4

6.

lIn

put

par

amet

er lpsO

ffse

t, if

no

n-N

ULL

, sh

oul

d c

on

tain

ch

ara

cte

rs h

avi

ng

va

lue

s in

the

ra

nge

0x3

0-0

x39

.

lIn

put

par

amet

er bP

ad

din

g sh

ou

ld h

ave

a v

alu

e i

n t

he r

ang

e 0

x30

-0x3

9. O

the

rwis

e0

x30

will

be

use

d a

s th

e d

efa

ult

valu

e, w

ith n

o e

rro

r co

de

retu

rne

d.

lIn

put

par

am

ete

r usM

axP

IN s

hou

ld b

e i

n t

he

ran

ge

MIN

_C

HE

CK

_L

EN

GT

H a

nd

MA

X_

CH

EC

K_

LEN

GT

H.

lIn

put

par

am

ete

r usV

alD

igits

sh

ou

ld b

e in

th

e ra

nge

MIN

_LE

FT_

SH

IFT

_VA

LUE

an

dM

AX

_LE

FT_

SH

IFT

_VA

LUE

.

lIn

put

pa

ram

ete

r lpsK

ey

sho

uld

sp

eci

fy t

he

en

cryp

tion

ke

y na

me

as

reg

iste

red

with

the

key

rep

osi

tory

.

lIn

put

pa

ram

ete

r lpxK

eyE

ncK

ey,

if u

sed

, sh

ou

ld h

ave

lpxK

eyE

ncK

ey-

>u

sLe

ng

th as

EN

CR

YP

TIO

N_

KE

Y_

LE

NG

TH

an

d lp

xKeyE

ncK

ey-

>lp

bD

ata

spe

cify

ing

the

act

ual

valu

e.

WF

S_

CM

D_

PIN

_C

RE

AT

E_

OF

FS

ET

0N

on

e

WF

S_

CM

D_

PIN

_L

OC

AL_

EU

RO

CH

EQ

UE

0N

on

e

WF

S_

CM

D_

PIN

_L

OC

AL_

VIS

A1

lIn

put

pa

ram

ete

r lpsP

AN,

sh

ou

ld c

on

tain

ch

ara

cter

s h

avin

g v

alu

es

in t

he

ran

ge 0

x30

-0

x39

and

0x4

1-0

x46

.

lIn

put

pa

ram

ete

r lpsP

VV,

if n

on-N

UL

L, s

ho

uld

co

nta

in c

har

act

ers

havi

ng

va

lue

s in

the

ra

ng

e 0

x30

-0x3

9.

lIn

put

pa

ram

ete

r wP

VV

Dig

its s

ho

uld

be

in t

he

ra

nge

MIN

_LE

FT_S

HIF

T_

VALU

E a

nd

MA

X_

LEFT

_S

HIF

T_

VALU

E.

lIn

put

pa

ram

ete

r lpsK

ey s

ho

uld

sp

ecify

a k

ey-c

oup

le n

am

e if

lp

xKeyE

ncK

ey in

pu

t is

n

ot

bei

ng u

sed

.

lIn

put

pa

ram

ete

r lpxK

eyE

ncK

ey, if

use

d,

shou

ld h

ave

lp

xKeyE

ncK

ey-

>u

sLe

ng

th as

2

times

EN

CR

YP

TIO

N_K

EY

_LE

NG

TH

an

d

lpxK

eyE

ncK

ey-

>lp

bD

ata

spe

cify

ing

th

e a

ctua

l val

ue.

WF

S_

CM

D_

PIN

_P

RE

SE

NT

_ID

C0

No

ne

WO

SA

Com

man

dC

LC

omm

ents


3-103

3

WF

S_

CM

D_

PIN

_G

ET

_P

INB

LOC

K1

lIn

put

par

am

ete

r lpsC

ust

om

erD

ata, i

f u

sed,

sh

ou

ld c

ont

ain

cha

ract

ers

hav

ing

valu

es

in

the

ra

nge

0x3

0-0

x39

and

0x4

1-0

x46

.

lIn

put

pa

ram

ete

r lpsX

OR

Da

ta is

ign

ore

d.

lIn

put

pa

ram

ete

r bP

add

ing w

ill b

e us

ed o

nly

for

for

mat

s W

FS

_P

IN_

FO

RM

362

4,

WF

S_

PIN

_FO

RM

ISO

1 an

d W

FS

_F

OR

M_

EC

I2.

It sh

ou

ld b

e in

th

e ra

ng

e 0

x30

-0x3

9

and

0x4

1-0

x46

.

lIn

put

pa

ram

ete

r lpsK

ey c

ann

ot

be N

UL

L an

d s

ho

uld

sp

ecify

ke

y n

ame

as r

egis

tere

d

with

th

e ke

y re

pos

itory

.

lIn

put

par

amet

er lpsK

eyE

ncK

ey, i

f use

d, s

hou

ld s

peci

fy k

ey

nam

e a

s re

gist

ere

d w

ith th

e ke

y re

po

sito

ry.

WF

S_

CM

D_

PIN

_G

ET

_D

ATA

1l

Ou

tpu

t p

ara

me

ter lp

sDa

ta w

ill o

nly

con

tain

nu

me

ric d

igits

; an

d d

ecim

al p

oin

t(s)

, if

any

.

lT

he fo

llow

ing

va

lue

s w

ill a

lso

be

retu

rned

for

the

out

pu

t pa

ram

eter

w

Co

mp

letio

n eve

n

tho

ug

h t

hey

are

de

fine

d o

nly

for

exe

cute

eve

nt:

lW

FS

_P

IN_C

OM

PC

LE

AR

lW

FS

_P

IN_C

OM

PB

AC

KS

PA

CE

lIf

an

y u

nuse

d k

ey is

pre

sse

d,

or a

ny

un

know

n k

ey

code

is r

ece

ive

d, t

hen

th

e ex

ecu

te

eve

nt w

ill s

how

ulD

igit

par

am

ete

r a

s 0

x00

an

d th

e c

om

ma

nd

will

be

com

ple

ted

as

if it

is c

ance

lled

.

WF

S_

CM

D_

PIN

_IN

ITIA

LIZ

AT

ION

1T

he in

put

po

inte

r sh

oul

d b

e N

UL

L.

WO

SA

Com

man

dC

LC

omm

ents


3-104

Con

form

ance

Mat

rix -

Err

ors

3

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_

INF

_PIN

_STA

TU

SN

on

e0

No

ne

WF

S_

INF

_PIN

_CA

PA

BIL

ITIE

SN

on

eN

one

WF

S_

INF

_PIN

_KE

Y_

DE

TAIL

WF

S_E

RR

_P

IN_

KE

YN

OT

FO

UN

D1

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lK

ey n

am

e is

inva

lid.

lE

ncr

yptio

n k

ey

is n

ot

reg

iste

red

with

th

e k

ey

rep

osi

tory

and

ke

y-co

up

le w

ith n

am

e s

pe

cifie

d is

als

o n

ot

reg

iste

red

with

th

e ke

y re

po

sito

ry.

WF

S_E

RR

_P

IN_

AC

CE

SS

DE

NIE

D3

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lK

ey r

ep

osi

tory

is e

mp

ty.

lS

eve

re e

rror

wh

ile a

cces

sin

g t

he

key

rep

osi

tory

.

WF

S_

INF

_PIN

_FU

NC

KE

Y_

DE

TAIL

No

ne

0N

one

WF

S_

CM

D_

PIN

_C

RY

PT

WF

S_E

RR

_P

IN_

KE

YN

OT

FO

UN

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

llp

sKe

y is

not

re

gis

tere

d w

ith t

he

key

repo

sito

ry.

llp

sSta

rtV

alu

eK

ey is

no

t re

gis

tere

d w

ith t

he

key

rep

osi

tory

.

WF

S_E

RR

_P

IN_

KE

YN

OVA

LUE

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

llp

sKe

y is

n

ot

impo

rted

in

e

ncr

ypto

r;

asin

dic

ate

d b

y ke

y re

pos

itory

inf

orm

atio

n f

or

the

key.

llp

sSta

rtV

alu

eK

ey is

no

t im

po

rte

d in

en

cryp

tor;

as i

nd

ica

ted

by

key

rep

osi

tory

inf

orm

atio

n f

or

the

key

.

WF

S_E

RR

_P

IN_

US

EV

IOLA

TIO

N2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

llp

sKe

y d

oes

no

t h

ave

pro

per

typ

e o

f ac

cess

fo

ren

cryp

tion

in t

he k

ey

rep

osi

tory

.

llp

sSta

rtV

alu

eK

ey d

oes

no

t h

ave

pro

pe

r ty

pe

of

acce

ss in

th

e ke

y re

posi

tory

.

con

tinu

ed

....


3-105

WF

S_

CM

D_

PIN

_C

RY

PT

WF

S_E

RR

_P

IN_

MO

DE

NO

TS

UP

PO

RT

ED

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lIn

valid

enc

rypt

ion

mo

de

is s

pec

ified

in

wM

od

ein

pu

t p

aram

eter

.

lIn

valid

e

ncr

yptio

n

alg

orith

m

is

spe

cifie

d

inw

Alg

ori

thm

inp

ut

par

am

ete

r.

WF

S_E

RR

_P

IN_

AC

CE

SS

DE

NIE

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lK

ey r

ep

osi

tory

is e

mp

ty.

lE

ncr

ypto

r is

no

n-in

itia

lize

d.

lS

eve

re e

rror

wh

ile a

cces

sin

g t

he

key

rep

osi

tory

.

WF

S_E

RR

_P

IN_

INVA

LID

KE

YLE

NG

TH

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

llp

xKe

yEn

cKey i

np

ut p

oin

ter

is n

on-N

UL

L a

nd

lpxK

eyE

ncK

ey-

>u

sLe

ngth

is

not

equ

al

toE

NC

RY

PT

ION

_K

EY

_LE

NG

TH

.

llp

xKe

yEn

cKey i

np

ut p

oin

ter

is n

on-N

UL

L a

nd

lpxK

eyE

ncK

ey-

>lp

bD

ata i

s N

UL

L.

llp

xSta

rtVa

lue

inp

ut

poi

nte

r is

no

n-N

UL

L a

nd

lpxS

tart

Valu

e->

usL

en

gth

is

no

t eq

ual

to

INIT

IALI

ZAT

ION

_VE

CT

OR

_L

EN

GT

H.

llp

xSta

rtV

alu

e in

put

po

inte

r is

no

n-N

ULL

an

dlp

xSta

rtV

alu

e->

lpb

Da

ta is

NU

LL.

WF

S_

CM

D_

PIN

_IM

PO

RT

_K

EY

WF

S_E

RR

_P

IN_

KE

YN

OT

FO

UN

D2

No

ne

WF

S_E

RR

_P

IN_

KE

YN

OVA

LUE

2N

one

WF

S_E

RR

_P

IN_

US

EV

IOLA

TIO

N2

No

ne

WF

S_E

RR

_P

IN_

INVA

LID

ID2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

llp

xIde

nt

inp

ut

po

inte

r is

n

on-

NU

LL

an

dlp

xIde

nt-

>u

sLe

ng

th is

n

ot

equ

al

toP

AS

SW

OR

D_

LEN

GT

H.

llp

xIde

nt

inp

ut

po

inte

r is

n

on-

NU

LL

an

dlp

xIde

nt-

>lp

bDa

ta is

NU

LL

poi

nte

r. con

tinu

ed.

..

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-106

WF

S_

CM

D_

PIN

_IM

PO

RT

_K

EY

WF

S_E

RR

_P

IN_

DU

PL

ICA

TE

KE

Y2

Th

e k

ey h

as

alre

ady

bee

n i

mp

ort

ed;

can

no

t b

e re

-im

por

ted

.

WF

S_E

RR

_P

IN_

INVA

LID

KE

YLE

NG

TH

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

llp

xVa

lue->

usL

en

gth

is

not

e

qu

al

toE

NC

RY

PT

ION

_K

EY

_LE

NG

TH

.

llp

xVa

lue->

lpbD

ata

is N

UL

L p

oin

ter.

WF

S_E

RR

_P

IN_

AC

CE

SS

DE

NIE

D3

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lK

ey r

ep

osi

tory

is e

mp

ty.

lE

ncr

ypto

r is

no

n-in

itia

lize

d.

lS

eve

re e

rror

wh

ile a

cces

sin

g t

he

key

rep

osi

tory

.

WF

S_

CM

D_

PIN

_G

ET

_P

INW

FS

_ER

R_

PIN

_K

EY

INVA

LID

0T

his

err

or

cod

e w

ill n

ot b

e g

ene

rate

d.

WF

S_E

RR

_P

IN_

KE

YN

OT

SU

PP

OR

TE

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lu

lAct

iveK

eys

inp

ut

spec

ifies

a k

ey

that

is n

ot

sup

port

ed.

lu

lTe

rmin

ate

FD

Ks in

put

spe

cifie

s a

key

tha

t is

n

ot s

upp

ort

ed

.

WF

S_E

RR

_P

IN_

NO

AC

TIV

EK

EY

S2

ulA

ctiv

eK

eys

inp

ut

is e

qu

al t

o 0

.

WF

S_E

RR

_P

IN_

NO

TE

RM

INAT

EK

EY

S0

Th

is e

rro

r co

de

will

not

be

gen

era

ted

.

WF

S_E

RR

_P

IN_

MIN

IMU

MLE

NG

TH

0T

his

err

or

cod

e w

ill n

ot b

e g

ene

rate

d.

WF

S_

CM

D_

PIN

_L

OC

AL_

DE

SW

FS

_ER

R_

PIN

_K

EY

NO

TF

OU

ND

2lp

sKe

y is

not

re

gis

tere

d w

ith t

he

key

repo

sito

ry.

WF

S_E

RR

_P

IN_

KE

YN

OVA

LUE

2lp

sKe

y is

no

t im

po

rte

d in

en

cryp

tor;

as

ind

icat

ed b

yke

y re

posi

tory

info

rmat

ion

for

th

e k

ey.

WF

S_E

RR

_P

IN_

US

EV

IOLA

TIO

N2

lpsK

ey

do

es n

ot

hav

e pr

op

er t

ype

of

acce

ss i

n t

he

key

repo

sito

ry.

WF

S_E

RR

_P

IN_

AC

CE

SS

DE

NIE

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lK

ey r

ep

osi

tory

is e

mp

ty.

lE

ncr

ypto

r is

no

n-in

itia

lize

d.

lS

eve

re e

rror

wh

ile a

cces

sin

g t

he

key

rep

osi

tory

.

con

tinu

ed

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-107

WF

S_

CM

D_

PIN

_L

OC

AL_

DE

SW

FS

_ER

R_

PIN

_N

OP

IN2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lT

he

PIN

buf

fer

is e

mpt

y; n

o p

revi

ous

issu

e o

fW

FS

_C

MD

_P

IN_

GE

T_

PIN

com

ma

nd.

lT

he

PIN

bu

ffer

is c

lear

ed b

efo

re t

his

com

ma

nd.

WF

S_E

RR

_P

IN_

INVA

LID

KE

YLE

NG

TH

3R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

llp

xKe

yEn

cKey-

>u

sLe

ngth

is

not

equ

al

toE

NC

RY

PT

ION

_K

EY

_LE

NG

TH

.

llp

xKe

yEn

cKey-

>lp

bD

ata i

s N

UL

L p

oin

ter.

WF

S_

CM

D_

PIN

_L

OC

AL_

VIS

AW

FS

_ER

R_

PIN

_K

EY

NO

TF

OU

ND

2lp

sKe

y is

not

re

gis

tere

d w

ith t

he

key

re

po

sito

ry a

sen

cryp

tion

ke

y o

r ke

y-co

up

le.

WF

S_E

RR

_P

IN_

KE

YN

OVA

LUE

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

llp

sKe

y is

n

ot

impo

rted

in

e

ncr

ypto

r;

asin

dic

ate

d b

y ke

y re

pos

itory

inf

orm

atio

n f

or

the

key.

lA

t le

ast

one

or

bo

th o

f th

e k

eys

in k

ey-

cou

ple

lpsK

ey

is

not

im

port

ed

in

en

cryp

tor;

as

ind

ica

ted

by

key

rep

osito

ry i

nfo

rma

tion

fo

r th

eke

y.

WF

S_E

RR

_P

IN_

US

EV

IOLA

TIO

N2

lpsK

ey

do

es n

ot

hav

e pr

op

er t

ype

of

acce

ss i

n t

he

key

repo

sito

ry.

WF

S_E

RR

_P

IN_

AC

CE

SS

DE

NIE

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lK

ey r

ep

osi

tory

is e

mp

ty.

lE

ncr

ypto

r is

no

n-in

itia

lize

d.

lS

eve

re e

rror

wh

ile a

cces

sin

g t

he

key

rep

osi

tory

.

WF

S_E

RR

_P

IN_

NO

PIN

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lT

he

PIN

buf

fer

is e

mpt

y; n

o p

revi

ous

issu

e o

fW

FS

_C

MD

_P

IN_

GE

T_

PIN

com

ma

nd.

lT

he

PIN

bu

ffer

is c

lear

ed b

efo

re t

his

com

ma

nd.

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-108

WF

S_

CM

D_

PIN

_G

ET

_P

INB

LOC

KW

FS

_ER

R_

PIN

_K

EY

NO

TF

OU

ND

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

llp

sKe

y is

not

reg

iste

red

with

th

e k

ey r

epo

sito

ryas

en

cryp

tion

ke

y.

llp

sKe

yEnc

Key i

s n

ot

reg

iste

red

with

th

e ke

yre

po

sito

ry a

s e

ncry

ptio

n k

ey.

WF

S_E

RR

_P

IN_

KE

YN

OVA

LUE

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

llp

sKe

y is

n

ot

impo

rted

in

e

ncr

ypto

r;

asin

dic

ate

d b

y ke

y re

pos

itory

inf

orm

atio

n f

or

the

key.

llp

sKe

yEnc

Key is

no

t im

po

rte

d i

n e

ncr

ypto

r; a

sin

dic

ate

d b

y ke

y re

pos

itory

inf

orm

atio

n f

or

the

key.

WF

S_E

RR

_P

IN_

US

EV

IOLA

TIO

N2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

llp

sKe

y d

oes

no

t h

ave

pro

per

typ

e o

f ac

cess

in

the

key

re

po

sito

ry.

llp

sKe

yEnc

Key d

oes

no

t h

ave

pro

per

ty

pe

of

acce

ss in

th

e ke

y re

posi

tory

.

WF

S_E

RR

_P

IN_

MO

DE

NO

TS

UP

PO

RT

ED

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lw

Fo

rma

t in

put

spec

ifies

u

nsu

ppo

rted

fo

rmat

for

PIN

.

lT

he

en

tere

d P

IN l

eng

th

is

not

valid

fo

r th

efo

rmat

sp

eci

fied

in wF

orm

at i

np

ut.

WF

S_E

RR

_P

IN_

AC

CE

SS

DE

NIE

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lK

ey r

ep

osi

tory

is e

mp

ty.

lE

ncr

ypto

r is

no

n-in

itia

lize

d.

lS

eve

re e

rror

wh

ile a

cces

sin

g t

he

key

rep

osi

tory

.

WF

S_E

RR

_P

IN_

NO

PIN

2R

etur

ne

d u

nde

r th

e f

ollo

win

g co

nd

itio

ns:

lT

he

PIN

bu

ffer

is e

mp

ty;

no

pre

vio

us is

sue

of

WF

S_

CM

D_

PIN

_G

ET

_P

IN c

omm

an

d.

lT

he

PIN

bu

ffer

is c

lear

ed b

efo

re t

his

com

ma

nd.

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-109

Con

form

ance

Mat

rix -

Eve

nts

3 3

WF

S_

CM

D_

PIN

_G

ET

_D

ATA

WF

S_E

RR

_P

IN_

KE

YIN

VAL

ID0

Th

is e

rro

r co

de

will

not

be

gen

era

ted

.

WF

S_E

RR

_P

IN_

KE

YN

OT

SU

PP

OR

TE

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lu

lAct

iveF

DK

s in

put

spe

cifie

s a

ke

y th

at

is n

ot

sup

port

ed.

lu

lAct

iveK

eys

inp

ut

spec

ifies

a k

ey

that

is n

ot

sup

port

ed.

lu

lTe

rmin

ate

FD

Ks in

put

spe

cifie

s a

key

tha

t is

n

ot s

upp

ort

ed

.

lu

lTe

rmin

ate

Ke

ys in

pu

t sp

ecifi

es a

key

th

at is

n

ot s

upp

ort

ed

.

WF

S_E

RR

_P

IN_

NO

AC

TIV

EK

EY

S2

ulA

ctiv

eK

eys

inp

ut

is e

qu

al t

o 0

.

WF

S_

CM

D_

PIN

_IN

ITIA

LIZ

AT

ION

WF

S_E

RR

_P

IN_

AC

CE

SS

DE

NIE

D2

Ret

urn

ed

und

er

the

fo

llow

ing

con

diti

on

s:

lE

ncr

ypto

r is

no

n-in

itia

lize

d.

lS

eve

re e

rror

wh

ile a

cces

sin

g t

he

key

rep

osi

tory

.

WF

S_E

RR

_P

IN_

INVA

LID

ID0

Th

is e

rro

r co

de

will

not

be

gen

era

ted

.

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WO

SA

/XF

S E

vent

sC

LC

omm

ents

WF

S_

EX

EE

_PIN

_KE

Y2

No

ne

WF

S_

SR

VE

_P

IN_

INIT

IAL

IZE

D2

No

ne

WF

S_

SR

VE

_P

IN_

ILL

EG

AL

_K

EY

_A

CC

ES

S2

No

ne





1 Position and Key codes are stored in the registry and should be set accordingto the physical layout of the keyboard. Thus for example, if the CLEAR key islocated on the top-right hand corner of the keyboard, FKClear should be set to04 and FKClearCC to 255 (if default codes are being used). Position codes aredocumented in the "Control Codes And Keycode Parameters" section of theProgramer's Manual for the Cardholder Keyboard Manager (Ref. 26). Thisdocument also discusses constraints on the assignment of keycodes.




Key Library and WOSA/XFS MVSS Application 3

The Key Library API maintains an encryption key repository, that stores all therequired information concerning the hardware encryption keys for the WOSA/XFSMVSS system. The following diagram illustrates the location of the Key LibraryAPI within the WOSA/XFS MVSS system, a Key Loading application and ADIfor NCR SSTs:

WOSA/XFS Application Key Loading Application

Key Library

Functions

Key Repository

XFS ManagerPIN Keypad Service Provider

ADI

1. WFSExecute commands for PINpad requires direct call to ADI commands.

1. WFSGetInfo commands for PINpad keys requires call to key library commands.

2. Key validation also requires call to the key library commands.

1. Key Loading application uses the ADI commands to load initial keys and other necessary initialization.




A WOSA/XFS MVSS application works on NCR SSTs, and conforms to thestandards developed by the Banking Solutions Vendor Council. A Key Loadingapplication is developed by the WOSA/XFS MVSS application developers for usewith a WOSA/XFS MVSS application, to perform encryptor initialization at thecustomer site.

The Key Library API provides an interface for recording names, usage andlocation of encryption keys which are used/managed by the WOSA/XFSapplication. It also stores the encryptor status (initialized/not initialized). TheWOSA/XFS application starts executing only after the encryptor is initialized.

Using the Key Library 3

Encryption keys are classified into two categories - keys that are loaded beforeany WOSA/XFS MVSS application starts on SST, called 'working' keys,

'initial or master' keys, and keys that are loaded/imported by the WOSA/XFS MVSS application during its execution, called 'working' keys.

It is the Key Loading application’s task to load the initial keys before starting aWOSA/XFS MVSS application on an NCR SST. This task is performed when theSST is installed at the customer site and before the WOSA/XFS MVSS applicationis started on it. It can be repeated when the encryptor device is again required to beinitialized for whatever reason.

The Key Library is used along with the WOSA/XFS MVSS application as follows:

l First, Key Library commands are used to create key repository recordsthat identify the name, id, type of access of the encryption key andwhether it is a master (initial) key. The names of all the initial keys andworking keys are recorded in the key repository. The WOSA/XFS MVSSapplication knows well in advance, the names of keys that it will beusing, and these are found in the key repository.

l Next, the Initial keys are loaded. You need to perform some additionalvendor-specific tasks like creating a keyspace structure for theWOSA/XFS MVSS application, or entering a password for the secretsecure keyspace, in order to be capable of loading the initial keys.

l After performing these initialization tasks, the key loading applicationuses a key library command to set the encryptor status to 'initialized'. Thisindicates that the encryptor is ready to run a WOSA/XFS MVSSapplication.

l The WOSA/XFS MVSS application can now be started.

A Key Loading application can be developed for each customer site that willautomate the process of initial key loading. But, you may still have to intervene -for example, to enter a password.

Apart from encryption keys, the Key Library also maintains Starting Vectors orInitialization Vectors (IV). The IV has the same properties as that of the encryptionkeys, except that it is used only for MAC generation and CBC encryption.




Key Library Information 3

The Key Library stores all information concerning the encryption keys used by theWOSA/XFS MVSS system. It also keeps track of the encryptor status (initializedor not), and stores vendor-specific keyspace management information needed foreach key.

From the WOSA/XFS MVSS point of view, the following information isassociated with the encryption key:

l A keyname

l A keyid

l A keyspaceid

l Type of access information

l An Initialization Vector (IV) flag

l A master_key_flag

In addition to this, the ‘loaded_flag’ is also stored in the key repository:

The following diagram depicts the possible inputs/outputs to or from Key Librarycommands:

Key

Commands

Library

Keyname

Keyid

Type_of_access

Master_key_flag

Loaded flag

Keyspaceid (0 for BAPE)

IV_Flag

Keyname

Keyid

Type_of_access

Master_key_flag

Keyspaceid

IV_Flag

KeyRepository




The application/s (Key Loading or WOSA/XFS MVSS) identifies a key by itsKeyname. The keyname is unique within the Key Library.

The Keyid information specifies the key identifier as required by the encryptorADI commands. It is in the range of 1-100 for BAPE and 0-299 for EKC variant ofthe encryptor. The keyid is also unique within the Key Library.

The Type_of_access information identifies how the encryption key has been used in the WOSA/XFS MVSS application. It identifies the functions that are allowed to use this encryption key. It is a combination of the following values:

WFS_PIN_USECRYPT

WFS_PIN_USEFUNCTION

WFS_PIN_USEMACING

WFS_PIN_USEKEYENCKEY

WFS_PIN_USESVENCKEY

WFS_PIN_USENODUPLICATE.

Note that for EKC variant, the combination of WFS_PIN_USECRYPT andWFS_PIN_USEFUNCTION is not allowed.

The Master_flag identifies an initial key for the WOSA/XFS MVSS application.Initially, a master key is loaded in the encryptor. The encryptor status is then set toinitialize and the WOSA/XFS MVSS application is started.

The Keyspaceid identifies the identifier of the keyspace to which the key belongs,in case of EKC encryptor. The keyspaceid is in the range 0-15 for EKC encryptor.It is 0 for BAPE encryptor.

The Loaded_flag information is maintained by the Key Library to indicatewhether the key is currently loaded in the encryptor or not.

The IV_flag information identifies whether the key will act as IV for MACgeneration or CBC encryption.

All the key repository information is available outside the Key Library as a resultof an information command.

The value of an encryption key is not stored in the key repository. The actual valueof a key is never available externally, even through Key Library commands. Youhave to maintain it through the Key Loading application, or any other applicationthat uses the Key Library and allows loading/exchanging of the key in theencryptor. The application actually loads/exchanges/deletes encryption keys in theencryptor and updates the key repository information using the Key Librarycommands.

The key repository also stores maintenance information to check the integrity ofthe repository, and its Sync Status, that indicates whether or not the repositorycontents are in sync with the encryptor contents. The sync status is set by theapplication before using any ADI command that loads/deletes encryption keys inthe encryptor. It is reset after the successful updating of the key repository. Whensync status indicates that the repository is out of sync with the encryptor, theencryptor needs to be re-initialized.




The key repository also maintains information about Key Couple'. A key couple isa pair of encryption keys. Note that IVs cannot be specified as one of the keys ofthe key couple.

Key Library Configuration Information 3

The configuration information for the Key Library which may vary for differentcustomer sites or different installations of NCR SSTs, is stored in a separateconfiguration repository.The name and location of this repository is stored underWOSA/XFS_ROOT\SERVICE_PROVIDERS\PIN\KEYLI\Repository.

In addition to the above, the Key Library shares parameters Variant, KeyID1,KeyID2, IVID1 & IVID2 described earlier in this chapter with the Pinpad ServiceProvider. Note that the configuration information for the Key Library is a subset ofthat of the PIN Keypad Device Service Provider. The configuration repositorymust be present in order to use Key Library commands.




CMD_KEYLIB_INITIALIZE 3

PurposeThis command initializes the Key Library for the calling application.

Synopsis#include <key_lib.h>

int CMD_KEYLIB_INITIALIZE ( ) ;

DescriptionThis command initializes the Key Library for the calling application. It readsconfiguration information from the registry, validates it and checks the integrity ofthe key repository. This function should be called before issuing any other KeyLibrary function calls. It returns the encryptor status (i.e. whether the encryptor isinitialized or not) or the initialization error code.

ParametersNone.

Return ValueINT iResult

The return value is either the error code for the Key Library initializationfailure or the encryptor status, if the Key Library initialization issuccessful. The value TRUE (1) indicates that the encryptor is initializedand the value FALSE (0) indicates it to be non-initialized.

If the function returned is not TRUE (1) or FALSE (0), it is one of thefollowing error codes described in the Key Library Error Codes section:

KL_ERR_KEYLIB_CONFIGURATION_ERROR

KL_ERR_ENCRYPTOR_VARIANT_CONFIGURATION_ERROR

KL_ERR_INVALID_ENCRYPTOR_VARIANT

KL_ERR_TEMPKEY_1_CONFIGURATION_ERROR

KL_ERR_TEMPKEY_2_CONFIGURATION_ERROR

KL_ERR_TEMPIV_1_CONFIGURATION_ERROR

KL_ERR_TEMPIV_2_CONFIGURATION_ERROR

KL_ERR_REPOSITORY_NAME_CONFIGURATION_ERROR

KL_ERR_REPOSITORY_OUT_OF_SYNC

KL_ERR_REPOSITORY_INTEGRITY_ERROR

KL_ERR_REPOSITORY_ACCESS_ERROR




KL_ERR_INTERNAL_ERROR




CMD_CREATE_KEY_NAME 3

PurposeThis command registers an encryption key with the specified attributes with theKey Library. (Adds an encryption key record in the key repository).


int CMD_CREATE_KEY_NAME (LPSTR lpszKeyName,USHORT usKeyId,USHORT usKeyspaceId,WORD fwTypeOfAccess,BOOL bIsIV,BOOL bMasterKeyFlag);

DescriptionThis command registers an encryption key with the specified attributes with theKey Library. (Adds an encryption key record in the key repository). The key is notloaded into the encryptor. It is only made known to the Key Library.

Note:

For the encryption keys in BAPE, all combinations of type of access values areallowed, except WFS_PIN_USENODUPLICATE.

For encryption keys in EKC, all combinations of type of access values are allowed,except OR'ing of WFS_PIN_USECRYPT and WFS_PIN_USEFUNCTION.

For IVs, only combinations of WFS_PIN_USECRYPT, WFS_PIN_USEMACINGand WFS_PIN_USENODUPLICATE are allowed.

The master key flag cannot be TRUE for IVs. That is, the master key flag and IVflag cannot be TRUE simultaneously.

If the master key flag is TRUE for an encryption key, the type of access should beWFS_PIN_USEKEYENCKEY and/or WFS_PIN_USESVENCKEY.

ParametersLPSTR lpszKeyName

The name of the encryption key. A string of up to MAX_KEYNAME_LENGTH characters.

USHORT usKeyId

The keyid of the encryption key. It should be in the range 1-100 for BAPE and 0-299 for an EKC encryptor.

USHORT usKeyspaceId




The keyspaceid of the encryption key. It should be in the range 0-15 for EKC and 0 for a BAPE encryptor.




WORD fwTypeOfAccess

WOSA/XFS type of access for the encryption key specified as a combination of WFS_PIN_USECRYPT, WFS_PIN_USEFUNCTION, WFS_PIN_USEMACING, WFS_PIN_USEKEYENCKEY, WFS_PIN_USESVENCKEY and WFS_PIN_USENODUPLICATE.Note that for IVs, only combinations of WFS_PIN_USECRYPT, WFS_PIN_USEMACING and WFS_PIN_USENODUPLICATE are allowed.

BOOL bIsIV

The flag indicating whether this key is to be loaded as an IV in theencryptor or not. A TRUE value indicates that it should be IV.

BOOL bMasterKeyFlag

The flag indicating whether this key is a master key or not. A TRUE valueindicates a master key and a FALSE value indicates that this key is not amaster key.

Return ValueINT iSuccess

The return value indicating success of an encryption key registration. Azero value indicates success.

If the function returned is not zero, it is one of the following error codesdescribed in the Key Library Error Codes section:



KL_ERR_INVALID_KEY_NAME

KL_ERR_DUPLICATE_KEY_NAME

KL_ERR_DUPLICATE_KEY_ID

KL_ERR_INVALID_KEY_ID

KL_ERR_INVALID_TYPEOFACCESS

KL_ERR_INVALID_KEYSPACE_ID

KL_ERR_INVALID_MASTER_KEY_FLAG_FOR_IV




CMD_CREATE_KEY_COUPLE 3

PurposeThis command creates a key couple with the specified key names pair.


int CMD_CREATE_KEY_COUPLE (LPSTR lpszKeyCouple,

LPSTR lpszKeyName1,

LPSTR lpszKeyName2);

DescriptionThis command creates a key couple with the specified key names pair. (Adds a keycouple record in the key repository). The key names should already exist in the keyrepository and none of the two keys should be IVs. The same key-name can bespecified for both the keys in the key couple.

ParametersLPSTR lpszKeyCouple

The name of the key couple. A character string of up toMAX_KEYNAME_LENGTH characters.

LPSTR lpszKeyName1

The name of the already registered encryption key.

LPSTR lpszKeyName2

The name of the already registered encryption key.


The return value indicating success of key couple registration. A zero valueindicates success.


KL_ERR_REPOSITORY_EMPTY



KL_ERR_INVALID_KEY_COUPLE_NAME

KL_ERR_INVALID_KEY_NAME_1




KL_ERR_INVALID_KEY_NAME_2

KL_ERR_DUPLICATE_KEY_COUPLE_NAME

KL_ERR_KEY_NAME_1_NOT_FOUND

KL_ERR_KEY_NAME_2_NOT_FOUND

KL_ERR_KEY_NAME_1_IS_IV

KL_ERR_KEY_NAME_2_IS_IV




CMD_DELETE_KEY_NAME 3

PurposeThis command de-registers the specified encryption key with the Key Library.(Deletes the key repository record for the key).


int CMD_DELETE_KEY_NAME (LPSTR lpszKeyName);

DescriptionThis command de-registers the specified encryption key from the Key Library. Thekey should be deleted from the encryptor before de-registering it from the KeyLibrary. The key couple(s), which use the key to be deleted, should also be deletedbefore deleting the encryption key.


The name of the encryption key. A character string of up toMAX_KEYNAME_LENGTH characters.

Return valueINT iSuccess

The return value indicating success of encryption key deletion. A zerovalue indicates success, otherwise an error code is returned.





KL_ERR_KEY_NOT_FOUND

KL_ERR_INVALID_KEY_STATUS

KL_ERR_KEY_NAME_IN_USE




CMD_DELETE_KEY_COUPLE 3

PurposeThis command de-registers the specified key couple from the Key Library.(Deletes the key repository record for the key couple).


int CMD_DELETE_KEY_COUPLE (LPSTR lpszKeyCouple);

DescriptionThis command de-registers the specified key couple from the Key Library.


The name of the key couple. A character string of up to MAX_KEYNAME_LENGTH characters.


The return value indicating success of key couple deletion. A zero valueindicates success, otherwise an error code is returned.


KL_ERR_NO_KEY_COUPLE_RECORDS



KL_ERR_KEY_COUPLE_NOT_FOUND




CMD_SET_KEY_STATUS 3

PurposeThis command updates the Loaded_flag information for the specified encryptionkey in the key repository.


int CMD_SET_KEY_STATUS (LPSTR lpszKeyName,

BOOL bLoadedFlag);

DescriptionThis command updates the loaded_flag information for the specified encryptionkey in the key repository. This command unconditionally updates the keyrepository record (without checking the current status of the loaded_flaginformation for the key).


The name of the encryption key. A character string of up to MAX_KEYNAME_LENGTH characters.

BOOL bLoadedFlag

The flag indicating whether the loaded_flag information for the specifiedkey is to be set or reset. TRUE indicates that the key is currently loaded inthe encryptor and FALSE indicates that the key is deleted from theencryptor or that it can be overwritten.


The return value indicating success of loaded_flag information update. Azero value indicates success, otherwise an error code is returned.












CMD_SET_ENCRYPTOR_STATUS 3

PurposeThis command sets the encryptor state to either initialized or non-initialized.


int CMD_SET_SYNC_STATUS (BOOL bSyncStatus);

DescriptionThis command sets the encryptor state to either initialized or non-initialized. Itunconditionally updates the key repository (without checking the current encryptorstatus).

ParametersBOOL bEncryptorStatus

The flag indicating whether the encryptor status is to be set to initialized ornon-initialized. TRUE indicates that the encryptor status is to be set toinitialized and FALSE indicates the encryptor status is to be set to non-initialized.


The return value indicating success of encryptor status update. A zerovalue indicates success, otherwise an error code is returned.







CMD_SET_SYNC_STATUS 3

PurposeThis command sets the sync status to either 'in-sync' or 'out-of-sync'.


int CMD_SET_ENCRYPTOR_STATUS (BOOL bEncryptorStatus);

DescriptionThis command sets the sync status to either 'in-sync' or 'out-of-sync'. It is used bythe application to set the sync status to 'out-of-sync' before issuing an ADIcommand to load/delete keys into/from the encryptor. After the ADI command iscomplete and the corresponding key repository is successfully updated, thiscommand should be used to set the sync status to 'in-sync'.

ParametersBOOL bSyncStatus

The flag indicating whether the sync status is to be set to 'in-sync' or 'out-of-sync'. TRUE indicates that the sync status is to be set to 'in-sync' andFALSE indicates that the sync status is to be set to 'out-of-sync'.


The return value indicating success of sync status update. A zero valueindicates success, otherwise an error code is returned.






INFO_GET_KEY_DETAIL 3

PurposeThis command returns key repository information for an encryption key.


int INFO_GET_KEY_DETAIL (LPSTR lpszKeyName,LPKLKEYDETAIL lptKeyDetail);

DescriptionThis command returns key repository information for an encryption key. It doesnot produce any interaction with the encryptor. It can be used by a Key Loading orWOSA/XFS MVSS applications to obtain key information.



LPKLKEYDETAIL lptKeyDetail

The key detail structure KLKEYDETAIL that stores the key repositoryinformation defined as follows:

typedef struct kl_key_detail{

LPSTR lpszKeyName;USHORT usKeyId;WORD fwTypeOfAccess;BOOL bMasterKey;BOOL bLoadedFlag;USHORT usKeyspaceId;BOOL bIsIV;

} KLKEYDETAIL, *LPKLKEYDETAIL;

Note, the application should release the returned data usingWFMFreeBuffer.

LPSTR lpszKeyName


USHORT usKeyId




The keyid of the encryption key. It should be in the range 1-100 for BAPE and 0-299 for EKC.




WORD fwTypeOfAccess

The WOSA/XFS type of access for an encryption key specified as a combination of WFS_PIN_USECRYPT, WFS_PIN_USEFUNCTION, WFS_PIN_USEMACING, WFS_PIN_USEKEYENCKEY, WFS_PIN_USESVENCKEY and WFS_PIN_USENODUPLICATE.

BOOL bMasterKeyFlag

The flag indicating whether this key is a master key or not. TRUE indicatesa master key and FALSE indicates that it is not a master key.

BOOL bLoaded

The flag indicating whether the key is currently loaded in the encryptor ornot. TRUE indicates that the key is currently loaded in the encryptor andFALSE indicates that the key is not loaded in the encryptor.

USHORT usKeyspaceId

The keyspaceid to which the key belongs.

BOOL bIsIV

The flag indicating whether this key is IV or not. TRUE indicates that it is an IV.


The return value indicating success of a key query. A zero value indicatesthat the key exists in the key library and that repository information isreturned, otherwise an error code is returned.








INFO_GET_KEY_COUPLE_DETAIL 3

PurposeThis command returns the key repository information on a key couple.


int INFO_GET_KEY_COUPLE_DETAIL (LPSTR lpszKeyCouple, LPKLKEYCOUPLE ptKeyCouple);

DescriptionThis command returns the key repository information for a key couple.


The name of the key couple. A null terminated character string of up toMAX_KEYNAME_LENGTH characters.

LPKLKEYCOUPLE lptKeyCouple

A key couple structure KLKEYCOUPLE that stores the key repositoryinformation. It is defined as follows:

typedef struct kl_key_couple

{LPSTR lpszKeyCouple;LPSTR lpszKeyName1;LPSTR lpszKeyName2;

} KLKEYCOUPLE, *LPKLKEYCOUPLE;

Note, the application should release the returned data using WFMFreeBuffer.

LPSTR lpszKeyCouple

The name of the key couple.

LPSTR lpszKeyName1

The name of the encryption key 1 in the key pair.

LPSTR lpszKeyCouple

The name of the encryption key 2 in the key pair.







Return ValueINTi Success

The return value indicating success of a key couple query. A zero valueindicates that the key couple exists in the key library and that repositoryinformation is returned, otherwise an error code is returned.


KL_ERR_NO_KEY_COUPLE_RECORDS


KL_ERR_KEY_COUPLE_NOT_FOUND




INFO_GET_KEY_NAMES 3

PurposeThis command returns all the registered keynames in the key library.


int INFO_GET_KEY_NAMES (LPPKEYNAMES *lppsKeyNames);

DescriptionThis command returns all the registered keynames in the key library. It does notproduce any interaction with the encryptor. It can be used by Key Loading and/orWOSA/XFS MVSS applications to retrieve all available keynames, and then useINFO_GET_KEY_DETAIL on each of them.

ParametersLPPKEYNAMES lppsKeyNames

A pointer to a NULL terminated array of pointers to keynames that areregistered with the Key Library. If iSuccess is zero and this pointer isNULL, then the key repository is empty. Note, the application shouldrelease the returned data using WFMFreeBuffer.


The return value indicating success of keynames query. A zero valueindicates that at least one key exists in the key library and keyname/s is/arereturned, otherwise an error code is returned.







INFO_GET_KEY_COUPLES 3

PurposeThis command returns all the registered key couples in the key library.


int INFO_GET_KEY_COUPLES (LPPKEYCOUPLES *lppsKeyCouples);

DescriptionThis command returns all the registered key couples in the key library.

ParametersLPPKEYCOUPLES lppsKeyCouples

A pointer to a NULL terminated array of pointers to key couple names thatare registered with the Key Library. If iSuccess is zero and this pointer isNULL, then the key repository contains no key couple records. Note, theapplication should release the returned data using WFMFreeBuffer.


The return value indicating success of key couples query. A zero valueindicates that at least one key exists in the key library and keyname/s is/arereturned, otherwise an error code is returned.





3-137

INF

O_G

ET

_EN

CR

YP

TO

R_S

TAT

US

3

Pur

pose

De

term

ine

s th

e en

cryp

tor

stat

us.

Syn

opsi

s#

incl

ud

e <

key_

lib.h

>

int

INF

O_

GE

T_

EN

CR

YP

TO

R_

ST

AT

US

(B

OO

L

*b

pEn

cryp

torS

tatu

s);

Des

crip

tion

Th

is c

om

ma

nd

ret

urn

s th

e e

ncr

ypto

r st

atus

. It

do

es n

ot

pro

duce

an

y in

tera

ctio

n w

ith t

he

encr

ypto

r. It

can

be

use

d b

yK

ey

Loa

din

g a

nd/o

r W

OS

A/X

FS

MV

SS

ap

plic

atio

ns

to d

ete

rmin

e t

he e

ncr

ypto

r st

atu

s.

Par

amet

ers

BY

TE

bE

ncr

ypto

rSta

tus

Th

e

flag

ind

icat

ing

w

het

her

th

e

encr

ypto

r is

in

itia

lize

d o

r n

on

-initi

aliz

ed.

TR

UE

in

dic

ate

s th

at

it is

initi

aliz

ed

and

FA

LSE

indi

cate

s th

at

it is

no

n-i

niti

aliz

ed.

Ret

urn

Valu

eIN

TiS

ucc

ess

Alw

ays

0.


3-138

INF

O_G

ET

_SY

NC

_STA

TU

S3

Pur

pose

Th

is c

om

man

d r

etu

rns

the

sync

sta

tus

of t

he

key

re

po

sito

ry.

Syn

opsi

s#

incl

ud

e <

key_

lib.h

>

int

INF

O_G

ET

_S

YN

C_

ST

AT

US

(B

OO

L *b

pS

yncS

tatu

s);

Des

crip

tion

Th

is c

om

ma

nd

ret

urn

s th

e

syn

c st

atu

s o

f th

e ke

y re

po

sito

ry a

s 'in

-syn

c' o

r 'o

ut-o

f-sy

nc'

. It

is u

sed

by

the

Key

Lib

rary

DLL

at

initi

aliz

atio

n, t

o c

hec

k th

at t

he

rep

osi

tory

an

d e

ncr

ypto

r ar

e sy

nch

ron

ized

. If

th

e re

po

sito

ry is

fo

und

to b

e ‘o

ut-

of-s

ync’

, th

e ke

y lib

rary

will

fail

to in

itia

lize.

Par

amet

ers

BY

TE

bS

yncS

tatu

s

Th

e f

lag

ind

icat

ing

wh

eth

er

the

sync

sta

tus

is s

et t

o 'in

-syn

c' o

r 'o

ut-

of-s

ync'

. T

RU

E in

dica

tes

that

th

e s

ync

stat

us

is s

et t

o 'i

n-s

ync'

and

FA

LSE

indi

cate

s th

at

the

syn

c st

atu

s is

se

t to

'ou

t-o

f-sy

nc'

.

Ret

urn

Valu

eIN

TiS

ucc

ess

Alw

ays

0.


3-139

Key

Lib

rary

and

WO

SA

/XF

S M

VS

S E

ncry

ptio

n K

eys

3

WO

SA

/XF

S

MV

SS

a

pp

lica

tion

s re

fer

to

the

en

cryp

tion

ke

ys

usi

ng

ke

yna

me

s.

All

the

keyn

ames

th

at

the

WO

SA

/XF

S a

pplic

atio

n w

ill u

se s

hou

ld b

e re

gis

tere

d w

ith th

e K

ey

Lib

rary

.

Wo

rkin

g

keys

ar

e

loa

ded

in

to

the

encr

ypto

r b

y th

e W

OS

A/X

FS

M

VS

S

ap

plic

atio

n us

ing

th

eW

FS

_CM

D_

PIN

_IM

PO

RT

_K

EY

com

ma

nd.

Th

e ke

y va

lue

is e

ithe

r sp

ecifi

ed in

a c

lear

tex

t fo

rm o

r an

en

cryp

ted

form

. In

cas

e o

f an

en

cryp

ted

key

val

ue,

a k

ey

exc

ha

nge

ke

y is

sp

ecifi

ed t

o d

ecr

ypt t

he

enc

rypt

ed

key

valu

e, a

nd t

he

enc

rypt

ion

key

is lo

aded

with

the

de

cryp

ted

valu

e. T

he

key

rep

osi

tory

ne

eds

to b

e u

pd

ated

for

this

new

ly lo

aded

key

for

wh

ich

th

e C

MD

_S

ET

_K

EY

_STA

TU

S c

om

ma

nd

is u

sed.

Th

e o

ther

WO

SA

/XF

S M

VS

S c

omm

and

s fo

r P

IN K

eyp

ad

refe

r to

key

s e

ither

by

keyn

ame

alo

ne,

or

by

aco

mb

inat

ion

of k

eyn

ame

and

enc

rypt

ed k

ey v

alu

e.

lW

he

n th

e re

fere

nce

is

only

by

a ke

yna

me

, th

e k

ey

sho

uld

be

alr

ead

y lo

aded

/ im

port

ed i

n th

e en

cryp

tor;

eith

er i

niti

ally

bef

ore

sta

rtin

g t

he

WO

SA

/XF

S M

VS

S a

pp

licat

ion

or

with

in t

he

app

licat

ion

, u

sin

g th

eW

FS

_CM

D_

PIN

_IM

PO

RT

_K

EY

co

mm

an

d.

Th

e K

ey L

ibra

ry c

om

ma

nd I

NF

O_

GE

T_

KE

Y_D

ETA

IL i

su

sed

to o

bta

in t

he

key

stat

us

an

d o

the

r re

qu

ired

info

rma

tion

.

lW

he

n th

e re

fere

nce

is b

y a

com

bin

atio

n o

f ke

yna

me

an

d e

ncr

ypte

d k

ey

valu

e, t

he

act

ual

en

cryp

tion

ke

y fo

re

xecu

ting

th

e c

om

man

d is

to

be

de

rive

d. T

he

spe

cifie

d k

eyn

am

e r

efe

rs t

o a

key

exc

han

ge k

ey t

ha

t sh

ou

ldb

e a

lread

y lo

aded

/imp

orte

d in

th

e e

ncr

ypto

r. T

her

e a

re t

wo

ke

ys t

o b

e no

ted

- t

he

spe

cifie

d k

ey

exch

an

ge

key

an

d th

e n

ew

ke

y th

at

is t

o b

e l

oa

ded

in

to t

he

en

cryp

tor

with

th

e d

ecry

pted

va

lue.

Ho

wev

er,

th

eke

ynam

e fo

r th

is n

ew

key

is n

ot s

pe

cifie

d b

y th

e W

OS

A/X

FS

MV

SS

app

licat

ion

. Th

e P

IN K

eyp

ad

Se

rvic

eP

rovi

de

r an

d

Key

L

ibra

ry

hav

e

to

take

ca

re

of

such

'te

mp

ora

ry

keys

' fo

r th

e W

OS

A/X

FS

M

VS

Sa

pplic

atio

n.

Tem

pora

ry K

eys

3

A "

tem

por

ary

ke

y" r

efe

rs t

o t

he

key

(id)

tha

t is

use

d b

y th

e P

INp

ad S

erv

ice

Pro

vid

er

wh

en t

he W

OS

A/X

FS

MV

SS

PIN

Key

pad

co

mm

and

su

pplie

s an

en

cryp

ted

key

val

ue,

an

d p

rovi

des

a na

me

of

the

sto

red

ke

y to

be

use

d a

s a

key

exc

han

ge

key.

Th

e P

INp

ad

Se

rvic

e P

rovi

der

use

s th

is k

ey

exc

han

ge

ke

y to

de

cryp

t the

en

cryp

ted

ke

y va

lue

an

d lo

adth

e d

ecr

ypte

d v

alu

e at

the

tem

por

ary

key

id a

s sp

eci

fied

in t

he

con

figu

ratio

n r

epo

sito

ry o

f th

e K

ey

Lib

rary

.

At

leas

t tw

o te

mp

ora

ry k

ey

(id)s

are

nee

ded

to

be

regi

ster

ed

in t

he

co

nfig

ura

tion

rep

osi

tory

of

the

Ke

y Li

bra

ry f

or

the

WO

SA

/XF

S M

VS

S a

pp

lica

tion

. T

he

PIN

Key

pad

Ser

vice

Pro

vid

er n

eed

s to

kno

w t

hes

e te

mp

ora

ry k

ey (

id)s

ino

rder

to

be

able

to

exe

cute

the

PIN

pa

d c

om

ma

nds

issu

ed b

y th

e W

OS

A/X

FS

MV

SS

ap

plic

atio

n.

A t

emp

ora

ry k

ey h

as t

he s

am

e t

ype

of

acce

ss a

s th

at o

f th

e k

ey

exch

an

ge k

ey, a

nd

is lo

ade

d in

th

e sa

me

keys

pac

e a

sth

at

of

the

ke

y ex

chan

ge

key.

Th

e a

bov

e d

iscu

ssio

n is

als

o a

pp

lica

ble

to

IVs.


3-140

Key

Lib

rary

Err

or C

odes

3

All

the

Key

Lib

rary

fun

ctio

ns

retu

rn a

n in

teg

er

err

or v

alu

e o

n a

n e

rro

r. T

he

fo

llow

ing

are

th

e e

rro

r co

des

tha

t a

reg

ene

rate

d b

y th

e K

ey L

ibra

ry f

unct

ion

s:

KL

_ER

R_

KE

YLI

B_

CO

NF

IGU

RAT

ION

_E

RR

OR

Th

e c

onf

igur

atio

n r

epo

sito

ry in

form

atio

n is

no

t a

vaila

ble

or

is in

corr

ect.

KL

_ER

R_

EN

CR

YP

TO

R_

VAR

IAN

T_

CO

NF

IGU

RAT

ION

_ER

RO

R

Th

e e

ncr

ypto

r va

rian

t is

no

t p

rese

nt

in t

he

con

figu

ratio

n r

epo

sito

ry.

KL

_ER

R_

INVA

LID

_E

NC

RY

PT

OR

_VA

RIA

NT

Th

e e

ncr

ypto

r va

rian

t in

the

co

nfig

ura

tion

re

posi

tory

is in

valid

.

KL

_ER

R_

TE

MP

KE

Y_

1_C

ON

FIG

UR

AT

ION

_E

RR

OR

Th

e t

emp

ora

ry k

ey 1

id s

peci

fied

in t

he c

onf

igur

atio

n r

epo

sito

ry is

no

t a

vaila

ble

or

is in

valid

.

KL

_ER

R_

TE

MP

KE

Y_

2_C

ON

FIG

UR

AT

ION

_E

RR

OR

Th

e t

emp

ora

ry k

ey 2

id s

peci

fied

in t

he c

onf

igur

atio

n r

epo

sito

ry is

no

t a

vaila

ble

or

is in

valid

.

KL

_ER

R_

TE

MP

IV_

1_

CO

NF

IGU

RAT

ION

_E

RR

OR

Th

e t

emp

ora

ry I

V 1

id s

pe

cifie

d in

th

e c

onfig

ura

tion

rep

osi

tory

is n

ot

ava

ilab

le o

r is

inva

lid.

KL

_ER

R_

TE

MP

IV_

2_

CO

NF

IGU

RAT

ION

_E

RR

OR

Th

e t

emp

ora

ry I

V 2

id s

pe

cifie

d in

th

e c

onfig

ura

tion

rep

osi

tory

is n

ot

ava

ilab

le o

r is

inva

lid.

KL

_ER

R_

RE

PO

SIT

OR

Y_

NA

ME

_C

ON

FIG

UR

AT

ION

_E

RR

OR

Th

e k

ey

rep

osi

tory

file

nam

e is

not

ava

ilab

le o

r is

inva

lid.

KL

_ER

R_

RE

PO

SIT

OR

Y_

OU

T_

OF

_S

YN

C

Th

e r

epo

sito

ry is

out

of s

ync

with

th

e e

ncr

ypto

r.

KL

_ER

R_

RE

PO

SIT

OR

Y_

INT

EG

RIT

Y_

ER

RO

R

Th

e n

um

be

r o

f en

cryp

tor

key

reco

rds

in t

he

key

rep

osi

tory

do

es

no

t m

atc

h w

ith t

he

file

size

.

KL

_ER

R_

RE

PO

SIT

OR

Y_

EM

PT

Y

Th

e k

ey

rep

osi

tory

is e

mp

ty.

KL

_ER

R_

NO

_K

EY

_C

OU

PLE

_RE

CO

RD

S


3-141

Th

e k

ey

rep

osi

tory

do

es n

ot c

on

tain

an

y ke

y co

upl

e in

form

atio

n.

KL

_ER

R_

RE

PO

SIT

OR

Y_

CO

PY

_E

RR

OR

Th

ere

is a

file

co

py

erro

r w

he

n m

aki

ng

a b

acku

p o

f th

e k

ey

rep

osi

tory

.

KL

_ER

R_

RE

PO

SIT

OR

Y_

AC

CE

SS

_E

RR

OR

Th

ere

is a

n e

rro

r in

up

da

ting

the

key

rep

osi

tory

.

KL

_ER

R_

INT

ER

NA

L_E

RR

OR

Th

ere

is a

n e

rro

r w

hen

allo

catin

g m

em

ory

or

an

y o

the

r in

tern

al e

rro

r.

KL

_ER

R_

RE

PO

SIT

OR

Y_

LOC

KE

D

Th

e k

ey

rep

osi

tory

is lo

cked

or

the

re is

an

err

or w

hen

lock

ing

th

e k

ey r

ep

osito

ry.

KL

_ER

R_

RE

PO

SIT

OR

Y_

UN

LOC

K_

ER

RO

R

Th

ere

is a

n e

rro

r w

hen

un

lock

ing

th

e ke

y re

posi

tory

.

KL

_ER

R_

INVA

LID

_K

EY

_N

AM

E

Th

e k

ey-

na

me

is o

f in

valid

len

gth

or

is N

UL

L.

KL

_ER

R_

INVA

LID

_K

EY

_C

OU

PLE

_N

AM

E

Th

e k

ey

cou

ple

na

me

is o

f in

valid

len

gth

or

is N

UL

L.

KL

_ER

R_

INVA

LID

_K

EY

_N

AM

E_

1

Th

e k

ey-

na

me

1 in

key

co

upl

e p

air

is o

f in

valid

len

gth

or

is N

UL

L.

KL

_ER

R_

INVA

LID

_K

EY

_N

AM

E_

2

Th

e k

ey-

na

me

2 in

key

co

upl

e p

air

is o

f in

valid

len

gth

or

is N

UL

L.

KL

_ER

R_

DU

PL

ICAT

E_

KE

Y_

NA

ME

Th

ere

is a

n e

ncr

ypto

r ke

y re

cord

with

th

e sa

me

key-

nam

e.

KL

_ER

R_

DU

PL

ICAT

E_

KE

Y_

CO

UP

LE

_N

AM

E

Th

e k

ey

cou

ple

na

me

alre

ad

y ex

ists

in t

he

key

rep

osi

tory

.

KL

_ER

R_

INVA

LID

_K

EY

_ID

Th

e k

ey-

id is

ou

t o

f ra

ng

e o

r is

inva

lid.


3-142

KL

_ER

R_

DU

PL

ICAT

E_

KE

Y_

ID

Th

ere

is a

n e

ncr

ypto

r ke

y re

cord

with

th

e sa

me

key-

id.

KL

_ER

R_

INVA

LID

_K

EY

SP

AC

E_

ID

Th

e k

eys

pace

-id is

out

of

ran

ge o

r is

inva

lid.

KL

_ER

R_

INVA

LID

_T

YP

EO

FAC

CE

SS

Th

e t

ype

of a

cces

s is

inva

lid fo

r th

e ke

y.

KL

_ER

R_

KE

Y_

NO

T_

FO

UN

D

Th

e e

ncr

ypto

r ke

y re

cord

is n

ot f

ou

nd

with

th

e sp

ecifi

ed k

ey-

na

me

.

KL

_ER

R_

KE

Y_

CO

UP

LE_N

OT

_F

OU

ND

Th

e k

ey

cou

ple

re

cord

is n

ot

fou

nd

with

th

e s

pe

cifie

d ke

y co

upl

e n

ame.

KL

_ER

R_

KE

Y_

NA

ME

_1

_N

OT

_F

OU

ND

Th

e e

ncr

ypto

r ke

y re

cord

is n

ot f

ou

nd

with

th

e sp

ecifi

ed k

ey-

na

me

fo

r th

e k

ey

cou

ple

.

KL

_ER

R_

KE

Y_

NA

ME

_2

_N

OT

_F

OU

ND

Th

e e

ncr

ypto

r ke

y re

cord

is n

ot f

ou

nd

with

th

e sp

ecifi

ed k

ey-

na

me

fo

r th

e k

ey

cou

ple

.

KL

_ER

R_

INVA

LID

_K

EY

_S

TAT

US

Th

e k

ey

stat

us (

wh

eth

er it

is lo

aded

in e

ncr

ypto

r o

r no

t) is

inva

lid f

or

up

dat

e.

KL

_ER

R_

KE

Y_

NA

ME

_IN

_U

SE

Th

e e

ncr

ypto

r ke

y re

cord

is in

use

(in

key

co

up

le).

Yo

u c

ann

ot

del

ete

it.

KL

_ER

R_

KE

Y_

NA

ME

_1

_IS

_IV

Th

e k

ey

nam

e 1

in k

ey

cou

ple

is IV

an

d n

ot

an

encr

yptio

n k

ey.

KL

_ER

R_

KE

Y_

NA

ME

_2

_IS

_IV

Th

e k

ey

nam

e 2

in k

ey

cou

ple

is IV

an

d n

ot

an

encr

yptio

n k

ey.

KL

_ER

R_

INVA

LID

_M

AS

TE

R_

KE

Y_

FL

AG

_F

OR

_IV

Th

e m

aste

r ke

y fla

g is

TR

UE

for

IV

wh

ich

is n

ot

allo

wed

.

WOSA/XFS - Programmer’s Reference ManualSensors and Indicators Unit



Sensors and Indicators Unit 3




Non TCM basedTCM based

siu_spx.dllsiu_wfp.dllsiu_ipc.dllsiu.dll

siu.exe


SIU The logical name of the SIU service provider

Sensors and Indicators Unit

3-144

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e

WO

SA

/XF

S_

RO

OT

\SE

RV

ICE

_P

RO

VID

ER

S\S

IU\G

EN

ER

AL

_C

ON

FIG

S\C

ON

FIG.

Par

amet

erD

escr

iptio

nP

erm

issi

ble

Val

ues

AL

AR

MS

\CO

MP

OS

ITE

\Con

fS

pec

ifies

wh

eth

er o

r no

t th

e co

mp

osi

te s

en

sor

is in

sta

lled

an

d c

onf

igur

ed

.T

RU

EFA

LSE

AL

AR

MS

\SA

FE

\Co

nf

Sp

ecifi

es w

het

her

or

not

the

safe

se

nso

r is

inst

alle

d a

nd

con

figur

ed

.T

RU

EFA

LSE

AL

AR

MS

\SIL

EN

T\C

on

fS

pec

ifies

wh

eth

er o

r no

t th

e si

len

t se

nso

r is

inst

alle

d an

d c

onf

igu

red

.T

RU

EFA

LSE

AL

AR

MS

\TA

MP

ER

\Co

nf

Sp

ecifi

es w

het

her

or

not

the

tam

per

sen

sor

is in

stal

led

and

co

nfig

ure

d.

TR

UE

FALS

E

IND

ICAT

OR

S\IN

_S

ER

VIC

E\A

vaila

ble

Sp

ecifi

es w

het

her

or

not

the

In-S

erv

ice

ind

icat

or

is in

sta

lled

.T

RU

EFA

LSE

IND

ICAT

OR

S\F

AS

CIA

_L

IGH

T\A

vaila

ble

Sp

ecifi

es w

het

her

or

not

the

Fas

cia

Lig

ht

ind

ica

tor

is in

stal

led

.T

RU

EFA

LSE

IND

ICAT

OR

S\F

AS

CIA

_L

IGH

T\L

inke

dS

pec

ifies

wh

eth

er o

r no

t th

e F

asci

a L

igh

t in

dic

ato

r is

lin

ked

with

th

e

In-S

ervi

ce in

dic

ato

r.T

RU

EFA

LSE


3-145

Cap

abili

ties

3

Cap

abili

tyV

alue

Ope

rato

r S

witc

hT

RU

E

Tam

per

Se

nso

rT

RU

E*

Sile

nt A

larm

Se

nso

rT

RU

E*

Com

po

site

Se

nso

rT

RU

E*

Pro

xim

ity S

en

sor

FAL

SE

Am

bie

nt L

igh

t S

ens

orFA

LS

E

Cab

inet

Doo

r S

en

sor

FAL

SE

Sa

fe D

oor

Se

nso

rT

RU

E*

Va

nda

l Sh

ield

Sen

sor

FAL

SE

Ope

n/C

lose

In

dica

tor

TR

UE

*

Fa

scia

Lig

ht

Indi

cato

rT

RU

E*

Aud

io I

nd

ica

tor

TR

UE

Hea

ting

Ind

ica

tor

FAL

SE

Vol

um

e C

ontr

ol

FAL

SE

UP

S C

ont

rol

FAL

SE

Car

d U

nit

Gui

da

nce

Lig

ht

TR

UE

PIN

Pad

Un

it G

uid

an

ce L

igh

tFA

LS

E

Not

es

Dis

pe

nser

Un

it G

uid

ance

Lig

ht

FAL

SE

Coi

n D

isp

ense

r U

nit

Gu

ida

nce

Lig

htFA

LS

E

Rec

eip

t P

rin

ter

Un

it G

uid

ance

Lig

ht

FAL

SE

Pa

ssb

oo

k P

rint

er

Uni

t G

uid

an

ce L

ight

TR

UE

En

velo

pe

Dep

osi

tory

Gui

da

nce

Lig

ht

TR

UE

En

velo

pe

Dis

pe

nser

Gu

idan

ce L

igh

tFA

LS

E

Che

que

Un

it G

uid

anc

e L

igh

tFA

LS

E

Bill

Acc

ept

or

Un

it G

uid

ance

Lig

ht

FAL

SE


3-146

NO

TE

: T

ho

se c

ap

abili

ties

mar

ked

with

ast

eris

ks a

re d

epe

nde

nt

on t

he

reg

istr

y se

ttin

gs.

C

onfo

rman

ce

Mat

rix -

Com

man

ds3

WO

SA

Com

man

dC

LC

omm

ents

WF

S_

INF

_SIU

_STA

TU

S2

lfw

De

vice

of

W

FS

_SIU

_D

EV

PO

WE

RO

FF,

W

FS

_S

IU_

DE

VN

OD

EV

ICE

,W

FS

_S

IU_

DE

VH

WE

RR

OR

an

d

WF

S_

SIU

_D

EV

US

ER

ER

RO

R

are

n

eve

rre

turn

ed

.

lfw

Do

ors

of W

FS

_S

IU_

CLO

SE

D a

nd

WF

S_

SIU

_LO

CK

ED

are

nev

er

rep

ort

ed

.

lT

he

co

nd

ition

WF

S_

SIU

_N

OT

_AVA

ILA

BLE

in

dic

ates

th

at

the

po

rt w

ho

se s

tatu

sis

req

ues

ted

is n

ot

sup

port

ed o

r do

es

no

t ex

ist.

WF

S_

INF

_SIU

_CA

PA

BIL

ITIE

S2

No

ne

WF

S_

CM

D_

SIU

_E

NA

BLE

_E

VE

NT

S2

No

ne

WF

S_

CM

D_

SIU

_S

ET

_P

OR

TS

1T

he

fo

llow

ing

sen

sors

/ind

icat

ors

are

no

t su

pp

ort

ed:

Cab

ine

t D

oors

, S

afe

D

oor

s,

Van

dal

S

hie

ld,

Hea

ting

de

vice

, Vo

lum

e C

on

tro

l an

dG

uid

anc

e L

igh

ts o

n t

he

PIN

pa

d u

nit,

No

tes

Dis

pen

ser

un

it, C

oin

Dis

pe

nse

r u

nit,

Rec

eip

t P

rinte

r u

nit,

Ch

equ

e un

it, B

ill A

cce

pto

r u

nit

an

d E

nve

lop

e D

isp

en

ser

unit.

WF

S_

CM

D_

SIU

_S

ET

_D

OO

R0

No

ne

WF

S_

CM

D_

SIU

_S

ET

_IN

DIC

ATO

R1

Th

e H

eat

ing

In

dic

ato

r is

no

t su

pp

orte

d.

WF

S_

CM

D-S

IU_

SE

T_

AU

XIL

LAR

Y0

No

ne

WF

S_

CM

D_

SIU

_S

ET

_G

UID

LIG

HT

1T

he

fo

llow

ing

ind

icat

ors

are

no

t su

pp

orte

d:

PIN

pa

d u

nit,

No

tes

Dis

pen

ser

un

it, C

oin

Dis

pen

ser

un

it, R

ecei

pt

Pri

nter

un

it, C

he

que

un

it, B

ill A

cce

pto

r u

nit

and

En

velo

pe

Dis

pen

ser

un

it.


3-147

Con

form

ance

Mat

rix -

Err

ors

3

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents

WF

S_

CM

D_

SIU

_E

NA

BLE

_E

VE

NT

SW

FS

_ER

R_

SIU

_IN

VALI

D_

PO

RT

1R

etu

rned

wh

en t

he

req

ues

ted

po

rt:

lD

oes

not

exi

st a

nd

is n

ot

supp

ort

ed

by t

he

se

rvic

e p

rovi

der

.

lD

oes

not e

xist

bu

t is

sup

po

rte

d b

y th

ese

rvic

e p

rovi

der

.

lE

xist

s b

ut i

s no

t su

pp

ort

ed

by

the

serv

ice

pro

vid

er.

WF

S_E

RR

_S

IU_

SY

NTA

X2

Non

e

WF

S_

CM

D_

SIU

_S

ET

_P

OR

TS

WF

S_E

RR

_S

IU_

INVA

LID

_P

OR

T1

Re

turn

ed w

hen

th

e re

qu

este

d p

ort

:

lD

oes

not

exi

st a

nd

is n

ot

supp

ort

ed

by t

he

se

rvic

e p

rovi

der

.

lD

oes

not e

xist

bu

t is

sup

po

rte

d b

y th

ese

rvic

e p

rovi

der

.

lE

xist

s b

ut i

s no

t su

pp

ort

ed

by

the

serv

ice

pro

vid

er.

WF

S_E

RR

_S

IU_

SY

NTA

X2

Non

e

WF

S_E

RR

_S

IU_

PO

RT

_E

RR

OR

3R

etu

rned

w

hen

an

at

tem

pt

to

set

the

b

eep

seq

uen

ce fa

ils.


3-148

WF

S_

CM

D_

SIU

_S

ET

_IN

DIC

ATO

RW

FS

_ER

R_

SIU

_IN

VALI

D_

PO

RT

1R

etu

rned

wh

en t

he

req

ues

ted

po

rt:

lD

oes

not

exi

st a

nd

is n

ot

supp

ort

ed

by t

he

se

rvic

e p

rovi

der

.

lD

oes

not e

xist

bu

t is

sup

po

rte

d b

y th

ese

rvic

e p

rovi

der

.

lE

xist

s b

ut i

s no

t su

pp

ort

ed

by

the

serv

ice

pro

vid

er.

WF

S_E

RR

_S

IU_

SY

NTA

X2

Non

e

WF

S_E

RR

_S

IU_

PO

RT

_E

RR

OR

1R

etu

rned

w

hen

an

at

tem

pt

to

set

the

b

eep

seq

uen

ce fa

ils.

WF

S_

CM

D_

SIU

_S

ET

_G

UID

LIG

HT

WF

S_E

RR

_S

IU_

INVA

LID

_P

OR

T1

Re

turn

ed w

hen

th

e re

qu

este

d p

ort

:

lD

oes

not

exi

st a

nd

is n

ot

supp

ort

ed

by t

he

se

rvic

e p

rovi

der

.

lE

xist

s b

ut i

s no

t su

pp

ort

ed

by

the

serv

ice

pro

vid

er.

WF

S_E

RR

_S

IU_

SY

NTA

X2

Non

e

WO

SA

Com

man

dE

rror

Cod

esC

LC

omm

ents


3-149

Con

form

ance

Mat

rix -

Eve

nts

3 3

App

licat

ion

Gui

delin

es3

1T

he

WF

S_

CM

D_

SIU

_E

NA

BL

E_

EV

EN

TS

co

mm

an

d e

nab

les

the

app

licat

ion

to

regi

ster

fo

r ch

ang

e-o

f-st

ate

eve

nts

fro

m v

ario

us

sens

ors

and

ind

ica

tors

by

sett

ing

th

e c

orr

esp

ond

ing

fla

gs

in t

he

inpu

t. I

f th

e fla

g f

or

eve

n a

sin

gle

sen

sor/

ind

icat

or

tha

t ca

n b

e s

up

port

ed i

s se

t in

th

e i

np

ut,

the

co

mm

and

is

cons

ider

ed

as

valid

. T

he

com

ma

nd is

co

nsi

der

ed a

s u

nsui

tab

le f

or

exe

cutio

n,

on

ly if

no

ne

of

the

se

t se

nsor

s/in

dic

ato

rs is

su

pp

orte

d.

Th

e s

am

e is

tru

e fo

r th

e W

FS

_C

MD

_S

IU_

SE

T_

PO

RT

S c

om

ma

nd

.

2W

he

n th

e W

FS

_C

MD

_S

IU_

SE

T_

GU

IDLI

GH

T a

nd

WF

S_

CM

D_S

IU_S

ET

_P

OR

TS

co

mm

and

s a

re i

ssu

ed

tose

t th

e b

linki

ng s

peed

of

the

gu

ida

nce

lig

hts,

th

ey

affe

ct A

LL t

he

gui

dan

ce l

igh

ts t

hat

are

on.

Th

is c

om

man

dca

nn

ot s

et t

he

spe

ed o

f an

ind

ivid

ual g

uid

ance

lig

ht.

3T

he

WF

S_

CM

D_S

IU_

SE

T_

DO

OR

an

d W

FS

_C

MD

_S

IU_

SE

T_

AU

XIL

IAR

Y c

om

man

ds

are

un

sup

po

rte

d.

WO

SA

Eve

ntC

LC

omm

ents

WF

S_

SR

VE

_SIU

_PO

RT

_S

TAT

US

2G

ener

ate

d o

nly

for

the

Car

d U

nit,

Pas

sbo

ok

Pri

nte

r an

d D

epo

sito

ryg

uid

ance

lig

hts,

th

e S

afe

Se

nso

r, C

om

po

site

Sen

sor,

Tam

per

Se

nsor

,S

ilen

t A

larm

S

en

sor,

A

udio

In

dic

ato

r,

Fa

scia

Li

ght

Indi

cato

r,O

pen

/Clo

se In

dic

ato

r a

nd

the

Op

era

tor

(Mo

de

) S

witc

h.

WF

S_

EX

EE

_S

IU_

PO

RT

_ER

RO

R2

lG

en

era

ted

by

erro

rs o

n t

he

follo

win

g p

ort

s:

Gu

ida

nce

Lig

hts

(C

ard

Un

it, D

epo

sito

ry,

Pa

ssb

oo

k P

rint

er)

Au

dio

Ind

ica

tor

Op

era

tor

Sw

itch

Fa

scia

Lig

ht

Op

en/C

lose

Ind

icat

or

lN

eve

r ge

ner

ate

d b

y th

e W

FS

_C

MD

_S

IU_

EN

AB

LE_

EV

EN

TS

co

mm

an

d.

Identity Card Unit

3-150

Iden

tity

Ca

rd U

nit

3

Ser

vice

Pro

vide

r C

ompo

nent

s3

Def

ault

Logi

cal S

ervi

ce N

ames

3

Dev

ice

DLL

Nam

eS

P E

xecu

tabl

e

IDC

idc_

spx.

dll

idc_

wfp

.dll

idc_

ipc.

dll

idc.

dll

idc.

exe

Logi

cal N

ame

Des

crip

tion

IDC

ard

Un

it1T

he

log

ica

l nam

e o

f th

e ID

C s

erv

ice

pro

vid

er.

Identity Card Unit

3-151

Con

figur

able

Par

amet

ers

3

Th

e f

ollo

win

g c

on

figu

rab

le p

ara

met

ers

are

stor

ed

in t

he

reg

istr

y u

nde

r th

e W

OS

A/X

FS

RO

OT

\SE

RV

ICE

_P

RO

VID

ER

S\ID

C k

ey.

Par

amet

er

Des

crip

tion

Per

mis

sibl

e V

alue

s

GE

NE

RA

L_C

ON

FIG

S\V

aria

nt

Varia

nt

of t

he

dev

ice

. C

an b

e o

ne

of

the

fo

llow

ing

:

lM

CR

W -

M

oto

rise

d M

agn

etic

Ca

rd R

eade

r/W

rite

r.

lS

CR

W -

M

oto

rise

d M

agn

etic

Ca

rd R

eade

r/W

rite

r

with

a S

ma

rt C

ard

Re

ade

r/W

riter

Uni

t

att

ach

ed.

lD

IP

-

DIP

typ

e M

agn

etic

Ca

rd R

eade

r.

lS

WIP

E

-

SW

IPE

typ

e M

ag

net

ic

Ca

rd R

eade

r.

GE

NE

RA

L_C

ON

FIG

S\M

axR

eta

ine

dCa

rds

Max

imu

m

num

ber

o

f ca

rds

tha

t ca

n

be

acco

mm

od

ated

b

y th

e

Ca

ptu

re

bin

.R

elev

ant

on

ly t

o M

CR

W a

nd

SC

RW

.

De

vice

d

epe

nd

ent

par

amet

er.

Def

aul

ts

to

10

if no

tsp

eci

fied

in t

he

reg

istr

y.

GE

NE

RA

L_C

ON

FIG

S\H

igh

Re

tain

edC

ard

sH

igh

ca

ptu

re

coun

t th

resh

old

. R

elev

ant

on

ly t

o M

CR

W a

nd S

CR

W.

lA

nu

mb

er l

ess

than

or

equ

al t

o M

axR

eta

ined

Ca

rds.

De

fau

lts t

o 7

if n

ot

spe

cifie

d in

th

e re

gis

try.

Identity Card Unit

3-152

GE

NE

RA

L_C

ON

FIG

S\P

ow

erO

nF

lag

Det

erm

ine

s th

e

actio

n

to

be

pe

rfor

med

wh

en a

ca

rd i

s d

etec

ted

in

th

e de

vice

at

po

wer

up

.

Can

be

set

to

one

of

the

follo

win

g v

alu

es:

lN

OA

CT

ION

: If

P

ow

er

On

op

tion

s no

tsu

pp

ort

ed.

T

his

will

be

th

e ca

se

for

no

n-

Mo

tori

sed

uni

ts.

lE

JEC

T:

If C

ard

pre

sen

t, i

t w

ill b

e e

ject

ed o

nP

ow

er

On

.

lR

ETA

IN:

If C

ard

pre

sen

t, it

will

be

ca

ptu

red

on

Po

we

r O

n.

lE

JEC

TT

HE

NR

ETA

IN:

I

f C

ard

pre

sen

t, i

tw

ill b

e e

ject

ed o

n

Po

wer

On

. If t

he C

ard

is n

ot

take

n

with

in a

sp

eci

fied

tim

e, it

is c

apt

ure

d.

lR

EA

DP

OS

ITIO

N:

If th

e C

ard

is p

rese

nt,

it w

illb

e m

ove

d o

n P

ow

er O

n s

o th

at i

t is

in a

po

sitio

nto

be

read

.

If n

ot

spec

ified

in t

he

reg

istr

y, d

efa

ults

to

NO

AC

TIO

N.

GE

NE

RA

L_C

ON

FIG

S\P

ow

erO

ffFla

gD

ete

rmin

es

the

actio

n to

be

pe

rfo

rme

d

wh

en a

car

d is

de

tect

ed

in t

he

dev

ice

at

po

wer

do

wn.

Can

be

set

to

one

of t

he

follo

win

g:

lN

OA

CT

ION

: If

P

ow

er

Off

opt

ion

s ar

e no

tsu

pp

ort

ed,

thi

s w

ill b

e t

he

case

fo

r th

e n

on

-m

oto

rise

d u

nits

.

lE

JEC

T:

If C

ard

pre

sen

t, i

t w

ill b

e e

ject

ed o

nP

ow

er

Off.

lR

ETA

IN:

If C

ard

pre

sen

t, it

will

be

ca

ptu

red

on

Po

we

r O

ff.

lE

JEC

TT

HE

NR

ETA

IN:

If C

ard

pre

sen

t, i

t w

illb

e e

ject

ed o

n P

ow

er

Off.

If t

he c

ard

is n

ot

take

nw

ithin

a s

pec

ified

tim

e, i

t is

cap

ture

d.

lR

EA

DP

OS

ITIO

N:

If C

ard

pre

sen

t, i

t w

ill b

em

ove

d o

n P

ow

er

Off

so th

at it

is in

a p

osi

tion

tob

e re

ad.

If n

ot

spec

ified

in t

he

reg

istr

y, d

efa

ults

to

NO

AC

TIO

N.

Par

amet

er

Des

crip

tion

Per

mis

sibl

e V

alue

s

Identity Card Unit

3-153

3

Cap

abili

ties

3

GE

NE

RA

L_C

ON

FIG

S\R

ead

Tra

cks

Tra

cks

the

de

vice

ca

n re

ad

lA

com

bin

atio

n o

f st

ring

s T

RA

CK

1,

TR

AC

K2

&T

RA

CK

3.

Th

e se

par

ato

r ca

n b

e ‘+

’, ‘|’

or

the

spa

cech

ara

cte

r.

lIf

n

o tr

ack

can

be

re

ad,

th

is

sho

uld

b

e se

t to

NO

_T

RA

CK

.

lIf

th

is v

alue

is n

ot

spec

ified

in t

he

reg

istr

y, a

de

fau

lto

f T

RA

CK

2 is

ass

umed

.

GE

NE

RA

L_C

ON

FIG

S\W

riteT

rack

sT

rack

s th

e d

evi

ce c

an

writ

el

A c

omb

ina

tion

of

strin

gs

TR

AC

K1

, T

RA

CK

2 &

TR

AC

K3

. T

he

sep

ara

tor

can

be

‘+’,

‘|’ o

r th

e sp

ace

cha

ract

er.

lIf

no

tra

ck c

an b

e w

ritte

n, a

s in

th

e ca

se o

f th

e D

IP&

S

WIP

E

vari

ants

, th

is

sho

uld

b

e

set

toN

O_

TR

AC

K.

lIf

th

is v

alue

is n

ot

spec

ified

in t

he

reg

istr

y, a

de

fau

lto

f N

O_

TR

AC

K is

ass

um

ed.

GE

NE

RA

L_C

ON

FIG

S\S

ecu

rityT

ype

Se

curit

y m

od

ule

typ

eS

ho

uld

be

se

t to

S

EC

_N

OT

_SU

PP

a

s th

e cu

rren

tim

ple

me

nta

tion

do

es n

ot s

upp

ort

th

e s

ecu

rity

mod

ule

.

GE

NE

RA

L_C

ON

FIG

S\S

usp

end

Tim

eou

tT

ime

in s

eco

nds

for

wh

ich

the

de

vice

sh

ou

ld b

e s

usp

end

ed

wh

en c

ust

om

er

tam

pe

ring

is s

uspe

cted

.

If n

ot

spec

ified

, a

def

aul

t o

f 2

00

se

con

ds

is a

ssu

med

.

GE

NE

RA

L_C

ON

FIG

S\F

orm

sDir

Dire

cto

ry u

nd

er w

hic

h ID

C fo

rm d

efin

itio

n

files

are

sto

red

.A

ny

valid

dire

cto

ry n

am

e.

GE

NE

RA

L_C

ON

FIG

S\C

hip

Pro

toco

lS

up

por

ted

Ch

ip p

roto

cols

lP

RO

T_

NO

T_

SU

PP

if

the

d

evic

e

can

not

han

dle

Ch

ip C

ard

s. (

Th

is w

ill b

e t

he

case

if

vari

ant

is n

ot

SC

RW

).

lA

sp

ace

o

r ‘+

’ o

r ‘|’

se

para

ted

co

mb

inat

ion

o

fst

ring

s of

the

fo

rm T

<X

X>

wh

ere

XX

ran

ges

fro

m0

0 t

o 1

5. (

e.g

. "T

00

" o

r "T

00+

T0

1+

T0

2")

.

If n

ot s

pec

ified

, a d

efa

ult

valu

e o

f PR

OT

_NO

T_

SU

PP

is

assu

me

d

Par

amet

er

Des

crip

tion

Per

mis

sibl

e V

alue

s

Identity Card Unit

3-154

Cap

abili

tyV

alu

e (M

CR

W)

Val

ue

(SC

RW

)V

alue

(D

IP/S

WIP

E)

Tra

ck R

ead

Cap

ab

ility

TR

UE

TR

UE

TR

UE

Tra

ck W

rite

Cap

abili

tyH

/W D

ep

end

ant

H/W

De

pen

dan

tFA

LS

E

Ch

ip I/

OFA

LSE

TR

UE

FAL

SE

Po

we

r O

n o

ptio

ns

H/W

De

pen

dan

tH

/W D

ep

end

ant

FAL

SE

Po

we

r O

ff o

ptio

ns

H/W

De

pen

dan

tH

/W D

ep

end

ant

FAL

SE

Se

curi

ty M

od

ule

FALS

EFA

LS

EFA

LS

E

Identity Card Unit

3-155

Con

form

ance

Mat

rix -

Com

man

ds3

WO

SA

Com

man

dC

LC

omm

ents

WF

S_

INF

_ID

C_

STA

TU

S1

lfw

De

vice

of

WF

S_I

DC

_D

EV

PO

WE

RO

FF

an

d W

FS

_ID

C_D

EV

NO

DE

VIC

E a

rene

ver

retu

rned

.

lfw

Secu

rity

is a

lway

s W

FS

_ID

C_

SE

CN

OT

SU

PP

ev

en

if a

se

curi

ty

mo

dul

e is

pre

sent

.

lIf

the

dev

ice

ha

s b

een

sus

pen

ded

an

d th

is c

om

man

d i

s is

sue

d,

the

retu

rne

d s

tatu

sw

ill b

e th

at

whi

ch e

xist

ed

at

the

sta

rt o

f th

e su

spen

d o

per

atio

n an

d w

ill a

lso

be

the

case

if t

he

card

is s

tag

ed

in t

he

sm

art

card

un

it.

WF

S_

INF

_ID

C_

CA

PA

BIL

ITIE

S2

lfw

Type

of W

FS

_ID

C_T

YP

E_

CO

NTA

CT

LES

S is

ne

ver

retu

rned

.

lfw

SecT

ype is

alw

ays

WF

S_

IDC

_SE

CN

OT

SU

PP

eve

n if

a s

ecu

rity

mo

dule

is

pre

sent

.

WF

S_

INF

_ID

C_

FO

RM

_LI

ST

2N

one

WF

S_

INF

_ID

C_

QU

ER

Y_

FO

RM

2N

one

WF

S_

CM

D_

IDC

_R

EA

D_

TR

AC

K2

lT

he

com

man

d c

an

resu

lt in

th

e ca

rd b

ein

g c

ap

ture

d if

a ca

rd ja

m o

ccu

rs o

r th

e c

ard

bein

g e

ject

ed

if t

he

firm

war

e s

usp

ect

s cu

sto

mer

ta

mp

erin

g.

lW

FS

_E

RR

_H

AR

DW

AR

E_

ER

RO

R m

ay

be r

etu

rned

if

the

ca

rd i

s st

aged

in

the

Sm

art

Ca

rd s

ect

ion

of

an

SC

RW

wh

en

the

co

mm

an

d is

giv

en

.

lW

FS

_E

RR

_D

EV

_NO

T_

RE

AD

Y m

ay

be r

etur

ne

d if

the

de

vice

en

ters

a s

tate

wh

ich

cou

ld c

au

se a

sys

tem

esc

ap

e o

r w

hen

th

e S

P is

in a

su

spe

nde

d s

tate

. If

su

chan

err

or

is r

etu

rned

, a

nd

if

the

SP

is

no

t in

a s

usp

en

ded

sta

te,

the

nex

t co

mm

and

sen

t sh

ou

ld b

e a

n E

JEC

T_

CA

RD

or

a R

ETA

IN_C

AR

D.

lS

hou

ld a

n e

rror

occ

ur

be

caus

e th

e d

ata

on

th

e t

rack

do

es

no

t m

atch

t

he

fo

rmde

finiti

on

, th

e o

utp

ut

will

co

nta

in a

s m

uch

fie

ld d

ata

as

cou

ld b

e r

ead

.

WF

S_

CM

D_

IDC

_W

RIT

E_T

RA

CK

2l

Th

e co

mm

and

ca

n re

sult

in t

he

card

bei

ng

ca

ptu

red

if a

card

jam

occ

urs

or

the

car

dbe

ing

eje

cte

d if

th

e fi

rmw

are

su

spe

cts

cust

om

er t

am

per

ing

.

lW

FS

_E

RR

_H

AR

DW

AR

E_

ER

RO

R m

ay

be r

etu

rned

if

the

ca

rd i

s st

aged

in

the

Sm

art

Ca

rd s

ect

ion

of

an

SC

RW

wh

en

the

co

mm

an

d is

giv

en

.

lW

FS

_E

RR

_D

EV

_NO

T_

RE

AD

Y m

ay

be r

etur

ne

d if

the

de

vice

en

ters

a s

tate

wh

ich

cou

ld c

au

se a

sys

tem

esc

ap

e o

r w

hen

th

e S

P is

in a

su

spe

nde

d s

tate

. If

su

chan

err

or

is r

etu

rned

, a

nd

if

the

SP

is

no

t in

a s

usp

en

ded

sta

te,

the

nex

t co

mm

and

sen

t sh

ou

ld b

e a

n E

JEC

T_

CA

RD

or

a R

ETA

IN_C

AR

D.

Identity Card Unit

3-156

WF

S_

CM

D_

IDC

_E

JEC

T_

CA

RD

2l

WF

S_

ER

R_

HA

RD

WA

RE

_E

RR

OR

ma

y be

re

turn

ed i

f th

e c

ard

is

stag

ed i

n t

heS

ma

rt C

ard

se

ctio

n o

f a

n S

CR

W w

he

n th

e c

om

ma

nd

is g

ive

n.

lIn

th

e e

ven

t a

card

is ja

mm

ed

in t

he

dev

ice

wh

en

this

co

mm

an

d is

issu

ed,

the

car

dis

ca

ptu

red

by

the

SP

, th

e C

ard

s R

eta

ine

d co

un

t is

incr

emen

ted

, an

d a

n e

rro

r co

deof

WF

S_

ER

R_

IDC

_M

ED

IAR

ETA

INE

D is

ret

urn

ed.

No

te h

owe

ver,

th

at n

o e

ven

tsar

e g

ene

rate

d i

f th

is c

ause

s th

e ca

rds

reta

ine

d co

un

t to

cro

ss a

th

resh

old

as

the

WO

SA

/XF

S s

pec

ifica

tion

doe

s no

t d

efin

e an

y e

ven

ts fo

r th

is c

om

man

d.

WF

S_

CM

D_

IDC

_R

ETA

IN_

CA

RD

1l

WF

S_

ER

R_

HA

RD

WA

RE

_E

RR

OR

may

be

re

turn

ed w

hen

a c

ard

is ja

mm

ed in

sid

e th

e c

ard

rea

der

wh

ich

sen

ds

the

dev

ice

into

a F

ATA

L st

ate

. T

his

con

diti

on

mu

st b

e cl

eare

d u

sin

g t

he U

lyss

es

Sys

tem

Ap

plic

atio

n.

lW

FS

_E

RR

_ID

C_M

ED

IAJA

MM

ED

is r

etu

rned

whe

n t

he

SP

ent

ers

a s

usp

end

ed

sta

te a

fter

it de

tect

s p

ossi

ble

cu

sto

mer

ta

mp

erin

g.

WF

S_

CM

D_

IDC

_R

ES

ET

_C

OU

NT

2N

one

WF

S_

CM

D_

IDC

_S

ET

_K

EY

0S

ecu

rity

mo

du

le is

no

t su

pp

ort

ed.

WO

SA

Com

man

dC

LC

omm

ents

Identity Card Unit

3-157

WF

S_

CM

D_

IDC

_R

EA

D_

RA

W_

DAT

A2

lT

he

com

man

d c

an

resu

lt in

th

e ca

rd b

ein

g c

ap

ture

d if

a ca

rd ja

m o

ccu

rs o

r th

e c

ard

bein

g e

ject

ed

if t

he

firm

war

e s

usp

ect

s cu

sto

mer

ta

mp

erin

g.

lW

FS

_E

RR

_H

AR

DW

AR

E_

ER

RO

R m

ay

be r

etu

rned

if

the

ca

rd i

s st

aged

in

the

Sm

art

Ca

rd s

ect

ion

of

an

SC

RW

wh

en

the

co

mm

an

d is

giv

en

.

lW

FS

_E

RR

_D

EV

_NO

T_

RE

AD

Y m

ay

be r

etur

ne

d if

the

de

vice

en

ters

a s

tate

wh

ich

cou

ld c

au

se a

sys

tem

esc

ap

e o

r w

hen

th

e S

P is

in a

su

spe

nde

d s

tate

. If

su

chan

err

or

is r

etu

rned

, a

nd

if

the

SP

is

no

t in

a s

usp

en

ded

sta

te,

the

nex

t co

mm

and

sen

t sh

ou

ld b

e a

n E

JEC

T_

CA

RD

or

a R

ETA

IN_C

AR

D.

WF

S_

CM

D_

IDC

_W

RIT

E_R

AW

_DA

TA

2l

Th

e co

mm

and

ca

n re

sult

in t

he

card

bei

ng

ca

ptu

red

if a

card

jam

occ

urs

or

the

car

dbe

ing

eje

cte

d if

th

e fi

rmw

are

su

spe

cts

cust

om

er t

am

per

ing

.

lW

FS

_E

RR

_H

AR

DW

AR

E_

ER

RO

R m

ay

be r

etu

rned

if

the

ca

rd i

s st

aged

in

the

Sm

art

Ca

rd s

ect

ion

of

an

SC

RW

wh

en

the

co

mm

an

d is

giv

en

.

lW

FS

_E

RR

_D

EV

_NO

T_

RE

AD

Y m

ay

be r

etur

ne

d if

the

de

vice

en

ters

a s

tate

wh

ich

cou

ld c

au

se a

sys

tem

esc

ap

e o

r w

hen

th

e S

P is

in a

su

spe

nde

d s

tate

. If

su

chan

err

or

is r

etu

rned

, a

nd

if

the

SP

is

no

t in

a s

usp

en

ded

sta

te,

the

nex

t co

mm

and

sen

t sh

ou

ld b

e a

n E

JEC

T_

CA

RD

or

a R

ETA

IN_C

AR

D.

WF

S_

CM

D_

IDC

_C

HIP

_IO

2l

A c

ard

mus

t be

pre

sen

t in

th

e u

nit

if th

is c

om

man

d is

to

suc

ceed

.

lA

RE

AD

_RA

W_

DA

TA c

om

man

d s

ho

uld

h

ave

bee

n i

ssu

ed

in

som

e p

revi

ou

sco

mm

and

to

get

the

AT

R o

f th

e c

hip

. If

th

e A

TR

is

not

obt

ain

ed c

orre

ctly

, th

isco

mm

and

will

fail.

lC

om

mu

nic

atio

n w

ith th

e c

hip

take

s p

lace

tran

spa

ren

tly. A

ll th

e d

ata

pas

sed

as

inpu

tfo

r th

e C

HIP

_IO

co

mm

and

is s

en

t to

th

e c

hip

. A

ll th

e d

ata

ret

urn

ed

by

the

chip

isre

turn

ed

as o

utp

ut

dat

a. N

o a

ttem

pt

is m

ad

e to

inte

rpre

t th

is d

ata

.

WO

SA

Com

man

dC

LC

omm

ents

WOSA/XFS - Programmer’s Reference ManualIdentity Card Unit



Conformance Matrix - Errors 3

WOSA Command Error Codes CL Comments

WFS_INF_IDC_QUERY_FORM WFS_ERR_IDC_FORMNOTFOUND 2 None

WFS_ERR_IDC_FORMINVALID 2 None

WFS_CMD_IDC_READ_TRACK WFS_ERR_IDC_MEDIAJAM 2 None

WFS_ERR_IDC_SHUTTERFAIL 2 None

WFS_ERR_IDC_INVALIDDATA 2 None

WFS_ERR_IDC_NOMEDIA 1 Returned under the following conditions:

l On timeout.

l If the command hascaused a card to beaccepted into theunit. But, if when anattempt is made toread it, the card is notpresent.

l A card is expected tobe present in the unitbut is not detected atthe start of thiscommand. The nextcall to the commandwill however waitfor a card to beinserted.

WFS_ERR_IDC_INVALIDMEDIA 0 Never returned

WFS_ERR_IDC_FORMNOTFOUND 2 None

WFS_ERR_IDC_FORMINVALID 2 Returned when the dataon the track does notconform to the formdefinition. Here, thebenefit of doubt shouldbe given to the form. (Forexample, a non-existentstart/end delimiter).

WFS_ERR_IDC_SECURITYFAIL 0 Never returned.

WFS_CMD_IDC_WRITE_TRACK WFS_ERR_IDC_MEDIAJAM 2 None





WFS_ERR_IDC_INVALIDDATA 2 Returned under thefollowing conditions:

l A track could not beread as written to, orif the existing data onthe track is invalid.

l Data on a card doesnot conform to theform definition.

WFS_ERR_IDC_NOMEDIA 2 Returned under thefollowing conditions:

l The command hascaused a card to beaccepted into theunit. But, whileattempting toread/write to it, thecard is not present.

l A card is expected tobe present in the unitbut is not detected atthe start of thiscommand. The nextcall to the commandwill wait for a card tobe inserted.

WFS_ERR_IDC_INVALIDMEDIA 2 Returned when the trackexists but does notcontain valid data when aread is performed toverify the written data.

WFS_ERR_IDC_DATASYNTAX 2 None

WFS_ERR_IDC_FORMNOTFOUND 2 None

WFS_ERR_IDC_FORMINVALID 2 Returned under the following conditions:

l The specified form was found to be invalid at startup.

l The form specified is meant only for reading

l Data specified in the input conflicts with the form definition.





WFS_CMD_IDC_EJECT_CARD WFS_ERR_IDC_MEDIAJAM 2 None

WFS_ERR_IDC_SHUTTERFAIL 0 Never returned

WFS_ERR_IDC_MEDIARETAINED 2 None

WFS_ERR_IDC_NOMEDIA 2 None

WFS_CMD_IDC_RETAIN_CARD WFS_ERR_IDC_MEDIAJAM 1 This code is returnedwhen a card is jammed inthe throat of the cardreader which indicatespossible customertampering. This causesthe SP to go into asuspended state forSuspendTimeout secondsspecified in the registry.


WFS_ERR_IDC_RETAINBINFULL 0 This code is neverreturned. Instead, whenthe hardware senses thatthe retain bin is full,WFSExecute returns anderror code ofWFS_ERR_HARDWAREERROR

WFS_ERR_HARDWARE_ERROR 1 This code is returnedwhen a card is jammedinside the card readerwhich causes the deviceto go into a fatal state.This condition must becleared via the UlyssesSystem Application.

WFS_ERR_DEV_NOT_READY 1 This code is returned when the SP is in a suspended state.

WFS_CMD_IDC_RESET_COUNT WFS_ERR_INTERNAL_ERROR 2 An internal error occurred while processing this command.

WFS_CMD_IDC_SET_KEY None 2 None

WFS_CMD_IDC_READ_RAW_DATA WFS_ERR_IDC_MEDIAJAM 2 None






WFS_ERR_IDC_NOMEDIA 2 Returned under thefollowing conditions:

l The command hascaused a card to beaccepted into theunit, but when anattempt is made toread it, the card is notpresent.

l A card is expected tobe present in the unitbut is not detected atthe start of thiscommand. The nextcall to the commandhowever, will waitfor a card to beinserted.

WFS_CMD_IDC_READ_RAW_DATA WFS_ERR_IDC_INVALIDMEDIA 2 In the case of a SMART card, this error is returned under the following conditions:

l The Smart Card command format is invalid

l The SP was unable to communicate with the Smart Card.

l The Smart Card is powered off.

l An invalid card is inserted.

WFS_CMD_IDC_WRITE_RAW_DATA WFS_ERR_IDC_MEDIAJAM 2 None






WFS_ERR_IDC_NOMEDIA 2 Returnedunder thefollowingconditions:

l When the commandhas caused a card tobe accepted into theunit, but when anattempt is made toread it, the card is notpresent.

l When a card isexpected to bepresent in the unit butis not detected at thestart of thiscommand. The nextcall to the commandhowever, will waitfor a card to beinserted.

WFS_ERR_IDC_INVALIDMEDIA 1 Returned under thefollowing conditions:

l The specified track is not supported.

l The supplied data was found to be invalid during validation.

l An error occurred while writing to the card

l An error occurred while verifying the data written to the card.

WFS_CMD_IDC_CHIP_IO WFS_ERR_IDC_MEDIAJAM 0 Never returned. If a jam occurs in a smart card related operation, it is treated as a hardware error.


WFS_ERR_IDC_INVALIDMEDIA 2 Returned when the chip has been powered-off by the firmware for some reason.





Conformance Matrix - Events 3

WFS_ERR_IDC_INVALIDDATA 2 None

WFS_ERR_IDC_PROTOCOLNOTSUPP 2 None

WFS_ERR_IDC_ATRNOTOBTAINED 2 None

WOSA Event CL Comments

WFS_EXEE_IDC_INVALIDTRACKDATA 2 None

WFS_EXEE_IDC_MEDIAINSERTED 2 Generated after a card has been properly staged.

WFS_SRVE_IDC_MEDIAREMOVED 2 Generated when a card is taken by a user followinga successful card eject. Also generated byRead/Write commands under the followingconditions:

l A card is expected to be in unit at the start ofthe command but is not. (This can happen ifthe card is reeled out after the previouscommand).

l An invalid card has been ejected by thefirmware and the user has taken it.

WFS_EXEE_IDC_INVALIDMEDIA 2 None

WFS_SRVE_IDC_CARDACTION 0 Not supported

WFS_USRE_IDC_RETAINBINTHRESHOLD 2 l WFS_IDC_RETAINBINOK is never posted.

l An event with event data ofWFS_IDC_RETAINBINHIGH is postedwhen the number of captured cards exceedsthe value of HighRetainedCards specified inthe registry. This event is posted each time acard is captured, until the number of capturedcards reaches MaxRetainedCards, at whichtime the SP posts an event with event data ofWFS_IDC_RETAINBINFULL. Beyond thispoint, the SP will continue to capture cardsand post events until the hardware detects thatthe retain bin is full.





IDC Forms 3

The WOSA/XFS IDC class functionality supports the "forms" model. However,non-forms based functionality is also provided for by the WOSA/XFSspecification.

In the implementation of forms, both the form and the field definition are stored infiles called "Form Definition Files", and the name of the directory containing thesefiles is stored in the Windows NT Registry. Each file may contain one or moreform definitions, and the registry may contain any number of Form Definition Filepaths, limited only by the system resources.

Forms Validation 3

Form validation is performed in two stages; at start-up and at runtime.


When the SP is started up, all form definition files are opened and validated. Thesyntax errors are checked if they are categorized under the following:

l Invalid keywords

l Duplication of keywords

l Unexpected placement of keywords

l Invalid data associated with a keyword

l Invalid comments

The form definitions are converted to an 'in-core' representation called the 'FormsDatabase'. Errors found during this initial validation are logged in the form errorlog file whose location is specified in the registry. If an error is detected in a formduring this validation, an entry will be made in the 'Forms Database', but the formwill be marked as invalid.

Runtime validation:Runtime validation is performed when the QUERY_FORM, READ_TRACK andWRITE_TRACK commands are given. The type of errors detected at this stageare:

l User defined fields used but not defined.

l User defined fields not found on track.

l User defined fields out of bounds for track.

l Field requested to be read/written has not been defined in form.

Errors found during this validation process may be logged either in the form errorlog file or the trace file whose locations are specified in the registry.




Interpretation of Reserved Keywords: 3

The following table describes how Keywords are interpreted by the SP. Keywords not listed below are interpreted as described in ref. 5.

Forms Guidelines

l The form name defined between the delimiters '['and']' should not containblank spaces. There can be blank spaces elsewhere. Therefore,[ READ FORM ] is an invalid form name, but [ READFORM ] is valid.

l The form name cannot exceed 20 characters.

l User defined keywords cannot have blank spaces in between. Therefore akeyword 'ACC NO' will result in a syntax error for the form.

l User defined keywords cannot exceed 20 characters.

l The maximum size of data that can be associated with a keyword is 320characters.

l All user defined fields must have a start and an end position. These positionsmust always be of the form, <Field Separator> +/- <Field Offset>. For example, a form which contains MII= FIELDSEPPOS1, ENDTRACKwill be invalid. The correct format would be as MII= FIELDSEPPOS1 + 0,ENDTRACK + 0.

l If the read algorithm does not make use of brackets to take care of precedence,a check will occur from left to right, irrespective of the type of operand. Thus,read algorithm 'TRACK1|TRACK2&TRACK3', it is equivalent to'(TRACK1|TRACK2)&TRACK3'.

l The absence of a DEFAULT character being defined in the form is equivalentto the statement "DEFAULT = ?" being present in the form.

Keyword Interpretation

SECURE This keyword is ignored as Security Modules arenot supported.

FIELDSEPPOSn This is the nth occurrence of field separator in thetrack. Here, n must be greater than 0.

DEFAULT The value for this keyword must be a singlecharacter other than the character '?', which signifiesthat fields not specified in the form are to be leftunchanged. This character is used to pad up fields inthe track not explicitly mentioned in the formdefinition.

ALL For Write forms, if the input specifies the field nameas ALL, the entire track is written to, irrespective ofthe fields defined in the form.Similarly, if the inputnames certain fields, but the form specifies ALL forthe track, the entire track is written with the originalcontents or with the Default character.





1 If the READ_RAW_DATA command requests the ATR of the chip to be read,this will be the last action performed. When the command is complete, thecard will be staged in the Smart card reader. If a chip is present, it will be in apowered-up condition.

2 After the READ_RAW on Chip or the CHIP_IO command is completedsuccessfully, the card remains staged in the Smart Card unit and will be in apowered-on condition. To switch off, issue any other command which requirestracks to be read/written. The Eject/Retain operations will also switch the chipoff.

3 Errors detected in form files will be logged in the form error file named in theregistry. During initialization of the SP, the forms are read from the files,formatted into structures and placed into memory. Only certain classes oferrors can be detected at this stage. If an error is found in any form, it will belogged in the file. In order to check for basic syntactical correctness of forms,examine the form error file just after the SP has been initialized. After formrelated commands have been executed, semantical errors are likely to bedetected. This, too, will be logged into the form error file.

4 In the READ_RAW command, the data will not contain track delimiters.

5 In the WRITE_RAW command, the data passed to write on card should notcontain track delimiters.

6 The maximum data that can be stored on tracks 1, 2 and 3 are 78, 39 and 106respectively minus two delimeters.

7 If the read algorithm is "TRACK1 | (TRACK2 & TRACK3)", the output datawill contain data from all the tracks successfully read. Reading will not stopimmediately after the read algorithm is satisfied.

8 When a QUERY_FORM command returns the error ofWFS_ERR_FORMINVALID, there is definitely a problem with the form.However, the same cannot be said of the READ_TRACK andWRITE_TRACK commands. Here, WFS_ERR_FORMINVALID error maybe returned even if command or data does not suit the form being used. For example - A Read form being used in a WRITE_TRACK command, afiled defined in a form is not present on card data to be written on a fieldoverflows the field, etc. Messages in the trace file will indicate the true natureof the error.

9 Following a WFSCancelAsyncRequest of any command that results in the SPwaiting for a card to be inserted, the application should issue a GET_STATUScommand to determine if a card is staged or not. This is recommendedbecause there is a finite possibility that the cancel request is processed as thecard is being staged in which case the SP does not generate aWFS_EXEE_IDC_MEDIAINSERTED event.




10 The IDC SP and device drivers attempt to recover from card jam and othercard conditions. If after repeated attempts, the error condition persists, thedevice goes into a fatal state, a condition that can be cleared only by operatorintervention via the VDM. The following table lists the error conditions fromwhich the SP attempts to recover, and the action to be taken for othercommonly occurring errors.

Error Condition Recovery Action

Card Jam on Entry Following a WFS_CMD_IDC_READ_RAW_DATA command, if the SP detects acard entering the throat but is unable to complete the ACCEPT operation, the SPassumes that customer tampering has occurred and enters a suspend state for'SuspendTimeout' minutes, during which all commands that have device interactionwill return WFS_ERR_DEV_NOT_READY.On expiry of this period, the SP checks the status of the device, and if it is found to behealthy, resumes normal operation. If user tampering persists, the device goes into afatal state, following which all commands issued to the device will returnWFS_ERR_HARDWARE_ERROR.Recovery now requires operator intervention via VDM.

Read errors The device driver maintains a count of consecutive read errors for each track. Thecount is cleared by a good read from the appropriate track, but a blank track is notconsidered a good read in this case.The driver also maintains an overall error count of consecutive read errors on anytrack which can be cleared by a good read on any track. When this count reaches 15,30 or 45, the SP assumes that customer tampering has occurred and attempts to ejectthe card. Following this, the SP enters a suspend state for 'SuspendTimeout' minutes,during which all commands that have device interaction will returnWFS_ERR_DEV_NOT_READY.On expiry of this period, the SP checks the status of the device, and if it is found to behealthy, resumes normal operation. If user tampering persists, the device goes into afatal state, following which all commands issued to the device will returnWFS_ERR_HARDWARE_ERRORRecovery now requires operator intervention via VDM.

Blank tracks The device driver maintains a count of consecutive blank tracks returned from anytrack, plus an overall count.When this count reaches 15, the SP assumes that customertampering has occurred and attempts to eject the card. Following this, the SP enters asuspend state for 'SuspendTimeout' minutes, during which all commands that havedevice interaction will return WFS_ERR_DEV_NOT_READY.On expiry of this period, the SP checks the status of the device, and if it is found to behealthy, resumes normal operation. If user tampering persists, the device goes into afatal state, following which all commands issued to the device will returnWFS_ERR_HARDWARE_ERROR.Recovery now requires operator intervention via VDM.




Invalid Cards The device driver detects long cards on entry, and ejects them as invalid. However, if5 consecutive invalid cards are detected, the SP assumes that customer tampering hasoccurred and attempts to eject the card. Following this, the SP enters a suspend statefor 'SuspendTimeout' minutes, during which all commands that have deviceinteraction will return WFS_ERR_DEV_NOT_READY.On expiry of this period, the SP checks the status of the device, and if it is found to behealthy, resumes normal operation. If user tampering persists, the device goes into afatal state, following which all commands issued to the device will returnWFS_ERR_HARDWARE_ERROR.Recovery now requires operator intervention via VDM.

Card jammed inside device When the device driver detects a card jam it makes 3 attempts to complete theoperation at 3-second intervals. If these attempts are unsuccessful, the SP returnsWFS_ERR_IDC_MEDIAJAM and attempts to capture the card. If the attempt tocapture the card fails the device goes into a fatal state in which the device isinoperable. All Execute command requiring device interaction issued to the SP willreturn WFS_ERR_HARDWARE_ERROR.If following a successful capture of a card, three consecutive card jams occur in eitherthe forward or backward direction, the device enters a fatal state in which the device isrendered inoperable. All Execute command requiring device interaction issued to theSP will return WFS_ERR_HARDWARE_ERROR.Recovery now requires operator intervention via VDM.

Write errors due to badmedia/hardware errors.

The device driver maintains a count of consecutive write errors for each track, and onefor the card overall. The overall count is cleared by a good write to any track. If thiscount reaches six, the device enters a fatal state in which the device is renderedinoperable. The SP make no attempt at recovery. Recovery now requires operator intervention via VDM.

Shutter Jam When the device detects a card entering the throat, the shutter solenoid is energized forup to 25 seconds. If the shutter fails to open, the SP returnsWFS_ERR_IDC_SHUTTERFAIL. If the driver detects this condition five times in arow, the device enters a fatal state in which the device is rendered inoperable. The SPmakes no attempt at recovery.Recovery now requires operator intervention via VDM.

Error Condition Recovery Action




References

References R-1




WOSA/XFS - Programmer’s Reference ManualReferences

WOSA/XFS - Programmer’s Reference Manual R-1


References 0

1 WOSA/XFS Application Programming Interface (API)/Service ProviderInterface (SPI) Specification, Programmer’s Reference, Revision 2.00,September 12, 1996.

2 WOSA/XFS Sensors and Indicators Unit Device Class Interface,Programmer's Reference, Revision 2.00, September 26, 1996.

3 WOSA/XFS Programming Interface Specification for Depository ServiceClass, Revision 2.00, September 19, 1996.

4 WOSA/XFS Cash Dispenser Device Class Interface, Programmer'sReference, Revision 2.00, September 25th, 1996.

5 WOSA/XFS Magnetic Stripe Reader/Writer Device Class Interface,Programmer's Reference, Revision, 2.00 September 11th, 1996.

6 WOSA/XFS Printer Device Class Interface, Programmer's Reference, --Revision 2.00, September 19, 1996.

7 WOSA/XFS Text Terminal Unit Service Class, Revision 2.00, Sept. 26, 1996.

8 WOSA/XFS Vendor Dependent Mode Unit Service Class-Revision 2.00,Sept. 26, 1996.

9 WOSA/XFS PIN Keypad Device Class Interface, Programmer's Reference, Revision 2.04, Sep 11, 1996.

10 NCR Self-Service Platform Software, Programmer's Manual for the MediaEntry Indicators, D1-4597A.

11 NCR Self-Service Platform Software, Programmer's Manual for the IndicatorsServices , D1-4596-A.

12 NCR Self-Service Platform Software, Programmer's Manual for the Alarms,D1-4601-A.

13 56XX ATMs Diagnostic Status Code Note Book, SP-5065.

14 NCR 56XX ATMs Security Enclosures' Alarms and Locks, D1-2472-A.

15 Programmer's Manual for the Envelope Dispenser - NCR Self-ServicePlatform Software, D1-4610-A.

WOSA/XFS - Programmer’s Reference ManualReferences

R-2 WOSA/XFS - Programmer’s Reference Manual


16 Programmer's Manual for the Envelope Depository - NCR Self-ServicePlatform Software, D1-4607-A.

17 Programmer's Manual for the Night safe Depository - NCR Self-ServicePlatform Software, D1-4609-A.

18 Self-Service Platform Software Programmer's Manual for the CurrencyDispenser, D1-4606-A.

19 Programmer’s Manual for the Motorised Magnetic Card Reader/Writer NCRS4 D1-4604-A

20 Smart Card Programmer’s Reference Manual. NCR S4 D1-3084-B.

21 Programmer’s Manual for the Swipe Magnetic Card Reader NCR S4 D1-4741-A.

22 Programmer’s Manual for the DIP Magnetic Stripe Reader NCR S4 D1-4605-A.

23 Programmer's Manual for the 40 Column Printer, NCR: --D1-4612-A.

24 Programmer's Manual for the 80 Column Printer, NCR: --D1-4611-A.

25 NCR Self-Service Platform Software, Programmer's Manual for the EnhancedOperator Panel, D1-4598-A.

26 NCR Self-Service Platform Software, Programmer's Manual for theCardholder Keyboard Manager, D1-4594-C.

Title:

Number: : Date:

NCR welcomes your feedback on this publication. Your comments can be of great value in helping us improve our information products.

You may send your comments, electronically, to the Information Products Department at Dundee. See over for details.

Circle the numbers below that best represent your opinion of this publication.

Ease of use 5 4 3 2 1 0 5 = Excellent4 = Good3 = Adequate2 = Fair1 = Poor

0 = Not applicable

Accuracy 5 4 3 2 1 0

Clarity 5 4 3 2 1 0

Completeness 5 4 3 2 1 0

Organization 5 4 3 2 1 0

Appearance 5 4 3 2 1 0

Examples 5 4 3 2 1 0

Illustrations 5 4 3 2 1 0

Job performance 5 4 3 2 1 0

Question resolution 5 4 3 2 1 0

Overall satisfaction 5 4 3 2 1 0

Indicate the ways you feel we could improve this publication.

❑ Improve the table of contents ❑ Add more/better quick reference aids

❑ Improve the overview/introduction ❑ Add more examples

❑ Improve the organization ❑ Add more illustrations

❑ Improve the index ❑ Add more step-by-step procedures

❑ Make it less technical ❑ Add more troubleshooting information

❑ Make it more concise/brief ❑ Add more detail

Cut


B006-0000-6001 01.00.00 September 1997Release

User Feedback Form

Fold

FoldC

ut

AffixPostageStampHere

Write any additional comments you may have below and on additional sheets, if necessary. Include page numbers where applicable.

Use the following addresses to send your comments, electronically, to the Information Products Departmentat Dundee:

WWW - http://www.ncr.com/product/infoprod/dundeeip/

e-mail - [email protected]

If we may contact you concerning your comments, please fill in the information below:

Thank you for your evaluation of this publication. Fold the form where indicated, tape (please do not staple),and drop in the mail.

F 8763-0695

Name:

Organization:

Company:

Address:

Phone: Fax:

NCR Financial Systems LtdInformation ProductsKingsway WestDundee ScotlandDD2 3XX

Documents

WOSA/XFS - pudn.comread.pudn.com/downloads756/ebook/3008325/wosa_ncr.pdf · WOSA/XFS - Programmer’s Reference Manual Overview WOSA/XFS - Programmer’s Reference Manual v Overview