Professional Documents
Culture Documents
Agilis For ixCSP Terminal Programming Manual PDF
Agilis For ixCSP Terminal Programming Manual PDF
Document History
Copyright protection is claimed for each revision listed in the document history, as of the date indicated.
Any trademarks, service marks, product names or company names not owned by Diebold that appear in this
document are used for informational purposes only and Diebold claims no rights thereto, nor does such use indicate
any affiliation with or any endorsement of Diebold or Diebold products by the owners thereof.
This document contains proprietary information. If the document pages state the information is confidential
(or words of similar import), then this document is intended solely for the use of the copyright owner’s
employees or other personnel expressly authorized in writing by the copyright owner. Other uses of this
information without the express written consent of the copyright owner are prohibited. This document should
be treated as confidential material for security reasons. Any unauthorized disclosure or use of confidential
material may violate Section 1832 of Title 18 of the United States Code as well as other laws, and may be
punishable by fine and imprisonment.
The information contained in this document is subject to change without notice. When using the document for system
implementation, please call your authorized sales or service representative for any applicable changes.
This document and the information contained herein are provided AS IS AND WITHOUT WARRANTY. In
no event shall the copyright owner or its suppliers be liable for any special, indirect, or consequential damages
of any nature resulting from the use of information in this manual.
No part of this document may be reproduced, stored in a retrieval system, or transmitted, in any form or by any
means: electronic, mechanical, photocopying, recording, or otherwise, without prior written permission from the
copyright owner.
Your use of this document and/or any of the information contained herein constitutes your agreement to all of the
terms stated on this page.
Diebold continually strives to improve its products. If you would like to comment on the accuracy, clarity,
organization or value of this document, please contact us at documentationservices@diebold.com or address
correspondence to:
Diebold, Incorporated
Att: Documentation Services 9-B-16
5995 Mayfair Road
North Canton, OH 44720
ii
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
iii
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
iv
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
v
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
vi
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
5.2.9 Withdrawal Door Status (solicited) for 912 Mode (DID = ’@’) . . . . . . . . . . . . 5-37
5.2.10 Depository Status (solicited) for Envelope Depository, for 911 Mode (DID = ’:’) . . 5-38
5.2.11 Depository Status (solicited) for Envelope Depository, for 912 Mode (DID = ’A’) . . 5-39
5.2.12 Depository Status (solicited) for IDM, for 912 Mode (DID = ’A’) . . . . . . . . . . 5-40
5.2.13 Configuration ID Status (solicited) (DID = ’<’) . . . . . . . . . . . . . . . . . . . . 5-42
5.2.14 Cassette Solicited Status (912 mode only) (DID = ’D’) . . . . . . . . . . . . . . . . 5-43
5.2.15 Check Point Status (solicited) (DID = ’C’) . . . . . . . . . . . . . . . . . . . . . . 5-44
5.2.16 Coin Dispenser (solicited) (DID = ’G’) . . . . . . . . . . . . . . . . . . . . . . . . 5-46
5.2.17 Supply Counts (solicited) (DID = ’H’) . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
5.2.18 External Options Module Status (solicited) (DID = ’I’) . . . . . . . . . . . . . . . 5-53
5.2.19 Enhanced Status (solicited) (Status Descriptor = ’J’) . . . . . . . . . . . . . . . . . 5-54
5.2.20 Other Solicited Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56
5.2.21 Message Reject Reason Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
5.3 Unsolicited Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
5.3.1 Unsolicited Status Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-82
5.3.2 Alarm Status (unsolicited) (SSF = ’2’) (Diebold terminals only) . . . . . . . . . . . 5-82
5.3.3 Supervisory and Supply Actions Status (unsolicited) (SSF = ’3’) . . . . . . . . . . . 5-83
5.3.3.1 Supervisory and Supply Actions Status for ixSeries terminals . . . . . . . 5-83
5.3.3.2 Supervisory and Supply Actions Status . . . . . . . . . . . . . . . . . . 5-89
5.3.4 Printer Status (unsolicited) (SSF = ’4’) . . . . . . . . . . . . . . . . . . . . . . . . 5-93
5.3.5 Card Reader Status (unsolicited) (SSF = ’5’) . . . . . . . . . . . . . . . . . . . . . 5-95
5.3.6 Card Writer Status (unsolicited) (SSF = ’7’) . . . . . . . . . . . . . . . . . . . . . . 5-96
5.3.7 Dispenser Status (unsolicited) for 912 Mode (SSF = ’?’) . . . . . . . . . . . . . . . 5-96
5.3.8 Withdrawal Door Status (unsolicited) for 912 Mode (SSF = ’@’) . . . . . . . . . . 5-97
5.3.9 Withdrawal Area Sensors Status (unsolicited) (SSF = ’<’) . . . . . . . . . . . . . . 5-97
5.3.10 IDM Status (unsolicited) for 912 Mode (SSF = ’A’) . . . . . . . . . . . . . . . . . . 5-98
5.3.11 Coin Dispenser Status (unsolicited) for 912 Mode (SSF = ’G’) . . . . . . . . . . . . 5-100
5.3.12 Enhanced Status (unsolicited) (SSF = ’J’) . . . . . . . . . . . . . . . . . . . . . . . 5-101
5.4 Filtering and Translating Network Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-103
5.5 Function Command Message (ID ’4’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-106
5.5.1 Print Immediate (4) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-122
5.5.2 Set Next State and Print (5) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-122
5.5.3 After Hour Depository Deposit and Print (6) . . . . . . . . . . . . . . . . . . . . . 5-122
5.5.4 Deposit and Print (7) (911 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-123
5.5.5 Dispense, Deliver, and Print (8) (911 mode) . . . . . . . . . . . . . . . . . . . . . . 5-125
5.5.6 Deliver and Print (9) (911 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-127
5.5.7 Deposit Envelope (A) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-128
5.5.8 Dispense Currency (B) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-129
5.5.9 Deliver Currency (C) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-130
5.5.10 Print and Wait for Completion (D) (912 mode) . . . . . . . . . . . . . . . . . . . . 5-131
5.5.11 Return Card Immediately (E) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . 5-131
5.5.12 Write Track 3 (F) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-133
5.5.13 After Hour Depository Deposit (G) (912 mode) . . . . . . . . . . . . . . . . . . . . 5-134
5.5.14 Print and Do Not Wait for Completion (H) (912 mode) . . . . . . . . . . . . . . . . 5-134
5.5.15 Return Card, Dispense, Deliver, and Print (J) (911 mode) . . . . . . . . . . . . . . . 5-135
5.5.16 Deposit Envelope, Return Card, Dispense, Deliver, and Print (K) (911 mode) . . . . 5-135
5.5.17 Print, Return Card, Dispense, and Deliver (O) (911 mode) . . . . . . . . . . . . . . 5-135
5.5.18 Print Data and Stay in Present State (P) . . . . . . . . . . . . . . . . . . . . . . . . 5-136
5.5.19 Perform Presenter Retain (Q) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-136
5.5.20 Deposit Check to Escrow (R) (912 mode) (<emphasis type="ITALIC">ix</emphasis>
Series terminals with IDM only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-137
5.5.21 Return Check if in Escrow (S) (912 mode) (<emphasis type="ITALIC">ix</emphasis>
Series terminals with IDM only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-137
5.5.22 Retain Check if in Escrow (T) (912 mode) (<emphasis type="ITALIC">ix</emphasis>
Series terminals with IDM only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-138
vii
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
viii
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
ix
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Contents
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1
Figures
x
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Figures
Tables
xi
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Tables
xii
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Tables
xiii
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Tables
xiv
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Tables
xv
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Tables
xvi
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Section 1
Introduction
This manual is for system programmers who are responsible for the configuration
or control of Agilis 91x for ix/CSP software used to drive Diebold ixSeries
terminals.
Agilis 91x for ix/CSP can be installed on any ixSeries terminal described in
Section 3.
See Section 1.4 for a summary of the devices and features supported by Agilis
91x for ix/CSP.
This manual covers ixSeries terminals and CashSource Plus (CSP) 4XX
terminals operating in either 911 mode or 912 mode differences between these
modes are noted.
Overview
Section 2 provides an overview of the Agilis 91x for ix/CSP system,
including network configurations, terminal configuration, modes of operation,
enhancement software, and information on the devices and features supported
by Agilis 91x for ix/CSP.
Terminal Devices
Section 3 lists terminal devices (bill dispenser, printers, and so on) supported by
Agilis 91x for ix/CSP. For each device, the manual provides a brief description of
the device capabilities that Agilis 91x for ix/CSP supports.
Configuration Data
Section 4 defines the four types of configuration data that the network must store
in the terminal (download) to define terminal operation and their associated
Write Command messages.
Transaction Messages
Section 5 describes the messages sent between the terminal and the network
during transactions.
1-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Introduction
Application Notes
Appendix C contains additional information regarding some Agilis 91x for
ix/CSP features.
VGA Plus
Appendix D describes the VGA Plus features.
• Agilis 91x for ix/CSP and 91x for CSP Status Reference Manual
(TP-821028-001A)
For programming information about the Remote Key Loading feature, check
with your Agilis 91x for ix support representative.
1.3 Terms
The abbreviation ATM refers to an automatic teller machine. In this manual, the
abbreviation ATM and the term terminal are synonymous. Both of these terms
are used to indicate ixSeries terminals manufactured by Diebold.
1-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Introduction
Write Command message numbers have been changed from roman numerals
(for example, Write Command XVIII) to Arabic numerals (Write Command
18). This change in terminology is intended to improve readability. The change
does not reflect any change in either the format or the function of any of the
Write Command messages.
The terms configuration setting and configuration options are used to define
various parameters for terminal devices. Typically, these parameters are
set during Agilis 91x for ix/CSP installation, then remain unchanged. When
specific configuration settings are described, the configuration menu selections
proceed the actual parameter which are shown in a bold font as shown in the
following example.
EXAMPLE
The term Consumer Keypad is used for ixSeries terminals only, and refers to the
numeric keys and those function keys physically grouped with the numeric keys.
The abbreviation CD refers to a compact disk. The term CD-ROM is used only
for non-writeable CDs and CD drives without write capability.
This section provides information on the devices and features supported by Agilis
91x for ix/CSP (see Table 1-1). For those readers familiar with the TCS product,
Table 1-1 also lists devices and features that are not supported.
1-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Introduction
Processor
911 Yes
912 Yes
Camera Yes
Card Readers
Cash Pocket No
Communications Protocols:
- Datapac Yes
- NCR 751 No
Coin Acceptor No
1-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Introduction
Consumer Video
Web Enablement, Phase 2, (For example, printing web pages, and manage ATM No
Devices)
Counters Yes
Depositor Yes
Diagnostics Yes
Dispenser Yes
- Totals by denomination No
Extended Applications
ImageWay Yes
1-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Introduction
XApEvent Plus No
XApImage Yes
EMV Yes
EPP2 Yes
Keyboard Yes
Maintenance Features
Presenter Yes
Printers
Printer, Thermal Statement (Both emulated consumer and thermal statement modes) Yes
RBM Yes
1-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Introduction
TCP/IP Yes
TIA Yes
1-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Section 2
Overview
This section provides an overview of the Agilis 91x for ix/CSP system, including
the following topics:
Agilis 91x for ix/CSP enabled terminals can operate in the following network
configurations:
g5966001a
2-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Overview
The configuration data is sent by the network over the communications line and
is stored in the terminal memory (RAM). This download process is known as
terminal configuration and is performed whenever the terminal is powered
up or reset.
At any time, the Agilis 91x for ix/CSP enabled terminal operates in one of
the following five modes:
• Power-up mode
• Out-of-service mode
• Off-line mode
• In-service mode
• Maintenance mode
The terminal goes from one mode to another when it encounters a specific event,
such as when the terminal operator logs on to Maintenance mode, or Agilis 91x
for ix/CSP determines that the terminal is no longer communicating with the
network.
Figure 2-2 shows how the terminal normally exits one mode and enters another.
If the terminal loses power or is reset, the terminal abnormally exits from the
mode it was in when the reset or power failure occurred.
g5233015
The following subsections describe how the terminal enters and exits each of the
modes and, if applicable, how the terminal functions when it is in that mode.
2-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Overview
The terminal enters the Power-up mode when one of the following events occurs:
During the Power-up mode, Agilis 91x for ix/CSP initializes the timers, the
communications interface, and any installed devices (bill dispenser, keypad, and
so on). Agilis 91x for ix/CSP also erases any information that might have been
displayed on the consumer display when the terminal entered the Power-up mode.
The terminal exits to the Off-line mode or Out-of-Service mode when it leaves
the Power-up mode.
The terminal enters the Out-of-service mode from any one of the following
modes:
• The In-service mode (if the terminal receives a shutdown command from
the network)
While in the Out-of-service mode, the terminal displays the Out of Service screen
(screen 002, unless redefined by the network) on the consumer display.
Depending upon what mode the terminal was in before going Out-of-service, the
terminal might be able to perform other functions.
The terminal enters the Off-line mode from any of the following modes:
• In-service mode
• Out-of-service mode
• Power-up mode
• Maintenance mode
The Off-line mode is entered from the In-service mode if communication is lost
between the network and the terminal.
2-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Overview
• The terminal displays the Off Line screen (screen 001, unless redefined by
the network) on the consumer display.
The terminal enters the In-service mode from any of the following modes:
While in service, the terminal uses the configuration data to make transaction
sequence decisions.
By default, Agilis 91x for ix/CSP accepts Write Command messages while in
service. This is a configurable option (Transaction Host, Message Settings,
Command Message, Write Commands while In Service).
By default, Agilis 91x for ix/CSP processes the Operational Command message
requesting configuration information even if a consumer is on the terminal.
This is a configurable option (Transaction Host, Message Settings, Command
Messages, Configuration request while consumer is using ATM).
The terminal exits from the In-service mode under the following conditions:
• The terminal receives a Shutdown command from the network; the terminal
exits to the Out-of-service mode after finishing any consumer transactions
in progress.
2-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Overview
NOTE
The terminal manager or terminal operator uses the Agilis 91x for ix/CSP
Maintenance mode to replenish supplies, change passwords, and change
encryption keys. All maintenance operations are described in the Agilis 91x for ix
Maintenance Manual (TP-820589-001E).
The terminal manager must manually place the terminal in the Maintenance
mode. The network cannot command the terminal to enter this mode.
• The terminal processes Write Command messages and replies with Solicited
Status messages indicating either a Ready condition or a Command
Reject condition.
2-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Overview
Some ixSeries terminals are equipped with the Agilis Supply Manager option,
which includes the Continuous Availability feature. Continuous Availability
allows a terminal manager to perform maintenance procedures on a rear-load
terminal while the terminal is in service. The terminal remains available to the
consumer for performing transactions while the terminal manager replenishes
supplies and checks counters using the terminal’s rear monitor. If a transaction
requires a device that is being serviced, Agilis 91x for ix/CSP informs the
consumer that the device is temporarily unavailable.
For details on Continuous Availability, refer to the Agilis 91x for ix Maintenance
Manual (TP-820589-001E)
NOTE
2-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
2-7
Overview
Table 2-1 Terminal Responses to Network Commands
Operational Command ’1’ Ready (’9’) Ready (’9’) Ready (’9’) Ready (’9’), once Maintenance
mode is exited
(Go in-service)
Operational Command ’2’ Ready (’9’) Ready (’9’), once transaction is Ready (’9’) Ready (’9’), once Maintenance
closed mode is exited
(Go out-of-service)
Operational Command ’3’ Configuration information (’8’) Configuration information (’8’) [1] Configuration information (’8’) Configuration information (’8’)
Operational Command ’6’ Ready (’9’) Ready (’9’) Ready (’9’) Ready (’9’)
Operational Command ’7’ Ready (’9’) Ready (’9’) Ready (’9’) Ready (’9’)
Operational Command ’8’ Reject (’A’) Reject (’A’) Ready (’9’) (must be set for EMG Reject (’A’)
©Diebold, Incorporated (11/2004) - All Rights Reserved
Operational Command ’9’ Configuration information (’8’) Configuration information (’8’) Configuration information (’8’) Configuration information (’8’)
Operational Command ’:’ Reject (’A’) Reject (’A’) Configuration information (’8’) Reject (’A’)
[3] Depending on configuration options, the terminal can reject a Write Command message in these modes.
[4] Ready (’B’) would occur instead, if the Separate Ready for Function Command Message feature is enabled in Miscellaneous Features 1 field of Write Command 3 message.
[5] Depending on configuration options, the terminal can accept print immediate function commands and print and wait function commands in Maintenance mode.
[6] Ready response only if the terminal is in the Transaction Request state. Otherwise, a Reject response occurs.
TP-821029 (Ed. A)
©Diebold, Incorporated (11/2004) - All Rights Reserved
Operational Command ’;’ Configuration information (’8’) Configuration information (’8’) Configuration information (’8’) Configuration information (’8’)
Operational Command ’<’ Reject (’A’) Reject (’A’) Configuration information (’8’) Reject (’A’)
(Run self-test)
Write Commands Ready (’9’) [3] Ready (’9’) [3] Ready (’9’) Ready (’9’) [3]
Write Command 5 Reject (’A’) Ready (’9’) [6] Reject (’A’) Reject (’A’)
(OAR)
Function Commands Reject (’A’) Ready (’9’) [4] [6] Reject (’A’) Reject (’A’)
Overview
2-8
2-9
Overview
Table 2-1 Terminal Responses to Network Commands (continued)
Function Commands ’4’ and ’D’ Reject (’A’) Ready (’9’) [4] [6] Ready (’9’) Reject (’A’) [5]
Enhanced Function Commands Reject (’A’) Ready (’9’) [4] [6] Reject (’A’) Reject (’A’)
[1] Depending on configuration options, the operational command can be rejected.
[2] Also returns a Supervisory and Supply Actions status (Maintenance logon or logoff).
[3] Depending on configuration options, the terminal can reject a Write Command message in these modes.
[4]
There are several terminal-resident applications that can coexist with Agilis 91x
for ix/CSP to enhance the operation of the terminal. Some of the applications are
included as part of the Agilis 91x base software. Other applications are optional.
The following applications are available for use with Agilis 91x.
Application Description
ACI Remote Client Optional ACI Remote Client is an ATM resident software application designed to interface to the
File Manager software distribution product marketed by Applied Communications, Inc.
(ACI). The interface to ACI File Manager is via a message level protocol defined by ACI
known as Standard POS Device Handler Enhanced or SPDH-e.
The Diebold ACI File Manager/Remote Client is a 32-bit application designed to run
under OS/2 and now, Windows NT, 2000 and XPe. This product uses Diebold Agilis
Base Communications (ABC) as its communications interface to the system hosting
the ACI File Manager product.
Agilis Base Included Agilis Base Communications (ABC) is a data communications package that provides
Communications support for a wide variety of communications protocols. This product has merged
the two primary communication software packages used within the global Diebold
organization into one. The two packages are Common Communications Services
(CCS) developed in the Diebold EMEA geography and the Communications Subsystem
(CSS) developed by Diebold North America. This single ABC package addresses the
needs of the Agilis 91x for ix product line.
Protocols supported as of Release 4.0 include the following:
• IBM 3271 Bisync Slave (EBCDIC)
• Burroughs Poll/Select Slave (TD800) (SYNC/ASYNC)
• Dial Transfer Driver
• IBM SNA/SDLC LU_T0 (PU_T2) slave
• TCP/IP (sockets driver) Client/Server with TELNET and TELNET 3270E
• X.25
• NULL protocol
• Datapac 3201
• IBM SNA over TCP (DSLW)
Bill Mix Application (BMX) Included The Agilis Bill Mix Application provides bill mix support for terminals installed in a host
network running the 911-message format and requires more than 2 denominations (high
and low) to be supported for terminals installed in a true 911 terminal network
NOTE
EDC Version Optional Electronic Data Capture (EDC) provides an alternative to the physical journal printer for
the capture and storage of journal information. What was once a standalone application
has been integrated into Agilis 91x as a user exit. This data can include transaction data,
terminal statuses, device activity logs, printer diagnostics, and cassette counters. EDC
continues to support multiple operating modes: Dial-up, Leased line and ATM Resident.
EMS Remote Notifier Optional EMS Remote Notifier provides support for 911/912 and MDS terminal messages. This
Version application monitors and sends the status and event messages from the ATM to the
Event Management System (EMS) Server.
2-10
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Overview
Application Description
iqCRM Agent Optional iqCRM™ (Customer Relationship Management) is a centralized, server based system
that allows remote management of marketing sessions or campaigns on self-service
terminals. The iqCRM™ system is provided with the hardware and software required
to remotely communicate with the ATMs. Marketing campaigns are created based on
what the financial institution wants to accomplish. These can be determined from the
financial institution’s Enterprise CRM system, or specific requirements of the financial
institution such as offering a $5 deposit to all not on-us customers. iqCRM™ also
requires a product to deliver content (for example, icons, MPEGs and coupons) to the
ATMs. For this purpose, iqCRM™ operates most effectively when accompanied with
Diebold iqESD™. iqCRM™ operates in a TCP/IP network environment.
iqESD Agent Optional iqESD™ (Electronic Software Distribution) is a centralized, server based system
that allows remote delivery of campaign content (for example, icons, MPEG videos,
coupons) to self-service terminals. The iqESD™ system provides the hardware
and software required to remotely communicate with the ATMs. The system allows
information to pass back and forth between the server and the network of ATMs.
iqESD™ operates in a TCP/IP network environment.
Local Screen Change Optional The key features include the ability to store network download data; the ability to load
(LSC) stored network data upon receipt of a power failure message; the ability to maintain
custom data; dynamic reconfiguration of the terminal and validation of locally stored
files to guard against tampering of those files.
MAC Version Included The Message Authentication Application (MAC) is a security application, which
authenticates messages between the Network and ATM by appending a message
authentication number and/or time variant number to all critical messages.
SXA Version Included The Software Extended Application is the application that is responsible for routing
and managing 911/912 messages to/from custom ATM applications, also known as
User Exits. This application was previously available as an option for TCS and is now
designed as a standard component of Agilis 91x. The key advantage is the ease of
configuration. All user exit applications that are designed with the enhanced architecture
will fit into the Agilis 91 x system as a completely integrated solution.
SXA provides complete tracing and error logging support for all messages that pass
through the application’s subsystem. A GUI-based user interface is provided with
SXA to simplify the management of traces, error logs and re-configuration of User
Exit applications.
Visa Network Interface Included Diebold’s VNI application is a protocol application for Diebold ATM(s) running
(VNI) Compatible 91X Application software under Windows. This application allows an ATM
to use the standard VISA II data link protocol to exchange 91x text messages with a
host computer through a value-added network. Diebold’s VNI application protocol
supports Compatible 91X Application style messages. The types of text messages
include the following:
• Consumer Requests
• Function commands
• Write commands
• Operation commands
• Unsolicited Status
• Solicited Status
• Protocol messages
XApCoupon Plus Optional XApCoupon Plus provides support for Coupon or non-cash media dispensing and/or
printing capabilities at the terminal. XApCoupon Plus may be used when the networks
or hosts are unable to support these functions or do not want the costs associated with
managing coupons (i.e. scheduling file updates, changing the host configuration files,
and managing the replenishment of supplies).
XApCoupon Plus provides management of the non-cash media delivered by providing
detailed configuration on when the coupon is to be delivered. The application maintains
counts of media delivered via extensive logging and even provides flexibility to allow
consumers to select the coupon of choice. This provides the required information for
terminal owners to determine the profitability of dispensing or printing non-cash media.
2-11
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Overview
Application Description
XApDeposit (XApCheck Optional The XApCheck Plus extended application allows the IDM3 Intelligent Depositor Module
Plus, XApImage Plus) to operate in a network that does not currently support check cashing transactions.
The XApCheck Plus product enables this by presenting the check transaction as an
envelope deposit to the 912 network.
The XApImage Plus extended application provides the ability to save the front and
back images of checks along with transaction data from IDM3 based check deposit
transactions. The images and transaction data are then retrieved by the Imageway
Agent for item processing.
XApLogo Plus Optional XApLogo Plus provides local support for printing graphics to the thermal receipt printer.
XApLogo Plus provides the ability to print up to four logos per receipt, two logos on the
top and two logos on the bottom of the receipt, before and after network print data. A
special feature of this application is a statistics file that is updated each time a logo or
graphic is printed.
2-12
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Section 3
ix Series Terminals and Devices
ixSeries terminals
Agilis 91x for ix/CSP can be installed on any ix/CSP Series terminal including
the following terminals:
Section 3.1 through Section 3.4 describe the devices that can be installed with
Agilis 91x for ix/CSP in ixSeries terminals.
The types of card readers available for ixSeries terminals are as follows:
NOTE
At present, Agilis 91x for ix/CSP does not support reading data
from or writing data to smart card (chip card) electronic chips.
3-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Motorized card readers (including motorized smart card readers) for ixSeries
terminals can perform any of the following functions as directed by Agilis
91x for ix/CSP:
• Return the card to the consumer when a power problem occurs, if the
terminal has the Card Return on Powerfail option
Agilis 91x for ix/CSP supports the multi-media dispenser (MMD) equipped with
a Presenter. The MMD can contain up to four dispense cassettes, plus a divert
cassette (reject cash unit). The MMD can dispense up to four denominations and
up to 50 bills for each dispense operation.
The SDM has an automatic dispensing mode that allows the dispense of a single
piece of media at the beginning of a deposit function. The automatic dispensing
mode is enabled or disabled by the network using a Write Command 3 message.
The default is auto dispensing enabled.
2. If the response is Yes, the media is dispensed and the terminal proceeds to
the deposit operation (it does not wait for consumer to take media).
3-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
SDM status messages can be blocked from being sent to the network by using a
Write Command 3 message. The default is to not send any SDM status messages
to the network during the automatic dispensing mode.
3.4.1 Features
• Reads all fields from magnetic ink character recognition (MICR) encoding
strip
3-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
• Sorts documents into three separate bins with an approximate total capacity
of 650 documents
• An invalid document can be inserted into the IDM3 without a micr fault
being reported. The occurrence of this is rare, however, when this does
happen the validity of documents can usually be determined by whether or
not image recognition is successful
Information contained in the MICR line is retrieved using a magnetic read head.
The head reads all fields from the MICR line encoding strip as defined by
ANSI X9.13-1983.
The image scanner system for the IDM consists of the following components:
3-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
The image capture feature enables an ATM to record the images of various
documents deposited into the ATM. These documents could be checks, utility
bills, etc. The image can be used in the following ways:
• Displayed on the consumer display to assure the consumer that the document
is being handled properly
3-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Figure 3-1 shows some typical configurations of the consumer interface panel on
ixSeries terminals.
3-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
g5966003a
3-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
• Basic monochrome
• Enhanced Monochrome Graphics (EMG)
• Color Graphics Feature (CGF)
• VGA Plus
For information about the basic monochrome video option, refer to Section 4.6.
For information about EMG, refer to the Enhanced Monochrome Graphics
Programming Manual (TP-799300-000A). For information about CGF, refer
to the Color Graphics Feature Programming Manual (TP-799344-000A). For
information about VGA Plus, refer to Appendix D.
All monitors support both the 32-by-16 display grid and the 40-by-20 display
grid (Section 4.6.1). The 32-by-16 display grid allows compatibility with mixed
networks running both TABS and Agilis 91x for ix/CSP terminals.
Some ixSeries terminals are equipped with a touch screen, which allows the
consumer to make selections and enter data by touching programmable areas on
the consumer display. For information about programming requirements for
touch screens, refer to Section 4.8.
ixSeries terminals can be equipped with either a single set of function keys
(four keys, labeled A, B, C, and D) or dual function keys (eight keys, labeled
A through D, and F through I). Implementing dual function keys requires
the Function Key Extension state (Section 4.4.19), as well as screens with
appropriate lead-through lines or arrows. For host computers that use the Open
Account Relationship feature, the Write Command 5 message can also be
extended to enable the F, G, H, and I keys (Section 5.2.6).
NOTE
3-8
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Function keys J through M also require extension states and extended Write
Command 5 messages for activation.
Some ixSeries terminals are equipped with an encrypting PIN pad (EPP). The
EPP is a Consumer Keypad incorporating an encryption/decryption module
that can encipher a consumer-entered PIN inside a secure module directly at
the keypad for transmission to the network. The EPP can also perform data
encryption algorithm (DEA, also known as DES [data encryption standard])
and operations such as network-to-ATM message authentication. The keypad
layout of the EPP is comparable to that of non-encrypting 16-key keypads. For
detailed information about the EPP, refer to the Data Security Procedures and
Reference Manual (TP-799530-001D).
3-9
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
For each numeric key and function key, the data byte sent to Agilis 91x for
ix/CSP is shown in Table 3-1.
0 Key 0 30 F0
1 Key 1 31 F1
2 Key 2 32 F2
3 Key 3 33 F3
4 Key 4 34 F4
5 Key 5 35 F5
6 Key 6 36 F6
7 Key 7 37 F7
8 Key 8 38 F8
9 Key 9 39 F9
Function Key A A 41 C1
Function Key B B 42 C2
Function Key C C 43 C3
Function Key D D 44 C4
Cancel Key E 45 C5
Function Key F F 46 C6
Function Key G G 47 C7
Function Key H H 48 C8
Function Key I I 49 C9
Function Key J J 4A D1
Function Key K K 4B D2
Function Key L L 4C D3
Function Key M M 4D D4
NOTE
3-10
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
When these lead-through indicators are present in the terminal, the indicators are
controlled by the Automatic Lead-through feature described in Section 3.6.
3.7 Alarms
Agilis 91x for ix/CSP reports Alarm statuses to the network if any alarms are
triggered. Alarm status can be reported for any of the following devices, if the
devices are installed in the ix/CSP Series terminal:
• Anti-ambush
• Chest door
• Burglary
To print transaction information on the receipt printer, the network must send
the information to Agilis 91x for ix/CSP in a Function Command message
(Section 5.5) and must specify (in the Function Command message) the routing
of print data to the receipt printer.
• Graphics-related
• Text-related
• Pass-through
3-11
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
NOTE
The number of blank lines for form feeding varies. The Close state performs
eight line feeds before cutting the paper. When the terminal receives an FF
control character or ESC P, information in the configuration determines the
number of line feeds performed. The default is one line feed.
Blank paper typically does not contain preprinted transaction codes and
descriptors on the reverse side of consumer receipts. If this is the case,
changes to the network printer data are required to add transaction descriptors
to the printer data.
• Can detect and retract receipts not taken by the consumer (that is, the receipt
printer has an exit sensor and has document retain capability)
The receipt printer can use top-of-form (TOF) marks for fixed-page-length
control or registration with preprinted images. If fixed page lengths or preprinted
registration are not needed, TOF marks are optional. By installing suitable
thermal paper, it is possible to print two colors on the receipt.
3-12
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Using graphics-related printing strategies, the receipt printer can print graphics
having a maximum size of 576 pixels by 1600 pixels. The following settings are
recommended for graphics-related printing strategies:
• Can detect and retract receipts not taken by the consumer (that is, the receipt
printer has an exit sensor and has document retain capability)
The network should send no more than 28 characters for each line at 10
characters per inch (cpi), 34 characters for each line at 12 cpi, or 45 characters
for each line at 16 cpi. (In pass-through mode, the printer supports 17 cpi pitch
rather than 16 cpi, allowing 48 characters for each line.)
The maximum size of the graphics that can be printed are as follows:
3-13
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
This receipt printer can use top-of-form (TOF) marks for fixed-page-length
control or registration with preprinted images. If fixed page lengths or preprinted
registration are not needed, TOF marks are optional.
The 35-column Consumer Printer does not have an exit sensor. The printer
cannot retract and retain receipts that are not taken by the consumer.
To print transaction information on the journal printer, the network must send
the information to Agilis 91x for ix/CSP in a Function Command message
(Section 5.5) and must specify (in the Function Command message) the routing
of print data to the journal printer.
• Graphics-related
• Text-related
• Pass-through
These printing strategies function the same way for journal printers as for receipt
printers. For a description of these printing strategies, refer to Section 3.8.
Journal printers using one of the graphics strategies use the same character sets
and control sequences as the receipt printer (Section 3.8).
3-14
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Form Feeds
During Agilis 91x for ix/CSP installation, a deliver request string can optionally
be defined for the journal printer. This deliver request string is used by
graphics-related strategies and text-related strategies (but not the pass-through
strategy) in the following way. When Agilis 91x for ix/CSP encounters a form
feed character in the print data for the journal printer, if a deliver request string
has been defined, then Agilis 91x for ix/CSP substitutes the deliver request string
for the form feed character and sends the deliver request string to the journal
printer as raw data.
The intent of this feature is to allow printing receipt data on the journal printer
without requiring the host to send separate print data for the two printers.
With this feature, Agilis 91x for ix/CSP automatically converts any form feed
characters required for receipt printing to, for example, single line feeds before
sending the data to the journal printer.
For additional information about the deliver request string, refer to the Agilis 91x
for ix/CSP installation documentation for your system.
Line Feeds
For all graphics-related strategies and text-related strategies, Agilis 91x for
ix/CSP filters out line feeds (LF control characters) for lines that do not contain
information. This process suppresses the printing of blank lines on the journal
printer roll.
Using graphics-related printing strategies, the journal printer can print graphics
having a maximum size of 432 pixels by 1600 pixels. The following settings are
recommended for graphics-related printing strategies:
3-15
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
The ix/CSP Series journal printer is not graphics capable. Either the pass-through
strategy or a text-related strategy must be used with the ix/CSP Series journal
printer.
To print transaction information on the statement printer, the network must send
the information to Agilis 91x for ix/CSP in a Function Command message
(Section 5.5) and must specify (in the Function Command message) the routing
of print data to the statement printer.
• Graphics-related
• Text-related
• Pass-through
These printing strategies function the same way for statement printers as for
receipt printers. For a description of these printing strategies, refer to Section 3.8.
Statement printers using one of the graphics strategies use the same character sets
as the receipt printer and the journal printer (Section 3.12.1), but use a separate
set of control sequences (Section 3.12.3), and, for standard (non-enhanced)
Function Command messages, the print data for a statement printer must be
in expanded ASCII format.
A special file called an SCR file can also be used (Section 4.11). This file type is
automatically detected and handled.
3-16
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
When the network sends data intended for receipt printing, the Function
Command message must contain either an appropriate receipt printer flag (2 or
3) or PR b/ enhanced function data to indicate receipt printing. In addition, the
print data intended for receipt printing must be compliant with the rules for
receipt data. In particular, the print data must be in normal (non-expanded)
ASCII format, and the network must use the receipt printer control sequences
(Section 3.12.3), rather than statement printer control sequences.
The network must ensure that receipt data and statement data are not intermixed
on the same form. One job should complete printing and delivering the form
before the next job starts printing.
Print Buffers
If the printer data is short enough to fit in a single Function Command message,
the network can use any function ID, other than P, that includes a print operation.
The printer flag ; (semicolon) is used to print the printer data on the statement
printer. During the processing of the Function Command message, the printer
flag ; causes Agilis 91x for ix/CSP to place the printer data associated with
printer flag ; in buffer S. During the printing operation, the printer data in buffer
S is sent to the statement printer. When the function command processing is
complete, the statement printer cuts and delivers the document automatically.
If the printer data is too lengthy to fit in a single Function Command message,
the printer data can be divided into smaller blocks. The smaller blocks can be
sent to the terminal in a series of standard Function Command messages. For
example, the first Function Command message could contain the printer data for
the statement header. The second Function Command message could contain the
information requested by the consumer. The third Function Command message
could contain trailer data of some sort. With this method, the function identifier P
(print data and stay in present state) must be used in all but the last Function
Command message so that the statement printer does not automatically cut and
deliver the document before all printing is completed. In the last Function
Command message, a function ID other than P must be used so that the statement
printer cuts and delivers the document after all the printing is completed. This last
Function Command message must contain at least one character of printer data.
EXAMPLE
The following example shows how the Statement Printer state could be used to
print data that is in normal (non-expanded) ASCII format.
3-17
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3. The second Statement Printer state specifies operation 003 (deliver and
wait) to deliver the printed statement.
The statement printer uses a continuous roll of paper. The printer can use
top-of-form (TOF) marks for page alignment, fixed-page-length control, or
registration with preprinted images. If page alignment, preprinted registration, or
fixed page lengths are not needed, TOF marks are optional. By installing suitable
thermal paper, it is possible to print two colors on the statement document.
The maximum size of the graphics that can be printed is 1622 pixels wide
by 2280 pixels high.
The deposit printer in an ix/CSP Series terminal prints the transaction serial
number, the dollar and cents keyboard entry, and track data as shown in
Figure 3-2. Also, the deposit printer can print the standard characters in the
ASCII range of 20 through 5D (Table 4-88).
The dollar and cents keyboard entry is the dollar amount entered by the
consumer. This field is 12 characters long.
3-18
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
The terminal prints the amount (without leading zeros) flush left in the field.
The terminal does not print the decimal point. If the amount does not fill the
field, trailing blanks (space characters) are added.
Track data contains the first 20 Track 2 data characters (after the start sentinel)
read off the card while the ix/CSP Series terminal was in the Card Read state. If
Track 2 is not on the card, the first 20 Track 3 data characters (after the start
sentinel) are printed. If neither Track 2 nor Track 3 is on the card, or if neither is
readable, the first 20 Track 1 data characters (after the start sentinel) are printed.
An ix/CSP Series terminal can print data sent by the network on the deposit
envelope, instead of the default data. A maximum of 55 characters can be printed
on a single line of the deposit envelope. If you have an IDM, 100 characters can
be printed. Refer to Section 5.5 and Section 5.6 for more information on sending
network deposit printer data to an ix/CSP Series terminal.
g1959055
3-19
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Agilis 91x for ix/CSP can provide the text for printing on envelopes inserted into
the depository. The text can be generated by Agilis 91x for ix/CSP (default), or
the text can be provided by the network.
Default Text
If the deposit printer text is generated by Agilis 91xfor ix/CSP, the text includes
the transaction serial number, the deposit amount entered by the consumer, and
track data from the consumer’s card (Figure 3-3).
g5233014
The transaction serial number is the same four-digit transaction serial number
sent in the Function Command message. This number originates at the network
and identifies the transaction to the network.
The dollar and cents keyboard entry is the deposit amount entered by the
consumer. This field is 12 characters long. The terminal prints the deposit
amount (without leading zeros) flush left in the field. The terminal does not
print the decimal point. If the deposit amount does not fill the field, trailing
blanks (space characters) are added.
Track data contains the first 20 characters of track 2 data (not including the
start sentinel) read off the card while the terminal is in the Card Read state. If
track 2 is not on the card or is unreadable, the first 20 characters of track 3 data
(not including the start sentinel) are printed. If neither track 2 nor track 3 is on
the card, or if neither is readable, the first 20 characters of track 1 data (not
including the start sentinel) are printed.
3-20
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Print data programming is the same for all graphics-related strategies. This
section discusses the following aspects of print data programming:
You can select a character set anywhere within a line, thus allowing the terminal
to print characters from more than one character set on one line. The following
character sets are supplied with the standard Agilis 91x for ix/CSP system:
During Agilis 91x for ix/CSPinstallation, one of the preceding character sets
is designated the primary character set, one set is designated the first alternate
set, and one set is designated the second alternate set. For many systems, this
arrangement provides adequate flexibility to meet printing requirements. For
systems that require access to more than three character sets, the ESC s control
sequence (described in Section 3.12.2) provides access to all the character sets
defined for Agilis 91x for ix/CSP.
3-21
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-22
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-23
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-24
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-25
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-26
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-27
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-28
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-29
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-30
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-31
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-32
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-33
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-34
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-35
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-36
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-37
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-38
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-39
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-40
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-41
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3-42
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
The control sequences for the receipt and journal printers are shown in
Table 3-14. An ASCII and EBCDIC cross-reference for printer control sequences
is shown in Table 3-15.
NOTE
Table 3-14 Printer Control Sequences for Receipt and Journal Printers
LF Prints a line of characters, then does a carriage return and a line feed.
VT Enables the first alternate character set for one character. For details on use, refer to
Section 3.12.4.
FF For paper with a top-of-form mark, advances to top-of-form mark, then cuts and delivers the
form. For blank paper, does one or more line feeds (depending on configuration setting), then
cuts and delivers the form.
SO Fills an area with blanks (space characters). The character following SO defines the number of
blanks. The range for the character following SO is ASCII 31 through 3F (decimal 1 through 15).
ESC a n Sets the page alignment. The valid values for the parameter n are r (right alignment) and l (left
alignment). (Agilis 91x version 1.1 or later)
ESC B Prints the contents of the buffer specified by the one byte following the ESC B. Valid values are
@, and A through Z.
ESC c 0 [1] Disables text color printing (Agilis 91x version 1.1 or later)
ESC c 1 n [1] Enables text color printing. The parameter n specifies the color or shade. The range for n is ASCII
hex 30 (black) through 3F (white). For two-color paper, the values from 31 through 3E represent
varying shades of blue or red. (Agilis 91x version 1.1 or later)
3-43
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Table 3-14 Printer Control Sequences for Receipt and Journal Printers (continued)
ESC I Prints the screen data specified by the three bytes following the ESC I. The three bytes identify a
screen number. Screens can be nested to five levels using ESC I.
ESC P For paper with a top-of-form mark, advances to top-of-form mark. For blank paper, does one
or more line feeds (depending on the Receipt Printer configuration setting). Does not cut or
deliver the form.
ESC Q Prints a scanned image from the Recognition Subsystem (RSS), typically a small region of a
check. This image is the contents of the most recent window processed by an IC state enable
operation (operation 000).
ESC R Prints a scanned image of an entire check. The parameter nnn specifies the length of the check
image in millimetres.
ESC R requires the installation of a scanner card and the Recognition Subsystem (RSS) software.
ESC s Selects a character set to use as the first alternate character set.
ESC 4 Enables the first alternate character set (more than one character). The first alternate character
set remains enabled until disabled by ESC 5 or ESC z 0, or until the end of the current block of
print data. For details on use, refer to Section 3.12.4.
ESC 5 Disables the first alternate character set. Resets printing to the primary character set.
ESC @ Resets printing to the primary character set, single-width printing, and the default horizontal
and vertical pitches.
3-44
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Table 3-14 Printer Control Sequences for Receipt and Journal Printers (continued)
ESC z 0 Disables the character set currently enabled (first alternate or second alternate). Printing reverts
to the character set previously enabled (primary, first alternate or second alternate). For details
on use, refer to Section 3.12.4.
ESC z 1 Enables the second alternate character set (more than one character). The second alternate
character set remains enabled until disabled by ESC z 0, or until the end of the current block of
print data. For details on use, refer to Section 3.12.4.
[1] Receipt printer only. Not applicable to the journal printer.
[2] Vertical and horizontal print pitches are specified as part of Agilis 91x installation, as are the pitch defaults. For Diebold ixSeries terminals,
the standard pitches are 6 LPI, 8 LPI, 10 CPI, 12 CPI, and 16 CPI.
CR 0D 0D
FF 0C 0C
LF 0A 15 or 25
SO 0E 0E
VT 0B 0B
ESC a 1B 61 27 81
ESC B 1B 42 27 C2
ESC C 1B 43 27 C3
ESC c 0 1B 63 30 27 83 F0
ESC c 1 1B 63 31 27 83 F1
ESC D 1B 44 27 C4
ESC E 0 1B 45 30 27 C5 F0
ESC E 1 1B 45 31 27 C5 F1
ESC I 1B 49 27 C9
ESC L 0 1B 4C 30 27 D3 F0
ESC L 1 1B 4C 31 27 D3 F1
ESC N 0 1B 4E 30 27 D5 F0
ESC N 1 1B 4E 31 27 D5 F1
ESC P 1B 50 27 D7
ESC Q 1B 51 27 D8
ESC R 1B 52 27 D9
ESC s 1B 73 27 A2
ESC T 1B 54 27 E3
ESC U 0 1B 55 30 27 DC F0
ESC U 1 1B 55 31 27 DC F1
ESC $ 1B 24 27 5B
3-45
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
ESC % 1B 25 27 6C
ESC & 1B 26 27 50
ESC ’ 1B 27 27 7D
ESC ( 1B 28 27 4D
ESC ) 1B 29 27 5D
ESC 4 1B 34 27 F4
ESC 5 1B 35 27 F5
ESC @ 1B 40 27 7C
ESC W 0 1B 57 30 27 E6 F0
ESC W 1 1B 57 31 27 E6 F1
ESC Z 0 1B 5A 30 27 E9 F0
ESC Z 1 1B 5A 31 27 E9 F1
ESC z 0 1B 7A 30 27 A9 F0
ESC z 1 1B 7A 31 27 A9 F1
General Characteristics
Each line must end with a CR or LF control character. Agilis 91x does not
automatically insert line breaks.
ESC D
The ESC D control sequence is used to print data contained in files stored at the
terminal. For the receipt printer, these files can be PCX-format graphic files,
PCX-format logo files, WIN32 bitmap files, or plain text files.
Starting with Agilis 91x (XV) version 1.1 and Agilis 91x for Opteva version
1.2.1, the ESC D control sequence can be used for the journal printer as well.
However, only plain text files can be used with ESC D when printing to the
journal printer.
The characters that immediately follow the ESC D are the file name, including
the extension. The file name must be terminated by a semicolon ( ; ). For receipt
printers, the file specified by the ESC D control sequence must be in the directory
\DIEBOLD\TCS\cp\thpr. For journal printers, the file specified by the ESC D
control sequence must be in the directory \DIEBOLD\TCS\jp.
3-46
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
• Version 4 header
• Non gray-scaled: Monochrome, 16 colors, or 256 colors
• Gray-scaled: 16 shades or 256 shades
The maximum size of the graphic that can be printed depends on the specific
printer and XFS SP. Refer to the documentation provided with the printer.
Any file with an extension other than .PCX, .LCX, or .BMP is treated as a
text file. Text files must contain only printable text data and line termination
characters.
Printing graphic files, logo files, or text files containing line feeds increments the
Agilis 91x line count by one.
ESC I
Agilis 91x can combine the text received in the Printer Data field of the Function
Command message with text stored as screen data in terminal memory. The text
stored as screen data is called configured text. When the network configures the
terminal, the network downloads both consumer display screens and configured
text screens in Write Command 2 messages.
The valid range for screen numbers is decimal 000 through 511. Each screen can
contain a maximum of 500 characters.
To print the configured text contained in a screen, the network includes the ESC
I control sequence and the three-digit screen number in the Printer Data field
of the Function Command message. The ESC I control sequence can be used
anywhere within a line, which allows both Function Command message text and
configured text to be printed on one line.
If a screen contains control characters that are not valid printer control sequences
as described in this section, the terminal cannot print the screen. Agilis 91x might
not report the error to the network.
The ESC I control sequence is allowed within the configured text. Including
an ESC I control sequence in the configured text causes Agilis 91x to insert
configured text from a second screen into the printer data from the first screen.
This technique is referred to as nesting. Agilis 91x allows up to five levels of
nesting. However, nesting should be kept to a minimum because each level
uses up additional system resources.
If one of the screens contains an ESC Q control sequence, the fifth level of
nesting is discarded.
3-47
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
ESC L
The ESC L 1 control sequence enables landscape mode. Landscape mode
rotates printing 90 degrees clockwise.
Pass-through mode (ESC N) cannot be used while in landscape mode. All other
control sequences are permitted while in landscape mode.
The maximum number of lines of text and the maximum number of text
characters per line that can be printed in landscape mode depend on the printer
and on the size of the paper. Refer to the documentation provided with the printer.
ESC N
The ESC N control sequence allows the host to send raw printer data and control
sequences to the printer. This technique is called pass-through mode because
the print data passes through Agilis 91x without any filtering or processing of
the print data.
NOTE
When ESC N 1 is used, it must be the first three bytes in the block of print
data. The pass-through data is terminated by an ESC N 0 control sequence (in
non-expanded ASCII format) or by the end of the print data block (a block
corresponds to one printer data field in a host message). If the ESC N 0 control
sequence is included in the print data, ESC N 0 must be the last three bytes in
the print data block. Therefore, pass-through mode data and normal mode data
cannot be included in the same block of print data.
NOTE
If line feed or form feed control sequences are sent to the printer
in pass-through mode, Agilis 91x cannot update the line count
properly. The host programmer using pass-through mode is
responsible for counting lines and ensuring proper form length.
3-48
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
ESC R nnn
The parameter nnn specifies the length of the check image in millimetres (000 to
106). All scaling is done proportionally, horizontally and vertically. Due to the
granularity of the scaling algorithm, the actual image is only an approximation
of the requested size. If a length greater than 106 is requested, the largest
available image is printed.
Typically, landscape mode (ESC L) is used for printing the check image.
Landscape orientation allows the image of the check to be printed as large as
possible on the receipt. To print the scanned image in landscape mode, the ESC
L 1 control sequence must precede the ESC R nnn control sequence. The ESC
L 0 control sequence must follow the ESC R nnn to take the printer out of
landscape mode. If it is desired to have text printed in landscape mode along
with the check image, the text can be placed anywhere between the ESC L 1
control sequence and the ESC L 0 control sequence.
NOTE
The check image can also be printed in portrait mode. In this case, the image
is scaled so that the length of the check image does not exceed the width of
the printable area on the paper. In portrait mode, the length parameter (nnn)
is ignored.
ESC s
The ESC s control sequence selects a character set to temporarily function as the
first alternate character set, in place of the first alternate character set specified
during Agilis 91x installation. The characters that immediately follow ESC s are
the map filename, including the extension, for the desired character set. The map
filename must be terminated by a semicolon ( ; ). The character set selected
remains in effect until the end of the current block of print data.
The following list shows the map filename for each of the standard character sets:
3-49
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
• Hungarian/Latin - HUNLATIN.MAP
• Turkish - TURKISH.MAP
• Hebrew - HEBREW.MAP
• Arabic - ARABIC.MAP (or ARAB1017.MAP, or ARAB1217.MAP)
• Arabic Script - ARABSC12.MAP
• Lithuanian - LITHUANI.MAP
• Code Page 850 - CP850.MAP (or CP850U.MAP)
ESC s does not enable the character set for printing. The VT or ESC 4 control
sequences must be used to enable the first alternate character set. For details on
how to use the ESC s control sequence, refer to Section 3.12.4.
ESC T
The ESC T control sequence allows the host to send print data that exceeds the
maximum Agilis 91x receive buffer size. The print data can be split into two
blocks. The two blocks of print data are then sent to the terminal in two separate
Function Command messages. The first block of print data must end with a
line feed, if the data is not pass-through data. The second block of data must
begin with ESC T.
3-50
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
3.12.3 Control Sequences for Statement Printers (Agilis 91x for Opteva only)
The control sequences for the statement printer are shown in Table 3-16.
VT n 0B n Enables the first alternate character set for one character. The
parameter n specifies the character of the alternate character set to
be printed.
LF 0A Prints a line of text, then does a carriage return and a line feed.
CR 0D Moves the horizontal print position to the left margin of the current
line. Does not print a line of text.
Any print data that follows the CR character overlays print data
already in the print buffer, replacing the existing data byte for byte.
ESC $ n1 n2 1B 24 n1 n2 Sets the horizontal print position to an absolute value. The position is
determined by the following formula:
ESC ( V STX NUL n1 n2 1B 28 56 02 00 n1 n2 Sets the vertical print position to an absolute value. The position is
determined by the following formula:
ESC ( v STX NUL n1 n2 1B 28 76 02 00 n1 n2 Sets the vertical print position to a relative value. The position is
determined by the following formula:
3-51
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
ESC ( ^ n 1B 28 5E n Prints the character n from IBM Code Page 850. The parameter n is a
single byte whose value can range from 00 through FF hexadecimal.
ESC 3 n 1B 33 n Sets the vertical pitch to 203/n LPI (n/203-inch line spacing).
ESC 6 1B 36 Enables the first alternate character set (more than one character).
The first alternate character set remains in effect until disabled by
ESC 7 or ESC z 0, or until the end of the end of the current block of
print data.
ESC 7 1B 37 Disables the first alternate character set. Resets printing to the
primary character set.
ESC @ 1B 40 Initializes the printer. This command does not cause any motion
of the paper or the cutter.
ESC a n 1B 61 n Sets the page alignment. The valid values for the parameter n are r
(right alignment) and l (left alignment).
ESC c 1 n 1B 63 31 n Enables text color printing. The parameter n specifies the color or
shade. The range for n is ASCII hex 30 (black) through 3F (white).
For two-color paper, the values from 31 through 3E represent varying
shades of blue or red.
ESC D 1B 44 Prints the specified file. Refer to the description of the ESC D control
sequence for the receipt and journal printers. For statement printers
the specified file must be in the directory \DIEBOLD\TCS\sp.
ESC R nnn 1B 52 nnn Prints a scanned image of an entire check from the Recognition
Subsystem (RSS). The parameter nnn specifies the length of the
check image in millimetres.
3-52
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
ESC u 1 n 1B 75 31 n Begins a Unicode encoding block. The following values have been
defined for n:
• 7- UTF-7
• 8 - UTF-8
• b - UTF-16, big endian
• l - UTF-16, little endian
ESC \ n1 n2 1B 5C n1 n2 Sets the horizontal print position to a relative value. The position is
determined by the following formula:
ESC e n 1B 65 n Sets the top margin. The parameter n specifies the distance in
millimetres from the top of the form to the first printed line. The valid
range for n is 1 to 254.
ESC l n 1B 6C n Sets the left margin to column n using the current horizontal pitch to
determine column width. The valid range for n is 1 to 200.
ESC s 1B 73 Selects a character set to use as the first alternate character set. For
details on use, refer to Section 3.12.4.
ESC z 0 1B 7A 30 Disables the character set currently enabled (first alternate or second
alternate). Printing reverts to the character set previously enabled
(primary, first alternate, or second alternate). For details on use,
refer to Section 3.12.4.
ESC z 1 1B 7A 31 Enables the second alternate character set (more than one
character). The second alternate character set remains enabled until
disabled by ESC z 0, or until the end of the current block of print data.
For details on use, refer to Section 3.12.4.
3-53
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
During Agilis 91x installation, one character set is designated the primary
character set, one set is designated the first alternate set, and one set is designated
the second alternate set. For systems that require access to more than three
character sets, the ESC s control sequence provides access to all the character
sets defined for Agilis 91x.
• Emphasis (bold)
• Underline
• Double height
• Double width
1. Enable the first alternate character set using the VT control character.
2. Specify the character of the first alternate character set using the
appropriate ASCII or EBCDIC code.
The printer automatically reverts to the primary character set after printing the
single character of the first alternate character set. An example of this procedure
is shown in the following table.
20 ASCII code for the first character in the first alternate character set
3-54
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
To print several characters from the first alternate character set, use the ESC 4
control sequence, as in the following procedure:
1. Enable the first alternate character set using the ESC 4 control sequence.
2. Specify the characters of the first alternate character set by using the
appropriate ASCII or EBCDIC code.
3. Revert to the primary character set using the ESC 5 control sequence.
20 ASCII code for the first character in the first alternate character set
21 ASCII code for the second character in the first alternate character
set
22 ASCII code for the third character in the first alternate character set
23 ASCII code for the fourth character in the first alternate character set
NOTE
1. Enable the second alternate character set using the ESC z 1 control
sequence.
2. Specify the characters of the second alternate character set by using the
appropriate ASCII or EBCDIC code.
3. Revert to the primary character set by using the ESC z 0 control sequence.
20 ASCII code for the first character in the second alternate character
set
3-55
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
22 ASCII code for the third character in the second alternate character
set
23 ASCII code for the fourth character in the second alternate character
set
1. Select the desired character set. Use ESC s with the appropriate map
filename to temporarily designate this character set as the first alternate
character set. (Refer to the description of ESC s in Section 3.12.2 for a
list of map filenames for the primary character sets.)
3. Specify the characters of the first alternate character set by using the
appropriate ASCII or EBCDIC code.
4. Revert to the primary character set using the ESC 5 control sequence.
20 ASCII code for the first character in the first alternate character set
21 ASCII code for the second character in the first alternate character
set
22 ASCII code for the third character in the first alternate character set
23 ASCII code for the fourth character in the first alternate character set
Miscellaneous Comments
You can enable a character set anywhere within a line, thus allowing the terminal
to print characters from the primary character set and one of the alternate
character sets on one line.
3-56
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Table 3-17 describes the standard format illustrated in Figure 3-4. Table 3-18
shows a breakdown of the actual printer data required to produce the example
receipt.
g5233029
3-57
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
Date 1 The actual date in the format MM/DD/YY b/b/, where MM = month, DD = day, and YY = year
( b/ is a space)
Time 1 The time in the format HH:MM b/b/, where HH = hours and MM = minutes
Courtesy Message 5-7 This area consists of the three lines (with a maximum of 25 characters per line) that contains
a courtesy message
Business Date 9 The institution’s business date in the format MM/DD/YY b/b/, where MM = month, DD = day,
and YY =year
Code 12 - 17 For each transaction, Code contains the Transaction Code and Error Code in the format TTEE b/,
where TT = Transaction Code and EE = Error Code. Any additional (non-standard) characters
must be printed on subsequent lines
Serial 12 - 17 For each transaction, Serial contains the Transaction Serial Number sent in the Function
Command message in four contiguous characters plus four blanks
Amount 12 - 17 For each transaction, Amount contains the transaction’s amount in 13 contiguous characters
(including decimal point) for a maximum value of 9999999999.99
3-58
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
SO 4 THANK b/ YOU b/ FOR 0E 34 54 48 41 4E 4B 20 59 4F 55 20 The SO control character specifies that the number
46 4F 52 following the character (4 in this case) is the desired
number of spaces. Following the 4 spaces is the first line
of the courtesy message
SO 7 WITH b/ US 0E 37 57 49 54 48 20 55 53 Seven spaces, then the last line of the courtesy message
3-59
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ix Series Terminals and Devices
If both the receipt printer and the journal printer use a graphics-related strategy,
the same print data can be used to print transaction information on both the
receipt and the journal printer roll. The transaction entry on the journal printer
roll would then look exactly like the printed receipt with two exceptions. First,
for journal printers, Agilis 91x does not execute line feeds (LF control characters)
for lines that do not contain information. Second, for journal printers, Agilis 91x
converts a form feed (FF control character) to the deliver request string defined
during Agilis 91x installation (typically, a single line feed). This causes the
journal printer to print the data in Table 3-18 as shown in Figure 3-5.
g5233030
Figure 3-5 Journal Printer Roll Created Using Standard Format Receipt Data
3-60
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Section 4
Configuration Data
All configuration data is loaded into the terminal using Write Command
messages. Configuration data is divided into the following four categories:
• States - State tables direct the terminal to the tasks to be performed during
each part of a transaction.
• Screens - Screen data contains display, control, and delimiter characters for
different screens that must be shown during different parts of a transaction.
4-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Buffers
4.1 Buffers
Buffer ID Use
A (065) Dollar
M (077) Reserved
U (085) OAR
257 Reserved
NOTE
Buffer IDs 343 through 354 are reserved for use with the
Provisor Currency Module (PCM) (CashSource Plus 400P
only)
343 ID number
4-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Buffers
Buffer ID Use
355 Reserved
The enhanced buffers (256 through 355) can be used by many of the Agilis 91x
for ix/CSP states and messages, but not by all of the states and messages. To
determine if a particular state or message can use the enhanced buffers, refer to
the detailed description of the state or message in question.
4-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command Messages Overview
The following Write Command messages are used to load configuration data:
All the message tables in this manual use the notation conventions set forth
in Table 4-1.
4-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command Messages Overview
Notation Description
X The letter X in the Data column indicates that the terminal ignores
the data. The data for this field must be a valid character as
described in this manual. An example of invalid data for this
notation is a null character (hex 00).
- - - Three dashes in the Data column indicate that the data is dependent
on the specific transaction performed and the range of valid values
for the field. Refer to the field descriptions in this manual.
Variable The term Variable indicates that the length or the content of the
field is variable. In the Data field, the term Variable indicates
that the data is not necessarily character based. In the Number
of Characters field, if a number in parentheses follows the term
Variable, that number indicates the maximum number of characters
allowed in the field.
[ ] Brackets indicate that the field is optional. The field can be deleted
completely from the message without affecting the format or
meaning of the message. If the field is present in the message,
the data for this field must be a valid character as described in
this manual. An example of invalid data for this notation is a null
character (hex 00).
All the Write Command messages have some common fields (Table 4-2). The
remainder of the Write Command messages fields are described with each
individual Write Command message.
[ Response Flag ] [ X ] [ 1 ]
Modifier - - - 1
This is the area where fields specific to each Write Command messages are
placed. These fields are described with each specific Write Command.
4-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command Messages Overview
Write Identifier
Field Size: 1 character
Valid Range: 1 through 3
Description: This one-character data field tells the terminal that configuration
data follows. The valid value is ’1’.
Modifier
Field Size: 1 character
Valid Range: Refer to the description field
Description: This one-character field identifies the type of configuration data
to follow. If the Write Identifier is 1 (configuration data), the valid values
are as follows:
• 1 - Screens
• 2 - States
• 3 - LUNO, miscellaneous parameters, timers
• 5 - FITs
• 6 - Configuration ID
• ; - EMG icon definition data
• < - EMG font definition data
4-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 1 Message (States)
If the Write Identifier is 3 (encryption key change), this field tells the terminal
which key(s) to use for encryption and message authentication.
This message is used to load state tables into terminal memory. The maximum
message length for this command is 1920 characters from header to ETX.
Because of message length limit, transmission of state tables might occur in
several messages. Each message contains a portion of the state tables. There are
two different types of states, 9000-style states and enhanced states.
Each state is associated with a specific task. For example, while the terminal is in
the Select Function state, the terminal is dedicated to the task of prompting the
consumer to select a function and recognizing the key (function) selected. Only
those subroutines and hardware components (such as Consumer Display and
Keypad) that facilitate function selection are used.
The terminal requires the repeated use, in different ways, of some states. For
instance, the consumer must select the type of transaction (deposit, withdrawal,
inquiry, or other) and later they must select the type of account. Both tasks are
performed using different versions of the Select Function state.
Each state type can have one or more state tables associated with it. Each state
table, of the same state type, is a different version of that state providing the same
type of functions, but used in a different manner. The different state tables are
specified by a three-digit number.
9000 States
Each 9000-style state table has nine entries in it. A state table is 25 characters
long (first entry, which is one character long, plus eight three-digit entries).
The entries are as follows:
• The first entry in a state table is a single character that identifies the type of
state (ASCII graphic character).
• The other eight entries specify the actions performed (such as screen
displayed, buffers used and next state table) and are three characters long.
NOTE
4-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 1 Message (States)
The terminal can use one state type several times while processing a transaction.
Depending upon the transaction that the consumer has requested, other state
types might not be used at all. The use of these state types, in any order, defines
terminal operation. 9000-style states are described in Section 4.4.
Enhanced States
There are a number of enhanced states that Agilis 91x for ix/CSP can use in
addition to the 9000-style states. These enhanced states can be used with the
9000-style states to increase the flexibility of the terminal. Unlike the standard
9000-style states which are a fixed length, the enhanced states format and length
are specific to their purpose. Enhanced states are described in Section 4.5.
For Agilis 91x for ix/CSP, the valid range of state numbers is 000 through 254,
256 through 999, and A00 through ZZZ.
The Write Command 1 Message Format is shown in Table 4-3. The fields
common to all Write Command messages are shaded. Only the fields specific to
the Write Command 1 message are described here.
[ Response Flag ] [ X ] [ 1 ]
Modifier (States) 2 1
4-8
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 1 Message (States)
State Number - - - 3
State Data - - - 25
The following paragraphs describe the fields specific to the Write Command 1
message.
State Number
Field Size: 3 characters
Valid Range: Valid state numbers (Section 4.3.1)
Description: This is a three-character field that identifies the state number for
the state data that follows this field.
State Data
Field Size: Variable
Valid Range: Refer to the description
Description: The first entry identifies the state type. The rest of the characters
are associated state data (Section 4.4 and Section 4.5).
NOTE
MAC Data
Field Size: 8 characters
Valid Range:
Description: This eight-character field contains hexadecimal characters that
represent the MAC calculation of the Consumer Request message. Refer to
the Data Security Procedures and Reference Manual (TP-799530-001D) for
additional details.
4-9
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Card Read A Reads magnetic stripe on the consumer’s card and stores the data. Usually points
to a PIN Entry state as the next state.
PIN Entry B Reads the four-digit PIN entered by the consumer and verifies that the PIN entered
is valid. Usually points to a Clear Keys state as the next state.
Deposit (for envelope C If the terminal is equipped with an envelope dispenser, the terminal dispenses an
depository) envelope, if one is requested by the consumer. If there is no envelope dispenser,
the terminal goes immediately to the next state.
Deposit (for IDM) C Tells the terminal how to handle a deposit operation.
Clear Keys D Clears and sets any or all 8 bytes of the function key buffer.
Select Function E Reads the code of each function key pressed by the consumer. The key codes are
stored in the function key buffer. The next state varies depending on the consumer’s
selection.
Dollar Entry F Reads a transaction amount, displays that amount on the consumer display, and
stores the amount in the dollar buffer. If a withdrawal transaction is being processed,
typically a Cent Check state is the next state, if the terminal does not have a coin
dispenser. Otherwise, a Clear Keys state is typically the next state.
Cent Check G Verifies that the transaction amount entered by the consumer is a whole-dollar
amount (zero cents). If the amount entered by the consumer is not a whole-dollar
amount, the next state is always determined by the network configuration.
Otherwise, a Clear Keys state is typically next.
Information Entry H Reads in a variable-length string of numerical keys and stores that data in a general
purpose buffer. Optionally, the terminal displays the data on the consumer display. If
the consumer presses the Cancel key, a function key, or times out during data entry,
the input string is terminated. The next state depends on the consumer’s input.
Transaction Request I Sends a Consumer Request message to the network and executes the function
commands received from network. The next state depends on the network response.
Close J Returns or retains the consumer’s card and optionally issues a printed receipt to the
consumer. Typically, the next state table used is 000 (a Card Read state preparing
the terminal for the next consumer).
Indirect Next K Used to modify selection paths based on FIT table entry and institution type. The
terminal can use customized state tables for a specific institution’s consumers. The
terminal can provide different functions to different consumers depending on the
consumer’s institution.
Card Write L Writes the current contents of a track data buffer onto the magnetic stripe of the
consumer’s card. The next state is usually a Close state.
Set Dollar Buffer R The Set Dollar Buffer state is typically used for fast cash transactions. In a fast cash
transaction, the consumer uses a function key to choose both the transaction and
the amount instead of entering the amount through the numeric keys of the keypad.
After the consumer selects the fast cash transaction, the Set Dollar Buffer state is
used to automatically place the appropriate amount in the Dollar Buffer.
Card Read (non-000 T This Card Read state is used if the application needs the Card Read state to be
state applications) numbered something besides 000.
4-10
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Check Track Buffer Z The Check Track Buffer state examines track data to define the terminal’s
personality for the current consumer. The state provides conditional branching of the
state table sequence and can change the index for Indirect Next state processing.
(This index is initially set to the value of the PSTDX from the FIT identified during
the Card Read state.)
Voice ; The Voice state can be used to turn the Voice feature on and off. Turning voice
off aborts any message in progress, purges any messages pending in the delay
queue, and idles the device. If the Voice feature is turned off by this state, the only
way to turn the Voice feature back on, without resetting the terminal, is to execute
another Voice state. The Voice state can also be used to turn on the Voice Keypad
Feedback feature.
Copy Buffer = Split deposits and any other operations requiring more than one Dollar Entry state
are supported by the Copy Buffer state. By following Dollar Entry states with Copy
Buffer states, and by changing the appropriate entry in the Transaction Request
state, up to three transaction amounts can be included in the Consumer Request
message without requiring changes to the format of that message.
Function Key > The Function Key Extension state extends the B, D, E, F, H, and I state tables to
Extension support the use of the F, G, H, I, J, K, L, and M function keys.
Withdrawal Area ? The Withdrawal Area Sensors state provides additional control of a dispense
Sensors operation. This state directs the terminal to check the withdrawal area sensors and
modify the transaction sequence based on the result.
Set Language Bank [ The Set Language Bank state is used to select the appropriate language bank to
use for screen retrieval when supporting the Multilingual Feature.
Buffer Arithmetic \ The Buffer Arithmetic state adds or subtracts ASCII decimal buffers.
4-11
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Card Read state table is usually the first state table used during transaction
processing. This state table is normally assigned state number 000. The terminal
enters state number 000 automatically when it goes in-service.
• Defines the card track(s) from which data is read (Table 4-6)
• Contains a flag for the card return feature (immediately or at the end
of the transaction)
• Points to the next state number for cards that are read properly
• Scans the FIT tables to obtain a match on the Financial Institution Number
Refer to Table 4-5 for the Card Read state table format.
1 State Type A
State Type
Entry Number: 1
Valid Data Range: A
Description: This state ID identifies this state table as a Card Read state table.
4-12
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Screen Number
Entry Number: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: This is the number of the screen displayed. This screen prompts
the consumer to insert a card. This screen is displayed while the terminal is
awaiting card entry.
Read Condition 1
Entry Number: 5
Valid Data Range: The following values are valid for this entry:
• 001 - 3 only
• 002 - 2 only
• 003 - 2 and 3
• 004 - 1 only
• 005 - 1 and 3
• 006 - 1 and 2
• 007 - 1 and 2 and 3
• 008 through 015 - Reserved for future use
Description: This is one of the three entries (used with entry numbers 6 and 7)
that tell the terminal which card track(s) must be read correctly. This is the first
read condition. If this condition cannot be met, read condition 2 is used next.
Refer to Table 4-6 for example values for the Read Condition entries.
Read Condition 2
Entry Number: 6
Valid Data Range: Same as Read Condition 1
Description: This is one of the three entries (used with entry numbers 5 and
7) that tell the terminal which card track(s) must be read correctly. This is the
second read condition used. This one is used if read condition 1 cannot be done.
If read condition 2 cannot be met, read condition 3 is used. Refer to Table 4-6
for example values for the Read Condition entries.
Read Condition 3
Entry Number: 7
Valid Data Range: Same as Read Condition 1
Description: This is one of the three entries (used with entry numbers 5 and 6)
that tell the terminal which card track(s) must be read correctly. If neither read
condition 1 or read condition 2 can be met, this read condition is used. Refer to
Table 4-6 for example values for the Read Condition entries.
4-13
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Required Track(s) Card Read Table Entry Card Read Table Entry Card Read Table Entry
5 (Read Condition 1) 6 (Read Condition 2) 7 (Read Condition 3)
4-14
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The PIN Entry state prompts the consumer to enter a PIN and shows Xs for each
PIN digit entered.
FIT determines if the terminal performs PIN verification (local PIN verification)
or the network performs PIN verification (remote PIN verification). If local
PIN verification is done, the terminal does not use state entry 8. If remote PIN
verification is used, the terminal does not use state entry 5. For details on each
PIN verification method, refer to the Data Security Procedures and Reference
Manual (TP-799530-001D).
Refer to Table 4-7 for the PIN Entry state table format.
Entry Definition
1 State Type
2 Screen Number
State Type
Entry Number: 1
Valid Data Range: B
Description: This state ID identifies this state table as a PIN Entry state table.
Screen Number
Entry Number: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: This is the number of the screen displayed that prompts the
consumer to enter a PIN. This screen is displayed when the terminal enters
the PIN Entry state. This screen must position the cursor at the beginning of
the X display area.
4-15
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
PIN Retry
Entry Number: 9
Valid Data Range: 000 through 009
Description: This entry specifies the maximum number of times that a consumer
can enter an incorrect PIN (if local check) before the terminal goes to the
state specified by state entry 6. An entry on the card can override this entry
if specified by FIT.
4-16
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Deposit state supports networks that have a mix of TABS terminals and
Agilis 91x for ix/CSP terminals, where the C state is needed to unlock the
depository door on a TABS terminal.
On Agilis 91x for ix/CSP terminals equipped with an envelope dispenser, this
state displays reserved screen 910, asking the consumer if they require an
envelope. If the consumer presses a Yes key, the envelope dispenser dispenses a
single envelope without waiting. If a No or Cancel key is pressed, no envelope is
dispensed. In either case, the terminal proceeds to the next state specified in
state entry 2. If the envelope dispenser is not operational, reserved screen 913 is
displayed to inform consumers that envelopes are not available and that they can
cancel the transaction if they do not want to continue.
On Agilis 91x for ix/CSP terminals without an envelope dispenser, the terminal
goes immediately to the state specified by the Next State entry.
Entry Definition
1 State Type
2 Next State
3 - 9 Reserved
State Type
Entry Number: 1
Valid Data Range: C
Description: This state ID identifies this state table as a Deposit state table.
Next State
Entry Number: 2
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: The number of the state the terminal goes to when C state
processing is complete.
Reserved
Entry Number: 3 through 9
Valid Data Range: 000
Description: Entries 3 through 9 are reserved and must be 000.
4-17
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
4.4.4 Deposit State (C) for IDM (terminals with IDM only)
The Deposit state tells the terminal how to process a deposit operation on
terminals equipped with an IDM.
Entry Definition
1 State Type
3 Screen Number
6 Operation
7 Deposit Bin ID
8 Image Capture
9 Reserved
State Type
Entry Number: 1
Valid Data Range: C
Description: This state ID identifies this state table as a Deposit state table.
Screen Number
Entry Number: 3
Valid Data Range: Valid screen numbers (Section 4.6)
Description: The number of the screen to display during the state. If the value in
this entry is 000, the terminal does not change the screen currently showing.
4-18
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
This exit is also used if the consumer presses the Cancel key before inserting a
check or envelope during a check or envelope deposit operation, if the Deposit
Extension state is not used.
Operation
Entry Number: 6
Valid Data Range: 000 through 004
Description: This entry tells the terminal which Deposit operation to perform.
The valid values are as follows:
If this operation is used, the only other applicable entries are Good Next
State and Fault Next State. All other field entries must be set to 000.
• 002 - Deposit check to escrow. This operation is intended to be the first step
of a check deposit. If there is no check or other document in escrow, the
terminal enables the IDM to perform the following operations:
4-19
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
• 003 - Retain check. The terminal moves the check or other document
from the escrow position to the deposit bin specified in the Deposit Bin
ID entry. The terminal does not do any printing on the check or document
during this operation.
• 004 - Return check with printing. The terminal moves the check or other
document from the escrow position to the entry slot of the depository, to
allow the consumer to retrieve the check or document.
If there is data in the Depository Printer Data buffer (buffer Q), the terminal
prints this data on the check or document. If there is no data in buffer Q,
the terminal prints the default data. If no printing is desired, buffer Q
must contain all spaces.
Deposit Bin ID
Entry Number: 7
Valid Data Range: 000 through 003 (subject to the capabilities of the depository)
Description: The Deposit Bin ID tells the terminal in which bin to place a deposit.
If the operation specified is 000, this entry must be 000. If any of the operations
001 through 004 are selected, the range for this value is 000 through 003.
4-20
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Image Capture
Entry Number: 8
Valid Data Range: 000, 001, 003, 005, and 007
Description: This entry is applicable only if operation 002 is selected. The
specified value determines which images, if any, are to be taken from the
document. Valid values are based on a bitmap whose bits are defined as follows:
• Bit 2:
• Bit 1:
• Bit 0:
For IDM operation, the value of bits 2 and 1 is ignored. Bit 0 must be set to
1 to perform document scanning. When bit 0 is set to 1, the IDM scans both
the top and the bottom of the document. When the specified operation includes
printing, the side of the document that is printed depends on the physical location
of the deposit printer, rather than the setting of bit 2.
Reserved
Entry Number: 9
Valid Data Range: 000
Description: The terminal does not use this entry.
4-21
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Function Key buffer is eight bytes long. The Clear Keys state can do any
combination of the following functions.
• Clear the Function Key buffer or clear selected bytes of the Function
Key buffer.
Each bit of the masks in this state represents a byte (buffer position) in the
Function Key buffer. Bit 0 of the mask represents the first byte. Bit 7 of the mask
represents the eighth byte.
Refer to Table 4-10 for the Clear Keys state table format.
Entry Definition
1 State Type
2 Next State
3 Clear Mask
4 A Preset Mask
5 B Preset Mask
6 C Preset Mask
7 D Preset Mask
8 Reserved
9 Reserved
State Type
Entry Number: 1
Valid Data Range: D
Description: This state ID identifies this state table as a Clear Keys state table.
Next State
Entry Number: 2
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: The number of the state the terminal goes to after clearing or
presetting the function key buffer.
Clear Mask
Entry Number: 3
Valid Data Range: 000 through 255
Description: Specifies bytes of function key buffer to be cleared to graphic
"space." Each bit relates to a byte in the function key buffer. Bit 0 relates to the
first entry. Bit 7 relates to the eighth entry. If a bit is "zero," the corresponding
entry is cleared. If a bit is "one," the corresponding entry is unchanged. Set this
entry to 255 if none of the Function Key Buffer positions are to be cleared.
4-22
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
A Preset Mask
Entry Number: 4
Valid Data Range: 000 through 255
Description: Specifies bytes of function key buffer to be set to A. Each bit
relates to a byte in the function key buffer. Bit 0 relates to the first entry. Bit 7
relates to the eighth entry. If a bit is one, the corresponding entry is set to A. If
bit is zero, the corresponding entry is unchanged.
B Preset Mask
Entry Number: 5
Valid Data Range: 000 through 255
Description: Specifies bytes of function key buffer to be set to B. Each bit relates
to a byte in the function key buffer. Bit 0 relates to the first entry. Bit 7 relates to
the eighth entry. If a bit is one, the corresponding entry is set to B. If bit is zero,
the corresponding entry is unchanged.
C Preset Mask
Entry Number: 6
Valid Data Range: 000 through 255
Description: Specifies bytes of function key buffer to be set to C. Each bit relates
to a byte in the function key buffer. Bit 0 relates to the first entry. Bit 7 relates to
the eighth entry. If a bit is one, the corresponding entry is set to C. If bit is zero,
the corresponding entry is unchanged.
D Preset Mask
Entry Number: 7
Valid Data Range: 000 through 255
Description: Specifies bytes of function key buffer to be set to D. Each bit
relates to a byte in the function key buffer. Bit 0 relates to the first entry. Bit 7
relates to the eighth entry. If a bit is one, the corresponding entry is set to D. If
bit is zero, the corresponding entry is unchanged.
Reserved
Entry Number: 8 and 9
Valid Data Range: 000
Description: Entries 8 and 9 are reserved and must be 000.
EXAMPLE 1
Start with a Function Key Buffer that looks like the following:
Buffer B _ _ C _ _ D _
Byte 0 1 2 3 4 5 6 7
Weight 1 2 4 8 16 32 64 128
4-23
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
To clear buffer position 6 (byte 6), add the weights of the positions that you do
not want to clear and put that result in the Clear Mask entry (entry 3).
Buffer B _ _ C _ _ D _
Byte 0 1 2 3 4 5 6 7
Positions x x x x x x x
not cleared
not cleared
With 191 entered in entry 3, the resultant Function Key buffer would appear
as follows:
Buffer B _ _ C _ _ _ _
Byte 0 1 2 3 4 5 6 7
EXAMPLE 2
Assume that you want to set the Function Key buffer positions as follows:
• Positions 0 and 2 to A
• Positions 1 and 5 to B
• Position 3 to C
• Positions 4 and 7 to D
Buffer A B A C D B _ D
Byte 0 1 2 3 4 5 6 7
Weight 1 2 4 8 16 32 64 128
4-24
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
This state reads one function key, stores the key code in the function key buffer,
and then advances to the next state. This state permits the consumer to select one
function, from up to four functions displayed on the screen, by pressing one of
the active function keys. The state table data for this state type defines which of
the four function keys are to be active during this state.
NOTE
For detailed information about the Function Key Extension state, refer to
Section 4.4.22.
Refer to Table 4-11 for the Select Function state table format.
Entry Definition
1 State Type
2 Screen Number
State Type
Entry Number: 1
Valid Data Range: E
Description: This state ID identifies this state table as a Select Function state
table.
Screen Number
Entry Number: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: Number of the display screen that prompts the consumer to make
choice between two or more alternatives (transaction types, account names, and
so on). This screen is displayed upon entry into the selection function state
and must be aligned with the active function keys (table entry 5, 6, 7, and 8)
for proper operation.
4-25
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
4-26
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
_ _ _ _ _ _ _ _
0 1 2 3 4 5 6 7
4-27
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
This state reads the transaction amount entered by the consumer, displays it on
the consumer display, and saves the amount in the dollar buffer. This buffer is 8
or 12 bytes long. When in the Dollar Entry state, the consumer uses the function
to indicate whether the displayed amount is either correct or incorrect.
Refer to Table 4-12 for the Dollar Entry state table format.
Entry Definition
1 State Type
2 Screen Number
State Type
Entry Number: 1
Valid Data Range: F
Description: This state ID identifies this state table as a Dollar Entry state table.
Screen Number
Entry Number: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: Number of display screen that prompts an amount entry. This
screen is displayed upon entry into the Dollar Entry state.
4-28
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
NOTE
4-29
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
g1959024
g1959025
4-30
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
This state checks to verify if the transaction amount entered by the consumer is
a whole-dollar (zero cents) amount. This state must follow the Dollar Entry
state when a withdrawal transaction is being performed, if the terminal does
not have a coin dispenser.
Refer to Table 4-13 for the Cent Check state table format.
Entry Definition
1 State Type
4 - 9 Reserved
State Type
Entry Number: 1
Valid Data Range: G
Description: This state ID identifies this state table as a Cent Check state table.
Reserved
Entry Number: 4 through 9
Valid Data Range: 000
Description: Entries 4 through 9 are reserved and must be 000.
4-31
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
This state reads in a variable length string of numeric keys, saves the data in
one of two general purpose buffers (refer to table entry 9), and displays either
the data or X for each numeric key pressed. The input string is terminated by a
function key, Cancel key, or a time-out. General Purpose Buffers B and C are
variable in length. Maximum length is 32 bytes. When the terminal exits this
state, the specified buffer contains only the data from the numeric keys pressed
by the consumer. If no keys are pressed, then the buffer contains no data.
Refer to Table 4-14 for the Information Entry state table format.
Entry Definition
1 State Type
2 Screen Number
State Type
Entry Number: 1
Valid Data Range: H
Description: This state ID identifies this state table as an Information Entry
state table.
Screen Number
Entry Number: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: The number of the display screen that prompts the consumer for
key entry. This screen is displayed upon entry into the Information Entry state
and must leave the cursor at the beginning of the data or X display area.
4-32
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
• 000 - Display X for each numeric key pressed. Store keys in general
purpose buffer C.
• 002 - Display X for each numeric key pressed. Store keys in general
purpose buffer B.
4-33
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Transaction Request state tells the terminal what information to place in the
Consumer Request message, transmits the Consumer Request message to the
network, and waits for the network response. When the network responds with
a Function Command message, the terminal executes the function commands
contained in the message, and goes to the next state specified in the Function
Command message. If the network does not respond with a Function Command
message within the time specified by timer 03 (Section 4.23), the terminal goes
to the state specified in entry 3 of this state.
Refer to Table 4-15 for the Transaction Request state table format.
Entry Definition
1 State Type
2 Screen Number
State Type
Entry Number: 1
Valid Data Range: I
Description: This state ID identifies this state table as a Transaction Request
state table.
Screen Number
Entry Number: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: Number of the display screen displayed while the terminal transmits
a request to the network and waits for the associated Function Command
message. This is normally a PLEASE WAIT screen.
4-34
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
If the PIN is included in the message, the PIN is in encrypted form, based
on the applicable FIT entry.
4-35
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
4-36
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Close state terminates the consumer’s current terminal interface. This state
performs the following functions:
Also, if there is a check or other document held in escrow in the IDM at the start
of the Close state, Close state processing directs the IDM to retain the check or
document, without printing on the document.
In addition, if the terminal returns the card, and the consumer fails to remove the
card within the time period specified by timer 02 (Section 4.23), the terminal
automatically recaptures the card.
Entry Definition
1 State Type
3 Next State
6 - 9 Reserved
State Type
Entry Number: 1
Valid Data Range: J
Description: This state ID identifies this state table as a Close state table.
4-37
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Next State
Entry Number: 3
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: The state number the terminal goes to after the Close state
is completed.
Reserved
Entry Number: 6 through 9
Valid Data Range: 000
Description: Entries 6 through 9 are reserved and must be 000.
4-38
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Indirect Next state allows the terminal to follow an alternate sequence of
states and screens based on the Financial Institution Table (FIT) matched during
the Card Read state (A or T) or the FIT Check state (@B). Each FIT can specify
an index number, called the PSTDX. The Indirect Next state uses the PSTDX to
determine the next state to execute. For example, if the FIT matched during
the Card Read state specifies a PSTDX of 3, entry 5 of the Indirect Next state
indicates the next state number. Refer to the Data Security Procedures and
Reference Manual (TP-799530-001D) for a detailed explanation of FITs.
Refer to Table 4-17 for the Indirect Next state table format.
Entry Definition
1 State Type
2 - 9 Next State
State Type
Entry Number: 1
Valid Data Range: K
Description: This state ID identifies this state table as an Indirect Next state table.
Next State
Entry Number: 2 through 9
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: Entries 2 through 9 contain the number of the state that the terminal
goes to depending on the value in the PSTDX value of FIT. These entries are
defined as follows:
4-39
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Card Write state requires a card reader capable of writing on the specified
track of the magnetic stripe.
Entry 8 of the Card Read state must be 001 so that the terminal does not
immediately return the card.
The Card Write state writes the current contents of the track 1, track 2, or track 3
data buffer onto the magnetic stripe of the card if the track 1, 2, or 3 data buffer
contains one of the following items:
• Good track data (including both the start sentinel and the end sentinel) from
the most recently received Function Command message
If multiple tracks must be written, a Card Write state is necessary for each
track to be written.
Three next state exits are provided. One exit is taken after the write is completed
and verified by a card read. A second exit is taken if several write attempts fail
repeatedly. A third exit is used when the appropriate track buffer contains no
data. As a result, no writing is attempted.
NOTE
If, during a writing process, the card jams in the transport, the card might have to
be retained to clear the jam. In this case, the Bad Write Next State exit is taken.
The card reader status, indicating that a card was retained, is then sent.
Refer to Table 4-18 for the Card Write state table format.
Entry Definition
1 State Type
2 Screen Number
6 Track to Write
7 - 9 Reserved
4-40
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
State Type
Entry Number: 1
Valid Data Range: L
Description: This state ID identifies this state table as a Card Write state table.
Screen Number
Entry Number: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: Number of the screen displayed during the Card Write process.
Track to Write
Entry Number: 6
Valid Data Range: 0 through 3
Description: The track number the terminal should write to for a Card Write
operation. The valid values are as follows:
• 0 - Track 3 (default)
• 1 - Track 1
• 2 - Track 2
• 3 - Track 3
Reserved
Entry Number: 7 through 9
Valid Data Range: 000
Description: Entries 7 through 9 are reserved and must be 000.
4-41
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
This PIN Entry state is identical to PIN Entry (B) state described in Section 4.4.2.
The Dollar Buffer is a terminal buffer used to store the numeric characters
corresponding to the transaction amount requested by the consumer. The
standard Dollar Buffer contains 8 digits, but the terminal can be configured to
maintain a 12-digit buffer (using the Write Command 3 message in Section 4.23).
The Set Dollar Buffer state places a transaction amount in the Dollar Buffer. The
Set Dollar Buffer state is typically used for fast cash transactions. In a fast cash
transaction, the consumer uses the function keys to choose both the transaction
and the amount instead of entering the amount through the numeric keys.
After the consumer selects the fast cash transaction, the Set Dollar Buffer state
automatically places the appropriate amount in the Dollar Buffer.
Digits 1 and 2 are the least significant digits of the amount. Typically, for
terminal located in the U.S., these digits would represent the cents portion
of the transaction amount.
Refer to Table 4-19 for the Set Dollar Buffer state table format.
Entry Definition
1 State Type
2 Next State
3 Reserved
4 Digits 12 and 11
5 Digits 10 and 9
6 Digits 8 and 7
7 Digits 6 and 5
8 Digits 4 and 3
9 Digits 2 and 1
The Set Dollar Buffer state (R) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: R
Description: The State Type entry identifies this state table as a Set Dollar
Buffer state table.
4-42
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Next State
Entry Number: 2
Valid Data Range: Valid state table numbers
Description: The Next State entry specifies the state table that the terminal
processes after storing the transaction amount in the Dollar Buffer.
Reserved
Entry Number: 3
Valid Data Range: 000
Description: The terminal does not use this entry.
Digits 12 and 11
Entry Number: 4
Valid Data Range: 000 through 099
Description: The last two digits of the Digits 12 and 11 entry specify the digits to
place in positions 12 and 11, respectively, of the Dollar Buffer. If the Dollar
Buffer is configured to eight digits, enter 000.
Digits 10 and 9
Entry Number: 5
Valid Data Range: 000 through 099
Description: The last two digits of the Digits 10 and 9 entry specify the digits
to place in positions 10 and 9, respectively, of the Dollar Buffer. If the Dollar
Buffer is configured to eight digits, enter 000.
Digits 8 and 7
Entry Number: 6
Valid Data Range: 000 through 099
Description: The last two digits of the Digits 8 and 7 entry specify the digits to
place in positions 8 and 7, respectively, of the Dollar Buffer.
Digits 6 and 5
Entry Number: 7
Valid Data Range: 000 through 099
Description: The last two digits of the Digits 6 and 5 entry specify the digits to
place in positions 6 and 5, respectively, of the Dollar Buffer.
Digits 4 and 3
Entry Number: 8
Valid Data Range: 000 through 099
Description: The last two digits of the Digits 4 and 3 entry specify the digits to
place in positions 4 and 3, respectively, of the Dollar Buffer.
Digits 2 and 1
Entry Number: 9
Valid Data Range: 000 through 099
Description: The last two digits of the Digits 2 and 1 entry specify the digits to
place in positions 2 and 1, respectively, of the Dollar Buffer.
4-43
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Card Read state (T) can be any valid state number, unlike the Care Read state
(A) (Section 4.4.1), which must be state 000 (state 000 is the state the terminal
enters when it goes in-service). The Card Read state (T) can be used to make
both card-based transactions and cardless transactions available on the same
terminal. For example, state 000 could be a Select Function state that offers
the consumer one or more card-based transactions and one or more cardless
transactions. If the consumer selects a card-based transaction, state 000 exits to a
T state (to require card insertion). If the consumer selects a cardless transaction,
state 000 exits to sequences that do not include a Card Read state.
To use the Card Read state (T), you must download timer 15. Timer 15 defines
the time to wait for a card insertion.
Refer to Table 4-20 for the Card Read state table format.
Entry Definition
1 State Type
2 Screen Number
State Type
State Entry: 1
Valid Data Range: T
Description: The State Type entry identifies this state as the Card Read state.
Screen Number
State Entry: 2
Valid Data Range: Valid screen numbers (Section 4.6)
Description: The number of the screen that prompts the consumer to insert a
debit or credit card.
4-44
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
• 001 - 1 only
• 002 - 2 only
• 003 - 3 only
• 004 - 1 and 2
• 005 - 1 and 3
• 006 - 2 and 3
• 007 - 1 and 2 and 3
• 008 - 2 or 3
• 009 - 1 or 3
• 010 - 1 or 2
• 011 - 1 or 2 or 3
• 012 - 1 and (2 or 3)
• 013 - 2 and (1 or 3)
• 014 - 3 and (1 or 2)
• 015 - 1 or (2 and 3)
• 016 - 2 or (1 and 3)
• 017 - 3 or (1 and 2)
• 018 through 025 - Reserved for future use
NOTE
4-45
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
4-46
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Check Track Buffer state examines track data to define the terminal’s
personality for the current consumer. The state provides conditional branching
of the state table sequence and can change the index for Indirect Next state
processing. This index is initially set to the value of the PSTDX from the FIT
identified during the Card Read state.
The Check Track Buffer state table contains six characters for the Check Track
Buffer state to compare with track data. A match condition occurs only if the
track data matches all six characters specified by the state table.
Refer to Table 4-21 for the Check Track Buffer state table format.
Entry Definition
1 State Type
5 Buffer ID/Delimiter
6 Delimiter Index
The Check Track Buffer state (Z) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: Z
Description: The State Type entry identifies this state table as the Check Track
Buffer state table.
4-47
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Buffer ID/Delimiter
Entry Number: 5
Valid Data Range: Decimal numbers less than or equal to 035. When this entry
is converted to hexadecimal, the first digit must be 0, 1, or 2, and the second
must be 0, 1, 2, or 3.
Description: The Buffer ID/Delimiter entry specifies the track to examine
for matching characters. It also specifies (in conjunction with entry 6) the
position in the track.
• 0 - Track 2
• 1 - Track 3
• 2 - Track 1
The least significant digit represents a track delimiter and a direction for applying
the offset specified in entry 6. The allowable values are as follows:
Delimiter Index
Entry Number: 6
Valid Data Range: 000 through 999
Description: The Delimiter Index specifies the number of characters to offset
from the delimiter (entry 5) to locate the data for comparing with entries 7, 8, and
9. The first character after the delimiter is at offset 000.
NOTE
4-48
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
EXAMPLE
Refer to the example state table shown in Table 4-22. The terminal proceeds as
follows when it executes this state:
1. The terminal examines the track 3 data beginning at offset 12 from the
last field separator (counting forward). This position is derived from the
Buffer ID/Delimiter entry and the Delimiter Index entry.
2. The terminal compares the track data to the characters specified in the
last three entries.
The specified characters are 03497F. Because the sixth character specified
by the table is F, the sixth character of track data is ignored.
• If the track data matches 03497, the terminal changes the current
Indirect Next state index to 05 and goes to state 100.
• If the track data does not match 03497, the terminal goes to state
150. The Indirect Next state index does not change.
4-49
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Entry Contents
State Type Z
4-50
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Deposit Extension state (# or >) extends the Deposit state (C). This state
provides additional fault handling to the network for deposit operations.
The Deposit Extension state always directly precedes the Deposit state that it
extends. That is, the state number of a Deposit Extension state table is one
less than the state number of the Deposit state table. All state tables that link
to the Deposit state table must specify the associated Deposit Extension state
table as the next state table.
Refer to Table 4-23 for the Deposit Extension state table format.
Entry Definition
1 State Type
State Type
Entry Number: 1
Valid Data Range: # or >
Description: This state ID identifies this state table as a Deposit Extension
state table.
NOTE
4-51
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
4-52
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
• 000 - Override the setting in the Depositor device properties. This entry
enables searching for MICR data on the right and left sides of the check. The
first attempt is made on the right edge of the check.
• 002 through 255 - The remaining values, that override the setting in the
Depositor device properties are created using the following bitmap:
4-53
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Voice state is used to turn the Voice feature on and off. Turning voice off
aborts any message in progress, purges any messages pending in the delay
queue, and idles the device. If the Voice feature is turned off by this state, the
only way to turn the Voice feature back on, without resetting the terminal, is to
execute another Voice state with the enable flag set to 001. The format of the
Voice state is shown in Table 4-24.
Entry Definition
1 State type
3 Next State
5 Beeping/Voice Prompting
Coordination Flag
6 Reserved
7 Reserved
8 Reserved
9 Reserved
State Type
Entry Number: 1
Valid Data Range: ;
Description: This state ID identifies this state table as a Voice state table.
Next State
Entry Number: 3
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: The state which is executed immediately following completion
of the Voice state.
4-54
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Reserved
Entry Number: 6 through 9
Valid Data Range: 000
Description: Must be 000.
4-55
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Split deposits and any other operations requiring more than one Dollar Entry state
are supported by the Copy Buffer state. This state allows for the copying of the
dollar buffer into a general purpose buffer. General purpose buffers B and C can
be included in a Consumer Request message. By following Dollar Entry states
with Copy Buffer states, and by changing the appropriate entry in the Transaction
Request state, up to three transaction amounts can be included in the Consumer
Request message without requiring changes to the format of that message.
Entry Definition
1 State type
2 Next State
3 Source Buffer ID
4 Reserved
5 Destination Buffer ID
6 Reserved
7 Reserved
8 Reserved
9 Reserved
State Type
Entry Number: 1
Valid Data Range: =
Description: This state ID identifies this state table as a Copy Buffer state table.
Next State
Entry Number: 2
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: The number of the state that is executed immediately following
completion of the Copy Buffer state.
Source Buffer ID
Entry Number: 3
Valid Data Range: 001
Description: The identifier of the buffer of which a copy is to be made. The
action of copying does not affect the source buffer. The only valid value for this
entry is 001. All other values are reserved.
Reserved
Entry Number: 4
Valid Data Range: 000
Description: Must be 000.
4-56
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Destination Buffer ID
Entry Number: 5
Valid Data Range: 002 or 003
Description: The identifier of the buffer to which the source buffer is copied.
The valid values are as follows:
Reserved
Entry Number: 6 through 9
Valid Data Range: 000
Description: Must be 000.
4-57
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Transaction Request Extension state extends the Transaction Request state
(I) to support the Cancel key during the Transaction Request processing.
Refer to Table 4-26 for the Transaction Request Extension state table format.
Entry Definition
1 State Type
4 - 9 Reserved
State Type
Entry Number: 1
Valid Data Range: )
Description: The State Type entry identifies this state table as a Transaction
Request Extension state table.
Reserved
Entry Number: 4 through 9
Valid Data Range: 000
Description: Must be 000.
4-58
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Function Key Extension state extends several standard state tables to support
the use of the F, G, H, I., J, K, L, and M function keys. Without extension, those
state tables support A, B, C, and D key operation only. The entries in a Function
Key Extension state table supplement the key defining entries of a state table by
defining the operation of the F, G, H, I, J, K, L, and M keys.
The Function Key Extension state extends the following state tables:
Terminals that have more than four function keys do not automatically require
you to extend every B, D, E, F, H, and I state table in the transaction sequence, or
to extend any of them. If you need to activate only the A, B, C, and D keys in a
given instance, omit the Function Key Extension state.
The Function Key Extension state always directly precedes the base state. That is,
the state number of a Function Key Extension state table is one less than the state
number of the base state table. All state tables that link to the base state table must
specify the associated Function Key Extension state table as the next state table.
NOTE
Refer to Table 4-27 for the Function Key Extension state table format.
Entry Definition
1 State Type
2 Function Key F
3 Function Key G
4 Function Key H
5 Function Key I
4-59
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Entry Definition
8 Function Key L
9 Function Key M
The Function Key Extension state ( > ) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: >
Description: The State Type entry identifies this state table as a Function
Key Extension state table.
NOTE
B "
D $
E %
F &
H (
I )
Function Key F
Entry Number: 2
Valid Data Range: The range for this entry is the same as for the function
keys in the base state.
Description: The function of this entry is the same as for the function keys in the
base state. An entry of 255 disables the key for this state.
Function Key G
Entry Number: 3
Valid Data Range: The range for this entry is the same as for the function
keys in the base state.
Description: The function of this entry is the same as for the function keys in the
base state. An entry of 255 disables the key for this state.
Function Key H
Entry Number: 4
Valid Data Range: The range for this entry is the same as for the function
keys in the base state.
Description: The function of this entry is the same as for the function keys in the
base state. An entry of 255 disables the key for this state.
4-60
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Function Key I
Entry Number: 5
Valid Data Range: The range for this entry is the same as for the function
keys in the base state.
Description: The function of this entry is the same as for the function keys in the
base state. An entry of 255 disables the key for this state.
Function Key L
Entry Number: 8
Valid Data Range: The range for this entry is the same as for the function
keys in the base state.
Description: The function of this entry is the same as for the function keys in the
base state. An entry of 255 disables the key for this state.
Function Key M
Entry Number: 9
Valid Data Range: The range for this entry is the same as for the function
keys in the base state.
Description: The function of this entry is the same as for the function keys in the
base state. An entry of 255 disables the key for this state.
EXAMPLE
Refer to the example state tables shown in Table 4-28. Assume that the terminal
has just finished processing a state table that specifies state 057 as the next state
table. Processing proceeds as follows:
1. The terminal recognizes state 057 as a Function Key Extension state table
and combines state 057 with the state table that follows it, state 058.
2. The terminal shows screen 023 (the Screen Number entry of state 058).
Screen 023 prompts the consumer to press one of the eight function keys,
the OK key, or the CORR key.
4. The terminal stores the key code for the OK key (J) in byte 3 of the
Function Key Buffer (the Function Key Buffer Location entry of state
058).
5. The terminal exits to state 108 (the Function Key J entry of state 057).
4-61
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
State Type
Entry Number: 1
Valid Data Range: >
Description: The State Type entry identifies this state table as a Function
Key Extension state table.
4-62
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Reserved
Entry Number: 4 through 9
Valid Data Range: 255
Description: These entries are reserved.
4-63
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Withdrawal Area Sensors state provides additional control of a bill dispense
operation. This state directs the terminal to check the withdrawal area sensors
and modify the transaction sequence based on the result.
If one or more sensors are blocked, the Withdrawal Area Sensors state generates
an Unsolicited Status message to report a withdrawal area sensors status.
See Table 4-29 for the Withdrawal Area Sensors state table format.
ENTRY DEFINITION
1 State Type
4 - 9 Reserved
State Type
Entry Number: 1
Valid Data Range: ?
Description: The State Type entry identifies this state table as a Withdrawal Area
Sensors state table.
Reserved
Entry Numbers: 4 through 9
Valid Data Range: 000
Description: The terminal does not use these entries.
4-64
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
The Set Language Bank state selects the appropriate language bank to use for
screen retrieval when supporting the multilingual feature. For more details on the
multilingual feature, refer to Section 4.15.
Refer to Table 4-30 for the Set Language Bank state table format.
Entry Definition
1 State Type
2 Next State
4 - 9 Reserved
State Type
Entry Number: 1
Valid Data Range: [
Description: The State Type entry identifies this state table as a Set Language
Bank state table.
Next State
Entry Number: 2
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: The Next State entry specifies the state table that the terminal
processes after establishing the Language Bank number.
Reserved
Entry Number: 4 through 9
Valid Data Range: 000
Description: The terminal does not use these entries.
4-65
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Entry Definition
1 State type
4 Buffer 1 ID
5 Buffer 2 ID
6 Result Buffer ID
7 Operation to Perform
8 Reserved
9 Reserved
State Type
Entry Number: 1
Valid Data Range: \
Description: This state ID identifies this state table as a Buffer Arithmetic state.
Buffer 1 ID
Entry Number: 4
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: This is the ID of the buffer that contains the value to be added
to or subtracted from. This entry is set to the decimal ASCII value of the
ID of the buffer to be used.
4-66
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
9000 States
Buffer 2 ID
Entry Number: 5
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: This entry contains the buffer ID of the buffer that contains the
value to be added or subtracted. This entry is set to the decimal ASCII value
of the ID of the buffer to be used.
Result Buffer ID
Entry Number: 6
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: This entry contains the buffer ID of the buffer to contain the result
of the given operation. This entry is set to the decimal ASCII value of the ID
of the buffer to be used. This entry can be the same buffer ID as given in
either entry 4 or 5.
Operation to Perform
Entry Number: 7
Valid Data Range: 000 and 001
Description: This entry identifies the operation to be performed with the
specified buffers. The valid values are as follows:
• 000 - This value directs the terminal to add buffer 1 and buffer 2 and place
the result in the result buffer specified.
NOTE
• 001 - This value directs the terminal to subtract buffer 2 from buffer 1.
The result buffer always contains the difference between the two buffers
(a positive value). If the contents of buffer 2 is larger than buffer 1, the
Negative Result Next State path is taken. Otherwise, the Positive Result
Next State path is used. The result buffer is always the same length as the
longer of buffers 1 and 2.
Reserved
Entry Number: 8 and 9
Valid Data Range: 000
Description: These entries are reserved and are always 000.
4-67
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Configured Timers
The standard configured timers are described in Section 4.23. These timers are
labeled as timers 00 through 31. When timers are used with enhanced states,
these timers must be prefixed with a 9. For example, to use timer 04 with an
enhanced state, the state data must refer to the timer as 904. Timers 00 through
31 can be used in the terminals. Any timer that is not reserved (Section 4.23)
can be downloaded to the terminal in a Write Command 3 message at the
programmer’s discretion.
4-68
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Text To Speech state table is shown in Table 4-32. The Text To
Speech state is part of the Voice feature. The state data directs the terminal to
convert a text string to audible speech. The text must have been previously stored
in the buffer specified in the state table.
State Type AU b/
Reserved 000
Reserved 000
Reserved 000
The following paragraphs describe each entry in the Text To Speech state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State Data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: AU b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
Unit Number
Valid Range: 001
Description: The unit number for the Text To Speech state must be 001.
4-69
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Next State
Valid Range: Valid state numbers (Section 4.3.1)
Description: The Next State entry identifies the next state the terminal goes to
after performing the Text To Speech state processing.
Interrupt Flag
Valid Range: 000 through 002
Description: The interrupt flag indicates how the terminal should queue the
message retrieved from the specified buffer.
• 000 - Add the message to the message queue. Do not terminate the message
currently in progress.
• 001 - Terminate the message in progress. Proceed with the new message.
Buffer ID
Valid Range: 064 through 090 (@, and A through Z)
Description: The Buffer ID entry identifies the buffer containing the text to be
spoken. SAPI XML tags and Diebold Text To Speech tags can be embedded
in the text.
For detailed information on SEPIA XML tags and Diebold Text To Speech
tags, refer to Section 4.17.3.
Template Number
Valid Range: 000 through 099
Description: The Template Number entry specifies a format template to use
for interpreting the specified text as a cash amount (for example, a transaction
amount or an account balance). If this entry contains the value 000, no format
template is applied to the text. For information about the use of format templates
for the Voice feature, refer to Section 4.17.1.3.
Delay
Valid Range: 000 through 255
Description: The Delay entry specifies the amount of time (in ticks) to delay
before speaking the message (one tick equals 0.8 second).
Reserved (3 entries)
Valid Range: 000
Description: These three entries are reserved for future use.
4-70
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Card Reader state is shown in Table 4-33. The Card Reader
state data directs the terminal to perform specific card reader operations. The
Operation entry in the state table determines which operation the terminal
performs.
State Type CR b/
The following paragraphs describe each entry in the Card Reader state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
4-71
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: CR b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
Unit Number
Valid Range: 001
Description: The unit number for the Card Reader state must be 001.
Operation
Valid Range: 001 through 007, and 009 through 015
Description: The Operation entry tells the terminal which operation to perform
during the state.
NOTE
For all writing operations (002, 011, and 012), the applicable
track data buffer must contain good track data (including both
the start sentinel and the end sentinel) obtained either from
a good read or from the most recently received Function
Command message.
The valid values for the Card Reader state are as follows:
• 001 - Read the card, wait for the operation to complete. The terminal takes a
Next State exit after the card reader successfully reads the card or a fault is
encountered (for example, cannot satisfy the read conditions).
• 002 - Write on track 3 of the card, wait for the operation to complete. The
terminal takes a Next State exit after the card reader successfully writes and
verifies the track 3 data or a fault is encountered.
• 003 - Return the card, wait for the consumer to remove the card. The
terminal takes a Next State exit after the consumer takes the card, the
consumer timeout expires, or a fault is encountered (for example, a card jam).
• 004 - Retain or capture the card, wait for the operation to complete. The
terminal takes a Next State exit after the card leaves the transport or a fault is
encountered (for example, a card jam).
• 006 - Return the card, do not wait for removal. The terminal goes
immediately to the Good Operation Next State without waiting for the
consumer to remove the card. The terminal keeps the card in the drive rollers
so that it can be captured at a later time, if necessary.
4-72
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• 007 - Return the card, wait for removal, capture the card if not removed. The
terminal takes a Next State exit after the consumer takes the card, the card
leaves the transport, or a fault is encountered (for example, a card jam).
• 009 - Enables the card reader so that it can accept a card. After the card
is inserted but before it is read, the state takes the Good Operation Next
State exit. The reading of the card is performed while other states are
being processed.
NOTE
• 010 - Wait until the card read started by operation 009 is completed. The
sequence of operation 009 and 010 is equivalent to operation 001.
• 011 - Write on track 1 of the card, wait for the operation to complete. The
terminal takes a Next State exit after the card reader successfully writes and
verifies the track 1 data or a fault is encountered. This operation requires a
card reader capable of writing on track 1.
• 012 - Write on track 2 of the card, wait for the operation to complete. The
terminal takes a Next State exit after the card reader successfully writes and
verifies the track 2 data or a fault is encountered. This operation requires a
card reader capable of writing on track 2.
• 013 - Enable card reader for read on insertion and do not lock. This
operation requires a dip smart card reader capable of reading on insertion.
When the card is inserted, it is not locked.
• 014 - Enable card reader for read on insertion and lock. This operation
requires a dip smart card reader capable of reading on insertion. When the
card is inserted, it is locked in the reader. This allows for multiple transaction
with one card insertion. The card can be released by using a card read state
or card read function, or by directing the state flow through a close state.
• 015 - Check the card reader sensors until the consumer response time
expires. This operation requires a dip smart card reader. If the sensors are
clear (no card in the reader) before the time expires, the terminal goes to
the good operation next state. If the sensors remain blocked and the time
expires, the terminal goes to the consumer fault next state.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen the
terminal shows on the consumer display when the terminal enters the state. The
valid values are as follows:
4-73
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
NOTE
The word and specifies that the terminal must read all the
indicated tracks correctly. The word or specifies that the
terminal must read only one of the indicated tracks correctly.
4-74
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
For example, 1 and 2 and 3 indicates that the terminal must read tracks 1, 2, and
3, while a 1 or 2 or 3 indicates that the terminal assumes a successful operation if
any of the tracks are read correctly.
The terminal always attempts to read all the tracks. The read conditions set up
the criteria by which the terminal determines a successful read operation.
NOTE
Pre-head
Valid Range: 000 through 002
Description: The Pre-head entry tells the terminal whether or not to use the card
reader pre-head for opening the card reader gate. This entry is optional. The
valid values are as follows:
4-75
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of a Card Reader state is shown in Table 4-34. This example state
directs the terminal to do the following:
- 006 if unit number 001 is not defined in the Card Reader configuration
setting.
Entry Value
State Type CR b/
Operation 001
4-76
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Depositor state table is shown in Table 4-35. The Depositor
state data directs the terminal to perform specific depositor operations. The
Operation entry in the state data determines which operation the terminal
performs.
State Type DP b/
Check Handling Delay Time [1] 000 - 255, 900 - 931, 999
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State Data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
4-77
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: DP b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
Unit Number
Valid Range: 001
Description: The unit number for the Depositor state must be 001.
Operation
Valid Range: 000 through 004
Description: The Operation entry tells the terminal which operation to perform
during the processing of the state. The valid values for the Depositor state
are as follows:
• 000 - No action. The terminal takes the Good Operation Next State exit
immediately.
• 002 - Deposit check to escrow. This operation is intended to be the first step
of a check deposit. If there is no check or other document in escrow, the
terminal enables the IDM to perform the following operations:
- Read the MICR line as directed by the MICR Read Position Setting entry
or the MICR search preference set in the Depositor device properties
4-78
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• 003 - Retain check with printing. The terminal moves the check or other
document from the escrow position to the deposit bin specified in the
Deposit Bin ID entry.
If there is data in the buffer specified by the Print Buffer ID entry, the
terminal prints this data on the check or document. If there is no data in
the specified buffer, the terminal prints the default data. If no printing is
desired, the specified buffer must contain all spaces, or the value in the
Print Buffer ID entry must be 000.
• 004 - Return check with printing. The terminal moves the check or other
document from the escrow position to the entry slot of the depository, to
allow the consumer to retrieve the check or document.
If there is data in the buffer specified by the Print Buffer ID entry, the
terminal prints this data on the check or document. If there is no data in
the specified buffer, the terminal prints the default data (Section 3.11). If
no printing is desired, the specified buffer must contain all spaces, or the
value in the Print Buffer ID entry must be 000.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen that
the terminal shows upon entering the state. The valid values are as follows:
This entry is used only with operations 001, 002, and 004. This entry is not
used with operations 000 and 003.
4-79
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Print Buffer ID
Valid Range: 000, and 064 through 090 (buffers @, and A through Z)
Description: The Print Buffer ID entry identifies which buffer contains the
data that the terminal is to print on the deposit printer. The terminal prints the
buffer data only when the Operation entry specifies an operation that includes
printing. Also, the print data must be placed in the buffer before the terminal
begins processing the Depositor state. If the value in this entry is 000, printing is
disabled.
MICR Buffer ID
Valid Range: 064 through 090 (buffers @, and A through Z)
Description: The MICR Buffer ID entry identifies which buffer the terminal uses
to store MICR data read from the check.
Deposit Bin ID
Valid Range: 000 through 003 (subject to the capabilities of the depository)
Description: The deposit bin ID tells the terminal in which bin to place a deposit
if the terminal is equipped with an IDM. If the operation specified in the Deposit
state is 000, this entry should be 000. If any of the operations 001 through 004
are selected, the range for this value is 000 through 003.
Image Enable
Valid Range: 000, 001, 003, 005, and 007
Description: The Image Enable entry is applicable to operation 002 only. This
entry determines which images, if any, are to be taken from the document. Valid
values are based on a bitmap whose bits are defined as follows:
• Bit 2:
4-80
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• Bit 1:
• Bit 0:
For IDM operation, the value of bits 2 and 1 are ignored. Bit 0 must be set to
1 to perform document scanning. When bit 0 is set to 1, the IDM scans both
the top and the bottom of the document. When the specified operation includes
printing, the side of the document that is printed depends on the physical location
of the deposit printer, rather than the setting of bit 2.
4-81
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• 000 - Override the setting in the Depositor device properties. This entry
enables searching for MICR data on the right and left sides of the check. The
first attempt is made on the right edge of the check.
• 002 through 255 - The remaining values, that override the setting in the
Depositor device properties are created using the following bitmap:
4-82
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
- 090 if the consumer cancels the transaction or does not insert a check
- 060 if the depository detects a media fault (document too small or too
large)
- 080 if the depository has problems handling the check, (jam, and so on)
4-83
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Entry Value
State Type DP b/
Operation 002
4-84
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Dispenser Door state table is shown in Table 4-37. The
Dispenser Door state data directs the terminal to perform present, retain, restore,
and retract operations and to check withdrawal area sensors. The Operation entry
in the state data determines which operation the terminal performs.
State Type DR b/
The following paragraphs describe each entry in the Dispenser Door state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State Data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: DR b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
Unit Number
Valid Range: 001
Description: The unit number for the Dispenser Door state must be 001.
4-85
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
Valid Range: 001 through 003, 005 through 008, and 010 through 016
Description: The Operation entry tells the terminal which operation to perform
during the processing of the state. The valid values for the Dispenser Door
state are as follows:
• 001 - Present and wait for the operation to complete. The terminal takes a
Next State exit after the present or a fault is encountered.
• 002 - Present and wait for the consumer to remove the bills. The terminal
takes a Next State exit after detecting that the consumer removed the bills
within the timeout period (sensors cleared), the consumer timeout expires
and the sensors are still blocked, or a fault is encountered.
• 003 - Retain, restore, or retract (as applicable), and do not wait. If the current
consumer’s cash is in escrow, the bill dispenser does nothing. If there is no
cash in escrow or in the presenting position, and the presenter is not in the
dispense-ready position, the bill dispenser performs a restore operation.
Then the bill dispenser retains the cash. The terminal goes immediately to
the Good Operation Next State.
• 005 - Check withdrawal area sensors, wait for the operation to complete.
• 008 - Retain, restore, or retract (as applicable), and wait for completion. If
the current consumer’s cash is in escrow, the bill dispenser does nothing. If
there is no cash in escrow or in the presenting position, and the presenter
is not in the dispense-ready position, the bill dispenser performs a restore
operation. Then the bill dispenser dumps the cash.
• 010 - Wait for consumer to remove bills. The terminal takes a Next State
exit after detecting that the consumer removed the bills within the timeout
period (sensors cleared), the consumer timeout expires and the sensors are
still blocked, or a fault is encountered.
• 014 - Restore and do not wait for operation to complete. The terminal goes
immediately to the Good Operation Next State.
• 015 - Retract and do not wait for operation to complete. The terminal goes
immediately to the Good Operation Next State.
• 016 - Retain and do not wait for operation to complete. The terminal goes
immediately to the Good Operation Next State.
4-86
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the terminal enters the
state. The valid values are as follows:
EXAMPLE
An example of a Dispenser Door state is shown in Table 4-38. This example state
directs the terminal to do the following:
4-87
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
- 004 if all the operations are successful and the consumer removes the bills
from the presenter within 60 ticks
- 005 if the consumer does not remove the bills from the presenter within
60 ticks
- 007 if unit number 001 is not defined in the Fascia configuration setting
Entry Value
State Type DR b/
Operation 002
4-88
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Get Encrypted PIN state table is shown in Table 4-39. The Get
Encrypted PIN state data directs the terminal to get the encrypted PIN block
of the consumer-entered PIN from the encrypting PIN pad and store the PIN
block in the buffer specified in the state table. This allows the terminal to verify
that two separate entries of the PIN match, by placing the resulting PIN blocks
in separate buffers and then comparing the buffers (using the Buffer Compare
state). By requiring a consumer to enter their PIN twice and verifying that the
entries match, an institution can ensure that the consumer typed the PIN correctly
before proceeding with the transaction.
State Type EP b/
Operation 001
The following paragraphs describe each entry in the Get Encrypted PIN state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State Data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: EP b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
Operation
Valid Range: 001
Description: The Operation entry tells the terminal which operation to perform
during the processing of the state. The only valid value for the Get Encrypted
PIN state is 001.
4-89
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Buffer ID entry identifies the buffer in which to store the
encrypted PIN block.
4-90
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Image Character Recognition state table is shown in Table 4-40.
The Image Character Recognition state determines how a given document is
interpreted, which fields on the document to recognize, and where to store the
information that the Recognition Subsystem finds in those field locations.
State Type IC b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State Data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
4-91
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: IC b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
Operation
Valid Range: 000, 001
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 000 - Enable. The Enable operation must come before the actual deposit and
the Image Capture must be turned on in the Deposit state.
• 001 - Read. The Read operation must come after a deposit operation.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the terminal enters the
state. The valid values are as follows:
Document Type
Valid Range: 001 through 999
Description: The Document Type entry identifies the type of document to
process. Document types can be personal checks, commercial checks, bill
payments, and so on. For information about the standard, predefined document
types, refer to the example at the end of this section.
Document Index
Valid Range: 001 through 999
Description: The Document Index entry identifies which document is to be
processed within a particular document type. For information about the standard,
predefined document indexes, refer to the example at the end of this section.
4-92
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Document Window
Valid Range: 001 through 999
Description: The Document Window entry identifies the area of the document to
process. For information about the standard, predefined document windows,
refer to the example at the end of this section.
Buffer ID
Valid Range: 064 through 090, and 256 through 355
Description: The Buffer ID entry identifies the buffer where the results of the
operation are to be placed. The valid values are as follows:
• Buffer IDs 064 through 090 are used to select buffers @, A through Z
• Buffer IDs 256 through 355 can be used for anything else
NOTE
EXAMPLE
The following table shows the standard, predefined document types, document
indexes, and document windows used by Agilis 91x for ix/CSP:
4-93
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Lead-through Indicators state table is shown in Table 4-41.
The Lead-through Indicators state data tells the terminal how to operate the
lead-through indicators (lamps).
State Type LT b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State Data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: LT b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
4-94
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Lamp Number
Valid Range: 001 through 011, and 100
Description: The Lamp Number entry tells the terminal which lead-through
indicator the state data is for. The valid values are as follows:
If 100, automatic mode, is used, then the condition and flash rate values are
applied to future automatic lead-through operations.
Condition
Valid Range: 000 through 002
Description: The Condition entry tells the terminal which condition to put the
indicator in. The valid values are as follows:
• 000 - Off
• 001 - On
• 002 - Flash
Time
Valid Range: 000 through 999
Description: The Time entry specifies the amount of time (in seconds) to wait
after turning a light on or flashing the light before turning the indicator off. The
value of 000 leaves the indicator on indefinitely.
Flash Rate
Valid Range: 000 through 255
Description: The Flash Rate entry specifies the rate at which to flash the
indicator. The flash rate is specified in the following manner:
Next State
Valid Range: Valid state numbers (Section 4.3.1)
Description: The Next State entry identifies the next state the terminal goes to
after performing the desired indicator operation.
4-95
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Color
Valid Range: 000 through 002
Description: The Color entry specifies the indicator color affected by the
Condition entry. The indicator color is specified in the following manner:
• 000 - Green
• 001 - Red
• 002 - Yellow
This entry is optional. If it is not included in the function data, the value defaults
to 000 (green).
EXAMPLE
• Have the card reader lead-through indicator flash for 30 seconds at a low rate
Because the optional Color entry is not included in the state table, Agilis 91x for
ix/CSP directs the terminal to flash the green lead-through indicator.
Entry Value
State Type LT b/
Condition 002
Time 030
4-96
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Network Connection state table is shown in Table 4-43. The
Network Connection state data directs the terminal to begin the process of
connecting to/disconnecting from the network in a dialup environment. The data
in the Operation entry determines which operation the terminal performs.
State Type NC b/
The following paragraphs describe each entry in the Network Connection state.
State Number
Valid Range: 000 through 250, and 256 through 511
Description: The State Number entry identifies groups of related State Data
entries. The terminal executes a group of related entries by calling their
associated state number either while performing another state or performing a
function commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
Data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: NC b/
Description: The State Type entry identifies the specific type of State Data
entries associated with a particular state number. The State Type entry is
considered to be part of the State Data.
Unit Number
Valid Range: 001
Description: The unit number for the Network Connection state must be 001.
4-97
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
Valid Range: 000 through 002
Description: The Operation entry tells the terminal which operation to perform
during the state. The valid values for the Network Connection state are as follows:
• 000 - Do nothing.
• 001 - Begin the network connect process.
• 002 - Begin the network disconnect process.
To increase state sequencing speed, the ATM can begin the network connect
process at anytime. This state can be executed after a good card read or a PIN
entry state so that the connection process can begin before the Consumer Request
message is ready to be sent to the network.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the terminal enters the
state. The valid values are as follows:
4-98
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
Entry Value
State Type NC b/
Operation 001
4-99
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
4-100
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Printer state table is shown in Table 4-45. The Printer state
data directs the terminal to perform specific printer operations. The data in the
Operation entry determines which operation the terminal performs. Operation
is also affected by whether the printer is equipped with an exit sensor (that
is, whether the printer is capable of detecting and reporting the taking of the
delivered document).
State Type PR b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: PR b/
Description: The State Type entry identifies the specific type of state data entries
associated with a particular state number. The State Type entry is considered
to be part of the state data.
4-101
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Unit Number
Valid Range: 001 through 003
Description: The unit number for the Printer state tells the terminal which device
this state is for. The valid values are as follows:
Operation
Valid Range: 001 through 008
Description: The Operation entry tells the terminal which operation to perform.
The meaning of this entry is dependent on the entry in the unit number entry.
If the unit number entry is 001, receipt printer, and the printer is not equipped
with an exit sensor, the valid values are as follows:
• 001 - Print the data on the consumer’s receipt. Do not wait for the operation
to complete. The terminal goes immediately to the Good Operation Next
State.
• 002 - Deliver the printed document. Do not wait for the operation to
complete. The terminal goes immediately to the Good Operation Next State.
• 003 - Deliver the printed document. Wait for the operation to complete.
The terminal takes a Next State exit after delivery is completed or a fault is
encountered.
• 004 - Print the data on the consumer’s receipt. Wait for the operation to
complete. The terminal takes a Next State exit after the printer successfully
prints all the data or a fault is encountered.
4-102
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
If the unit number entry is 001, receipt printer, and the printer is equipped with
an exit sensor, the valid values are as follows:
• 001 - Print the data on the consumer’s receipt. Do not wait for the operation
to complete. The terminal goes immediately to the Good Operation Next
State.
If the print data contains a form feed control character (0C hex), and the
receipt is not taken before the time specified in the Consumer Response
Time entry expires, the terminal retains or dumps the receipt (if the printer
has that capability). If a receipt is retained or dumped due to a timeout, the
terminal sends the network an unsolicited status indicating an automatic
document retain.
If the Consumer Response Time entry is 000, the terminal uses timer 21
instead. If the value of timer 21 is also 000 (timer 21’s default value), the
terminal does not automatically retain the receipt.
• 002 - Deliver the printed receipt. Do not wait for the operation to complete.
The terminal goes immediately to the Good Operation Next State unless a
data error is detected. In that case, the Network Fault Next State is taken.
If the receipt is not taken before the time specified in the Consumer
Response Time entry expires, the terminal retains or dumps the receipt (if
the printer has that capability). If a receipt is retained or dumped due to a
timeout, the terminal sends the network an unsolicited status indicating an
automatic document retain.
If the Consumer Response Time entry is 000, the terminal uses timer 21
instead. If the value of timer 21 is also 000 (timer 21’s default value), the
terminal does not automatically retain the receipt.
• 003 - Deliver the printed receipt. Wait for the operation to complete. The
terminal takes the Good Operation Next State exit after the consumer has
taken the delivered receipt, or if there is no receipt to be delivered.
If the receipt is not taken before the time specified in the Consumer
Response Time entry expires, the terminal goes to the Consumer Fault Next
State. The terminal does not automatically retain the receipt.
If the Consumer Response Time entry is 000, the terminal takes the Good
Operation Next State exit immediately after delivering the receipt. The
terminal does not wait for the consumer to take the receipt. The Consumer
Fault Next State entry is never used.
• 004 - Print the data on the consumer’s receipt. Wait for the operation to
complete. The terminal takes a Good Operation Next State exit after the
printer successfully prints all the data.
If the print data contains a form feed control character (0C hex), the terminal
delivers the receipt before taking the Good Operation Next State exit, but the
terminal does not wait for the consumer to take the receipt before exiting. If
the receipt is not taken, the terminal does not automatically retain the receipt.
4-103
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• 005 - Retain the receipt that is still in the delivery position, wait for the
operation to complete. The terminal takes a Good Operation Next State exit
after the printer successfully retains the receipt.
• 006 - Retain the receipt that is still in the delivery position, do not wait for
the operation to complete. The terminal goes immediately to the Good
Operation Next State unless a network data error is detected.
• 007 - Retain the receipt that is still in the delivery position, wait for the
operation to complete. The terminal takes a Good Operation Next State exit
after the printer successfully dumps the receipt.
• 008 - Retain the receipt that is still in the delivery position, do not wait for
the operation to complete. The terminal goes immediately to the Good
Operation Next State unless a network data error is detected.
To increase state sequencing speed, the network can combine printing data and
delivering the receipt in one operation. To accomplish this, the network should
end the print data with a form feed control character and then use a print and
do not wait operation in the state (001). State sequencing then continues while
the printing and delivery operations are performed.
If the unit number entry is 002, journal printer, the valid values are as follows:
• 001 - Print the data on the journal printer’s audit roll. Do not wait for
the operation to complete. The terminal goes immediately to the Good
Operation Next State.
• 004 - Print the data on the journal printer’s audit roll. Wait for the
operation to complete. The terminal takes a Next State exit after the printer
successfully prints all the data or a fault is encountered.
If the unit number entry is 003, EDC, the valid values are as follows:
• 001 - Print the data on the EDC device. Do not wait for the operation to
complete. The terminal goes immediately to the Good Operation Next State.
• 004 - Print the data on the EDC device. Wait for the operation to complete.
The terminal takes a Next State exit after the printer successfully prints all
the data or a fault is encountered.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the terminal enters the
state. The valid values are as follows:
4-104
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
This entry is used only with printers equipped with an exit sensor, and only with
operations 001, 002, and 003. If the printer has no exit sensor, or if the operation
is not 001, 002, or 003, this entry is not used and must be 000.
- Operations 001 and 002 - Use timer 21 (If the value of timer 21 is 000, the
terminal does not automatically retain the receipt.)
This entry is used only with printers equipped with an exit sensor, and only with
operation 003. If the printer has no exit sensor, or if the operation is not 003, this
entry is not used and must be 000.
Print Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Print Buffer ID entry identifies which buffer contains the
data that the terminal prints on the designated printer. The terminal prints the
buffer data only when the Operation entry specifies a print operation (operation
001 or 004). The print data must be placed in this buffer before the terminal
enters the Printer state.
4-105
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
This entry is used only with printers equipped with an exit sensor, and only with
operations 001 and 002. If the printer has no exit sensor, or if the operation is not
001 or 002, this entry is not used and must be 000.
4-106
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE 1
Table 4-46 shows an example of a Printer state for a receipt printer that has no
exit sensor. This example state directs the terminal to do the following:
• Deliver the consumer’s receipt and wait for the operation to complete
(operation 003)
- 500 if the print data is invalid, or if unit number 001 is not defined in the
Receipt Printer configuration setting
Entry Value
State Type PR b/
Operation 003
4-107
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE 2
Table 4-47 shows an example of a Printer state for a receipt printer equipped with
an exit sensor. This example state directs the terminal to do the following:
• Start printing the consumer’s receipt and do not wait for the operation to
complete (operation 001)
• Continue printing the consumer’s receipt using the data in buffer 080
(buffer P)
If the print data contains a form feed, and the receipt is not taken before the
consumer response time expires (38 ticks, 30.4 seconds), the terminal retains
the receipt (Unremoved Document Flag entry contains 000).
Agilis 91x for ix/CSP does not use the Consumer Fault Next State entry in this
example, because the Operation entry contains a value of 001 rather than 003.
Table 4-47 Example Printer State (Receipt Printer with Exit Sensor)
Entry Value
State Type PR b/
Operation 001
4-108
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE 3
Table 4-48 shows an example of a Printer state for a receipt printer equipped with
an exit sensor. This example state directs the terminal to do the following:
• Print the consumer’s receipt and wait for the operation to complete
(operation 004). Print the receipt using the data in buffer 080 (buffer P).
- 500 if the printer data is invalid, or if unit number 001 is not defined in the
Receipt Printer configuration setting
Agilis 91x for ix/CSP does not use the Consumer Response Time entry, the
Consumer Fault Next State entry, and the Unremoved Document Flag entry in
this example, because the Operation entry contains a value of 004 rather than
001, 002, or 003.
Table 4-48 Example Printer State (Receipt Printer with Exit Sensor)
Entry Value
State Type PR b/
Operation 004
4-109
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE 4
Table 4-49 shows an example of a Printer state for a journal printer. This example
state directs the terminal to do the following:
• Start printing on the journal printer and do not wait for the operation to
complete (operation 001)
- 250 if unit number 002 is not defined in the Journal Printer configuration
setting
State Type PR b/
Operation 001
The format of the Supplemental Dispenser Module State data entries is shown in
Table 4-50. The Supplemental Dispenser Module State data instructs the terminal
to perform specific dispense operations. The Operation entry in the State data
determines which operation the terminal performs.
4-110
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
NOTE
Operation 001-002
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: SD b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Unit Number
Valid Range: 001
Description: The unit number for the Supplemental Dispenser Module State data
must be 001.
4-111
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
Valid Range: 001 through 002
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 001 - Dispense and do not wait for operation to complete. The state
sequencer goes immediately to the Good Operation Next State.
• 002 - Dispense and wait for operation to complete. The state sequencer
takes the Good Operation Next State exit after the consumer has taken the
dispensed media. The consumer response timer is started when the media
has been successfully dispensed. If the consumer response timer expires, the
Consumer Fault Next State exit is taken.
Screen #1
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen #1 entry specifies the number of the screen that the
terminal shows on the consumer display during the wait for the media to be
dispensed. This screen only applies to a dispense and wait operation (002). The
valid values are as follows:
Screen #2
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen #2 entry specifies the number of the screen that the
terminal shows on the Consumer display after the dispense is complete and the
state is waiting for the media to be taken. This screen only applies to a dispense
and wait operation (002). The valid values are as follows:
4-112
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
before the operation is complete. This exit is only valid for the dispense and
wait operation (002).
This exit can also be taken for any operation if a consumer cancel occurs.
This action can happen if the device becomes unavailable and the consumer
elects to cancel the operation.
4-113
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Statement Printer state table is shown in Table 4-51. The
Statement Printer state data directs the terminal to perform specific printer
operations. The data in the Operation entry determines which operation the
terminal performs. It is important to note that all uses of the statement printer
need to end with a deliver, retain, or retain function. If the print function
fails, this ensures that the paper is cleared and the printer is back in a "ready
for use" condition.
State Type SP b/
Reserved 000
The following paragraphs describe each entry in the Statement Printer state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
4-114
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: SP b/
Description: The State Type entry identifies the specific type of state data entries
associated with a particular state number. The State Type entry is considered
to be part of the state data.
Unit Number
Valid Range: 001
Description: The unit number for the Statement Printer state must be 001.
Operation
Valid Range: 001 through 008
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 001 - Print the data on the statement. Do not wait for the operation to
complete. The terminal goes immediately to the Good Operation Next
State unless there is a data error. In that case, the Network Fault Next
State exit is taken.
• 002 - Deliver the printed statement. Do not wait for the operation to
complete. The terminal goes immediately to the Good Operation Next
State unless a data error is detected. In that case, the Network Fault Next
State exit is taken.
If the statement is not taken before the time specified in the Consumer
Response Time entry expires, the terminal retains or dumps the statement
(if the statement printer has that capability). If a statement is retained or
dumped due to a timeout, the terminal sends the network an unsolicited
status indicating an automatic document retain.
• 003 - Deliver the printed statement. Wait for the operation to complete. The
terminal takes the Good Operation Next State exit after the consumer has
taken the delivered statement or if there is no statement to be delivered.
If the statement is not taken before the time specified in the Consumer
Response Time entry expires, the terminal takes the Consumer Fault Next
State exit. The terminal does not automatically retain the statement.
• 004 - Print the data on the statement. Wait for the operation to complete.
The terminal takes a Next State exit after the printer successfully prints all
the data or a fault is encountered.
• 005 - Retain any statement that is still in the delivery position. Wait for the
operation to complete. The terminal takes a Next State exit after the printer
successfully retains the statement or a fault is encountered.
• 006 - Retain any statement that is still in the delivery position. Do not wait
for the operation to complete. The terminal goes immediately to the Good
Operation Next State unless a network data error condition is detected.
4-115
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• 007 - Retain any statement that is still in the delivery position. Wait for the
operation to complete. The terminal takes a Next State exit after the printer
successfully dumps all forms or a fault is encountered.
• 008 - Retain any statement that is still in the delivery position. Do not wait
for the operation to complete. The terminal goes immediately to the Good
Operation Next State unless a network data error condition is detected. In
this case, the Network Fault Next State is taken.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
• During operation 003 (deliver and wait), the time specified in the Consumer
Response Time entry expires before the statement is removed.
• During any operation, the consumer cancels the operation. This can happen
if the statement printer becomes unavailable, and the consumer chooses
to cancel the operation instead of waiting for the statement printer to be
available again.
4-116
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
For Do Not Wait operations (001, 002, 006, and 008), only severe data errors
cause this exit. These data errors can be an invalid state or function data packet
size.
Print Data ID
Valid Range: 064 through 090 (@, and A through Z), 256 through 355, ’@’,
and ’A’ through ’Z’
Description: The Print Data ID entry identifies the location of the print data. The
meaning of this value depends on the Print Data Type entry. This entry is only
used for operations 001 and 004. All other operations ignore this entry.
• 000 - The print data is in an buffer. The value in the Print Data ID entry is
the buffer ID of the buffer containing the print data. The print data in the
buffer is in expanded ASCII format.
• 001 - The print data is stored in a file. The value in Print Data ID entry is the
buffer ID of the buffer containing the path and file name of the file. The path
and file name in the buffer must be a fully qualified path and file name.
Example - If the value in the Print Data ID entry is ’Z’, the terminal prints
the data in the file: c:\DIEBOLD\TCS\sp\SPDATA_Z.TXT.
• 003 - The print data is stored in an buffer. The value in the Print Data ID
entry is the buffer ID of the buffer containing the print data. The print data in
the buffer is in normal (non-expanded) ASCII format.
Reserved
Valid Range: 000
Description: This entry is reserved.
4-117
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Description: The Unremoved Document Flag entry tells the terminal what action
to take on a document that has not been removed in the time allotted in the
Consumer Response Time field. The valid values are as follows:
This entry is only used for print operation 002, deliver and do not wait.
EXAMPLE
• Print the statement and wait for the operation to complete (operation 004)
Entry Value
State Type SP b/
Operation 004
Reserved 000
4-118
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Check FIT state table is shown in Table 4-53. The Check
FIT state data directs the terminal to compare the institution ID read from the
consumer’s card against the Financial Institution Table (FIT) entries stored in
terminal memory. If there is a match, the terminal goes to the Match Next State.
If no match is found, the terminal goes to the No Match Next State. Refer to
the Data Security Procedures and Reference Manual (TP-799530-001D) for
details on FIT.
NOTE
State Type @B b/
The following paragraphs describe each entry in the Check FIT state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @B b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
4-119
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Data in the consumer’s associated FIT entry determines whether the terminal
uses the state’s PIN Retry Count entry or the PIN Retry Count recorded on
the card. For detailed information on FlT entries, refer to the Data Security
Procedures and Reference Manual (TP-799530-001D).
The terminal resets the PIN Retry Counter each time it executes a state that
contains a PIN Retry Count entry.
If this entry is included in the Check FIT state, the Check PIN state should
include no PIN Retry Count entry. Upon executing the Check FlT state, the
terminal loads the entry value into the PIN Retry Counter. The terminal then
decreases the value of the counter each time the consumer enters a bad PIN
during the Check PIN state.
EXAMPLE
An example of a Check FIT state is shown in Table 4-54. This example state
directs the terminal to do the following:
4-120
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
- 300 if the Institution ID from the card does not match an Institution ID
in the FIT entries
Entry Value
State Type @B b/
4-121
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Check PIN state table is shown in Table 4-55. The Check
PIN state data directs the terminal to verify the PIN entered by the consumer.
The terminal must perform a Check FIT state and an Information Entry state
(@D) before performing a Check PIN state. The Information Entry state is
used for PIN entry.
NOTE
State Type @C b/
The following paragraphs describe each entry in the Check PIN state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
4-122
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: @C b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
PIN Buffer ID
Valid Range: 064
Description: The only valid entry for this state is 064.
Data in the consumer’s associated FIT entry determines whether the terminal
uses the state’s PIN Retry Count entry or the PIN Retry Count recorded on the
consumer’s card. For detailed information on the FlT entries, refer to the Data
Security Procedures and Reference Manual (TP-799530-001D).
4-123
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The terminal resets the PIN Retry Counter each time it executes a state that
contains a PIN Retry Count entry.
If this entry is included in the Check FIT state, the Check PIN state should include
no PIN Retry Count entry. Upon executing the Check FlT state, the terminal
loads the entry value into the PIN Retry Counter. The terminal then decrements
the counter each time the consumer enters a bad PIN during the Check PIN state.
If this entry is included in the Check PIN state, the terminal performs the
following state sequence:
1. The terminal enters an Information Entry state that prompts the consumer
to enter a PIN number. The Format Template Full Next State entry of this
Information Entry state is a Check PIN state.
2. The terminal enters the Check PIN state and loads the PIN Retry Count
entry value into the PIN Retry Counter. The terminal decreases the value
of the counter each time the consumer enters a bad PIN.
3. If the consumer entered a bad PIN, the counter is decreased and the
terminal enters the No Match Next State specified in the Check PIN state.
The No Match Next State entry is a second Information Entry state.
4. The second Information Entry state informs the consumer that an invalid
PIN has been entered and prompts the consumer for a new PIN. The
Format Template Full Next State entry of this second Information Entry
state is a different Check PIN state that has no PIN Retry Count entry.
5. If the consumer entered another bad PIN, the value of the counter
specified in Step 2 is decreased and the terminal enters the No Match
Next State specified in the second Check PIN state. The No Match Next
State entry is the same Information Entry state specified in Step 4.
6. If the PIN Retry Counter reaches zero, the terminal exits to the state
specified in the Maximum Bad PINs Next State entry. This Next State
entry should be included in the second Check PIN state specified in Step 5.
Specifying a PIN Retry Count in the second Check PIN state resets the PIN Retry
Counter, making it impossible for the counter to reach zero.
EXAMPLE
An example of a Check PIN state is shown in Table 4-56. This example state
directs the terminal to do the following:
• Verify the consumer-entered PIN according to the directions in the FIT entry
4-124
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
- 050 if the FIT entry tells the terminal to perform PIN verification and the
PIN entered by the consumer is correct
- 060 if the FIT entry tells the terminal to perform PIN verification and
the PIN entered by the consumer is incorrect
- 095 if the FIT entry tells the terminal to send the PIN to the network for
verification
Entry Value
State Type @C b/
4-125
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Information Entry state table is shown in Table 4-57. The
terminal uses the Information Entry state data to allow the consumer to enter
information.
To allow the consumer to enter information, the State data calls Screen #1 along
with a format template or Screen #2 or both. With optional entries, this state
can also do the following:
• Define the type of entry allowed (numeric key, function key, or both)
If the consumer must press several function keys during a transaction, the
terminal must use a separate Information Entry state for each function key
keypress.
The values of Timeout #1 and Timeout #2 determine the amount of time allowed
for the consumer to enter information. The terminal goes to the states defined
by the Timeout Next State numbers if the consumer does not complete the
information entry in the allotted time.
For example, the network might choose to allow a consumer 15 ticks to enter the
first digit of a transaction amount, but only 5 ticks for each digit that follows the
first. The Number of Keys (First Timeout) entry would contain 001, the Timeout
#1 entry would contain 015, and the Timeout #2 entry would contain 005.
The Information Entry state can also be used for PIN entry. In this case, a special
value must be placed in the Number Key Buffer ID entry to indicate PIN entry
and ensure proper encryption of the entered PIN.
Because the state data does not use record separators (RSs) to identify the
individual optional entries, the terminal requires that the state data contain the
optional entries up to, and including, the final desired entry. Intermediate entries
that are not desired must contain an applicable disabling value. Intermediate
optional entries cannot be skipped. However, the terminal does not require any
of the optional entries after the final desired entry.
NOTE
If the state is used to accept data from the keypad (the typical
use), it is mandatory, as a minimum, that all the entries up
to and including the Function Key A Next State be defined,
even if no keys are enabled.
4-126
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
NOTE
State Type @D b/
The following paragraphs describe each entry in the Information Entry state.
4-127
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @D b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Screen #1
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen #1 entry specifies the number of the first screen
that the terminal shows on the consumer display when the terminal enters the
Information Entry state. This screen must leave the display’s cursor positioned
at the beginning of the format template area or the overlay screen (Screen
#2). The valid values are as follows:
Screen #2
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen #2 entry specifies the number of an overlay screen that
can be used in place of, or along with, a format template. If the state does not use
Screen #2, set this entry to 000. The valid values are as follows:
If the consumer chooses Yes, the terminal restarts the Information Entry state
from the beginning, regardless of which timeout occurred. If the consumer
chooses No, the terminal exits to the timeout next state associated with the
timeout period that occurred.
If the entry is set to 000 (disabled) and either Timeout #1 or Timeout #2 expires,
the terminal exits to the timeout next state associated with the timeout period
that occurred.
4-128
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Timeout #1
Valid Range: 000 through 255, 900 through 931, and 999
Description: The Timeout #1 entry defines the amount of time that the terminal
waits for the consumer to press each key defined by the Number of Keys entry.
If this time expires before the consumer presses a key, the terminal goes to
the exit state identified by the Timeout #1 Next State entry. The valid values
for this entry are as follows:
Timeout #2
Valid Range: 000 through 255, 900 through 931, and 999
Description: The Timeout #2 entry defines the amount of time that the terminal
waits for the consumer to press each key. The terminal uses this timeout after
the consumer presses all the keys defined by the Number of Keys entry. If the
Number of Keys entry contains a 255, the terminal ignores Timeout #2.
If this time expires before the consumer presses a key, the terminal goes to
the exit state identified by the Timeout #2 Next State entry. The valid values
for this entry are as follows:
4-129
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
If all keypresses are timed by Timeout #1, this entry must be set to 255. This
setting also disables Timeout #2. The valid values for this entry are as follows:
The value 064 indicates thatthis instance of the state is being used for PIN
entry. This value causes Agilis 91x for ix to automatically encrypt the
entered PIN (based on the applicable FIT entry, and using the terminal’s
encryption/decryption device).
NOTE
If this state is used for PIN entry, the only valid value for the
numeric key buffer ID is 064 (buffer @).
Enter 255 to disable this entry. When this entry contains 255, the terminal
remains in the Information Entry state until the consumer presses a function key,
even when the format template is full.
• 000 - Do not place the value of the pressed key in any buffer
• 065 through 090 (A through Z), and 256 through 355 - Buffer ID
4-130
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
A value of 001 in this entry represents the first (left-most) byte in the buffer. In
a buffer with a length of 255 bytes, a value of 255 in this entry represents the
last (right-most) byte in the buffer.
lf a timeout occurs while waiting for a consumer to press a key, the terminal
places an * (asterisk) in the specified Function Key Buffer position. If the
terminal takes the Format Template Full Next State as an exit, the terminal places
a + (plus sign) in the specified Function Key Buffer position.
Refer to Figure 4-2 for an example in which the function key byte is defined
as the fourth-from-start byte because the value of the Function Key Buffer
Byte From Start entry is 004.
g1959026
Figure 4-2 Example Function Key Buffer Byte from Start Entry
4-131
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
• Disable Screen #2
• Call format template 002, enabling the numeric keys of the keypad
• Place the key code for any function key pressed into the third byte of buffer O
In the table, the state data requires a Next State entry of 255 to disable function
keys B and D, but does not require any entries for function keys F through M.
Entry Value
State Type @D b/
Screen #1 026
Screen #2 000
Timeout #1 008
4-132
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Entry Value
4-133
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The Buffer Compare state is a general purpose state that compares the contents of
two buffers. As with other enhanced states, the state’s format and length are
specific to its purpose (it does not conform to the 9000 style of fixed-length
state tables).
An offset value can be used to ignore certain characters from the right end of a
buffer. The least significant character has an offset value of 1. The offset value
indicates the last character considered for the comparison. All characters to the
right of the offset value are ignored. An offset value of 1 indicates that all
characters in the buffer should be compared.
Several state entries can be defined to indicate the next state operation, which is
determined by the values compared in two buffers. The good next state operation
is one of the following conditions:
If the data contained in either buffer is not valid for the specified compare
mode or a problem was encountered retrieving the buffer to compare, an error
next state diverts state flow.
The state entries for use with the Buffer Compare state (@E) are shown
in Table 4-59.
State Type @E b/
Buffer_1 Value < Buffer_2 Value Next State Valid state numbers
Buffer_1 Value > Buffer_2 Value Next State Valid state numbers
4-134
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The following paragraphs describe each entry in the Buffer Compare state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @E b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Compare Mode
Valid Range: 001 and 002
Description: The Compare Mode entry tells the terminal the type of compare
mode to use when comparing the contents of two buffers. The valid values
are as follows:
If the buffers are not the same length, then the shorter buffer is padded to the left
before the compare operation. The compare mode pads the shorter buffer with
ASCII zeros (hex 30) for ASCII data and NULLs (hex 00) for binary data.
Buffer_1 ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Buffer_1 ID entry identifies the ID of the first buffer in
the comparison.
Buffer_1 Offset
Valid Range: 001 through Length of Buffer_1
Description: The Buffer_1 Offset entry contains the offset from the end of
Buffer_1. The end position (offset equal to one) is the least significant value
moving left to the more significant values.
Buffer_2 ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Buffer_2 ID entry identifies the ID of the second buffer
in the comparison.
4-135
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer_2 Offset
Valid Range: 001 through Length of Buffer_2
Description: The Buffer_2 Offset entry contains the offset from the end of
Buffer_2. The end position (offset equal to one) is the least significant value
moving left to the more significant values.
4-136
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Set Buffer state table is shown in Table 4-60. The Set Buffer
state data directs the terminal to set specific bytes in an existing buffer to the
values contained in the state data and then to exit to another state.
The Set Buffer state does not create a buffer. That is, it cannot be used to redefine
the length of an existing buffer or to create a new buffer. The Set Buffer state
can only be used to change data bytes in an existing buffer. For information on
creating buffers, refer to Section 4.5.22.
The terminal enters the first value of the state data into the buffer position
indicated by the Most Significant Byte from Start entry. The terminal enters the
remaining values, in succession, into the buffer positions to the right of the Most
Significant Byte from Start (bytes of lesser significance). A Value entry of 255
causes no change to a current buffer position. Therefore, an existing buffer byte
that must not be changed can be skipped.
NOTE
To use the Set Buffer state, the network must either use a buffer
that already exists or define a buffer before using the state.
The network defines buffers with Write Command messages,
Function Command messages (Section 5), or using the Create
Buffer state (@L b/).
The number of Value entries that can be assigned to a Set Buffer state is limited
by the size of the existing buffer and by the starting position within the buffer.
State Type @F b/
The following paragraphs describe each entry in the Set Buffer state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
4-137
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @F b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Buffer ID entry identifies the buffer being set.
A value of 001 in this entry represents the first (left-most) byte in the buffer. In
a buffer with a length of 255 bytes, a value of 255 in this entry represents the
last (right-most) byte in the buffer.
Refer to Figure 4-3 for an example in which the most significant byte is defined
as the fourth-from-start byte because the value of the Most Significant Byte From
Start entry is 004.
4-138
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
g1959027
Value
Valid Range: 000 through 255
Description: This entry contains the value to place in a buffer.
An example of a Set Buffer state is shown in Table 4-61. This example state
directs the terminal to do the following:
EXAMPLE
The example in Figure 4-4 shows the contents of buffer B before and after the
terminal performs the example Set Buffer state.
Entry Value
State Type @F b/
Value 065
Value 255
Value 050
4-139
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
g1959028
4-140
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Buffer Copy state table is shown in Table 4-62. The Buffer
Copy state copies a buffer to another buffer.
State Type @G b/
The following paragraphs describe each entry in the Buffer Copy state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @G b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Source Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Source Buffer ID is the ID of the buffer that contains data to be
copied. This entry should be set to the decimal ASCII value of the Buffer ID
to be used. For example, to use the Dollar Buffer (that is, buffer A), this entry
must be set to 065.
Destination Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
4-141
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of a Buffer Copy state is shown in Table 4-63. This example state
directs the terminal to do the following:
Entry Value
State Type @G b/
4-142
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Check Buffer state table is shown in Table 4-64. The Check
Buffer state data directs the terminal to check a buffer for a match with the values
contained in the state data. The terminal then goes to another state depending
on whether the value in the buffer was less than, equal to, or greater than the
value(s) in the state data.
NOTE
State Type @H b/
Buffer Data Less Than State Data Next Valid state numbers
State
Buffer Data Equal To State Data Next State Valid state numbers
Buffer Data Greater Than State Data Next Valid state numbers
State
The following paragraphs describe each entry in the Check Buffer state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
4-143
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @H b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Compare Mode
Valid Range: 001 and 002
Description: When the Check Buffer state compares its values with the data
bytes in the buffer, the state starts the compare operation a specified number of
bytes from the last byte in the buffer. The starting byte in the buffer is specified
by the Least Significant Byte from End entry. The state compares the buffer
bytes to the left of the starting byte with the bytes (values) specified in the state.
If the buffer contains more data bytes than the state, the state compares only the
number of bytes specified by the state. If the buffer contains fewer data bytes than
the state, the state pads the buffer temporarily to equalize the number of bytes.
Compare Mode entry 001 pads the buffer with ASCII NULL characters (hex 00).
Compare Mode entry 002 pads the buffer with ASCII 0 characters (hex 30). In
the following examples, assume the following conditions:
• The buffer contains ASCII 00XX (XX represents the last two bytes in the
buffer. These bytes are ignored in the compare operation because of the
Least Significant Byte From End entry)
Compare Mode entry 001 pads the buffer to look like NULL00XX. The NULL is
compared to the state data’s most significant ASCII 0, and the buffer would be
declared Less Than.
Compare Mode entry 002 pads the buffer to look like 000XX. The ASCII 0 is
compared to the state data’s most significant ASCII 0, and the buffer would be
declared Equal To.
Compare Mode entry 001 should be used for ASCII chart-ranking-type compare
operations, and Compare Mode entry 002 should be used for true numeric
compare operations. The Compare Mode padding is done for compare purposes
only. The padding does not change the physical length of the buffer data.
4-144
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Buffer ID entry identifies a buffer.
A value of 001 in this entry represents the last (right-most) byte in the buffer. In
a buffer with a length of 255 bytes, a value of 255 in this entry represents the
first (left-most) byte in the buffer.
Refer to Figure 4-5 for an example in which the least significant byte is defined
as the third-to-last byte because the value of the Least Significant Byte From
End entry is 003.
g1959029
Value
Valid Range: 000 through 255
Description: The Value entry contains the value to look for in a buffer. The
value entered must be the decimal equivalent of the ASCII Hex value. For
example, 1 is entered as 049.
4-145
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
Entry Value
State Type @H b/
Buffer ID 066
Value 049
If buffer B contains 123, the least significant byte from the end is 1 and equals
the value of 1 (049) in the Value entry. The terminal takes the Buffer Data
Equal to State data Next State exit.
If buffer B contains 321, the least significant byte from the end is 3 which is
greater than the value of 1 (049) in the Value entry. The terminal takes the Buffer
Data Greater Than State Data Next State exit.
If buffer B contains 012, the least significant byte from the end is 0 which is less
than the value of 1 (049) in the Value entry. The terminal takes the Buffer Data
Less Than State Data Next State exit.
4-146
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• The amount of time the terminal waits for the network’s response message
• The state the terminal goes to if the network does not respond within
the specified time
State Type @I b/
The following paragraphs describe each entry in the Transaction Request state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
4-147
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @I b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen that
the terminal shows on the consumer display when the terminal enters the state.
The valid values for this entry are as follows:
If this time expires before the network responds, the terminal goes to the exit
state identified by the Network Response Timeout Next State entry.
Format Indicator
Valid Range: 000 and 001
Description: This entry indicates the format of the message. The valid values
are as follows:
• 000 - Format 0
• 001 - Format 1
4-148
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
If the PIN is included in the message, the PIN is in encrypted form, based
on the applicable FIT entry.
4-149
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Description: This entry indicates whether general purpose buffer B data, general
purpose buffer C data, or both should be sent in the Consumer Request message.
The valid values are as follows:
NOTE
If the Cancel Key Enable Flag entry is 128, the next two
entries, Cancel Key Next State and Cancel After Function
Next State, must be included.
Buffer ID
Valid Range: 064 through 090, and 256 through 355
Description: The Buffer ID entry indicates the ID of the buffer to be sent. This
entry can be repeated as needed if multiple buffers need to be sent.
EXAMPLE
• Show screen 200 upon entering the state (usually a screen that asks the
consumer to please wait)
4-150
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
- Track 2 data
- Track 1 and 3 data
- Function Key data
- Dollar Buffer data
- Consumer-entered PIN
- General Purpose Buffer B data
• Exit to state number 300 if the network does not respond within 30 ticks
If the terminal receives the network message within the 30-tick time limit, it
performs any function commanded by the network and then exits to the Good
Operation Next State identified in the network message.
Entry Value
State Type @I b/
State Type @I b/
4-151
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The following paragraphs describe the entries in the Transaction Request state
different for format 1.
Format Indicator
Valid Range: 001
Description: The Format Indicator entry indicates that this is a format 1
Transaction Request state.
Buffer ID
Valid Range: 064 (consumer-entered PIN), 065 through 090 (buffers A through
Z), and 256 through 299 (enhanced buffers)
Description: The Buffer ID entry indicates the ID of the buffer to be sent. This
entry can be repeated as needed if multiple buffers need to be sent. The value 064
specifies sending the consumer-entered PIN. If the PIN data is included in the
message, the PIN is in encrypted form, based on the applicable FIT entry.
4-152
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Indirect Next state table is shown in Table 4-69. The Indirect
Next state data directs the terminal to go to alternate states based on matching a
value in a buffer or the value of the PSTDX entry from the consumer’s associated
FIT entry. Refer to the Data Security Procedures and Reference Manual
(TP-799530-001D) for a detailed description of the PSTDX entry in the FIT.
A maximum of 100 alternate Next State entries can be defined in this state. If
more than 100 state entries are defined, only the first 100 are used.
If the Buffer ID entry contains a value of 000, the terminal compares the values
in the state data to the PSTDX entry. Since the Buffer ID entry can also
contain @ and A through Z, the terminal can also use this state as a limited
Check Buffer state.
If no match is found between the values in the state data and the PSTDX value
or the buffer value, the terminal goes to the Network Fault Next State exit. A
no match condition usually occurs because the state does not contain enough
comparison values.
NOTE
The terminal requires that the state data contain all the Next
State entries up to, and including, the Next State for the
final desired matching value. Intermediate entries cannot be
skipped. For example, if the final desired matching value is
10 and matching values 01 through 09 is not important,
the Next State if Value entries for 01 through 09 must be
included in the state data.
State Type @K b/
The following paragraphs describe each entry in the Indirect Next state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
4-153
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @K b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Buffer ID
Valid Range: 000, 064 through 090 (@, and A through Z), and 256 through 355
Description: The Buffer ID entry identifies the buffer to be matched. If the Buffer
ID entry is 000, then the terminal reads the value from the PSTDX FIT entry.
When buffer data is compared to state data values, the terminal uses the values in
the first two buffer positions (most significant bytes) to match the state data
values as follows:
NOTE
4-154
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
30 & 30 = 00
30 & 31 = 01
30 & 32 = 02
• • •
• • •
• • •
39 & 38 = 98
39 & 39 = 99
If the buffer is defined as one byte long, the terminal uses only that byte to
match the state data values as follows:
NOTE
30 = 00
31 = 01
• • •
• • •
• • •
38 = 08
39 = 09
When the buffer is one byte long, a maximum of 10 alternate Next State entries
can be defined in the state. If more than 10 states are defined, only the first 10
are used.
The value of the PSTDX entry might be limited in some FIT systems. Therefore,
when a PSTDX entry is compared to the state data values, the maximum
number of alternate Next State entries is equal to the range of PSTDX values
in the FIT. If more than the maximum are defined, only the values up to and
including the maximum are used.
4-155
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of an Indirect Next state is shown in Table 4-70. This example state
directs the terminal to do the following:
- 010 if the PSTDX entry does not equal any of the values listed in the
state data
Entry Value
State Type @K b/
Buffer ID 000
4-156
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Create Buffer state table is shown in Table 4-71. The Create
Buffer state data directs the terminal to create the buffer specified by the Buffer
ID entry and to fill the buffer with the data specified in the Value byte entries. A
maximum of 38 Value byte entries can be defined in this state. If more than 38
Value bytes are defined, only the first 38 are used.
NOTE
The terminal enters the first value in the state data into the
Most Significant Byte buffer position (first or left-most
buffer position). The terminal enters the remaining values,
in succession, into the buffer positions to the right of the
Most Significant Byte.
The following list defines some of the uses for the Create Buffer state:
• Clearing a buffer
State Type @L b/
• •
• •
4-157
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The following paragraphs describe each entry in the Create Buffer state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @L b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Buffer ID entry identifies the buffer being created.
Value
Valid Range: 000 through 255
Description: This entry contains the value to place in a buffer.
EXAMPLE
An example of a Create Buffer state is shown in Table 4-72. This example state
directs the terminal to do the following:
4-158
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Entry Value
State Type @L b/
Buffer ID 074
Value 084
Value 072
Value 073
Value 083
Value 032
Value 073
Value 083
Value 032
Value 074
4-159
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Track Buffer Compare state table is shown in Table 4-73.
The Track Buffer Compare state examines track data to define the terminal’s
personality for the current consumer. The state provides conditional branching
of the state table sequence and can change the index for Indirect Next State
processing.
State Type @M b/
The following paragraphs describe each entry in the Track Buffer Compare state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related State data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of State
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @M b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
4-160
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer ID/Delimiter
Valid Range: 000 through 003, 016 through 019, and 032 through 035
Description: When this entry is converted to hexadecimal, the first digit must
be 0 through 2 and the second 0 through 3. This entry specifies the track to
examine for matching characters, along with the position (in conjunction with the
Delimiter Index) in the track.
The first hexadecimal digit specifies the track data buffer as follows:
• 0 - Track 2
• 1 - Track 3
• 2 - Track 1
The second hexadecimal digit specifies a track delimiter and a direction for
applying the offset in the Delimiter Index as follows:
Delimiter Index
Valid Range: 000 through 999
Description: This entry specifies the number of characters to offset from the
delimiter to locate the data for comparing with the six Match Characters. The
first character after the delimiter is offset 000.
Match Character
Valid Range: 048 through 057, and 063
Description: These entries specify the characters to compare with those in the
track buffer. Hexadecimal 3F (063) always matches any buffer character.
4-161
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
• Exit to state number 050 if the data in the specified buffer matches all six
match characters
• Exit to state number 060 if the data in the specified buffer does not match
all six match characters
• The track delimiter is the start sentinel and the direction is count forward
when applying the offset in the Delimiter index entry.
• The number of characters to offset from the delimiter (refer to the two
items immediately preceding) to locate records for comparing with 6
match characters is 010.
• The six entries to compare with those in the track buffer are 049, 048,
056, 052, 053, and 051.
Entry Value
State Type @M b/
4-162
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The Buffer Shift state allows the user to shift or rotate the data in a buffer to the
left or right. If shifting, it shifts a user-supplied pad character into the buffer.
The buffer size is not affected by this state. The format of the Buffer Shift
state table is shown in Table 4-75.
State Type @N b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Data Range: @N b/
Description: This State Type identifies this state table as a Shift Buffer state.
4-163
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer ID
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: The Buffer ID is the ID of the buffer containing data to be
shifted. This entry should be set to the decimal ASCII value of the Buffer ID
to be used. For example, to use the Dollar Buffer (that is, buffer A), this entry
should be set to 065.
Operation
Valid Data Range: 001 through 004
Description: The Operation entry tells the terminal which operation to perform
during the state. The valid values for the Shift Buffer state are as follows:
On a shift operation, the pad character is used to fill in the positions being shifted
out of. On a rotate operation, the character in the last buffer position is shifted
into the first buffer position or vice versa based on direction.
Pad Character
Valid Data Range: 000 through 255
Description: The Pad Character entry contains the value to be placed into the
buffer positions that characters are shifted out of if a shift operation is being
used. The value entered must be the decimal equivalent of the ASCII Hex value.
For example, 0 would be entered as 048.
4-164
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The Buffer Arithmetic state adds or subtracts buffers. This state assumes that the
buffers being added or subtracted contain ASCII numeric characters 0 through 9.
The result is also an ASCII numeric buffer. The result buffer is unsigned, with
the exit next state indicating a positive or negative result. For subtraction, the
Negative Result Next State is taken if Buffer 2 is larger than Buffer 1. Otherwise,
the Positive Result Next State is taken. In addition, the Positive Result Next
State exit is always taken.
State Type @O b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Data Range: @O b/
Description: This State Type identifies this state table as a Buffer Arithmetic
state.
4-165
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer 1 ID
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: This is the ID of the buffer that contains the value to be added to
or subtracted from.
Buffer 2 ID
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: This entry contains the buffer ID of the buffer that contains the
value to be added or subtracted.
Result Buffer ID
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: This entry contains the buffer ID of the buffer to contain the result
of the given operation. This entry can be the same buffer ID as given in either
Buffer 1 ID or Buffer 2 ID. The length of this buffer is the length of the larger
of the two source buffers. In the case of addition, the buffer is one byte larger
than the larger of the two source buffers if the result is larger because of a
carry-on to the most significant place.
Operation to Perform
Valid Data Range: 000 and 001
Description: This entry identifies the operation to be performed with the
specified buffers. The valid values are as follows:
• 000 - This value directs the terminal to add Buffer 1 and Buffer 2 and place
the result in the result buffer specified.
NOTE
• 001 - This value directs the terminal to subtract Buffer 2 from Buffer 1.
The result buffer always contains the difference between the two buffers
(a positive value). If the contents of Buffer 2 is larger than Buffer 1, the
Negative Result Next State path is taken. Otherwise, the Positive Result
Next State path is used. The result buffer is always the same length as the
longer of Buffers 1 and 2.
4-166
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The Copy Buffer Data state allows the user to copy all or part of one buffer into
all or part of another buffer. The data can be copied in either direction (left to
right or right to left) thus enabling the user to invert the data if they so desire.
The user also can pad the unused portions of the destination buffer with a leading
and trailing pad character. The destination buffer size is not altered by this state.
The format of the Copy Buffer Data state table is shown in Table 4-77.
NOTE
The Copy Buffer Data state should not be used with the PIN
buffer since the PIN buffer is encrypted.
State Type @P b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
4-167
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Data Range: @P b/
Description: This State Type identifies this state table as a Copy Buffer Data
state.
Source Buffer ID
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
Description: The Source Buffer ID is the ID of the buffer containing data to
be copied. This entry should be set to the decimal ASCII value of the Buffer
ID to be used. For example, to use the Dollar Buffer (that is, buffer A), this
entry should be set to 065.
• 000 - Left to Right. Copy source data starting from the beginning of the
buffer to the end.
• 001 - Right to Left. Copy source data starting from the end of the buffer
to the beginning.
NOTE
Destination Buffer ID
Valid Data Range: 064 through 090 (@ through Z), and 256 through 355
4-168
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Description: The Destination Buffer ID is the ID of the buffer where the data is
copied to. This entry should be set to the decimal ASCII value of the Buffer
ID to be used. For example, to use the Dollar Buffer (that is, buffer A), this
entry should be set to 065.
• 000 - Left to Right. Copy source data starting from the beginning of the
buffer to the end.
• 001 - Right to Left. Copy source data starting from the end of the buffer
to the beginning.
NOTE
Truncation Allowed
Valid Data Range: 000 and 001
Description: The Truncation Allowed entry is used to indicate if there is not the
indicated amount of data available to be copied, or not enough room to copy to, if
the operation should be completed with space available and still take the Good
Operation Next State exit, or do not perform the operation and take the Fault
Operation Next State exit. The valid values are as follows:
• 000 - Take fault operation next state exit without performing copy if unable
to perform complete copy as indicated.
• 001 - Copy partial data as available resources dictate and take good next
state exit.
Pad Enable
Valid Data Range: 000 through 003
4-169
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Description: The Pad Enable entry indicates if the parts of the destination
buffer that are not receiving data should be filled with a pad character. The
valid values are as follows:
• 001 - Fill unused buffer before destination offset with leading pad character.
Locations are dependent on destination direction. Start of buffer to character
before destination offset if left to right and End of buffer to character
after offset if right to left.
• 002 - Fill unused buffer after copied data with trailing pad character.
Locations are dependent on destination direction. After last copied character
to end of buffer if destination direction is left to right and start of buffer to
character before last character copied if right to left.
• 003 - Pad both before and after as described above for values 001 and 002.
4-170
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Buffer Overlay state table is shown in Table 4-78. The Buffer
Overlay state data directs the terminal to copy the bytes in one existing buffer
(overlay buffer) over the bytes in another existing buffer (base buffer) starting at
an offset value contained in the state data. The terminal then exits to another state.
The Buffer Overlay state does not create any new buffers or alter the length of
the existing buffers. The Buffer Overlay state can only be used to overlay the
data in one existing buffer with the data in another existing buffer. If the base
buffer is shorter than the overlay buffer, only those bytes overlaid by the (longer)
overlay buffer are changed in the base buffer.
The terminal enters the first byte of the overlay buffer into the base buffer
position indicated by the Most Significant Byte From Start entry. The terminal
enters the remaining bytes until the entire overlay buffer is copied into the base
buffer or until the base buffer end is reached, whichever happens first.
NOTE
State Type @Q b/
The following paragraphs describe each entry in the Buffer Overlay state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
4-171
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: @Q b/
Description: The State Type entry identifies the specific type of state data entries
associated with a particular state number. The State Type entry is considered
to be part of the state data.
Base Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Base Buffer ID is the ID of the buffer overwritten by the
Overlay Buffer. This entry is set to the decimal ASCII value of the Buffer ID
to be used. For example, to use the Dollar Buffer (that is, buffer A), this entry
is set to 065.
Overlay Buffer ID
Valid Range: 064 through 090 (@, and A through Z), and 256 through 355
Description: The Overlay Buffer ID is the ID of the buffer that overwrites the
data in the Base buffer. This entry should be set to the decimal ASCII value
of the Buffer ID to be used. For example, to use the Dollar Buffer (that is,
buffer A), this entry is set to 065.
A value of 001 in this entry represents the first (left-most) byte in the buffer. In
a buffer with a length of 255 bytes, a value of 255 in this entry represents the
last (right-most) byte in the buffer.
Refer to Figure 4-6 for an example in which the most significant byte is defined
as the fourth-from-start byte because the value of the Most Significant Byte From
Start entry is 004.
4-172
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
g1959030
EXAMPLE
An example of a Buffer Overlay state is shown in Table 4-79. This example state
directs the terminal to do the following:
The example at the bottom of Table 4-79 shows the contents of Buffer A before
and after the terminal performs the example Buffer Overlay state.
State Type @Q b/
4-173
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
g1959031
4-174
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Time Delay state table is shown in Table 4-80. The Time
Delay state delays state sequencing for the amount of time specified in the
Time Delay Timeout value.
A Time Delay state with an Operation value of 001 starts the timing. A Time
Delay state with an Operation value of 002 stops timing only after the value
specified in with the Time Delay Timeout value expires. The Time Delay
Timeout value is only included when the Operation value is 2.
State Type @S b/
The following paragraphs describe each entry in the Time Delay state.
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @S b/
Description: The State Type entry identifies the specific type of state data entries
associated with a particular state number. The State Type entry is considered
to be part of the state data.
4-175
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
Valid Range: 001 and 002
Description: The Operation entry tells the terminal which operation to perform
during the state. The valid values for the Time Delay State entry are as follows:
• 002 - Stop timing. Remain in this state until the elapsed time is greater than
or equal to the Time Delay Timeout value.
Examples of Time Delay states are shown in Table 4-81 and Table 4-82.
EXAMPLE 1
Entry Value
State Type @S b/
Operation 001
EXAMPLE 2
The example state in Table 4-82 directs the terminal to do the following:
4-176
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
Entry Value
State Type @S b/
Operation 002
4-177
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Multi-tasking State data entries is shown in Table 4-83. This
state allows a transaction to be started by either a card read or by key input. This
is done by starting a Card Reader state (CR) and an Information Entry state
(@D). Whichever one of these states completes first determines what the terminal
does next. There is no Next State number for the Multi-tasking state itself. The
state data in CR and the @D states determines the Next State. The next state to
which the Multi-tasking state goes is determined by the state that terminates first.
State Type @X b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number identifies groups of related State data entries.
The terminal executes a group of related entries by calling their associated
state number while performing either another state or a function commanded
by the network.
State Type
Valid Range: @X b/
Description: The State Type entry identifies the specific type of State data entries
associated with a particular state number. The State Type entry is considered
to be part of the State data.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the terminal enters the
state. The valid values are as follows:
NOTE
With this state, there are three screen numbers that can be
used: the screen number in the @X state data, the screen
number in State #1, or the screen number in State #2. Only
ONE of these three screen numbers should be non-zero.
All three of these states are being executed at the same
time and there is only one consumer display. Therefore,
only one screen can be shown.
4-178
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
State #1
Valid Range: Valid state numbers (Section 4.3.1)
Description: The state number of an Information Entry State (@D) or Card
Read State (CR) that is to be executed.
State #2
Valid Range: Valid state numbers (Section 4.3.1)
Description: The state number of an Information Entry State (@D) or Card
Read State (CR) that is to be executed.
An example of the usage of a Multi-tasking state is shown here. The states used
in this example are defined as follows:
• State #000
• State #461
• State #462
- State Type CR b/
- Unit Number - 001
- Operation - 001
- Screen Number - 000
- Consumer Response Time - 999
- Good Operation Next State - 463
- Consumer Fault Next State - 464
- Hardware Fault Next State - 464
- Network Fault Next State - 464
- Read Conditions - 011
4-179
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
• State #463
- State Type - @B b/
- Match Next State - Valid state numbers (Section 4.3.1)
- No Match Next State - Valid state numbers (Section 4.3.1)
- Hardware Fault Next State - Valid state numbers (Section 4.3.1)
- Network Fault Next State - 464
• State #464
- State Type CR b/
- Unit Number - 001
- Operation - 001
- Screen Number - Valid screen numbers (Section 4.6)
- Consumer Response Time - 915
- Good Operation Next State - 463
- Consumer Fault Next State - 465
- Hardware Fault Next State - 464
- Network Fault Next State - 464
- Read Conditions - 011
• State #465
- State Type - @Z b/
- Good Operation Next State - 000
The state operation in this example starts at state #000. At this point, the terminal
starts up a Card Reader state (CR) with a state number of 462 and an Information
Entry state (@D) with a state number of 461. State 461 waits for a function key
to be pressed (A,B,C,D). State 462 waits for a card to be inserted and read (with
or without fault). The state (either 461 or 462) that completes first determines the
next state for the terminal to perform. If the key is pressed first, the terminal goes
to the next state indicated in state 461. If the card is read first, the terminal goes
to state 463 for a good read or state 464 for a bad read.
4-180
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The Set Language Bank state selects the appropriate language bank to use for
screen retrieval when supporting the multilingual feature. For more details on the
multilingual feature, refer to Section 4.15.
Refer to Table 4-84 for the Set Language Bank state table format.
State Type @Y b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
State Type
Valid Range: @Y b/
Description: The State Type entry identifies the specific type of state data entries
associated with a particular state number. The State Type entry is considered
to be part of the state data.
Next State
Valid Range: Valid state numbers (Section 4.3.1)
Description: The Next State entry specifies the state table that the terminal
processes after establishing the Language Bank number.
4-181
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
The format of the Close state table is shown in Table 4-85. The Close state
data directs the terminal to logically close all device tasks when the consumer
is finished with the terminal. The Close state must always be the last state
of a transaction sequence.
The Close state should not be used to generate any device action or to return the
consumer’s card. Use a Card Reader state to return the consumer’s card before
performing a Close state. Use a Depositor state to retain or return a check or
other document held in escrow in an IDM.
The Close state should never be used for anything except the last state in
transaction sequence. The execution of the Close state declares a consumer to be
finished with the terminal and is, therefore, essential in preparing the terminal for
the next consumer.
State Type @Z b/
State Number
Valid Range: Valid state numbers (Section 4.3.1)
Description: The State Number entry identifies groups of related state data
entries. The terminal executes a group of related entries by calling their
associated state number while performing either another state or a function
commanded by the network.
The State Number entry is a group ID in the Write Command and Function
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
The terminal can use (execute) more than one state of the same type (for
example, multiple Information Entry states) by having a unique state number
assigned to each state.
State Type
Valid Range: @Z b/
Description: The State Type entry identifies the specific type of state data entries
associated with a particular state number. The State Type entry is considered
to be part of the state data.
4-182
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of a Close state is shown in Table 4-86. This example state directs
the terminal to do the following:
State Type @Z b/
4-183
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
All consumer display screens are assigned a three-digit number. The valid screen
number range is 000 through AZZ. Screen numbers 000 through 009, and 900
through 950 are reserved for specific functions defined in Section 4.10. Screens
010 through 899 can be assigned to other functions as required. Screens 951
through AZZ are reserved for use by Agilis NDx.
Normally, the screen number and data are downloaded to the terminal by using the
Write Command 2 message. However, new screens can be sent by the network in
a Function Command message. Unused screens do not need to be downloaded.
[ Response Flag ] [ X ] [ 1 ]
Modifier (Screens) 1 1
4-184
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
The following paragraphs describe the fields specific to the Write Command 2
message.
Screen Number
Field Size: 3 characters
Valid Range: Valid screen numbers (Section 4.6)
Description: This is a three-character field that identifies the screen number for
the screen data that follows.
The parameters used with the ESC ; control sequence are defined as follows:
- 0 - Add the message to the message queue, do not terminate the message
currently in progress.
• mmm - The parameter mmm is used only with voice prompting commands
using control files. This number is a reference to a control file (specifically,
the file CTRLmmm.DAT). The control file defines a list of voice messages,
with delay time and number of repetitions specified for each message in
the list (Section 4.17.1.2).
4-185
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
The ESC ZK control sequence can be used within the quotes to interpret
a designated buffer according to a designated format template. This
control sequence uses the same format templates as defined for screens
(Section 4.17.1.3). The quotes must be included in this field. If the
dollar buffer contains 2000 and the format data is C04ZZZZZ9699, the
command translates the buffer to the string "$20.00" (in this example, screen
004 contains $ and screen 006 contains a decimal point). This string is
then parsed, and a concatenation of .WAV files is generated and played.
Currently, the parsing algorithm only supports U.S. dollar amounts. The
structure of this control sequence is ESC ZK b ff. The parameters of this
control sequence are defined as follows:
NOTE
• ddd - This is a three-digit number that specifies the amount of time to delay
(in 800-millisecond ticks) after displaying the screen, before speaking the
message or processing the control file. The valid range for ddd is 000 to 255.
If multiple messages are queued, this specifies the delay between messages.
Agilis 91x for ix/CSP supports multiple voice prompting commands within any
given screen. However, all such commands must be back-to-back and must
precede screen data with the exception of the screen number and the language
bank number.
4-186
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
• k - This character indicates the key type. The valid values are as follows:
- 0 - numeric key
- Hex 1B (ESC) - function key
• cccc - This field indicates the hexadecimal value of ASCII key code (that is,
0041 for "A", 0042 for "B", 0030 for "0", and so on).
In the special cases where the key type is numeric and the value of cccc
is 0023 (for terminals using .WAV files) or 0021 (for terminals using the
Text To Speech method), the numeric keys are treated as a group and set to
user-defined default messages (that is, key 1 is set to "ONE", key 2 is set to
"TWO", key 3 is set to "THREE", and so on). The default messages are
defined in the file FEEDBACK.DAT (for terminals using .WAV files) or the
file FEEDBACK.TTS (for terminals using the Text To Speech method).
These files reside in the C:\DIEBOLD\TCS directory.
- 00030000 "0.wav"
- 00031000 "1.wav"
- 00032000 "2.wav"
- 00033000 "3.wav"
- 00034000 "4.wav"
- 00035000 "5.wav"
- 00036000 "6.wav"
- 00037000 "7.wav"
- 00038000 "8.wav"
- 00039000 "9.wav"
- 0002E000 "decimal.wav"
- 00030000 "0"
- 00031000 "1"
- 00032000 "2"
- 00033000 "3"
- 00034000 "4"
- 00035000 "5"
- 00036000 "6"
- 00037000 "7"
- 00038000 "8"
- 00039000 "9"
- 0002E000 "decimal"
If necessary, the voice messages specified within the quotes can be changed
in order to default the numeric keys to different voice messages.
4-187
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
Each ESC ZD statement defines one button region. To define more than one
region for a template, multiple ESC ZD sequences must be used, all having
the same template number.
The touch template number ranges from 000 to 998. The key field specifies
which keystroke this region represents. The screen regions are defined by the x
and y numbers, each in a range of 0000 to 9999. The icon number specifies
which button-depressed icon to display in the region when that area of the
screen is touched.
To specify a particular touch template to use with a screen, you must include
an ESC ZC xxx sequence within that screen’s data, where xxx is the number
of the desired touch template. For more details on the touch screen feature,
refer to Section 4.8.
Screen Data
Field Size: Variable
Valid Range:
Description: The variable-length Screen data field represents the data to be
shown on the consumer display. This field always follows a screen number entry.
NOTE
4-188
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
The terminal stores the screen data in terminal memory. The network must
download all appropriate screens after receiving a Power Failure Unsolicited
Status message.
Display Grids
Agilis 91x for ix/CSP terminals have a maximum display grid of 40 columns by
20 rows. However, these terminals can also display a 32-column by 16-row
screen. The alignment of the function keys with the 40-by-20 display grid is
shown in Figure 4-7. The terminal manager can modify the Consumer Display
configuration setting to get either a 40-by-20 display grid or a 32-by-16 display
grid.
003 32 16 Left
004 32 16 Center
As shown, the terminal manager must also select on which side to position the
32-by-16 display grid within the 40-by-20 display grid. Positioning on the right
and left sides and centered is shown in Figure 4-8.
g1959072
4-189
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
g1959073
4-190
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
Displayable Characters
The terminal has the following sets of displayable characters stored in files:
• Standard characters
• Alternate characters
• Mosaic characters
• Predefined icons
Agilis 91x for ix/CSP can show all the standard and alternate characters listed in
Table 4-88 and Table 4-89. The character matrix for the standard and alternate
characters is 5 by 9 dots. Agilis 91x for ix/CSP can also show mosaic characters
(Table 4-90). The character matrix for mosaic characters is 8 dots by 12 dots.
Graphic ASCII (Hex) EBCDIC (Hex) Graphic ASCII (Hex) EBCDIC (Hex)
Space 20 40 @ 40 7C
! 21 4F [1] A 41 C1
" 22 7F B 42 C2
# 23 7B C 43 C3
$ 24 5B D 44 C4
% 25 6C E 45 C5
& 26 50 F 46 C6
’ 27 7D G 47 C7
( 28 4D H 48 C8
) 29 5D I 49 C9
* 2A 5C J 4A D1
+ 2B 4E K 4B D2
, 2C 6B L 4C D3
- 2D 60 M 4D D4
. 2E 4B N 4E D5
/ 2F 61 O 4F D6
0 30 F0 P 50 D7
1 31 F1 Q 51 D8
[1] This cross-reference uses Diebold’s implementation of EBCDIC. The characters noted differ from the
standard IBM EBCDIC characters.
4-191
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
Graphic ASCII (Hex) EBCDIC (Hex) Graphic ASCII (Hex) EBCDIC (Hex)
2 32 F2 R 52 D9
3 33 F3 S 53 E2
4 34 F4 T 54 E3
5 35 F5 U 55 E4
6 36 F6 V 56 E5
7 37 F7 W 57 E6
8 38 F8 X 58 E7
9 39 F9 Y 59 E8
: 3A 7A Z 5A E9
; 3B 5E [ 5B 4A [1]
< 3C 4C \ 5C 6A [1]
= 3D 7E ] 5D 5A [1]
> 3E 6E ^ 5E 5F[1]
? 3F 6F _ 5F 6D
7F 07
[1] This cross-reference uses Diebold’s implementation of EBCDIC. The characters noted differ from the
standard IBM EBCDIC characters.
4-192
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
g1959074
4-193
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
g1959075
4-194
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
g1959076
4-195
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
g1959077
4-196
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Refer to Table 4-91 for a definition of the function of each screen control
sequence. These control sequences are used to clear a screen, insert a screen,
position the cursor, show on the consumer display an additional character listed
in Table 4-89, or display track 1 information at the current cursor position. An
ASCII and EBCDIC cross reference for the screen control sequences is shown
in Table 4-92. The Agilis 91x for ix/CSP consumer display has the following
additional capabilities:
• Allows backspacing
• Allows user-specified delays when displaying characters or graphics
• Shows blinking characters
• Shows inverse video characters
• Shows both blinking and inverse video characters
Screen Delimiters
The field separator and the end of the message are screen delimiters. One of
these two screen delimiters must terminate each screen data field.
Normally, a field separator separates each screen data field in a Write Command
2 message. The end of the message terminates the last screen data field in a
Write Command 2 message.
Control Description
Sequence
FF Clears the screen and positions the cursor to position @,@ on the display grid
HT Causes the consumer’s name encoded on track 1 of the consumer’s card to be shown on the consumer display,
starting at the current consumer display cursor position
SI Sets the cursor to the position specified by the two bytes following SI. The first byte is the row, and the second byte
is the column. Data shown on the screen remains unchanged.
SO Overlays the screen specified by the three bytes following SO. Screen data can be nested or overlayed to five
levels using SO.
VT Shows an alternate character on the consumer display. The byte following VT specifies the alternate character.
ESC B Shows the contents of a buffer, specified by the 1 byte following the ESC B, on the consumer display. Valid
values are @, A through Z.
ESC D Causes a delay in ticks (1 tick = 0.8 second) equal to the 3 bytes following ESC D. The minimum delay is 0.1
seconds. The maximum delay is 255 ticks (204 seconds).
ESC F Specifies a character set (font) for the text that follows the control sequence
ESC G Changes the character set and the display mode. The first byte following ESC G specifies the character set (from 0
to 7). The second byte specifies the display mode (0 = normal, 1 = blinking, 2 = inverse video, 3 = blinking
and reverse video).
4-197
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Control Description
Sequence
ESC H Sets the foreground color for the text that follows the control sequence. When you use ESC H, the background
color is transparent.
ESC J Allows you to use a color wheel on a color. When you use a color wheel, you can change one color to other colors
at the rate you select. You can use color wheels to create special effects, such as blinking and fade-in transitions.
ESC K Scrolls designated text through a specified window on the consumer display.
ESC M Specifies a new video resolution. Each resolution is designated by a resolution mode number nn.
ESC N Allows you to access the extended color set in the 640 x 480 x 16 resolution. ESC N directs the terminal to load the
palette registers associated with palette setup number nnn. Palette registers allow you to select 16-custom colors.
You can map the 16-custom colors to any 16 of the available 256 colors of the current DAC setup.
ESC O Directs the terminal to load the DAC register with values from the DAC file associated with DAC setup number nnn.
ESC T Specifies a background color or pattern in the area around the addressable area.
ESC V Shows on the consumer display the contents of a buffer within the constraints of a format template. The buffer is
specified by the 3 bytes following the ESC V, the first byte specifies the buffer (@, A through Z), the second and
third specify the Format Template number.
ESC X Allows you to position the cursor on the screen to a pixel position identified by a unique pair of (X,Y) coordinates.
ESC ZC Specifies the touch screen template number to activate for the current screen. (not applicable on the CashSource
Plus 400)
ESC ZD Specifies the touch screen configuration information. (not applicable on the CashSource Plus 400)
ESC ZE Provides touch screen configuration data. (Touch screen terminals only.)
ESC ZI Allows you to display touch screen Buttons from the In Button database. (not applicable on the CashSource
Plus 400)
ESC ZO Allows you to display touch screen buttons from the Out Button database. For more details on ESC ZO and the
touch screen option, refer to Section 4.8. (not applicable on the CashSource Plus 400)
ESC ZU Allows you to define screen windows that show video sequences, complete with sound (if the terminal is so
"MPEG- equipped), from MPEG formatted files stored on a CD ROM or system hard disk.
Play"
ESC ZU Used to facilitate the use of MPEG video presentation in the context of Agilis 91x for ix/CSP transaction processing.
Screen This control sequence is to be programmed into the screen data and used in conjunction with the Enhanced
Marker Information Entry state (@D).
ESC ZV Enables a web browser to display contents on the screen. The browser can be configured to coexist with legacy
screen output for a “mixed-mode” effect, or it can be forced to fill the entire screen.
ESC : Displays the date, time, or both on the screen in the format designated in format template screen nnn.
4-198
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Control Description
Sequence
ESC > Provides a fade-in transition between screens from a black screen to colors corresponding to DAC setup number
nnn. This control sequence has the effect of fading the screens contents into view.
ESC ? Provides sprite animation based on the contents of Sprite Definition file nnn.
BS 08 16
CR 0D 0D
FF 0C 0C
HT 09 05
LF 0A 15 or 25
SI 0F 0F
SO 0E 0E
VT 0B 0B
ESC A 1B 41 27 C1
ESC B 1B 42 27 C2
ESC C 1B 43 27 C3
ESC D 1B 44 27 C4
ESC F 1B46 27 C6
ESC G 1B 47 27 C7
ESC H 1B 48 27 C8
ESC I 1B 49 27 C9
ESC J 1B 4A 27 D1
ESC K 1B 4B 27 D2
ESC L 1B 4C 27 D3
ESC M 1B 4D 27 D4
ESC N 1B 4E 27 D5
ESC O 1B 4F 27 D6
ESC P 1B 50 27 D7
ESC Q 1B 51 27 D8
ESC R 1B 52 27 D9
ESC T 1B 54 27 E3
ESC U 1B 55 27 E4
ESC V 1B 56 27 E5
ESC W 1B 57 27 E6
ESC X 1B 58 27 E7
4-199
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
ESC Y 1B 59 27 E8
ESC ZC 1B 5A 43 27 E9 C3
ESC ZD 1B 5A 44 27 E9 C4
ESC ZE 1B 5A 45 27 E9 C5
ESC ZF 1B 5A 46 27 E9 C6
ESC ZI 1B 5A 49 27 E9 C9
ESC ZO 1B 5A 4F 27 E9 D6
ESC ZU 1B 5A 55 27 E9 E4
ESC ZV 1B 5A 56 27 E9 E5
ESC : 1B 3A 27 7A
ESC < 1B 3C 27 4C
ESC = 1B 3D 27 7E
ESC > 1B 3E 27 6E
ESC ? 1B 3F 27 6F
The BS control character moves the cursor to the left by one column in the
current row. If the cursor is already at column @, the cursor wraps to the last
column in the row above.
The CR control character moves the cursor to column @ in the current row.
The FF control character directs the terminal to clear the consumer display, enter
cell mode, and place the cursor at row @, column @. Because attributes are
cleared from the display, the terminal uses font 0 (basic character set) for text.
The HT control character inserts the name from track 1 of the consumer’s card
into the screen data. The terminal displays the name starting at the current
cursor position.
4-200
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
A sample screen using the HT control character to show on the consumer display
the name encoded on track 1 of the card is shown in Figure 4-9. The data used to
create the screen is shown in Table 4-92. However, if track 1 is not successfully
read, no name is shown on the consumer display. Note that the cursor should
be set to column @ to allow a maximum length name (up to 40 characters) to
be shown on the consumer display.
The LF control character moves the cursor down one row in the current column.
If the cursor is already in the bottom row, the cursor wraps to the top row in
the current column.
The SI control sequence moves the cursor to a specified row and column. The
format of the control sequence is as follows:
SI I A
The format used for showing a consumer display screen and positioning the
consumer display screen cursor is shown in Table 4-93. Any of the 20 rows can
be selected by using a row select character from @ through 3. Any of the 40
columns can be selected by using a column select character @ through W. A
sample screen created from the data in Table 4-93 is shown in Figure 4-10.
Table 4-93 Example Screen 018 Data - Use of the HT Control Character
WELCOME 57 45 4C 43 4F 4D 45 Shows the graphic characters on the top row of the screen
SI A @ 0F 41 40 Sets the cursor to the second row and the first column
4-201
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g1959078
Table 4-94 Example Screen 016 Data - Use of the FF and SI Control Sequences
SELECT b/ THE b/ WAY b/ 53 45 4C 45 43 54 20 54 48 45 20 57 41 Shows the graphic characters on the top row of the screen.
YOU b/ WANT b/ TO b/ MAKE 59 20 59 4F 55 20 57 41 4E 54 20 54 4F
20 4D 41 4B 45
SI A @ 0F 41 40 Sets the cursor to the second row and the first column
YOUR b/ CREDIT b/ CARD b/ 59 4F 55 52 20 43 52 45 44 49 54 20 Shows the graphic characters on the second row of the
PAYMENT 43 41 52 44 20 50 41 59 4D 45 4E 54 screen
4-202
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g1959079
Figure 4-10 Example Screen 016 - Use of the FF and SI Control Sequences
The SO control sequence inserts a specified screen into the current screen. The
format of the control sequence is as follows:
SO nnn
A sample screen using the SO control sequence to pick up the first screen
and overlay parts of it to create a new screen is shown in Figure 4-11 and in
Table 4-94. Note that both screens are assigned a unique screen number.
The network uses the SO control sequence to call another screen. This technique
is called nesting. Nesting is accomplished by placing the SO character followed
by a three-digit screen number within a current screen.
Agilis 91x for ix/CSP retains only the last five levels of nesting.
When nested screens are used, the maximum number of characters per screen
is as follows:
The total number of characters for all six screens can be no more than 1,800
characters.
4-203
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The network can use an SO control sequence along with an ESC D control
sequence to show animated screens. In a typical animation sequence, the last
screen calls the first screen again. To prevent infinite nesting when animation is
used, the SO control sequence must be the last instruction in each animation
screen (refer to the examples in Figure 4-12 and Figure 4-15).
Table 4-95 Example Screen 017 Data - Use of the SO Control Sequence
g1959080
4-204
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g1959081
4-205
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The US control character moves the cursor up one row in the current column.
If the cursor is already in the top row, the cursor wraps to the bottom row
in the same column.
The VT control sequence is used to represent character numbers outside the core
range (decimal 32 through 95). The format of the control sequence is as follows:
VT c
The ESC A control sequence displays an animation sequence using icons. VGA
Plus also provides a capability to display animated graphic files. If you wish to
display animated graphic files, refer to Appendix D.
VGA Plus includes several animation sequences as part of the set of prepackaged
icons (Table 4-96), all of which are shown in the VGA Plus Prepackaged Icons
and Character Sets manual, (TP-799508-000A).
4-206
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The valid values for ttt (animation rate) are 000 to 999 (decimal). The animation
rate is computed as follows. When ttt is between 000 and 255, the rate equals
ttt times 0.8 seconds. Thus, if ttt equals 002, each icon is displayed for 002 x
0.8, or 1.6 seconds. When ttt is between 256 and 999, the rate equals (ttt - 255)
times 0.1 second. Thus, if ttt equals 256, each icon is displayed for (256 -
255) x 0.1, or 0.1 second.
The following screen data directs the terminal to display the message PLEASE
TAKE CARD and the Take Card animation sequence (icons 062, 063, and 064).
FF
SI C B
PLEASE
/TAKE
b
/CARD
b
ESC A 062 2 259
The parameter ttt for the ESC A equals 259, therefore the animation rate is (259 -
255) x 0.1 second, or 0.4 seconds. At the start, icon 062 appears with the
message (Figure 4-13). At the end of 0.4 seconds, icon 063 appears and, 0.8
seconds after the start, icon 064 appears. At the end of 1.2 seconds, icon 062
appears again, and the sequence repeats.
4-207
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970A18
4-208
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The terminal displays the contents of the buffer a or aaa. The valid values for a
are @, A through Z. The valid values for aaa are 256 through 355.
The ESC C control sequence establishes colors for displaying text and
prepackaged icons. The format of the control sequence is as follows:
ESC C b f
The terminal displays subsequent text and icons in color f (the foreground
color) against a background of color b (the background color). The background
and foreground colors remain in effect until changed by another ESC C or by
entering the Maintenance mode (Maintenance mode sets the foreground color to
white and the background color to black). Refer to Appendix D.10 for the valid
values for ESC C.
ESC C does not change the color of text and icons already displayed.
The ESC D control sequence delays screen processing for a specified amount of
time. The format of the control sequence is as follows:
ESC D ttt
The terminal delays screen processing for the time specified by the parameter
ttt. The valid values for ttt are 000 to 999 (decimal). The amount of time
is computed as follows. When ttt is between 000 and 255, the time equals ttt
times 0.8 seconds. Thus, if ttt equals 002, processing is delayed for 002 x 0.8,
or 1.6 seconds. When ttt is between 256 and 999, the time equals (ttt - 255)
times 0.1 second. Thus, if ttt equals 256, processing is delayed for (256 -
255) x 0.1, or 0.1 second.
In this example, the terminal displays the Take Card animation sequence that
moves in the direction of the receipt slot (Figure 4-14).
FF
4-209
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
SI C B
PLEASE
/TAKE
b
/CARD
b
SI H C
ESC P 062 0
ESC D 001
ESC P 063 0
ESC D 001
ESC P 064 0
The appearance of movement is achieved by displaying the hand taking the card
in three consecutive positions. The terminal displays the message PLEASE
TAKE CARD and then the Take Card animation sequence.
NOTE
If you use a value less than 004 for ESC D, screen processing
might interfere with other terminal tasks and slow down overall
terminal operation. Usually this is only significant when using
looping animation sequences during a consumer transaction.
4-210
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970b18
4-211
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The ESC F control sequence specifies a character set (font) for the text that
follows the control sequence. The format of the control sequence is as follows:
ESC F f d
The terminal displays subsequent text using character set f and display mode d
(normal, blinking, inverse, or blinking inverse). The valid values for f are 0
through 7, E, F, G, and @. Font changes do not change the font of characters
already displayed.
In addition, Agilis 91x for ix/CSP allows ESC F to be used to select any
TrueType or OpenType font currently installed on the Windows operating
system. The format of the control sequence for this use is as follows:
The font name is shown in double quotes and ppp is the desired point size of
the font.
The character set and display mode remain in effect until changed by another
ESC F or ESC G, ESC M, or by an FF control sequence. The display mode
can also be changed by the ESC P control sequence. For more details on the
display mode, refer to Appendix D.12.
The network uses the ESC G control sequence to change the character set and
the display mode. The first character following the ESC G control characters
specifies the character set. The standard Agilis 91x for ix/CSP terminal has
the following character sets:
The second character following the ESC G control characters specifies the
display mode (Appendix D.12). The valid display modes are as follows:
• 0 - normal
• 1 - blinking
• 2 - inverse video
• 3 - blinking and inverse video
No more than 32 blinking characters should be used on one screen. Only use
reverse video with a 40 column by 20 row display grid.
When ESC G is used, the terminal stores the display mode attribute as the first
character at the current cursor position on the screen. (This position appears
blank.) To compensate for this, the cursor should be positioned one position to
the left of where the text needs to start when an ESC G sequence is inserted.
4-212
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g1959082
Figure 4-15 Example Screen Using the Inverse Video Feature (ESC G)
The ESC H control sequence sets the foreground color for the text that follows
the control sequence. When you use ESC H, the background color is transparent.
ESC H nnn
The terminal uses color nnn for all subsequent text characters. In those resolutions
which permit 256 colors, the valid range for nnn is 000 to 255. In the 640 x 480 x
16 resolution, the valid range is 000 to 015. The background color is transparent.
You can use ESC H to select a color with which to clear the screen. Select
the color just before the FF (clear screen) control sequence. The border is
also set to this color.
ESC H stays in effect until the screen data sets a new color or the screen data
changes the resolution.
4-213
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
In this example, the terminal clears the screen with color 137.
ESC H 137
FF
The actual color the terminal displays for color 137 depends on the DAC setup.
The ESC I control sequence inserts a specified screen into the current screen.
The format of the control sequence is as follows:
ESC I nnn
The terminal processes the screen data contained in screen nnn as if that data
were inserted in the current screen. The current images and attributes remain on
the consumer display. The display characteristics (cursor position, cell or font
mode, bank selection, and row size) that are in effect in the current screen (called
the base screen) carry over to screen nnn. Similarly, the display characteristics in
effect at the end of screen nnn (whether established before ESC I processing or
within screen nnn) carry over to subsequent screen processing.
If the ESC I control sequence is not the last entry in the base screen, after the
terminal finishes processing screen nnn, it returns to the base screen and processes
the remaining entries. You can use ESC I in this way to create composite screens
by using one or more screens as standard parts or templates. You can nest screens
up to five levels deep within the base screen, as shown in the following graphic.
G40970a12
If screen 105 in the preceding figure contained an ESC I control sequence, the
terminal would discard the remainder of screen 100 instead of displaying it.
4-214
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
If the ESC I control sequence is the last entry in the base screen, the terminal
does not return to the base screen after processing screen nnn. You can use
ESC I in this way in combination with the ESC D control sequence to create
repeating screen sequences.
NOTE
The use of templates can increase the efficiency of the system by reducing file
space and configuration time for screen data. This example demonstrates how to
use ESC I to implement templates.
Screen 016 in Figure 4-16 can be used as a template for various payment
transactions by overlaying it with a small amount of additional text. Screen 017
uses screen 016 to generate a prompt for a credit card payment. The screen data
for screen 017 is as follows:
ESC I 016
SI D @
CREDITbCARDbPAYMENT
Screen 018 uses screen 016 to generate a prompt for a mortgage loan payment.
The screen data for screen 018 is as follows:
ESC I 016
SI D @
MORTGAGEbLOANbPAYMENT
4-215
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970a13
4-216
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The ESC J control sequence allows you to use a color wheel on a color. When
you use a color wheel, you can change one color to other colors at the rate you
select. You can use color wheels to create special effects, such as blinking and
fade-in transitions. The format of the control sequence is as follows:
NOTE
ESC J changes DAC register (color) nnn by using the Color Wheel file
designated by sss at rate rrr. The terminating ESC character is part of the
ESC J control sequence; it is not and cannot be used as a control character for
the next control sequence.
Each Color Wheel file defines a set of colors by using a table of red, green,
and blue values.
The parameter nnn designates the DAC register that is to be adjusted with
colors from Color Wheel file designated by sss. The valid values for nnn
are 0 through 255.
The parameter rrr designates the timer rate at which the terminal steps through
values in the Color Wheel file to change the DAC. 000 is about 10ms. Each
count after that adds one system clock time or about 32ms between updates.
The parameter sss designates the color wheel setup number. The color wheel
setup number identifies the Color Wheel file that stores a specific set of values
for the Color Wheel. For example, the color wheel setup number 235 identifies
Color Wheel file CLRW235.DAT. The range for sss is 0 through 511. The list of
sss values is terminated by ESC. Color wheel processing cycles through the
first sss color wheel, then through the second color wheel, up to the number
of sss values listed (512 sss values maximum). Once the terminal reaches the
end of the list of sss values, the terminal repeats the process again starting over
at the first sss setup value. Values for sss of 0 through 50 are reserved for
Diebold preassigned Color Wheel files.
The first 17-preassigned values for the parameter sss provide the color wheels
described in the following table.
4-217
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
sss Description
In the 640 x 480 x 16 resolution, using the default palette register setup, colors 0
through 15 map to DAC registers 0 through 15. Therefore, values of 000 through
015 can be used to make any of the 16 colors cycle through the color wheel.
There can be up to five color wheels active at once. If the terminal finds more
than five ESC J control sequences in the screen data, then the terminal stops the
first one and starts a new one in its place. The next ESC J sequence the terminal
encounters replaces the second one started and so on.
NOTE
Avoid having more than two color wheels active at the same
time with a rate of 10ms (rrr parameter = 000).
This example demonstrates how ESC J cycles the text and icons, displayed with
color 014 on screen 311, through a range of colors.
ESC J 014 000 016 ESC Adjust color 014 at a rate of 10ms by using setup
number 016. File 016 cycles through a range of colors.
SO 311 Insert screen 311 into the current screen. Any text or
icons that screen 311 displays in color 014 undergo color
changes as dictated by Color Wheel file CLRW016.DAT.
4-218
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The ESC K control sequence scrolls designated text through a specified window
on the consumer display. The format for the control sequence is as follows:
The terminal scrolls the text in screen nnn in direction d (up, down, left, or right).
The text scrolls through a window whose top row is row r1 and whose bottom
row is row r2. The window goes completely across the addressable area. The
parameter ttt determines how fast the text is scrolled. The scrolling continues,
repeating screen nnn, until the terminal processes an ESC M or FF control
sequence. The size and position of rows r1 and r2 depends on the current display
format, which is controlled by the ESC = control sequence.
g40970a14
No more than one ESC K can be in effect on the consumer display at any time.
For upward scrolling and downward scrolling, the number of rows scrolled at a
time equals the height of the characters in cells, regardless of the row size in
effect. The text scrolls two rows at a time for helvetica, century, or rolling font
characters. The text scrolls one row at a time for all other prepackaged characters.
Unless modified by an SI control sequence in screen nnn, the text from screen
nnn is placed at the left edge of the addressable area. Upward scrolling starts by
putting the bottom row of the first line on row r2. Downward scrolling starts
by putting the top row of the first line on row r1.
4-219
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
For leftward scrolling and rightward scrolling, text from screen nnn is displayed
and scrolled one character at a time. All the text in screen nnn is treated as a
single line (LF and CR characters are ignored). Leftward scrolling starts by
putting the top row of the first character at the right edge of the addressable
area on row r1. Rightward scrolling starts by putting the top row of the first
character at the left edge on row r1.
You can choose any pair of rows of your addressable area to define the window,
as long as row r1 is not below row r2. You can even have a window that is one
row high, by entering the same value for r1 and r2 (this is typical for left or right
scrolling, for instance). However, the number of rows in the window must be a
multiple of the height (in cells) of the characters in screen nnn. Therefore, for the
helvetica, century, and rolling fonts, the window must be an even number of rows.
For the other prepackaged character sets, the window can be any number of rows.
The valid values for ttt (scrolling rate) are 000 to 999 (decimal). The amount
of time to scroll up or down one line or to scroll left or right one character is
computed as follows. When ttt is between 000 and 255, the amount of time
equals ttt times 0.8 seconds. Thus, if ttt equals 002, the scrolling rate is 002 x 0.8,
or 1.6 seconds for each line or character. When ttt is, the amount of time equals
(ttt - 255) times 0.1 second. Thus, if ttt equals 256, the scrolling rate is (256 -
255) x 0.1, or 0.1 second for each line or character.
In addition to text, screen nnn can contain the following control sequences:
• CR
• ESC C
• ESC F
• ESC G
• SI (up and down scrolling only)
• VT
If screen nnn contains an ESC C control sequence, the color specified by that
ESC C affects only the text in screen nnn.
For up or down scrolling, all the characters in screen nnn must be the same
number of cells high. For example, you can switch back and forth between the
Chinese character sets when scrolling (they are all one cell high). However,
you cannot scroll Chinese and helvetica characters at the same time (helvetica
is two cells high).
4-220
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
For left or right scrolling, any combination of character sets can be put in
screen nnn, but the tallest characters (the characters that are the greatest number
of cells high) should be the first text in the screen. For example, any basic or
Chinese characters should follow the helvetica or century characters. Also, the
trailing character of each character set’s string should be a space character.
The space character creates a clean area for the start of the next character
set as the text is scrolled.
The SI control sequence can be used to position text for scrolling up or down.
The terminal starts the next line of text at the specified column. The row
parameter is ignored (although it must be present).
This example demonstrates how ESC K scrolls text upward. The following
screen data generates the Welcome screen shown in Figure 4-17.
FF
SI C E
ESC P 000 0
SI I @
FOR
/YOUR
b
/CONVENIENCE,
b
SI J @
THIS
/ATM
b
/ALLOWS
b
/YOU
b
/TO:
b
SI 0 @
INSERT
/CARD
b
/FOR
b
/SERVICE
b
ESC K U 200 L N 001
The ESC P control sequence puts the Welcome icon (icon 000) on the screen.
This is followed by the non-scrolling text. The text is placed so as to leave room
for the scrolling window (rows L through N). The ESC K control sequence in
the last line then directs the terminal to scroll the text contained in screen
200, using an animation rate of 0.8 seconds (ttt = 001). Screen 200 contains
a list of ATM services as follows:
WITHDRAW
/CASH CR
b
DEPOSIT
/CHECKS
b
/OR
b
/CASH CR
b
PAY
/THE
b
/BALANCE
b
/ON
b
/
b
YOUR
/CREDIT
b
4-221
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
bCARD CR
/
TRANSFER
/FUNDS
b
/BETWEEN
b
/YOUR
b
/ACCOUNTS CR
b
PAY
/MORTGAGE
b
/LOANS CR
b
CHECK
/YOUR
b
/CURRENT
b
/ACCOUNT
b
/BALANCE CR
b
PRINT
/A
b
/STATEMENT
b
/OF
b
/
b
YOUR
/ACCOUNT CR
b
PAY
/YOUR
b
/ELECTRIC
b
/BILL CR
b
PAY
/YOUR
b
/GAS
b
/BILL CR
b
.
.
.
CR CR
Each text line is terminated with a CR control character. The two extra CRs at
the end generate two blank lines between the end of the list and the next loop of
the list, so that each time the entry WITHDRAW CASH appears, the two rows
above it are blank. This is optional at your discretion. If you omit the two Crs at
the end, the loop becomes seamless.
4-222
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970a19
4-223
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
This example demonstrates how ESC K scrolls text leftward. The following
screen data generates the Welcome screen in Figure 4-18.
FF
SI C E
ESC P 000 0
SI I O
INSERT
/CARD
b
/FOR
b
/SERVICE
b
ESC K L 200 2 3 256
The ESC P control sequence puts the Welcome icon (icon 000) on the screen.
This is followed by the message INSERT CARD FOR SERVICE. The ESC K
control sequence in the last line then directs the terminal to scroll the text
contained in screen 200, using an animation rate of 0.1 second (ttt = 256). The
row designator 2 and 3 indicate that the bottom two rows of the addressable area
are the window for screen 200’s text.
ESC F 1 0
TRY
/OUR
b
/CONVENIENT
b
/NEW
b
/ATMS
b
bAT
/
/OUR
b
/BANK
b
/IN
b
bTHE
/
/RIDGE
b
/VALLEY
b
/SHOPPING
b
bPLAZA.
/
/
b
/
b
/
b
b
/
/
b
The text line is terminated with several blanks to generate a gap between the
end of one loop and the start of the next loop. This gap makes it easier for the
consumer to find the start of the sentence. The ending blanks are optional
at your discretion.
4-224
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970b19
4-225
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The ESC L control sequence designates the correct language bank to use when
the multi-lingual feature is used. The format of this control sequence is ESC L
xxx, where xxx is the language bank number. If you are using the ESC L control
sequence, it must be the first control sequence listed in the screen data. If the
ESC L control sequence is not the first control sequence included in the screen
data, Agilis 91x for ix/CSP uses the default language bank to display the screen.
The language bank number is set in a state as part of Agilis 91x for ix/CSP. For
more details on ESC L and the multi-lingual feature, refer Section 4.15.
The ESC M control sequence specifies the new resolution. Each resolution is
designated by a resolution mode number nn. The format of the control sequence
is as follows:
ESC M nn
Default Resolution
At powerup, the terminal defaults to 640 x 480 x 16 (resolution mode 00). The
default resolution mode remains in effect until the terminal encounters an
ESC M in the screen data.
NOTE
The valid values for ESC M are shown in the following table.
00 640 480 16
NOTE
4-226
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
When the terminal encounters an ESC M in a screen file, the terminal changes
the current resolution to the resolution specified by ESC M, selects the default
DAC and palette registers, and clears the screen to black. The default DAC and
palette register values are in DAC000.DAT and PAL000.DAT files.
When the terminal switches to the new resolution, it sets the foreground color to
white and the background color to black.
When you select a resolution with ESC M, the terminal accesses the appropriate
character set for the resolution you selected. Two complete character sets are
available, the low-resolution modes use the 8-by-12 dot character set and the
high-resolution modes use a 16-by-24 dot character set.
The VGA standard resolution 320 x 200 x 256 allows 320 x 200 x 256 color
icon files to fill the screen. There are many commercial graphic files available
with the 320 x 200 x 256 resolution.
If you are using the default DAC settings, those resolutions which permit 256
colors allow the foreground and background colors you select with ESC C to
work the same way they work in the 16-color mode. However, if you select a
color with ESC H, the background color becomes transparent. When you use
ESC H and the terminal writes a character on the screen, the terminal only
displays the foreground pixels. This makes it possible to overlay a 256-color
custom icon with text without having a blocked-looking background.
Assume you want to display a 320 x 200 x 256 icon in 320 x 200 x 256 resolution.
ESC M 02
ESC O 150
ESC P 150 0
The ESC N control sequence allows you to access the extended color set in
the 640 x 480 x 16 resolution. ESC N directs the terminal to load the palette
registers associated with palette setup number nnn. Palette registers allow you
to select 16-custom colors. You can map the 16-custom colors to any 16 of
the available 256 colors of the current DAC setup. The format of the control
sequence is as follows:
ESC N nnn
The palette setup number ranges from 000 to 255. If desired, you can use ESC
N to display color screen data on a monochrome consumer display. You can
map colors to on or off values. ESC N has no effect if an ESC M placed the
terminal in a resolution which permits 256 colors.
4-227
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
All palette settings, including setup number 000, are contained in files in the
configuration subdirectory for the current resolution. The terminal loads these
files into memory at powerup when Agilis 91x for ix/CSP initializes.
Custom Palette
If desired, you can create a Palette file to setup a custom palette for 16-color
icons. Use ESC N to specify the custom palette.
This example directs the terminal to load palette registers associated with
palette setup number 123.
ESC N 123
The ESC O control sequence directs the terminal to load the DAC register with
values from the DAC file associated with DAC setup number nnn.
NOTE
ESC O nnn
000 Default DAC settings. The default DAC settings are in effect at terminal
powerup or whenever the terminal encounters an ESC M in the screen
data. The default DAC file (DAC000.DAT) contains the 16 EGA colors
used with the Color Graphics Feature, 16 shades of gray, and varying
intensity hues.
When the DAC setup number is 001, the screen remains black while data
is written. Then, you can use ESC > to fade the image into view or ESC O to
flash the image into view.
When you paint the screen, you see the screen fill with the image. Use ESC O
before ESC P if you want to paint the screen with the icon. Use ESC O 001,
ESC P, and then ESC > or ESC O if you want to display the icon without
painting the screen.
4-228
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Custom DAC
DDU provides a custom DAC file for each custom icon that you create. You
should use ESC O or ESC > to specify the setup number for the icon’s custom
DAC file.
This example directs the terminal to set the resolution to 640 x 480 x 256, and
load the DAC registers with values from the DAC001.DAT file, display icon 242
in normal mode, and fade icon 242 into the screen.
ESC M 03
ESC O 001
ESC P 242 0
ESC > 242
ESC O stays in effect until the screen data includes an ESC M or another ESC O.
The ESC P control sequence displays a specified icon. The format of the control
sequence is as follows:
ESC P nnn d
The terminal displays icon nnn in display mode d (normal, blinking, inverse,
blinking inverse, sprinkle, or wipe). The terminal places the upper left corner of
the icon at the current cursor position.
• 0 - Normal video
• 1 - Blinking video
• 2 - Inverse video
• 3 - Blinking inverse video
• 4 - Sprinkle image
• 50 - Wipe image
The icon must be at least 8 pixels across by 8 pixels down for sprinkle to work.
4-229
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
NOTE
Assume you wish to display two full screen 320 x 200 x 256 color icons. This
example fades in one icon, delays about 5 seconds, fades to black, and then fades
in the second icon. The control sequences to accomplish this are as follows:
NOTE
ESC > 176 Fade icon 176 in from black using palette setup
number 176
The ESC Q control sequence displays the check icon at the current cursor
position.
4-230
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The ESC R control sequence repeats a specified cell a specified number of times.
The format of the control sequence is as follows:
ESC R sss b f c
Starting at the current cursor position, the terminal repeats cell c of the current
character set, using background color b and foreground color f. Cell c is
repeated sss times. The cells are put on the consumer display from left to right,
automatically wrapping to the next row when necessary.
g40970a26
For character sets whose characters are one row high and one column wide (such
as the borders and backgrounds sets), a cell is the same as a character. Therefore,
parameter c can be any character defined for the current set, including characters
that require the VT control sequence. For character sets whose characters are
larger than one-by-one (such as the prepackaged helvetica font or Chinese
characters), the cell identifiers are not directly related to the character codes, so
normally these character sets are not used with this control sequence.
The valid values for sss are 000 to 800 (decimal). The ESC R control sequence
has no effect if sss is set to 000.
You can completely tile a 40-by-20 area by entering the value 800 for sss (to tile
an area means to cover the area with cells placed side by side, like floor tiles).
You can tile a 40-by-15 display (for example, when using Chinese characters) by
entering 600 for sss. The following table shows the relationship between the row
size and the maximum value of sss for the ESC R control sequence.
10 960
11 840
4-231
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
12 800
13 720
14 680
15 640
16 600
The background and foreground colors specified for ESC R affect only the cells
that this control sequence puts on the consumer display. ESC R does not change
the color of text and icons already displayed and does not affect the color of text
and icons put on the consumer display after completing ESC R processing.
When ESC R is finished, the cursor occupies the next row-column position
after the last cell c.
The following screen data generates the Welcome screen shown in Figure 4-19.
FF
SI C M
ESC R 012 0 7 *
SI J M
ESC R 012 0 7 *
SI E O
WELCOME
SI F 2
TO
SI G 0
FOURTH
SI H N
FINANCIAL
SI M G
INSERT
/CARD
b
/FOR
b
/SERVICE
b
The two rows of asterisks (*) are generated by the ESC R control sequences in
the screen data shown above. The background and foreground colors for the
asterisks (black and white, respectively) were arbitrarily chosen for this example.
Typically, you specify the same colors as those used for the text.
4-232
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970a20
The ESC T control sequence specifies a background color or pattern in the area
around the addressable area. The format of the control sequence is as follows:
ESC T b f c
The terminal tiles the display area outside the addressable area with cell c of the
current character set, using background color b and foreground color f as shown
in Figure 4-20. To tile an area means to cover the area with cells placed side by
side, like floor tiles. This area remains in effect until changed by another ESC T.
NOTE
4-233
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g1959093
For character sets whose characters are one row high and one column wide
(such as the borders and backgrounds sets), a cell is the same as a character, so
parameter c can be any character defined for the current set, including characters
that require the VT control sequence. For character sets whose characters are
larger than one-by-one (such as the prepackaged helvetica font or Chinese
characters), the cell identifiers are not directly related to the character codes, so
normally these character sets are not used with this control sequence.
The background and foreground colors specified for ESC T affect only the cells
that this control sequence puts on the consumer display. ESC T does not change
the color of anything displayed on the addressable area and does not affect the
color of anything put on the consumer display after completing ESC T processing.
4-234
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
ESC U r1 c1 r2 c2 b f c
g40970a25
The terminal creates a rectangle whose upper left corner is at row r1, column c1
and whose lower right corner is at row r2, column c2 as shown in the following
figure. It tiles this area with cell c of the current character set, using background
color b and foreground color f (to tile an area means to cover the area with cells
placed side by side, like floor tiles). You can choose any rows and columns of
your addressable area to define the rectangle, as long as row r1 is not below row
r2 and column c1 is not to the right of column c2.
For character sets whose characters are one row high and one column wide
(such as the borders and backgrounds sets), a cell is the same as a character, so
parameter c can be any character defined for the current set, including characters
that require the VT control sequence. For character sets whose characters are
larger than one-by-one (such as the prepackaged helvetica font or Chinese
characters), the cell identifiers are not directly related to the character codes, so
normally these character sets are not used with this control sequence.
The background and foreground colors specified for ESC U affect only the cells
that this control sequence puts on the consumer display. ESC U does not change
the color of anything already displayed and does not affect the color of anything
put on the consumer display after completing ESC U processing.
4-235
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g1959090
The following screen data generates the screen shown in Figure 4-21.
FF
ESC F @ 0
ESC U @ @ 3 W 0 7)
SI E I
ESC F 1 0
PLEASE
/WAIT
b
The ESC F control sequence in the second line selects character set @ for the
ESC U control sequence that follows. The ESC U tiles the display from row @,
column @ (the upper left corner of the addressable area) to row 3, column W
(the lower right corner) with cell ’)’.
g40970a21
The ESC V control sequence displays the contents of a buffer within the
constraints of a format template. The format of the control sequence is as follows:
4-236
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The valid values for a, the buffer name, are @, and A through Z. The valid values
for aaa, the buffer name, are 256 through 355.
The single character name designates one of 27 memory buffers that are reserved
for storage of specific data. These buffers contain such information as the
consumer’s PIN, the transaction amount entered, the consumer’s name, and other
terminal and transaction related data.
The valid values for tt, the format template number, are 01 through 11. This
number designates one of 11 available default format templates. The templates
specify how to display the contents of a buffer so that it appears on the screen
properly as a transaction amount, phone number, plain text, plain numbers,
and so on.
The ESC W control sequence blinks the display within a specified rectangle.
The format of the control sequence is as follows:
ESC W r1 c1 r2 c2 ttt
The terminal blinks anything displayed within a rectangle whose upper left
corner is at row r1, column c1, and whose lower right corner is at row r2, column
c2. The blinking is achieved by alternately painting the rectangle a solid color
(the color of the pixel in the upper left corner of the rectangle) and restoring
the original contents of the rectangle. The parameter ttt determines how fast
the rectangle blinks. The blinking continues until the terminal processes an
FF control sequence.
NOTE
4-237
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970a22
You can choose any rows and columns of your addressable area to define the
rectangle, as long as row r1 is not below row r2 and column c1 is not to the
right of column c2.
The valid values for ttt (blink rate) are 000 to 999 (decimal). The blink rate is
computed as follows. When ttt is between 000 and 255, the time in each state
(solid color or original contents) equals ttt times 0.8 seconds. Thus, if ttt equals
002, the blink rate is 002 x 0.8, or 1.6 seconds. When ttt is between 256 and 999,
the time in each state equals (ttt - 255) times 0.1 second. Thus if ttt equals 256,
the blink rate is (256 - 255) x 0.1, or 0.1 second.
The ESC X control sequence allows you to position the cursor to a position
identified by a pair of (X,Y) coordinates. The format of the control sequence
is as follows:
4-238
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970a16
The terminal positions the cursor differently depending on the current resolution.
The following paragraphs describe the way the terminal positions the cursor
in each resolution.
(y * vres) / 10000
When the resolution is 640 x 480 x 16, the terminal sets the cursor’s horizontal
position on the byte (8 pixels) in which the pixel is contained, according to
the following calculation:
(x * hres) / 10000
4-239
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Once the cursor’s screen position is set with ESC X, then text written or icons
displayed, start at the cursor position setting. If any other control sequence is
used following ESC X, then the cursor is set back to the 40-by-20 screen grid.
The following is a partial list of control sequences that set the cursor back to
the 40-by-20 screen type: SI, ESC K, ESC U, ESC W, ESC =, FF, ESC T,
BS, CR, LF, US, HT, and ESC R.
Suggestion
Shadow text is three-dimensional in appearance. Use ESC X to display shadow
text on the screen.
ESC M 03 Select
640 x 480 x 256 resolution
4-240
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The ESC Y control sequence allows you to select a special effect time in
milliseconds. The format of this control sequence is as follows:
ESC y n tttt
The range of the time tttt is 0000 through 9999 milliseconds. The value of n
determine the special effect time that VGA Plus adjusts. The valid values for
n are shown in the following table:
Value Indicates...
> Adjust time for ESC > control sequence. Default value is 0300 millisecond.
< Adjust time for ESC < control sequence. Default value is 0300 millisecond.
P Adjust time for ESC P control sequence. Default value is 0500 millisecond.
This applies to sprinkle and wipe only
4.7.33 ESC ZC - Select Touch Screen Template (not applicable on the CashSource Plus 400)
The ESC ZC control sequence specifies the touch screen template number to
activate for the current screen. The format for ESC ZC is as follows:
ESC ZC nnn
The value of nnn indicates the template number (ASCII) for the current screen.
ESC ZC is only valid for systems that include the optional touch screen. For
more details on ESC ZC and the optional touch screen, refer to Section 4.15.
4.7.34 ESC ZD - Define Touch Screen Configuration Data (Touch screen Terminals Only)
The valid values for the parameters are shown in the following table:
Value Description
nnn template number in ASCII
4-241
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The valid values for the key parameter (ff) are detailed in the following table:
ESC ZD is only valid for systems that include the optional touch screen. For
more details on ESC L and the optional touch screen, refer to Section 4.15.
4.7.35 ESC ZE - Touch Screen Configuration Data (not applicable on the CashSource Plus 400)
The ESC ZE control sequence provides touch screen configuration data. The
ESC ZE control sequence has the following format:
The value of the ttt parameter is the template number and the file name is
of the form *.scr. For more details on ESC L and the optional touch screen,
refer to Section 4.15.
The parameter str can be the name of any valid FLC or FLI file. The file name
should include the appropriate extension, either FLC or FLI. The format for the
str parameter is as follows:
4-242
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
filename.ext
\DIEBOLD\TCS\MOVIES
• R - A value of R indicates that VGA Plus displays the animated graphic file
repeatedly until encountering an ESC M or FF control sequence. Continue
screen processing while the animation is active.
The parameter yyyy designates the y coordinate for upper-left corner of the
animation in global coordinates.
• You have the ability to update FLC and FLI files while the ATM is in
service. This is done using the file update protocol used for updating MPEG
files. This protocol is described in Appendix C.3.6. In this case, however,
the files targeted for update have a .FLC or .FLI extension.
• There is also channel support available for FLC and FLI files. This support
works similiar to the channel file support for MPEG files described in
Appendix C.3.5. However, there are two important differences in channel
support for FLC and FLI files. First, there can only be one filename in a
FLC/FLI channel file as opposed to the three file names that can appear in a
MPEG channel file. Secondly, there is no environment variable based search
algorithm for FLC/FLI channel files. All FLC and FLI channels files must
reside in the \DIEBOLD\TCS\MOVIES directory.
4-243
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
4.7.37 ESC ZI - Display In Touch Screen Button (not applicable on the CashSource Plus 400)
The ESC ZI control sequence allows you to display touch screen Buttons
from the In Button database. The touch screen button Icon files are in the
ADP00\touch or ADP01\touch directory. The naming convention for graphic
files containing in Touch screen buttons is BTNInnn.pcx or BTNInnn.gif The
ESC ZI control sequence has the following format:
The valid values for the parameters are shown in the following table:
Value Description
xxxx the x coordinate of the button position
yyyy the y coordinate of the button position
nnn the button number to display
For more details on ESC ZI and the optional touch screen, refer to Section 4.8.
4.7.38 ESC ZO - Display Out Touch Screen Button (not applicable on the CashSource Plus 400)
The ESC ZO control sequence allows you to display touch screen Buttons from
the Out Button database. The ESC ZO format is similar to ESC ZI. For more
details on ESC ZO and the optional touch screen, refer to Section 4.8.
The Media Player control sequence allows you to define screen windows that
show video sequences, complete with sound (if the terminal is so equipped),
from MPEG formatted files stored on a CD ROM or system hard disk. You can
overlay the video window onto existing VGA graphics, or use the colorkey
feature that plays the video only through a specified color on the VGA graphics
screen. The specified color is made transparent for the display of the MPEG
video information.
You must have an Agilis 91x for ix/CSP terminal equipped with the appropriate
software to use the ESC ZU Media Player control sequence feature. System
hardware and software requirements are as follows:
• Windows NT 4.0
4-244
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The following paragraphs describe the control sequences that perform the
preceding tasks.
Valid values for the preceding parameters are described in the following table:
4-245
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Parameter Description
m Play on or off switch.
• 0 = Reserved for future use
• 1 = on (set up window and begin play immediately)
filename The file name of the MPEG file to be played. Refer to the explanation
and examples later in this section for details on specifying file names.
xxxx The x (global) coordinate position of the top left side of the MPEG
display window. The range for the x coordinate is 0000 through 9999.
yyyy The y (global) coordinate position of the top left side of the MPEG
display window. The range for the y coordinate is 0000 through 9999.
hhhh The height of the MPEG display window relative to the y coordinate.
The value for the height can range from 0000 through 9999. If 0 is
used, the height is the distance from the y coordinate to the bottom
of the screen.
wwww The width of the MPEG display window relative to the x coordinate.
The value for the width can range from 0000 through 9999. If 0 is
used, the width is the distance from the x coordinate to the right
edge of the screen.
n Colorkey feature state:
• 0 = disabled
• 1 = Reserved for future use
• 2 = Reserved for future use
000 The color palette index for the colorkey color. This value ranges
from 000 to 255. If colorkey is disabled, this parameter is ignored
(but must still be 3 decimal digits).
p Play mode designation. Valid values are C, W, and R, defined as
follows:
• C = play once and continue screen processing during MPEG(s)
play
EXAMPLE DISPLAYS
In the examples, the MPEG Playing Window screen shows the movie portion
of the screen labeled with the word MPEG. The VGA Data screen shows
text information as TEXT. Other areas of the VGA screen contain general
multi-colored graphical data, labeled VGA. The screen labeled Consumer Screen
shows the combined results of the MPEG and VGA screens.
4-246
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g41007a07
4-247
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g41007b07
4-248
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
• Multiple files can be specified by placing a + (plus sign) between them. The
files are played in the order given from left to right. No more than three files
can be specified in a single call.
• Each file designation can be just the file name, or can include a path,
either with or without the drive specification. The default directory is
d:\DIEBOLD\TCS\movies, where d is the drive on which Agilis 91x for
ix/CSP is installed. The system searches for each file in a manner based on
how the file name is designated, and on what search path(s) are contained
in the environment variable TCSMEDIAPATH.
This search sequence allows the system to find MPEG files efficiently while also
permitting efficient storage of both language-specific and non-specific MPEG
files. Language-specific MPEGs can be stored in the appropriate language bank
subdirectory, while non-language-specific MPEGs can be stored in the associated
parent directory. Under these conditions, using the described search sequence,
the system finds the non-language-specific MPEG files, without needing to store
multiple copies of these files, one copy in each language bank subdirectory.
The search sequence follows four variations, depending on how the MPEG file
names are specified in the ESC ZC command sequence. Specific descriptions
and examples of each variation are outlined in the following paragraphs.
VARIATION 1
The first variation specifies the command sequence file name as "filename.mpg"
(the file name only, including the MPEG extension, in quotes). The search
for the file progresses as follows (assume only two environment variables in
TCSMEDIAPATH):
1 st search:Environmentstring#1\langxxx\filename.mpg
4-249
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
2 nd search:Environmentstring#2\langxxx\filename.mpg
3 rd search:Environmentstring#1\filename.mpg
4 th search:Environmentstring#2\filename.mpg
SET TCSMEDIAPATH=C:\DIEBOLD\TCS\MOVIES;E:\MOVIES
1 st search:C:\DIEBOLD\TCS\MOVIES\lang002\welcome.mpg
2 nd search:E:\MOVIES\lang002\welcome.mpg
3 rd search:C:\DIEBOLD\TCS\MOVIES\welcome.mpg
4 th search:E:\MOVIES\welcome.mpg
VARIATION 2
1 st search:Environmentstring#1\subdir1\subdir2\langxxx\filename.mpg
2 nd search:Environmentstring#2\subdir1\subdir2\langxxx\filename.mpg
3 rd search:Environmentstring#1\subdir1\subdir2\filename.mpg
4 th search:Environmentstring#2\subdir1\subdir2\filename.mpg
Assume that the environment variable and language bank are the same as in the
previous example.
4-250
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
1 st search: C:\DIEBOLD\TCS\MOVIES\shortclp\lang002\short.mpg
2 nd search: E:\MOVIES\shortclp\lang002\short.mpg
3 rd search: C:\DIEBOLD\TCS\MOVIES\shortclp\short.mpg
4 th search: E:\MOVIES\shortclp\short.mpg
VARIATION 3
1 st search: TCSVolume:\subdir1\subdir2\filename.mpg
The TCSVolume is the device from which Agilis 91x for ix/CSP was installed
on the terminal.
1 st search: C:\MOVIES\HELLO.MPG
VARIATION 4
1 st search: volumeletter:\subdir1\subdir2\filename.mpg
4-251
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
1 st search: D:\MOVIES\LONGCLIP\LONG.MPG
MPEG Stop
This command sequence is used to stop a currently playing MPEG. The format
for the MPEG stop command sequence is as follows:
ESC ZU "MPEGPlay" 1 3
The stop command removes the playing MPEG from the screen. The VGA
graphics on the screen before the play of the MPEG movie become visible again.
An MPEG window set up/play command sequence must be called to play another
MPEG after execution of the MPEG stop command sequence.
NOTE
MPEG Volume
This command sequence changes the audio volume level of an MPEG video
presentation. Changing the volume level can occur before or during MPEG play.
The format for the MPEG volume change command sequence is as follows:
The parameter s indicates the volume change direction. When s = +, the volume
increases, and when s = , the volume decreases.
The parameter vvv is the percent volume change, ranging from 0 to 100. The
percentage change in volume is from that set in using the Set Media Player
Volume in diagnostics. If this is not set, then a default of 50 is used. The percent
volume change is constrained between maximum and minimum allowed volume
levels. For example, a value for vvv of +000 results in the set (in diagnostics) or
default value. A value of +100 results in the maximum allowed volume. A value
of 100 results in no volume, or the minimum allowed volume.
If there are two sound channels available on the machine (two distinct sound
chips/cards), Voice takes whichever channel is designated default, and MPEG
takes the other secondary channel. Volume for each channel is independently
adjustable through maintenance. The system volume setting (settable via
desktop) defines the upper limit of the Voice/MPEG volume range.
If there is only one sound channel, then Voice and MPEG share that channel
if both are installed. Both volumes are still independently settable through
maintenance. Additionally, MPEG has a screen command for setting volume
(Voice does not).
4-252
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Because Voice always shares its channel with someone (system and/or MPEG),
its volume setting in maintenance is "virtual" in that it is selectively applied only
when the WAV file is playing. System settings are always restored when the
WAV file completes. This way, when Voice and MPEG share a channel, Voice
volume settings do not interfere with MPEG volume and vice versa.
This ESC ZU control sequence is used to facilitate the use of MPEG video
presentation in the context of Agilis 91x for ix/CSP transaction processing.
This control sequence is to be programmed into the screen data and used in
conjunction with the Enhanced Information Entry state (@D).
The format (with optional spaces) of the Screen Marker control sequence is:
ESC ZU "ScrnMark" 0
The purpose of the Screen Marker is to provide a mechanism for timing the @D
state relative to the video play time, which is variable depending on the movie (or
movies) selected to play. It is undesirable to require the network programmer to
time each movie and compute the @D timeout manually.
Alternatively, the user can program the MPEGPlay control sequence with the
wait option such that screen processing is suspended for the duration of the
movie presentation, follow that control sequence with a slight delay (ESC D)
for potential consumer input, and finally, program the Screen Marker control
sequence to terminate the @D state with a timeout. The timer value 998 has been
reserved to indicate to the @D state that it should wait for the Screen Marker
event to timeout. Thus, the actual timeout of the @D state so programmed
varies and automatically adjust itself according to the length of the particular
movie or movies playing.
The following screen file illustrates the use of the Screen Marker control
sequence:
069|ECC1F|FF|SIB3TRANSACTION COMPLETE|SID3ANOTHER
TRANSACTION? |SIL6PRESS IF YES ---->|SIO6PRESS IF NO
----->|ECZU"MPEGPlay"11"E:\MUSIC\GERRY.MPG"0300 9700 4500
4500 0 000 W |ECZU"ScrnMark"0
This screen plays a movie while prompting the consumer for another transaction.
The consumer can answer yes or no and sequence state, or the movie plays
to its completion (note the "W" or wait option in the MPEGPlay control
sequence) after which the Screen Marker (ScrnMark) is processed causing the
associated @D state to take its programmed timeout exit. Here is the entry
for the associated @D state:
059@D 069000000998999070255000001999999078006255002070255070
4-253
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Note that Timeout #1 is set to 998, indicating that the Screen Mark occurence
times the state, Timeout #2 is infinite, and the "Do you want more time?" prompt
is disabled as it must be in this context. It is perfectly acceptable to have any
number of keys enabled while waiting for a Screen Mark event. If no keys are
enabled, then the @D state acts like a time delay state with the length of the
movie equal to the delay.
The ESC ZV control sequence enables a web browser to display contents on the
screen. The browser can be configured to coexist with legacy screen output for a
“mixed-mode” effect, or it can be forced to fill the entire screen. The format of
this control sequence is as follows:
The “URL spec” parameter is the web page or local document to be displayed by
the browser. This specification must be enclosed by double quotes.
The next parameters, ssss and p, are the size and position of the browser window,
respectively. The size ssss is measured in global coordinates, ranging from
0 through 9999 (refer to Section 4.7.31 for a detailed description of global
coordinates). The position p can have the following values:
• T – Positions the browser window along the top edge of the screen, with
a height ssss.
• B – Positions the browser window along the bottom edge of the screen,
with a height ssss.
• L – Positions the browser window along the left edge of the screen, with
a width ssss.
• R – Positions the browser window along the right edge of the screen,
with a width ssss.
The field ttt is the number of seconds to wait for a URL to successfully load,
ranging from 000 through 999. A value of 000 in this field causes the current
default value to be used. This default is defined by the Consumer Display
Browser time out property.
A backup screen number bbb must be provided for fullscreen browser windows
(p = “F”) in the event that the browser is unable to load the specified URL. This
backup screen is processed exactly like an inserted screen normally would
be, such as an ESC I or SO sequence. This field is currently ignored for
“mixed-mode” windows, where p is set to T, B, L, or R. In these cases, the
browser simply does not appear if the URL fails to load, leaving a fullscreen
legacy display.
The browser window does not carry over from screen to screen and must be
specified in each screen in which browser display is desired.
4-254
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The ESC : control sequence displays the date, time, or both on the screen in
the format designated in format template screen nnn. The format of the control
sequence is as follows:
ESC : nnn
If more than one ESC : control sequence is used, then only the last sequence that
referenced time is in effect.
• ESC C
• ESC F
• ESC G
• ESC P
The only control characters that you can include in a format template screen
are as follows:
• BS
• LF
• CR
• SI
• DC 4 (forward space)
• US
• VT
Format templates for date and time are contained in screen data. Each format
template must contain a set cursor position sequence and any character set select
information required to select the font or character set to display the date and
time. The numerical values of date and time replace the format characters in the
format template. There can be any character or number of characters between
the format characters. Valid format characters are listed as follows along with
example format template text.
4-255
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
• MM - Month
• YY - Year
NOTE
• DD - Day
• HH - Hours
• RR - Minutes
• SS - Seconds
You can use the following parameters to modify the time format to 12 hour,
24 hour, or AM/PM:
[blank, M, or x..x!x..x]
The rules for characters enclosed in [] are described in the following table.
Character Indicates...
[AM!PM] If the time of day is in the first 12 hours, then display the characters
in the brace to the left of !. If the time of day is in the second 12
hours, then display the characters in the brace on the right of !. []
must appear in the screen text where the characters on the left or
right of ! are to be displayed. The data on the left and right side of !
must contain the same number of characters. This scheme allows
you to display a.m. in the morning and p.m. in the afternoon.
It is possible to display the date and time on screens without making any changes
to the download image. To do this, simply place a file named DATETIME.DAT
in the C:\DIEBOLD\TCS directory. This is an ASCII file that contains a list
of screen numbers on which the date and time should be displayed, followed
by the format template screen number to be used for each screen (refer to
Appendix D.17.4).
These examples show how the terminal replaces characters in the format template.
4-256
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The following example shows three ways to display the time 20:12:15.
HH:RR:SS[M] 20:12:15
HH:RR[ ] 08:12
The following example shows two ways to display the date January 26, 2000.
MM/DD/YY 01/26/00
DD-MM-YY 26-01-00
The following example shows five ways to display the time and date.
The following example shows how to create a format template screen. Assume
that you want to display the date and time on the Insert Card screen and on
the Enter Deposit screen.
First, you must create a format template screen so the terminal knows where to
position the time and date on the Welcome screen.
SI B 4
ESC F 1 2
HH:RR:SS[A!P]M
SI D 4
MM/DD/YY
SI positions the cursor in the upper right corner of the screen at row B, column 4.
ESC F selects the Helvetica font and the inverse display mode. Line 3 displays
the time in the following format: 08:12:15PM. SI positions the cursor in the
upper right corner of the screen at row D, column 4. Line 5 displays the date in
the following format: 01/26/92. Format screen 500 is as follows.
4-257
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
g40970a23
Now, add ESC: 500 to the screen data for your Insert Card and Enter Deposit
Screen. Another option is to add the Insert Card and Enter Deposit screen
numbers to the Datetime file.
The ESC < control sequence provides a fade-out transition between screens.
The format of the control sequence is as follows:
ESC <
This control sequence fades all the DAC registers to black using a color
algorithm to slowly decrement the DAC registers until the entire screen is black.
Use this feature to fade one screen out then create a new screen in video memory
while the screen remains black. Use ESC > to fade the new screen back in. This
technique avoids showing awkward screen building.
If you are using multiple full screen icons, there is no need to clear the screen
between them, simply fade in and fade back out as shown in the following
example.
4-258
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
Fade in.
The ESC = control sequence changes the row size to the size specified. The
format of the control sequence is as follows:
ESC = 08 hh
The terminal divides the entire display into rows hh scan lines high. The row size
defined by ESC = remains in effect until the terminal does one of the following:
The ESC = control sequence controls the number of rows on the consumer
display and cursor positioning on the display, and it affects the alignment
of the rows with the function keys.
Because each icon block and character block is a fixed number of scan lines high
regardless of the row size, the number of rows occupied by a block depends on
the row size set by ESC =. For example, the character blocks for the helvetica
font are 24 scan lines high. If you select a row size of 10 (ESC = 08 10), a
helvetica character occupies three rows, and the last four scan lines partially fill
the third row. The six scan lines at the bottom of the third row are not affected.
Before you use ESC = to modify the row size of a screen, take into consideration
the character sets you intend to use for the screen. Most of the prepackaged
character sets are designed for a specific row size. Establishing a larger row
size than the font was designed for generally does not create any problems.
However, using a smaller row size can occasionally result in the loss of some
portions of some characters, depending on the details of the screen design. This
is particularly true if the screen uses the automatic text wrap feature or the
scrolling function (ESC K).
4-259
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
The Maintenance mode sets the row size to 12 scan lines. If you want a different
row size for the Welcome screen or the Off-line screen, you must include an ESC
= control sequence in the screen. For example, to display Chinese characters
on the Welcome screen and the Off-line screen, these screens must include an
ESC = 08 16.
You can only use ESC = once per screen. If you use ESC = in a screen, it must
be at the beginning of the screen. The only control sequence that can precede
ESC = in a screen is ESC M.
The ESC > control sequence provides a fade-in transition between screens from a
black screen to colors corresponding to DAC setup number nnn. This control
sequence has the effect of fading the screens contents into view. The format of
the control sequence is as follows:
Having used ESC O 001 or ESC < before displaying screen data, this function
fades the screen contents into view using the DAC settings in setup number nnn.
Screen updates (painting) then occur invisibly to the consumer.
The ESC ? control sequence provides sprite animation based on the contents of
Sprite Definition file nnn. The format of the control sequence is as follows:
ESC ? nnn
The range of nnn is 000 through 127. The terminal reads the Sprite Definition
files at powerup. A Sprite Definition file defines where the sprite icon appears on
the screen, the layer that the sprite icon is on, and the rate at which to step through
the location/sprite number information. Layers are used to determine which
sprite overwrites other sprites on the screen in the case of an overlap of a sprite on
the screen. Two sprites cannot exist on the same layer even if they do not overlap.
The last sprite on the layer stops and the new sprite takes over on the layer.
There can be up to three sprites active at once. If more than three ESC ? control
sequences are in the screen data, then the first one is stopped and the new
one is started in its place. The next ESC J sequence encountered replaces the
second one started.
4-260
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Screen Control Sequences
NOTE
4-261
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Touch Screen (not applicable on the CashSource Plus 400)
The touch screen feature allows the consumer to enter numeric and function
key-type input by touching designated areas of the screen. This input can provide
both numeric and function key inputs for all information gathering states (PIN
entry, information entry, function key entry).
Configuration Data
Configuration data for the touch screen must be provided either from the
network, from disk files, or a combination of both. After configuration, it
operates in direct parallel to the fascia keypad. Screens that have associated
touch screen templates enable and disable the touch screen at the same time that
the fascia keypad is enabled and disabled. Keypad input is accepted from either
the touch screen, the fascia keypad, or a combination of both.
Configuration data for the touch screen must be considered in two parts: touch
template definitions and screen definition data telling the terminal which touch
template to use for a specific screen. All touch screen configuration data is
contained within screen records in Write Command 2 messages (Section 4.6).
Touch Templates
Touch templates are defined with the ESC ZD control sequence and contain one
or more touch button definitions. Each region on the screen that corresponds to
a touch button is defined separately in the screen file. Each button definition
contains the following fields:
The touch template number ranges from 000 to 998. The key field specifies
which keystroke this field represents. The screen regions are defined by four
x and y numbers, each in the range of 0000 through 9999. The icon number
specifies which button-depressed icon to display in that region when that area of
the screen is touched.
For example, to define touch template 123 for function keys A through D, the
following data needs to be included in screen data sent in a Write Command 2
message:
Refer to Figure 4-22 for the areas of the screen defined by this touch template.
4-262
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Touch Screen (not applicable on the CashSource Plus 400)
g40970b16
Screen Data
To use a touch template for a screen, you must place an ESC ZC XXX control
sequence within the screen data that uses the template. For example, using the
previously defined template 123 in screen 450 requires an ESC ZC 123 in the
screen data for screen 450. The touch template definitions can be placed within
any screen definition. The template definition itself has no logical connection
to the screen in which it is defined.
• The touch screen is enabled in each state that displays a screen for which a
touch template has been declared and enables the keypad.
• The touch subsystem enables buttons that are both declared in the template
and enabled on the keypad. If a state does not display a screen (for example,
specified screen 000) or does not enable the keypad, the touch screen is not
be enabled for that state.
• When using the touch screen with OAR, the screen data supplied in a Write
Command 5 message can include touch screen information. The Write
Command 5 message must include at least the ESC ZC nnn field to specify
which template to use or it can define a new template. For more details on
the Write Command 5 message, refer to Section 5.10.
Auto Touch
Every downloaded screen that does not include an ESC ZC touch template
reference gets a reference to touch template 999. This template sets up touch
button regions for function keys A through I. This allows use of the touch screen
without additional programming. If a specific touch template is specified, it
overrides touch template 999.
The following chart provides the data for touch template 999. Icon 000 is
specified for each key.
4-263
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
Agilis 91x for ix/CSP can show icons on the consumer display. The icons
graphically depict the action that the consumer should perform, such as inserting
a card or taking a receipt.
The icons are built from special icon characters similar to mosaic characters. The
icon characters are stored in disk files. To use an icon, the network downloads a
screen that contains icon data that specifies where to position the icon on the
consumer display and which characters to use.
You can add text above or below the icon without modifying icon data. Also, text
can share a row with an icon. However, if text and the icon share a row, one
cannot overlay the other, and one space must separate the text and the icon. Their
combined lengths cannot extend beyond the end of the row.
Refer to Figure 4-23 for a sample display combining the Take Cash icon with
the message PLEASE TAKE YOUR CASH. The white areas in the icon are
illuminated on the consumer display.
Below the sample display is the screen data that generates the message and the
icon. For readability, screen data is divided into lines corresponding to separate
rows on the consumer display. The first line of icon data starts with the control
sequence SI G C. This positions the display mode attribute for the first line of
the icon at row G, column C and the first character of the icon itself at row G,
column D. Thus, the upper left corner of the icon appears at row G, column D.
Basic icon screens (Figure 4-24 through Figure 4-38) are available for both host
and controller applications.
4-264
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959016
Standard Icons
This section presents the standard icons (Figure 4-24 through Figure 4-38). The
defining data for each icon appears below the icon.
The icon characters themselves are shown in ASCII hexadecimal. If you work
in an EBCDIC environment, convert all hexadecimal values from ASCII to
EBCDIC.
EXAMPLE
Assume that you work in an ASCII environment. Suppose that you are entering a
line of icon data for which the section shows the following defining data:
4-265
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
Determine the actual row and column for this line of the icon on the consumer
display and modify the SI-#-# portion of the line to set the cursor to this
position. For example, if the line is to start at row G, column C, the SI-#-#
portion becomes SI-G-C.
SI-G-C 0F 47 43
ESC-G-5-0 1B 47 35 30
VT-25 0B 25
• •
• •
• •
ESC-G-0-0 1B 47 30 30
The ASCII hexadecimal data for this line of the icon would then be as follows:
0F 47 43 1B 47 35 30 0B 25 3F 20... 0B 26 1B 47 30
30
4-266
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959001
4-267
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959002
4-268
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959003
4-269
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959004
4-270
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959005
4-271
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959006
4-272
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959007
4-273
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959008
4-274
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959009
4-275
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959010
4-276
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959011
4-277
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959012
4-278
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959013
4-279
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959014
4-280
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959015
4-281
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Reserved Screens
Agilis 91x for ix/CSP reserves screens 000 through 009, and 900 through 950 for
specific terminal functions (Table 4-97). Agilis 91x for ix/CSP provides default
data for reserved screens 000 through 007, but the network can download its own
data for any of the reserved screens.
Screen Function
Number
4-282
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Reserved Screens
• If function key A is pressed, the terminal returns to the original state in which
the timeout occurred. The consumer presses this key to request more time.
• If function key B is pressed, the terminal returns to the Timeout Next State
entry of the original state in which the timeout occurred. Normally, this
Timeout Next State is a Close state.
NOTE
Screen 003
Agilis 91x for ix/CSP does not use this screen. This screen is reserved for
compatibility with TCS.
Screen 004 places the currency-type characters at the beginning of the cash
amount on the consumer display.
For terminals that use an 8-digit cash amount field, screen 005 defines the
separator character (usually a comma) between the hundreds and thousands
digits. For terminals that use a 12-digit cash amount field, Agilis 91x for ix/CSP
places these separator characters between the hundreds, thousands, millions,
and billions digits.
Screen 006 places the decimal separator between major and minor currency units
on the consumer display (for example, between dollars and cents).
4-283
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Reserved Screens
If screens 004, 005, and 006 are not downloaded, they default to the following
characters:
• Screen 004 - $ b/
• Screen 005 - NULL
• Screen 006 - . (period)
By downloading screens 004, 005, and 006, other characters can be shown in the
cash amount display field. For example, by downloading a comma ( , ) in screen
005 and not selecting the 12-character dollar buffer size, the terminal shows
screens 004, 005, and 006 shown in the example that follows.
Agilis 91x for ix/CSP requires additional character positions on the consumer
display to show both 8-digit and 12-digit transaction amount fields. As shown
in the following example, a full 8-digit transaction amount field requires 13
character positions. The example assumes that the network downloads reserved
screen 005. Otherwise, 12 character positions are required.
EXAMPLE
g1959017
4-284
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Reserved Screens
EXAMPLE
g1959018
Screen 007
This is the Remove Currency screen. This screen prompts consumers to remove
currency left in the withdrawal area. An ix/CSP Series terminal shows this screen
as part of the Withdrawal Door Retry feature that occurs when the terminal
performs a delivery function and the consumer fails to remove the bills. The
screen’s characters default to PLEASE REMOVE CURRENCY LEFT IN
DRAWER at terminal powerup or reset.
4-285
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Reserved Screens
4-286
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Reserved Screens
Screen 912
This screen is reserved for future use.
This screen appears if the consumer does not remove the card within a specified
amount of time (determined by timer 18).
4-287
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Reserved Screens
4-288
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Default Screen File Management
The default screens that Diebold provides as part of Agilis 91x for ix/CSP are in
files that can be replaced and/or modified. Each type of display has its own set of
default screen files in a directory. These directories are as follows:
Within each of these directories, there are files that further break down how the
default screens are displayed by character mode and function key placement.
These individual files help to set up default screens that properly center the text
and align text with any function keys that a screen might require. Part of the file
name describes the intended use with the following nomenclature:
The ??? is cge, cgf, emg, or vga, depending on the directory where the file
is found.
When Agilis 91x for ix/CSP initializes, it decides which file to read into the
screen memory in the following steps:
2. All files found in the selected directory with a.SCR extension are used. If
there are conflicting screen numbers in various files, then the last file read
rules. For example, if there are two SCR files with a screen 011, then the
last file’s screen 011 is loaded at the terminal.
The different screen files are selected by changing the desired file name to have
the .SCR extension. When a different screen file is selected, the system must be
restarted to load the contents of the new file. Only one default file should have
the .SCR extension in any given screen directory. The screen files stored in a
directory but not used have the extension .SC_ instead of .SCR.
NOTE
To select a specific file, copy the .SC_ file to a file with the
same name and the extension .SCR. To remove the current file
from use, delete only the file name with the .SCR extension. To
avoid losing a default screen file when selecting or removing
screen files, do not perform file operations (such as rename or
delete) directly on the .SC_ files.
4-289
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Modifying the Contents of a Screen File
The .SCR or .SC_ files cannot be directly modified. To make new .SC_ or .SCR
files, you must first convert them to an ASCII file format. Files of this format are
created by a utility called SCREEN, which is provided on the software release
disks. This utility converts files from the .SCR to a file with the same name, but
with a .MSC extension. You can also SCREEN the .MSC file to a .DA0 file if
you need to edit it through PCEDIT or VGASCRN.
EXAMPLE
It is important to use the file name extensions .SCR and .MSC for the SCREEN
utility to work correctly. The .MSC files can be modified with any text editor
capable of modifying ASCII files.
• FILE HEADER - The file header is the same for all files. This is comprised
of the beginning of the file up through the |DS. There should be no need
to change the file header.
• The first screen from that point starts with a screen number.
• The last screen in the file does not need to end with a |FS.
The screens are made up of the control characters. Symbols such as |EC, which
represent control characters, are used within the screen data files for various
functions. Directly inserting control characters into the files is not possible, thus
a set of symbols is available to generate these codes. The hex value for control
characters and the appropriate ASCII symbol to use to place the control character
in the file is shown in Table 4-98.
00 |NL 10 |DE
01 |SH 11 |D1
02 |SX 12 |D2
03 |EX 13 |D3
04 |ET 14 |D4
05 |EQ 15 |NK
06 |AK 16 |SN
07 |BL 17 |EB
4-290
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Creating a New Default Screen File
08 |BS 18 |CN
09 |HT 19 |EM
0A |LF 1A |SB
0B |VT 1B |EC
0C |FF 1C |FS
0D |CR 1D |GS
0E |SO 1E |RS
0F |SI 1F |US
Special Codes
23 |LB 7C |VB
7F |DL
For example, the escape (ESC) hex code is 1B, a |EC would be typed where the
screen building protocol says to use escape.
To convert the new .MSC files, use the utility SCREEN.EXE. This utility
converts files from the .MSC to .SCR format.
EXAMPLE
Once a file has been made with the .SCR extension, it can be copied to one of the
screen file directories. Ensure there is only one default .SCR file in a screen
directory. The .SCR files can have their extension changed to .SC_ after being
created with the SCREEN program using the rename or copy commands.
4-291
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Monochrome Graphics
EXAMPLE
Once you have the file with a .DA0 extension, you can use PCEDIT or
VGASCRN to make your modifications. When you are done with your
modifications, you need to SCREEN the .DA0 file to a .SCR file.
EXAMPLE
If your terminal uses the Enhanced Monochrome Graphics (EMG) option, you
might want to change the default graphics package. The default graphics package
provides English, Thai, and Arabic characters. You can change the default
graphics package to one of two packages that provide Chinese characters. For
more information on the EMG option and a description of the character sets
provided, refer to the Enhanced Monochrome Graphics Programming Manual
(TP-799300-000A).
• LPROM.LIB - Character set data file used by Agilis 91x for ix/CSP at
startup. Contains EMG icons, fonts, and character sets.
• DPROM.LIB - Bank 0 data file used by Agilis 91x for ix/CSP at startup
where:
4-292
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Monochrome Graphics
cd \DIEBOLD\TCS\emg <ENTER>
2. Perform a binary copy of the library file (substituting the actual revision
level for ???) using one of the following commands depending on
the graphics package desired:
• Chinese graphics:
• Standard graphics:
4-293
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Multilingual Feature
• Storing screens of different languages so that only one state flow is required
to show screens of any language.
Each language supported has a set of screens translated into that language with
the same screen numbers as the default screens. These screens are contained
in separate language banks. By doing this, the same state flow can be used to
show screens in various languages.
This language control sequence is ESC L num, where num represents the
language bank number.
Once the consumer’s language bank has been determined, subsequent states
use this language bank for retrieving each screen.
A Close state sets the language bank back to the default of 000.
The following is an example of screen data that contains this language bank
indicator:
013
ESC L 010
FF
SI CL PLEASE SELECT TRANSACTION
SI I8 WITHDRAW ----- >
SI L8 DEPOSIT ------ >
SI 08 TRANSFER ----- >
There is both an automatic method and a manual method for selecting the
language. The automatic method does not require any network changes but, it
has some restrictions. The manual method requires a new state to be incorporated
into the existing state flow.
4-294
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Multilingual Feature
Automatic Method
Upon getting a good read of the consumer’s card, a screen similar to the one
below (screen 901) is displayed. The consumer then selects the language by
using the function keys.
g1959019
NOTE
The language bank number is directly determined by the key pressed. KEY A
sets the language bank number to zero, KEY B sets it to one, and so on. Up
to eight different languages are supported (corresponding to the eight function
keys). If key mapping is used to map the F, G, H, and I keys to A, B, C, and D, a
maximum of four languages are supported.
The institution is required to configure a Select Language screen (901) that maps
the supported languages with the corresponding keys. Since screens are retrieved
from the default language bank (000) before language selection, the Select
Language screen (901) must be saved in the default language bank. In order
to ensure this, the Select Language screen (901) is always saved in the default
language bank (000) despite any language bank control sequence.
The automatic method only functions when the feature is enabled with the
configuration settings and the Select Language screen (901) has been configured.
This is a configurable option; refer to the Agilis 91x for ix Installation and
Configuration Guide (TP-820605-001D) for information on configuration.
4-295
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Multilingual Feature
Manual Method
This method allows institutions to perform manually what was done
automatically in the automatic method. A Set Language Bank state is available
that can be incorporated anywhere into the current state flow. A definition for
this state is in Section 4.4.24. One method of implementation is to use one or
more Select Function states in order to get to the Set Language Bank states. In
this case, the institution can specify both a Timeout Next State and a Cancel Next
State. The language bank number associated with each function key is at the
institution’s discretion. Using several Select Function states and Set Language
Bank states, an institution can support as many languages as it requires.
Once the language is selected and the language bank number is established,
the remaining screens are retrieved from that bank. If, for some reason, a
particular screen number does not exist in the selected language bank, the screen
is retrieved from the default language bank (if the screen number exists there).
Thus, reserved screens 004, 005 and 006, which contain only symbols, do not
have to be downloaded to each bank.
A language control sequence (ESC L xxx) can be inserted within the OAR screen
data as long as the character is at the beginning of the OAR screen data. No other
characters can precede the ESC L xxx. Internally, the OAR screen is stored using
a reserved OAR screen number. If no language bank is specified by an ESC L
xxx sequence, the OAR screen is saved in the default bank (000). If a language
bank is specified, the OAR screen is saved in that language bank.
Before the OAR screen is displayed, the screen must first be retrieved from
where it was stored. The current language bank is first scanned to determine if it
contains a screen that matches the reserved OAR screen number. If the current
language bank does not contain the OAR screen, the default language bank (000)
is scanned to determine if it contains a screen matching the reserved OAR screen
number. The backup feature of checking the default language bank for a screen
that does not exist in the current language bank works the same for OAR screens
as it does for downloaded screens.
This backup feature can be used to a network’s advantage when OAR data is
sent. If the OAR screen does not contain any language-specific text, the network
can choose to not specify a language bank within the OAR screen data. This
action removes the burden of keeping track of the current language bank the
consumer is using.
For example, the network could download both an English screen 200 that
contains the text "TODAY’S RATE FOR CAR LOANS IS:" and a Spanish
screen 200 that contains the same text translated into Spanish. Each screen 200
must contain a language control sequence. The OAR screen could then contain
only a control sequence to insert screen 200 in addition to the numerical data
showing the current rate.
Some caution must be used when taking advantage of the backup feature. The
backup feature fails as soon as the network specifies a language bank within
OAR screen data. Whenever the network sends an OAR screen with a language
control sequence that specifies bank 001, this screen is retrieved whenever
the current language bank is 001.
4-296
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Multilingual Feature
Using the backup feature in this manner is only recommended for banks that
use the automatic method described previously. In the case of the automatic
method, the network has no way of determining the current language bank used
during each transaction. Whenever the state method is used, however, it is
recommended that the network have some method of determining the current
language bank used during each transaction. In addition to allowing the network
to insert a language control sequence within the OAR screen data, this knowledge
opens up many other programming possibilities.
The most straight forward method of using OARs, multilingual, and touch
screens is to use the manual method for Multilingual and have the network know
the current language bank. Then, the OAR data can contain the ESC L XXX and
the ESC ZC XXX. This is the recommended method.
A very indirect approach has been shown to work, which establishes a touch
template cross reference for OAR screens when Multilingual is used. This
method uses several preliminary screen 900s in order to establish template 100
for an OAR in bank 0, template 200 for an OAR in bank 1, template 300 for
an OAR in bank 2, and so on. It also relies on the backup feature described
previously. The only data in the preliminary screen 900s is the ESC L XXX and
the ESC ZC XXX. The OAR data is sent and, since no language bank is specified,
it is saved in Language Bank 000. If the current language bank in use is 001, then
the display task tries to retrieve screen 900 (OAR screen) out of Language Bank
001. However, it does not exist, thus screen 900 is retrieved from Language
Bank 000 according to the backup feature. This method does not work if there is
any data in the preliminary screen 900 in addition to the ESC L XXX and the
ESC ZC XXX.In this case, screen 900 already exists in the current language bank
and the preliminary screen 900 is used instead of the current OAR data.
When Multilingual is used, having one preliminary screen 900 (in Language
Bank 000) to establish a cross reference between template 100 and the OAR
screen does not work because there is no way of having a common template for
all the languages. The templates specify the icons containing language-specific
text for the buttons. Even if a common template existed, the cross reference must
be established for all the language banks.
4-297
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
4.16 Rear Balance Feature (not applicable on the CashSource Plus 400)
The Rear Balance feature requires the Agilis Supply Manager option.
The Rear Balance feature provides the ability to perform terminal balancing
operations from the rear of the terminal, using the (GUI) Maintenance
interface. A rear balance session is initiated by a terminal operator selecting
the Start RBM function from the Tools menu while in Maintenance mode or
Continuous Availability. Although the rear balance session is initiated through
the Maintenance software, rear balance functions are defined and controlled
by the network.
Selecting a rear balance function at the terminal causes the terminal to send the
network a unique Consumer Request message. The network then sends the
terminal a Function Command message directing the terminal to perform the
requested function.
• Maintenance mode
• Continuous Availability
Maintenance mode
When you select Start RBM in Maintenance mode, the Maintenance software
checks to see if any card data has been stored for the operator group to which the
current operator belongs. If there is stored card data for the operator group, the
Maintenance software searches the Financial Institution Table (FIT) library for a
FIT entry matching the stored card data.
NOTE
If a matching FIT entry is found, the Maintenance software prompts the operator
to enter the appropriate PIN for the stored card data. The PIN can be any number
of digits, up to a maximum of six, as indicated by the FIT entry.
If the FIT entry indicates local PIN verification, the PIN entered by the operator
must pass the local PIN verification check. If the local PIN check fails, the
rear balance session is not started.
If the FIT entry indicates remote PIN verification, the encryption method
specified in the FIT entry is used when the PIN is sent to the network for
verification.
4-298
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
If there is no stored card data for the operator group, the Maintenance software
starts the rear balance session without prompting for a PIN entry. When a rear
balance function request is sent to the network, the operator’s password (the
password used for Maintenance logon) is sent in place of the PIN for network
verification. The password is placed in the PIN Buffer field of a Consumer
Request message. The password is not encrypted.
Continuous Availability
When you select Start RBM in Continuous Availability, the Maintenance software
checks to see if there is any stored card data for the operator group to which the
current operator belongs. If there is stored card data for the operator group, the
Maintenance software proceeds in the same way as for Maintenance mode.
If there is no stored card data for the Continuous Availability group, the
Maintenance software does not permit the operator to start a rear balance session.
In Continuous Availability, a rear balance session cannot be started using the
operator’s password.
NOTE
Reserved screen 008 is used to define the menu for rear balance functions. The
Maintenance software displays this menu during the rear balance session. The
operator executes rear balance functions by selecting the desired function
from this menu.
Reserved screen 009 is used to define the message data sent to the network for
rear balance functions. For each rear balance function, this definition data
specifies required operator input (if any), what data is to be sent to the network in
the Consumer Request message, and how to handle a function failure.
Because the network has control over both the function menu (screen 008) and
the function definition data (screen 009), the rear balance mode is completely
configurable by the network.
NOTE
4-299
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
FUNCTION MENU
01=Print Totals
02=ATM Out Of Serv
03=Cash Added
04=Cash Removed
05=Deposits Cleared
Each line in screen 008 is terminated by a line feed character (LF). The second
line through the last line are the menu entries for the Rear Balance menu. Each of
these lines must correspond to an operator selectable function defined in screen
009. The first three characters of the second line through the last line (01=, 02=,
and so on, in this example) must be present to permit the Maintenance software
to parse the screen data, but are not used for any other purpose.
Autoexecute/Chain Flag 1
PIN Flag 1
Data Separator 1
The fields shown in Table 4-99 are described in the following paragraphs.
Autoexecute/Chain Flag
This flag indicates whether the function executes automatically at the start of the
rear balance session or is executed automatically following another function.
This field contains one character. The following values are valid:
4-300
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
The Maintenance software does not link menu entries to autoexecute functions.
Autoexecute functions are not selectable from the Rear Balance menu, so screen
008 must not contain any entries for autoexecute functions.
Chain: This specification means that several functions are executed when one
function is selected from the Rear Balance menu. As soon as the Function
Command message for one function has been returned from the network and
successfully processed by the terminal, another function request can be sent
to the network without additional operator action.
The function definition data for the chained functions must occupy consecutive
records in screen 009. The first function in a chained series must be marked as a
selectable function (autoexecute/chain flag = 0). Each subsequent function in the
chain must be marked as a chained function (autoexecute/chain flag = 1). The
functions are processed in the order defined in screen 009.
The Maintenance software does not link menu entries to functions marked as
chained functions. The functions so marked are not selectable from the Rear
Balance menu, so screen 008 must not contain any entries for those functions.
NOTE
• 0 - No tracks
• 1 - Track 1 only
• 2 - Track 2 only
• 3 - Tracks 1 and 2
• 4 - Track 3 only
• 5 - Tracks 1 and 3
• 6 - Tracks 2 and 3
• 7 - Tracks 1 and 2 and 3
4-301
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
• 0 - No
• 1 - Yes
PIN Flag
This flag indicates whether to include PIN data in the Consumer Request
message. The value in this field is one decimal digit. The following values
are valid:
• 0 - No
• 1 - Yes
NOTE
4-302
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
Operator input, regardless of the format, can be stored in the following buffers:
If the input is to be stored in the Dollar Buffer, the input is right-justified in the
buffer and padded with zeros to the maximum Dollar Buffer size (eight or
twelve digits).
4-303
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
If the value in the Expected Next State ID field is 255, this field is ignored
(but still must be present).
Data Separator
A capital Y enclosed in single quotes (’Y’) is used as a data separator. The
traditional field separator, hex 1C, cannot be used because it is not a valid
screen data character.
NOTE
Additional Data
This field contains the additional data to be sent in the Consumer Request
message, as indicated in the Additional Data Flag field. If the value in the
Additional Data Flag field is 0, this field can be omitted. The length of this
field is variable.
NOTE
4-304
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
Once the terminal has built the Consumer Request message from the function
definition data in screen 009 and any required operator input, the terminal
sends the message to the network. The terminal displays a PLEASE WAIT
box while it waits for a Function Command message from the network. If
timer 03 (communications message timeout interval) expires, the Maintenance
software displays an error box, then returns to Maintenance mode or Continuous
Availability, as applicable.
When the terminal receives a Function Command message from the network, it
attempts to process it. Note that if the same function commands are used for
terminal balancing from the front, receipts might be delivered through the front
on rear-load terminals. To avoid this, when is installed, the terminal’s balancing
options can be set to print data to the journal printer only. When this option is
set, all receipt print data received during a rear balance session is printed on
the journal printer instead of the receipt printer. If this option is not set, as an
alternative, the receipt printer can be placed in the supply position to prevent
delivering receipts through the front of the terminal.
If the value in the Expected Next State ID field in the current function definition
data is not set to 255, the next state specified in the Function Command message
is compared to the Expected Next State ID. If they are not equal, the Maintenance
software handles this error as specified in the Exit on Next State ID Mismatch
field of the defined data in screen 009. If the value in the Exit on Next State
ID Mismatch field is 0, screen 902 is displayed for 10 seconds, then the Rear
Balance menu is redisplayed, and the operator is allowed to select another rear
balance function. If the value in the Exit on Next State ID Mismatch field is 1,
the rear balance session is immediately exited. Immediately exiting might be
appropriate in situations such as the failure of a remote PIN check. Displaying
screen 902 might be more appropriate in other situations. Screen 902 might
display something like FUNCTION FAILURE.
4-305
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
NOTE
g1959020
In this example, the network downloads screens 008, 009, 301, and 902 for
use during a rear balance session. Screen 008 contains the following Rear
Balance menu data.
FUNCTION MENU
01=Print Totals
02=ATM Out Of Serv
03=Cash Added
04=Cash Removed
05=Deposits Cleared
Screen 009 contains the function definition data shown in Table 4-100.
4-306
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
4-307
Autoexecute/ Track Function Function Key PIN Flag Operator Input Expected Exit on Data Addi- Addi- Function
Chain Flag Data Flag Key Data Data Input Screen Next Next Separator tional tional Definition
Flag Flag Number State ID State Data Flag Data Separator
ID Mis-
match
Screen 301 contains the following text to prompt for operator input.
ENTER AMOUNT
Screen 902 contains the following text to indicate an error in function processing.
FUNCTION FAILURE
If there is no stored card data for the operator’s group, the operator is not
permitted to start a rear balance session. The rest of this example assumes
that there is stored card data and a matching FIT entry.
3. The operator enters the four-digit PIN associated with the stored card
data and clicks on the OK button.
4. Since the first function listed in screen 009 has an A in the Autoexecute
field, the terminal immediately sends the specified Consumer Request
message to the network. The Consumer Request message contains
the following data:
5. If the remote PIN check at the network fails, the Function Command
message sent from the network has a value in the Next State ID field that
does not match the value in the Expected Next State ID field (110). Since
the Exit on Next State ID Mismatch field for the autoexecute function is
set to 1, the terminal exits the rear balance session.
6. If the remote PIN check at the network succeeds, the Function Command
message sent from the network has a value in the Next State ID field of
110, which matches the Expected Good Next State. The Maintenance
software displays the Rear Balance menu, which contains the following
menu items:
Print Totals
ATM Out Of Serv
Cash Added
Cash Removed
Deposits Cleared
4-308
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Rear Balance Feature (not applicable on the CashSource Plus 400)
NOTE
ENTER AMOUNT
$ 0.00
12. The terminal checks that the next state specified in the function
command is 110. If it is not, a dialog box using the text from screen 902
(FUNCTION FAILURE) is displayed for 10 seconds.
13. The Maintenance software displays the Rear Balance menu again.
14. The operator ends the balance transactions by clicking on the Cancel
button on the Rear Balance menu.
15. If any data has been printed on the receipt printer, a receipt is delivered.
4-309
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
The Voice feature provides the ability to coordinate voice messages with the text
messages displayed on the consumer display. This feature is intended primarily
for voice prompting and voice assist applications.
The Voice feature is based on the use of .WAV files. These .WAV files are
played at appropriate points during a transaction. In addition, some terminals
have Text To Speech (TTS) capability (Section 4.17.3). TTS allows terminals to
convert plain text to audible speech.
To use the Voice feature, voice commands are embedded in screen data
(Section 4.6). Voice commands must immediately follow the screen number and
language bank number (if present) in the Write Command 2 message, and must
precede the touch template data (if present) and the displayable screen data.
The Voice state (Section 4.4.19) provides a means to enable or disable prompting
and/or keypad feedback on a per-state basis.
All .WAV files and control files must be saved in the same subdirectory. The
default directory is C:\DIEBOLD\TCS\VOICE\LANG000. If the multilingual
feature (Section 4.15) is used, then additional directories need to be created
following the format LANGxxx, where xxx is the three-digit language bank
number. The .WAV files and control files associated with each language bank
must be stored in the corresponding directory. All default .WAV files included
with Agilis 91x for ix/CSP should be copied to the appropriate language bank
directory.
If there are two sound channels available on the machine (two distinct sound
chips/cards), the Voice feature takes whichever channel is designated the default,
and MPEG takes the other, secondary channel. Volume for each channel is
independently adjustable through maintenance operations. The system volume
setting (settable via desktop) defines the upper limit of the Voice/MPEG
volume range.
If there is only one sound channel, then the Voice feature and MPEG share that
channel if both are installed. Both volumes are still independently settable
through maintenance operations. Additionally, MPEG has a screen command for
setting volume (the Voice feature does not).
Because the Voice feature always shares its channel (with the system, with
MPEG, or both), its volume setting through maintenance operations is "virtual"
in that it is selectively applied only when a .WAV file is played. System settings
are always restored when the playing of the .WAV file completes. This way,
when the Voice feature and MPEG share a channel, the Voice feature volume
settings do not interfere with MPEG volume and vice versa.
4-310
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
Agilis 91x for ix/CSP supports multiple voice prompting commands within any
given screen. However, all the voice prompting commands must be placed
back-to-back. The maximum number of voice messages that can be in the
queue at any one time is 50.
Voice prompting commands can reference individual .WAV files directly. The
following is an example of a voice prompting command using a .WAV file:
This command directs the terminal to play the file TCS_TEST.WAV, with no
delay before playing TCS_TEST.WAV.
Voice prompting commands can reference control files. Control files are used to
specify a list of one or more .WAV files (up to 50 .WAV files). Fields within the
control file provide functionality to repeat the entire list, repeat an individual
.WAV file , or specify delays. Control files are useful for orientation/tutorial
messages in a Welcome screen sequence. The control file can be set up to
repeat indefinitely as well as independently of the rotating Welcome screens.
The voice control file is named CTRLxxx.DAT, where xxx is the control file
number specified in the voice prompting command.
• Column 1 specifies the destination for the voice message. The only valid
value is 0.
• Columns 3 through 5 specify the repeat factor (how many times an individual
.WAV file is repeated). The valid range of this field is 001 through 999.
4-311
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
• Columns 7 through 9 specify the delay time ttt (in ticks). The valid range of
this field is 000 through 999 (end play). The delay occurs after the .WAV
file has been played, and specifies how long to delay before playing the
next message or replaying the entire list. If repetition is specified, the delay
occurs between every play. The range for the delay time parameter is
divided into the following subranges:
- 000 through 255 - The delay time equals ttt times 0.8 seconds. For
example, if ttt equals 002, the delay is 002 times 0.8, or 1.6 seconds.
- 256 through 998 - The delay time equals ttt - 255 times 0.1 seconds. For
example, if ttt equals 256, the delay is (256-255) times 0.1, or 0.1 seconds.
- 999 - End the play loop after playing the current file.
To prevent the entire list from repeating automatically, specify a delay time
of 999 in the last entry in the list.
A control file cannot contain a reference to another control file. Only one
control file can be active at any time.
4-312
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
Voice prompting commands can contain ESC ZK control sequences within the
message field to interpret a buffer according to a format template. This provides
the capability of speaking entered transaction amounts or account balances.
Interpretive commands concatenate specific .WAV files (1.wav, 2.wav, and so on)
together in order to speak transaction amounts and account balances.
The ESC ZK control sequence does not display the formatted buffer. If desired,
the ESC V screen control sequence can be used to display the buffer according to
a different format template that contains the currency symbol appropriate to
the actual currency used.
Although some currencies are displayed with a comma as the decimal delimiter,
a decimal point should be used in the format template. All characters except
numerics, a dollar sign and a decimal point are ignored by the parser.
The .WAV files created for concatenated transaction amounts should be recorded
in the correct language, although the standard file name must be used. For
example, the file DOLLARS.WAV can contain the recorded text "pounds".
The parser which concatenates the pre-recorded .WAV files together uses an
English syntax. For example to say the dollar amount $123456.78, the following
.WAV files are played:
• 1.wav
• hundred.wav
• 20.wav
• 3.wav
• thousand.wav
• 4.wav
• hundred.wav
• 50.wav
• 6.wav
• dollars.wav
• and.wav
• 70.wav
• 8.wav
• cents.wav
• 0.WAV, "zero"
• 1.WAV, "one"
• 2.WAV, "two"
• 3.WAV, "three"
• 4.WAV, "four"
4-313
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
• 5.WAV, "five"
• 6.WAV, "six"
• 7.WAV, "seven"
• 8.WAV, "eight"
• 9.WAV, "nine"
• 10.WAV, "ten"
• 11.WAV, "eleven"
• 12.WAV, "twelve"
• 13.WAV, "thirteen"
• 14.WAV, "fourteen"
• 15.WAV, "fifteen"
• 16.WAV, "sixteen"
• 17.WAV, "seventeen"
• 18.WAV, "eighteen"
• 19.WAV, "nineteen"
• 20.WAV, "twenty"
• 30.WAV, "thirty"
• 40.WAV, "forty"
• 50.WAV, "fifty"
• 60.WAV, "sixty"
• 70.WAV, "seventy"
• 80.WAV, "eighty"
• 90.WAV, "ninety"
• AND.WAV, "and"
• CENT.WAV, "cent"
• CENTS.WAV, "cents"
• DOLLAR.WAV, "dollar"
• DOLLARS.WAV, "dollars"
• BILLION.WAV, "billion"
• HUNDRED.WAV, "hundred"
• MILLION.WAV, "million"
• THOUSAND.WAV, "thousand"
• DECIMAL.WAV, "decimal point"
These files are concatenated together to speak transaction amounts and balances.
The script associated with each of these .WAV files is shown in quotes.
When creating these files, care must be taken to remove all dead space so that the
overall speech is smooth. This can be done using a multimedia editor. If all the
dead space is not removed, the speech might sound choppy.
4-314
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
4-315
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
Text To Speech (TTS) is an extension of the Voice feature that allows terminals
to convert plain text to audible speech. TTS allows developers and customers
to create and output voice messages without requiring the creation of custom
.WAV files.
Like the basic voice commands, TTS voice commands must immediately
follow the screen number and language bank number (if present) in the Write
Command 2 message, and must precede the touch template data (if present) and
the displayable screen data (Section 4.6).
Text intended for conversion to speech can be in the form of text strings
embedded in screen data, stored in text files (.TXT files), and stored in Agilis
91x for ix/CSP buffers. The .TXT files must be stored in the appropriate
C:\DIEBOLD\TCS\VOICE\LANGxxx directory, where xxx is the three-digit
language identifier.
TTS can be used in conjunction with .WAV files. TTS voice commands can play
or speak .WAV files, text files, text strings, or a combination of these. If .WAV
files are specified in any of the voice commands, the TTS engine also plays the
.WAV files so that the TTS engine can properly control the audio output, such as
terminating a .WAV file output in order to speak a text string.
Agilis 91x for ix/CSP also supports the Text To Speech state (Section 4.5.1).
The Text To Speech state directs the terminal to obtain text from a specified
buffer and convert the text to audible speech. Typically, this state is used
to speak account balances.
At present, the Text To Speech capability supports U.S. English speech only.
Various commands can be embedded in text to modify the manner in which the
text is spoken. These commands allow developers to enhance the spoken output
by indicating a specific pronunciation of the text, altering the speed or pitch
of the speech, pausing within the speech, or including the contents of a buffer
within the text to be spoken. Many of these commands are extensible markup
language (XML) tags defined by the Speech Application Programming Interface
(SAPI) 5.1 standards (Table 4-103). These SAPI XML tags are processed by the
TTS engine itself. In addition, there are several commands defined by Diebold
and processed by Agilis 91x for ix/CSP (Table 4-104).
4-316
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
Tag Description
Context Provides information for normalizing special items such as dates, numbers, and cash amounts. An
example follows:
<context id=’date_mdy’>03/04/01</context>
The value of the Id attribute (date_mdy) indicates that the date between the tags is to be interpreted as
the month, followed by the day, followed by the year. Other SAPI-defined values for the Id attribute
are date_dmy and date_ymd.
<emph>text</emph>
Lang Defined by SAPI, but not currently used by Agilis 91x for ix/CSP.
PartOfSp Provides the speech processor with the part of speech of a word or phrase. An example follows:
<partofsp part=’verb’>record</partofspeech>
The value of the Part attribute (verb) indicates that the word record is a verb. SAPI-defined values for
the Part attribute include the following values:
• Noun
• Verb
• Modifier
• Function
• Interjection
• Unknown
Pitch Controls the pitch of the voice speaking the text. An example follows:
<pitch absmiddle=’5’>text</pitch>
The value of the Absmiddle attribute (5) causes the word text to be spoken at pitch 5. The valid range
for the Absmiddle attribute is -10 to 10.
The Middle attribute can be used in place of the Absmiddle attribute. The Middle attribute changes the
pitch relative to the current pitch. The valid range for the Middle attribute is -10 to 10, with a value of
0 resulting in no change from the current pitch.
The value of the Sym attribute is a string of phoneme symbols that specify the pronunciation of the
word hello.
Rate Controls the rate at which a word or section of text is spoken. An example follows:
<rate absspeed=’5’>text</rate>
The value of the Absspeed attribute (5) causes the word text to be spoken at rate 5. The valid range for
the Absspeed attribute is -10 to 10.
The Speed attribute can be used in place of the Absspeed attribute. The Speed attribute changes the
rate relative to the current rate. The valid range for the Speed attribute is -10 to 10, with a value of
0 resulting in no change from the current rate.
4-317
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
Tag Description
<silence msec=’500’/>
The value of the Msec attribute (500) directs the speech processor to insert 500 milliseconds of silence
into the text being spoken.
Spell Directs the speech processor to speak the individual letters, numbers, and punctuation marks
comprising a word or section of text. An example follows:
<spell>text</spell>
The Spell tag causes the speech processor to voice the individual letters t, e, x, and t comprising the
word text.
Voice Selects a voice based on age, gender, name, or other attributes. An example follows:
The value of the Required attribute (name=Microsoft Mary) causes the speech processor to speak the
word text using the Microsoft Mary voice. The following attributes can be used to select a voice:
• Age
• Gender
• Language
• Name
• Vendor
• Vendorpreferred
The Optional attribute can be used in place of the Required attribute if the change is not required. The
Optional attribute has the same range of voice attributes.
Volume Controls the volume of a voice as a percentage of the default volume setting. An example follows:
<volume level=’50’>text</volume>
The value of the Level attribute (50) causes the speech processor to speak the word text at 50 percent
of the default volume setting. (The default volume setting is the volume set through maintenance
operations, not the maximum volume of which the terminal is capable.) The valid range for the Level
attribute is 0 to 100.
4-318
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
Tag Description
ControlList Defines a list of one or more voice messages that can be repeated a fixed number of times or
indefinitely. An example follows:
<controllist repeat=999>
(message list)
</controllist>
The start and end tags must both be present in order to mark the start and the end of the message
list. The Repeat value specifies the number of repetitions for the entire message list. This number can
range from 000 to 999. The value 999 causes Agilis 91x for ix/CSP to repeat the list indefinitely. For
further information, refer to the paragraphs labeled Control Lists.
Interrupt Indicates whether to interrupt any message currently playing in order to play the message that follows
the command tag. An example follows:
<interrupt=Y>
The valid values are Y (Yes) and N (No). The value Y causes Agilis 91x for ix/CSP to terminate the
playing of any messages currently in progress and begin playing the message that follows the Interrupt
command tag. The value N causes Agilis 91x for ix/CSP to append the message that follows to the end
of the queue without interrupting any messages already in the queue.
Repeat The Repeat tag is an optional element of an entry in a control list. This tag causes Agilis 91x for ix/CSP
to repeat the corresponding message a fixed number of times or indefinitely. An example follows:
<repeat=4>
The Repeat value specifies the number of repetitions for the corresponding message. This number can
range from 000 to 999. The value 999 causes Agilis 91x for ix/CSP to repeat the list indefinitely. If the
Repeat tag is not included in an entry, the message is played once for each repetion of the control list.
For further information, refer to the paragraphs labeled Control Lists.
Speakfile Specifies a .WAV file to be played or a .TXT file to be spoken. An example follows:
<speakfile=wavefile.wav>
The Speakfile tag causes Agilis 91x for ix/CSP to play the file WAVEFILE.WAV.
TCSBuffer Inserts the contents of an Agilis 91x for ix/CSP buffer into the message. An example follows:
<tcsbuffer=A>
The TCSBuffer tag causes Agilis 91x for ix/CSP to insert the text contained in buffer A into the message.
The valid range of values for buffer IDs is @, and A through Z. SAPI XML tags and Diebold Text To
Speech tags can be embedded in the text contained in the buffer.
Optionally, the TCSBuffer tag can specify a format template to use in formatting the contents of the
buffer, as in the following example:
<tcsbuffer=A,format=9>
The contents of buffer A is formatted using format template 009. For information about using format
templates to format buffer contents, refer to Section 4.17.1.3.
TransLang Modifies the speaker for the duration of the transaction. The system default is reset at the end of
the transaction.
<translang=Microsoft Mary>
4-319
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
The SAPI XML tags can be embedded in text strings in screen data and control
files, in .TXT files, and in Agilis 91x for ix/CSP buffers. The Diebold Text To
Speech tags can be embedded in all of the preceding except .TXT files. .TXT
files cannot contain any Diebold Text To Speech tags.
Agilis 91x for ix/CSP processes and removes the Diebold Text To Speech tags
before queueing a voice message for the TTS engine. Therefore, the resulting
data placed in the queue contains some combination of text, file names (for .WAV
files, .TXT files, or both), and SAPI XML tags. This data is limited to 300 bytes.
Table 4-106) shows some examples of voice prompting commands using control
files that are valid for terminals that have Text To Speech capability.
4-320
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Voice Feature
The first line of the control list specifies that the message list is to be repeated
indefinitely (repeat = 999). The last line inserts a 5-tick delay (ddd = 005) after
each repetition of the message list.
Control lists cannot contain other control lists. Control lists cannot contain
references to control files.
Only one control list can be active at any time. When a control list is processed,
Agilis 91x for ix/CSP purges the message queue, terminating any messages
currently being played.
4-321
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Miscellaneous Screen Data
Agilis 91x for ix/CSP screen data can contain HTML code and also URL
references. Each is described in the following sections.
Screen data can consist of inline HTML code defining a screen. The screen data
in this case must begin with the <HTML> tag. Standard control sequences cannot
be used within these screens. The following screen data displays the Diebold
logo in a full screen browser window.
Screen data can consist of a URL specification which is then displayed in a full
screen browser window. The screen data must begin with <URL="location">,
where location is a web page or document. Standard control sequences cannot be
used within these screens. The following screen data opens a full screen browser
window and navigates to the Diebold website.
4-322
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Miscellaneous Screen Data
<URL="http://www.diebold.com">
You can enhance existing screens with browser support. This is done by
overlaying a browser window on an existing screen. This enables you to provide
browser support without changing your existing screens. To do this, you need to
create the file HTMOVRLY.TXT in the Diebold/TCS/ADP00 directory. The
contents of this file tells Agilis 91x for ix/CSP what screens get overlays and what
those overlays are. Each line of this file must conform to the following format:
nnn,url,ssss,p,ttt,bbb
The next parameters, ssss and p, are the size and position of the browser window,
respectively. The size ssss is measured in global coordinates, ranging from
0 through 9999 (refer to Section 4.7.31 for a detailed description of global
coordinates). The position p can have the following values:
• T – Positions the browser window along the top edge of the screen, with
a height ssss.
• B – Positions the browser window along the bottom edge of the screen,
with a height ssss.
• L – Positions the browser window along the left edge of the screen, with
a width ssss.
• R – Positions the browser window along the right edge of the screen,
with a width ssss.
The field ttt is the number of seconds to wait for a URL to successfully load,
ranging from 000 through 999. A value of 000 in this field causes the current
default value to be used. This default is defined by the Consumer Display
configuration parameters.
A backup screen number bbb must be provided for fullscreen browser windows
(p = “F”) in the event that the browser is unable to load the specified URL. This
backup screen is processed exactly like an inserted screen normally would be,
such as an ESC I or SO sequence. This field is currently ignored when p is set to
T, B, L, or R. In these cases, the browser simply does not appear if the URL
fails to load, leaving a fullscreen legacy display.
4-323
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 13 Message (custom icons for EMG)
025,www.topbanner.com,3333,T,000,000
032,www.LeftEdgeBanner.com,2500,L,000,000
This example file tells the terminal to overlay screen 025 with a web banner
on the top third of the screen and overlay screen 032 with a web banner on the
left quarter of the screen.
This message is used to send the icon definitions for custom icons to the terminal.
Table 4-108 illustrates the command message format. The following paragraphs
describe the fields. For more details on custom icons, refer to the Enhanced
Monochrome Graphics (EMG) Programming Manual (TP-799300-000A).
[ Response Flag ] [ X ] [ 1 ]
The following paragraphs describe the fields specific to the Write Command 13
message.
Icon Definition
Field Length: Variable
Valid Range: Refer to the description.
Description: This field contains one icon definition. The data is formatted
the same as one record in the DDU’s ICON.DEF file, not including the ETX
character used as a file record separator.
If an ICON.DEF record is too long to fit in one message, the record cannot be
sent to the terminal. You must omit that icon definition from the terminal’s
configuration.
4-324
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 14 Message (custom character sets for EMG)
For more details on the Write Command 13 message, refer to the Enhanced
Monochrome Graphics (EMG) Programming Manual (TP-799300-000A).
This message is used to send the character set definitions for custom character
sets to the terminal. Because of message length limits, transmission of character
set definitions typically requires several messages. Each message contains a
portion of the character set definitions. Table 4-109 illustrates the command
message format. The following paragraphs describe the fields.
[ Response Flag ] [ X ] [ 1 ]
The following paragraphs describe the fields specific to the Write Command 14
message.
If a CHAR.DEF record is too long to fit in one message, the record can be broken
up and sent in two or more messages. Each message must repeat the character set
information for that file record (Character Set Number field through Character
Height field, including the trailing field separator). The character data that
follows these fields can be split anywhere, so long as a Character Number field is
not separated from the Cell List field that follows it.
4-325
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 14 Message (custom character sets for EMG)
For more details on the Write Command 14 message, refer to the Enhanced
Monochrome Graphics Programming Manual (TP-799300-000A).
4-326
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 15 Message (cell data for EMG)
This message is used to send the cell data for custom icons and character sets to
the terminal. Because of message length limits, transmission of cell data can
occur in several messages. Each message contains a portion of the cell data.
Table 4-110 illustrates the command message format. The following paragraphs
describe the fields.
[ Response Flag ] [ X ] [ 1 ]
If a CELL.DAT record is too long to fit in one message, the record can be broken
up and sent in two or more messages. Each message must repeat the cell set
information for that file record (Library List field, field separator, and Cell Height
field). The cell data that follows these fields can be split anywhere, so long as a
Cell Number field is not separated from the Cell data field that follows it.
For more details on the Write Command 13 message, refer to the Enhanced
Monochrome Graphics Programming Manual (TP-799300-000A).
4-327
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
This message is used to load format templates into the terminal. The maximum
message length for this command is 1920 characters from header to ETX.
Because of message length limit, transmission of format templates can occur in
several messages. Each message contains a portion of the format templates.
Table 4-111 illustrates the command message format.
[ Response Flag ] [ X ] [ 1 ]
The following paragraphs describe the fields specific to the Write Command 18
message.
4-328
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
NOTE
Format templates are used most often during Information Entry states
(Section 4). However, a format template can be called by any screen using the
ESC V control sequence. When the ESC V control sequence are used, buffer
data is shown on the screen within the constraints of the format template; no
consumer input is required.
Format templates are part of the configuration data that the network either
downloads with Write Command messages or updates with Function Command
messages (Section 5).
Format Template Numbers between 001 and 099 identify individual format
templates. Unused templates do not need to be downloaded. Format Template
Number 000 is reserved and indicates to the terminal that it disables all numeric
keys during the Information Entry state.
A format template used for PIN entry must be of the maximum length expected
in the card base. If the network specifies the buffer @ as the PIN buffer in an
Information Entry state, the terminal enables the keypad for the number of
digits specified in the PIN Length entry of the consumer’s associated FIT entry.
The terminal allows the network to send the following two types of format
template characters:
• Data type characters to determine the type of data the consumer can enter
A format template can contain enough characters to fill one full line of screen
characters. A single screen line is 40 characters long, so a format template can
contain from 1 to 40 display method and data type characters.
The network can mix display method and data type characters in the same format
template with some restrictions. The following paragraphs describe the different
types of format template characters and the restrictions for using them.
Several examples of how format templates are used for consumer entered data
are shown in Table 4-112.
4-329
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
Format Template Data Entry Display After Data Entry Contents of Input Buffer After Entry
AAAA No Entry
1st A |A|
2nd AB |A|B|
XXXX No Entry
1st x |1|
2nd xx |1|2|
(zzz)zzz-zzzz ( ) - No Entry
1st (1 ) - |1|
• • •
• • •
• • •
D$b/AAAAAA.AA $ No Entry
1st $1 |1| | | |
2nd $ 12 |1|2| | |
4-330
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
Format Template Data Entry Display After Data Entry Contents of Input Buffer After Entry
5th • •
• • •
• • •
4-331
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
The display method characters specify how the data is shown on the consumer
display as the consumer enters the data. The display method characters (when
used) are the first three characters in a format template. The valid entries for the
display method characters are as follows.
The terminal shows the first data character entered in the left-most display
field position. When the consumer enters more data, the terminal shows
the characters in succession in the display positions to the right of the last
character entered. The characters are not shifted to the right (Table 4-112).
075B*******
Format template 75 uses display method B to show the asterisk (*) character
for each consumer key input (excluding function keys) up to seven key
inputs (because there are seven * characters in the format template). After
seven key inputs, the format template is full and the keypad is disabled.
If the Information Entry state is programmed to do so, the state exits
appropriately when the format template is full.
088B0123456789 ABCDEFGHIJKLMNOPQRSTUVWXYZ$!
012B!@#$%^&*()_-+=?><,.
Format template 88 displays 0 for the first key input, 1 for the second key
input, 2 for the third, and so on, up to the 40th character in the format
template, !. Format template 12 shows some of the other characters that can
be used with display method B.
• C** - The terminal shows the consumer-entered data starting at the right of
the display field and shifting to the left as the consumer enters more data.
The ** characters represent the first two (leading) symbols shown in the
display field (Table 4-110) or they can be 04, which tells the terminal to use
reserved screen 004 (Section 4.10) for the leading symbols.
NOTE
4-332
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
• D** - The terminal shows the consumer entered data starting at the left of
the display field. The ** characters represent the first two (leading) symbols
shown in the display field or they can be 04, which tells the terminal to use
reserved screen 004 (Section 4.10) for the leading symbols. The first data
character entered is shown in the first display field position following the
** leading symbols. As more data is entered, the characters are shown in
succession in the display positions to the right of the last character entered.
The characters are not shifted to the right (Table 4-112).
A D format template can have one decimal point. The decimal point cannot
occupy the right-most position in the template. The terminal uses the
template’s decimal point to determine how many decimal positions are
applicable in the currency system. Typical currency systems have two
decimal positions.
NOTE
The terminal recognizes only the first decimal point key pressed. All other
decimal point keypresses are ignored.
The terminal does not enter the decimal point key data into the input buffer.
If a decimal point key is not pressed, the terminal assumes that the data
entered is a whole number and appends the buffer data sent to the network
with the required number of zeros to fill the decimal positions.
NOTE
Filling all the character positions to the left of the decimal point causes the
terminal to automatically show the decimal point on the consumer display.
The consumer need not press the decimal point key. After the decimal point
appears, any additional numeric input fills the decimal positions.
The data type characters specify the type of data the consumer can enter and if
the data appears on the consumer display. The number of data type characters
in a format template also specifies the maximum number of characters a
consumer can enter.
4-333
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
The valid entries for the data type characters are as follows:
• X - alphanumeric display, but show only Xs on the display for any character
entered (not valid for D display method formats)
• W - alphanumeric display, but show only Xs on the display for any character
entered (not valid for C and D display method formats)
• 5 - insert reserved screen 005, which stores the thousands separator character
When activated, format templates with A or X data type characters clear the
display field on the consumer display. Format templates with V or W data type
characters overlay the display field without first clearing it.
Data types V and W are unique in that the format template field area on the
consumer display is not cleared before the consumer-entered data is displayed.
Whatever is on the screen when the format template is referenced is overwritten.
Type W shows Xs for any character entered. Type V shows the character
entered as is. Neither of these data types can be used with the C or D formats.
Also, the letters V and W are not recognized as special data types when used
with the B format.
Using these formats and the associated screen data with cursor control, the
network programmer can make the screen appear to have place holders for
consumer-entered data. For example, consider an Information Entry state that
references the following screen data and format template:
Screen data:
Format data:
033WWWWWW
4-334
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
When the state references screen 010, the screen is cleared and the verbiage
PLEASE ENTER YOUR PIN is displayed at cursor position CC. The cursor
is then positioned to GI and six. (dots) characters are displayed. The cursor is
then repositioned to the beginning of the dot field. While the consumer enters
his or her PIN, the dots are overwritten with Xs.
• Template 001
C04ZZZZ5ZZ9699 (used for transaction amount
entry display) (state F)
• Template 002
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX (used
for OAR display)
• Template 003
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA (used
for OAR display)
• Template 004
XXXXXXXXXXXXXXXX (used for PIN entry
display) (states B and M)
• Template 005
AA (not used)
• Template 006
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX (used for
information entry display) (state H)
• Template 007
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA (used for
information entry display) (state H)
• Template 008
C04ZZZ5ZZZ5ZZ96 (used for transaction
amount entry display)
• Template 009
C04ZZZZZ9699 (used for transaction amount
entry display)
4-335
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
• Template 010
C04ZZZZZZZZZ9699 (used for transaction
amount entry display)
• Template 011
C04ZZZZZZZZ96999 (used for transaction
amount entry display)
Note that the actual transaction amount format depends on other configuration
data, which can specify 8 or 12 total digits, 2 or 3 decimal places, and either
calculator or decimal format. The preceding list shows the format template
data for 8-digit, 2 decimal place, calculator format. Other applicable formats
are as follows:
Description Format
4-336
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
2. When using calculator (C) or decimal (D) entry formats, the C or D does
not count toward the length. Also any leading spaces in the two-character
modifiers of these formats are ignored and assumed to be null (thus not
counting toward length).
3. When inserting screen 004 as modifier, the length of screen 004 is used
instead of the 04 (two characters) in the modifier.
4. The remainder of the length is based on the length of the format template
itself.
Calculator-type entries should be used to display data entry shifting from right
to left. Normal undefined format entry is from left to right. Decimal entry is
left to right, but includes the synchronizing of the decimal point for format
length. Decimal entry should only be used when displaying entries with decimal
amounts.
001I123C
/
b
/ZZZZZZZZ Format Template 1, 8 digits zero suppression.
b
123*************** Screen 123, all asterisks.
An example of a normal style format with initialization used for date entry
is as follows:
The preceding format initially displays../../.. where the periods are replaced by
keypad digits from left to right to fill in the date.
The preceding changes can result in the shifting of format displays currently
in use with the C and D formats by up to two places to the left on the display
if the modifier for those formats is blank (two space characters). Also, the
display can be shifted to the right in calculator C-style formats using reserved
screens 005 and 006 for the comma and decimal point if those screens are
defined as null. The display shifts to the right by one character for each null
screen usage in the format template.
4-337
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
[ Response Flag ] [ X ] [ 1 ]
Modifier (Parameters+LUNO+Timers) 3 1
Reserved X 1 [1]
Reserved X 3 [1]
Reserved X 3 [1]
Reserved X 3 [1]
Reserved X 3 [1]
Miscellaneous Features 1 - - - 3
Reserved 000 3
Miscellaneous Features 2 - - - 3
Reserved 000 3
4-338
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
Timer Number - - - 2
Number of Ticks - - - 3
The following paragraphs describe the fields specific to the Write Command 3
message.
Miscellaneous Features 1
Field Size: 3 characters
Valid Range: 000 through 255
Description: The value in the Miscellaneous Features 1 field is the sum of the
weights of the features selected. Agilis 91x for ix/CSP allows the network to
select the following features for Solicited Status and Unsolicited Status messages
from the terminal to the network:
4-339
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
Weight Features
64 Decimal style
4 Reserved [1]
Decimal Style
The Decimal Style feature allows the consumer to insert a decimal point or
equivalent delimiter at the desired position. This feature works properly in
conjunction with all combinations of eight- and twelve-digit dollar buffer
and two- and three-decimal positions, except for the eight-digit dollar buffer
with three decimal places.
This feature also allows the network to download appropriate screens for
inserting the currency symbol (screen 004) and the decimal character (screen
006) delimiters. Up to 20 characters can be downloaded for screen 004. If more
than 20 characters are downloaded, only the first 20 characters are displayed.
Only one character can be displayed for screen 006. If more than one character is
downloaded for screen 006, only the first character is displayed. If screens 004
and 006 are not downloaded, the terminal uses $ for screen 004 and . for screen
006 as the default characters to display.
Using this feature, all numerical digits entered before the decimal point (or
equivalent delimiter) represent whole currency units (for example, dollars) and
start in the leftmost position. All numerical digits entered after the decimal point
keypress appear to the right of the decimal point, starting with the leftmost
position. The following examples assume an eight-digit dollar buffer with two
decimal positions.
EXAMPLE 1
Entry of three digits of U.S. dollars and two digits of cents appears on the
consumer display as follows:
Before entry $
4-340
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
1st digit $ 1
2nd digit $ 12
3rd digit $ 123
Decimal key $ 123.
4th digit $ 123.4
5th digit $ 123.45
The entry session terminates with the keypress of a function key or Cancel key.
After the second decimal digit (5 in this case), the numeric digits of the keypad
are disabled and do not respond to further keypresses. The consumer must press
a function key or the Cancel key to end the entry.
EXAMPLE 2
The entry of U.S. cents only appears on the consumer display as follows:
Before entry $
Decimal key $ 0.
1st digit $ 0.1
2nd digit $ 0.12
The entry session terminates with the keypress of a function key or Cancel key.
After the second decimal digit (2 in this case), the numeric digits of the keypad
are disabled and do not respond to further keypresses. The consumer must press
a function key or the Cancel key to end the entry.
EXAMPLE 3
The entry of three digits of U.S. dollars and one digit of cents appears on the
consumer display as follows:
Before entry $
1st digit $ 1
2nd digit $ 12
3rd digit $ 123
Decimal key $ 123.
4th digit $ 123.4
The entry session terminates with the keypress of a function key or Cancel key,
and the terminal fills in (for the network) the missing zero. Or the consumer
can enter a final zero before terminating the amount entry. Likewise, if only a
whole-dollar amount was entered, no decimal digits appear on the consumer
display, but the terminal fills in the 00 for the cents digits.
EXAMPLE 4
The entry of six digits of U.S. dollars and two digits of cents appears on the
consumer display as follows:
Before entry $
1st digit $ 1
2nd digit $ 12
3rd digit $ 123
4th digit $ 1234
5th digit $ 12345
4-341
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
At this point, the numeric keys are disabled and the Cancel and function keys
are enabled. Notice that the consumer cannot enter too many dollar digits. The
decimal point can be entered after the sixth digit, but it is not necessary. The
seventh numeric digit is automatically taken as the first cents digit.
NOTE
Miscellaneous Features 2
Field Size: 3 characters
Valid Range: 000 through 255
4-342
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
Description: The value in the Miscellaneous Features 2 field is the sum of the
weights of the features selected. Agilis 91x for ix/CSP allows the network to
select the following features:
Weight Features
128 Reserved
2 Reserved
1 Reserved
Miscellaneous Features 3
Field Size: 3 characters
Valid Range: 000 through 255
Description: The value in the Miscellaneous Features 3 field is the sum of the
weights of the features selected. Agilis 91x for ix/CSP allows the network to
select the following features:
4-343
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
Weight Features
32 No retract bills
4-344
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
There are three main operational modes for this feature, governing the terminal’s
response to unremoved bills during a bill dispense transaction:
• Stay In Service. This mode requires network changes to state and screen
configuration data in order to prevent the consumer from selecting additional
bill dispense transactions while unremoved cash remains in the presenting
position.
If the Money Forgotten and Money Removed messages are enabled, the Money
Forgotten message (a solicited Withdrawal Door status with a status byte of 30)
is sent when the alloted delivery time expires. The Money Removed message
(an unsolicited Withdrawal Area Sensors status with a status byte of 40) is sent
when the cash is removed. These messages are required only if you are using
the Go Out of Service, Wait for Network Command to Go Back In Service
operational mode. These messages are not required for the other two operational
modes, but can be turned on to capture how often consumers do not remove
cash in the delivery time allowed.
The operational modes are set and the messages enabled using the Fascia
configuration setting. For detailed information on configuration setting refer to
the Agilis 91x for ix Installation and Configuration Guide (TP-820605-001D).
4-345
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
Miscellaneous Features 4
Field Size: 3 characters
Valid Range: 000 through 255
Description: The value in the Miscellaneous Features 4 field is the sum of the
weights of the features selected. Agilis 91x for ix/CSP allows the network to
select the features listed in the following table:
Weight Features
128 Reserved
64 Reserved
32 Reserved
8 Reserved
1 Reserved
The setting of the Send Envelope Dispenser Status to Network feature has an
effect only if the Envelope Dispenser Configuration Control feature is selected. If
the Envelope Dispenser Configuration Control feature is not selected, Agilis 91x
ignores the setting of the Send Supplemental Dispenser Status to Network feature.
4-346
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
NOTE
Timer Number
Field Size: 2 characters
Valid Range: 00 through 31
Description: This two-character field contains the timer number (enhanced
timers have a 9 in front of these numbers, for example, enhanced timer 905 is
timer 05 as defined here). The valid values for this field, along with the timer
descriptions, are as follows:
• Timer 02 - Timer 02 sets the Close state screen timeout interval. At the end
of this interval, the terminal proceeds to the next state number specified
in the Close state.
NOTE
4-347
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
• Timer 04 - Timer 04 sets the deposit insertion timeout interval for the
depository. When a screen is displayed that prompts the consumer to insert
an envelope, check, or document into the depository, the consumer must
respond within the timeout interval specified by timer 04. Otherwise, the
terminal exits its present state, displays screen 000, and starts timer 01. The
keypad beeper sounds while this timer is active.
If timer 20 has a non-zero value, Agilis 91x for ix/CSP uses timer 20 in
place of timer 04.
• Timer 05 - Timer 05 sets the initial withdrawal timeout interval for terminals
with a cash presenter. The terminal starts timer 05 after the bills are
presented to the consumer. The maximum amount of time that the terminal
waits for a consumer to remove the bills is the sum of timers 05 and 07.
Refer to the description of timer 07 for further details.
NOTE
• Timer 07 - On all terminals with a cash presenter, timer 07 starts after either
the consumer takes all the presented bills or timer 05 expires. A timeout
interval of 000 is suggested, to minimize transaction time.
• Timer 08 - Timer 08 sets the timeout interval for inserting a deposit bag or
other deposit material into the After Hour depository. When a screen is
displayed that prompts the consumer to insert a deposit, the consumer must
respond within the timeout interval specified for timer 08. Otherwise, the
terminal exits its present state, displays screen 000, and starts timer 01.
• Timer 09 - Timer 09 sets the consumer timeout interval before a card capture
attempt. If, during a close state, the card is presented to the consumer and
it is not removed within this time period, a card capture attempt is made.
This timer starts after the terminal executes the card return function ID
and at the beginning of the Close state if the card was not returned at the
Card Read state. Timers 02 and 09 start at the same time. When the card
is removed, timer 09 stops. Timer 09 defaults to 30 seconds (38 ticks) by
the terminal on powerup.
NOTE
NOTE
4-348
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
• Timer 15 - Timer 15 is used with the Card Read T state. Timer 15 sets the
amount of time from when the card reader is enabled until timer 01 starts,
and screen 000 is displayed if no action is taken by the consumer.
NOTE
• Timer 18 - Timer 18 sets the Swipe Card Reader or Dip Card Reader Retry
Screen timer. Timer 18 sets the amount of time the Swipe Card Reader or
Dip Card Reader Retry screen is displayed before the Welcome screen is
re- displayed. For Card Read state (A), during this time, the consumer can
attempt to swipe or dip a card again. An error during this subsequent read
attempt causes the retry screen to be displayed again. If timer 18 expires
without a retry attempt, the original screen specified in the Card Read state
(A) is displayed. Timer 18 defaults to 012 ticks on powerup. (Timer 18 is
not applicable for Card Read state [T].)
NOTE
• Timer 20 - Timer 20 sets the insertion timeout interval for the depository. If
timer 20 has a non-zero value, Agilis 91x for ix/CSP uses timer 20 in place
of timer 04. Timer 20 allows seven seconds of silent time, after which the
beeper sounds at a slow rate for the remainder of the specified time.
• Timer 22 - .Reserved
4-349
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
• Timer 23 - Timer 23 is used by the dip card reader. Timer 23 sets the
amount of time the terminal waits for the consumer to remove a card from
the dip card reader before displaying a prompt for removal screen on the
display. The prompt for removal screen is reserved screen 915. Timer 23
is set by Agilis 91x for ix/CSP to a default value of 000. A value of 000
causes Agilis 91x for ix/CSP to wait forever before displaying the prompt for
removal screen (reserved screen 915). To allow Agilis 91x for ix/CSP to
display the prompt for removal screen, timer 23 (or enhanced timer 923)
must be set to a non-zero value.
NOTE
Number of Ticks
Field Size: 3 characters
Valid Range: 000 through 255
Description: This three-character, decimal data field determines the timeout
intervals for the timers in 800 millisecond ticks. The number of ticks can be 001
to 255. This gives a timeout range from 0.8 seconds to 204 seconds. The default
and suggested values are as follows:
4-350
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
00 000 019
01 000 019
02 000 006
03 000 225
04 000 075
05 000 025
06 075 075
07 000 000
08 000 075
09 038 038
15 000 038
18 012 012
19 000 075
21 000 038
22 030 030
23 000 003
31 030 030
NOTE
4-351
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 6 Message (Financial Institution Tables)
[ Response Flag ] [ X ] [ 1 ]
Modifier (FIT) 5 1
FIT Number - - - 3
[ MAC Data ] [ - - - ] [ 8 ]
The following paragraphs describe the fields specific to the Write Command 6
message.
FIT Number
Field Size: 3 characters
Valid Range: 000 through 509
Description: This three-character field designates the number assigned to the
FIT in the following field.
4-352
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 6 Message (Financial Institution Tables)
FIT Data
Field Size: 38 bytes
Valid Range:
Description: FIT data specifies the control words for processing PINs. FIT data
is also used for Indirect Next state and remote PIN encryption. FIT data is
downloaded to the terminal.
MAC Data
Field Size: 8 characters
Valid Range:
Description: This eight-character field contains hexadecimal characters that
represent the MAC calculation of the Write Command 6 message. Refer to
the Data Security Procedures and Reference Manual (TP-799530-001D) for
additional details.
4-353
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 7 Message (encryption key change)
This message carries encrypted encryption keys to replace the current keys. The
message also includes a control word (in the modifier field) that identifies the key
in the message and the means of decrypting the key. Refer to the Data Security
Procedures and Reference Manual (TP-799530-001D) for a detailed description
of data encryption. Table 4-115 illustrates the message format.
[ Response Flag ] [ X ] [ 1 ]
[ Key Change ] [ - - - ] [ 1 ]
The following paragraphs describe the fields specific to to the Write Command 7
message.
Key Change
Field Size: 1 character
Valid Range: 1 through 9, ? and @
Description: This one-character field tells the terminal which key(s) to use
for encryption and message authentication. The valid values for this field
are as follows:
The ATM must receive two Write Command 7 messages for Visa local PIN
verification. The first message should contain 8 and the Visa master key. The
second message should contain 9 and the Visa key table.
4-354
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 7 Message (encryption key change)
NOTE
• If the Key Change field is 4 or 7, there is no New Key data; this field is not
included in the message.
NOTE
• If the Key Change field is 9, the New Key Data field is 288 characters. It
consists of 12 keys (six Visa key pairs), eight hex bytes per key. Each
hex byte is sent as a three-character decimal number with a range of 000
through 255.
4-355
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 7 Message (encryption key change)
• If the Key Change field is ? (remote key transport), the New Key Data field
contains a Tag field (three decimal digits), followed by a Length field (four
decimal digits), followed by a Base64-encoded encrypted, signed key block
message (approximately 1200 to 1300 bytes). The value in the Tag field
identifies the type of key contained in the key block message. The following
values are defined for the Tag field:
• If the Key Change field is @ (public key certificate), the New Key Data
field contains a Tag field (three decimal digits), followed by a Length
field (four decimal digits), followed by a Base64-encoded public key
certificate. At present, the only valid value for the Tag field is 001, which
indicates that the public key certificate is a Network’s Certificate message
(approximately 900 to 1100 bytes).
NOTE
4-356
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 8 Message (configuration ID)
The terminal can respond to the Configuration ID Request message (as described
previously) only when it is in Supply mode or Out-of-service mode. When the
terminal is not in one of these modes, the terminal responds with a Command
Reject (Section 5.11).
[ Response Flag ] [ X ] [ 1 ]
Configuration ID Number - - - 4
The following paragraphs describe the fields specific to the Write Command 8
message.
4-357
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 8 Message (configuration ID)
Configuration ID Number
Field Size: 4 characters
Valid Range: 0001 through 9999
Description: This four-character field contains the configuration ID number.
This number must be in the range of 0001 to 9999. 0000 indicates that the
terminal is not configured.
4-358
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Section 5
Transaction Messages
This section describes the messages that make up the communications interface
between Agilis 91x for ix/CSP and the controlling network. These messages
are used for performing transactions at the terminal and for providing feedback
to the network.
The terminal gathers all the necessary information for a Consumer Request
message. Typically this information consists of the following items:
After the terminal completes the transaction with the consumer, the terminal
sends a Solicited Status message to the network.
The basic message formats used in the system are fixed. These formats contain
the necessary control characters to conform with most protocol formats. This
section shows the format for each message type used in the system. Messages
can travel either from the terminal to the network, or from the network to the
terminal. Individual variable fields in Agilis 91x for ix/CSP messages are not
restricted in size (unless otherwise noted on a per-field basis), but the total
message length cannot exceed 1920 bytes.
5-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Transaction Messages
Most of the Write Command messages are used for loading configuration data
into the terminal. These Write Command messages are described in Section 4.
The only one described in this section is Write Command 5 (Section 5.9).
g1959060
Section 5.1 through Section 5.10 illustrate these messages in table form. The
notation conventions in Table 4-1 apply to all the message tables.
5-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
The Consumer Request message contains data that the network needs to
authorize a consumer transaction at the terminal. The maximum length of this
message is 1920 characters (bytes). The network answers a Consumer Request
message with a Function Command message to the terminal. Refer to Table 5-1
for the data fields and sequence of fields for a Consumer Request message.
Solicited/Unsolicited ID 1 1
Message Identifier 1 1
Top-of-Form Flag - - - 1
5-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
[1] These fields are only sent if the MAC flags entered by the key-entry person were 01 or 11.
[2] This field can be 12 characters if the Dollar Buffer Size feature is selected with the Write Command 3 message (Section 4.23).
[3] This field separator and all the following fields to the next field separator are only sent in this message if the Transaction
Verification Status feature is selected in bit 6 of the Miscellaneous Features 3 field in a Write Command 3 message
(Section 4.23).
[4] The Field Separator and Rollover Count fields are only sent if Append Rollover Counts is selected in Write Command 3,
Miscellaneous Features 1
[5] All data associated with buffer data is optional. If any buffer data is present, then the Field Separator (FS) and the Buffers to
Follow ID (9) must be present. There must also be at least one buffer ID and one buffer data field. Additional buffer ID and
buffer data fields must be preceded by a group separator (GS).
5-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
[ Device ID ] [ - - - ] [ 4 ] [3]
[ Buffer ID ] [ - - - ] [ 3 ] [5]
[ Buffer ID ] [ - - - ] [ 3 ] [5]
The following paragraphs describe the fields in the Consumer Request message:
5-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
Solicited/Unsolicited ID
Field Size: 1 character
Valid Range: 1 and 2
Description: This field tells the network whether the message is solicited or
unsolicited. The valid entries for this field are as follows:
• 1 - Unsolicited message
• 2 - Solicited message
Message Identifier
Field Size: 1 character
Valid Range: 1
Description: This one-character data field defines the type of message being
transmitted. The only valid value for the Consumer Request message is 1.
5-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
Track 2 Data
Field Size: Variable
Valid Range:
Description: This variable-length data field contains up to 40 characters of data
from track 2 of the magnetic stripe on the consumer’s account card. This field
includes the data from the start sentinel to the end sentinel, inclusive.
Track 3 Data
Field Size: Variable
Valid Range:
Description: This is a variable-length field that contains up to 106 characters of
data from track 3 of the magnetic stripe. This field includes the data from the
start sentinel to the end sentinel, inclusive.
The terminal stores the following information for each function key pressed:
A A
B B
C C
D D
The Clear Keys state can clear and preset any of positions in the Function
Key Buffer.
The Select Function state determines where the graphic is stored in the function
key buffer.
5-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
Description: If the Dollar Buffer Size feature is not selected, the Dollar and
Cents Keyboard Entry field can be either zero or eight characters long. If
the Dollar Buffer Size feature is selected, this field can be either zero or
twelve characters long. This field identities the transaction amounts entered
at the keypad. The content of this field is determined by the Dollar Entry
state or the Set Dollar Buffer state. The data is right justified with zeros to fill
unused positions on the left.
PIN Buffer
Field Size: 0 or 16 characters
Valid Range:
Description: The PIN Buffer field contains the 16-character encrypted PIN,
provided that the consumer entered a PIN, and the Transaction Request state data
specifies sending the PIN to the network.
If the Transaction Request state data specifies sending the PIN to the network,
but no PIN has been entered, the PIN buffer field contains either 16 zeros or is
empty (zero length field), depending on how the system is configured.
If the Transaction Request state data specifies not sending the PIN to the
network, the PIN buffer field is empty.
If it is not being sent in response to an OAR screen, this field only contains up to
32 digits entered by the consumer.
Track 1 Data
Field Size: Variable (79 maximum)
Valid Range: Refer to the description
Description: This variable length field contains up to 79 characters of data from
the track 1 magnetic stripe. This field includes the data from the start sentinel to
the end sentinel, inclusive.
5-8
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
MICR Data
Field Size: Variable (70 maximum)
Valid Range: The following characters are valid MICR data characters:
• 0 through 9 - Numbers
• T - Transit symbol
• $ - Amount symbol
• * - On-us symbol
• -- - Dash symbol
• - Blank
• _ - Unidentified symbol
Description: The data contained in this buffer is the MICR data read from
a deposited check.
• 1 - Ready 9 or B
Retract Operation
Field Size: 1 character
Valid Range: Refer to the description
5-9
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
Device ID
Field Size: 4 characters
Valid Range: DI01
Description: This is a four-character field that indicates the following status
information is for the bill dispenser.
NOTE
NOTE
Device ID
Field Size: 4 characters
Valid Range: CN01
Description: This is a four-character field that indicates the following status
information is for the coin dispenser.
NOTE
5-10
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
NOTE
Device ID
Field Size: 4 characters
Valid Range: XXyy
Description: This is a four-character field that indicates the following status
information is for any other device in the system. XX is the 2-letter device name
and yy is the two-letter device number. This field is reserved for future use.
NOTE
Buffers to Follow ID
Field Size: 1 character
Valid Range: 9
Description: The Buffers to Follow entry is a field ID that indicates the next
message entries contain Buffer ID and Buffer Data entries.
Buffer ID
Field Size: 3 characters
Valid Range: 065 through 090, and 256 through 299
Description: The Buffer ID entry is a Group ID that identifies a buffer.
Buffer Data
Field Size: Maximum of 256 characters
Valid Range: 000 through 255
Description: The Buffer Data entry contains the data stored in the buffer
identified in the Buffer ID entry preceding this entry.
NOTE
Rollover Count
Field Size: 3 characters
Valid Range: 000 through 255
Description: Each of these three-character entries contains the three least
significant digits of a five-digit dispense counter that keeps track of the number of
bills known to be successfully delivered to the consumer. Each entry represents a
dispense position, starting with dispense position 1 (top). These fields are
included only if Append Rollover Counters is selected in the Miscellaneous
Features 1 field of a Write Command 3 message (Section 4.23).
MAC Data
Field Size: 8 characters
5-11
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
Valid Range:
Description: This eight-character field contains hexadecimal characters that
represent the MAC calculation of the Consumer Request message. Refer to
the Data Security Procedures and Reference Manual (TP-799530-001D) for
additional details.
Solicited/Unsolicited ID 1 1
Message Identifier A 1
Top-Of-Form Flag - - - 1
[ Rollover 1 Count ] [ - - - ] [ 3 ]
[ Rollover 2 Count ] [ - - - ] [ 3 ]
[ Rollover 3 Count ] [ - - - ] [ 3 ]
[ Rollover 4 Count ] [ - - - ] [ 3 ]
[ MAC Data ] [ - - - ] [ 8 ]
The following paragraphs describe the modified or added fields in the Consumer
Request message:
5-12
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Consumer Request Message
Message Identifier
Field Size: 1 character
Valid Range: A
Description: This field defines the type of message being transmitted. The only
valid value for a format 1 Consumer Request message is A.
Field ID (Buffers)
Field Size: 3 characters
Valid Range: 9
Description: The Field ID (Buffers) entry is a field ID that indicates the next
message entries contain Buffer ID and Buffer Data entries.
Buffer ID
Field Size: 3 characters
Valid Range: 064 (consumer-entered PIN) through 090 (buffers A through Z),
and 256 through 299 (enhanced buffers)
Description: The Buffer ID entry identifies the buffer that provides the data
placed in the buffer Data field.
The value 064 indicates that the Buffer Data field contains the consumer-entered
PIN in encrypted form.
Buffer Data
Field Size: Maximum of 256 characters
Valid Range: 000 through 255
Description: The Buffer Data entry contains the data stored in the buffer
identified in the Buffer ID entry preceding this entry.
NOTE
5-13
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Solicited/Unsolicited ID 2 1
Message Identifier 2 1
Status Descriptor - - - 1
[ Status ] [ - - - ] [ Variable ]
[1] The Group Separator, Device Identifier, and Status fields are sent when the Solicited
Status message is sent in response to a Configuration Information Request
Operational Command message. When transmitted, these fields can be repeated
so that the Solicited Status message contains all the required information. Refer to
Section 5.7 for details on the Operational Command message.
[2] The Field Separator field and the Amount of Coins Dispensed field are only included
in Coin Dispenser solicited status when the Function Command message for the
coin dispense used the Dollar Amount of Coins field to specify the amount of coin
to dispense.
[3] The Field Separator and the MDS Status fields are only sent if the MDS Status to
Network feature is selected in the Miscellaneous Features 2 field of a Write Command
3 message (Section 4.23).
[4] All data associated with buffer data is optional. If any buffer data is present, then the
Field Separator (FS) and the Buffers to Follow ID (9) must be present. There must
also be at least one Buffer ID field and one Buffer Data field. Additional Buffer ID fields
and Buffer Data fields must be preceded by a group separator (GS).
[5] The Field Separator and Rollover Count fields are only sent if Append Rollover
Counts is selected in the Miscellaneous Features 1 field of a Write Command 3
message (Section 4.23). However, if the Solicited Status message is sent in response
to a Configuration Request Operational Command message or a Supply Counts
Operational Command message, the FS and Rollover Count fields are not sent.
5-14
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
[ Buffer ID ] [ - - - ] [ 3 ] [4]
[ Buffer ID ] [ - - - ] [ 3 ] [4]
The following paragraphs describe the fields for the Solicited Status message:
5-15
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Solicited/Unsolicited ID
Field Size: 1 character
Valid Range: 1 and 2
Description: This field tells the network whether the message is solicited or
unsolicited. The valid entries for this field are as follows:
• 1 - Unsolicited message
• 2 - Solicited message
Message Identifier
Field Size: 1 character
Valid Range: 2
Description: This one-character data field defines the type of message being
transmitted. The only valid value for the Solicited Status message is 2.
Status Descriptor
Field Size: 1 character
Valid Range: Refer to the description
5-16
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
• ’B’ - Ready. When separate Ready for function commands is selected, this
character indicates successful completion of the function command.
• ’C’ - Specific MAC Command Reject. The terminal can send this
character only if MAC is enabled. This character indicates the unsuccessful
completion of a message because of a Message Authentication Code (MAC)
failure or a Time Variant Number failure. The terminal can send this
character in response to any of the following messages:
• ’D’ - Specific Command Reject. The terminal can send specific reject
reasons to the network. Reject reason codes are described in Section 5.2.21.
• If Status Descriptor field is ’8’, the status bytes following this field are
defined as follows:
5-17
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
- ’;’ - Trap
- ’<’ - Configuration ID
- ’D’ - Cassette (912 mode). This device identifier is also used to indicate
that the statement printer is ready for more information (912 mode)
5-18
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
• If the Status Descriptor field is ’C’, this field contains one of the following
characters, and no device status bytes follow:
- ’2’ - Time Variant Number Failure. The time variant number received in
the Function Command message did not equal the time variant number in
the Consumer Request message.
For additional details on MAC and the time variant number, refer to the Data
Security Procedures and Reference Manual (TP-799530-001D).
Status
Field Size: Variable
Valid Range: Refer to the description
Description: Each status byte is broken up into upper and lower nibbles.
Each nibble is transmitted without decimal conversion, with the upper nibble
transmitted first. The hexadecimal device status code from the terminal to
the network is converted into two separate bytes of ASCII or EBCDIC code.
For details of this field, refer to Section 5.2.1. Following are examples of
how the terminal transmits the device status field to an ASCII network and an
EBCDIC network.
If the terminal issues a status byte of hexadecimal 4B, then the terminal transmits
a status of ASCII 34 3B in the device status field. After the network receives the
status of ASCII 34 3B, the network can then drop the 3 from both bytes and
reassemble the data into the original hexadecimal 4B status byte.
If the terminal issues a status byte of hexadecimal 4B, then the terminal transmits
a status of EBCDIC F4 5E (graphic 4;) in the device status field. After the
network receives the status of EBCDIC F4 5E, the network can convert EBCDIC
F4 5E into the original hexadecimal 4B status byte.
MDS Status
Field Size: Variable
Valid Range: Refer to the description
5-19
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Description: As an option, Agilis 91x for ix/CSP can send MDS status to the
network in a Solicited Status message. This feature is a terminal configuration
option set by the network through the Miscellaneous Features 2 field of the
Write Command 3 message (Section 4.23). When this feature is selected, the
terminal sends both the TABS-type status and the MDS-type status in Solicited
Status messages that contain device status (not including messages that contain
configuration information).
The data in the MDS Status field is the same data that the terminal prints on the
journal printer and is in the same format. Refer to the Agilis 91x for ix Status
Reference Manual (TP-820741-001B) for a description of the data printed on
the journal printer.
Buffers to Follow ID
Field Size: 1 character
Valid Range: 9
Description: The Buffers to Follow ID entry is a field ID indicating that the
following message fields (Buffer ID and Buffer Data) contain buffer data from
an Agilis 91x for ix/CSP buffer. If the terminal sends buffer data from more
than one buffer, the message contains a pair of Buffer ID and Buffer Data
fields for each buffer.
This set of message fields is used for the Remote Key Transport feature. For
detailed information about this feature, refer to the Data Security Procedures and
Reference Manual (TP-799530-001D).
Buffer ID
Field Size: 3 characters
Valid Range: 064 through 090, and 256 through 355
Description: The Buffer ID entry is a Group ID that identifies a buffer.
Buffer Data
Field Size: Variable
Valid Range: For each character, 0 through 9, A through Z, a through z, + / and =
Description: The Buffer Data entry contains the data stored in the buffer
identified in the Buffer ID entry preceding this entry.
NOTE
Rollover Count
Field Size: 3 characters
Valid Range: 000 through 255
Description: As an option, each of these three-character entries contain the three
least significant digits of a five-digit dispense counter that keeps track of the
number of bills known to be successfully delivered to the consumer. Each
entry represents a dispense position, starting with dispense position 1 (top).
These fields are included only if Append Rollover Counters is selected in the
Miscellaneous Features 1 field of a Write Command 3 message (Section 4.23).
However, if the Solicited Status message is sent in response to a Configuration
Request Operational Command message or a Supply Counts Operational
Command message, the field separator and Rollover Count fields are not sent.
5-20
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5-21
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
This section contains tables for the solicited status of the following components:
For Trap status (DID = ’;’), no status bytes are reported to the network.
5-22
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There are three bytes in printer solicited status. Printer solicited status is only
sent in 912 mode during print and wait operations. Refer to Table 5-4 for detailed
bit definition of these three bytes.
0 7 Print operation complete If this bit is set, the print operation has been completed.
3 Passbook printer has faulted A fault has occurred on the passbook printer which requires
attention.
NOTE
2 Statement Printer has faulted A fault has occurred on the statement printer which requires
attention.
1 Receipt printer has faulted A fault has occurred on the receipt printer which requires
attention. Detailed fault information is available in Printer
Solicited Status Byte 1.
0 Journal printer has faulted A fault has occurred on the journal printer which requires
attention. Detailed fault information is available in Printer
Solicited Status Byte 2.
1 7 Receipt printer has run low on paper This fault is normally caused by a depleted receipt printer
paper roll. It is corrected by reloading the printer. If this
fault is indicated and the paper roll is not out, an electrical
or mechanical malfunction might have occurred requiring
service assistance.
5 Receipt printer has run out of paper This fault is normally caused by the printer paper roll being
depleted. This fault is corrected by reloading the printer.
If this fault is indicated and the paper roll is not out, an
electrical or mechanical malfunction might have occurred
requiring service assistance.
3 Fault occurred during a top-of-form search on Bursting of the receipt is controlled by a dark mark on the
the receipt printer right side of each receipt. This mark is optically detected
by a top-of-form sensor. When this mark is detected, the
receipt is burst and presented to the consumer. If this
mark is not found after approximately six seconds of paper
movement (because of a paper loading problem, a paper
jam, or possibly an electrical or mechanical problem), the
following takes place: the paper movement halts, no burst
is attempted, and this fault is indicated.
5-23
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
1 2 Fault occurred during a head return and line After printing a line on the consumer receipt, the printer
feed on the receipt printer performs a carriage return of the print head to prepare for the
next line of data. At the same time a paper line feed is done.
Of these, only print head movement can be detected by the
paper margin sensor. The fault indications are caused by a
failure of the print head to return to the start position. No
monitoring of actual paper movement is done. A fault is not
indicated if a paper line feed is not done because of a paper
drive problem. A print head carriage return problem can be
caused by a paper jam or other obstruction, an electrical
or mechanical failure of the print head drive, or a failure of
the paper margin sensor. A fault indication might also be
caused by an electronic failure that is caused by a failure of
the printer electronics to send a ready signal to the terminal’s
microcomputer indicating task completion.
0 Fault occurred during a line print on the This fault is indicated following an attempt to print a line of
receipt printer characters on the receipt. Fault causes are:
• The print head fails to move because of a paper jam
or other obstruction, a mechanical failure of the print
head drive assembly, or an electrical failure of the head
motor drive electronics.
2 7 Journal printer has run out of paper This fault is normally caused by a depleted journal printer
paper roll. It is corrected by reloading the printer. If this
fault is indicated and the paper roll is not out, an electrical
or mechanical malfunction might have occurred requiring
service assistance.
6 Electrical fault detected on ready line of This is an electrical fault caused by a malfunction of the
journal printer journal printer electronics. The printer electronics has a
signal line called ready which is used to signal the terminal’s
microcomputer that a printer task has been completed.
A printer task complete is indicated by a logic low level
(ground) on this signal line. This line is then reset by an
acknowledgment signal from the microcomputer. If the ready
line fails to reset (remains grounded), this fault is indicated.
2 5 Journal printer has run low on paper This fault is normally caused by a depleted journal printer
paper roll. It is corrected by reloading the printer. If this
fault is indicated and the paper roll is not out, an electrical
or mechanical malfunction might have occurred requiring
service assistance.
5-24
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
2 Fault occurred during a head return and line After printing a line on the journal printer paper roll, the
feed on the journal printer printer does a carriage return of the print head to prepare
for the next line of data. At the same time, a paper line
feed is done. Of these, only the print head movement can
be detected by the paper margin sensor. Fault indications
are caused by a failure of the print head to return to the
start position. The printer does not monitor actual paper
movement. A fault is not indicated if a paper line feed is not
done because of a paper drive problem.
0 Fault occurred during a line print on the This fault follows an attempt to print a line of characters on
journal printer the journal printer paper roll if one of the following occurs:
• The print head fails to move due to a paper jam or other
obstruction, a mechanical failure of the print head drive
assembly, or an electrical failure of the head motor
drive electronics.
5-25
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There is one byte for After Hour depository (AHD) solicited status. See
Table 5-5 for detailed bit definitions.
5 Bin full or bag jammed sensor in throat This bit is set if a bag was accepted and seen by the Bag
sensor Drop Sensor but the sensor never went clear.
4 Bag not seen in chest throat This bit is set if the AHD operates properly, but a bag is not
seen by the Bag Drop Sensor.
3 Door locked (this bit is the complement of If this bit is the only bit set, it indicates an AHD deposit
bit 1) incomplete transaction but with no malfunctions. If this bit
and bit 2 are set, the AHD deposit transaction was successful
with no malfunction.
2 Cycle complete The AHD deposit transaction was successful, and the
materials have been placed in the safe. If this bit is not set,
the transaction was incomplete.
5-26
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There is one byte for the card reader solicited status for the 911 mode and two
bytes for 912 mode. Refer to Table 5-6 for detailed bit definition of these bytes.
0 7 Card return failure This bit is set if the card reader mechanism failed to return the
card. Refer to Byte 1 for details.
6 Card return timeout This bit is set if the consumer failed to take tha card within the
timeout period. A card capture was initiated.
5 Card capture failure This bit is set if a card capture was initiated, but failed.
1 7 Read operation complete This bit is used internally by the terminal for sequencing and
is always turned on in this status byte.
6 Track 1 read error These bits can appear on or off in any combination reflecting
the status of the last read operation. If any of these bits are on
and bits 1 and 0 are off, the terminal is reporting that the card
read error count set in the Card Reader configuration setting
has been reached. Shutdown of the terminal is not necessary,
but a timely inspection of the card reader is suggested.
3 Card in retain position This bit is used internally by the terminal for sequencing. This
bit being set does not indicate a status change requiring
sending a status message, for example, status messages that
include this bit on have other status.
2 Soft failure If this bit is set, the terminal sensed an abnormal condition in
the card reader. For example, the front and rear switches
were closed simultaneously. If this bit is set, the terminal
completes the current card read and allows future card reads.
Soft failure refers only to card motion and not card read errors.
1 Hard Fault If this bit is set, a fault has occurred on the card reader that
requires attention before another card read can be correctly
processed. This fault is normally caused by a card being
jammed on the read head that the card reader cannot return
or retain. Hard fault refers only to card motion and not card
read errors.
0 Card in rear If this bit is set, the terminal retained a card that it could not
return because of a mechanical failure. This bit being set
does not cause the terminal to send a status message.
5-27
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There is one byte for the card writer solicited status for the 911 mode and two
bytes for the 912 mode. Refer to Table 5-7 for detailed bit definition of these
bytes. Byte 0 of Table 5-7 is the only byte sent in the 911 mode.
Depending on the capabilities of the card reader, all three tracks can be written,
but only one track can be written at a time. This status applies to whichever
track was being written at the time the fault occurred.
0 7 Good write was not verified This bit is set if the terminal could not verify a
successful write on the track. The terminal verifies a
successful track write by reading the track of the card
after writing on that track.
0 No start or end sentinel The track being written’s data buffer does not contain
a start and an end sentinel. No writing was attempted.
1 7 Read operation complete This bit is used internally by the terminal for
sequencing and is always turned on in this status byte.
3 Card in Retain position This bit is used internally by the terminal for
sequencing. This bit being set does not indicate a
status change requiring sending a status message.
For example, status messages that include this bit on,
have other status.
1 Hard Fault If this bit is set, a fault has occurred on the card reader
that requires attention before another card write can
be correctly processed. This fault is normally caused
by a card being jammed on the read head that the
card reader cannot return or retain. Hard fault refers
only to card motion and not card write errors.
0 Card in rear If this bit is set, the terminal retained a card that it
could not return because of a mechanical failure. This
bit being set does not cause the terminal to send a
status message.
5-28
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There are eight bytes for Dispenser Solicited Status in the 911 mode. Table 5-8
lists and defines the Dispenser Status information. 912 mode Dispenser status
information is in Section 5.2.6.
Table 5-8 Dispenser Solicited Status for 911 Mode (DID = ’8’)
0 (HI 7 HI amount requested is amount dispensed The bill dispenser picked the HI side amount requested
Summary) by the network and transported it to the delivery area.
4 HI bill supply low This bit is set once if the HI-side cash supply is
nearly depleted and the terminal commands a HI-side
dispense. Dispensing can continue while this condition
exists. Further dispensing can result in a HI Bill Supply
Out condition.
3 HI bill supply out The terminal commands a HI-side dispense and the
HI-side cash supply is exhausted before or after the
dispense. Dispensing can continue while this condition
exists, but can result in a maximum-bill-pick attempts
fault on the HI side. A HI-side hard fault bit (bit 0) is
then set.
2 HI divert canister full, do not continue The divert count for the bill dispenser has reached its
maximum limit. Further dispensing might result in a
divert cassette overflow. In addition to the preceding
condition, this bit is also set if the LO side dispense
count reaches its maximum limit during a HI side
dispense (possibly due to an unrequested LO side bill
being picked and diverted). If uncontrolled bill picking
occurs on the LO side, dispensing must stop on both
the HI and LO sides. Before dispensing can continue,
the divert cassette must be emptied and the divert count
must be reset.
1 Inaccurate count, HI side An unknown cash amount has been dispensed on the
HI side. This condition might occur during a motor
failure or divert cassette failure.
0 Hard fault, HI side If the hard fault bit is set, HI side dispensing should
stop. Possible causes are as follows:
• Maximum-bill-pick attempts on the HI-side
• Bill jam
• No forward motor cycle
• No reverse motor cycle
• Divert cassette failure
• Transport failure
• Maximum exit sensor failures on the HI-side
1 (LO 7 LO amount requested is amount dispensed The bill dispenser picked the LO side amount requested
Summary) by the network and transported it to the delivery area.
5-29
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-8 Dispenser Solicited Status for 911 Mode (DID = ’8’) (continued)
4 LO bill supply low This bit is set once if the LO-side cash supply is
nearly depleted and the terminal commands a LO-side
dispense. Dispensing can continue while this condition
exists. Further dispensing can result in a LO Bill Supply
Out condition.
3 LO bill supply out The terminal commands a LO-side dispense and the
LO-side cash supply is exhausted before or after the
dispense. Dispensing can continue while this condition
exists, but can result in a maximum-bill-pick attempts
fault on the LO side. A LO-side hard fault bit (bit 0) is
then set.
2 LO divert canister full, do not continue The divert count on the bill dispenser has reached its
maximum limit. Further dispensing might result in a
divert cassette overflow. In addition to the preceding
condition, this bit can also be set if the LO side dispense
count reaches its maximum limit during a LO side
dispense (possibly due to an unrequested HI side bill
being picked and diverted). If uncontrolled bill picking
occurs on the HI side, dispensing must stop on both the
HI and LO sides. Before dispensing can continue, the
divert cassette must be emptied and the divert count
must be reset.
1 Inaccurate count, LO side An unknown cash amount has been dispensed on the
LO side. This condition might occur during a motor
failure or divert cassette failure.
0 Hard fault, LO side If the hard fault bit is set, LO side dispensing should
stop. Possible causes are as follows:
• Maximum-bill-pick attempts on the LO-side
• Bill jam
• No forward motor cycle
• No reverse motor cycle
• Divert cassette failure
• Transport failure
• Maximum exit sensor failures on the LO-side
2 (HI de- 7-0 Amount of HI denomination bills If bit 1 of status byte 0 (inaccurate count) is not set, then
nomination this byte is the number of HI side bills dispensed.
Bills)
3 (LO de- 7-0 Amount of LO denomination bills If bit 1 of status byte 1 (inaccurate count) is not set, then
nomination this byte is the number of LO side bills dispensed.
Bills)
3 Divert Cassette not present (set when byte The divert cassette was not present during a divert.
5, bit 3 is set) Dispensing on the HI and LO-sides is stopped. The
divert cassette must be installed before another
dispense is initiated. When this condition occurs, bit 0
of status byte 0 and byte 1 are set.
5-30
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-8 Dispenser Solicited Status for 911 Mode (DID = ’8’) (continued)
2 Delivery door open before dispense (set There are bills in the escrow position when a dispense
when byte 5, bit 2 is set) operation is initiated. No bills are dispensed while there
are bills in escrow.
1 HI Bill sensor not blocked after dispense (set The cash dispensed on the HI side fails to block the bill
when byte 5, bit 1 is set) sensor. Possible causes are as follows:
• Bill trap
• HI sensor electrical failure
• HI-side delivery area jam
0 HI bill sensor blocked before dispense (set Material is sensed in the delivery area before a dispense
when byte 5, bit 0 is set) is initiated. Possible causes are as follows:
• Bill trap)
• HI sensor electrical failure
• Material left in HI-side delivery area
3 Divert Cassette not present (set when byte The divert cassette was not present during a divert.
4, bit 3 is set) Dispensing on the HI and LO-sides is stopped. The
divert cassette must be installed before another
dispense is initiated. When this condition occurs, bit 0
of status byte 0 and byte 1 are set.
2 Delivery door open before dispense (set There are bills in the escrow position when a dispense
when byte 4, bit 2 is set) operation is initiated. No bills are dispensed while there
are bills in escrow.
1 LO Bill sensor not blocked after dispense The money dispensed on the LO side fails to block the
(set when byte 4, bit 1 is set) bill sensor. Possible causes are as follows:
• Bill trap
• LO sensor electrical failure
• LO-side delivery area jam
0 LO bill sensor blocked before dispense (set Material is sensed in the delivery area before a dispense
when byte 4, bit 0 is set) is initiated. Possible causes are as follows:
• Bill trap
• LO sensor electrical failure
• Material left in LO-side delivery area
6 (Machine 7 LO side dispense stopped - HI divert This bit is set during a LO-side dispense when the
Fault Status cassette full HI-side divert count has gone one over its maximum
#1) limit. This situation occurs because an excess of
unrequested HI bills have been diverted. Dispensing is
now stopped on the LO-side because of the HI-side
fault condition. Until the divert cassette is emptied,
dispensing cannot continue. This condition also sets
the following bits:
• Bits 6, 3, 2 (status byte 6)
• Bit 2 (status byte 0 and 1)
6 HI side dispense stopped - LO divert This bit is set during a HI-side dispense when the
cassette full LO-side divert count has gone one over its maximum
limit. This situation occurs because an excess of
unrequested LO bills have been diverted. Dispensing
is now stopped on the HI-side because of the LO-side
fault condition. Until the divert cassette is emptied,
dispensing cannot continue. This condition also sets
the following bits:
• Bits 7, 3, 2 (status byte 6)
• Bit 2 (status byte 0 and 1)
5-31
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-8 Dispenser Solicited Status for 911 Mode (DID = ’8’) (continued)
5 LO-side dispense stopped - maximum pick This bit is set during a LO-side dispense when the
attempts on HI-side HI-side bill-pick-attempts count has gone one over
its maximum limit. This situation occurs because an
excess of unrequested HI bills have been picked.
Dispensing is stopped on the LO-side because of the
HI-side fault condition. Service assistance is needed to
correct this fault. This condition also sets the following
bits:
• Bit 1 (status byte 6)
• Bit 0 (status byte 0 and 1)
4 HI-side dispense stopped - maximum pick This bit is set during a HI-side dispense when the
attempts on LO-side LO-side bill-pick-attempts count has gone one over
its maximum limit. This situation occurs because an
excess of unrequested LO bills have been picked.
Dispensing is stopped on the HI-side because of the
LO-side fault condition. Service assistance is needed to
correct this fault. This condition also sets the following
bits:
• Bit 0 (status byte 6)
• Bit 0 (status byte 0 and 1)
3 HI Divert Cassette full The HI-side divert count has reached its maximum
diverts limit. Dispensing is stopped on the HI-side and
should not continue until the divert cassette is emptied.
This condition also sets bit 2 (status byte 0) and bits 0
and 2 (status byte 6).
2 LO Divert Cassette full The LO-side divert count has reached its maximum
diverts limit. Dispensing is stopped on the LO-side and
should not continue until the divert cassette is emptied.
This condition also sets bit 2 (status byte 1) and bits 1
and 3 (status byte 6).
1 HI maximum pick attempts A good bill has not been picked from the HI-side within a
specified number of consecutive attempts. Dispensing
stops on the HI-side and should not continue until the
HI-side cash cassette is checked for a probable cause
of the missed picks. If no loading problem is found, the
fault might require service help. This condition also sets
bit 0 (status byte 0).
0 LO maximum pick attempts A good bill has not been picked from the LO-side within
a specified number of consecutive attempts. Dispensing
stops on the LO-side and should not continue until the
LO-side cash cassette is checked for a probable cause
of the missed picks. If no loading problem is found, the
fault might require service help. This condition also sets
bit 0 (status byte 1).
5-32
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-8 Dispenser Solicited Status for 911 Mode (DID = ’8’) (continued)
5 HI maximum exit faults This bit is set under two possible conditions.
• The maximum unsuccessful consecutive attempts
to divert a bill on the HI-side occurs
4 LO maximum exit faults This bit is set under two possible conditions.
• The maximum unsuccessful consecutive attempts
to divert a bill on the LO-side occurs
3 Bill jam in transport This condition occurs during a divert when a bill jam
exists in the exit sensor area. Dispensing stops. This
condition must be cleared before initiating another
dispense. Clearing this fault is not easy and might
require service assistance. This condition also sets bit
0 (status bytes 0 and 1).
2 Bill jam in picker This condition occurs when a bill jam exists in the bill
thickness detect. Dispensing stops. This condition
must be cleared before initiating another dispense. Call
service if no jam is evident. This condition also sets bit
0 (status bytes 0 and 1).
1 No reverse machine cycle A bit is set if there is no indication that the bill dispenser
is running in the divert direction. Dispensing on both
sides stops, and should not continue until service clears
the fault. This condition also sets bit 0 (status byte 0
and 1).
0 No forward machine cycle A bit is set if there is no indication that the bill dispenser
is running in the dispense direction. Dispensing on both
sides stops, and should not continue until service clears
the fault. The cash amount delivered to the consumer is
unknown. This condition also sets bits 0 and 1 (status
byte 0 and 1).
5-33
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There are 40 bytes for Dispenser status in the 912 mode. Refer to Table 5-9 for
the byte definitions. Refer to Table 5-10 for the Dispenser error codes that can
be contained in bytes 1 and 2 of the Dispenser Solicited Status message. 911
mode Dispenser status information is in Section 5.2.5.
Table 5-9 Dispenser Solicited Status for 912 Mode (DID = ’?’)
0 Withdrawal Area Status This byte defines withdrawal area status as follows:
0 - No error
1 - Delivery door open before dispense (bills in escrow)
3 - Sensors blocked before dispense
5 - Sensors not blocked after dispense
1-2 Dispense error code The bill dispenser error codes for each dispense error are listed in Table
5-10. The error codes shown in Table 5-10 are listed as graphic characters.
However, all bytes in this table, Table 5-9, are in ASCII code.
4 Cassette Position This byte contains the position of the cassette from which the terminal
dispensed. The valid characters are as follows:
1 - First cassette position (top)
2 - Second cassette position
3 - Third cassette position
4 - Fourth cassette position (bottom)
6-7 Number of Bills Dispensed These two bytes contain two ASCII digits that equal the number of bills
dispensed. The valid characters are 0 through 30. byte 6 is the most
significant byte.
8-9 Number of Divert Operations These two bytes are reserved for service use only.
13 - 21 Dispenser Status for second cassette These bytes contain the dispenser status of the second cassette position.
position This information is in the format of bytes 4 through 12.
22 - 30 Dispenser Status for third cassette These bytes contain the dispenser status of the third cassette position.
position This information is in the format of bytes 4 through 12.
31 - 39 Dispenser Status for fourth cassette These bytes contain the dispenser status of the fourth cassette position.
position This information is in the format of bytes 4 through 12.
5-34
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5-9)
00 No error 0 No
35 Denomination error 4 No
41 Feed and single counted bills are not equal from cassette position 1 (top) 2 No
42 Feed and single counted bills are not equal from cassette position 2 2 No
43 Feed and single counted bills are not equal from cassette position 3 2 No
44 Feed and single counted bills are not equal from cassette position 4 2 No
(bottom)
49 Single and exit counted bills are not equal from cassette position 1 (top) 5 No
50 Single and exit counted bills are not equal from cassette position 2 5 No
51 Single and exit counted bills are not equal from cassette position 3 5 No
52 Single and exit counted bills are not equal from cassette position 4 5 No
(bottom)
5-35
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5-9)
65 Cassettes shuffled 4 No
82 Not used
93 Not used
5-36
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5.2.8 Withdrawal Door Status (solicited) for 911 Mode (DID = ’9’)
There is one byte for withdrawal door solicited status in 911 mode. The following
statuses are applicable for terminals with a presenter:
5.2.9 Withdrawal Door Status (solicited) for 912 Mode (DID = ’@’)
There is one byte for withdrawal door solicited status in 912 mode. The
following statuses are applicable for terminals with a presenter:
5-37
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5.2.10 Depository Status (solicited) for Envelope Depository, for 911 Mode (DID = ’:’)
Table 5-11 lists and defines the Depository status information for an envelope
depository, for terminals operating in 911 mode.
Table 5-11 Depository Solicited Status for Envelope Depository, for 911 Mode (DID = ’:’)
6 Detect switch blocked, do not continue An envelope or foreign material is stuck in the envelope
detect area. Further deposits should not be attempted until
the jam is cleared. If no envelope is jammed, then this bit
might also indicate a mechanism failure.
5 Printer error The printer that stamps the deposit envelope with a specific
serial number has not moved to the desired increment. Refer
to Status Byte 1 for more detailed information on the printer
module fault status. This fault requires service assistance.
4 Consumer timeout An envelope has not been deposited during the allotted time
period.
3 Deposit cassette not present A deposit cassette is not present. No deposit is attempted.
2 No reverse cycle or Depository not There is no indication that the Total Cash Control system
present motor is running in the deposit direction. The envelope might
or might not have been captured. This fault requires service
assistance. Until this condition is corrected, another deposit
should not be attempted.
1 Deposit cassette full, do not continue The deposit cassette is full. It must be emptied before the
next deposit can start. No deposit is attempted.
4 Consumer cancel If this bit is set, the consumer cancelled a deposit operation.
This bit is set in addition to the consumer timeout bit (Byte
0, bit 4). The deposit cancel status bit feature must be set
in Miscellaneous Features Field 1 of a Write Command 3
message for this bit to be set.
3 Thousands module error The deposit thousands-digit print module has not increased
to the desired number. This fault requires service assistance.
2 Hundreds module error The deposit hundreds-digit print module has not increased to
the desired number. This fault requires service assistance.
1 Tens module error The deposit tens-digit print module has not increased to the
desired number. This fault requires service assistance.
0 Units module error The deposit units-digit print module has not increased to the
desired number. This fault requires service assistance.
5-38
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5.2.11 Depository Status (solicited) for Envelope Depository, for 912 Mode (DID = ’A’)
Table 5-12 lists and defines the Depository status information for an envelope
depository, for terminals operating in the 912 mode.
Table 5-12 Depository Solicited Status for Envelope Depository, for 912 Mode (DID = ’A’)
6 Hard Fault If this bit is set, a depository fault has occured that requires
attention before another can be correctly processed. This
fault is normally caused by a stuck envelope in the envelope
entry slot or a missing deposit cassette. If this bit is set,
the terminal cannot complete the current deposit and future
deposits should not be attempted.
5 Printer error The printer that stamps the deposit envelope with a specific
serial number has not moved to the desired increment. Refer
to Status Byte 1 for more detailed information on the printer
module fault status. This fault requires service assistance.
4 Consumer timeout An envelope has not been deposited during the allotted time
period.
3 Deposit cassette not present A deposit cassette is not present. No deposit is attempted.
2 Deposit incomplete or Depository not If this bit is set, the terminal started receiving the envelope but
present the terminal never sensed the envelope entering the deposit
cassette. This is probably caused by either a depository fault
or by the consumer inserting then removing the envelope.
1 Deposit cassette full, do not continue The deposit cassette is full. It must be emptied before the next
deposit can start. No deposit is attempted.
0 Soft fault If this bit is set, a fault has occurred on the depository. This
fault is normally caused by a switch failure. If this bit is set,
the terminal completes the current deposit and allows future
deposits.
4 Consumer cancel If this bit is set, the consumer cancelled a deposit operation.
This bit is set in addition to the consumer timeout bit (Byte 0,
bit 4). The deposit cancel status bit feature must be set in
the Miscellaneous Features Field 1 of the Write Command 3
message for this bit to be set.
3 Thousands module error The deposit thousands-digit print module has not increased to
the desired number. This fault requires service assistance.
2 Hundreds module error The deposit hundreds-digit print module has not increased to
the desired number. This fault requires service assistance.
1 Tens module error The deposit tens-digit print module has not increased to the
desired number. This fault requires service assistance.
0 Units module error The deposit units-digit print module has not increased to the
desired number. This fault requires service assistance.
2 (exit path) 7-0 Sequence ID The program exit path at the time of the fault (for service use
only).
5-39
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5.2.12 Depository Status (solicited) for IDM, for 912 Mode (DID = ’A’)
Table 5-13 lists and defines the Depository status information for an IDM, for
terminals operating in the 912 mode.
Table 5-13 Depository Solicited Status for IDM, for 912 Mode (DID = ’A’)
6 Hard fault If this bit is set, a depository fault has occurred that requires
attention before another can be correctly processed. This
fault is normally caused by stuck media in the transport.
If this bit is set, the terminal was unable to complete the
current deposit.
4 Consumer timeout An envelope has not been deposited during the allotted
time period.
3 Initial condition fault A deposit cassette is not present, the rotating assembly
is unlatched, the printhead is missing, or check bins are
missing.
1 Deposit cassette full, do not The deposit cassette is full. It must be emptied before the
continue, or invalid check bin next deposit can start. No deposit is attempted. OR the
specified in a retain or capture specified bin is not present in IDM. No deposit is attempted.
operation Use another bin.
0 Soft fault If this bit is set, a fault has occurred on the depository. This
fault is normally caused by a switch failure. If this bit is
set, the terminal completes the current deposit and allows
future deposits.
1 (printer 7 MICR read fault If this bit is set, a MICR read fault was encountered. If
module fault any MICR data was found, it is available for inclusion in
status) a Consumer Request message, depending on the Send
Track 1, Track 3, and/or MICR Data entry in the Transaction
Request state.
4 Consumer cancel If this bit is set, the consumer cancelled a deposit operation.
This bit is set in addition to the consumer timeout bit (byte 0,
bit 4). The Deposit Cancel Status Bit feature must be set in
the Miscellaneous Features 1 field of the Write Command 3
message for this bit to be set.
2 7 Depository disabled The IDM has been disabled either due to a fault or by the
network.
5-40
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-13 Depository Solicited Status for IDM, for 912 Mode (DID = ’A’) (continued)
4 Document handling error The IDM has encountered one of the following problems
while trying to transport a check:
• Mechanism cannot lift the gate during a straighten
sequence
• Cannot position the shuttle during a straighten
sequence
• Document cannot reach the magnetic sensor
• Cannot straighten the document
• Document cannot position in the bottom hold area
• Document cannot position in the top hold area
3 Bin error The selected bin was unusable or was full. This status might
also indicate a possible jam.
2 Document size error Inserted document is too short, too long, or too thick.
1 Scanner error The scanner did not operate, indicating a scanner fault.
And so on.
5-41
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
0 and 1 Configuration ID Bytes 0 and 1 represent the four digit configuration ID number.
6 Supervisory action This bit is set if the terminal operator has initiated a supervisory
activity.
5 Supply action This bit is set if the terminal operator has initiated a
supply-related activity.
0 Go In-service flag This bit is set if the terminal is not in the In-service mode, but
has received a Startup command. Otherwise, the terminal is in
the In-service, Out-of-service, or Maintenance mode, but has
not received a Startup command.
5-42
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
The number of bytes of cassette solicited status is variable. This status is sent
along with the Configuration ID status when the network requests configuration
information. Refer to Table 5-15 for the detailed bit definitions.
0-1 All First cassette The valid characters for the status of the first cassette position (top) are as follows where B0 and B1
position (top) are byte 0 and byte 1, respectively:
status
B0 B1 B0 B1 B0 B1 B0 B1 B0 B1
2-3 All Second cassette Bytes 2 and 3 contain the status of the second cassette position. Refer to bytes 0 and 1 for the valid
position status characters.
4-5 All Third cassette Bytes 4 and 5 contain the status of the third cassette position. Refer to bytes 0 and 1 for the valid
position status characters.
6-7 All Fourth cassette Bytes 6 and 7 contain the status of the fourth cassette position (bottom). Refer to bytes 0 and 1 for the
position (bottom) valid characters.
status
5-43
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-16 Check Point Status Bytes (912 Mode) (DID = ’C’)
0-7 Function identifiers Status bytes 0 to 7 contain the function identifiers that the terminal received in the
last Function Command message. Byte 0 contains the first function identifier in the
Function Command message, byte 1 contains the second function identifier, and so
on. These function identifiers appear in a different format than as a function ID. A cross
reference is shown in Table 5-17. All unused bytes contain ’0’. When the terminal
sends a Consumer Request message, bytes 0 through 7 are set to ’0’.
8 Last device ID Status byte 8 contains the device identifier (status ID) of the last device that the
terminal started to operate. The device identifiers shown in this message appear in a
slightly different format than the standard device identifiers. After all the devices finish
operating, the terminal sets this byte to ’0’. The valid values are as follows (standard
device identifier is shown in parentheses):
; = ( ’ = ’ ) - Card reader
; ? ( ’ ? ’ ) - Bill dispenser
9 Last message coordination Status byte 9 contains the message coordination number that the network put in the
number last Function Command message.
Check Point Status 912 Function ID Check Point Status 912 Function ID
; 5 ’5’ = 0 ’P’
; 6 ’6’ = 1 ’Q’
5-44
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Check Point Status 912 Function ID Check Point Status 912 Function ID
5-45
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There are 20 bytes for coin dispenser solicited status in 912 mode. All bytes of
this status contain character data rather than bitmap data. Refer to Table 5-18 for
the byte definitions. Refer to Table 5-19 for the coin dispenser error codes in
bytes 1 and 2 of the coin dispenser solicited status.
Table 5-18 Coin Dispenser Solicited Status for 912 Mode (DID = ’G’)
0 Coin dispenser docked The following values are defined for this byte:
• 0 - Coin dispenser docked
• 1 - Coin dispenser not docked
1-2 Dispense error code These bytes contain two hexadecimal digits. Refer to Table 5-19 for a list
of the dispense error codes.
3 Partial dispense status This byte defines coin dispense status. The valid values are as follows:
• 0 - Good dispense. The number of coins dispensed equals the number
of coins requested.
• 1 - Not applicable
• 2 - Bad dispense. Continuation is not possible. Some coins might
be in the slot.
• 3 - Dispense is not possible. No coins were dispensed.
• 4 - Denomination error. Try again after remix. No coins were
dispensed.
• 5 - Good partial dispense. Continuation is possible. The number of
coins dispensed is not the number of coins requested. Possibly out
of coins.
4 Bin position This byte specifies the bin position associated with the next three bytes of
data. Valid values are 1 (front bin) through 4 (back bin).
5 Denomination ID This byte identifies the coin denomination associated with the bin specified
in the preceding Bin Position byte. The valid values are as follows:
• A through H - Type of coin
• a through h - Type of coin, supply low or empty
• J - Denomination ID cannot be read
• @ - No bin present or no feed module present
6-7 Number of coins dispensed These two bytes contain two decimal digits that indicate the number of
coins dispensed from the bin specified in the preceding Bin Position byte.
The valid values are 00 through 30.
8 - 11 Dispense status for position 2 These bytes contain the dispense status for bin position 2. This information
is in the format of bytes 4 through 7.
12 - 15 Dispense status for position 3 These bytes contain the dispense status for bin position 3. This information
is in the format of bytes 4 through 7.
16 - 19 Dispense status for position 4 These bytes contain the dispense status for bin position 4. This information
is in the format of bytes 4 through 7.
5-46
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
00 No error 0, 5 No
35 Denomination error 4 No
5-47
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
To obtain supply counts from the terminal, the network can send Agilis 91x for
ix/CSP an appropriate Operational Command message. The format and content
of supply count data depends on the command code used in the Operational
Command message. The following command codes can be used to request
supply counts from the terminal:
Refer to Section 5.7 and Section 5.8 for details on Operational Command
messages.
In Table 5-20 and Table 5-21, all the data fields are optional. If a device is not
present in the terminal or is not enabled, Agilis 91x for ix/CSP does not send
the corresponding data. Only the corresponding group separator that precedes
the data group is required. Also, if a device is present, but the device lacks one
or more of the capabilities described for supply count statuses, Agilis 91x for
ix/CSP omits the fields corresponding to those capabilities.
5 Total Deposits These bytes contain the total number of deposits since the last time
the counters were cleared. The range is 00000 through 65535.
4 CR01 Indicates that the counts to follow are from the card reader.
5 Total cards retained These bytes contain the total number of cards retained since the last
time the counters were cleared. The range is 00000 through 65535.
4 DI01 Indicates that the counts to follow are from the bill dispenser.
1 Denomination ID position 1 This byte indicates the denomination ID of the cassette in position
1.The valid range is A through H.
1 Denomination ID position 2 This byte indicates the denomination ID of the cassette in position
2.The valid range is A through H.
1 Denomination ID position 3 This byte indicates the denomination ID of the cassette in position
3.The valid range is A through H.
1 Denomination ID position 4 This byte indicates the denomination ID of the cassette in position
4. The valid range is A through H.
5 Total number of divert operations These bytes contain the total number of divert operations since the
last time the diverted bill counter was cleared. The range is 00000
through 65535.
5-48
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5 Total bills dispensed - cassette position 1 These bytes contain the number of bills dispensed to the stacking
(top) position (excludes bills sent to the divert cassette) from cassette
position 1 (top) since the last time the counter was cleared. The
range is 00000 through 65535.
5 Total bills dispensed - cassette position 2 These bytes contain the number of bills dispensed to the stacking
position (excludes bills sent to the divert cassette) from cassette
position 2 since the last time the counter was cleared. The range
is 00000 through 65535.
5 Total bills dispensed - cassette position 3 These bytes contain the number of bills dispensed to the stacking
position (excludes bills sent to the divert cassette) from cassette
position 3 since the last time the counter was cleared. The range
is 00000 through 65535.
5 Total bills dispensed - cassette position 4 These bytes contain the number of bills dispensed to the stacking
(bottom) position (excludes bills sent to the divert cassette) from cassette
position 4 (bottom) since the last time the counter was cleared. The
range is 00000 through 65535.
5 Total number of retain operations These bytes contain the total number of retain operations since
the last time the retain counter was cleared. The range is 00000
through 65535.
5-49
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5 Envelope Count These bytes contain the total number of envelope deposits since
the last time the counters were cleared. The range is 00000
through 65535.
5 [1] Check Bin 1 Count These bytes contain the total number of checks or other
documents placed in deposit bin 1 since the last time the counters
were cleared. The range is 00000 through 65535.
5 [1] Check Bin 2 Count These bytes contain the total number of checks or other
documents placed in deposit bin 2 since the last time the counters
were cleared. The range is 00000 through 65535.
5 [1] Check Bin 3 Count These bytes contain the total number of checks or other
documents placed in deposit bin 3 since the last time the counters
were cleared. The range is 00000 through 65535.
5 [1] Check Bin 4 Count These bytes contain the total number of checks or other
documents placed in deposit bin 4 since the last time the counters
were cleared. The range is 00000 through 65535.
4 CR01 Indicates that the counts to follow are from the card reader.
5 Total cards retained These bytes contain the total number of cards retained since the
last time the counters were cleared. The range is 00000 through
65535.
4 DI01 Indicates that the counts to follow are from the bill dispenser.
1 Denomination ID position 1 This byte indicates the denomination ID of the cassette in position
1. The valid range is A through H.
1 Denomination ID position 2 This byte indicates the denomination ID of the cassette in position
2. The valid range is A through H.
1 Denomination ID position 3 This byte indicates the denomination ID of the cassette in position
3. The valid range is A through H.
1 Denomination ID position 4 This byte indicates the denomination ID of the cassette in position
4. The valid range is A through H.
5 Loaded Count position 1 These bytes indicate the number of bills loaded in the cassette in
position 1. The valid range is 00000 through 65535.
5 Loaded Count position 2 These bytes indicate the number of bills loaded in the cassette in
position 2. The valid range is 00000 through 65535.
5 Loaded Count position 3 These bytes indicate the number of bills loaded in the cassette in
position 3. The valid range is 00000 through 65535.
5 Loaded Count position 4 These bytes indicate the number of bills loaded in the cassette in
position 4. The valid range is 00000 through 65535.
5-50
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-21 Enhanced Supply Counts Solicited Status (DID = ’H’) (continued)
5 Total bills dispensed - cassette position 1 These bytes contain the number of bills dispensed to the stacking
(top) position (excludes bills sent to the divert cassette) from cassette
position 1 (top) since the last time the counter was cleared. The
range is 00000 through 65535.
5 Total bills dispensed - cassette position 2 These bytes contain the number of bills dispensed to the stacking
position (excludes bills sent to the divert cassette) from cassette
position 2 since the last time the counter was cleared. The range
is 00000 through 65535.
5 Total bills dispensed - cassette position 3 These bytes contain the number of bills dispensed to the stacking
position (excludes bills sent to the divert cassette) from cassette
position 3 since the last time the counter was cleared. The range
is 00000 through 65535.
5 Total bills dispensed - cassette position 4 These bytes contain the number of bills dispensed to the stacking
(bottom) position (excludes bills sent to the divert cassette) from cassette
position 4 (bottom) since the last time the counter was cleared.
The range is 00000 through 65535.
5 Divert1 Count position 1 These bytes contain the number of bills known to be either
dumped or diverted from position 1 during a consumer transaction
due to mispick or recovery attempt since the last time the counter
was cleared. The range is 00000 through 65535.
5 Divert1 Count position 2 These bytes contain the number of bills known to be either
dumped or diverted from position 2 during a consumer transaction
due to mispick or recovery attempt since the last time the counter
was cleared. The range is 00000 through 65535.
5 Divert1 Count position 3 These bytes contain the number of bills known to be either
dumped or diverted from position 3 during a consumer transaction
due to mispick or recovery attempt since the last time the counter
was cleared. The range is 00000 through 65535.
5 Divert1 Count position 4 These bytes contain the number of bills known to be either
dumped or diverted from position 4 during a consumer transaction
due to mispick or recovery attempt since the last time the counter
was cleared. The range is 00000 through 65535.
5 Divert2 Count position 1 These bytes contain the number of bills known to be either
dumped or diverted from position 1 during maintenance or as a
result of a network-commanded retain since the last time the
counter was cleared. The range is 00000 through 65535.
5 Divert2 Count position 2 These bytes contain the number of bills known to be either
dumped or diverted from position 2 during maintenance or as a
result of a network-commanded retain since the last time the
counter was cleared. The range is 00000 through 65535.
5 Divert2 Count position 3 These bytes contain the number of bills known to be either
dumped or diverted from position 3 during maintenance or as a
result of a network-commanded retain since the last time the
counter was cleared. The range is 00000 through 65535.
5 Divert2 Count position 4 These bytes contain the number of bills known to be either
dumped or diverted from position 4 during maintenance or as a
result of a network-commanded retain since the last time the
counter was cleared. The range is 00000 through 65535.
[1] These field are present only for terminals equipped with an IDM.
5-51
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-21 Enhanced Supply Counts Solicited Status (DID = ’H’) (continued)
5 Retract Count position 1 These bytes contain the number of bills from position 1 that were
accessible to the consumer but might not have been taken, and
something was retracted and dumped since the last time the
counter was cleared. The range is 00000 through 65535.
5 Retract Count position 2 These bytes contain the number of bills from position 2 that were
accesable to the consumer but might not have been taken, and
something was retracted and dumped since the last time the
counter was cleared. The range is 00000 through 65535.
5 Retract Count position 3 These bytes contain the number of bills from position 3 that were
accessible to the consumer but might not have been taken, and
something was retracted and dumped since the last time the
counter was cleared. The range is 00000 through 65535.
5 Retract Count position 4 These bytes contain the number of bills from position 4 that were
accessible to the consumer but might not have been taken, and
something was retracted and dumped since the last time the
counter was cleared. The range is 00000 through 65535.
4 CN01 Indicates that the counts to follow are from the coin dispenser.
1 Denomination ID, Position 1 This byte indicates the denomination ID of the coin bin in position
1. The valid range is A through H.
1 Denomination ID, Position 2 This byte indicates the denomination ID of the coin bin in position
2. The valid range is A through H.
1 Denomination ID, Position 3 This byte indicates the denomination ID of the coin bin in position
3. The valid range is A through H.
1 Denomination ID, Position 4 This byte indicates the denomination ID of the coin bin in position
4. The valid range is A through H.
5 Loaded Count, Position 1 These bytes indicate the number of coins loaded in the bin in
position 1. The valid range is 00000 through 65535.
5 Loaded Count, Position 2 These bytes indicate the number of coins loaded in the bin in
position 2. The valid range is 00000 through 65535.
5 Loaded Count, Position 3 These bytes indicate the number of coins loaded in the bin in
position 3. The valid range is 00000 through 65535.
5 Loaded Count, Position 4 These bytes indicate the number of coins loaded in the bin in
position 4. The valid range is 00000 through 65535.
5 Total Coins Dispensed, Position 1 These bytes contain the number of coins dispensed to the delivery
slot from the bin in position 1 since the last time the counter was
cleared. The range is 00000 through 65535.
5 Total Coins Dispensed, Position 2 These bytes contain the number of coins dispensed to the delivery
slot from the bin in position 2 since the last time the counter was
cleared. The range is 00000 through 65535.
[1] These field are present only for terminals equipped with an IDM.
5-52
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-21 Enhanced Supply Counts Solicited Status (DID = ’H’) (continued)
5 Total Coins Dispensed, Position 3 These bytes contain the number of coins dispensed to the delivery
slot from the bin in position 3 since the last time the counter was
cleared. The range is 00000 through 65535.
5 Total Coins Dispensed, Position 4 These bytes contain the number of coins dispensed to the delivery
slot from the bin in position 4 since the last time the counter was
cleared. The range is 00000 through 65535.
4 AH01 Indicates that the counts to follow are from the After Hour
depository (AHD).
5 Deposit Count These bytes contain the total number of AHD deposits since the
last time the counter was cleared. The range is 00000 through
65535.
NOTE
All the counts preceding this note appear in the order shown in this table. Any counts following this note can appear
in any order. It is important for you to examine the Device ID field to determine which count fields are being reported.
4 SD01 Indicates that the counts to follow are from the envelope dispenser.
1 Denomination Code This byte contains the denomination code. The valid range is A
through B.
5 Loaded Count These bytes indicate the number of envelopes loaded since the
last time the counter was cleared. The valid range is 00000
through 65535.
5 Total envelopes dispensed These bytes contain the number of envelopes dispensed since
the last time the counter was cleared. The range is 00000 through
65535.
[1] These field are present only for terminals equipped with an IDM.
There is one byte for External Options Module solicited status. The following
statuses can occur:
5-53
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Agilis 91x for ix/CSP reports enhanced status for the following devices:
• Keypad
• Encryption/decryption device
• Envelope dispenser
• Lead-through indicators
• Passbook printer
NOTE
• Statement printer
• Touch screen (not applicable on the CashSource Plus 400)
• Device ID. This is the four-character device identifier of the device that sent
the status. For solicited statuses, the following device IDs are valid:
NOTE
• Fault Status. This status is the MDS-type fault status data. MDS-type status
data is a series of three-character fields, each field consisting of a colon
character ( : ), followed by two hexadecimal digits.
Status Descriptor J
Device ID SP01
The operation sequence number 002 indicates that the fault was caused by the
second operation in the Function Command message.
5-54
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
For details on the actual status definitions, refer to the Agilis 91x for ix/CSP and
91x for CSP Status Reference Manual (TP-821028-001A).
5-55
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
There are other specific Solicited Status messages that can be sent to the
network. If the network sends an Operational Command message requesting the
terminal to send configuration information, the terminal sends configuration ID
status, hardware configuration status, check point status, and cassette status in
one Solicited Status message. The following paragraphs describe the hardware
configuration status.
0 7-0 Terminal type (01 for 911 mode, 02 for 912 mode (international), 03 for 912 mode (domestic))
1 7 Reserved (always 0)
4 Reserved (always 0)
2 Reserved (always 0)
1 Reserved (always 0)
0 Reserved (always 1)
2 7 Reserved (always 0)
6 Reserved (always 0)
1 Reserved (always 1)
5-56
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
1 Reserved
6 Reserved (always 1)
5 Reserved (always 0)
4 Reserved (always 0)
3 Receipt printer paper selection (0, paper with top-of-form mark, 1, blank paper)
0 i Series/MDS or Agilis 91x for ix/CSP terminal operating in 911 or 912 mode (always 1)
9 7-0 Receipt printer column width (maximum characters per line) in hex
10 Bill denominations present in terminal (C and D are the only valid denomination IDs for 911 mode):
7 Denomination ID H
6 Denomination ID G
5 Denomination ID F
4 Denomination ID E
3 Denomination ID D
2 Denomination ID C
5-57
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
1 Denomination ID B
0 Denomination ID A
11 7 Check depository
6 Coin dispenser
3 Reserved (always 0)
2 Reserved (always 0)
1 Reserved (always 0)
14 7 Reserved (always 0)
0 Presenter (always 1)
15 7-0 Terminal Model Number - contains the last three digits of the terminal model number (in hex), for
example, for the 1072 it contains 48H (072 decimal).
5-58
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
16 Coin denominations present in the terminal (912 mode only; always 00 for 911 mode)
7 Denomination ID H
6 Denomination ID G
5 Denomination ID F
4 Denomination ID E
3 Denomination ID D
2 Denomination ID C
1 Denomination ID B
0 Denomination ID A
18 7 Reserved
5 Reserved
20 - 21 7-0 Bytes 20 and 21 contain the bill limit entry as set at the terminal. Byte 20 is the low byte and 21 is the
high byte. The bill limit entry is a four-character number expressed in hex. For example, a bill limit entry
of 50 bills is expressed as 3200, with byte 20 being 32 and 21 being 00.
The devices that have status reported this way are as follows:
NOTE
5-59
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
This data is in a slightly different format from the other hardware configuration
status. The format of this data is as follows:
Device ID 4 bytes
Configuration information Variable bytes (not all devices use these bytes)
Presently, the only devices that require the configuration information bytes
are as follows:
5-60
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
x Media Type:
• A - Envelopes
• B - Reserved
y Automatic Mode definitions:
• 0 - Automatic dispensing mode enabled, send status to network disabled
• 1 - Reserved
• 2 - Automatic dispensing mode enabled, send status to network enabled
• 3 - Reserved
• Receipt printer. Agilis 91x for ix/CSP sends a large amount of configuration
information as part of the record (Table 5-25).
5-61
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
The following paragraphs describe the fields in the Receipt Printer Hardware
Configuration message.
5-62
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
NOTE
The unit separator (hex 1F) is the default separator used in the
Hardware Configuration status data for the receipt printer.
However, certain host protocols have a problem seeing this
character in a message. Therefore, some systems might use
some other character separator in place of the unit separator.
This substitute separator would be defined during Agilis
91x for ix/CSP installation.
Printer Device ID
Field Size: 4 characters
Valid Range: PR01
Description: This is the device ID for the receipt printer.
Printer Vendor
Field Size: Variable
Valid Range: Variable
Description: This is the vendor name of the hardware receipt printer device.
5-63
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-26 Agilis 91x for ix/CSP Printer Character Set Codes
003 Greek
004 Portuguese
005 Cyrillic/Latvian
006 Hungarian/Latin
007 Turkish
008 Hebrew
009 Arabic
010 Lithuanian
011 Custom 1
012 Custom 2
5-64
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5-65
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Table 5-27 Example Hardware Configuration Data for Diebold 48-column Thermal Receipt Printer
5-66
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
The following paragraphs describe the fields in the Statement Printer Hardware
Configuration message.
Printer Device ID
Field Size: 4 characters
Valid Range: SP01
Description: This is the device ID for the statement printer.
Printer Vendor
Field Size: 7 characters
Valid Range: DIEBOLD
Description: This is the vendor name of the hardware statement printer device.
5-67
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Description: This field lists the statement printer’s AMI version, driver version,
main firmware version, and boot firmware version, separated by line feeds
(hex 0A).
5-68
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
The specific message reject code system involves changing the format of the
Solicited Status message sent to the network when a message from the network
to the ATM is rejected. The operation of this feature is network-selectable via a
Write Command 3 message, or by the following configuration setting:
The format of the message is shown in Table 5-29. The shaded areas are the
portions of the message format that are not different than the standard Solicited
Status message.
Solicited Status 2 1
Status Descriptor D 1
The following paragraphs describe the fields different from the standard
Solicited Status message.
5-69
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Status Descriptor
When the specific message reject code system is being used, this field contains a
graphic ’D’ rather than a graphic ’A’ in the event of a message reject.
5-70
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Description: This is a two-byte ASCII field used to indicate the reason that the
message from the network was rejected by the ATM. The definitions of the
Reject Reason Codes are shown in Table 5-30.
NOTE
Code Reason
00 No error
01 Unidentified message command ID. The message was not type 1 (Operational Command message), type 3
(Write Command message), type 4 (Function Command message), type 5 (Enhanced Operational Command
message), or type 6 (Enhanced Write Command message) or if there is no application present to process the
command (type 5 or 6 only).
02 Data from this message cannot be stored due to insufficient user memory in the ATM.
03 Conversion failure of a three-character field entry into an acceptable binary count. (No range checking is done).
04 Conversion failure of a two-character field entry into an acceptable binary count. (No range checking is done).
05 Conversion failure of hexadecimal data of the format :xx into an acceptable binary count. (No range checking is
done).
07 Language bank number is outside valid range (0 through 255). This number is part of the ESC L control sequence
immediately after the screen number.
09 Reserved
11 The ATM is busy (in use), and the Operational Command message cannot be processed.
13 Reserved
16 Reserved
17 The modifier field is out of range, the new key data field contains an incorrect number of entries, or a new key data
field entry exceeds 255.
18 This is an inappropriate request for key change. A non-existent key is needed for this request.
20 - 21 Reserved
5-71
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Code Reason
22 The message contained illegal oriental screen data. (Write Command 11 only).
24 Reserved
25 There are not eight three-character numeric entries in a state table data field.
26 - 29 Reserved
34 - 39 Reserved
41 - 44 Reserved
45 There were less than six characters in the active key buffer field.
46 At least one (possibly two) field separators are missing following the active key buffer field.
48 - 49 Reserved
55 A field separator character was not found after the function ID (and screen number and data fields which optionally
follow the function ID).
56 The one-character message coordination field did not match the one sent by the ATM in the Consumer Request
message.
5-72
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
Code Reason
GENERAL CASES
61 The terminal is in a mode during which the message cannot be received. For example, Function Command
message sent during a consumer session but not in a Transaction Request state, Write Command message sent
while in service without special configuration setting, and so on.
62 The terminal can currently accept only certain function commands (usually a print immediate), but not the type
just sent.
63 - 67 Reserved
68 - 79 Reserved
GENERAL CASES
84 - 98 Reserved
99 The message has an error not covered by one of the preceding codes.
22\#L\\D\11x10
A configuration state table message is rejected because there are less than eight
numeric entries in a state table after the letter that specifies the state type. A reject
code of 25 is generated, and the following reject message is sent by the ATM:
22\#L\\D\31225
where #L = LUNO.
22\#L\\D\41x53
If the reject reason code system is not being used, then each of these reject cases
results in the following message being sent by the ATM:
22\#L\\A
5-73
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
where #L = LUNO.
NOTE
Function Identifiers
Field Size: 8 characters
Valid Range: Refer to the description
Description: The Function Identifiers field contains the function identifiers that
the terminal received in the last Function Command message before the Cancel
key was pressed. Byte 0 contains the first function identifier in the Function
Command message, byte 1 contains the second function identifier, and so on.
These function identifiers appear in a different format than as a function ID. A
cross reference is shown below. All unused bytes contain ’0’ (;0).
Check Point Status 912 Function ID Check Point Status 912 Function ID
; 5 ’5’ = 0 ’P’
; 6 ’6’ = 1 ’Q’
Last Device ID
Field Size: 1 character
Valid Range: Refer to the description
Description: The Last device ID field contains the device identifier (status ID) of
the last device that the terminal started to operate. The device identifiers shown
in this message appear in a slightly different format than the standard device
identifiers. After all the devices finish operating, the terminal sets this byte to
’0’. The valid values are as follows (standard device identifier is shown in
parentheses):
5-74
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Solicited Status Messages
• ; ? ( ’ ? ’ ) - Bill dispenser
• < 0 ( ’@’ ) - Presenter
• < 1 ( ’A’ ) - Depository (envelope depository or IDM)
• < 7 ( ’G’ ) - Coin dispenser
5-75
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Solicited/Unsolicited ID 1 1
Message Identifier 2 1
Status Source - - - 1
Status - - - Variable
The following paragraphs describe the fields in the Unsolicited Status message.
5-76
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Solicited/Unsolicited ID
Field Size: 1 character
Valid Range: 1 and 2
Description: This field tells the network whether the message is solicited or
unsolicited. The valid entries for this field are as follows:
• 1 - Unsolicited message
• 2 - Solicited message
Message Identifier
Field Size: 1 character
Valid Range: 2
Description: This one-character data field defines the type of message being
transmitted. The only valid value for the Unsolicited Status message is 2.
Status Source
Field Size: 1 character
Valid Range: Refer to the description
Description: This one-character field describes the source of the status change
as follows:
• ’4’ - Printers
5-77
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
• ’?’ - Dispenser (912 mode) (if the following configuration option is set:
Transaction Host, Message Settings, Command Message, Function ID ’D’)
• ’J’ - Enhanced status. This indicates that this message contains status for one
of the enhanced status devices. Refer to Section 5.3.12 for further details.
Status
Field Size: Variable
Valid Range: Refer to the description
Description: This field elaborates on the cause of the status change in direct
association with the Status Source field. Data length is variable. For details of
this field, refer to Section 5.3.1 through Section 5.3.12.
MDS Status
Field Size:
Valid Range:
Description: If the MDS Status to Network feature is selected in the
Miscellaneous Features 2 field of the Write Command 3 message, this field
contains the MDS status for this status message. The data in this field is the same
data that the terminal prints on the journal printer and is in the same format.
Refer to the Agilis 91x for ix Status Reference Manual (TP-820589-001E) for a
description of the data printed on the journal printer.
When the Maintenance Mode Log to Network feature is selected, the terminal
generates an Unsolicited Status message for operator logon and various menu
selections. The message includes the Supervisory and Supply Actions status
source code and status byte, plus the Maintenance Mode Log field.
The Maintenance Mode Log field contains one or more log entries. Each log
entry is a decimal number made up of a three-digit operator code followed by a
three-digit menu selection code (Table 5-32).
5-78
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Operator Code Group and Operator Menu Code Menu Item Selected
008 Reserved
009 Reserved
012 Reserved
014 Reserved
040 Reserved
046 Reserved
[1] The terminal sends an operator code of 000 when Maintenance mode logon is initiated. At this point the operator still has to
enter a password. Therefore, no operator can be identified.
[2] The Continuous Availability feature is applicable only to terminals equipped with the optional Agilis Supply Manager.
When the terminal is online, it sends each log entry to the network as soon as
the operator performs the action that generates the entry. In this case, each
Unsolicited Status message contains one log entry only. Refer to Example 1.
If the terminal is offline during operator activity, the terminal stores up to six
log entries for transmission to the network. When communication is restored,
the terminal sends a message that contains the current Supervisory and Supply
Actions status, followed by the most recent log entry, the next most recent entry,
and so on. The group separator character (hexadecimal 1D) separates the log
entries. Refer to Example 2.
When the Maintenance Mode Log to Network feature is selected, the terminal
reports Supervisory and Supply Actions status for Maintenance mode logon and
selection of the Supply command regardless of the settings of the Send Status at
Logon option and the Send Supervisory Status at Logon option.
5-79
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
EXAMPLE 1
Assume that the terminal is online when the operator performs the procedure in
Table 5-33. For each step, the terminal reports a Supervisory and Supply Actions
status with the status byte and the Maintenance mode log entry indicated.
The operator selects Status List from the Maintenance menu. 20 001 006
The operator views the list of statuses, then returns to the Maintenance menu. no message
The operator logs off (selects the Exit menu item). 00 001 011
Notice that the operator code for logon is 000. The terminal sends the message
when the operator initiates Maintenance mode logon (before the operator enters a
password). At that time, the terminal has not yet identified the operator.
EXAMPLE 2
Assume that the terminal is offline when the operator performs the procedure in
Table 5-33. When communication is restored, the terminal sends an Unsolicited
Status message that includes a Supervisory and Supply Actions status byte of
00 and, in the Maintenance Mode Log field, three log entries separated by
group separators (GS) as follows:
Buffers to Follow ID
Field Size: 1 character
Valid Range: 9
Description: The Buffers to Follow ID entry is a field ID indicating that the
following message fields (Buffer ID and Buffer Data) contain buffer data from
an Agilis 91x for ix/CSP buffer. If the terminal sends buffer data from more
than one buffer, the message contains a pair of Buffer ID and Buffer Data
fields for each buffer.
This set of message fields is used for the Remote Key Transport feature. For
detailed information about this feature, refer to the Data Security Procedures and
Reference Manual (TP-799530-001D).
Buffer ID
Field Size: 3 characters
Valid Range: 064 through 090, and 256 through 355
Description: The Buffer ID entry is a Group ID that identifies a buffer.
Buffer Data
Field Size: Variable
Valid Range: For each character, 0 through 9, A through Z, a through z, + / and =
Description: The Buffer Data entry contains the data stored in the buffer
identified in the Buffer ID entry preceding this entry.
5-80
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
NOTE
5-81
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
This section contains tables for the unsolicited status of the following devices:
There is one byte for alarm unsolicited status. Refer to Table 5-34 for detailed
bit definition of this byte.
2 Anti-ambush activated The operator triggered an alarm while opening the safe.
Appropriate measures should be taken.
1 Chest door open The safe door is open. This is a normal indication during
supply replenishment.
5-82
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
There is one byte for Supervisory and Supply Actions status. Refer to Table 5-35
for detailed bit definition of this byte.
Table 5-35 Supervisory and Supply Actions Status Byte (SSF = ’3’)
6 Supervisory action This bit is set if the terminal operator has initiated a supervisory activity.
Otherwise, it is off.
5 Supply action This bit is set if the terminal operator has initiated a supply-related activity.
Otherwise, it is off.
5 Supply selected
Terminals with Send Status at Logon option 6 Send Attention Message selected
Terminals with Send Status at Logon optionand Send 6 Maintenance mode logon
Supervisory Status at Logon option
5 Supply selected
[1] Bits 0 through 4 and bit 7 of the status byte are reserved.
The first time an operator performs one of the Maintenance mode operations
(logging on, selecting Send Attention Message, or selecting Supply), the terminal
sends an Unsolicited Status message with the applicable bit set. If the operator
performs a second (but different) Maintenance mode operation, the terminal
sends an Unsolicited Status message with both bits set.
5-83
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Agilis 91x for ix/CSP clears bits 5 and 6 of the status byte only when the operator
logs off (selects the Exit menu item). If only one status bit was set during
Maintenance mode operation, then during logoff, the terminal sends a single
message with both status bits cleared.
Normally, if both status bits were set during Maintenance mode operation,
then during logoff, the terminal first sends an Unsolicited Status message
with bit 6 cleared and bit 5 set. Then the terminal sends a message with both
status bits cleared.
NOTE
EXAMPLE 1
Assume that the terminal is configured with neither the Send Status at Logon
option nor the Send Supervisory Status at Logon option. When the operator
performs the procedures in Table 5-37, the terminal reports a Supervisory and
Supply Actions status with the status byte indicated for each step.
When neither option is selected, logging on has no effect on the bits of the
Supervisory and Supply Actions status byte. When an operator logs on, the
terminal does not send a message to the network.
Table 5-37 Supervisory and Supply Actions Example (with no options selected)
3. The operator makes any selections other than Send Attention Message and Exit no message
(logoff).
2. The operator makes any selections other than Supply, Send Attention Message, no message
and Exit (logoff).
[1] If the Send Supervisory Status at Logoff option is selected, the terminal sends a 40 status byte (first message) instead of a 20
status byte at Step 5 of the last procedure in this table.
5-84
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Table 5-37 Supervisory and Supply Actions Example (with no options selected) (continued)
3. The operator makes any selections other than Send Attention Message and Exit no message
(logoff).
EXAMPLE 2
Assume that the terminal is configured with the Send Status at Logon option, but
not the Send Supervisory Status at Logon option. When the operator performs
the procedures in Table 5-38, the terminal reports a Supervisory and Supply
Actions status with the status byte indicated for each step.
When only the Send Status at Logon option is selected, the Supply command has
no effect on the bits of the Supervisory and Supply Actions status byte. If the
operator selects Supply, the terminal does not send a message to the network.
Table 5-38 Supervisory and Supply Actions Example (with Send Status at Logon option selected)
2. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
2. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
EXAMPLE 3
Assume that the terminal is configured with both the Send Status at Logon option
and the Send Supervisory Status at Logon option. When the operator performs
the procedures in Table 5-39, the terminal reports a Supervisory and Supply
Actions status with the status byte indicated for each step.
5-85
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
When both the options are selected, the Send Attention Message command has
no effect on the bits of the Supervisory and Supply Actions status byte. If the
operator selects Send Attention Message, the terminal does not send a message
to the network.
Table 5-39 Supervisory and Supply Actions Example (with Send Status at Logon and Send
Supervisory Status at Logon options selected)
2. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
3. The operator makes any selections other than Exit (logoff). no message
NOTE
The following table shows the sequence of Unsolicited Status messages that are
sent to the network in Continuous Availability for a Send Attention Message
selection. The items in parentheses describe the messages that are sent when
Send Attention Message is selected. These items represent what is to be sent
for maintenance logon, followed by selection of Send Attention Message,
followed by maintenance logoff.
The 300s before and after the messages in parentheses are sent if the Maintenance
Mode Log to Network option is selected. These 300s represent the Unsolicited
Status messages sent to the network upon entrance to Continuous Availability
and exit from Continuous Availability.
5-86
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Table 5-40 shows how the setting of these options determines which statuses are
sent to the network.
Send Status at Send Supervisory Send Supervisory Maintenance Statuses Sent for Attention
Logon [1] Status at Logon [1] Status at Logoff [1] Mode Log to Message
Network [1]
(340 300)
X (340 300)
X X (340 300)
X X X (340 300)
An example of the messages sequence for the last case in Table 5-40 is shown
below:
5-87
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
5-88
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
For ixSeries terminals, the interpretation of the status byte depends on the
Maintenance Message configuration properties. The At Logon property controls
when and how the terminal advises the network of operator activity (Table 5-41).
The requirements of your network determine the correct setting for this property.
5 Supply selected
5 Supply selected
[1] Bits 0 through 4 and bit 7 of the status byte are reserved.
The first time an operator performs one of the maintenance operations (logging
on, selecting Send Attention Message, or selecting Supply), the terminal sends an
Unsolicited Status message with the applicable bit set. If the operator performs a
second (but different) maintenance operation, the terminal sends an Unsolicited
Status message with both bits set.
Agilis 91x for ix/CSP clears bits 5 and 6 of the status byte only when the operator
logs off (selects the Exit menu item). If only one status bit was set during
maintenance operations, then during logoff, the terminal sends a single message
with both status bits cleared.
Normally, if both status bits were set during maintenance operations, then during
logoff, the terminal first sends an Unsolicited Status message with bit 6 cleared
and bit 5 set. Then the terminal sends a message with both status bits cleared.
This sequence is a result of the default setting of the At Logoff property (the
Send Supply Status setting).
Changing the At Logoff property to the Send Supervisory Status setting reverses
the bit pattern sent to the network at logoff. With this setting selected and both
status bits set during maintenance operations, at logoff, the terminal first sends an
Unsolicited Status message with bit 6 set and bit 5 cleared. Then the terminal
sends a message with both status bits cleared.
EXAMPLE 1
Assume that the terminal is configured with the Send No Status setting selected
for the At Logon property. When the operator performs the procedures in
Table 5-42, the terminal reports a Supervisory and Supply Actions status with the
status byte indicated for each step.
5-89
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
When the Send No Status setting is selected, logging on has no effect on the bits
of the Supervisory and Supply Actions status byte. When an operator logs on, the
terminal does not send a message to the network.
Table 5-42 Supervisory and Supply Actions Example (Send No Status selected)
3. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
2. The operator makes any selections other than Supply, Send Attention Message, and Exit (logoff). no message
3. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
EXAMPLE 2
Assume that the terminal is configured with the Send Supply Status setting
selected for the At Logon property. When the operator performs the procedures
in Table 5-43, the terminal reports a Supervisory and Supply Actions status with
the status byte indicated for each step.
When the Send Supply Status setting is selected, the Supply command has no
effect on the bits of the Supervisory and Supply Actions status byte. If the
operator selects Supply, the terminal does not send a message to the network.
Table 5-43 Supervisory and Supply Actions Example (Send Supply Status selected)
2. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
2. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
[1] If the Send Supervisory Status setting is selected for the At Logoff property, the terminal sends a 40 status byte (first message)
instead of a 20 status byte at Step 4 of the last procedure in this table.
5-90
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Table 5-43 Supervisory and Supply Actions Example (Send Supply Status selected) (continued)
EXAMPLE 3
Assume that the terminal is configured with the Send Supervisory Status setting
selected for the At Logon property. When the operator performs the procedures
in Table 5-44, the terminal reports a Supervisory and Supply Actions status with
the status byte indicated for each step.
When the Send Supervisory Status setting is selected, the Send Attention
Message command has no effect on the bits of the Supervisory and Supply
Actions status byte. If the operator selects Send Attention Message, the terminal
does not send a message to the network.
Table 5-44 Supervisory and Supply Actions Example (Send Supervisory Status selected)
2. The operator makes any selections other than Send Attention Message and Exit (logoff). no message
3. The operator makes any selections other than Exit (logoff). no message
NOTE
The following table shows the sequence of Unsolicited Status messages that are
sent to the network in Continuous Availability for a Send Attention Message
selection. The items in parentheses describe the messages that are sent when
Send Attention Message is selected. These items represent what is to be sent
for maintenance logon, followed by selection of Send Attention Message,
followed by maintenance logoff.
5-91
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
The 300s before and after the messages in parentheses are sent if the Maintenance
Mode Log to Network option is selected. These 300s represent the Unsolicited
Status messages sent to the network upon entrance to Continuous Availability
and exit from Continuous Availability.
• At Logon property
• At Logoff property
• Maintenance Mode Log to Network option
Table 5-45 shows how these elements determine which statuses are sent to the
network.
An example of the messages sequence for the last case in Table 5-45 is shown
below:
5-92
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
There are three bytes in printer unsolicited status. Refer to Table 5-46 for
detailed bit definition of each of these three bytes.
0 7 Print operation complete If this bit is set, the print operation has been completed.
1 Receipt printer has faulted A fault has occurred on the receipt printer which requires attention.
Detailed fault information is available in Printer Unsolicited Status
Byte 1.
0 Journal printer has faulted A fault has occurred on the journal printer which requires attention.
Detailed fault information is available in Printer Unsolicited Status
Byte 2.
1 7 Receipt printer has run low on paper This fault is normally caused by a depleted receipt printer paper roll. It
is corrected by reloading the printer. If this fault is indicated and the
paper roll is not out, an electrical or mechanical malfunction might
have occurred requiring service assistance.
5 Receipt printer has run out of paper This fault is normally caused by the printer paper roll being depleted.
This fault is corrected by reloading the printer. If this fault is indicated
and the paper roll is not out, an electrical or mechanical malfunction
might have occurred requiring service assistance.
3 Fault occurred during a top-of-form search Bursting of the receipt is controlled by a dark mark on the right side of
on the receipt printer each form. This mark is optically detected by a top-of-form sensor.
When this mark is detected, the receipt is burst and presented to the
consumer. If this mark is not found after approximately six seconds
of paper movement (because of a paper loading problem, a paper
jam, or possibly an electrical or mechanical problem), the following
takes place: the paper movement halts, no burst is attempted, and
this fault is indicated.
2 Fault occurred during a head return and After printing a line on the consumer receipt, the printer performs a
line feed on the receipt printer carriage return of the print head to prepare for the next line of data. At
the same time, a paper line feed is done. Of these, only print head
movement can be detected by the paper margin sensor. The fault
indications are caused by a failure of the print head to return to the
start position. No monitoring of actual paper movement is done. A
fault is not indicated if a paper line feed is not done because of a paper
drive problem. A print head carriage return problem might be caused
by a paper jam or other obstruction, an electrical or mechanical failure
of the print head drive, or a failure of the paper margin sensor. A fault
indication might also be caused by an electronic failure that is caused
by a failure of the printer electronics to send a ready signal to the
terminal’s microcomputer to indicate task completion.
5-93
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
0 Fault occurred during a line print on the This fault is indicated following an attempt to print a line of characters
receipt printer on the receipt. Fault causes are as follows:
• The print head fails to move because of a paper jam or other
obstruction, a mechanical failure of the print head drive assembly,
or an electrical failure of the head motor drive electronics.
2 7 Journal printer has run out of paper This fault is normally caused by a depleted journal printer paper roll. It
is corrected by reloading the printer. If this fault is indicated and the
paper roll is not out, an electrical or mechanical malfunction might
have occurred requiring service assistance.
6 Electrical fault detected on ready line of This is an electrical fault caused by a malfunction of the journal
journal printer printer electronics. The printer electronics has a signal line called
ready used to signal the terminal’s microcomputer that a printer task
has been completed. A printer task complete is indicated by a logic
low level (ground) on this signal line. This line is then reset by an
acknowledgment signal from the microcomputer. If the ready line fails
to reset (remains grounded), this fault is indicated.
5 Journal printer has run low on paper This fault is normally caused by a depleted journal printer paper roll. It
is corrected by reloading the printer. If this fault is indicated and the
paper roll is not out, an electrical or mechanical malfunction might
have occurred requiring service assistance.
2 Fault occurred during a head return and After printing a line on the journal printer paper roll, the printer does a
line feed on the journal printer carriage return of the print head to prepare for the next line of data.
At the same time, a paper line feed is done. Of these, only the print
head movement can be detected by the paper margin sensor. Fault
indications are caused by a failure of the print head to return to the
start position. The printer does not monitor actual paper movement.
A fault is not indicated if a paper line feed is not done because of a
paper drive problem.
0 Fault occurred during a line print on the This fault follows an attempt to print a line of characters on the journal
journal printer printer audit roll if one of the following occurs:
• The print head fails to move due to a paper jam or other
obstruction, a mechanical failure of the print head drive assembly,
or an electrical failure of the head motor drive electronics.
5-94
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
There is one byte for the card reader unsolicited status. Refer to Table 5-47 for
detailed bit definition of this byte.
0 7 Read operation complete This bit is used internally by the terminal for sequencing and is always
turned on in this status byte.
6 Track 1 read error Bits 6 to 4 can appear on or off in any combination that reflects the
status of the last read operation. If any of these bits are on and bits 1
and 0 are off, the terminal is reporting that the card read error count set
in Card Reader configuration options has been reached. Shutdown of
the terminal is not required, but a timely inspection of the card reader is
suggested.
3 Card in Retain position This bit is used internally by the terminal for sequencing. This bit
being set does not indicate a status change that require sending a
status message, for example, status messages that include this bit on
might have other status.
2 Soft failure If this bit is set, the terminal sensed an abnormal condition in the
card reader (for example, the front and rear switches were closed
simultaneously). If this bit is set, the terminal completes the current
card read and allows future card reads. Soft failure refers only to card
motion and not card read errors.
1 Hard Fault If this bit is set, a fault has occurred on the card reader that requires
attention before another card read can be correctly processed. This
fault is normally caused by a card being jammed on the read head that
the card reader cannot return or retain. Hard fault refers only to card
motion and not card read errors.
0 Card in rear If this bit is set, the terminal retained a card that it could not return
because of a mechanical failure. This bit being set does not cause the
terminal to send a status message.
5-95
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
There is one byte for the card writer unsolicited status. Refer to Table 5-48 for
detailed bit definition of this byte.
1 Card write error limit The terminal has exceeded the Track Write Error Limit specified in the
exceeded Card Reader configuration options.
0 No start or end sentinel The track 1, 2, or 3 data buffer does not contain a start and an end
sentinel. No writing was attempted. The terminal went to the No Write
Attempted Next State from the Card Write state table. The terminal does
not set this bit or send this status message if the track was not properly
read and the network did not update the track data with a Function
Command message.
Unsolicited dispenser status can be sent to the network. To enable this feature
and have the status sent to the network, you must do the following:
Device ID ’?’
Status DI01
If the MDS Status to Network feature is selected, the MDS status is included
with this message along with the cassette IDs.
5-96
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
5.3.8 Withdrawal Door Status (unsolicited) for 912 Mode (SSF = ’@’)
There is one byte for withdrawal door unsolicited status in 912 mode. The
following statuses are applicable for terminals with a presenter:
Agilis 91x for ix/CSP can send an Unsolicited Status message to the network
to report a withdrawal area sensors status (’<’ status source). This message
contains one status byte. The following statuses are applicable for terminals
with a presenter:
5-97
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Table 5-49 lists and defines the IDM unsolicited status information for terminals
operating in the 912 mode.
Table 5-49 IDM Unsolicited Status for 912 Mode (SSF = ’A’)
6 Hard fault If this bit is set, a depository fault has occurred that requires attention
before another can be correctly processed. This fault is normally
caused by a stuck envelope in the envelope entry slot or a missing
deposit cassette. If this bit is set, the terminal will not complete the
current deposit, and future deposits should not be attempted.
5 Printer error The printer that stamps the deposit envelope with a specific serial
number has not incremented the serial number. Refer to byte 1 of the
status for more detailed information on the printer module fault status.
This fault requires service assistance.
4 Consumer timeout An envelope has not been deposited within the allotted time period.
3 Initial condition fault A deposit cassette is not present, the rotating assembly is unlatched,
the printhead missing, or check bins are missing. No deposit is
attempted.
2 Deposit incomplete, or depository If this bit is set, the terminal started receiving the envelopem, but the
not present terminal never sensed the envelope entering the deposit cassette.
This is probably caused by a depository fault, by the consumer
inserting then removing the envelope, by the absence of a depository,
or by the Depository device being disabled during configuration..
1 Deposit cassette full, or invalid check The deposit cassette is full. It must be emptied before the next deposit
bin specified in retain or capture can start. No deposit is attempted.
operation. Do not continue.
0 Soft fault If this bit is set, a fault has occurred on the depository. This fault is
normally caused by a switch failure. If this bit is set, the terminal
completes the current deposit and allows future deposits.
1 (printer 7 MICR read fault If this bit is set, a MICR read fault was encountered. The number
module fault of allowable read faults is set in the Depositor device properties. If
status) any MICR data was found, it is available for inclusion in a Consumer
Request message, depending on the Send Track 1, Track 3, and/or
MICR data entry in the Transaction Request state.
4 Consumer cancel If this bit is set, the consumer cancelled a deposit operation. This bit is
set in addition to the consumer timeout bit (byte 0, bit 4). The Deposit
Cancel Status Bit feature must be set in the Miscellaneous Features 1
field of the Write Command 3 message for this bit to be set.
3 Thousands module error The deposit thousands-digit print module has not increased to the
desired number. This fault requires service assistance.
2 Hundreds module error The deposit hundreds-digit print module has not increased to the
desired number. This fault requires service assistance.
1 Tens module error The deposit tens-digit print module has not increased to the desired
number. This fault requires service assistance.
0 Units module error The deposit units-digit print module has not increased to the desired
number. This fault requires service assistance.
5-98
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Table 5-49 IDM Unsolicited Status for 912 Mode (SSF = ’A’) (continued)
2 7 Depository disabled The IDM has been disabled either due to a fault or by the network.
4 Document handling error The IDM has encountered one of the following problems while trying to
transport a check:
• Mechanism cannot lift the gate during a straighten sequence
• Cannot position the shuttle during a straighten sequence
• Document cannot reach the magnetic sensor
• Cannot straighten the document
• Document cannot position in bottom hold area
• Document cannot position in top hold area
3 Bin error The selected bin was unusable or was full. This status might also
indicate a possible jam.
2 Document size error Inserted document is too short, too long, or too thick.
1 Scanner error The scanner did not operate, indicating a scanner fault.
And so on.
5-99
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
5.3.11 Coin Dispenser Status (unsolicited) for 912 Mode (SSF = ’G’)
Unsolicited coin dispenser status can be sent to the network. To enable this
feature and to have the status sent to the network, you must do the following:
Device ID ’G’
Status CN01
If MDS Status to the network is selected, the MDS status is included with
this message.
5-100
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
Agilis 91x for ix/CSP reports enhanced status for the following devices:
• Keypad
• Encryption/decryption device
• Envelope dispenser
• Lead-through indicators
• Passbook printer
NOTE
• Statement printer
• Touch screen (not applicable on the CashSource Plus 400)
• Device ID. This is the four-character device identifier of the device that sent
the status. For unsolicited statuses, the following device IDs are valid:
NOTE
- PF01 - PIN/FIT
- SD01 - Envelope dispenser
- SP01 - Statement printer
- TS01 - Touch screen
• Fault Status. This status is the MDS-type fault status data. MDS-type status
data is a series of three-character fields, each field consisting of a colon
character ( : ), followed by two hexadecimal digits.
For example, a statement printer paper out fault might appear as follows:
Status Source J
Device ID SP01
5-101
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
For details on the actual status definitions, refer to the Agilis 91x for ix Status
Reference Manual (TP-820589-001E).
5-102
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Filtering and Translating Network Status
This section describes how to filter and translate Agilis 91x for ix/CSP statuses
sent to the network to suit the needs of an individual network.
NOTE
To customize the statuses sent to the network, create the file CUSTSTAT.TXT in
the \ibold\afw directory. You can use any text editor to create and edit this file.
The format for this file is illustrated in the following example:
PR01
:2D:50:00 "xxxxxxx" "yyyyyyy"
:3D:60:00 "xxxxxxx" "yyyyyyy"
:3E:00:00 "xxxxxxx" "yyyyyyy"
END PR01
TS01
:3E:42:40 "xxxxxxx" "yyyyyyy"
:38:00:00 "xxxxxxx" "yyyyyyy"
END TS01
Each status translation table can have one or more entries. Each entry in the
table must contain three fields. The table should contain entries for only those
statuses you are customizing.
The first field represents an MDS status. Agilis 91x for ix/CSP uses MDS
statuses internally to modify processing and to determine what 911 status or 912
status is sent to the network. This field consists of from one to three hexadecimal
bytes. Each byte is preceeded by the : (colon) character. The field does not have
to include all three bytes of the MDS status. For example, if you want all MDS
statuses starting with :2D to translate to the same network status, you only
need to have the :2D in this field.
The second field ("xxxxxxx") defines the status to be sent to the network in
Solicited Status messages. Whatever is enclosed within the double quote
characters is placed in the Device Identifier field and the Status field of the
Solicited Status message. Each text string is limited to 43 bytes (not including
the double quotes).
The third field ("yyyyyyy") defines the status to be sent to the network in
Unsolicited Status messages. Whatever is enclosed within the double quote
characters is placed in the Status Source field and the Status field of the
Unsolicited Status message. Each text string is limited to 43 bytes (not including
the double quotes).
5-103
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Filtering and Translating Network Status
Agilis 91x for ix/CSP recognizes several special text strings to assist you in
producing the desired output for the network:
CAUTION
For printers (PR01, PR02, PR03, and SP01), Agilis 91x for ix/CSP is
designed to return a Ready message to the network if the applicable solicited
status is suppressed.
• Hexadecimal data (such as group separators, field separators, and so on) can
be included in the status data by preceding the hexadecimal data with the
\x sequence. The following text would cause the status handler to insert a
field separator (hexadecimal 1C) in the status data:
\x1C
For additional information on status, refer to the Agilis 91x for ix Status
Reference Manual (TP-820589-001E).
EXAMPLE
To translate the printer status :2D:50:00 (paper supply low) to the text message
Paper Supply Low for solicited status, and to the text message Supplies for
unsolicited status, you need to have a line similar to the following one in the
appropriate printer table of your CUSTSTAT.TXT file.
5-104
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Filtering and Translating Network Status
The Solicited Status message indicating a paper low condition would then appear
as shown in the following table (assuming that the optional fields following
the Status field are not included):
Description Data
Solicited/Unsolicited ID 2
Message Identifier 2
Status Descriptor 8
5-105
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
• The consumer has entered all the required data for a specific Consumer
Request message.
[ Response Flag ] [ X ] [ 1 ]
[ Next State ID ] [ - - - ] [ 3 ]
Function Identifier - - - 1
[ Screen Number ] [ - - - ] [ 3 ]
5-106
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
Printer Flag - - - 1
[ Printer Flag ] [ - - - ] [ 1 ]
[ MAC Data ] [ - - - ] [ 8 ]
5-107
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
[ Response Flag ] [ X ] [ 1 ]
[ Next State ID ] [ - - - ] [ 3 ]
Function Identifier - - - 1
Screen Number [ - - - ] 3
Function Identifier - - - 1
Screen Number [ - - - ] 3
The field separator, Depositor Settings field ID, and first group separator are not optional. After that, group separators are only
required as far as the data included.
This block can contain one or more null groups (a group separator followed by no data). In this case, the default value for
the omitted field prevails.
[5] These fields can be repeated as often as needed, up to the maximum message length.
5-108
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
Printer Flag - - - 1
Printer Flag - - - 1
Track 3 Field ID 4 1
Deposit Bin ID - - - 3
Image Capture - - - 3
[1] If the Message Sequence Number in Solicited Status Messages feature is selected in a Write Command 3 message, the
message sequence number (or the time variant number, if applicable) is sent back to the network in a Solicited Status
message. If message authentication (MAC) is used, the message sequence number is replaced by an eight-byte time variant
number, and the optional field separator and MAC data are included in the message.
[2] These fields as a whole are optional; however, if the separator (either group or field) is programmed, then all fields must
be specified.
[3] These fields can be repeated up to a total of seven times (seven total function IDs).
[4] These fields as a whole are optional. However, if any portion of these fields need to be programmed, the following rules apply:
The field separator, Depositor Settings field ID, and first group separator are not optional. After that, group separators are only
required as far as the data included.
This block can contain one or more null groups (a group separator followed by no data). In this case, the default value for
the omitted field prevails.
[5] These fields can be repeated as often as needed, up to the maximum message length.
5-109
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
Coin Field ID 8 1
Reserved 000 3
Track 1 Field ID 9 1
Track 2 Field ID : 1
MAC Data - - - 8
The field separator, Depositor Settings field ID, and first group separator are not optional. After that, group separators are only
required as far as the data included.
This block can contain one or more null groups (a group separator followed by no data). In this case, the default value for
the omitted field prevails.
[5] These fields can be repeated as often as needed, up to the maximum message length.
The following paragraphs describe the fields in the Function Command message.
5-110
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
Next State ID
Field Size: 3 characters
Valid Range: 000 through 511
Description: This field defines the state number which the terminal should
execute after the normal completion of the specified Function Command.
5-111
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
For example, to direct the terminal to dispense one A bill, two B bills, and one D
bill, enter 01020001 into this field.
Denomination Value
A $1
B $5
C $10
D $20
E $50
F Reserved
G Reserved
H Reserved
5-112
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
For example, to direct the terminal to dispense one A coin, two B coins, and one
D coin, enter 01020001 into this field.
Denomination Value
A Penny (1¢)
B Nickel (5¢)
D Quarter (25¢)
E Dollar ($1.00)
F Reserved
G Reserved
H Reserved
NOTE
Function Identifier
Field Size: 1 character
Valid Range: Refer to the description
Description: The contents of this one character data field directs the terminal as
to what functions to perform. The valid characters are listed as follows:
• 4 - Print immediate
• 5 - Set next state and print
• 6 - After Hour depository deposit and print
• 7 - Deposit and print (911 mode)
• 8 - Dispense, deliver, and print (911 mode)
• 9 - Deliver and print (911 mode)
• A - Deposit envelope (912 mode). Envelope depository only. For an IDM,
the equivalent function can be performed using a Depository function
or states.
5-113
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
NOTE
Screen Number
Field Size: 3 characters
Valid Range: Valid screen numbers (Section 4.6)
Description: This number indicates the number of the screen to be displayed on
the consumer display during execution of the function command. This field
is used on dispense, deposit, and deliver operations. 000 tells the terminal
not to change the display.
5-114
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
Description: This variable-length field contains a screen number and new screen
data. The data is stored in the terminal’s screen library. The new screen data
can be displayed when this screen number is referenced during transaction
processing. If the Screen Number field is not used and you want to use the
Screen Display Update field, place 000 in the Screen Number field. This data
is lost on powerfail.
NOTE
For example, to direct the terminal to dispense, deliver, and then print, the 912
mode Function Command message contains the following characters:
g1959061
If the terminal responds to any function ID, with a device fault Solicited Status
message, the network must immediately send a second Function Command
message. Then, if the network must disallow the transaction, the second
Function Command message normally contains a Do Nothing function ID. The
Do Nothing function ID sends the terminal to the next state number in the
Function Command message and shows a screen that tells the consumer why
the transaction was not completed.
5-115
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
NOTE
• 0 - Return card
• 1 - Retain card
Printer Flag
Field Size: 1 character
Valid Range: 0 through 3, and ;
Description: This one-character field tells the terminal which printer or printers
to use. The valid graphic characters for this field are as follows:
• 0 - Do not print
• 1 - Print on journal printer only
• 2 - Print on receipt printer only
• 3 - Print on the receipt printer and the journal printer
• ; (semicolon) - Statement printer
Printer Data
Field Size: Variable (limited only by the total length limit for the message)
Valid Range: Refer to the description
Description: This data is printed by the printer indicated in the Printer Flag field.
If the preceding printer flag is ; (semicolon), the printer data must be in expanded
ASCII format. In expanded ASCII format, a printer data byte of B5 (ASCII
hex) is sent to the terminal as the letter B followed by the number 5 (42
35 in ASCII hex).
NOTE
Track 3 Field ID
Field Size: 1 character
Valid Setting: 4
Description: This one character Track 3 Buffer field ID tells the terminal that the
following characters (up to the field separator) are track 3 data.
5-116
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
Track 3 Data
Field Size: Variable (106 characters maximum)
Valid Range: Refer to the description
Description: This field contains the data to be written onto track 3 as directed by
a function command. This data replaces any data previously in the terminal’s
track 3 buffer. The track 3 data in this field must include the start and end
sentinels.
• Bit 2:
5-117
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
• Bit 1:
• Bit 0:
For IDM operation, the value of bits 2 and 1 is ignored. Bit 0 must be set to
1 to perform document scanning. When bit 0 is set to 1, the IDM scans both
the top and the bottom of the document. When the specified operation includes
printing, the side of the document that is printed depends on the physical location
of the deposit printer, rather than the setting of bit 2.
5-118
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
Description: This field is used to override the MICR search preference set in the
Depositor device properties. If this field is not included in the message, the value
defaults to 001. The valid values are as follows:
• 000 - Override the setting in the Depositor device properties. This entry
enables searching for MICR data on the right and left sides of the check. The
first attempt is made on the right edge of the check.
• 002 through 255 - The remaining values, that override the setting in the
Depositor device properties are created using the following bitmap:
5-119
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
NOTE
Track 1 Field ID
Field Size: 1 character
Valid Setting: 9
Description: This one-character Track 1 field ID field tells the terminal that
track 1 data follows.
Track 1 Data
Field Size: Variable (78 characters maximum)
Valid Range: Refer to the description
Description: This field contains the data to be written onto track 1. This data
replaces any data previously in the terminal’s track 1 buffer. The track 1 data in
this field must include the start and end sentinels.
Track 2 Field ID
Field Size: 1 character
Valid Setting: : (colon character)
Description: This one-character Track 2 field ID field tells the terminal that
track 2 data follows.
Track 2 Data
Field Size: Variable (39 characters maximum)
Valid Range: Refer to the description
Description: This field contains the data to be written onto track 2. This data
replaces any data previously in the terminal’s track 2 buffer. The track 2 data in
this field must include the start and end sentinels.
5-120
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
NOTE
MAC Data
Field Size: 8 characters
Valid Range:
Description: This eight-character field contains hexadecimal characters that
represent the MAC calculation of the Consumer Request message. Refer to
the Data Security Procedures and Reference Manual (TP-799530-001D) for
additional details.
5-121
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
The Print Immediate function (function ID 4) directs the terminal to print the
information sent to the terminal. This function is often used when the operator
requests to balance the terminal.
The Set Next State and Print function (function ID 5) directs the terminal to
print the information received from the network, then proceed to the next
state defined in the Function Command message. This function is often used
when the consumer requests an inquiry, when a transaction is disallowed, or
any print operation.
The terminal processes the Set Next State and Print function as follows.
The terminal processes the After Hour Depository Deposit and Print function
(function ID 6) as follows:
5-122
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
The terminal processes the Deposit and Print function (function ID 7) as follows.
2. Starts timer 04 (deposit insertion timer). (If timer 20 has a non-zero value,
Agilis 91x for ix/CSP uses timer 20 in place of timer 04)
• If the Cancel key is pressed while the terminal is checking for the
insertion of the envelope, the terminal sends a Depository Solicited
Status message that indicates a fault and waits for a new Function
Command message.
5-123
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
7. Prints the transaction serial number, the contents of the Dollar Buffer, and
the first 20 characters of track 2 data on the envelope
• If a fault occurs while the terminal is waiting for the deposit to finish,
the terminal sends a Depository Solicited Status message that
indicates a fault and waits for a new Function Command message.
5-124
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
The terminal processes the Dispense, Deliver, and Print function (function
ID 8) as follows.
4. Starts dispensing
6. If a fault does not occur during the dispense operation, and the terminal
is not an <emphasis type="ITALIC">ix</emphasis> Series walk-up
terminal, the terminal goes to Step 8.
7. If a fault does not occur during the dispense operation, and the terminal is
an <emphasis type="ITALIC">ix</emphasis> Series walk-up terminal,
the terminal checks for a trap condition.
10. If a fault does not occur during the present operation, the terminal starts
timer 05. When all the presented bills are removed or when timer 05
expires, the terminal starts timer 07.
5-125
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
11. If timer 07 expires before all the bills are removed, and the No Retract
Bills feature is enabled, the terminal proceeds as follows.
12. If timer 07 expires before all the bills are removed, and the No Retract
Bills feature is not enabled, the terminal dumps the bills, then proceeds
as follows.
13. If all the bills are removed before timer 07 expires, the terminal initializes
for printing.
5-126
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
The terminal processes the Deliver and Print function (function ID 9) as follows.
5. If a fault does not occur during the present operation, the terminal starts
timer 05. When all the presented bills are removed or when timer 05
expires, the terminal starts timer 07.
6. If timer 07 expires before all the bills are removed, and the No Retract
Bills feature is enabled, the terminal proceeds as follows.
7. If timer 07 expires before all the bills are removed, and the No Retract
Bills feature is not enabled, the terminal dumps the bills, then proceeds
as follows.
8. If all the bills are removed before timer 07 expires, the terminal initializes
for printing.
5-127
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
NOTE
2. Starts timer 04. (If timer 20 has a non-zero value, Agilis 91x for ix/CSP
uses timer 20 in place of timer 04) (deposit insertion timer)
• If the Cancel key is pressed while the terminal is checking for the
insertion of the envelope, the terminal sends a Depository Solicited
Status message that indicates a fault and waits for a new Function
Command message.
5-128
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
• If a fault occurs while the terminal is waiting for the deposit to finish,
the terminal sends a Depository Solicited Status message that
indicates a fault and waits for a new Function Command message.
4. Starts dispensing
6. If a fault does not occur while the terminal is dispensing, the terminal
checks for an additional function identifier in the Function Command
message.
5-129
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
5. If a fault does not occur during the present operation, the terminal starts
timer 05. When all the presented bills are removed or when timer 05
expires, the terminal starts timer 07.
6. If all the bills are removed before timer 07 expires, the terminal goes to
Step 9.
7. If timer 07 expires before all the bills are removed, and the No Retract
Bills feature is enabled, the terminal proceeds as follows.
5-130
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
8. If timer 07 expires before all the bills are removed, and the No Retract
Bills feature is not enabled, the terminal dumps the bills, then proceeds
as follows.
The Print and Wait for Completion function (function ID D) directs the terminal
to wait for the completion of printing before going to the next function (if
configuration option: Transaction Host, Message Settings, Command Message,
Function ID ’D’ is selected). If the option is not selected, this function acts like
a Print and Do Not Wait for Completion function (function ID H).
The terminal processes the Print and Wait for Completion function as follows.
• If a fault does not occur while printing, the terminal checks for an
additional function identifier in the Function Command message.
5-131
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
• If a fault occurs while the terminal is returning the card, the terminal
sends a Card Reader Solicited Status message indicating a fault and
waits for a new funciton command message.
• If the card is removed before timer 09 expires, the terminal checks for
an additional function identifier in the Function Command message.
• If the consumer takes the card after the terminal starts transporting
the card, or if the card is not transported correctly, the terminal sends
a Card Reader Solicited Status message that indicates a fault and
waits for a new Function Command message.
• If the consumer does not take the card after the terminal starts
transporting the card, and if the card is transported correctly, the
terminal goes to step 6.
7. If a fault occurs while the terminal is retaining the card, the terminal
sends a Card Reader Solicited Status message indicating a fault and waits
for a new Function Command message.
8. If a fault does not occur while the terminal is retaining the card, the
terminal proceeds as follows.
5-132
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
2. Checks for data in the track 3 buffer (this data might be from the card or
the Function Command message)
4. Writes the data found in the track 3 buffer onto track 3 of the card
• If a fault does not occur while the terminal is writing on the card,
the terminal checks for an additional function identifier in the
Function Command message.
• If a fault occurs after five attempts to write on the card, the terminal
goes to step 5.
5. Retains the card if the terminal cannot advance the card to write on it
6. Sends a Card Writer Solicited Status message indicating a fault and waits
for a new Function Command message
5-133
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
The terminal processes the After Hour Depository Deposit function (function
ID G) as follows:
5.5.14 Print and Do Not Wait for Completion (H) (912 mode)
The Print and Do Not Wait for Completion function (function ID H) directs
the terminal to not wait for the completion of printing before going to the
next function.
The terminal processes the Print and Do Not Wait for Completion function
as follows.
5-134
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
5.5.15 Return Card, Dispense, Deliver, and Print (J) (911 mode)
The terminal processes the Return Card, Dispense, Deliver, and Print function
(function ID J) as follows.
1. During the Return Card function, the terminal shows the screen specified
in the Function Command message.
2. During the Dispense function, the terminal shows the specified screen
plus one.
3. During the Deliver function, the terminal shows the specified screen
plus two.
5.5.16 Deposit Envelope, Return Card, Dispense, Deliver, and Print (K) (911 mode)
The terminal processes the Deposit Envelope, Return Card, Dispense, Deliver,
and Print function (function ID K) as follows.
1. During the Deposit function, the terminal shows the screen specified in
the Function Command message.
2. During the Return Card function, the terminal shows the specified
screen plus one.
3. During the Dispense function, the terminal shows the specified screen
plus two.
4. During the Deliver function, the terminal shows the specified screen
plus three.
5.5.17 Print, Return Card, Dispense, and Deliver (O) (911 mode)
The terminal processes the Print, Return Card, Dispense, and Deliver function
(function ID O) as follows.
1. During the Print function, the terminal shows the screen specified during
the Transaction Request state, normally a Please Wait screen.
2. During the Return Card function and the Dispense function, the terminal
shows the screen specified in the Function Command message.
3. During the Deliver function, the terminal shows the specified screen
plus one.
5-135
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
The Print Data and Stay in Present State function (function ID P) directs the
terminal to print data and stay in the present state. After printing the data
received from the network, Agilis 91x for ix/CSP stays in the Transaction
Request state and waits for another Function Command message.
This function allows the terminal to print large amounts of data, such as a
statement, without continually sending Consumer Request messages to the
network. Using this function, the terminal prints the data sent from the network
and returns a Ready message to the network, then waits for more data. The
terminal does not cut or deliver the printed document. Once all the data has
been printed, the network sends a print function ID other than P, with a next
state specified.
The Print Data and Stay in Present State function supports the following printers:
• Receipt printer
• Journal printer
• Statement printer
The Print Data and Stay in Present State function can be used to stay in the
present state without printing. If no print data is specified in the Function
Command message, or if the printer flag is set to 0 (indicating Do Not Print), the
terminal sends a Ready message and remains in the Transaction Request state
as it awaits another Function Command message.
5-136
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
5.5.20 Deposit Check to Escrow (R) (912 mode) (<emphasis type="ITALIC">ix</emphasis> Series
terminals with IDM only)
If there is no check or other document in escrow, the terminal enables the IDM to
perform the following operations:
• Read the MICR line as directed by the MICR Search configuration setting
field or by the Depositor device configuration options
If a check or other document is in escrow at the start of this function, the check
or document is moved to the deposit bin specified in the Function Command
message. If no deposit bin is specified, the default deposit bin is used. The
deposit then proceeds as described in the preceding paragraphs.
5.5.21 Return Check if in Escrow (S) (912 mode) (<emphasis type="ITALIC">ix</emphasis> Series
terminals with IDM only)
If there is data in the Deposit Printer Data field, the terminal prints this data
on the check or document. If there is no data in the Deposit Printer Data field,
the terminal prints the default data (Section 3.11). If no printing is desired, the
Deposit Printer Data field must contain all spaces.
Timeout of this operation is controlled by timer 09. If a timeout occurs, the check
or document is captured and placed in the deposit bin specified in the Function
Command message. If no deposit bin is specified, the default deposit bin is used.
5-137
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
5.5.22 Retain Check if in Escrow (T) (912 mode) (<emphasis type="ITALIC">ix</emphasis> Series
terminals with IDM only)
If there is data in the Deposit Printer Data field, the terminal prints this data
on the check or document. If there is no data in the Deposit Printer Data field,
the terminal prints the default data (Section 3.11). If no printing is desired, the
Deposit Printer Data field must contain all spaces.
The Present Card function (function ID U) directs the terminal to return the
card and not wait for the consumer to remove the card before going to the
next function.
• If a fault occurs while the terminal is returning the card, the terminal
sends a Card Reader Solicited Status message indicating a fault and
waits for a new funciton command message.
The Write Track 1 function (function ID V) directs the terminal to write to track
1 if the card reader has that capability.
5-138
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
2. Checks for data in the track 1 buffer (this data might be from the card or
the Function Command message)
4. Writes the data found in the track 1 buffer onto track 1 of the card
• If a fault does not occur while the terminal is writing on the card,
the terminal checks for an additional function identifier in the
Function Command message.
• If a fault occurs after three attempts to write on the card, the terminal
goes to step 5.
5. Retains the card if the terminal cannot advance the card to write on it
6. Sends a Card Writer Solicited Status message indicating a fault and waits
for a new Function Command message
The Write Track 2 function (function ID W) directs the terminal to write to track
2 if the card reader has that capability.
2. Checks for data in the track 2 buffer (this data might be from the card or
the Function Command message)
5-139
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
4. Writes the data found in the track 2 buffer onto track 2 of the card
• If a fault does not occur while the terminal is writing on the card,
the terminal checks for an additional function identifier in the
Function Command message.
• If a fault occurs after three attempts to write on the card, the terminal
goes to step 5.
5. Retains the card if the terminal cannot advance the card to write on it
6. Sends a Card Writer Solicited Status message indicating a fault and waits
for a new Function Command message
5.5.26 Disable IDM (X) (912 mode) (<emphasis type="ITALIC">ix</emphasis> Series terminals
with IDM only)
The Disable IDM function (function ID X) directs the terminal to shut down the
IDM. All further IDM operations are suspended until the IDM is cleared and the
terminal enters and exits the Maintenance mode.
This function can be used when an check or other document in escrow cannot be
moved to a deposit bin and it is not desirable to return the check or document to
the consumer.
5.5.28 Deposit, Write Card, Return Card, Dispense, Deliver, and Print ( ? ) (911 mode)
The terminal processes the Deposit, Write Card, Return Card, Dispense, Deliver,
and Print function (function ID ?) as follows.
1. During the Deposit function, the terminal shows the screen specified in
the Function Command message.
2. During the Write Card and the Return Card functions, the terminal
shows the specified screen plus one.
5-140
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
3. During the Dispense function, the terminal shows the specified screen
plus two.
4. During the Deliver function, the terminal shows the specified screen
plus three.
5.5.29 Write Card, Return Card, Dispense, Deliver, and Print ( = ) (911 mode)
The terminal processes the Write Card, Return Card, Dispense, Deliver, and Print
function (function ID =) as follows.
1. During the Write Card and the Return Card functions, the terminal shows
the screen specified in the Function Command message.
2. During the Dispense function, the terminal shows the specified screen
plus one.
3. During the Deliver function, the terminal shows the specified screen
plus two.
5-141
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The network can send multiple field entries in one Enhanced Function Command
message. However, the network cannot send the same field ID more than
once in the same message.
The network can also send multiple group entries in certain fields.
Within one message, the network can send as many fields and field groups as
necessary until the maximum allowable length of the message has been reached
(1920 bytes).
The network programmer need not specify all the possible field IDs in a
given enhanced function command. Technically, all fields are optional. The
programmer specifies only those fields relevant to the specific application. For
example, if the programmer wants to print on the statement printer, function
IDs ’:’ (perform function) and ’9’ (update buffers) might be the only function
IDs in the message.
The network can also send a Function Command message with no field entries.
The network can use this type of Function Command message to send the
terminal directly to the Good Operation Next State without first performing a
function.
The terminal stores all update data received in a Function Command message
before starting any Perform Function operation included in the message.
Likewise, the terminal executes all Perform Function operations in a Function
Command message before exiting to the Good Operation Next State included in
the message.
The update data entries can be located after the Perform Function entries in the
message. However, the terminal still stores all update data received in a message
before starting any Perform Function operation. The terminal then executes the
Perform Function entries in the order received in the message.
5-142
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
[ Response Flag ] [ X ] [ 1 ]
Yes Key - - - 3
Yes Key - - - 3
Yes Key - - - 3
No Key - - - 3
No Key - - - 3
No Key - - - 3
Cancel/Stop Key - - - 3
Cancel/Stop Key - - - 3
Cancel/Stop Key - - - 3
5-143
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Silent Time - - - 3
Beeper Rate - - - 3
Beeping Time - - - 3
Screen Number - - - 3
Silent Time - - - 3
Beeper Rate - - - 3
Beeping Time - - - 3
Screen Number - - - 3
5-144
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
[ MAC Data ] [ - - - ] [ 8 ]
5-145
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Message ID
Field Size: 1 character
Valid Range: 7
Description: This one-character data field defines the type of message being
transmitted. The only valid value for the Enhanced Function Command message
is 7.
Response Flag
Field Size: 1 character
Valid Range: 1
Description: The Response Flag entry is part of the logical protocol in a network
message. This entry is included for compatibility with other Diebold products. It
is a reserved entry and must contain a value of 1.
The network also sends a LUNO in the logical protocol of each message it sends
to the terminal. However, the terminal ignores any LUNO sent in a network
message except for a LUNO sent as part of the installation data.
In the network chooses not to send a LUNO entry with the installation data,
the terminal automatically sets its LUNO to 000.
5-146
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
NOTE
When the terminal responds to the network with one of the following types of
messages, it sends the network the same number that it received in the Function
Command message:
5-147
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Configuration ID Data
Field Size: 1 to 16 characters
Valid Range: ASCII characters
Description: The variable-length Configuration ID Data entry contains a value
or number that identifies all the configuration data stored at the terminal. The
Configuration ID Data entry is part of the configuration data that the network
either downloads with Write Command messages or updates with Function
Command messages.
To verify that the terminal has the proper configuration data, the terminal sends
the Configuration ID Data back to the network in the following Status messages:
The network must define and download a unique Configuration ID with each
unique set of configuration data. Then, when the network asks for this ID from
the terminal (operational command ’3’), the network can identify the exact load
image that the terminal contains. Judicious use of the Configuration ID can save
needless downloading of configuration data.
If the network chooses to send Yes key values, the network must designate at
least one function key (A, B, C, D, F, G, H, I, J, K, L, or M) as a Yes key. If the
consumer selects any one of the Yes keys defined in the message, the system
returns the key code of the first function key designated in the Yes Keys group.
NOTE
If the network chooses not to send any Yes key values, the terminal defaults to
function key A as the only Yes key.
5-148
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Yes Key
Field Size: 3 characters
Valid Range: ’A’ through ’M’, and ’0’ through ’9’
Description: The Yes Key entry identifies which function key(s) the network
enables for the Yes response to any screen. The network can enable up to
three Yes keys per terminal.
If the network chooses to send No key values, the network must designate at
least one function key (A, B, C, D, F, G, H, I, J, K, L, or M) as a No key. If the
consumer selects any one of the No keys defined in the message, the system
returns the key code of the first function key designated in the No Keys group.
NOTE
If the network chooses not to send any No key values, the terminal defaults to
function key B as the only No key.
No Key
Field Size: 3 characters
Valid Range: ’A’ through ’M’, and ’0’ through ’9’
Description: The No Key entry identifies which function key(s) the network
enables for the No response to any screen. The network can enable up to three
No keys per terminal.
If the network chooses to send Cancel/Stop key values, the network must
designate at least one function key (A, B, C, D, F, G, H, I, J, K, L, or M) as a
Cancel/Stop key. If the consumer selects any one of the Cancel/Stop keys
defined in the message, the system returns the key code of the first function key
designated in the Cancel/Stop Keys group.
5-149
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
NOTE
If the network chooses not to send any Cancel/Stop key values, the terminal
defaults to function key E as the only Cancel/Stop key.
Cancel/Stop Key
Field Size: 3 characters
Valid Range: ’A’ through ’M’, and ’0’ through ’9’
Description: The Cancel/Stop Key entry identifies which function key(s) the
network enables for the Cancel or Stop response to any screen. The network can
enable up to three Cancel/Stop keys per terminal.
NOTE
NOTE
The timers are part of the configuration data that the network either downloads
with Write Command messages or updates with Function Command messages.
The network can then direct the terminal to use a timer by including the timer’s
number in state data and function data. These timers are the standard timers with
a 9 in front of the two-digit number.
Silent Time
Field Size: 3 characters
5-150
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Beeper Rate
Field Size: 3 characters
Valid Range: The valid values for this entry are as follows:
• 000 = No beeping
• 001 = Slow beep rate (1-second cycle time)
• 002 = Medium beep rate (1/2-second cycle time)
• 003 = Fast beep rate (1/4-second cycle time)
• 004 = Continuous tone
Description: The Beeper Rate entry defines the rate at which the beeper emits a
tone. The network can change the beeper rate only for the terminal configured
timers or for the timer the terminal uses while showing the Do You Want More
Time? special screen.
The beeper duty rate is 50%. This means that the beeper is on for half of the
cycle time and off for half of the cycle time. For example, for the slow beep
rate (1-second cycle time), the beeper is on for 1/2 second and off for 1/2
second during each cycle.
Beeping Time
Field Size: 3 characters
Valid Range: 000 through 255
Description: The Beeping Time entry defines the amount of time, in ticks, that
the beeper emits the tone defined in the Beeper Rate entry. The terminal starts
this timer after the timer defined in the Silent Time entry expires.
These screens are the only screens that the terminal can show without network
involvement.
Screen Number
Field Size: 3 characters
Valid Range: Valid screen numbers (Section 4.6)
5-151
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Screen Number entry tells the terminal the screen number for
the More Time special screen. The valid values are as follows:
Silent Time
Field Size: 3 characters
Valid Range: 000 through 255 (default is 000)
Description: The Silent Time entry defines the amount of time, in ticks, that the
Special Screen is shown with no beeping. The terminal uses this timer before
starting the timer defined in the Beeping Time entry.
Beeper Rate
Field Size: 3 characters
Valid Range: The valid values for this entry are as follows:
• 000 = No beeping
• 001 = Slow beep rate (1-second cycle time)
• 002 = Medium beep rate (1/2-second cycle time)
• 003 = Fast beep rate (1/4-second cycle time) (default)
• 004 = Continuous tone
Description: The Beeper Rate entry defines the rate at which the Beeper emits a
tone while while the terminal is showing the More Time special screen. The
beeper duty rate is 50%. That means the beeper is on for half the cycle time and
off half of the cycle time. For example, for the slow beep rate (1-second cycle
time), the Beeper is on for 1/2 second and off for 1/2 second during each cycle.
Beeping Time
Field Size: 3 characters
Valid Range: 000 through 255 (default is 030)
Description: The Beeping Time entry defines the amount of time, in ticks, that
the beeper emits the tone defined in the Beeper Rate entry. The terminal starts
this timer after the timer defined in the Silent Time entry expires.
Screen Number
Field Size: 3 characters
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry tells the terminal the screen number for
the Off Line special screen. The valid values are as follows:
5-152
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Screen Number
Field Size: 3 characters
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry tells the terminal the screen number for
the Special Screen Out-of-service. The valid values are as follows:
NOTE
State Data
Field Size: Maximum length is 150 characters
Valid Range: Refer to the description
Description: The State Data entries contain sets of parameters or rules that tell
the terminal how to process the states. For example, the entries include the
screen to show upon entering the state, the buffer location where necessary
data is stored, the exit state to go to depending on how the state is processed,
and so on. This must be enhanced state information. Standard 9000 state
information is not applicable.
Screen Data
Field Size: 1 to 512 characters
Valid Range: ASCII characters
5-153
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: A Screen Data entry contains data that the terminal uses to show
screens on the consumer display. With the use of special control sequences, the
terminal can also print a Screen Data entry on the receipt printer or journal printer.
FIT Data
Field Size: 38, 3-character entries of :XX
Valid Range: :00 through :FF
Description: A FIT Data entry contains the data the terminal needs to process
cards and to verify consumer-entered PIN numbers. The information in a FIT
Data entry is used in conjunction with the information encoded on a consumer’s
card. FIT Data entries are part of the configuration data that the network either
downloads with Write Command messages or updates with Function Command
messages.
Some examples of the functions a FIT Data entry serves are as follows:
5-154
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• Tells the terminal which key to use to encrypt a PIN before sending the
PIN to the network
• Tells the terminal the value of the encrypted key to use when performing
DES PIN verification at the terminal
At least one FIT Data entry is necessary for each financial institution that uses
the terminal. Refer to the Data Security Procedures and Reference Manual
(TP-799530-001D) for detailed information on FIT Data.
Buffer Data
Field Size: Variable (limited only by the total length limit for the message)
Valid Range: 000 through 255
Description: The Buffer Data entry contains the data the terminal stores in the
buffer identified in the Buffer ID entry preceeding this entry.
Function Data
Field Size: Variable
Valid Range: Refer to the description
Description: A Function Data entry is a set of parameters or rules that tell the
terminal how to complete a consumer transaction. A Function Data entry causes
the terminal either to go directly to a state or to perform a device operation and
then proceed to a state. The specific function data entries are described in
Section 5.6.1 through Section 5.6.18.
MAC Data
Field Size: 8 ASCII characters
Valid Range: 0 through 9, and A through F
Description: The MAC Data entry contains eight characters that represent the
result of a Message Authentication Code (MAC) calculation on the message. The
MAC entry is optional. It is only necessary when the terminal uses message
authentication.
5-155
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Message authentication allows the terminal and the network to check that a
message was not tampered with while the message was on the communications
lines. Refer to the Data Security Procedures and Reference Manual
(TP-799530-001D) for additional details on the MAC option.
5-156
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The following sections describe the function data sent to the terminal in enhanced
Function Command messages.
The network sends the function data to tell the terminal how to complete a
consumer transaction. The function data causes the terminal either to go directly
to a state or to perform a device operation and then proceed to a state.
Section 5.6.4 through Section 5.6.18 describe the data format for the following
functions:
NOTE
• Printer (for receipt printer, journal printer, and EDC) (PR b/)
• Statement printer (SP b/)
• Do nothing (.A b/)
Completing an Operation
When the network receives a Consumer Request message from a terminal, the
network processes the request and then either approves or denies the transaction.
The network tells the terminal how to complete the transaction by sending a
Function Command message. The Function Command message can contain
the following types of information:
• The number of the next state that the terminal goes to on a good completion
Each Device ID and its related group of Function Data entries described in this
section make up a Perform Function entry. Refer to Section 5.6 for information
on the update configuration data entries and the Good Operation Next State field.
Function Data is similar to Device State Data. However, Function Data does not
include any Fault Next State numbers. Also, the Good Operation Next State
number appears before the Function Data in the Function Command message,
not as part of the Function Data.
5-157
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The terminal stores all update data received in a Function Command message
before executing any Perform Function operations included in the message.
Likewise, the terminal executes all Perform Function operations in a Function
Command message before exiting to the Good Operation Next State included
in the message. The terminal executes multiple Perform Function operations
in the order that they are sent in the Function Command message.
Depending on the Operation entry specified in the Function Data, the terminal
completes an operation as follows:
• If the terminal is directed to wait for the operation to complete, and the
operation is successful, the terminal goes to the next operation specified in
the message (Perform Function or Good Operation Next State).
• If the terminal is directed to wait for the operation to complete, and the
operation is unsuccessful, the terminal stops the function processing. The
terminal sends the network a Solicited Status message indicating a fault, and
remains in the Transaction Request state while waiting for another Function
Command message from the network.
• If the terminal is directed not to wait, the terminal goes immediately to the
next operation specified in the message without waiting for a successful
completion to the current operation. This type of Operation entry allows the
network to program for device operation overlap during a transaction
sequence.
NOTE
• If the terminal is directed to wait for a consumer response and the consumer
responds before the timeout occurs, the terminal goes to the next operation
specified in the message.
• If the terminal is directed to wait for a consumer response and the consumer
does not respond before the timeout occurs, the terminal sends the network a
Timeout Status message.
NOTE
5-158
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
A perform operation and do not wait entry causes the terminal to exit
immediately to the next operation specified in the message (Perform Function or
Good Operation Next State), leaving the device to proceed with the operation.
Two devices can operate simultaneously if the next operation activates a device
operation. Also, multiple devices can operate simultaneously if the next
operation specifies another perform operation and do not wait.
5-159
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the After Hour Depository Function Data entries is shown in
Table 5-53. The After Hour Depository Function Data directs the terminal
to perform deposit operations only.
If the consumer does not insert the deposit material within the time specified by
the Consumer Response Time entry, the terminal shows the More Time screen
and starts timer 01. If the consumer answers No to this screen, or if timer 01
expires, the terminal sends the network a timeout status. If the consumer answers
Yes, the terminal restarts the deposit operation.
NOTE
Operation 101
The following paragraphs describe the fields for the After Hour Depository
Function Data.
Unit Number
Valid Range: 001
Description: The unit number for the After Hour depository Function Data
must be 001.
Operation
Valid Range: 101
Description: The Operation entry tells the terminal what operation to perform.
The only valid value for the After Hour depository is 101; start the deposit
operation and wait for the consumer to insert the deposit material.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
5-160
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Screen Number entry specifies the number of the screen that
the terminal shows on the consumer display while the terminal is performing the
function. The valid values are as follows:
NOTE
The After Hour depository device has its own timer. If the
consumer does not complete the deposit within 15 minutes, the
device times out. Agilis 91x for ix/CSP then terminates the
deposit operation and reports a timeout status to the network.
5-161
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Coin Dispenser Function Data entries is shown in Table 5-54.
The Coin Dispenser Function Data directs the terminal to perform coin dispense
operations only. The Operation entry in the Function Data determines which
operation the terminal performs.
The network specifies the number and types (denominations) of coins to dispense
in the Number of Coins entries. The total number of coins to be dispensed must
not exceed 50. For example, the network might specify 50 A coins only. Or, the
network might specify 25 A coins, 10 C coins, and 15 D coins.
The terminal must deliver the coins to the withdrawal area before the dispense
operation is considered complete and before the terminal can continue with
function processing. A terminal does not make denomination substitutions to
complete a dispense operation. In the case of a partial dispense, the terminal does
not go to the next operation when the dispense operation is complete. Instead, the
terminal sends the network a status message indicating what the terminal did and
why the terminal was not able to complete the dispense properly. The terminal
then waits for another Function Command message from the network.
The following paragraphs describe the fields for the Coin Dispenser Function
Data.
Unit Number
Valid Range: 001
5-162
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The unit number for the Coin Dispenser Function Data must be 001.
Operation
Valid Range: 101, 102
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 101 - Perform a dispense operation, deliver the coins to the withdrawal area,
and wait for the operation to complete.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen that
the terminal shows on the consumer display while the terminal is performing the
function. The valid values are as follows:
NOTE
Number of A Coins
Valid Range: 000 through 050
Description: The Number of A Coins entry tells the terminal how many A
denomination coins to dispense.
Number of B Coins
Valid Range: 000 through 050
Description: The Number of B Coins entry tells the terminal how many B
denomination coins to dispense.
Number of C Coins
Valid Range: 000 through 050
Description: The Number of C Coins entry tells the terminal how many C
denomination coins to dispense.
Number of D Coins
Valid Range: 000 through 050
5-163
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Number of D Coins entry tells the terminal how many D
denomination coins to dispense.
Number of E Coins
Valid Range: 000 through 050
Description: The Number of E Coins entry tells the terminal how many E
denomination coins to dispense.
Number of F Coins
Valid Range: 000 through 050
Description: The Number of F Coins entry tells the terminal how many F
denomination coins to dispense.
Number of G Coins
Valid Range: 000 through 050
Description: The Number of G Coins entry tells the terminal how many G
denomination coins to dispense.
Number of H Coins
Valid Range: 000 through 050
Description: The Number of H Coins entry tells the terminal how many H
denomination coins to dispense.
5-164
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Card Reader Function Data entries is shown in Table 5-55.
The Card Reader Function Data directs the terminal to perform specific card
reader operations. The Operation entry in the Function Data determines which
operation the terminal performs.
Reserved 000
Reserved 000
Reserved 000
Reserved 000
The following paragraphs describe the fields for the Card Reader Function Data.
Unit Number
Valid Range: 001
Description: The unit number for the card reader Function Data must be 001.
Operation
Valid Range: 101 through 104, 106 through 107, and 109 through 112
Description: The Operation entry tells the terminal which operation to perform.
NOTE
For all writing operations (102, 111, and 112), the applicable
track data buffer must contain good track data (including both
the start sentinel and the end sentinel) obtained either from
a good read or from the most recently received Function
Command message.
5-165
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 101 - Read the card, wait for the operation to complete. The terminal
goes to the next operation specified in the message after the card reader
successfully reads the card.
• 102 - Write on track 3 of the card, wait for the operation to complete. The
terminal goes to the next operation specified in the message after the card
reader successfully writes and verifies the track 3 data.
• 103 - Return the card, wait for the consumer to remove the card. The
terminal goes to the next operation specified in the message after the
consumer takes the card.
• 104 - Retain or capture the card, wait for the operation to complete. The
terminal goes to the next operation specified in the message after the
card leaves the transport.
• 106 - Return the card, do not wait for removal. The terminal goes
immediately to the next operation specified in the message without waiting
for the consumer to remove the card.
• 107 - Return the card, wait for removal, capture the card if not removed.
The terminal goes to the next operation specified in the message after the
consumer takes the card or the card leaves the transport.
• 109 - Enables the card reader so that it can accept a card. After the card
is inserted, but before it is read, the terminal goes to the next operation
specified in the message. The reading of the card is performed while other
operations are being processed.
NOTE
• 110 - Wait until the card read started by operation 109 is completed. The
sequence of operation 109 and 110 is equivalent to operation 101.
• 111 - Write on track 1 of the card, wait for the operation to complete. The
terminal goes to the next operation specified in the message after the
card reader successfully writes and verifies the track 1 data or a fault is
encountered. This operation requires a card reader capable of writing on
track 1.
5-166
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 112 - Write on track 2 of the card, wait for the operation to complete. The
terminal goes to the next operation specified in the message after the
card reader successfully writes and verifies the track 2 data or a fault is
encountered. This operation requires a card reader capable of writing on
track 2.
• 113 - Enable card reader for read on insertion and do not lock. This
operation requires a dip smart card reader capable of reading on insertion.
When the card is inserted, it is not locked.
• 114 - Enable card reader for read on insertion and lock. This operation
requires a dip smart card reader capable of reading on insertion. When the
card is inserted, it is locked in the reader. This allows for multiple transaction
with one card insertion. The card can be released by using a card read state
or card read function, or by directing the state flow through a close state.
• 115 - Check the card reader sensors until the consumer response time
expires. This operation requires a dip smart card reader. If the sensors are
clear (no card in the reader) before the time expires, the terminal goes to
the good operation next state. If the sensors remain blocked and the time
expires, the terminal goes to the consumer fault next state.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen that
the terminal shows on the consumer display while the terminal is performing the
function. The valid values are as follows:
Read Conditions
Valid Range: 001 through 017
Description: If the Operation entry contains 101 (read the card), the Read
Conditions entry tells the terminal which card track(s) the terminal must read
correctly. The terminal must satisfy the Read Conditions before going to the next
operation. The valid values are as follows:
• 001 - 1 only
• 002 - 2 only
• 003 - 3 only
• 004 - 1 and 2
• 005 - 1 and 3
5-167
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 006 - 2 and 3
• 007 - 1 and 2 and 3
• 008 - 2 or 3
• 009 - 1 or 3
• 010 - 1 or 2
• 011 - 1 or 2 or 3
• 012 - 1 and (2 or 3)
• 013 - 2 and (1 or 3)
• 014 - 3 and (1 or 2)
• 015 - 1 or (2 and 3)
• 016 - 2 or (1 and 3)
• 017 - 3 or (1 and 2)
The word and specifies that the terminal must read all the indicated tracks
correctly. The word or specifies that the terminal must read only one of the
indicated tracks correctly.
For example, 1 and 2 and 3 indicates that the terminal must read tracks 1, 2, and
3, while a 1 or 2 or 3 indicates that the terminal assumes a successful operation if
any of the tracks are read correctly.
The terminal always attempts to read all the tracks. The Read conditions set up
the criteria by which the terminal determines a successful read operation.
5-168
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Bill Dispenser Function Data entries is shown in Table 5-56.
The Bill Dispenser Function Data directs the terminal to perform bill dispense
operations only, without delivering the bills to the consumer. The Operation entry
in the Function Data determines which operation the terminal performs. The
only valid value for the Operation entry is 101: perform a dispense operation,
transport the bills to the stacking position, and wait for the operation to complete.
NOTE
The network specifies the denominations and number of bills to dispense in the
Number of Bills entries. The total number of bills to be dispensed must not
exceed 50. For example, the network can specify 50 A bills only; or the network
can specify 25 A bills, 10 C bills, and 15 D bills.
The terminal must transport the bills to the stacking position before the dispense
operation is considered complete and the terminal can continue with function
processing. A terminal does not make denomination substitutions to complete a
dispense operation. In the case of a partial dispense, the terminal does not go to
the next operation when the dispense operation is complete. Instead, the terminal
sends the network a status message indicating what the terminal did and why the
terminal was not able to complete the dispense properly. The terminal then waits
for another Function Command message from the network.
Operation 101
The following paragraphs describe the fields for the Bill Dispenser Function Data.
5-169
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Unit Number
Valid Range: 001
Description: The unit number for the Bill Dispenser Function Data must be 001.
Operation
Valid Range: 101
Description: The Operation entry tells the terminal which operation to perform.
The only valid value for the bill dispenser is 101; perform a dispense operation,
transport the bills to the stacking position, and wait for the operation to complete.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen that
the terminal shows on the consumer display while the terminal is performing the
function. The valid values are as follows:
NOTE
Number of A Bills
Valid Range: 000 through 050
Description: The Number of A Bills entry tells the terminal how many A
denomination bills to dispense.
Number of B Bills
Valid Range: 000 through 050
Description: The Number of B Bills entry tells the terminal how many B
denomination bills to dispense.
Number of C Bills
Valid Range: 000 through 050
Description: The Number of C Bills entry tells the terminal how many C
denomination bills to dispense.
5-170
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Number of D Bills
Valid Range: 000 through 050
Description: The Number of D Bills entry tells the terminal how many D
denomination bills to dispense.
Number of E Bills
Valid Range: 000 through 050
Description: The Number of E Bills entry tells the terminal how many E
denomination bills to dispense.
Number of F Bills
Valid Range: 000 through 050
Description: The Number of F Bills entry tells the terminal how many F
denomination bills to dispense.
Number of G Bills
Valid Range: 000 through 050
Description: The Number of G Bills entry tells the terminal how many G
denomination bills to dispense.
Number of H Bills
Valid Range: 000 through 050
Description: The Number of H Bills entry tells the terminal how many H
denomination bills to dispense.
5-171
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Depositor Function Data entries is shown in Table 5-57. The
Depositor Function Data directs the terminal to perform deposit operations only.
The Operation entry in the Function Data determines which operation the
terminal performs. The only valid value for the Operation entry is 101: start the
deposit operation and wait for the consumer to insert a deposit envelope.
If the consumer does not insert a deposit envelope within the time specified by
the Consumer Response Time entry, the terminal shows the Do You Want
More Time? screen. If the consumer answers No to this screen, the terminal
sends the network a Timeout Status message. If the consumer answers Yes, the
terminal restarts the deposit operation.
The terminal activates a separate timer for the Do You Want More Time? screen.
This timer is part of the Special Screens configuration data that the network either
downloads with Write Command messages or updates with Function Command
messages. The timer is similar to a configured timer. For more information on
this timer and the Special Screens, refer to Section 4 and Section 5.
NOTE
Operation 101
The following paragraphs describe the fields for the Depositor Function Data.
5-172
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Group ID (Device ID) entry identifies the specific device
that the following function data is for. The only valid value for the envelope
depository is DP b/.
Unit Number
Valid Range: 001
Description: The unit number for the Depositor Function Data must be 001.
Operation
Valid Range: 101
Description: The Operation entry tells the terminal which operation to perform.
The only valid value for the envelope depository is 101; start the deposit
operation and wait for the consumer to insert a deposit envelope.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen that
the terminal shows on the consumer display while the terminal is performing the
function. The valid values are as follows:
Print Buffer ID
Valid Range: ’@’, and ’A’ through ’Z’
Description: The Print Buffer ID entry identifies the buffer that contains the data
that the terminal prints on the deposit envelope. The print data must be placed in
the buffer before the terminal begins processing the Depositor function data.
5-173
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Depositor Function Data entries is shown in Table 5-58.
The Operation entry in the Function Data determines which operation the
terminal performs.
Check Handling Delay Time [1] 000 - 255, 900 - 931, 999
The following paragraphs describe the fields for the Depositor Function Data.
Unit Number
Valid Range: 001
Description: The unit number for the Depositor Function Data must be 001.
Operation
Valid Range: 100 through 104
Description: The Operation entry tells the terminal which operation to perform.
The valid values for the IDM are as follows:
5-174
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 102 - Deposit check to escrow. This operation is intended to be the first step
of a check deposit. If there is no check or other document in escrow, the
terminal enables the IDM to perform the following operations:
- Read the MICR line as directed by the MICR Read Position Setting field
or the MICR search preference set in the Depositor device properties
• 103 - Retain check with printing. The terminal moves the check or other
document from the escrow position to the deposit bin specified in the
Deposit Bin ID field.
If there is data in the buffer specified by the Print Buffer ID field, the
terminal prints this data on the check or document. If there is no data in the
specified buffer, the terminal prints the default data (Section 3.11). If no
printing is desired, the specified buffer must contain at least one space.
• 104 - Return check with printing. The terminal moves the check or other
document from the escrow position to the entry slot of the depository, to
allow the consumer to retrieve the check or document.
If there is data in the buffer specified by the Print Buffer ID field, the
terminal prints this data on the check or document. If there is no data in the
specified buffer, the terminal prints the default data (Section 3.11). If no
printing is desired, the specified buffer must contain all spaces.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
5-175
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Screen Number field specifies the number of the screen that
the terminal shows on the consumer display while it is performing the function.
The valid values are as follows:
This field is used only with operations 101, 102, and 104. This field is not
used with operations 100 and 103.
Print Buffer ID
Valid Range: ’@’, and ’A’ through ’Z’
Description: The Print Buffer ID field identifies which buffer contains the data
that the terminal is to print on the deposit printer. The terminal prints the buffer
data only when the Operation field specifies an operation that includes printing.
Also, the print data must be placed in the buffer before the terminal begins
processing the Depositor function data.
MICR Buffer ID
Valid Range: ’@’, and ’A’ through ’Z’
Description: The MICR Buffer ID field identifies which buffer the terminal uses
to store MICR data read from the check.
Deposit Bin ID
Valid Range: 000 through 003 (subject to the capabilities of the depository)
Description: The deposit bin ID tells the terminal in which bin to place a
deposit if the terminal is equipped with an IDM. If the operation specified in
the Depositor function data is 100, this field should contain 000. If any of
the operations 101 through 104 are selected, the range for this value is 000
through 003.
Image Enable
Valid Range: 000, 001, 003, 005, and 007
5-176
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Image Enable field is applicable to operation 002 only. This
field determines which images, if any, are to be taken from the document. Valid
values are based on a bitmap whose bits are defined as follows:
• Bit 2:
• Bit 1:
• Bit 0:
For IDM operation, the value of bits 2 and 1 is ignored. Bit 0 must be set to
1 to perform document scanning. When bit 0 is set to 1, the IDM scans both
the top and the bottom of the document. When the specified operation includes
printing, the side of the document that is printed depends on the physical location
of the deposit printer, rather than the setting of bit 2.
5-177
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: This field is used to override the MICR search preference set in the
Depositor device properties. If this field is not included, the value defaults to
001. The valid values are as follows:
• 000 - Override the setting in the Depositor device properties. This entry
enables searching for MICR data on the right and left sides of the check. The
first attempt is made on the right edge of the check.
• 002 through 255 - The remaining values, that override the setting in the
Depositor device properties are created using the following bitmap:
5-178
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Dispenser Door Function Data entries is shown in Table 5-59.
The Dispenser Door function data directs the terminal to perform present,
retain, restore, and retract operations and to check withdrawal area sensors.
The Operation entry in the Function Data determines which operation the
terminal performs.
The following paragraphs describe each field in the Dispenser Door Function
Data.
Unit Number
Valid Range: 001
Description: The unit number for the Dispenser Door function data must be 001.
Operation
Valid Range: 101, 103, and 106 through 016
Description: The Operation entry tells the terminal which operation to perform
during the state. The valid values are as follows:
• 101 - Present and wait for the consumer to remove the bills. The terminal
goes to the next function in the message after detecting that the consumer
removed the bills within the timeout period (sensors cleared), the consumer
timeout expires and the sensors are still blocked, or a fault is encountered.
• 103 - Retain restore, or retract (as applicable), and do not wait. If the current
consumer’s cash is in escrow, the bill dispenser does nothing. If there is no
cash in escrow or in the presenting position, and the presenter is not in the
dispense-ready position, the bill dispenser performs a restore operation.
If there is abandoned cash in the presenting position and Auto Retract is
enabled (Presenter device properties), the bill dispenser moves the cash to
the retract bin. In all other cases, the bill dispenser dumps the cash. The
terminal goes immediately to the next function in the message.
• 105 - Check the withdrawal area sensors, wait for the operation to complete.
5-179
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 108 - Retain restore, or retract (as applicable), and do not wait. If the current
consumer’s cash is in escrow, the bill dispenser does nothing. If there is no
cash in escrow or in the presenting position, and the presenter is not in the
dispense-ready position, the bill dispenser performs a restore operation.
If there is abandoned cash in the presenting position and Auto Retract is
enabled (Presenter device properties), the bill dispenser moves the cash to
the retract bin. In all other cases, the bill dispenser dumps the cash.
• 109 - Present and wait for the operation to complete. The terminal goes to
the next function in the message after the present or a fault is encountered.
• 110 - Wait for consumer to remove bills. The terminal goes to the next
function in the message after detecting that the consumer removed the bills
within the timeout period (sensors cleared), the consumer timeout expires
and the sensors are still blocked, or a fault is encountered.
• 114 - Restore and do not wait for operation to complete. The terminal goes
immediately to the next function in the message.
• 115 - Retract and do not wait for operation to complete. The terminal goes
immediately to the next function in the message.
• 116 - Retain and do not wait for operation to complete. The terminal goes
immediately to the next function in the message.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
5-180
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
5.6.9 External Options Module (EX b/) Function Data for Signage Unit
The format of the Signage Unit Function Data entries is shown in Table 5-60.
The Signage Unit Function Data directs the terminal to perform specific
lighting operations. The Operation entry in the Function Data determines
which operation the terminal performs.
NOTE
Reserved 000
The following paragraphs describe each field in the Signage Unit Function Data.
Unit Number
Valid Range: 001
Description: The unit number for the signage unit function data must be 001.
Operation
Valid Range: 101 through 104
Description: The Operation entry tells the terminal which operation to perform
during the state. The valid values are as follows:
• 101 - Turn off the side panel light, turn on the green traffic light, and turn off
the red traffic light. Do not wait for the operation to complete. The terminal
goes immediately to the next function in the message.
• 102 - Turn off the side panel light, turn off the green traffic light, and turn on
the red traffic light. Do not wait for the operation to complete. The terminal
goes immediately to the next function in the message.
5-181
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 103 - Turn on the side panel light, turn on the green traffic light, and turn off
the red traffic light. Do not wait for the operation to complete. The terminal
goes immediately to the next function in the message.
• 104 - Turn off the side panel light, the turn off green traffic light, and turn on
the red traffic light. Do not wait for the operation to complete. The terminal
goes immediately to the next function in the message.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
Reserved
Valid Range: 000
Description: This field is reserved.
5-182
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
5.6.10 External Options Module (EX b/) Function Data for Solenoid Safe Lock
The format of the Solenoid Safe Lock Function Data entries is shown in
Table 5-61. The Solenoid Safe Lock Function Data directs the terminal to
perform specific solenoid safe lock operations. The Operation entry in the
Function Data determines which operation the terminal performs.
NOTE
The following paragraphs describe each field in the Solenoid Safe Lock
Function Data.
Unit Number
Valid Range: 002
Description: The unit number for the Solenoid Safe Lock Function Data
must be 002.
Operation
Valid Range: 101 through 102
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 101 - Unlock the solenoid safe lock. Do not wait for the operation to
complete. The terminal goes immediately to the next function in the message.
• 102 - Lock the solenoid safe lock. Do not wait for the operation to complete.
The terminal goes immediately to the next function in the message.
5-183
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
5-184
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Lamp Number
Valid Range: 000 through 255
Description: The Lamp Number entry tells the terminal for which lead-through
indicator the function data is specified. The valid values are as follows:
NOTE
If 100, automatic mode, is used, then the condition and flash rate values are
applied to future automatic lead-through operations.
5-185
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Condition
Valid Range: 000 through 002
Description: The Condition entry tells the terminal in which condition to put the
indicator. The valid values are as follows:
• 000 - Off
• 001 - On
• 002 - Flash
Time
Valid Range: 000 through 999
Description: The Time entry specifies the amount of time (in seconds) to wait
after turning on a light or flashing the indicator before turning off the indicator.
The value of 000 leaves the indicator on indefinitely.
Flash Rate
Valid Range: 001 through 255
Description: The Flash Rate entry specifies the rate at which to flash the
indicator. The flash rate is specified in the following manner:
Color
Valid Range: 000 through 002
Description: The Color entry specifies the indicator color affected by the
Condition entry. The indicator color is specified in the following manner:
• 000 - Green
• 001 - Red
• 002 - Yellow
This field is optional. If it is not included in the function data, the value defaults
to 000 (green).
5-186
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Data 001
The following paragraphs describe each field in the Multiple Functions Function
Data.
Data
Valid Range: 001
Description: The Data entry follows the device ID and must contain 001.
5-187
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
NOTE
5-188
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
5.6.14 Printer (PR b/) Function Data for the Receipt Printer
The format of the Printer Function Data entries for the receipt printer (or
statement printer emulating a receipt printer) is shown in Table 5-64. The Printer
Function Data directs the terminal to perform specific printer operations. The
Operation entry in the Function Data determines which operation the terminal
performs. Operation is also affected by whether the printer is equipped with an
exit sensor (that is, whether the printer is capable of detecting and reporting the
taking of the delivered document).
The following paragraphs describe each field in the Printer Function Data for
the receipt printer.
Unit Number
Valid Range: 001
Description: The unit number for the receipt printer function data must be 001.
Operation
Valid Range: 101 through 108
Description: The Operation entry tells the terminal which operation to perform.
If the receipt printer is not equipped with an exit sensor, the valid values are
as follows:
• 101 - Print the data on the consumer’s receipt. Do not wait for the operation
to complete. The terminal goes immediately to the next function in the
message.
• 102 - Deliver the printed form. Do not wait for the operation to complete.
The terminal goes immediately to the next function in the message.
5-189
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 103 - Deliver the printed form. Wait for the operation to complete. The
terminal goes to the next function in the message after delivery is completed
or a fault is encountered.
• 104 - Print the data on the consumer’s receipt. Wait for the operation to
complete. The terminal goes to the next function in the message after the
printer successfully prints all the data or a fault is encountered.
If the receipt printer is equipped with an exit sensor, the valid values are
as follows:
• 101 - Print the data on the consumer’s receipt. Do not wait for the operation
to complete. The terminal immediately goes to the next function specified in
the message.
If the print data contains a form feed control character (0C hex), and the
receipt is not taken before the time specified in the Consumer Response
Time entry expires, the terminal retains or dumps the receipt (if the printer
has that capability). If a receipt is retained or dumped due to a timeout, the
terminal sends the network an unsolicited status indicating an automatic
document retain.
If the Consumer Response Time entry is 000, the terminal uses timer 21
instead. If the value of timer 21 is also 000 (timer 21’s default value), the
terminal does not automatically retain the receipt.
• 102 - Deliver the printed form. Do not wait for the operation to complete.
The terminal immediately goes to the next function specified in the message.
If the receipt is not taken before the time specified in the Consumer
Response Time entry expires, the terminal retains or dumps the receipt (if
the printer has that capability). If a receipt is retained or dumped due to a
timeout, the terminal sends the network an unsolicited status indicating an
automatic document retain.
If the Consumer Response Time entry is 000, the terminal uses timer 21
instead. If the value of timer 21 is also 000 (timer 21’s default value), the
terminal does not automatically retain the receipt.
• 103 - Deliver the printed form. Wait for the operation to complete. The
terminal goes to the next function specified in the message after the
consumer has taken the delivered form or if there is no form to be delivered.
If the receipt is not taken before the time specified in the Consumer
Response Time entry expires, the terminal sends the network a solicited
status indicating a consumer timeout. The terminal does not automatically
retain the receipt.
If the Consumer Response Time entry is 000, the terminal goes to the next
function specified in the message immediately after delivering the receipt.
The terminal does not wait for the consumer to take the receipt.
5-190
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
• 104 - Print the data on the consumer’s receipt. Wait for the operation to
complete. The terminal goes to the next function specified in the message
after all data has been printed.
If the print data contains a form feed control character (0C hex), the
terminal delivers the receipt before going to the next function specified in
the message, but the terminal does not wait for the consumer to take the
receipt. If the receipt is not taken, the terminal does not automatically
retain the receipt.
• 105 - Retain the receipt that is still in the delivery position, wait for the
operation to complete. The terminal goes to the next function specified in
the message after the printer has successfully retained the form.
• 106 - Retain the receipt that is still in the delivery position, do not wait for
the operation to complete. The terminal immediately goes to the next
function specified in the message.
• 107 - Retain the receipt that is still in the delivery position, wait for the
operation to complete. complete. The terminal goes to the next function
specified in the message after the printer has successfully dumped the form.
• 108 - Retain the receipt that is still in the delivery position, do not wait for
the operation to complete. The terminal immediately goes to the next
function specified in the message.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
This entry is used only with printers equipped with an exit sensor, and only with
operations 001, 002, and 003. If the printer has no exit sensor, or if the operation
is not 001, 002, or 003, this entry is not used and must be 000.
5-191
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
- Operations 001 and 002 - Use timer 21 (If the value of timer 21 is 000, the
terminal does not automatically retain the receipt.)
Print Buffer ID
Valid Range: ’@’, ’A’ through ’Z’, and 256 through 355
Description: The Print Buffer ID entry identifies which buffer contains the
data that the terminal prints on the receipt printer. The terminal prints the
buffer data only when the Operation entry specifies a print operation (operation
101 or 104). The print data must be placed in this buffer before the terminal
processes the Printer function ID.
This entry is used only with printers equipped with an exit sensor, and only with
operations 101 and 102. If the printer has no exit sensor, or if the operation is not
101 or 102, this entry is not used and must be 000.
5-192
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
5.6.15 Printer (PR b/) Function Data for the Journal Printer
The format of the Printer Function Data entries for the journal printer is shown in
Table 5-65. The Printer Function Data directs the terminal to perform specific
journal printer operations. The Operation entry in the Function Data determines
which operation the terminal performs.
The following paragraphs describe each field in the Printer Function Data for
the journal printer.
Unit Number
Valid Range: 002
Description: The unit number for the journal printer function data must be 002.
Operation
Valid Range: 101 and 104
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 101 - Print the data on the journal printer’s audit roll, do not wait for
the operation to complete. The terminal goes immediately to the next
function in the message.
• 104 - Print the data on the journal printer’s audit roll, wait for the operation
to complete. The terminal goes to the next function in the message after the
printer successfully prints all the data or a fault is encountered.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
5-193
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Print Buffer ID
Valid Range: ’@’, ’A’ through ’Z’, 256 through 355
Description: The Print Buffer ID entry identifies the buffer that contains the data
that the terminal prints on the journal printer. The network must fill the buffer
with data before sending the journal printer function data.
5-194
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
5.6.16 Printer (PR b/) Function Data for Electronic Data Capture
The format of the Printer Function Data entries for Electronic Data Capture
(EDC) is shown in Table 5-66. The Function Data directs the terminal to
perform specific electronic journaling operations. The Operation entry in the
Function Data determines which operation the terminal performs.
The following paragraphs describe each field in the Function Data for EDC.
Unit Number
Valid Range: 003
Description: The unit number for the EDC function data must be 003.
Operation
Valid Range: 101 and 104
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 101 - Print the data on the EDC device, do not wait for the operation to
complete. The terminal goes immediately to the next function in the message.
• 104 - Print the data on the EDC device, wait for the operation to complete.
The terminal goes to the next function in the message after the printer
successfully prints all the data or a fault is encountered.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
5-195
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Consumer Response Time entry defines the amount of time
that the terminal waits for the consumer to respond to the screen shown on the
consumer display. If this time expires before the consumer responds to the
screen, the terminal goes to the exit state identified by the Consumer Fault Next
State entry. The valid values for this entry are as follows:
Print Buffer ID
Valid Range: ’@’, ’A’ through ’Z’, 256 through 355
Description: The Print Buffer ID entry identifies the buffer that contains the data
that the terminal prints on the EDC device. The network must fill the buffer
with data before sending the EDC function data.
5-196
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Statement Printer Function Data entries is shown in Table 5-67.
The Statement Printer Function Data directs the terminal to perform specific
printer operations. The Operation entry in the Function Data determines which
operation the terminal performs.
Reserved 000
The following paragraphs describe each field in the Statement Printer Function
Data.
Unit Number
Valid Range: 001
Description: The unit number for the Statement Printer Function Data must be
001.
Operation
Valid Range: 001 through 008
5-197
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Description: The Operation entry tells the terminal which operation to perform.
The valid values are as follows:
• 001 - Print the data on the statement. Do not wait for the operation to
complete. The terminal goes immediately to the next function in the
message. If a fault occurs during the operation, the terminal sends the
network an unsolicited status.
• 002 - Deliver the printed statement. Do not wait for the operation to
complete. The terminal goes immediately to the next function in the
message. If a fault occurs during the operation, the terminal sends the
network an unsolicited status.
If the statement is not taken before the time specified in the Consumer
Response Time entry expires, the terminal retains or dumps the statement
(if the statement printer has that capability). If a statement is retained or
dumped due to a timeout, the terminal sends the network an unsolicited
status indicating an automatic document retain.
• 003 - Deliver the printed statement. Wait for the operation to complete. The
terminal goes to the next function in the message after the consumer has
taken the delivered statement or if there is no statement to be delivered. If a
fault occurs during the operation, the terminal sends the network a solicited
status, then waits for the next Function Command message.
If the statement is not taken before the time specified in the Consumer
Response Time entry expires, the terminal sends the network a solicited
status indicating a consumer timeout, then waits for the next Function
Command message. The terminal does not automatically retain the
statement.
• 004 - Print the data on the statement. Wait for the operation to complete.
The terminal goes to the next function in the message after the printer
successfully prints all the data. If a fault occurs during the operation,
the terminal sends the network a solicited status, then waits for the next
Function Command message.
• 005 - Reserved.
• 006 - Reserved
• 007 - Retain the statement that is still in the delivery position. Wait for the
operation to complete. The terminal goes to the next function in the message
after the printer successfully dumps the statement. If a fault occurs during
the operation, the terminal sends the network a solicited status, then waits for
the next Function Command message.
• 008 - Retain the statement that is still in the delivery position. Do not wait
for the operation to complete. The terminal goes immediately to the next
function in the message. If a fault occurs during the operation, the terminal
sends the network an unsolicited status.
5-198
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
Print Data ID
Valid Range: ’@’, ’A’ through ’Z’, and 256 through 355
Description: The Print Data ID entry identifies the location of the print data. The
meaning of this value depends on the Print Data Type entry. This entry is only
used for operations 001 and 004. All other operations ignore this field.
• 000 - The print data is in an Agilis 91x for ix/CSP buffer. The value in the
Print Data ID entry is the buffer ID of the buffer containing the print data.
The print data in the buffer is in expanded ASCII format.
• 001 - The print data is stored in a file. The value in Print Data ID entry is the
buffer ID of the buffer containing the path and file name of the file. The path
and file name in the buffer must be a fully qualified path and file name.
Example - If the value in the Print Data ID entry is ’Z’, the terminal prints
the data in the file: c:\DIEBOLD\TCS\sp\SPDATA_Z.TXT.
• 003 - The print data is stored in an Agilis 91x for ix/CSP buffer. The value in
the Print Data ID entry is the buffer ID of the buffer containing the print
data. The print data in the buffer is in normal (non-expanded) ASCII format.
Reserved
Valid Range: 000
Description: This field is reserved.
5-199
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
This entry is only used for print operation 002 (deliver and do not wait).
5-200
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
The format of the Do Nothing Function Data entries is shown in Table 5-68. The
Do Nothing Function Data tells the terminal to display a screen to the consumer
without performing a device function.
For example, the network can use a Do Nothing Perform Function to exit
a Transaction Request state after receiving a Solicited Device Status message
from the terminal.
The network can also use a Do Nothing Perform Function simply to show a screen
for a specified length of time. For example, the network has the terminal show a
PLEASE TAKE YOUR CASH screen for 10 ticks after a dispense operation.
The Screen Wait Time entry contains the amount of time that the terminal shows
the screen before going to the next operation specified in the message.
The following paragraphs describe each field in the Do Nothing Function Data.
Screen Number
Valid Range: Valid screen numbers (Section 4.6)
Description: The Screen Number entry specifies the number of the screen
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:
5-201
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Operational Command Message
This message is transmitted by the network to start up or shut down the terminal,
or to request a configuration ID. Table 5-69 shows the format of the Operational
Command message used.
Startup
When the terminal is powered down, all the configuration data is erased from
the terminal memory. This erasing of the terminal memory requires a startup
sequence that loads the necessary configuration data in pre-selected memory
locations to enable the terminal to go into service.
The Startup command also can put the terminal into service after shutdown or
exit from maintenance mode.
Shutdown
This is an Operational Command message from the network that places the
terminal temporarily Out-of-service. All pending messages are sent, and current
transactions completed, before the terminal executes the shutdown. The terminal
then indicates that it has successfully completed the shutdown procedures by
sending a Ready status in a Solicited Status message.
5-202
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Operational Command Message
[ Response Flag ] [ X ] [ 1 ]
Command Code - - - 1
Message ID
Field Size: 1 character
Valid Range: 1
Description: This one-character data field defines the type of message being
transmitted. The only valid value is 1, Consumer Request message or Operational
Command message
5-203
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Operational Command Message
Command Code
Field Size: 1 character
Valid Range: Refer to the description
Description: This one-character field is used to identify the type of command.
The valid values for this field are as follows:
5-204
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Operational Command Message
Authorization, by itself, does not cause the terminal to unlock the solenoid
safe lock. Once unlocking is authorized, the operator must unlock the
solenoid safe lock by selecting the applicable command from the Supply
menu. The operator then uses the manual combination lock to open the
safe door.
An authorization to unlock the solenoid safe lock is valid only when the
terminal is in the Maintenance mode. The authorization remains valid until
the operator exits the Maintenance mode.
• ’9’ - Retrieve Supply counts (refer to Section 5.2.17 for a list of the supply
counts).
• ’ < ’ - Retrieve and Set or Clear Enhanced Supply counts. To set and
clear counts, you must send additional fields in the Operational Command
message. The format of the message with the additional fields included is
shown in Table 5-70 and described in Section 5.8.
5-205
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Operational Command Message
• ’J’ - Initiate remote key transport . The terminal responds with a Solicited
Status message containing a random number generated by the EPP.
• ’K’ - Request the terminal’s EPP certificate . The terminal responds with
a Solicited Status message containing the terminal’s EPP certificate. The
type of certificate is indicated in the Data field.
NOTE
Command codes ’J’ and ’K’ are used by the Remote Key
Transport feature . For detailed information about this feature,
refer to the Data Security Procedures and Reference Manual
(TP-799530-001D).
Data
Field Size: Variable
Valid Range: Refer to the description
Description: The Data field is an optional field included only if the command
code requires additional data. The command codes that require additional
data are as follows:
• ’K’ - Request the terminal’s EPP certificate. The Data field contains one of
the following values to indicate which certificate the terminal is to send:
Status Flag
Field Size: 1 character
Valid Range: 0 and 1
5-206
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Operational Command Message
Description: The Status Flag field is an optional field included only if the
network is requesting an individual device self test. The valid values of this
field are as follows:
Device Name
Field Size: 4 characters
Valid Range: Refer to the description
Description: The Device Name field is an optional field included only if the
network is requesting an individual device self test. If this field is not included,
then all devices are tested. This field can be repeated for as many devices as
desired. The valid values of this field are as follows:
NOTE
NOTE
5-207
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
Groups of device fields are shown by the boxed in areas in Table 5-70. Each of
these boxed in areas are optional. If a particular device is included as part of
the message, then the Device ID fields, their associated fields, and any group
separators associated with a particular Device ID field must be included and
must appear in the order shown. If a particular Device ID field is not included, its
associated group separators need not be included.
Table 5-70 Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
[ Response Flag ] [ X ] [ 1 ]
5-208
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
Table 5-70 Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
(continued)
5-209
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
Table 5-70 Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
(continued)
The following paragraphs describe the fields different from the standard
Operational Command message.
Device ID
Field Size: 4 characters
Valid Range: DP01
Description: This is a four-character field that indicates the following
information affects the depository.
Device ID
Field Size: 4 characters
Valid Range: CR01
Description: This is a four-character field that indicates the following
information affects the card reader.
Device ID
Field Size: 4 characters
Valid Range: DI01
Description: This is a four-character field that indicates the following
information affects the bill dispenser.
5-210
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
Loaded Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Loaded Count fields load counter information into the Loaded
counters for each dispense position. The Loaded counters record the number
of bills loaded at each dispense position. Typically, these counts are set when
the cassettes are loaded in each position. These counts do not change as bills
are dispensed.
Dispense Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Dispense Count fields load counter information into the
dispense counters for each dispense position. The dispense counters keep
track of the number of bills successfully delivered to the consumer from each
dispense position. To clear the dispense counters, the network must send 00000
in each of the Dispense Count fields.
Divert1 Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Divert1 Count fields load counter information into the Divert1
counters for each dispense position. The Divert1 counters keep track of bills
known to have been either dumped or diverted from each dispense position
during a consumer transaction because of a mispick or a recovery attempt. To
clear the Divert1 counters, the network must send 00000 in each of the Divert1
Count fields.
Divert2 Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Divert2 Count fields load counter information into the Divert2
counters for each dispense position. The Divert2 counters keep track of bills
known to have been either dumped or diverted from each dispense position during
maintenance or as the result of a network commanded dump. To clear the Divert2
counters, the network must send 00000 in each of the Divert2 Count fields.
Retract Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Retract Count fields load counter information into the Retract
counters for each dispense position. The Retract counters keep track of bills that
were accessible to the consumer but might not have been taken, and something
was retracted and dumped. To clear the Retract counters, the network must send
00000 in each of the Retract Count fields.
Device ID
Field Size: 4 characters
Valid Range: CN01
Description: This field indicates that the following information affects the
coin dispenser.
Loaded Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Loaded Count fields load counter information into the
Loaded counters for each dispense position. The Loaded counters record the
5-211
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
number of coins loaded at each dispense position. Typically, these counts are
set when the coins are loaded in each position. These counts do not change as
coins are dispensed.
Dispense Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Dispense Count fields load counter information into the
dispense counters for each dispense position. The dispense counters keep
track of the number of coins successfully delivered to the consumer from each
dispense position. To clear the dispense counters, the network must send 00000
in each of the Dispense Count fields.
Device ID
Field Size: 4 characters
Valid Range: AH01
Description: This is a four-character field that indicates the following
information affects the After Hour depository.
Device ID
Field Size: 4 characters
Valid Range: SD01
Description: This is a four-character field that indicates the following
information affects the envelope dispenser.
Loaded Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Loaded Count field loads counter information into the Loaded
counter for the envelope dispenser. The Loaded Count keeps track of the number
of envelopes loaded in the envelope dispenser. This count is ordinarily set when
the envelopes are loaded. The Loaded Count does not change as envelopes are
dispensed from the envelope dispenser.
Dispense Count
Field Size: 5 characters
Valid Range: 00000 through 65535
Description: The Dispense Count field loads counter information into the
dispense counter for the envelope dispenser. The dispense counter keeps track
of the number of envelopes successfully delivered to the consumer from the
envelope dispenser. To clear the dispense counter, the network must send
00000 in the Dispense Count field.
5-212
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Operational Command Message
[ Response Flag ] [ X ] [ 1 ]
The following paragraphs describe the fields different from the standard
Operational Command message.
Command Code
Field Size: 3 characters
Valid Range: 025
Description: This three-character field is used to identify the type of command.
The only valid value for this field is 025, Get/set Time/date.
Data Identifier
Field Size: 2 characters
Valid Range: Refer to the description
Description: The Data Identifier field contains the code indicating which action
the command should take. The valid values are as follows:
5-213
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Enhanced Operational Command Message
Command Data
Field Size: Variable
Valid Range: Refer to the description
Description: The Command Data field contains the necessary data for each
action that can be performed. The valid values for this field are as follows:
• If the Data Identifier is SD (set date and time), this field contains 12
characters in the format of YYYYMMDDHHMM, defined as follows:
• If the Data Identifier is GD (get date and time), this field contains a
three-character response buffer ID. The valid range for this buffer ID is 064
through 090, and 256 through 355. However, some of the buffers in these
ranges are reserved by the system. For a list of the buffers and their uses,
refer to Section 4.1. The response sent back to the network is in the format
of YYYYMMDDHHMM, as defined in the previous paragraph. The buffer
ID and the data is appended to a Solicited Status message.
5-214
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 5 Message (Open Account Relationship [OAR] screens)
This message writes OAR screen configuration data to the terminal screen during
transactions. All OAR screen data is transmitted in one message. After this Write
Command 5 Message, the terminal waits for a consumer response or a timeout.
When a function key or the Cancel key is pressed or the screen timer expires, the
terminal responds with a Consumer Request message. The Consumer Request
messages contains general purpose buffer B information. Figure 5-2 illustrates
the message sequence. Table 5-72 shows the Write Command 5 Message formats.
[ Response Flag ] [ X ] [ 1 ]
Display Flag - - - 1
[ Options ] [2] [ - - - ] [ 3 ]
Screen Timer - - - 3
The following paragraphs describe the fields in the Write Command 5 message.
5-215
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 5 Message (Open Account Relationship [OAR] screens)
Message ID
Field Size: 1 character
Valid Range: 3
Description: This one-character data field defines the type of message being
transmitted. The only valid value for the Write Command 5 message is 3.
Write Identifier
Field Size: 1 character
Valid Range: 2
Description: This one-character data field tells the terminal that OAR screen
data follows. The valid value is ’2’.
Display Flag
Field Size: 1 character
Valid Range: 0 through 4
Description: This one-character field directs the terminal display as follows:
• ’3’ - Use the Format Template specified in the three characters that follow
the Display Flag field in the OAR Write Command 5 message.
The keyed response is stored in General Purpose Buffer B for later transmission
in a Consumer Request message.
Format Template
Field Size: 3 characters
Valid Range: 001 through 099
5-216
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 5 Message (Open Account Relationship [OAR] screens)
Options
Field Size: 3 characters
Valid Range: 000 through 003
Description: This three-character Options field is only included if the Display
Flag field is 4. The Options field is a bit-mapped field. Add the bit-mapped
option values together to select more than one option. The option values are
defined as follows:
• 001 - Want more time enabled. This setting allows the ’DO YOU WANT
MORE TIME’ screen to be displayed if the user fails to enter data in the
amount of time between each key as defined by timer 00.
Active Keys
Field Size: Up to 14 characters
Valid Range: 0 and 1
Description: This field either activates or deactivates keypad keys for consumer
responses. This field can contain 6, 10 or 14 characters, depending on the number
of function keys on the terminal. A graphic 0 deactivates, while a graphic 1
activates, the selected key(s) as follows:
NOTE
5-217
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 5 Message (Open Account Relationship [OAR] screens)
Screen Timer
Field Size: 3 characters
Valid Range: 000 through 255
Description: This three-character field determines the timeout intervals for the
consumer display. Graphic characters represent 001 to 255 800-millisecond ticks
to give a timeout range from 0.8 to 204 seconds. If the terminal timed out
waiting for the consumer to respond (by means of keypad entry) to a screen
command, the last character in General Purpose Buffer B is T. Entering 000
gives an infinite display time.
Screen Data
Field Size: Variable
Valid Range:
Description: This is a variable-length field that represents data to be displayed
on the consumer display.
5-218
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Write Command 5 Message (Open Account Relationship [OAR] screens)
g1959062
5-219
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Common Command Reject Conditions
• End of text field was found within three field separators of the Write
Command field.
• Three-byte graphic decimal field (for example, state table data) is out of
range (000 - 511).
• End of text field or a field separator was in the transaction serial number
field.
• Field separators do not follow the Next State ID field and the Screen
Display Update field.
• Message coordination number field was not the number issued by the
terminal and not a ’0’.
• Printer Flag field was not ’0’, ’1’, ’2’, ’3’, or ’;’.
• Write Command message other than OAR was received while the
terminal was in-service and following configuration option is set to reject
Write Commands while In-service (Transaction Host, Message Settings,
Command Message, Write Commands while In Service).
• Write Command Modifier field was not ’1’ through ’6’, ’:’, ’<’, ’=’,
’@’, or ’>’.
• Field Separator and a FIT number were not between FIT table data in a
Write Command 6 (FIT data) message that contains multiple FIT entries.
5-220
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Common Command Reject Conditions
• There was not enough available terminal memory to accommodate all data in
a Write Command 2 (screen data) or Write Command 6 (FIT data) message.
• The Active Keys field in the Write Command 5 (Open Account Relationship)
message contains an End of Text code or a Field Separator.
• The terminal is in the In-service mode, but not in the Transaction Request
state.
• The terminal does not have enough available memory to store all the
downloaded data.
• The terminal received a Function Command message when the terminal was
not in the Transaction Request state.
• The terminal received a message coordination number that was not 0 or the
number issued by the terminal in the Consumer Request message.
• The terminal attempted to operate a single device twice in the same Function
Command message. For example, the terminal sends a Solicited Status
message containing a general command reject status if the network sends
function identifiers ’D’ and ’H’ (for two prints) in the same Function
Command message.
5-221
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Common Command Reject Conditions
g1959064
5-222
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Appendix A
ASCII-to-EBCDIC Code Conversion Chart
Graphic ASCII (Hex) EBCDIC (Hex) Graphic ASCII (Hex) EBCDIC (Hex)
NUL 00 00 Space 20 40
SOH 01 01 ! 21 4F [1]
STX 02 02 " 22 7F
ETX 03 03 # 23 7B
EOT 04 37 $ 24 5B
ENQ 05 2D % 25 6C
ACK 06 2E & 26 50
BEL 07 2F ’ 27 7D
BS 08 16 ( 28 4D
HT 09 05 ) 29 5D
LF 0A 25 * 2A 5C
VT 0B 0B + 2B 4E
FF 0C 0C , 2C 6B
CR 0D 0D - 2D 60
SO 0E 0E . 2E 4B
SI 0F 0F / 2F 61
DLE 10 10 0 30 F0
DC1 11 11 1 31 F1
DC2 12 12 2 32 F2
DC3 13 13 3 33 F3
DC4 14 3C 4 34 F4
NAK 15 3D 5 35 F5
SYN 16 32 6 36 F6
ETB 17 26 7 37 F7
CAN 18 18 8 38 F8
EM 19 19 9 39 F9
SUB 1A 3F : 3A 7A
ESC 1B 27 ; 3B 5E
FS 1C 1C < 3C 4C
GS 1D 1D = 3D 7E
RS 1E 1E > 3E 6E
US 1F 1F ? 3F 6F
[1] This cross-reference uses Diebold’s implementation of EBCDIC. The characters noted differ from the standard IBM EBCDIC
characters.
A-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
ASCII-to-EBCDIC Code Conversion Chart
Graphic ASCII (Hex) EBCDIC (Hex) Graphic ASCII (Hex) EBCDIC (Hex)
@ 40 7C ’ 60 Undefined
A 41 C1 a 61 81
B 42 C2 b 62 82
C 43 C3 c 63 83
D 44 C4 d 64 84
E 45 C5 e 65 85
F 46 C6 f 66 86
G 47 C7 g 67 87
H 48 C8 h 68 88
I 49 C9 i 69 89
J 4A D1 j 6A 91
K 4B D2 k 6B 92
L 4C D3 l 6C 93
M 4D D4 m 6D 94
N 4E D5 n 6E 95
O 4F D6 o 6F 96
P 50 D7 p 70 97
Q 51 D8 q 71 98
R 52 D9 r 72 99
S 53 E2 s 73 A2
T 54 E3 t 74 A3
U 55 E4 u 75 A4
V 56 E5 v 76 A5
W 57 E6 w 77 A6
X 58 E7 x 78 A7
Y 59 E8 y 79 A8
Z 5A E9 z 7A A9
[ 5B 4A [1] { 7B C0
\ 5C 6A [1] | 7C 80
] 5D 5A [1] } 7D D0
^ 5E 5F [1] ~ 7E A1
_ 5F 6D DEL 7F 07
[1] This cross-reference uses Diebold’s implementation of EBCDIC. The characters noted differ from the standard IBM EBCDIC
characters.
A-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Appendix B
Network Integration for Check and Coin Processing
This appendix contains flow diagrams for programmers who need to integrate the
IDM and coin dispenser into their ATM network. The logic flow described is a
suggested method and is intended to be used as a model for implementation.
Figure B-1 provides the legend for the remaining diagrams. The flow diagrams
are shown in Figure B-2 through Figure B-6.
g1959065
B-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Network Integration for Check and Coin Processing
g1959066
B-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Network Integration for Check and Coin Processing
g1959067
Figure B-3 Check Deposit with Cash Back Transaction Flow Diagram
B-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Network Integration for Check and Coin Processing
g1959068
Figure B-4 Cash Check and Deposit Check Transaction Flow Diagram
B-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Network Integration for Check and Coin Processing
g1959069
B-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Network Integration for Check and Coin Processing
g1959070
B-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Network Integration for Check and Coin Processing
g1959071
B-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Appendix C
Application Notes
This appendix contains application notes for various features available with
Agilis 91x for ix/CSP. These notes describe the feature, hardware and software
requirements for the feature, how to implement the feature, why you might want
to use the feature, and provide some use cases for the feature.
This section contains general operation guidelines for operating Diebold ATMs.
The host should not allow withdrawals when the chest door (safe door) is open.
The Transaction Verification Status feature enables the terminal to store and send
the transaction status for the previously received function command. This status
information is stored in a buffer and is included as a part of the Consumer Request
message. The following items are included as a part of this status information:
The Media Player feature provides the capabilities of playing MPEG files on
an ATM. These MPEGs can be used to provide information to the consumer,
provide an advertising vehicle, or as an entertainment vehicle.
The following software and hardware is necessary for the Media Player feature:
These are the minimum requirements for the Media Player feature.
C-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
This section provides some instructions and examples on how to make the media
player work on your ATM. MPEG files can be played by either referencing
individual MPEG files in screen data or by referencing a channel file in the
screen data. A channel file can contain up to three MPEG references that are
played in the order that they are listed in the channel file.
An example of screen data with an embedded MPEG file is as follows (note that
comments are contained in parentheses and are not a part of the screen data):
FS
C-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
A Media Channel is defined as a text file that has a.chn extension. A channel can
contain up to three references to MPEG files. This ability allows the flexibility of
being able to change the MPEG files within the channel without having to change
the screen data. The screen data can continue to reference the same channel
file while the actual files within the channel are changed. The format of the
channel file is ASCII and follows the same MPEG file specification requirements
outlined in the ESC ZU "MPEGPLAY" sequence (Section 4.7.39) for the Media
Player. Playing channels at the ATM is very similiar to playing MPEG files. You
must make a reference to a channel file in a screen. The format is identical to
MPEG files except that you can only have one channel file referenced in the ESC
ZU sequence and the channel file reference must end in .chn.
The channel file must exist somewhere in the media player search
path (TCSMEDIAPATH). The default location for the search path is
c:\DIEBOLD\TCS\movies. You can put channel files in this location or add
your own path to the default path and put them there. Within the channel file
the first line contains a reference to MPEG file(s) in the same format used in
screen data (e.g. mpeg1.mpg+mpeg2.mpg+mpeg3.mpg). There can be up to 3
MPEG references in the channel file.
Using Channels to play MPEG content allows the flexibility to establish the
MPEG file names used at the ATM independent of the host states and screens.
Specific Channels must be defined to identify categories of content and delivery
mechanisms at the ATM. Established channels can be loaded or altered with new
MPEG file references. New channels can be defined and deployed as required.
• Channel used for attraction to the ATM (card read welcome state).
C-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
• The ATM must have a reliable source of data for determining when to stop
searching for file references made in screen libraries (MPEG files and
Channel files). The target searched must be fully reliable over time with
no interruptions.
• Once the target file (or semaphore) is found, access to an MPEG file must
be immediate or nearly immediate. Agilis 91x for ix/CSP cannot tolerate
waiting for an MPEG file to be copied to a target file. This delay would
present excessive delay (or timeouts) to the consumer.
• During the brief time that the MPEG file might not be present in the file
system during a MPEG update, the semaphore serves as a placeholder to
allow the search algorithm at the ATM to end.
This call returns a sharing violation error if the semaphore is currently locked
by another application. The application retries for a reasonable period of time
before giving up and logging an exception. The retry time on the system must
be greater than the length of play time for the MPEG file since Agilis 91x for
ix/CSP locks the semaphore the entire time (with minimal padding) the MPEG is
being played. Once the MPEG file operation is complete, the application must
unlock the semaphore by closing the semaphore file.
C-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
For example, when the MPEG file referenced below is being operated upon,
the semaphore file must be locked (open) the entire time that the application is
performing the operation.
Any application (or utility) that needs to operate on an MPEG file must first
attempt to lock (open) a semaphore at the same location as the MPEG file. If the
semaphore cannot be locked, the underlying MPEG file might not be accessed.
Semaphore Cleanup
The semaphore file can remain in the file system as long as the underlying
MPEG file is intended at the location. To allow the Agilis 91x for ix/CSP search
algorithm to operate properly, the semaphore file must always be deleted from
the file system if the underlying MPEG file is no longer required (deleted
for future use).
NOTE
C-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
FirstMPEGReferenceLine
SecondMPEGReferenceLine
ThirdMPEGReferenceLine
...
...
LastMPEGReferenceLine
NOTE
4. A Buffer Compare state (@E b/) can be used to verify that the courtesy
amount data returned by the Image Character Recognition state is valid
data.
C-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
If the courtesy amount image is required for printing on the receipt (using the
ESC R control sequence), the Courtesy Amount window (window 1-1-1) must be
specified last in the Image Character Recognition state data.
Because the preceding Image Character Recognition state has specified the
MICR window for character recognition, during the deposit to escrow operation,
the Recognition Subsystem (RSS) automatically reads the MICR line and
places the MICR data in buffer W.
Even though the MICR window must be enabled in the first Image Character
Recognition state, the second Image Character Recognition state does not need
not specify the MICR window for reading, because the preceding Depositor
state or function has already read the MICR line.
If more than one window is enabled in the first Image Character Recognition
state, you can optionally use multiple Image Character Recognition states to read
the individual document fields. Using a separate Image Character Recognition
state to read each document field allows you to determine which document field
caused a problem, if a problem does occur.
Valid courtesy amount data consists of all decimal digits (0 through 9), with
no decimal point or currency symbol. If the RSS cannot identify a given
character, the RSS places the ^ symbol (ASCII hex 5E) in the buffer to mark the
unidentified character. The Buffer Compare state specifying a compare mode of
001 (compare as ASCII decimal) can be used to compare the courtesy amount
buffer to itself. If the buffer contains only valid data (decimal digits), the
terminal takes the Buffer_1 = Buffer_2 exit. If the buffer contains one or more ^
symbols, the terminal takes the Compare Error exit.
C-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
EXAMPLE
1. The following Image Character Recognition state data directs the terminal
to enable windows for the MICR and Courtesy Amount document fields:
260 ICb
/ 000 000 261 053 053 001 001 002 074 001 075
2. The following Depositor state data directs the terminal to accept and scan
a deposited document.
261 DPb
/ 001 002 103 020 262 020 053 053 000 087 000
001 113 000 025 262 166 020 124 001 225 180
3. The following Image Character Recognition state data directs the terminal
to read the MICR and Courtesy Amount fields
262 ICb
/ 001 000 264 158 126 001 001 002 074 001 075
Or the read operations for the MICR field and the Courtesy Amount field
can be handled separately, using the following two Image Character
Recognition states in place of the previous one:
262 ICb
/ 001 000 263 158 126 001 001 002 074
263 ICb
/ 001 000 264 158 126 001 001 001 075
4. The following Buffer Compare state data directs the terminal to check the
courtesy amount buffer for valid characters.
264 @Eb
/ 001 075 001 075 001 265 266 265 265
Euro support is provided in Agilis 91x for ix/CSP. This is display and print
capability support.
Display Support
Euro character support is provided in systems using Character Generator
Emulation (CGE), Color Graphics Feature (CGF), and VGA Plus. Enhanced
Monochrome Graphics (EMG) is not currently in the supported group of video
modes. However, EMG allows for downloadable characters. This method can be
used to display a euro character on ATMs running EMG.
The Euro character is at position hex 7F in each of the following font libraries:
C-8
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
Printer Support
Agilis 91x for ix/CSP provides consistent euro character support for all printers
configured for any graphics-related strategy. The euro character is at hex 7F
(ASCII) of the Standard English character set, which is supplied with the
standard Agilis 91x for ix/CSP system.
The purpose of this section is to describe how transaction data is made available
to a web page from Agilis 91x native code and conversely, how data input to the
browser is made available to Agilis 91x native code.
Browser event/information transfer to Agilis 91x uses reserved URLs that are
predefined to trigger a particular response from the Agilis 91x native code that
receives them (Figure C-1). See Table C-1 for a list of reserved URLs. See
Figure C-1 for a diagram of how the transfer works.
NOTE
The following example describes a navigate event to the reserved URL a.tcskey.
EXAMPLE
When the browser control detects a navigate event to the a.tcskeyreserved URL,
it sends the "A" key (function key "A") to the awaiting keypad task in Agilis 91x.
This navigate event comes from an embedded href in the web page that causes
navigation to a.tcskey on a click event (a touch on a touch screen generates a
mouse click event). Therefore, to pass specific events to Agilis 91x, the web page
must be designed to use the reserved URLs and program hrefs as appropriate to
get the desired information to transfer to Agilis 91x.
C-9
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
NOTE
g5233034
C-10
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
A.getbuf through Z.getbuf Causes Agilis 91x to invoke the javascript method,
256.getbuf through showbuf(), with the content of buffers a through z and
355.getbuf buffers 256 through 355, respectively
A.setbuf through Z.setbuf Sets the content of buffers a through z and buffers 256
256.setbuf through through 355, respectively
355.setbuf
To send data from Agilis 91x to the browser web page, Agilis 91x uses predefined
javascript methods contained in the file, tcsvideo.js, installed with Agilis 91x.
Web page designers must reference tcsvideo.js in the HTML data that forms the
target web page source so that tcsvideo.js is loaded when the page loads. The
javascript methods in this file are designed to perform various duties, such as
displaying the transaction amount on the browser page, displaying asterisks in
PIN entry, and so on. These javascript methods are recognized by Agilis 91x in
advance (hard-coded) so that depending on the type of data solicited by the web
page, the appropriate javascript method is invoked.
Example 1 describes how keystrokes are displayed on the browser in the Dollar
Entry state. Example 2 describes how the transaction amount is displayed
during the Information Entry state.
EXAMPLE 1
If the terminal is in a Dollar Entry state with a full screen browser display, the
numeric keystrokes coming into Agilis 91x need to be displayed as a normal
part of that state’s flow. Agilis 91x sends these keystrokes to the display object.
When the display object receives the numeric input for the display, it knows that
the browser is in control and sends the data to the browser for display.
C-11
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
EXAMPLE 2
If the terminal is in an Information Entry state with a full screen browser and the
developer wants to display the transaction amount (as in a confirmation state after
transaction amount entry), the transfer requires a data transfer out-of-context.
Since, in normal Information Entry state processing, the transaction amount
is not displayed, the information must be obtained from Agilis 91x. This is
accomplished using a reserved URL that is generated when the web page loads.
Reception of the reserved URL is the event that triggers Agilis 91x to respond
with the desired data. The data returned by Agilis 91x is specific to the reserved
URL received. Also by this time, tcsvideo.js has been loaded in the target web
page and is ready to process the input data from Agilis 91x. See Figure C-2 for
an illustration of this process.
g5233033
In this example, if a 1 was entered the data from Agilis 91x would be:
showkey(1,$0.01)
The showkey function takes the key data sent by Agilis 91x and converts it to
an object in keyvalue. If valuetype=0, the raw data is used. If valuetype=1,
the formatted data is used.
The key data is formatted with the format template defined in the Dollar Entry
state.
C-12
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
function showkey()
{
if (valuetype==0)
{
keyvalue=showkey.arguments[0];
displaykey();
}
else
{
keyvalue=showkey.arguments[1];
displaykey();
}
}
The ATM Soft Lock feature (ASL) allows you to lock out host communications,
consumer operations, and service users from the ATM. The ATM remains in the
locked state until ASL is removed.
The soft lock can take effect under the following conditions:
• A consumer is not using the ATM, and the ATM is in state 000 waiting for a
card to be inserted (the Welcome state).
• The ATM is in the Continuous Availability main menu and not in any of the
selections of Continuous Availability
• Agilis 91x for ix/CSP is loaded on the hard disk but not currently executing
at the ATM. In this case, the ASL utility does not expect a response from
Agilis 91x for ix/CSP since Agilis 91x for ix/CSP is not executing. Upon
initialization, Agilis 91x for ix/CSP honors the soft lock as a priority above
enabling other interfaces.
Lock Operation
If the soft lock command is issued to the terminal, it does not take effect until one
of these conditions are met. After the soft lock takes effect, host communications
go offline, the card reader is disabled, and Maintenance mode is blocked. All
users are blocked from Agilis 91x for ix/CSP.
Unlock Operation
The soft unlock command unlocks the terminal for normal usage including host,
consumer, and Maintenance mode users. In the event that Agilis 91x for ix/CSP is
currently up and running with proper configuration, Agilis 91x for ix/CSP brings
high-side communications online and sends a power-fail message to the host.
C-13
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
mutil -l
The following command unlocks the terminal and returns the terminal to
normal usage:
mutil -u
During the period of time that the ATM is soft locked, Maintenance operation
requests are ignored.
Additional options are available with ASL. The following command provides
additional information:
mutil -?
This section describes the native capabilities (character sets and control
sequences) of the Diebold ix/CSP Series journal printer for those networks that
prefer to use the pass-through strategy rather than a text-related strategy.
The standard journal printer firmware provides the character sets shown in
Table C-2 and Table C-3. Table C-4 shows the control sequences for the
journal printer. Table C-5 is an ASCII and EBCDIC cross-reference for the
control sequences.
Space 20 40 @ 40 7C
! 21 4F [1] A 41 C1
" 22 7F B 42 C2
# 23 7B C 43 C3
$ 24 5B D 44 C4
[1] This cross-reference uses Diebold’s implementation of EBCDIC. The characters noted differ from the
standard IBM EBCDIC characters.
C-14
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
% 25 6C E 45 C5
& 26 50 F 46 C6
’ 27 7D G 47 C7
( 28 4D H 48 C8
) 29 5D I 49 C9
* 2A 5C J 4A D1
+ 2B 4E K 4B D2
, 2C 6B L 4C D3
- 2D 60 M 4D D4
. 2E 4B N 4E D5
/ 2F 61 O 4F D6
0 30 F0 P 50 D7
1 31 F1 Q 51 D8
2 32 F2 R 52 D9
3 33 F3 S 53 E2
4 34 F4 T 54 E3
5 35 F5 U 55 E4
6 36 F6 V 56 E5
7 37 F7 W 57 E6
8 38 F8 X 58 E7
9 39 F9 Y 59 E8
: 3A 7A Z 5A E9
; 3B 5E [ 5B 4A [1]
< 3C 4C \ 5C 6A [1]
= 3D 7E ] 5D 5A [1]
> 3E 6E ^ 5E 5F [1]
? 3F 6F _ 5F 6D
7F 07
[1] This cross-reference uses Diebold’s implementation of EBCDIC. The characters noted differ from the
standard IBM EBCDIC characters.
C-15
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
LF Prints a line of characters, then does a carriage return and a line feed.
C-16
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Application Notes
SO Fills an area with blanks (space characters). The character following SO defines the number of blanks.
The range for the character following SO is ASCII 31 through 3F (decimal 1 through 15).
ESC 4 Enables the alternate character set (more than one character).
ESC @ Resets the printer to the standard character set, single-width printing, and the default horizontal and
vertical pitches.
CR 0D 0D
FF 0C 0C
LF 0A 15 or 25
SO 0E 0E
VT 0B 0B
ESC P 1B 50 27 D7
ESC & 1B 26 27 50
ESC ’ 1B 27 27 7D
ESC ( 1B 28 27 4D
ESC ) 1B 29 27 5D
ESC 4 1B 34 27 F4
ESC 5 1B 35 27 F5
ESC @ 1B 40 27 7C
ESC W 0 1B 57 30 27 E6 F0
ESC W 1 1B 57 31 27 E6 F1
C-17
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Appendix D
VGA Plus
This appendix provides information about VGA Plus. Throughout this appendix,
the term application refers to the software application that your institution uses to
operate its terminals, unless otherwise stated. This can be a host or controller
application, or it can be an application installed in a terminal. Keep in mind
that, even in a direct-connect environment, terminals can be equipped with a
direct-connect application that can perform terminal configuration without
network intervention.
To implement VGA Plus, a terminal’s consumer display must meet the following
minimum requirements:
Currently, your institution might have terminals that support the Color Graphics
Feature, Enhanced Monochrome Graphics, or Character Generator Emulation.
VGA Plus is a superset of the Color Graphics Feature and is fully compatible
with the Color Graphics Feature.
For application programming, you use VGA Plus at a relatively high level,
adding a few control sequences to your screen data to access the icons, character
sets, and advanced display functions. The following display actions, currently
available with the Color Graphics Feature, are functions of screen data and are
supported under VGA Plus:
The following additional display actions are functions of screen data available
with VGA Plus:
D-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The application can send screen data to the terminal at various times during
terminal operation, as described in Appendix D.1.
This section summarizes how VGA Plus displays screens on the consumer
display and introduces the following topics:
• Screen data
• Powerup screen data
• Screen resolution
• Video digital-to-analog converter (DAC)
• Palette
• Custom icons and custom files
• Default files, prepackaged icons, and prepackaged character sets
All these topics are described in more detail in Appendix D.6 through
Appendix D.14.
D-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The terminal uses the powerup screens until the host or network overwrites them.
About Resolutions
VGA Plus supports four resolutions. This appendix describes resolutions in
the following format:
where PPP stands for the number of pixels the terminal displays on each line, SSS
stands for the number of horizontal scan lines the terminal can display, and CCC
stands for the number of colors that the terminal can display at any one time.
The following table describes the resolutions available for VGA Plus:
D-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Each color selects one of the DAC color registers. The terminal displays a color
based on the value in the selected DAC color register. This manual uses the term
DAC setup to indicate the current values in the DAC registers.
The ESC O control sequence directs the terminal to load the values from a
specific DAC file into the DAC registers. DAC files define each color by
a red (R), a green (G), and a blue (B) value. DAC files supply the following
values for the DAC color registers:
A DAC setup number is an ESC O control sequence parameter that identifies the
DAC file that stores a specific set of values for the DAC registers. For example,
DAC setup number 48 identifies DAC file DAC048.DAT.
Figure D-1 provides a block diagram of the DAC that shows the video RAM and
256 DAC registers, each register with a red, green, and blue value. You can think
of the video RAM as a matrix of 640 bytes by 480 bytes (in the 640 x 480 x 256
resolution), where each byte is an index into the DAC. The DAC displays the
RGB color on the consumer display as a pixel with that color.
Palette files store values for the palette registers. The ESC N control sequence
directs the terminal to change the values in the palette registers to the values
stored in a specific palette file. A palette setup number is an ESC N control
sequence parameter that identifies the palette file that stores a specific set of
values for the palette registers. For example, palette setup number 129 identifies
palette file PAL129.DAT.
D-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The Figure D-2 provides a block diagram of how the palette relates to the
DAC. Think of the video RAM shown in the diagram as being composed of
four layers, one each for red, green, blue, and intensity. A bit from each layer
maps to the palette, so there are 4 bits per pixel. This 4-bit number selects one of
the 16 palette registers. The palette registers are loaded with the default values
from the default palette file (PAL000.DAT). The following table provides
information on how the data in the PAL000.DAT file affects which set of 16
colors the DAC actually selects:
If the flag (first byte) is true then Bit2 and Bit3 of the
Color Select Register maps to Bit6 and Bit7 of the DAC
respectively.
D-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D.2.1 Directories
When consumer display is configured for VGA color, the terminal loads
configuration data from the following \DIEBOLD\TCS subdirectories:
D.2.2 Files
This section introduces the configuration and sample files. Appendix D.17
provides comprehensive information on all the VGA Plus files discussed in
this appendix.
Configuration Files
Depending on how you customize your system, the configuration files described
in Table D-1 can reside in the \DIEBOLD\TCS\ADP00 directory and the
\DIEBOLD\TCS\ADP01 directory. Some of the configuration files have
defaults included on the installation disk. If you want to use a file and there
is no default, you must create it and place it into the proper directory. When
there is a default file, you do not have to create additional files unless you
want to change the default values
D-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Sprite SPRITEnnn.DEF No Sprite definition files contain commands that direct the terminal when,
Definition where, and how to display each frame of an animated sprite.
DAC DACnnn.DAT Yes DAC files store a color lookup table of 256 red, green, and blue values.
These red, green, and blue values make up the selectable colors in the
system. The default DAC values are in the DAC000.DAT file.
Custon Icon • ICONnnn.DDU No Custom icon files store the custom icons you create. The extension
• ICONnnn.PCX indicates the format of the files.
• ICONnnn.GIF
Color Wheel CLRWnnn.DAT Yes Each color wheel file defines a set of colors by using a table of red, green,
and blue values. The default color wheel values are in CLRW000.DAT
through CLRW016.DAT files.
Power-up *.SCR [2] No Powerup screen files store screen data present in the terminal at powerup.
Screen
VGADFLT.SCR Yes The default power-up screen file that stores the following reserved
screens: Off Line, Out of Service, Currency Character, Decimal Character,
and Remove Currency
Palette [3] PALnnn.DAT Yes The palette file stores the 16 colors that you wish to select from the 256
available colors. The terminal uses these 16 colors to display 640 x 480
x 16 resolution icons and text. Each palette register value selects one
of 256 DAC color registers. The terminal displays a color based on the
value in the selected DAC color register. The default palette values are in
the PAL000.DAT file.
[1] The nnn designates a three-digit number unique to each individual files.
[2] The * designates any alphanumeric 8-character (maximum) name unique to each individual file.
[3] The palette files only reside in the \DIEBOLD\TCS\ADP00 directory. This is because palette files are only associated with
16-color resolutions.
The terminal loads the configuration files described in Table D-2 from the
\DIEBOLD\TCS directory.
Datetime Datetime.DAT No The datetime file stores a list of the screens on which you want the terminal to
display the date and time. This allows you to display the date and time on any
screen without making any changes to the download image.
Revert REVERT.CFG No The revert file stores the resolution associated with one or more screens. Under
certain conditions, described in Appendix D.17.2, the terminal’s download of
screens can be affected with respect to the resolution of a screen. If desired,
you can install the revert file.
D-8
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Sample Files
The sample files described in Table D-3 reside in the \DIEBOLD\TCS\SAMPLE
directory. VGA Plus provides sample files for you to use as a reference.
DAC000.ASM A sample assembly language file for the default DAC file
(DAC000.DAT). You might wish to look at this file if you
are creating a custom DAC.
DAC001.ASM A sample assembly language file for the black DAC file
(DAC001.DAT). The black DAC file contains DAC settings
set to black for all colors. You might wish to look at this file
if you are creating a custom DAC.
PAL000.ASM A sample assembly language file for the default palette file
(PAL000.ASM). You might wish to look at this file if you are
creating a custom palette.
REVERT.CFG A sample revert file that sets the 640 x 480 x 16 resolution
on each new screen that enters the video subsystem. If
you do not want the revert effect, you do not have to install
this file. If you only want the revert effect for some of your
new screens, you can edit this file before you install it.
CLRWnnn.ASM [1] Sample assembly language files for the default color wheel
files (CLR000.ASM through CLRW016.ASM). You might
wish to look at these files if you are creating a custom
color wheel.
[1] The nnn designates a three-digit number unique to each individual file.
D.2.3 Libraries
The terminal loads character sets from the following libraries at powerup:
16 x 24 \DIEBOLD\TCS\ADP00\*.LIB
8 x 12 \DIEBOLD\TCS\ADP01\*.LIB
This section presents simplified block diagrams that show how the terminal
performs the following tasks:
• Selects the correct DAC file based on the ESC O control sequence (select
DAC) parameters
D-9
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
• Selects the correct palette file based on the ESC N control sequence (select
palette) parameters (16-color only)
• Loads the DAC registers with the values from the DAC file
• Loads the palette registers with the values from the palette file
Refer to Figure D-3 for the data flow diagram of 16-color screens. Refer to
Figure D-4 for the data flow diagram for 256-color screens.
D-10
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-11
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Powerup
The files that define icons, the palette, the DAC, powerup screen data, sprites,
and character sets must be present on the terminal’s hard disk before the terminal
is powered up. During powerup, the terminal loads the information from the
files into memory from the hard disk.
Powerup takes anywhere from a few seconds to a few minutes, depending on the
amount of graphic data present. At the end of powerup, the terminal establishes
communication with the application.
Terminal Configuration
After the terminal successfully powers up, the application can send configuration
data to the terminal. As part of the configuration process, the application sends
the screen data to the terminal.
The icons and character sets used by VGA Plus are not part of your application’s
terminal configuration files. The modification, maintenance, and transferral of
these graphics to the terminal is discussed in Appendix D.16.
Consumer Transactions
The terminal can accept screen data from the application during consumer
transactions. If your institution wishes to make use of such capabilities, screen
data can be included in a Function Command message or a Write Command 5
message (used with the Open Account Relationship feature). The application
uses the same message sequencing and message formats to implement these
features on a terminal that supports VGA Plus as it uses for standard Agilis
91x for ix/CSP terminals.
If VGA Plus is being installed in your terminals for the first time, you need to
verify that your system is prepared for it. The preparation is minimal if your
terminal is configured with SXA with Local Screen Changes (LSC). For other
applications, some additional application programming might be necessary. This
section presents an overview of the required preparations.
D-12
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The consumer display configuration options must be set to permit the terminal to
support the VGA Plus feature.
If your terminals currently support the Color Graphics Feature, your current
Color Graphics Feature screen load operates on VGA Plus without modifications.
However, to implement the special graphics features of VGA Plus, you need
screens designed specifically for VGA Plus.
If your terminals do not support the Color Graphic Feature, you need to check the
screens in your terminal configuration data files and modify them as appropriate
for your institution. You do not need to modify screens that contain printer data
because the terminal does not display printer data on the consumer display. Also,
check any screen data generated by your application for Function Command
messages and Write Command 5 messages and modify it as appropriate.
D-13
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
If you want to create custom icons, there are many ways to proceed. You might
be able to use an outside service to create the icons. If you wish to do it yourself,
the following paragraphs outline one method.
Scanning
Use a scanner to capture the image. For example, if you want to create an icon
of your institution’s logo, scan something on which the logo appears, such as
letterhead or a business card.
Paint Package
Use a paint package that runs on your PC to enhance the scanned image.
For example, after scanning an image of your logo, you should remove any
background from the logo. You might want to change the colors of adjacent areas
for clarity. You might want to crop the image. Alternatively, use a paint package
to create custom icons from scratch.
Conversion Package
Depending on the output from the scanner and paint package, it might be
advantageous to scan and edit with pictures in 24-bit color. This way, you can
merge two pictures in the paint program without compromising either one since
there is no palette. After you scan and merge the 24-bit pictures, use a conversion
package that runs on a PC to convert 24-bit pictures to 16 or 256 colors. When
you convert 24-bit pictures, keep the following points in mind:
• The first 16 colors must be the default VGA colors if you wish to use
standard colors for fonts, and so on.
• If you want more than one icon to appear on the screen at the same time,
all of the icons that are on the screen together must use the same DAC
setup and palette
• If you cycle through icons to create animation, all the icons used in the
animation sequence must use the same palette. It might also be necessary to
use a conversion package to convert the icon to a format compatible with the
Diebold Design Utility (DDU).
• DDU
• GIF
• PCX
DDU
DDU is a utility that allows you to prepare icons for the terminal. DDU requires
a standard paint format (PCX) or graphics interface format (GIF) file. Tagged
image format (TIF) files are also acceptable, but they might not work. DDU
accepts files with a maximum of 256 colors. If your paint package produces
a GIF, PCX, or TIF file with 256 colors or fewer, DDU should be able to
convert them.
D-14
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Use DDU to perform the final fine-tuning on the icon. DDU provides a custom
DAC file for each icon. You must specify the setup number for the custom DAC
file in the screen data with the ESC O control sequence before displaying the
icon with ESC P. When you create new icons, it is a good idea to give each icon a
unique number. Refer to the Diebold Design Utility User’s Manual (Release
2.5) (TP-799346-000A) for information on DDU.
If you want the same icon to appear in a small portion of the screen, put it in
the high-resolution library (ADP00). Then use ESC M in the screen data to
display the icon in one of the following resolutions: 640 x 480 x 16 or 640 x
480 x 256. If the icon has more than 16 colors, you must display it in the
640 x 480 x 256 resolution.
You must store any icons larger than 320 pixels across by 240 pixels down in the
high-resolution library (ADP00) and display them in the high-resolution modes.
Refer to Appendix D.2.3 for more information on libraries.
D-15
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The memory required for the DAC, palette, color wheel, and character set
configuration files for the ADP00 and ADP01 directory is about 300K. Any
custom icons is in addition to the 300K.
Refer to the readme.doc file on the Agilis 91x for ix/CSP installation disk for
additional information on system requirements.
This section presents the specifics of designing the screens for your application’s
terminal configuration files. Appendix D.6.1 introduces screens and their
relation to what is shown on the consumer display. If you are already familiar
with the basic concepts of Agilis 91x for ix/CSP terminal screens and the
notation conventions used in this programming manual, you can skip this
section if desired. Appendix D.7 discusses how the screen type and the row size
determine the display format of the consumer display. Appendix D.8 through
Appendix D.13 describe the display features that you can control through screen
data. These features include fonts, icons, colors, blinking, and inverse video.
D.6.1 Screens
D-16
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Screens are part of the configuration data that the application must send to
the terminal during terminal configuration (in Write Command 2 messages).
The application can also send screen data to the terminal during consumer
transactions (in Function Command messages and Write Command 5 messages),
if your institution uses these techniques.
Screen data consists of text (displayable characters) and control sequences. Each
control sequence consists of one or two control characters plus parameters (for
some control sequences). VGA Plus allows you to use the non-displayable
characters shown in the following table as control characters:
Character ASCII (Hex) EBCDIC (Hex) Character ASCII (Hex) EBCDIC (Hex)
BS 08 16 LF 0A 25
CR 0D 0D SI 0F 0F
ESC 1B 27 SO 0E 0E
FF 0C 0C US 1F 1F
HT 09 05 VT 0B 0B
This appendix presents all screen data in character format rather than in the
hexadecimal equivalents. For example, the sample screen data shown in the
following table demonstrates how text characters and control characters appear in
this appendix:
D-17
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
FF 0C
SI B K 0F 42 4B
SI D K 0F 44 4B
ESC P 055 0 1B 50 30 35 35 30
This screen data directs the terminal to display the message PLEASE TAKE
CASH and to put an icon (a hand taking currency) below the message. The data
is broken into lines to make it easier to read. The actual data does not contain any
line terminators such as a carriage return (CR) or a line feed (LF). By referring
to the chart in Appendix A, you can determine the hexadecimal equivalent
of the data for an EBCDIC system.
The first line of the screen data is the FF control sequence, which is used to clear
the consumer display. The FF control sequence is one control character and
has no parameters.
The second line of the screen data is the SI control sequence, which is used to
position the cursor. The SI control sequence consists of one control character (SI)
and two parameters (B and K). The spaces between SI, B, and K have been added
to make it easier to read the control sequence. These spaces are not part of the
actual screen data. The same is true for the fourth and fifth lines of screen data.
The third line of the screen data is text; it contains no control sequences and is
just the message PLEASE TAKE CASH to be put on the consumer display. The
symbol b/ that appears twice in this line represents the space character.
The fourth line of the screen data is the SI control sequence again with two
different parameters (D and K). These parameters set the position for the terminal
to display the icon.
The last line contains an ESC P control sequence, which puts an icon on the
consumer display. The ESC P control sequence consists of two control characters
(ESC and P) and two parameters (055 and 0). Refer to Section 4.7 for a detailed
explanation of the control sequences used in this example. Control sequences
make it possible to create more complex screens than the example above,
including composite screens made from several screens linked together. The
remainder of this section describes some of the modifiable features and the
control sequences that modify them.
D-18
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The display area of the consumer display is the area on which the terminal can
write text and icons. It is made up of either 200, 240, 480, or 768 scan lines; each
scan line is made up of either 320, 640, or 1024 pixels. Scan lines are horizontal
lines traced across the consumer display by the electronic beam. Pixels are
dots on the consumer display. The number of scan lines is independent of the
configuration setting (Consumer Display, Line frequency). The following
factors determine the format of the display area:
Row Size
The display area can be divided into 40 or 64 columns and a variable number of
rows. The number of rows depends on the row size, which can vary from 10
to 16 scan lines high (Table D-4). Whatever the row size, all the rows on the
display are the same size.
The terminal sets a row size of 12 at powerup or when entering the Maintenance
mode. This row size remains in effect unless you modify it by using the
ESC = or the ESC M control sequence. Any row size remains in effect until
explicitly modified by screen data or until reset by powerup or Maintenance
mode. Refer to Section 4.7.44 for information on ESC = . Refer to Section 4.7.21
for information on ESC M.
Row Size (Scan Number of Rows Number of Rows Number of Rows Number of Rows
Lines) 640 x 480 x 16 320 x 200 x 256 1024 x 768 x 256 800 x 600 x 256
640 x 480 x 256
320 x 240 x 256
10 24 20 38 30
11 21 18 34 27
12 [1] 20 16 32 25
13 18 15 29 23
14 17 14 27 21
15 16 13 25 20
16 15 12 24 18
[1] Set by powerup and Maintenance mode.
The character set descriptions in the VGA Plus Prepackaged Icons and Character
Sets manual (TP-799508-000A) indicate the recommended row sizes for each
prepackaged character set. For custom character sets, use a row size that matches
the cell height used in creating the characters.
Resolution
Refer to Table D-5 for a summary of the five available VGA Plus resolutions.
D-19
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The default resolution is 640 x 480 x 16. The terminal places the screen in the
default resolution at powerup and when it enters Maintenance mode. Use the
ESC M control sequence to change the default resolution. Refer to Section 4.7.21
for information on ESC M.
NOTE
Screen Type
Agilis 91x for ix/CSP terminals can be configured for any of the following
screen types:
• 40-by-20 / 64-by-32
• 32-by-16, right-justified
• 32-by-16, left-justified
• 32-by-16, centered (available for 640 x 480 x 16 resolution only)
NOTE
The 40-by-20 screen type is considered the standard screen type for i Series and
MDS terminals. When the terminal is configured for the 40-by-20 (or 64-by-32)
screen type, you can use all the rows and columns in the display area to display
text and icons. You can address the entire area (Figure D-5).
D-20
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
To determine the screen type selected for a terminal, you can interrogate
the terminal directly using an Operational Command message to request
configuration information. When you receive the hardware configuration status
data from the terminal, check status byte 8, bit 2. If the 40-by-20 (or 64-by-32
in the 1024-by-768 resolution) screen type is selected, that bit is set to 1. If a
32-by-16 screen type (right-justified, left-justified, or centered) is selected,
that bit is set to 0. If you are using more than 16 colors, the only valid screen
types are 40-by-20 and 64-by-32.
D-21
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-22
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Row and column designators are used in screen data to position the cursor in the
addressable area on the consumer display. Refer to Figure D-6 for the rows and
columns available when you display the following resolutions:
• 640 x 480 x 16
• 320 x 240 x 256
• 320 x 200 x 256
• 640 x 480 x 256
Refer to Figure D-7 for the rows and columns available when you display the
1024 x 768 x 256 resolution.
Starting Position
The first row that you can address is always row @, and the first column that
you can address is always column @, regardless of the screen type. Refer to
Figure D-8 for the location of the first row you can address. Because the number
of rows and columns that you can address varies from system to system (and
sometimes from screen to screen). It is up to you to be aware of the number
of rows and columns in use and to know the correct range of row and column
designator for that display format.
Figure D-6 Row and Column Designator for 320 and 640 Pixels
D-23
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Figure D-7 Row and Column Designator for 1024 x 768 x 256 Resolution
D-24
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-25
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-26
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Screen Type Row Size A Key Row B Key Row C Key Row D Key Row
(Scan Lines)
40-by-20 10 I L O 2
11 H K N 0
12 G J L O
13 G I K N
14 F H J M
15 F H J L
16 E G I K
Resolutions 640 x 480 x 16, 640 x 480 x 256, and 320 x 240 x 256
32-by-16 [1] 12 F I L O
40-by-20 10 K N 2 6
11 J M 0 3
12 [2] I L O 2
13 H K N 0
14 G I L N
15 F I K M
16 [3] F H J L
64-by-32 10 1 7 = ?
11 O 5 : ?
12 N 3 8 =
13 M 1 6 :
14 L 0 4 8
15 K O 3 7
16 J N 2 5
[1] 32-by-16 screen type only supported in 640 x 480 x 16 resolution.
[2] Recommended for prepackaged Arabic, Thai, and Russian.
[3] Recommended for prepackaged Chinese.
D-27
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Figure D-10 Rows for Each Screen Type and Resolution (sheet 1 of 2)
D-28
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Figure D-10 Rows for Each Screen Type and Resolution (sheet 2 of 2)
D-29
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Character sets are sets of characters (such as letters or ideographs, numbers, and
punctuation) and sets of other simple image elements (such as mosaic blocks).
Each character set is assigned an identifying number (called a font number) from
0 to 7, or E, F, G, or @. Numbers not included in this range are reserved for
predefined character-based icon sets. If your institution does not use one or more
of these predefined icon sets, but does require more font selections, you can use
DDU to redefine these areas to contain custom font character sets.
You can select the desired character set by embedding an ESC F or an ESC
G control sequence in the screen data with the set’s font number. (Refer
to Section 4.7.14 for a description of ESC F. Refer to Section 4.7.15 for a
description of ESC G.)
When the terminal is powered up, it initially selects the basic set for text.
Therefore, until the terminal encounters an ESC F or ESC G control sequence in
screen data, all text appears in basic set characters. The Maintenance mode also
selects the basic set, and this selection remains in effect when the terminal exits
the Maintenance mode, so the same considerations apply as for powerup.
The VGA Plus Prepackaged Icons and Character Sets manual (TP-799508-000A)
describes the prepackaged character sets available for VGA Plus. The standard
graphics library includes the character sets shown in the following table:
Basic set 0
Helvetica font 1
Century font 2
Rolling font 3
The graphics library is stored on the terminal’s disk in files with a .LIB extension.
There are two standard graphics libraries: one for the high-resolution character
set and one for the low-resolution character set. Your institution can use one of
the standard LIB files with the character sets indicated previously or it can create
a custom LIB file that includes prepackaged character sets, custom character sets,
or both. You must have DDU to create custom character sets.
For both prepackaged and custom character sets, you can display characters in
any pair of colors. You select the background color and foreground color for
characters by embedding an ESC C control sequence in the screen data.
For characters only one column wide and one row wide, VGA Plus displays
the characters in a straightforward, intuitive fashion. The following illustration
shows how VGA Plus displays characters taller than one row or wider than one
column. The example uses the Helvetica character B (two columns wide and
24 scan lines high):
D-30
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The terminal places the upper left corner of the character at the current cursor
position, then moves the cursor to the right of the character as shown.
For automatic text wrapping, the number of rows that the cursor moves down
for each text line equals the height of the characters in cells, regardless of the
row size in effect. The cursor moves down two rows for a line of helvetica,
century, or rolling font characters. The cursor moves down one row for all
other prepackaged characters.
D.9 Icons
You can select the desired icon for a screen by embedding an ESC P control
sequence in the screen data with the icon number (refer to Section 4.7.24 for a
description of ESC P).
NOTE
Refer to the VGA Plus Prepackaged Icons and Character Sets manual
(TP-799508-000A) for more information on the prepackaged icons.
D-31
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The colors of custom icons are determined when the icon is created, and are not
changed by control sequences in the screen data. If you create your custom icon
in a GIF or PCX format, the DAC information is part of the graphic file. If you
create custom icons in some other graphic format, DDU generates a custom DAC
file for each custom icon that you create. You can use ESC O to specify the setup
number for the icon’s custom DAC file. If the custom icons you create are not in
the GIF or PCX format, or you did not create the custom icons with DDU, refer
to Appendix D.17.3 for information on creating the custom DAC file.
D.10 Colors
VGA Plus supports five screen resolutions. The 640 x 480 x 16 resolution
supports 16 colors. The other resolutions (320 x 240 x 256, 320 x 200 x 256, 640
x 480 x 256, and 1024 x 768 x 256) support 256 colors.
You can change the default colors shown in the preceding table by changing
the values in the palette or the DAC.
D-32
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
You can select background and foreground colors for a screen by embedding
an ESC C control sequence in the screen data with a pair of the codes listed
previously. The ESC R, ESC U, and ESC H control sequences also allow
you to designate colors for a specified region of the consumer display (refer
to Section 4.7). When the terminal powers up, it initially selects white as the
foreground color and black as the background color. Therefore, until the terminal
encounters an ESC C control sequence in screen data, all text appears in black
and white. The Maintenance mode also selects white on black, and this selection
remains in effect when the terminal exits the Maintenance mode, so the same
considerations apply as for powerup.
You can use a color wheel to change a specific color on the screen to a sequenced
set of colors. The sequenced set of colors is defined in a color wheel file. You
can specify the amount of time each color in the set remains on the screen. This
technique is known as using a color wheel on a color. You can use ESC J to
select the color number, the hue, and the length of time the terminal displays
each new color. You can use one or more color wheels to create special effects,
such as blinking, fade-in transitions, shimmer effects, and flashing backgrounds.
Refer to Section 4.7.18 for more information on ESC J.
The following table lists the display modes and the code associated with each
mode. The table also indicates in which modes the terminal can display text, and
in which mode the terminal can display the different types of icons.
Sprinkle 4 no Custom
Wipe 50 no Custom
You can select the desired display mode for a screen by embedding ESC F, an
ESC G, or an ESC P control sequence in the screen data with one of the codes
listed previously. Until you use one of these control sequences, the terminal
uses the normal mode (mode 0) as the display mode. Refer to Section 4.7 for
a description of control sequences.
D-33
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Blinking
Blinking affects the entire screen, including text and icons displayed before the
start of blinking. Once you activate blinking, it remains in effect until you select
the normal mode (0) or the inverse mode (2). Because you select a display mode
each time you specify a character set or icon, it is possible to inadvertently
terminate blinking when you are displaying an icon or specifying a character set.
To avoid terminating blinking, specify 1 or 3 (as desired) as the mode for the
last ESC F, ESC G, or ESC P in the screen data.
Refer to Section 4.7.22 for more information on the custom palette and ESC N.
Inverse Video
The inverse video mode reverses the foreground and background colors of text
and prepackaged icons (but not custom icons). Inverse video does not affect
text and icons already displayed. Inverse video remains in effect until you
change it by setting the display mode to normal or by specifying the inverse
video mode a second time.
Blinking Inverse
The blinking inverse mode is the same as the inverse video mode, except that
the foreground color blinks.
Sprinkle
The sprinkle mode displays custom icons a few pixels at a time over the icon’s
area until the entire icon’s area is filled. The effect is similar to raindrops hitting
a car windshield. At first each drop is distinct, then as more drops fall, they
all blend together.
D-34
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Wipe
The wipe mode displays custom icons in diagonal stripes. The stripes materialize
over the icon’s area until the entire icon’s area is filled. The effect is similar to
a Venetian blind closing. Each slat contains a slice of the icon. As the blind
closes, the icon slowly fills in.
The overscan area is a narrow illuminated border outside the display area,
as shown in the following figure:
You cannot put text or icons in the overscan area, but you can control the color
of this area and make it match the background of the display area. To set the
color of the overscan area, specify the background color you want, then clear
the display, as shown in the following examples.
EXAMPLE
ESC C 1 F
EXAMPLE
ESC H
FF
Of course, the FF control sequence erases any text or icons already on the
display, so the color select and FF entries must precede the text and icons
in the screen data.
D-35
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-7 for a list of the most commonly used display functions. It is
intended to direct you to the control sequences you are most likely to need. The
table is not intended as a comprehensive list of display functions and special
effects, nor as a complete description of the control sequences listed.
Refer to Appendix D.6 through Appendix D.13 for the valid parameters for
screen numbers, row and column designator, color codes, display modes, and
font numbers. Refer to the VGA Plus Prepackaged Icons and Character Sets
manual (TP-799508-000A) for valid icon numbers and valid characters for
prepackaged graphics. For the hexadecimal values of the control sequences,
refer to Appendix A.
All examples in this section use the 40-by-20 screen type and a row size of
12, unless otherwise stated.
Display OUT touch screen button (not applicable ESC ZO Section 4.7.38
on the CashSource Plus 400)
Fade from current DAC setup number to black ESC < Section 4.7.43
Initiate animation with FLC or FLI graphic files ESC ZF Section 4.7.36
D-36
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-37
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The following subsections discusses the ways in which you can us the VGA Plus
features effectively.
Phosphor burn occurs when the same image is displayed on the consumer display
for an extended period of time. This is not unique to VGA Plus, but can develop
on any monitor. This section provides some guidelines to help you design your
screens to minimize phosphor burn.
ESC P 000 1
EXAMPLE
This example displays the Welcome icon and the Insert Card animation sequence
in two different positions on the screen, fades in the icons, delays about 5
seconds, fades to black, and then fades in the icons again in the second position.
Screen 011 is the Welcome screen in this example.
D-38
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-39
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A31
Using these techniques does not totally eliminate phosphor burn, but should
extend the life of the consumer display.
D-40
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The suggestions in the following paragraphs might help to optimize the creation
and display of VGA screens.
ESC U @ @ 3 W 1 0 b
ESC U B B 1 U 4 0 b
Using two control sequences is the simplest way of displaying these rectangles.
However, display time is wasted by tiling the area from row B, column B to row
1, column U with blue. This area is red, not blue, on the finished display.
The following screen data tiles only the area outside the red rectangle with blue:
ESC U @ @ A W 1 0 b
ESC U B @ 1 A 1 0 b
ESC U B V 1 W 1 0 b
ESC U 2 @ 3 W 1 0 b
ESC U B B 1 U 4 0 b
This screen data builds the same display faster than the original screen data does.
D-41
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Simple Borders
You can use ESC R and ESC U control sequences as part of an efficient technique
for building borders. The example in this section demonstrates this technique
by building the Welcome screen in Figure D-12.
g40970B20
This Welcome screen uses the same text as the example used for the description
of ESC R. However, instead of two lines of asterisks, it uses one of the borders
from the 8 x 12 version (16 x 24 in high-resolution mode) of the borders and
backgrounds set. Refer to the VGA Plus Prepackaged Icons and Character Sets
manual (TP-799508-000A) for information about this border.
D-42
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
EXAMPLE
ESC F @ 0
SI C M
Z Top row, row C
ESC R 012 0 0 [
\
ESC U D M I M 0 7 ]
ESC U D: I: 0 7 ^ Left side, column M
SI J M Right side, column:
__ Bottom row, row J
ESC R 012 0 0 VT @
VT A
The ESC R control sequence forms the top and bottom sides of the border. The
ESC U control sequence forms the left and right sides. The following screen
data places the text within the border:
SI E N
ESC F 0 0
WELCOME
ESC F @ 0
SI F 1
ESC F 0 0
TO
ESC F @ 0
SI G O
ESC F 0 0
FOURTH
ESC F @ 0
SI H M
ESC F 0 0
FINANCIAL
ESC F @ 0
SI M F
ESC F 0 0
INSERT
/CARD
b
/FOR
b
/SERVICE
b
Notice the use of ESC F to place attributes around the text. The lead attribute for
each line of text sets the character set to basic normal and the trailing attribute
sets the character set to borders normal.
Two-color Border
VGA Plus provides a border specifically designed to be displayed in two colors
(not including the background color). This border is included in the 8 x 12, 8
x 16, and 16 x 24 versions of the borders and backgrounds set. The border is
shown below (on the left) as it appears in the VGA Plus Prepackaged Icons
and Character Sets manual (TP-799508-000A), and as a black-and-white
representation of its two-color appearance on the consumer display (on the right):
D-43
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A32
To display the border, construct the border in three segments, each segment using
a different set of foreground and background colors. The following figure shows
the three segments labeled with the ESC C control sequences required to display
the border in colors c1 and c2 against a background of color c0.
g40970A33
To identify the blocks required to build each segment, refer to the description
of the border in the VGA Plus Prepackaged Icons and Character Sets manual
(TP-799508-000A).
VGA Plus provides arrow icons as part of the prepackaged graphics. The arrow
icons are icons 085 through 092 (large arrows) and icons 094 through 097 (small
arrows). You can use these icons to point to text or icons on the consumer
display, or to other devices on the consumer interface panel. For example, you
can use left and right arrows to show the consumer which function key to press.
Some of your screen designs might require an arrow with a longer tail. You
can build a longer tail on an arrow icon in some circumstances. The extension
of these arrows depends on which arrow you use and what row size is in
effect (Table D-8).
D-44
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Figure D-13 for the arrows with their extending pieces. Each piece is
a block one column wide and 12 scan lines high.
To display these pieces, you need to access the applicable character set (using an
ESC F or ESC G control sequence). Refer to Table D-9 for a list of the character
sets for each arrow’s extending piece.
Icon SET
D-45
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A29
D-46
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A30
EXAMPLE
Figure D-14 shows a screen directing the consumer to press either the A key
or the B key. The arrows (icon 089) have been extended to lead from the text
to the right side of the consumer display. The screen data required for this
screen is shown below:
SI B C
DO
/YOU
b
/WANT
b
/MORE
b
/TIME?
b
SI I F
PRESS
/IF
b
/YES
b
SI L F
PRESS
/IF
b
/NO
b
SI H S
ESC P 089 0
SI K S
ESC P 089 0
ESC F 7 0
SI I 3
ESC R 016 0 7 VT S
SI L 2
ESC R 017 0 7 VT S
The ESC F 7 0 control sequence accesses the character set that contains the
extending pieces for icon 089. The ESC R control sequences build the long
tail for each arrow.
D-47
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A24
Use the information in this section to update custom graphics (icons and
character sets). You can update custom graphics by loading the new custom
graphics onto the hard disk in the terminal.
Custom icons and character sets are stored in files created with DDU. If you
need information on DDU, refer to the Diebold Design Utility User’s Manual
(Release 2.5) (TP-799346-000A).
There are two methods to load VGA Plus custom graphics from the system
disk, as follows:
The Load DDU Files selection loads files from the ADP00\UPD (high-resolution)
and ADP01\UPD (low-resolution) subdirectories. This selection lets you test
new DDU files without changing the old ones. When the terminal is powered
up, the files in the subdirectories are copied from the \UPD subdirectory to the
appropriate configuration directory (ADP00\UPD files are copied to ADP00 and
ADP01\UPD files are copied to ADP01).
Icons
DDU supplies a custom icon file and a custom DAC file for each custom icon.
Refer to Appendix D.5.6 for information on creating custom icons. You must
know the display resolution for each individual DDU file because icons intended
for high resolutions are stored in a different directory than the icons intended for
low resolutions. If you store the custom icons on diskettes, make sure you label
them with the appropriate resolution.
D-48
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Use the following procedure to load custom icon files and custom DAC files.
2. If DDU files have already been installed on the terminal, save them on
diskettes in case you need them later.
3. If you created the DDU files on a PC, insert a diskette that contains new
DDU file(s) into drive A. Verify that you know the resolution of each file
on the diskette. If DDU generated DAC files or you created custom DAC
files, ensure that the DAC files are also on the diskette. DAC files use
the following naming convention: DACnnn.DAT. The nnn in the DAC
file name indicates the DAC setup number.
4. Copy all the high-resolution DDU files and any associated DAC files
to the \DIEBOLD\TCS\ADP00\UPD directory on drive C. If you are
copying the files from drive A, insert as many diskettes as necessary
until all your files are copied.
5. Copy all the low-resolution DDU files and any associated DAC files
to the \DIEBOLD\TCS\ADP01\UPD directory on drive C. If you are
copying the files from drive A, insert as many diskettes as necessary
until all your files are copied.
6. Load the icons for verification using either one of the following methods.
Loadcrt
• Use the Agilis 91x for ix/CSP GUI interface (Maintenance mode) to
load the icons. Refer to the Agilis 91x for ix Maintenance Manual
(TP-820589-001E) for instructions.
8. Turn off the terminal, then turn it on again. If you do not want to turn the
terminal off, you can copy the update icons in the \UPD directories to
their normal location in either the C:\DIEBOLD\TCS\ADP00 directory or
the C:\DIEBOLD\TCS\ADP01 directory, as appropriate.
D-49
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
As described in Appendix D.2 there are two libraries: one to store high-resolution
characters and one to store low-resolution characters.
DEL \DIEBOLD\TCS\ADP00\*.LIB
If you do not want to delete the file, you can rename it instead.
2. Place the diskette with your high-resolution customized LIB file in drive
A. Then use the following command to copy your customized LIB file:
DEL \DIEBOLD\TCS\ADP01\*.LIB
If you do not want to delete the file, you can rename it instead.
4. Place the diskette with your low-resolution customized LIB file in drive
A. Then use the following command to copy your customized LIB file:
D-50
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The Loadcrt utility automates the process of loading custom graphics files. As an
alternative to going into Supply mode to load files from the UPD directories, you
can run Loadcrt to signal Agilis 91x for ix/CSP to load the graphics files. Loadcrt
notifies Agilis 91x for ix/CSP that update files are available. Loadcrt does not
take the terminal out of service. Follow your institution’s procedures regarding
whether or not to take the terminal out of service. If you wish to take the terminal
out of service, you must enter Maintenance mode before using Loadcrt. If you
do not enter Maintenance mode when you use Loadcrt, the current consumer’s
transaction stops until the files are loaded.
Assume there is a terminal in the data center loaded with the operating system,
Agilis Base Communications (ABC), and the VGA Plus version of Agilis 91x for
ix/CSP. This terminal is communicating to a direct-connect host and is able to
take your institutions’s color load and go in-service.
First, you must install the VGA Screen utility and DDU on the terminal’s hard
disk. These tools are used to create screens and convert graphics files for use in
the terminal environment.
Assume you have a photograph of a new branch that you want to advertise to
the consumers. You used the scanner to produce a 256-color PCX file of this
new branch.
Next, use the following DDU menus on the PCX file to produce ICON200.DDU
and DAC200.DAT:
• Color
• Convert Picture File
DDU creates icon 200, a picture of your new branch for you. You want the
terminal to display icon 200 during the greeting at the new VGA Plus terminal.
Next, make the screen changes to bring in your new icon. In this example, the
load from the network uses screen 011 to display the greeting screen. Access
the VGA Screen utility by typing VGASCRN. To keep it simple, start with the
sample TTF file (VGATTF.DA0). The only screens in the sample TTF file are
the Off Line screen and the Out of Service screen. Create screen 011. Insert the
following commands into screen 011:
D-51
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Next, convert the TTF screen file from a VGA Screen utility file format to
one that the terminal’s operating system can read. The utility to perform this
conversion is called Screen. Enter the following command to access the resident
Screen utility:
Finally, you must get the graphics to display on the terminal. Copy the
icon200.ddu, dac200.dat, and test.scr file to the \DIEBOLD\TCS\ADP00\UPD
directory. Enter Maintenance mode. Enter Supply mode and select LOAD DISK.
Exit Maintenance mode. Now, the greeting screen shows the new icon.
NOTE
If you wish to customize the default configuration files, you must read this
appendix.
NOTE
Powerup screen files store screen data. The extension for powerup screen
files is as follows:
.scr
D-52
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Use one of the following Diebold utilities to aid in the creation of powerup
screen files:
• VGA Screen - contact your local Diebold Systems Engineer for more
information on the VGA Screen utility.
• PC Based File Editor - for more information on this utility, refer to the PC
Based File Editor (DFE) (TP-799407-000A).
Procedure
1. Access the VGA Screen utility by typing VGASCRN.
2. Use the VGA Screen utility to design new color screens. Refer to the
VGA Screen help screens for instructions.
5. Type the following command to run the screen file format conversion
utility:
where dcttfd.da0 is the file you just changed with the VGA Screen utility.
6. Press Enter.
7. Copy the dcttfd.scr file to the configuration directory (Section 1.2) that
is used during powerup initialization. The changes take effect the next
time the terminal is powered up.
NOTE
D-53
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The revert file stores the resolution associated with one or more screens. The
naming convention for this file is as follows:
revert.cfg
If you desire the revert effect, you must install a revert file. A sample revert
file, if installed, is stored in the following directory:
C:\DIEBOLD\TCS\SAMPLE
Format
The format of a revert file entry is as follows:
nnn mm [ddd]
where nnn is the screen number, mm is the resolution mode number that
designates the resolution to which you want the terminal to revert, and ddd is the
optional DAC setup number. The terminal only checks the revert information
when a new screen display request comes into the display subsystem from an
outside source, such as a Function Command message or from a state. The
terminal does not switch resolutions on screens that are not listed in the revert
file. The terminal does not check screens included from within screen text
for a revert mode switch.
Optionally, the revert file can set the DAC (Appendix D.17.3) to a specified
DAC setup. Just add a space and the three digit DAC setup number after the
mode number. The following example shows the screen data that sets the mode
for screen 245 to 01 and the DAC setup number to 003.
EXAMPLE
002 00
245 01 003
200 00
• If the current color load can still be used when changing from the 16-color
mode to the 256-color mode (implying that only DDU icons are being
upgraded to 256 colors)
After a mode has been set by a revert file, the mode remains in effect until it is
changed by another revert file entry, or by an ESC M command sequence in the
current screen file. Refer to Section 4.7.21 for more information on ESC M.
D-54
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
When a revert file is used to change to the 256-color mode, a revert file must
be used to set the mode back to the 16-color mode (mode 00). The terminal’s
state load, function command entry points, and screen numbers must be known
to accomplish the change properly. Consider the example situation described
in the following paragraph:
The revert file data specifies one of the resolutions that support 256 colors
during the time that the terminal is waiting for a response from the network. (A
Consumer Request message has gone to the network and the terminal is waiting
for a Function Command message.) The following points must be known to
set the terminal back to mode 00:
• The network never sends the Function Command message. The terminal
times out and proceeds to the timeout next state. This state displays screen
290.
• The network displays a screen number in a function command and sends the
terminal to a new state. This state displays screen 300.
290 00
300 00
These two lines ensure that the mode is set back to the 16-color CGF compatible
mode under the preceding circumstances.
NOTE
NOTE
You do not need to install the revert file if you have not
changed the download from the network from the Color
Graphics Feature screen load. However, you need to use it if
you include an ESC M in any screen or in the screen data for
any of your Transaction Request state screens.
D-55
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
You can install the sample revert file by copying it into the \DIEBOLD\TCS
directory and turning the terminal off and on. After installation, if you decide
you no longer want the revert effect, you can remove the revert file by deleting
the file from the \DIEBOLD\TCS directory. When you remove the revert file and
turn the terminal off and on, the revert file does not exist and there is no revert
information. Therefore, screens do not revert to a specific resolution.
NOTE
There are two screens associated with the Dollar Entry state
table (state table entries 2 and 9). The screen number you
remove is the second one, state table entry number 9. Refer
to Section 4.4.7 for a summary of the Dollar Entry state
table contents.
2. Edit the file. For example, if your Dollar Display screen is screen number
097, remove the following line from the sample revert file:
097 00
If you experience problems after performing this procedure, such as the Dollar
Entry screen blacking out and only zeros on the display, you probably removed
the wrong screen number from the file. If this happens, check the screen number
in Step 2 and perform the procedure again.
The DAC files store a color lookup table of 256 red, green, and blue values.
These red, green, and blue values make up the selectable colors in the system.
When ESC M changes the resolution, the terminal sets the default DAC and
palette registers. The default DAC values are the same as the default EGA colors.
The default DAC values are in the DAC000.DAT file (Appendix C.3).
D-56
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
All DAC files are stored in the appropriate configuration subdirectory described
in Appendix D.2. The terminal loads the DAC files into memory when the Agilis
91x for ix/CSP application initializes.
NOTE
DACnnn.DAT
Where nnn indicates the DAC setup number referenced in the ESC O control
sequence.
DAC files are binary files. You have to create a DAC source file and assemble
the source file before you can generate a binary DAC file.
DACnnn.ASM
Where nnn indicates the DAC setup number referenced in the ESC O control
sequence. For example, if you are creating an assembly language file for DAC
setup number 250, the file should be called DAC250.ASM.
2. Use the following commands on the source file you created in Step 1 to
assemble the DAC source file and generate the binary DAC file:
Masm DACnnn.ASM;
Link DACnnn;
exe2Bin DACnnn.EXE DACnnn.DAT
D-57
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
3. After the binary DAC file is available, install the file in the appropriate
directory. Refer to Section 4.1 for more information on installing custom
DAC files.
Description
Reg 255 Red 1 byte value for red (bit0 - bit5 significant)
Reg 255 Green 1 byte value for grn (bit0 - bit5 significant)
Reg 255 Blue 1 byte value for blu (bit0 - bit5 significant)
Refer to Figure D-15 for a sample abbreviated DAC file. The sample file is
DAC000.DAT. Refer to Appendix D.18.3 for a list of all the values in the
sample file.
D-58
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
g1959085
D-59
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
g1959086
You can display the date and time on any screen without making any changes
to the download image. The datetime file stores a list of the screens on which
the terminal displays the date and time. You must create the list of screens and
the format screens that define where to display the date and time. The ESC:
command sequence is another way to display the time and date on a screen.
DATETIME.DAT
D-60
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
c:\DIEBOLD\TCS
Format
The datetime file is an ASCII file that contains a list of screen numbers on which
you want the terminal to display the date and time, followed by the format
template screen number to be used for each screen. For clarity, this section refers
to the screen that you want to display the time and date on as a T/D screen. Each
line of the file should be formatted as follows:
• A 3-digit T/D screen number. Start typing this screen number in column
zero of the first line in the file.
Add lines like this to the file for each T/D screen. Since no network changes
are desired, the format screen should be defined in an SCR file. Refer to
Section 4.7.40 for information on creating format screens.
EXAMPLE
The screen number for the Insert card screen is 120. The screen number for the
Deposit screen is 230. Both of the screens display the time and date with the
same format screen 500. The contents of the DATETIME.DAT file required to
accomplish this display is as follows:
120 500
230 500
Each palette file stores 16 colors that you select from the 256 available colors.
The terminal uses these 16 colors to display 640 x 480 x 16 resolution icons and
text. Each palette register value selects one of 256 DAC color registers. The
terminal displays a color based on the value in the selected DAC color register.
PALnnn.DAT
where nnn is the palette setup number referenced in the ESC N sequence.
When ESC M changes the resolution, the terminal sets the default DAC and
palette registers. The default palette values are in PAL000.DAT files. Refer to
Appendix C.2 for the values in the PAL000.DAT file.
D-61
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
Format
The following table shows the format of the palette file:
1 F Bits 4 and 5 of the palette register map to Bits 4 and 5 of the DAC. Bit 2 and 3 of the color select
register map to bits 6 and 7 of DAC. If the flag is false, all 6 bits of each palette register are used
and 2 bits of the Color Select register are used.
T Bits 0, 1, 2, and 3 of the color select register map to Bits 4, 5, 6, and 7 of the DAC. If the flag is true, 4
bits of each palette register are used and 4 bits of Color select register are used.
If the flag (first byte) is true then Bit2 and Bit3 of the Color Select Register maps to Bit6 and Bit7 of
the DAC respectively.
Each color wheel file defines a set of colors by using a table of red, green, and
blue values. You can use a color wheel to change a specific color on the screen to
the sequenced set of colors defined in a color wheel file.
All color wheel files are stored in the appropriate configuration subdirectory,
described in Appendix D.2. The terminal loads the color wheel files into memory
when the Agilis 91x for ix/CSP application initializes.
NOTE
CLRWsss.DAT
Where sss is the color wheel setup number referenced in the ESC J sequence.
Format
The format for the color wheel file is shown in the following table.
D-62
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The maximum number of red, green, and blue entries in the color wheel file is
500.
VGA Plus provides default color wheel files for setup numbers 000 through
016. Refer to Appendix D.18.2 for a list of all the values in the default color
wheel files.
Each sprite definition file contains commands that direct the terminal when,
where, and how to display each frame of an animated sprite. A frame is a sprite
picture. Each frame is stored in a frame file. You can design a set of frames so
that the next frame is slightly different from the previous frame, and so on. When
the terminal displays the frames in sequence, they give the illusion of motion.
The terminal loads the sprite definition and frame files at powerup from the
appropriate configuration directory for the screen resolution. The terminal
supports a maximum of 256 frame files. After you create sprite definition and
frame files, you must put them in the appropriate configuration directory for the
screen resolution in which you intend to display them.
After you create the sprite definition file, use ESC ? to display the sprite defined
in the file. Refer to Section 4.7.45 for information on ESC ?.
NOTE
The following sections describe how to create both sprite definition and frame
files.
FRAMEnnn.SPR.
D-63
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Where nnn represents the frame number. For example, frame file
FRAME100.SPR is the frame file for frame number 100. You supply the
frame number when you use the Mkframe utility. These frame numbers are
parameters for the sprite definition file’s STEP and MOVE commands. Refer to
Appendix D.17.7.4, for more information on STEP and MOVE commands.
Procedure
Use the following procedure to create a frame file.
1. Generate a GIF file for the frame. You can use the same method
to generate the GIF file that you used to create custom icons
(Appendix D.5.6).
NOTE
2. Use the resident Mkframe utility on the GIF file to generate the frame
file. The following paragraph describes the Mkframe utility.
Mkframe Utility
Use the following command to run the Mkframe utility:
g1959087
You supply the frame file number. The Mkframe utility displays the following
prompt:
Use your paint package to determine the number you enter for the background
color. Enter -1 when there is no background or when you want the background to
be part of the frame. It is necessary to make the background transparent or your
sprite includes the background color, even if the color is white. For example, if
you scan a butterfly on a square piece of blue paper, and you do not equate the
blue to transparent, the sprite has a blue square around it.
After you generate the individual frame files for each frame of a sprite, you can
create a sprite definition file.
SPRTEnnn.DEF
D-64
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Procedure
Use the following procedure to create a sprite definition file.
1. Use a text editor to create an ASCII text file that contains the sprite
definition file commands. Refer to Appendix D.17.7.4 for information on
the sprite definition file commands.
2. Use the resident Mksprite utility on the ASCII text file to generate the
sprite definition file. The following paragraph describes the Mksprite
utility.
Mksprite Utility
Use the following command to run the Mksprite utility:
g1959088
The utility range checks all data and displays warning or error messages if
problems exist.
Each line of a sprite definition file contains a command, parameters for the
command, and optional comments as follows:
D-65
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
RATE
The RATE command sets the speed to step through the commands in the file.
The format of the RATE command is as follows:
RATE ttt
where ttt is the speed. The valid values for ttt are 000 through 255. The speed =
10ms + (ttt * 32ms).
EXAMPLE
In this example, ttt = 001. Using the formula as follows, the speed = 42 ms:
Thus, the following rate command directs the terminal to step through the
commands in the file every 42 ms (about 24 times each second):
RATE 001
All sprites default to rate 1. You must include a RATE command in the file to
change the default.
LAYER
The LAYER command sets the layer that the terminal uses to determine which
sprites overwrite other sprites in the case of an overlap condition. The format of
the LAYER command is as follows:
LAYER n
where n stands for the layer. The valid values for n are 0 through 5.
The layer with the highest number is on the bottom. Sprites pass over sprites
on layers with higher numbers. For example, a sprite on layer 2 passes over a
sprite on layer 5. A sprite on layer 3 passes under a sprite on layer 2. Sprites
on layer 0 pass over sprites on all the other layers.
D-66
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The maximum number of layers is six. The maximum number of active sprites
is three. An active sprite is a sprite that is on the screen. This means that the
terminal can only display three sprites at the same time.
All sprites default to layer 0. You must include a LAYER command in the
file to change the default.
NOTE
You might wish to create sprite files that create the same sprite,
but have different layer numbers and include a delay.
EXAMPLE
First, the moon appears to pass behind the star on layer 1. Then it passes in
front of the star on layer 3, before it disappears from the screen as shown in
the following figure.
g40970B27
STEP
The STEP command sets a position and a frame file number for the terminal to
display at that position. Any previous frame is erased before a new step going up
on the screen. The format of the STEP command is as follows:
D-67
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
The frame file number is the number associated with the FRAMEnnn.SPR file
created with the Mkframe utility described in Appendix D.17.1. Locations
xxxx and yyyy are defined by the global pixel coordinate system described in
Section 4.7.31.
You can include as many STEP commands in the file as are necessary.
EXAMPLE
The STEP command in this example directs the terminal to display frame 121
in the center of the screen.
MOVE
The MOVE command moves a sprite on the screen.
g1959089
• Location - The location parameter determines the path of the sprite from
location xxxx 1,yyyy 1 to xxxx 2,yyyy 2. Locations xxxx and yyyy use the
global pixel coordinate system described in Section 4.7.31.
• Steps - The Steps parameter determines the number of times the terminal
displays the frames in the frame list over the total path that you want the
sprite to move. The valid range of Steps is 0 through 9999.
• Frame list - The terminal displays a frame in the frame list at each step
along the path. If there are not enough frames to complete the path, the
frame list is repeated until location xxxx 2, yyyy 2 is reached. Each
FrameNum represents an individual frame and is the number associated
with the FRAMEnnn.SPR file created with the Mkframe utility described in
Appendix D.17.1. The valid range of nnn is 0 through 255.
EXAMPLES
The MOVE command in the following example, displays frames 23, 24, 25, and
26 in four equally spaced steps in the first column of the screen:
D-68
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
Required Keyword
One of the following keywords must end the sprite definition file:
• REPEAT
• CLEAR
• LEAVE
If the word REPEAT is at the end of the sprite definition, the definition is
processed repeatedly. If CLEAR is used, then the sprite stops and it is cleared
from the screen. If LEAVE is used, the last frame displayed is left on the screen
in its last known position.
SPRITE
The SPRITE command starts another sprite from within a sprite definition file.
Parameter Limit
Layers 0-5
Rates 0 - 255
In this example, a butterfly flies across the screen. The butterfly appears at the
upper left side of the screen, lands on a tree in the middle of the screen, flies
behind the tree, and then takes off again to the right. This example requires the
following frame files created using the procedure described in Appendix D.17.1
D-69
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
RATE 002 Step through the commands in the file every 74ms.
MOVE 0,7000,4000,5000,9,200,201,202 Move the butterfly from the upper-right side of the
screen to the edge of the tree. The wings seem to move
because the terminal displays nine frames with wings in
different positions. The butterfly lands with wings down.
STEP 4000,6500,200 Display the butterfly with its wings up on the other side
of the tree.
RATE 001 Change the rate so the butterfly appears to fly off the
screen faster.
MOVE Move the butterfly from the right edge of the tree to the
4000,6500,8000,8700,11,200,201,202 upper- left side of the screen. The wings seem to move
because the terminal displays eleven frames with wings
in different positions.
SPRITE 123 Call sprite definition file 123. This file displays a dog
walking in front of the tree.
After creating the ASCII text file in the example, use the Mksprite utility
described in Appendix D.17.2, to create the sprite definition file.
This section lists the default values for the palette, color wheel, and DAC files.
D-70
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Default Value
Palette Register 0 0
Palette Register 1 1
Palette Register 2 2
Palette Register 3 3
Palette Register 4 4
Palette Register 5 5
Palette Register 6 6
Palette Register 7 7
Palette Register 8 8
Palette Register 9 9
Palette Register 10 10
Palette Register 11 11
Palette Register 12 12
Palette Register 13 13
Palette Register 14 14
Palette Register 15 15
[1] Refer to Appendix D.17.5 for information on setting the flag for the attribute mode
register.
This section describes the default values for color wheel setup numbers 000
through 016. The setup numbers are parameters in the ESC J control sequence
(Section 4.7.18). Refer to Table D-11 for the default values for Color Wheel
setup Number 000. This color wheel cycles from black to peach in the order
indicated in the order column in the table.
D-71
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-72
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-12 for the default values for Color Wheel setup Number
001. This color wheel cycles from black to blue in the order indicated in the
order column in the table.
D-73
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-13 for the default values for Color Wheel setup Number
002. This color wheel cycles from black to green in the order indicated in the
order column in the table.
D-74
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-14 for the default values for Color Wheel setup Number
003. This Color Wheel cycles from black to cyan in the order indicated in the
order column in the table.
D-75
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-15 for the default values for Color Wheel setup Number 004.
This color wheel cycles from black to red in the order indicated in the order
column of the table.
D-76
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-16 for the default values for Color Wheel setup Number 005.
This color wheel cycles from black to magenta in the order indicated in the
order column in the table.
D-77
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-17 for the default values for Color Wheel setup Number 006.
This color wheel cycles from black to yellow in the order indicated in the
order column in the table.
D-78
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-18 for the default values for Color Wheel setup Number
007. This color wheel cycles from black to white in the order indicated in the
order column in the table.
D-79
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-19 for the default values for Color Wheel setup Number
008. This color wheel cycles from black to gray in the order indicated in the
order column in the table.
D-80
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-20 for the default values for Color Wheel setup Number 009.
This color wheel cycles from black to orange in the order indicated in the
order column in the table.
D-81
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-21 for the default values for Color Wheel setup Number
010. This color wheel cycles from black to rust in the order indicated in the
order column in the table.
D-82
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-22 for the default values for Color Wheel setup Number
011. This color wheel cycles from black to silver in the order indicated in the
order column in the table.
D-83
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-23 for the default values for Color Wheel setup Number
012. This color wheel cycles from black to gold in the order indicated in the
order column in the table.
D-84
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-24 for the default values for Color Wheel setup Number
014. This color wheel cycles from black to brown in the order indicated in the
order column in the table.
D-85
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-25 for the default values for Color Wheel setup Number
015. This color wheel cycles from black to purple in the order indicated in the
order column in the table.
D-86
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
Refer to Table D-26 for the default values for Color Wheel setup Number 016.
This color wheel cycles through a range of colors in the order indicated in the
order column in the table.
D-87
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-88
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-89
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-90
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-91
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-92
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-93
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-94
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-95
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-96
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
VGA Plus
D-97
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Index
Index-1
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Index
Index-2
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Index
fade-out transitions 4-198, 4-258, D-2 Intelligent Depository Module (IDM) C-6
Fault Status Print feature 4-340 Deposit Extension state 4-51
filtering and translating network status 5-103 Deposit state 4-18
Financial Institution Tables 4-352 Depositor function data 5-174
Financial Institution Tables (FITs) 4-298 Depositor state 4-77
card match 4-46 Description 3-3
Card Read state (A) 4-12 solicited status 5-40
Check FIT state (@B) 4-119 unsolicited status 5-98
PIN Entry state (B) 4-15
FITs. See Financial Institution Tables J
FLC/FLI files 4-242 journal printer 3-14
font data for EMG 4-6 Printer state (PR) 4-101
foreground color 4-213 journal printers C-14
format templates 4-329
data types 4-333 K
default templates 4-335
keyboard response time 4-347
display methods 4-332
initialization data 4-336
reserved templates 4-336 L
Write Command 18 message 4-328 landscape printing (ESC L) 3-48
Function Command message 5-106 language banks 4-65, 4-181, 4-185–4-186, 4-249,
function identifiers 5-113 4-285, 4-294–4-297, 4-310, 5-71
Function Key Extension state ( > ) 4-59 ESC L control sequence 4-226
PIN Entry state usage 4-62 Latin characters 3-30
Transaction Request state usage 4-62 Latvian characters 3-28
function keys 3-8 lead-through indicators 3-11
solicited status 5-54
G Lead-through Indicators function data 5-185
Lead-through Indicators state 4-94
Get Encrypted PIN state 4-89
Lithuanian characters 3-39
graphics-related strategies 3-11
Greek characters 3-25 logical unit number (LUNO) 4-347
M
H
Hardware Configuration status 5-56 Maintenance mode 2-5
Media Player feature C-1
additional 4-345, 5-59
ESC ZU "MPEGPlay" control sequence 4-244
double expanded 4-343, 5-58
expanded 4-343, 5-57 ESC ZU "ScrnMark" control sequence 4-253
filenames and TCSMEDIAPATH 4-249
receipt printer 5-61
MPEG Stop 4-252
standard 5-56
Hebrew characters 3-33 MPEG volume 4-252
MPEG Window Setup/Play 4-245
Hungarian characters 3-30
Message Sequence Number in Solicited Status
Messages feature 4-345
I Miscellaneous Features 1 field 4-339
icons Miscellaneous Features 2 field 4-342
displaying 4-229 Miscellaneous Features 3 field 4-343
EMG data 4-6 Miscellaneous Features 4 field 4-346
predefined icons 4-264 modes of operation 2-2
IDM 3-3 Multi-tasking State 4-178
Image Character Recognition state 4-91 Example 4-179
In-service mode 2-4 Multilingual feature 4-294
Indirect Next state (@K) 4-153 ESC L screen control 4-226
Indirect Next state (K) 4-39 language selection 4-294
Information Entry state (@D) 4-126 OAR screens 4-296
Information Entry state (H) 4-32 Set Language Bank state ( [ ) 4-65
inserting screens 4-214
Index-3
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Index
Index-4
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Index
Index-5
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Index
timer 18 (swipe/dip Retry screen) 4-287, 4-349 Default Blinking Values D-34
timer 20 (deposit insertion) 4-349 Inverse Video D-34
timer 21 (document removal) 4-105, 4-349, 5-192 Sprinkle D-34
timer 23 (dip card removal) 4-350 Wipe D-35
touch screen 3-8, 4-188, 4-198, 4-241–4-242, 4-244, VGA Plus Feature D-1
4-262, 4-285, 5-60, 5-101, C-9 Addressable Area D-23
configuration 4-262 alternate ESC character D-13
multilingual feature 4-297 arrows D-44
touch templates 4-262 Arrows and Lead-through Lines D-26
Track Buffer Compare state (@M) 4-160 Background Information D-2
traffic lights 5-181–5-182 Borders D-42
transaction messages 5-1 Character Sets D-30
Consumer Request message 5-3 Chinese characters D-13
enhanced Function Command message 5-142 Color Wheel Default Values D-71
enhanced Operational Command message 5-213 color wheels D-33
Function Command message 5-106 Colors D-32
Operational Command message 5-202 Colors in 640 x 480 x 16 Resolution D-32
Solicited Status message 5-14 Configuration Files D-7
Unsolicited Status message 5-76 Control Characters D-36
Transaction Request Extension state ( ) ) 4-58 Cursor Positioning D-23
Transaction Request state ( I ) 4-34 custom character sets D-50
Transaction Request state (@I) 4-147 Custom Graphic Data Updates D-48
format 0 4-147 custom icon and DAC files D-49
format 1 4-151 custom icons D-14
Transaction Verification Status feature 4-344, 5-9, Custom Icons and Custom Files D-6
C-1 DAC D-3
transparent GIF files 4-230 DAC Default Values D-90
Turkish characters 3-31 DDU D-14
Two-color Graphical Receipt Printer 3-12 Description D-1
Two-color Statement Printer 3-18 Directories D-7
Display Area, Format, and Resolution D-19
U Display Modes D-33
unsolicited status Getting Started D-12
definitions 5-82 Graphic File Formats D-14
Unsolicited Status message 5-76 graphics loading D-51
unsolicited statuses Icon Size and Resolution D-15
Alarm 5-82 Icons D-31
Card Reader 5-95 Libraries D-9
Card Writer 5-96 Modifying Screen Data D-13
Coin Dispenser 5-100 monochrome display D-15
customizing 5-103 Moving Image on Screen D-38
Dispenser 5-96 Palette D-4
enhanced statuses 5-101 Palette Default Values D-70
Intelligent Depository Module 5-98 Palette, Color Wheel, and DAC Defaults D-70
Printer 5-93 Programming Techniques D-38
Supervisory and Supply Actions 5-83 Resolution D-19
Withdrawal Area Sensors 5-97 Resolutions D-3
Withdrawal Door 5-97 Row Size D-19
URLs, reserved. See browser support Sample Files D-9
Screen Description D-16
V Screen Design D-16
Screen Type D-20
VGA Plus Display Modes
Starting Position D-23
Blinking D-34
terminal setup D-13
Blinking Inverse D-34 Two-color Border D-43
Custom Blinking Values D-34
Index-6
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)
PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Index
Index-7
©Diebold, Incorporated (11/2004) - All Rights Reserved
TP-821029 (Ed. A)