Agilis For ixCSP Terminal Programming Manual PDF

PRELIMINARY - DRAFT COPY
Mon Nov 22 16:28:25 2004
Agilis® 91x for ix/CSP

Terminal Programming Manual
TP-821029-001A PD 5966
November 2004
Mon Nov 22 16:28:25 2004
Document History
Document Number Date Remarks

TP-820129-001A 11/2004 First release - supports Agilis 91x for ix/CSP, Version 1.6
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)
Mon Nov 22 16:28:25 2004
Contents
Section 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

1.1 About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
1.2 Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
1.3 Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
1.4 Supported Devices and Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Section 2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

2.1 Network Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
2.2 Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
2.3 Modes of Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
2.3.1 Power-up Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.3.2 Out-of-service Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.3.3 Off-line Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.3.4 In-service Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.3.5 Maintenance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
2.3.6 Continuous Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
2.3.7 Terminal Responses to Network Commands . . . . . . . . . . . . . . . . . . . . . 2-6
2.4 Additional Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Section 3 ix Series Terminals and Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

3.1 Card Readers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
3.2 Multi-media Dispenser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
3.3 Supplemental Dispenser Module (SDM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
3.4 Intelligent Depository Module (IDM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
3.4.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
3.4.2 MICR Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
3.4.3 System Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
3.4.4 Image Scanner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
3.5 Consumer Interface Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.5.1 Consumer Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
3.5.2 Function Keys and Consumer Keypad . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
3.6 Lead-through Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
3.7 Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
3.8 Receipt Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
3.9 Journal Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
3.10 Statement Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
3.11 Deposit Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
3.11.1 Transaction Serial Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
3.11.2 Dollar and Cents Keyboard Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
3.11.3 Track Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
3.11.4 Printing Network Data on the Envelope . . . . . . . . . . . . . . . . . . . . . . . . 3-19
3.11.5 Deposit Printer Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
3.12 Print Data Programming for Graphics-related Strategies . . . . . . . . . . . . . . . . . . . . 3-21
3.12.1 Character Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21
3.12.2 Control Sequences for Receipt Printers and Journal Printers . . . . . . . . . . . . . 3-43
3.12.3 Control Sequences for Statement Printers (Agilis 91x for Opteva only) . . . . . . . 3-51
3.12.4 Changing Character Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-54
3.12.5 Standard Format for the Receipt . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
3.12.6 Journal Printer Roll Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-60
Section 4 Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

4.1 Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
4.2 Write Command Messages Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
4.3 Write Command 1 Message (States) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
iii
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Contents
4.3.1 Valid State Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

4.3.2 Write Command 1 Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
4.4 9000 States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
4.4.1 Card Read State (A) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
4.4.2 PIN Entry State (B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
4.4.3 Deposit State (C) for Envelope Depository . . . . . . . . . . . . . . . . . . . . . . 4-17
4.4.4 Deposit State (C) for IDM (terminals with IDM only) . . . . . . . . . . . . . . . . 4-18
4.4.5 Clear Keys State (D) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
4.4.6 Select Function State (E) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
4.4.7 Dollar Entry State (F) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
4.4.8 Cent Check State (G) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
4.4.9 Information Entry State (H) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
4.4.10 Transaction Request State ( I ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
4.4.11 Close State (J) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
4.4.12 Indirect Next State (K) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
4.4.13 Card Write State (L) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
4.4.14 PIN Entry State (M) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
4.4.15 Set Dollar Buffer State (R) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
4.4.16 Card Read State (for Non-state 000 Applications) (T) . . . . . . . . . . . . . . . . . 4-44
4.4.17 Check Track Buffer State (Z) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
4.4.18 Deposit Extension State ( # or > ) (terminals with IDM only) . . . . . . . . . . . . . 4-51
4.4.19 Voice State ( ; ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-54
4.4.20 Copy Buffer State ( = ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-56
4.4.21 Transaction Request Extension State ( ) ) . . . . . . . . . . . . . . . . . . . . . . . 4-58
4.4.22 Function Key Extension State ( > ) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-59
4.4.23 Withdrawal Area Sensors State ( ? ) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
4.4.24 Set Language Bank State ( [ ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-65
4.4.25 Buffer Arithmetic State ( \ ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-66
4.5 Enhanced States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-68
4.5.1 Text To Speech State (AU b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-69
4.5.2 Card Reader State (CR b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-71
4.5.3 Depositor State (DP b/) (terminals with IDM only) . . . . . . . . . . . . . . . . . . 4-77
4.5.4 Dispenser Door State (DR b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-85
4.5.5 Get Encrypted PIN State (EP b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-89
4.5.6 Image Character Recognition State (IC b/) . . . . . . . . . . . . . . . . . . . . . . 4-91
4.5.7 Lead-through Indicators State (LT b/) . . . . . . . . . . . . . . . . . . . . . . . . . 4-94
4.5.8 Network Connection State (NC b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
4.5.9 Passbook Printer State (PB b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-100
4.5.10 Printer State (PR b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-101
4.5.11 Supplemental Dispenser Module (SDM) State (SDb/) . . . . . . . . . . . . . . . . . 4-110
4.5.12 Statement Printer State (SP b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-114
4.5.13 Check FIT State (@B b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-119
4.5.14 Check PIN State (@C b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-122
4.5.15 Information Entry State (@D b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-126
4.5.16 Buffer Compare State (@E b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-134
4.5.17 Set Buffer State (@F b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-137
4.5.18 Buffer Copy State (@G b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-141
4.5.19 Check Buffer State (@H b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-143
4.5.20 Transaction Request State (@I b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-147
4.5.21 Indirect Next State (@K b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-153
4.5.22 Create Buffer State (@L b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-157
4.5.23 Track Buffer Compare State (@M b/) . . . . . . . . . . . . . . . . . . . . . . . . . 4-160
4.5.24 Buffer Shift State (@N b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-163
4.5.25 Buffer Arithmetic State (@O b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-165
4.5.26 Copy Buffer Data State (@P b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-167
iv
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Contents
4.5.27 Buffer Overlay State (@Q b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-171

4.5.28 Time Delay State (@S b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-175
4.5.29 Multi-tasking State (@Xb/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-178
4.5.30 Set Language Bank State (@Y b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-181
4.5.31 Close State (@Z b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-182
4.6 Write Command 2 Message (screens) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-184
4.6.1 General Screen Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-189
4.6.2 Standard, Alternate, and Mosaic Characters . . . . . . . . . . . . . . . . . . . . . . 4-191
4.7 Screen Control Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-197
4.7.1 BS Control Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-200
4.7.2 CR Control Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-200
4.7.3 FF Control Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-200
4.7.4 HT Control Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-200
4.7.5 LF Control Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-201
4.7.6 SI Control Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-201
4.7.7 SO Control Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-203
4.7.8 US Control Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-206
4.7.9 VT Control Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-206
4.7.10 ESC A - Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-206
4.7.11 ESC B - Display Buffer Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-209
4.7.12 ESC C - Select Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-209
4.7.13 ESC D - Animation Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-209
4.7.14 ESC F - Select Font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-212
4.7.15 ESC G - Select Character Set and Display Mode . . . . . . . . . . . . . . . . . . . 4-212
4.7.16 ESC H - Select Foreground Color . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-213
4.7.17 ESC I - Insert Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-214
4.7.18 ESC J - Use Color Wheel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-217
4.7.19 ESC K - Initiate Scrolling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-219
4.7.20 ESC L - Select Language Bank . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-226
4.7.21 ESC M - Change Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-226
4.7.22 ESC N - Select Palette Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-227
4.7.23 ESC O - Select DAC Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-228
4.7.24 ESC P - Display Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-229
4.7.25 ESC Q - Display Check Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-230
4.7.26 ESC R - Repeat Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-231
4.7.27 ESC T - Tile Non-addressable Area . . . . . . . . . . . . . . . . . . . . . . . . . . 4-233
4.7.28 ESC U - Tile Rectangular Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-235
4.7.29 ESC V - Display Buffer Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-236
4.7.30 ESC W - Select Blinking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-237
4.7.31 ESC X - Position Cursor Using Global Coordinates . . . . . . . . . . . . . . . . . . 4-238
4.7.32 ESC Y - Select Special Effect Time . . . . . . . . . . . . . . . . . . . . . . . . . . 4-241
4.7.33 ESC ZC - Select Touch Screen Template (not applicable on the CashSource Plus 400) 4-241
4.7.34 ESC ZD - Define Touch Screen Configuration Data (Touch screen Terminals Only) . 4-241
4.7.35 ESC ZE - Touch Screen Configuration Data (not applicable on the CashSource Plus
400) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-242
4.7.36 ESC ZF - Display FLC/FLI Animation . . . . . . . . . . . . . . . . . . . . . . . . 4-242
4.7.37 ESC ZI - Display In Touch Screen Button (not applicable on the CashSource Plus
400) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-244
4.7.38 ESC ZO - Display Out Touch Screen Button (not applicable on the CashSource Plus
400) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-244
4.7.39 ESC ZU "MPEGPlay" - Media Player Control . . . . . . . . . . . . . . . . . . . . 4-244
4.7.40 ESC ZU - Screen Marker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-253
4.7.41 ESC ZV - Browser Control Sequence . . . . . . . . . . . . . . . . . . . . . . . . . 4-254
4.7.42 ESC : (Colon) - Display Date and Time . . . . . . . . . . . . . . . . . . . . . . . . 4-255
4.7.43 ESC < (less than) - Fade-out Transition . . . . . . . . . . . . . . . . . . . . . . . . 4-258
v
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Contents
4.7.44 ESC = (equal) - Select Row Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-259

4.7.45 ESC > (greater than) - Fade-in Transition . . . . . . . . . . . . . . . . . . . . . . . 4-260
4.7.46 ESC ? (Question Mark) - Use Sprites . . . . . . . . . . . . . . . . . . . . . . . . . 4-260
4.8 Touch Screen (not applicable on the CashSource Plus 400) . . . . . . . . . . . . . . . . . . 4-262
4.9 Predefined Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-264
4.10 Reserved Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-282
4.11 Default Screen File Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-289
4.12 Modifying the Contents of a Screen File . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-290
4.13 Creating a New Default Screen File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-291
4.14 Enhanced Monochrome Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-292
4.15 Multilingual Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-294
4.15.1 Screen Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-294
4.15.2 Language Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-294
4.15.3 OARs in Conjunction with the Multilingual Feature . . . . . . . . . . . . . . . . . 4-296
4.16 Rear Balance Feature (not applicable on the CashSource Plus 400) . . . . . . . . . . . . . . 4-298
4.16.1 Entry Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-298
4.16.2 Rear Balance Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-299
4.16.3 Network Activity during a Rear Balance Function . . . . . . . . . . . . . . . . . . 4-305
4.16.4 Exiting Rear Balance Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-305
4.16.5 Example Rear Balance Implementation . . . . . . . . . . . . . . . . . . . . . . . . 4-306
4.17 Voice Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-310
4.17.1 Voice Prompting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-311
4.17.1.1 Voice Prompting Using .WAV Files . . . . . . . . . . . . . . . . . . . . 4-311
4.17.1.2 Voice Prompting Using Control Files . . . . . . . . . . . . . . . . . . . 4-311
4.17.1.3 Interpretive Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-313
4.17.2 Voice Keypad Feedback Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 4-314
4.17.3 Text To Speech . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-316
4.18 Miscellaneous Screen Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-322
4.18.1 Inline HTML Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-322
4.18.2 URL Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-322
4.18.3 Enhancing Legacy Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-323
4.19 Write Command 13 Message (custom icons for EMG) . . . . . . . . . . . . . . . . . . . . 4-324
4.20 Write Command 14 Message (custom character sets for EMG) . . . . . . . . . . . . . . . . 4-325
4.21 Write Command 15 Message (cell data for EMG) . . . . . . . . . . . . . . . . . . . . . . . 4-327
4.22 Write Command 18 Message (format templates) . . . . . . . . . . . . . . . . . . . . . . . . 4-328
4.22.1 Display Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-332
4.22.2 Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-333
4.22.3 Default Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-335
4.22.4 Initialization Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-336
4.23 Write Command 3 Message (terminal parameters, LUNO, timers) . . . . . . . . . . . . . . 4-338
4.24 Write Command 6 Message (Financial Institution Tables) . . . . . . . . . . . . . . . . . . . 4-352
4.25 Write Command 7 Message (encryption key change) . . . . . . . . . . . . . . . . . . . . . 4-354
4.26 Write Command 8 Message (configuration ID) . . . . . . . . . . . . . . . . . . . . . . . . 4-357
Section 5 Transaction Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

5.1 Consumer Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
5.2 Solicited Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
5.2.1 Solicited Status Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
5.2.2 Printer Status (solicited) (DID = ’2’) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
5.2.3 After Hour Depository Status (solicited) (DID = ’3’) . . . . . . . . . . . . . . . . . 5-26
5.2.4 Card Reader Status (solicited) (DID = ’>’) . . . . . . . . . . . . . . . . . . . . . . 5-27
5.2.5 Card Writer Status (solicited) (DID = ’=’) . . . . . . . . . . . . . . . . . . . . . . . 5-28
5.2.6 Dispenser Status 911 Mode (solicited) (DID = ’8’) . . . . . . . . . . . . . . . . . . 5-29
5.2.7 Dispenser Status 912 Mode (solicited) (DID = ’?’) . . . . . . . . . . . . . . . . . . 5-34
5.2.8 Withdrawal Door Status (solicited) for 911 Mode (DID = ’9’) . . . . . . . . . . . . 5-37
vi
TP-821029 (Ed. A)
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>
5.5.22 Retain Check if in Escrow (T) (912 mode) (<emphasis type="ITALIC">ix</emphasis>
vii
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Contents
5.5.23 Present Card (U) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-138

5.5.24 Write Track 1 (V) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-138
5.5.25 Write Track 2 (W) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-139
5.5.26 Disable IDM (X) (912 mode) (<emphasis type="ITALIC">ix</emphasis> Series
terminals with IDM only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-140
5.5.27 Do Nothing (Z) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-140
5.5.28 Deposit, Write Card, Return Card, Dispense, Deliver, and Print ( ? ) (911 mode) . . 5-140
5.5.29 Write Card, Return Card, Dispense, Deliver, and Print ( = ) (911 mode) . . . . . . . 5-141
5.6 Enhanced Function Command Message (ID ’7’) . . . . . . . . . . . . . . . . . . . . . . . . 5-142
5.6.1 Function Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-157
5.6.2 After Hour Depository (AH b/) Function Data . . . . . . . . . . . . . . . . . . . . 5-160
5.6.3 Coin Dispenser (CN b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . . 5-162
5.6.4 Card Reader (CR b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . . . . 5-165
5.6.5 Bill Dispenser (DI b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . . . . 5-169
5.6.6 Depositor (DP b/) Function Data for Envelope Depository . . . . . . . . . . . . . . 5-172
5.6.7 Depositor (DP b/) Function Data for IDM . . . . . . . . . . . . . . . . . . . . . . . 5-174
5.6.8 Dispenser Door (DR b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . . . 5-179
5.6.9 External Options Module (EX b/) Function Data for Signage Unit . . . . . . . . . . 5-181
5.6.10 External Options Module (EX b/) Function Data for Solenoid Safe Lock . . . . . . 5-183
5.6.11 Lead-through Indicators (LT b/) Function Data . . . . . . . . . . . . . . . . . . . . 5-185
5.6.12 Multiple Functions (MF b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . 5-187
5.6.13 Passbook Printer (PB b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . . 5-188
5.6.14 Printer (PR b/) Function Data for the Receipt Printer . . . . . . . . . . . . . . . . . 5-189
5.6.15 Printer (PR b/) Function Data for the Journal Printer . . . . . . . . . . . . . . . . . . 5-193
5.6.16 Printer (PR b/) Function Data for Electronic Data Capture . . . . . . . . . . . . . . . 5-195
5.6.17 Statement Printer (SP b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . . 5-197
5.6.18 Do Nothing (.A b/) Function Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-201
5.7 Operational Command Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-202
5.8 Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message . . . . . . 5-208
5.9 Enhanced Operational Command Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-213
5.10 Write Command 5 Message (Open Account Relationship [OAR] screens) . . . . . . . . . . 5-215
5.11 Common Command Reject Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-220
Appendix A ASCII-to-EBCDIC Code Conversion Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Appendix B Network Integration for Check and Coin Processing . . . . . . . . . . . . . . . . . . . . . . B-1
Appendix C Application Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

C.1 General Operation Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
C.2 Transaction Verification Status Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
C.3 Media Player . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
C.3.1 Hardware and Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . C-1
C.3.2 Implementation Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
C.3.3 Programming Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
C.3.4 Making the Media Player Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
C.3.5 Working with Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3
C.3.6 Updating Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4
C.4 Intelligent Depository Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-6
C.5 Euro Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-8
C.6 Agilis 91x Browser Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-9
C.6.1 Transferring Event/information from the Browser to Agilis 91x . . . . . . . . . . . C-9
C.6.2 Transferring Data from Agilis 91x to the Browser . . . . . . . . . . . . . . . . . . . C-11
C.7 ATM Soft Lock Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-13
C.8 Native Capabilities of the Journal Printer . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-14
viii
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Contents
Appendix D VGA Plus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

D.1 Background Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2
D.2 Directories, Files, and Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-7
D.2.1 Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-7
D.2.2 Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-7
D.2.3 Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-9
D.3 Screen Data Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-9
D.4 Terminal Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-12
D.5 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-12
D.5.1 How the Network Recognizes VGA Plus Terminals . . . . . . . . . . . . . . . . . D-13
D.5.2 How to Set Up a Terminal to Support the VGA Plus Feature . . . . . . . . . . . . . D-13
D.5.3 Modifying Screen Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13
D.5.4 Using Chinese Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13
D.5.5 Replacing the ESC Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13
D.5.6 Creating Custom Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-14
D.5.7 Using a High-intensity Monochrome Monitor . . . . . . . . . . . . . . . . . . . . . D-15
D.5.8 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16
D.5.9 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16
D.6 Screen Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16
D.6.1 Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-16
D.6.2 Display Area, Format, and Resolution . . . . . . . . . . . . . . . . . . . . . . . . . D-19
D.7 Row and Column Designator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-23
D.8 Character Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-30
D.9 Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-31
D.10 Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-32
D.11 Color Wheel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-33
D.12 Display Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-33
D.13 Overscan Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-35
D.14 Control Characters and Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-36
D.15 Programming Techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-38
D.15.1 Reducing Phosphor Burn on Color Consumer Displays . . . . . . . . . . . . . . . . D-38
D.15.2 General Techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-41
D.15.3 Using Borders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-42
D.15.4 Using Arrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-44
D.16 Custom Graphic Data Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-48
D.16.1 Procedure to Load Custom Icon and DAC Files . . . . . . . . . . . . . . . . . . . . D-49
D.16.2 Procedure to Load Custom Character Sets . . . . . . . . . . . . . . . . . . . . . . . D-50
D.16.3 Procedure to Load Graphics Automatically . . . . . . . . . . . . . . . . . . . . . . D-51
D.16.4 Screen Design Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-51
D.17 VGA Plus Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-52
D.17.1 Powerup Screen Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-52
D.17.2 Revert File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-54
D.17.3 DAC Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-56
D.17.4 Datetime File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-60
D.17.5 Palette Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-61
D.17.6 Color Wheel Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-62
D.17.7 Sprite Definition Files and Frame Files . . . . . . . . . . . . . . . . . . . . . . . . D-63
D.17.7.1 Creating Frame Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-63
D.17.7.2 Creating Sprite Definition Files . . . . . . . . . . . . . . . . . . . . . . D-64
D.17.7.3 Format of the ASCII Text Sprite Definition File . . . . . . . . . . . . . . D-65
D.17.7.4 Sprite Definition File Commands . . . . . . . . . . . . . . . . . . . . . D-66
D.17.7.5 Sprite Numerical Limits . . . . . . . . . . . . . . . . . . . . . . . . . . D-69
D.17.7.6 Sprite Definition File Example . . . . . . . . . . . . . . . . . . . . . . . D-69
D.18 Palette, Color Wheel, and DAC Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-70
D.18.1 Palette Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-70
ix
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Contents
D.18.2 Color Wheel Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-71

D.18.3 DAC Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-90
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1
Figures
Figure 2-1 Sample Terminal Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Figure 2-2 Terminal Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Figure 3-1 Consumer Interface Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Figure 3-2 Example Default Printing on the Deposit Envelope . . . . . . . . . . . . . . . . . . . . . . . 3-19
Figure 3-3 Example Default Printing on the Deposit Envelope . . . . . . . . . . . . . . . . . . . . . . . 3-20
Figure 3-4 Standard Format for Receipts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
Figure 3-5 Journal Printer Roll Created Using Standard Format Receipt Data . . . . . . . . . . . . . . . 3-60
Figure 4-1 Transaction Amount Display Format - Example . . . . . . . . . . . . . . . . . . . . . . . . 4-30
Figure 4-2 Example Function Key Buffer Byte from Start Entry . . . . . . . . . . . . . . . . . . . . . . 4-131
Figure 4-3 Example Most Significant Byte from Start Entry . . . . . . . . . . . . . . . . . . . . . . . . 4-139
Figure 4-4 Set Buffer State Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-140
Figure 4-5 Example Least Significant Byte From End Entry . . . . . . . . . . . . . . . . . . . . . . . . 4-145
Figure 4-6 Example Most Significant Byte from Start Entry . . . . . . . . . . . . . . . . . . . . . . . . 4-173
Figure 4-7 40-by-20 Display Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-189
Figure 4-8 32-by-16 Display Grid Positioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-190
Figure 4-9 Example Screen 018 - Use of the HT Control Character . . . . . . . . . . . . . . . . . . . . 4-202
Figure 4-10 Example Screen 016 - Use of the FF and SI Control Sequences . . . . . . . . . . . . . . . . 4-203
Figure 4-11 Example Screen 017 - Use of the SO Control Sequence . . . . . . . . . . . . . . . . . . . . 4-204
Figure 4-12 Example Screen Using Animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-205
Figure 4-13 Animation (ESC A Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-208
Figure 4-14 Animation (ESC D Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-211
Figure 4-15 Example Screen Using the Inverse Video Feature (ESC G) . . . . . . . . . . . . . . . . . . . 4-213
Figure 4-16 Template (ESC I Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-216
Figure 4-17 Scrolling Upward (ESC K Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-223
Figure 4-18 Scrolling Leftward (ESC K Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-225
Figure 4-19 Border (ESC R Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-233
Figure 4-20 Tile Display Area Outside Addressable Area . . . . . . . . . . . . . . . . . . . . . . . . . . 4-234
Figure 4-21 Background (ESC U Example) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-236
Figure 4-22 Touch Template Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-263
Figure 4-23 Example Screen Combining Text and an Icon . . . . . . . . . . . . . . . . . . . . . . . . . . 4-265
Figure 4-24 Welcome Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-267
Figure 4-25 Insert Card Animation Icon 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-268
Figure 4-28 Enter PIN Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-271
Figure 4-29 Right Hand Select Transaction Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-272
Figure 4-30 Left Hand Select Transaction Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-273
Figure 4-31 Please Wait Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-274
Figure 4-32 Take Cash Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-275
Figure 4-33 Insert Envelope Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-276
Figure 4-34 Take Receipt Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-277
Figure 4-35 Take Card Icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-278
Figure 4-36 Swipe Card Animation Icon 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-279
x
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Figures

Figure 4-39 Example Balancing Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-306
Figure 5-1 Transaction Message Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Figure 5-2 Write Command 5 Message Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-219
Figure 5-3 Function Command Message Accept/Reject Flowchart . . . . . . . . . . . . . . . . . . . . . 5-222
Figure B-1 Legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Figure B-2 Main Flow Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Figure B-3 Check Deposit with Cash Back Transaction Flow Diagram . . . . . . . . . . . . . . . . . . . B-3
Figure B-4 Cash Check and Deposit Check Transaction Flow Diagram . . . . . . . . . . . . . . . . . . B-4
Figure B-5 Possible Network Actions Flow Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-5
Figure B-6 Error Recovery Flow Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6
Figure C-1 HTML to Agilis 91x Data Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-10
Figure C-2 Agilis 91x to HTML Data Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-12
Figure D-1 DAC Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-4
Figure D-2 Relationship Between Palette and DAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-5
Figure D-3 Screen Data Flow for 16-color Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-10
Figure D-4 Screen Data Flow for 256-color Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-11
Figure D-5 Screen Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-22
Figure D-6 Row and Column Designator for 320 and 640 Pixels . . . . . . . . . . . . . . . . . . . . . . D-23
Figure D-7 Row and Column Designator for 1024 x 768 x 256 Resolution . . . . . . . . . . . . . . . . . D-24
Figure D-8 Location of Row @, Column @ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-25
Figure D-9 Function Key Rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-26
Figure D-10 Rows for Each Screen Type and Resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . D-28
Figure D-11 Moving an Image around on the Screen -- Example . . . . . . . . . . . . . . . . . . . . . . D-40
Figure D-12 Border Technique Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-42
Figure D-13 Arrows and Extension Pieces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-46
Figure D-14 Arrows Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-48
Figure D-15 Sample DAC File (DAC000.ASM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-59
Tables
Table 1-1 Device/Feature Support Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Table 2-1 Terminal Responses to Network Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Table 2-2 Terminal-Resident Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Table 3-1 Key Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Table 3-2 Standard English Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Table 3-3 Standard Alternate Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24
Table 3-4 Greek Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25
Table 3-5 Portuguese Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27
Table 3-6 Cyrillic/Latvian Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-28
Table 3-7 Hungarian/Latin Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30
Table 3-8 Turkish Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31
Table 3-9 Hebrew Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Table 3-10 Arabic Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-35
Table 3-11 Arabic Script Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37
Table 3-12 Lithuanian Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-39
Table 3-13 Code Page 850 Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41
Table 3-14 Printer Control Sequences for Receipt and Journal Printers . . . . . . . . . . . . . . . . . . . 3-43
Table 3-15 Printer Control Sequence Cross-reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-45
xi
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Tables
Table 3-16 Printer Control Sequences for Statement Printers . . . . . . . . . . . . . . . . . . . . . . . . 3-51

Table 3-17 Standard Print Format for the Receipt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
Table 3-18 Example of Printer Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59
Table 4-1 Notation Conventions for Message Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Table 4-2 Write Command Message Common Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Table 4-3 Write Command 1 Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Table 4-4 9000-style State Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Table 4-5 Card Read State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Table 4-6 Read Condition Entry Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
Table 4-7 PIN Entry State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Table 4-8 Deposit State Entries (Envelope Depository) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Table 4-9 Deposit State Entries (IDM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
Table 4-10 Clear Keys State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Table 4-11 Select Function State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
Table 4-12 Dollar Entry State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Table 4-13 Cent Check State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Table 4-14 Information Entry State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
Table 4-15 Transaction Request State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
Table 4-16 Close State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
Table 4-17 Indirect Next State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39
Table 4-18 Card Write State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
Table 4-19 Set Dollar Buffer State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
Table 4-20 Card Read State (T) Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44
Table 4-21 Check Track Buffer State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
Table 4-22 Check Track Buffer State Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-50
Table 4-23 Deposit Extension State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-51
Table 4-24 Voice State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-54
Table 4-25 Copy Buffer State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-56
Table 4-26 Transaction Request Extension State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . 4-58
Table 4-27 Function Key Extension State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-59
Table 4-28 Function Key Extension State Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62
Table 4-29 Withdrawal Area Sensors State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Table 4-30 Set Language Bank State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-65
Table 4-31 Buffer Arithmetic State Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-66
Table 4-32 Text To Speech State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-69
Table 4-33 Card Reader State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-71
Table 4-34 Example Card Reader State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
Table 4-35 Depositor State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-77
Table 4-36 Example Depositor State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-84
Table 4-37 Dispenser Door State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-85
Table 4-38 Example Dispenser Door State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-88
Table 4-39 Get Encrypted PIN State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-89
Table 4-40 Image Character Recognition State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-91
Table 4-41 Lead-through Indicators State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-94
Table 4-42 Example Lead-through Indicators State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-96
Table 4-43 Network Connection State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
Table 4-44 Example Network Connection State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-99
Table 4-45 Printer State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-101
Table 4-46 Example Printer State (Receipt Printer without Exit Sensor) . . . . . . . . . . . . . . . . . . 4-107
Table 4-47 Example Printer State (Receipt Printer with Exit Sensor) . . . . . . . . . . . . . . . . . . . . 4-108
Table 4-48 Example Printer State (Receipt Printer with Exit Sensor) . . . . . . . . . . . . . . . . . . . . 4-109
Table 4-49 Example Printer State (Journal Printer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-110
Table 4-50 Supplemental Dispenser Module (SDM) State Format . . . . . . . . . . . . . . . . . . . . . 4-111
Table 4-51 Statement Printer State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-114
Table 4-52 Example Statement Printer State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-118
xii
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Tables
Table 4-53 Check FIT State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-119

Table 4-54 Example Check FIT State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-121
Table 4-55 Check PIN State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-122
Table 4-56 Example Check PIN State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-125
Table 4-57 Information Entry State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-127
Table 4-58 Example Information Entry State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-132
Table 4-59 Buffer Compare State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-134
Table 4-60 Set Buffer State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-137
Table 4-61 Example Set Buffer State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-139
Table 4-62 Buffer Copy State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-141
Table 4-63 Example Buffer Copy State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-142
Table 4-64 Check Buffer State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-143
Table 4-65 Example Check Buffer State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-146
Table 4-66 Transaction Request State Format (format 0) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-147
Table 4-67 Example Transaction Request State (format 0) . . . . . . . . . . . . . . . . . . . . . . . . . 4-151
Table 4-68 Transaction Request State Format (format 1) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-151
Table 4-69 Indirect Next State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-153
Table 4-70 Example Indirect Next State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-156
Table 4-71 Create Buffer State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-157
Table 4-72 Example Create Buffer State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-159
Table 4-73 Track Buffer Compare State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-160
Table 4-74 Example Track Buffer Compare State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-162
Table 4-75 Buffer Shift State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-163
Table 4-76 Buffer Arithmetic State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-165
Table 4-77 Copy Buffer Data State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-167
Table 4-78 Buffer Overlay State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-171
Table 4-79 Example Buffer Overlay State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-173
Table 4-80 Time Delay State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-175
Table 4-81 Example Time Delay State (start timing) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-176
Table 4-82 Example Time Delay State (stop timing) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-177
Table 4-83 Multi-tasking State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-178
Table 4-84 Set Language Bank State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-181
Table 4-85 Close State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-182
Table 4-86 Example Close State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-183
Table 4-87 Write Command 2 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-184
Table 4-88 Standard Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-191
Table 4-89 Alternate Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-193
Table 4-90 Mosaic Display Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-194
Table 4-91 Screen Control Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-197
Table 4-92 Screen Control Sequence Cross-reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-199
Table 4-93 Example Screen 018 Data - Use of the HT Control Character . . . . . . . . . . . . . . . . . 4-201
Table 4-94 Example Screen 016 Data - Use of the FF and SI Control Sequences . . . . . . . . . . . . . 4-202
Table 4-95 Example Screen 017 Data - Use of the SO Control Sequence . . . . . . . . . . . . . . . . . 4-204
Table 4-96 Icon Animation Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-206
Table 4-97 Reserved Screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-282
Table 4-98 Hex Value/ASCII Symbol Conversion Table . . . . . . . . . . . . . . . . . . . . . . . . . . 4-290
Table 4-99 Reserved Screen 009 Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-300
Table 4-100 Reserved Screen 009 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-307
Table 4-101 Example Control Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-312
Table 4-102 Example Voice Keypad Feedback Commands . . . . . . . . . . . . . . . . . . . . . . . . . 4-315
Table 4-103 Text To Speech XML Tags (SAPI 5.1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-317
Table 4-104 Diebold Text To Speech Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-319
Table 4-105 TTS Examples - Voice Prompting Using Individual Messages . . . . . . . . . . . . . . . . . 4-320
Table 4-106 TTS Examples - Voice Prompting Using Control Files . . . . . . . . . . . . . . . . . . . . . 4-321
Table 4-107 TTS Examples - Voice Keypad Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-322
xiii
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Tables
Table 4-108 Write Command 13 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-324

Table 4-112 Example Uses of Format Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-330
Table 5-1 Consumer Request Message (format 0) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Table 5-2 Consumer Request Message (format 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Table 5-3 Solicited Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14
Table 5-4 Printer Solicited Status (DID = ’2’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
Table 5-5 After Hour Depository Solicited Status (DID = ’3’) . . . . . . . . . . . . . . . . . . . . . . 5-26
Table 5-6 Card Reader Solicited Status (DID = ’>’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27
Table 5-7 Card Writer Solicited Status (DID=’=’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
Table 5-8 Dispenser Solicited Status for 911 Mode (DID = ’8’) . . . . . . . . . . . . . . . . . . . . . . 5-29
Table 5-9 Dispenser Solicited Status for 912 Mode (DID = ’?’) . . . . . . . . . . . . . . . . . . . . . . 5-34
Table 5-10 Dispenser Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
Table 5-11 Depository Solicited Status for Envelope Depository, for 911 Mode (DID = ’:’) . . . . . . . . 5-38
Table 5-12 Depository Solicited Status for Envelope Depository, for 912 Mode (DID = ’A’) . . . . . . . 5-39
Table 5-13 Depository Solicited Status for IDM, for 912 Mode (DID = ’A’) . . . . . . . . . . . . . . . . 5-40
Table 5-14 Configuration ID Solicited Status (DID = ’<’) . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
Table 5-15 Cassette Solicited Status (912 mode) (DID = ’D’) . . . . . . . . . . . . . . . . . . . . . . . 5-43
Table 5-16 Check Point Status Bytes (912 Mode) (DID = ’C’) . . . . . . . . . . . . . . . . . . . . . . . 5-44
Table 5-17 Check Point/Function ID Cross Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
Table 5-18 Coin Dispenser Solicited Status for 912 Mode (DID = ’G’) . . . . . . . . . . . . . . . . . . 5-46
Table 5-19 Coin Dispenser Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47
Table 5-20 Supply Counts Solicited Status (DID = ’H’) . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48
Table 5-21 Enhanced Supply Counts Solicited Status (DID = ’H’) . . . . . . . . . . . . . . . . . . . . . 5-50
Table 5-22 Hardware Configuration Status Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56
Table 5-23 Expanded Hardware Configuration Status Bytes . . . . . . . . . . . . . . . . . . . . . . . . 5-57
Table 5-24 Double Expanded Hardware Configuration Status Bytes . . . . . . . . . . . . . . . . . . . . 5-59
Table 5-25 Receipt Printer Hardware Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62
Table 5-26 Agilis 91x for ix/CSP Printer Character Set Codes . . . . . . . . . . . . . . . . . . . . . . . 5-64
Table 5-27 Example Hardware Configuration Data for Diebold 48-column Thermal Receipt Printer . . . 5-66
Table 5-28 Statement Printer Hardware Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . 5-67
Table 5-29 Reject Reason Codes Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69
Table 5-30 Reject Reason Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71
Table 5-31 Unsolicited Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76
Table 5-32 Operator Codes and Menu Selection Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-79
Table 5-33 Example Maintenance Mode Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80
Table 5-34 Alarm Unsolicited Status (SSF = ’2’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-82
Table 5-35 Supervisory and Supply Actions Status Byte (SSF = ’3’) . . . . . . . . . . . . . . . . . . . . 5-83
Table 5-36 Supervisory and Supply Actions Status Byte Mapping . . . . . . . . . . . . . . . . . . . . . 5-83
Table 5-37 Supervisory and Supply Actions Example (with no options selected) . . . . . . . . . . . . . 5-84
Table 5-38 Supervisory and Supply Actions Example (with Send Status at Logon option selected) . . . . 5-85
Table 5-39 Supervisory and Supply Actions Example (with Send Status at Logon and Send Supervisory
Status at Logon options selected) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-86
Table 5-40 Statuses Sent for Attention Message in Continuous Availability . . . . . . . . . . . . . . . . 5-87
Table 5-41 Supervisory and Supply Actions Status Byte Mapping . . . . . . . . . . . . . . . . . . . . . 5-89
Table 5-42 Supervisory and Supply Actions Example (Send No Status selected) . . . . . . . . . . . . . 5-90
Table 5-43 Supervisory and Supply Actions Example (Send Supply Status selected) . . . . . . . . . . . 5-90
Table 5-44 Supervisory and Supply Actions Example (Send Supervisory Status selected) . . . . . . . . . 5-91
Table 5-45 Statuses Sent for Attention Message in Continuous Availability . . . . . . . . . . . . . . . . 5-92
xiv
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Tables
Table 5-46 Printer Unsolicited Status (SSF = ’4’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-93

Table 5-47 Card Reader Unsolicited Status (SSF = ’5’) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95
Table 5-48 Card Writer Unsolicited Status (SSF = ’7’) . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-96
Table 5-49 IDM Unsolicited Status for 912 Mode (SSF = ’A’) . . . . . . . . . . . . . . . . . . . . . . . 5-98
Table 5-50 Function Command Message (911 Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-106
Table 5-51 Function Command Message (912 Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-108
Table 5-52 Enhanced Function Command Message Format . . . . . . . . . . . . . . . . . . . . . . . . 5-143
Table 5-53 After Hour Depository Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . 5-160
Table 5-54 Coin Dispenser Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-162
Table 5-55 Card Reader Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-165
Table 5-56 Bill Dispenser Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-169
Table 5-57 Depositor Function Data Format (Envelope Depository) . . . . . . . . . . . . . . . . . . . . 5-172
Table 5-58 Depositor Function Data Format (IDM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-174
Table 5-59 Dispenser Door Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-179
Table 5-60 Signage Unit Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-181
Table 5-61 Solenoid Safe Lock Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-183
Table 5-62 Lead-through Indicators Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . 5-185
Table 5-63 Multiple Functions Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-187
Table 5-64 Printer Function Data Format for Receipt Printer . . . . . . . . . . . . . . . . . . . . . . . . 5-189
Table 5-65 Printer Function Data Format for Journal Printer . . . . . . . . . . . . . . . . . . . . . . . . 5-193
Table 5-66 Printer Function Data Format for EDC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-195
Table 5-67 Statement Printer Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-197
Table 5-68 Do Nothing Function Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-201
Table 5-69 Operational Command Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-203
Table 5-70 Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message . . . . . . 5-208
Table 5-71 Enhanced Operational Command Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-213
Table C-1 Predefined Reserved URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-10
Table C-2 Journal Printer Standard Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-14
Table C-3 Journal Printer Alternate Character Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-16
Table C-4 Journal Printer Control Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-16
Table C-5 Printer Control Sequence Cross-reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-17
Table D-1 Configuration Files in ADP00 and ADP01 Subdirectories . . . . . . . . . . . . . . . . . . . D-8
Table D-2 Configuration Files in \DIEBOLD\TCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-8
Table D-3 Sample Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-9
Table D-4 Number of Rows in the Display Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-19
Table D-5 VGA Plus Resolutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-20
Table D-6 Recommended Rows for Lead-through Lines . . . . . . . . . . . . . . . . . . . . . . . . . . D-27
Table D-7 Common Display Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-36
Table D-8 Extension of Arrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-45
Table D-9 Character Sets for the Extending Pieces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-45
Table D-10 Default Palette Register Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-71
Table D-11 Default Color Wheel Set-up Number 000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-71
xv
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Tables

Table D-27 Default DAC Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-90
xvi
TP-821029 (Ed. A)
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.
1.1 About This Manual
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.
This manual is divided into the following sections:
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.
Code Conversion Chart

Appendix A contains a chart with the equivalents for decimal, binary, octal
and hex numbering systems as well as the ASCII and EBCDIC graphic
representations.
Network Integration for Check and Coin Processing

Appendix B contains information on integrating check and coin processing
into an ATM network.
1-1
TP-821029 (Ed. A)
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.
1.2 Related Documents
The following manuals provide additional information on ixSeries terminal

programming needs.
• Agilis 91x for ix/CSP Maintenance Manual (TP-820589-001E)
• Agilis 91x for ix/CSP Installation and Configuration Guide

(TP-820605-001D)
• Agilis 91x for ix/CSP and 91x for CSP Status Reference Manual
(TP-821028-001A)
• TABS Activator Card Magnetic Encoding Format Reference Manual

(TP-770093-000A)
• Data Security Procedures and Reference Manual (TP-799530-001D)
• Enhanced Monochrome Graphics Programming Manual (TP-799300-000A)
• Color Graphics Feature Programming Manual (TP-799344-000A)
For information about network protocols, refer to the documentation supplied

with the Agilis Base Communications (ABC) software.
For programming information about implementing smart card transactions on

Agilis 91x terminals, refer to the Agilis 91x/TCS Plus EMV Programmer’s Guide,
Version 1.0.0 (TP-820874-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.
The abbreviation TCS refers to Diebold’s Terminal Control Software, including

TCS Plus. TCS runs on Diebold i Series, ixSeries, and MDS terminals. TCS is
the predecessor to the Agilis 91x for ix/CSP application.
1-2
TP-821029 (Ed. A)
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
Transaction Host, Message Settings, Status Message, Terminal Model Number
For further information about configuration settings and configuration

options, refer to the Agilis 91x for ix Installation and Configuration Guide
(TP-820605-001D). For readers familiar with TCS, these terms replace
references to DIT settings.
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.
The abbreviation ABC refers to Agilis Base Communications. ABC is a

data communications package that provides support for a wide variety of
communications protocols.
1.4 Supported Devices and Features
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Introduction
Table 1-1 Device/Feature Support Summary
Feature Supported/required by Agilis

91x for ix/CSP, Version 1.6
Processor
Hard Drive Capacity 15GB or higher
Minimum Memory 256MB
Minimum Processor Support Pentium III 500Mhz or higher
Operating system XP Professional
911 Yes
911 Bill Mix Support Yes
912 Yes
Advanced Supply Manager Yes
After Hours Depositor (AHD) Yes
Bulk Note Acceptor No
Bulk Note, Article 6 Support (Back tracing) No
Camera Yes
Card Readers
Card Reader, Chip Card Support Yes
Card Reader, Motorized Yes
Card Reader, Swipe Yes
Card Reader, Dip Yes
Continuous Availability (CAS) Yes
Cash Pocket No
Check Depositor IDM Yes -IDM2/3
Communications Protocols:
- Burroughs Async Poll Select (TC 500) Yes
- Burroughs SYNC Poll/select (TC 800) No
- CCITT X25 Yes
- Datapac Yes
- IBM 3271 ASCII No
- IBM 3271 Bisync EBCDIC Yes
- IBM 3271 SDLC Slave No
- IBM Comm Manager LU 6.2 No
- IBM SNA on TCP/IP Yes
- IBM SNA on TN3270 Yes
- IBM SNA on X25 Yes
- IBM SNA/SDLC, QLLC Yes
- NCR 751 No
Coin Acceptor No
Coin Dispense Yes
1-4
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Introduction
Table 1-1 Device/Feature Support Summary (continued)

Consumer Video
Consumer video/MPEG Yes
OAR Write V messages Yes
Touch Screen Yes
Voice Text to Speech Yes
Voice Wav files Yes
Web Enablement Yes
Web Enablement, Phase 2, (For example, printing web pages, and manage ATM No
Devices)
Contact Indicators/Alarms Yes
Counters Yes
Customer Lead Thru Lights Yes
Depositor Yes
DES Encryption modes Yes
Device Self Tests Yes
Device Statuses Yes
Diagnostics Yes
Dial up (Visa II Dial Transfer Client) Yes
Dispenser Yes
- Partial Dispense Capability Yes
- Retract behind shutter Yes
- Test for low by position Yes
- Totals by cassette position Yes
- Totals by denomination No
Dual Monitor/Gui Rear Screen Maintenance Yes
Extended Applications
ACI Remote Client Yes
Electronic Data Capture (EDC) Yes
EMS Remote Notifier Yes
EMV Application Support Yes
ImageWay Yes
iq ESD Agent (TCP/IP support only) Yes
iqCRM Agent Yes
Local Screen Change (LSC) Yes
MAC - Message Authentication Application Includes Full or Partial message Yes

authentication
Terminal Resident PACE No
1-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Introduction

Extended Applications Continued
XApCheck Plus Yes
XApCom Plus Yes
XApCoupon Plus (Configurable printing or dispensing of coupons) Yes
XApEvent Plus No
XApImage Yes
XApLogo Plus (Print graphic logos on receipts) Yes
Electronic Journal Yes
EMV Yes
Encrypting PIN Pad
EPP2 Yes
EPP4 or Encrypting Pin Pad Yes
Escrow for dispense validation Yes
Graphics mode Yes
Keyboard Yes
Loading DES Keys from Disk Yes
Maintenance Features
Maintenance Scripting Yes
Maintenance Sequencing Yes
Password Access Yes
Presenter Yes
Printers
Printer, Advanced Passbook No
Printer, Basic Passbook No
Printer, Impact Receipt (35 col. 204 model) No
Printer, Impact Receipt (40 Col. 956 model) Yes
Printer, Journal Yes
Printer, Statement Printer - DH No
Printer, Thermal Receipt (Native 91x print data) Yes
Printer, Thermal Statement (Both emulated consumer and thermal statement modes) Yes
RBM Yes
Rear monitor language support Yes
Recognition Subsystem for Imaging Yes
Recycler (HCM) Yes
Remote Key Loading Yes
SDM Automatic Dispensing Mode Yes
SDM Enhanced State support for host control Yes
1-6
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Introduction

Supply Statuses Yes
TCP/IP Yes
Test Dispense Yes
TIA Yes
Tracing/Log files Yes
TTU (16x40) N/A
Video Supply Instructions Yes
1-7
TP-821029 (Ed. A)
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:
• Network configurations (Section 2.1)

• Terminal configuration (Section 2.2)
• Modes of operation (Section 2.3)
• Additional applications (Section 2.4)
2.1 Network Configurations
Agilis 91x for ix/CSP enabled terminals can operate in the following network
configurations:
• Online to a controller that is, in turn, connected to a host computer (on-host)

• Online to a host (direct connect)
• Online to a controller that is not connected to a host computer (off-host)
All three network types are shown in Figure 2-1.
g5966001a
Figure 2-1 Sample Terminal Networks
2.2 Terminal Configuration
In order to perform transactions, the terminal must be loaded with additional

information (configuration data). The configuration data includes information
on how to sequence a transaction, what messages to display to the consumer,
card verification methods, how long to wait for consumer responses, and other
variable information. The configuration data and the transfer of this data to the
terminal is the responsibility of the network application software.
2-1
TP-821029 (Ed. A)
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.
Refer to Section 4 for more information on configuration data.
2.3 Modes of Operation
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
Figure 2-2 Terminal Operation
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Overview
2.3.1 Power-up Mode
The terminal enters the Power-up mode when one of the following events occurs:
• The terminal is powered up

• The terminal is initialized (an operator presses the Reset button)
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.
2.3.2 Out-of-service Mode
The terminal enters the Out-of-service mode from any one of the following
modes:
• The Power-up mode
• The Off-line mode
• The In-service mode (if the terminal receives a shutdown command from
the network)
• The Maintenance mode
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.
The terminal accepts and stores configuration data while it is in the

Out-of-service mode. During this time, the terminal can also receive and execute
Print Immediate, Startup, and Shutdown commands from the network.
Depending upon what mode the terminal was in before going Out-of-service, the
terminal might be able to perform other functions.
2.3.3 Off-line Mode
The terminal enters the Off-line mode from any of the following modes:
• In-service mode
• Out-of-service mode
• Power-up mode
The Off-line mode is entered from the In-service mode if communication is lost
between the network and the terminal.
2-3
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Overview
While in the Off-line mode, the terminal operates as follows:
• The terminal displays the Off Line screen (screen 001, unless redefined by
the network) on the consumer display.
• The terminal enters an idle loop until network communication is restored.
The terminal exits this mode under the following conditions:
• Communication with the network is restored.

• The terminal enters the Maintenance mode.
• An abnormal exit occurs.
2.3.4 In-service Mode
The terminal enters the In-service mode from any of the following modes:
• The Out-of-service mode (if the terminal receives a Startup command

from the network)
• The Maintenance mode (if the Automatic Return to Previous Mode

feature is enabled)
• The Off-line mode (if communication with the network is restored)
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.
• The terminal loses communication with network; the terminal exits to

the Off-line mode.
2-4
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Overview
• The terminal manager initiates maintenance procedures; the terminal exits to

the Maintenance mode after finishing any consumer transactions in progress.
• An abnormal exit occurs.
NOTE
Except when an abnormal exit occurs, the In-service mode

can only be exited from state 000.
2.3.5 Maintenance Mode
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).
Depending on the configuration option selected for Transaction Host, an Agilis

91x for ix/CSP terminal can send the network an Unsolicited Status message
when the terminal enters the Maintenance mode. Refer to Section 5.3 for
further information.
The terminal manager must manually place the terminal in the Maintenance
mode. The network cannot command the terminal to enter this mode.
While in the Maintenance mode, the terminal responds to network messages

as follows:
• The terminal processes Write Command messages and replies with Solicited
Status messages indicating either a Ready condition or a Command
Reject condition.
• Depending on the configuration options selected for the Transaction Host,

the terminal might process a Function Command message containing
a Print Immediate function identifier and reply with a Solicited Status
message indicating a Ready condition. Otherwise the terminal’s response is
a Solicited Status message indicating a Command Reject condition.
• The terminal responds to all other Function Command messages with a

Solicited Status message indicating a Command Reject condition.
• The terminal responds to an Operational Command message requesting

configuration information with a Solicited Status message containing
configuration information.
• The terminal accepts Operational Command messages requesting startup

or shutdown but does not process or reply to them until the terminal exits
the Maintenance mode.
If the terminal receives any Operational Command messages requesting startup

or shutdown while in the Maintenance mode, then upon exiting the Maintenance
mode, the terminal processes the last such message received and sends the
network a Solicited Status message indicating a Ready condition.
2-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Overview
Automatic Return to Previous Mode

The Automatic Return to Previous Mode feature configures a terminal to
automatically return to service when exiting the Maintenance mode if the
terminal was in service before entering the Maintenance mode. If the feature
is disabled, the terminal remains out of service when exiting the Maintenance
mode. This configurable feature is enabled by default. Refer to the Agilis 91x for
ix Installation and Configuration Guide (TP-820605-001D) for information on
configuration.
2.3.6 Continuous Availability
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)
2.3.7 Terminal Responses to Network Commands
The terminal responds differently to Network messages depending on which

mode of operation the terminal is in. Table 2-1 describes terminal responses
to specific network messages. For details on specific network messages, refer
to Section 5.2.
NOTE
All occurrences of Reject (’A’) response can also be sent as

a Reject (’D’) response if the Send Reject Reason Codes
feature is enabled in the Miscellaneous Features 2 field of a
Write Command 3 message. Also, if the MAC application
is enabled, Reject (’C’) responses can occur for Function
Command messages if the time variant number or MAC
code field is incorrect.
2-6
TP-821029 (Ed. A)
2-7
Overview
Table 2-1 Terminal Responses to Network Commands
Commands Terminal Response to Command When Terminal Is:
In-service, No Consumer Consumer Session In Progress Out-of-service In Maintenance

Session In Progress
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’)

(Configuration request)
Operational Command ’6’ Ready (’9’) Ready (’9’) Ready (’9’) Ready (’9’)
Mon Nov 22 16:28:25 2004

(Authorize unlocking the solenoid
safe lock)
Operational Command ’7’ Ready (’9’) Ready (’9’) Ready (’9’) Ready (’9’)
(Disallow unlocking the solenoid

safe lock)
Operational Command ’8’ Reject (’A’) Reject (’A’) Ready (’9’) (must be set for EMG Reject (’A’)
and out-of-service screen must be

(Enhanced Monochrome using bank 0)
Graphics)
Operational Command ’9’ Configuration information (’8’) Configuration information (’8’) Configuration information (’8’) Configuration information (’8’)
(Retrieve supply counts)
Operational Command ’:’ Reject (’A’) Reject (’A’) Configuration information (’8’) Reject (’A’)
(Retrieve and clear supply counts)

[1] Depending on configuration options, the operational command can be rejected.
[2] Also returns a Supervisory and Supply Actions status (Maintenance logon or logoff).
TP-821029 (Ed. 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)
Table 2-1 Terminal Responses to Network Commands (continued)

Session In Progress
Operational Command ’;’ Configuration information (’8’) Configuration information (’8’) Configuration information (’8’) Configuration information (’8’)
(Retrieve enhanced supply

counts)
Operational Command ’<’ Reject (’A’) Reject (’A’) Configuration information (’8’) Reject (’A’)
(Retrieve and set/clear enhanced

supply counts)
[2] [2]

Operational Command ’=’ Ready (’9’) Reject (’A’) Ready (’9’) Reject (’A’)
(Run self-test)
Mon Nov 22 16:28:25 2004

Operational Command ’>’ Ready (’9’) Reject (’A’) Ready (’9’) Reject (’A’)
(Conditional go out-of- service to

consumers)
Write Commands Ready (’9’) [3] Ready (’9’) [3] Ready (’9’) Ready (’9’) [3]
(Except for Write Command 5)
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’)
(Except ’4’ [print immediate] and

’D’ [print and wait])
[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.
Overview
2-8
2-9
Overview
Table 2-1 Terminal Responses to Network Commands (continued)

Session In Progress
Function Commands ’4’ and ’D’ Reject (’A’) Ready (’9’) [4] [6] Ready (’9’) Reject (’A’) [5]
(Print immediate, and print and

wait)
Enhanced Function Commands Reject (’A’) Ready (’9’) [4] [6] Reject (’A’) Reject (’A’)
[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.
Mon Nov 22 16:28:25 2004

TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Overview
2.4 Additional Applications
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.
Table 2-2 Terminal-Resident Applications
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
This application supports currency mixing only
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Overview
Table 2-2 Terminal-Resident Applications (continued)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Overview
Table 2-2 Terminal-Resident Applications (continued)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Section 3
ix Series Terminals and Devices
This section provides information specific to ixSeries terminals and terminal

devices.
ixSeries terminals
Agilis 91x for ix/CSP can be installed on any ix/CSP Series terminal including
the following terminals:
• 1062ix/CSP Secure Interior ATM (Front-load or Rear-load)

• 1063ix/CSP Compact Cash Dispenser
• 1064ix/CSP Interior Cash Dispenser (ICD)
• 1064ix/CSP Exterior Cash Dispenser (ECD)
• 1072ix/CSP Thru-the-wall Walk-up ATM
• 1073ix/CSP Thru-the-wall Drive-up ATM
• 1074ix/CSP Island ATM
Section 3.1 through Section 3.4 describe the devices that can be installed with
Agilis 91x for ix/CSP in ixSeries terminals.
CashSource Plus Terminals

Agilis 91x for ix/CSP can be installed on any Diebold CSP 410/400 terminal with
the following capabilities:
• 566 MHz processor or greater

• 256 MB RAM or greater
• Large Capacity Hard Drive (15.0 GB or greater)
Devices Currently Not Supported

Refer to Section 1.4 for information on devices that are not currently supported
by Agilis 91x for ixSeries terminals.
3.1 Card Readers
The types of card readers available for ixSeries terminals are as follows:
• Motorized; read track 2 only

• Motorized; read tracks 1, 2, and 3; write track 3
• Motorized smart card reader; multiple configurations available
• Swipe-style; read track 2 only
• Swipe-style; read tracks 2 and 3
• Dip card reader; read tracks 1 and 2
• Dip smart card reader; read tracks 1, 2, and 3, plus chip connect
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:
• Read the magnetic stripe on the card (read)
• Reread the magnetic stripe (verify)
• Update information on the magnetic stripe (track 3 write)
• Return the card to the consumer when the transaction is complete
• Retract the card
• Return the card to the consumer when a power problem occurs, if the
terminal has the Card Return on Powerfail option
3.2 Multi-media Dispenser
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.
3.3 Supplemental Dispenser Module (SDM)
The Supplemental Dispenser Module (SDM) is a single hopper media dispenser

that can provide additional ATM functionality (presently, only deposit envelope
dispensing). The supplemental dispensing feature uses the supplemental
dispenser hardware module.
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.
The automatic dispensing mode works as follows:
1. At the beginning of the deposit function, reserved screen #910 is

displayed, asking the consumer if media is needed (an envelope).
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. If the response is No or Cancel, the terminal proceeds to the deposit

operation without dispensing media.
4. If there is no response from the consumer within the time-out interval

specified for Timer 00, the terminal proceeds to the deposit operation
without dispensing media.
3-2
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
There is a configurable consecutive fault count that is used to temporarily disable

automatic dispensing. The default value for this count is 5. The count can be
cleared and automatic dispensing can be resumed by completing a successful
self test on the SDM. If the envelope dispensing is disabled, reserved screen
#911 is displayed, informing consumers that envelopes are not available and
asking consumers if they want to continue the deposit operation. A Yes response
continues the deposit operation. A No or Cancel response cancels the deposit
operation and returns a depositor consumer cancel status.
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 Intelligent Depository Module (IDM)
The Intelligent Depository Module (IDM) is a modular addition that is physically

and electrically compatible with the envelope depositor. The IDM option is
designed to perform the functions of the depositor module and adds ATM
features and functions for check reading and cashing. More details on IDM
implementation are contained in Appendix Band Appendix C.4.
3.4.1 Features
The IDM has the following features:
• Handles various sizes of checks, documents, and envelopes as follows:
- Media length of 152.40 mm (6 in.) to 25.4 mm (1 in.)

- Media width of 69.85 mm (2.75 in.) to 111.13 mm (4.375 in.)
- Maximum filled envelope thickness of 12.7 mm (0.5 in.)
• Reads all fields from magnetic ink character recognition (MICR) encoding
strip
• Reads MICR documents inserted in any orientation (as configured by the

banking institution). This is a configurable option; refer to the Agilis 91x for
ix Installation and Configuration Guide (TP-820605-001D) for information
on configuration.
• Performs duplex operation to find the MICR line. This is a configurable

option; refer to the Agilis 91x for ix Installation and Configuration Guide
(TP-820605-001D) for information on configuration.
• Deposits or returns a single document from escrow
• Performs either network-defined or default printing on an envelope or

a document
3-3
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• Prints a single line (100 characters maximum) of Latin-style alphanumeric

characters using an ink jet print head. The location of the printed line is
variable and is determined by configuration settings. Depending upon the
length of the envelope or document, the IDM automatically selects 10 cpi
type or 16 cpi type (condensed) to prevent overruns.
• Deposits envelopes into a convenience (non-tamper indicating) or a secure

(tamper-indicating) cassette
• Has an envelope cassette capacity of approximately 500 deposit envelopes
• 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
3.4.2 MICR Data
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.
3.4.3 System Firmware
An ATM containing an IDM is compatible with any 912 system. As with

other enhancements, network or local changes are required to use the IDM’s
capabilities. Configuration data, function commands, and installation parameter
changes are necessary.
3.4.4 Image Scanner
The image scanner system for the IDM consists of the following components:
• Scan head (high-speed CCD line sensor)
• Imaging processing (IP) CCA
• IDM scanner power and logic cable
• Character recognition (RECO) (software option with IP that reads the

amount field)
3-4
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
• Displayed to institution personnel via networks, such as a LAN, for

verification
• Sent to the network
• Stored on a hard drive or a floppy disk
3-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.5 Consumer Interface Panel
The consumer interface panel consists of the following items:
• Consumer display (Section 3.5.1)

• Function keys and consumer keypad (Section 3.5.2)
Figure 3-1 shows some typical configurations of the consumer interface panel on
ixSeries terminals.
3-6
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g5966003a
Figure 3-1 Consumer Interface Panel
3-7
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.5.1 Consumer Display
ixSeries terminals are equipped with VGA monitors (either monochrome or

color) for use as the consumer display. All monitors support the following
video options:
• 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.
3.5.2 Function Keys and Consumer Keypad
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
If the terminal is equipped with a touch screen, the terminal

might not have any physical function keys. If touch buttons
corresponding to function keys F through I are to be enabled,
extension states and extended Write Command 5 messages are
still required for activation.
ixSeries terminals can have either an 11-key Consumer Keypad (standard

Consumer Keypad) or a 16-key Consumer Keypad (enhanced Consumer
Keypad). The 11-key Consumer Keypad contains the following keys:
• Numeric keys 0 through 9

• Function key E (labeled CANCEL)
3-8
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The 16-key Consumer Keypad contains the following keys:
• Numeric keys 0 through 9

• Decimal point key
• Function key E (labeled STOP)
• Function key J (labeled OK)
• Function key K (labeled CORR)
• Function key L (unlabeled)
• Function key M (unlabeled)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
For each numeric key and function key, the data byte sent to Agilis 91x for
ix/CSP is shown in Table 3-1.
Table 3-1 Key Codes
Byte Sent to Network
Key ASCII ASCII EBCDIC

Graphic Hex Hex
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
Agilis 91x for ix/CSP operating in 912 mode ignores

keypresses of the decimal point key during transaction amount
entry, unless the Decimal Style feature is selected in a Write
Command 3 message (Section 4.23). Agilis 91x for ix/CSP
does not place a decimal point character in the dollar buffer,
and no decimal point appears on the consumer display.
3-10
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.6 Lead-through Indicators
Some ixSeries terminals are equipped with lead-through indicators positioned

near the following components on the terminal’s fascia:
• Card reader bezel

• Depository slot
• Bill delivery area
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
For detailed information about Alarm statuses, refer to Section 5.3.2.
3.8 Receipt Printer
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.
Depending on printer capabilities and network requirements, the receipt printer

can be configured for any one of the following printing strategies:
• Graphics-related
• Text-related
• Pass-through
Graphics-related strategies require a printer (and printer XFS SP) capable of

printing graphic images. For graphics-related strategies, Agilis 91x for ix/CSP
renders the receipt as a graphic image. This image is then sent to the printer
as a bitmap or as raster data, as appropriate to the printer. Control sequences
within the print data are used as instructions to Agilis 91x for ix/CSP for building
the graphic image, and are extracted at that level instead of being passed to the
printer. For detailed information about graphics-related printing strategies,
refer to Section 3.8.
3-11
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Text-related strategies permit printable characters (hex 20 through 7E, ASCII),

line feeds (hex 0A, ASCII), carriage returns (hex 0D, ASCII), and form feeds
(hex 0C, ASCII). All other non-printable characters (for example, control
characters) are stripped from the print data before the print data is sent to the
printer. Text-related strategies do not support graphics, line or character pitches,
emphasis (bold, underline), alternate character sets, or any other special printing
features.
The pass-through strategy requires complete hardware dependence by the host.

All print data received from the host is passed directly to the printer without
processing, except for the addition of a print header. The print header contains
proprietary Diebold control sequences intended for Diebold printers.
NOTE
Because the effect of this header on non-Diebold printers is

uncertain, the pass-through strategy is not recommended
for non-Diebold printers.
Using Blank Paper

In order for Agilis 91x for ix/CSP to notify the network that the terminal is using
blank paper, the network must direct the terminal to use the expanded version of
the Hardware Configuration status (Section 5.2.20).
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.
Opteva Two-color Graphical Receipt Printer

The Opteva Two-color Graphical Receipt Printer uses direct thermal printing.
The receipt printer has the following features:
• Prints on paper that is 80 millimetres (3.15 inches) wide
• Supports graphics-related printing strategies
• Provides high-resolution graphic printing (8 dots per millimeter, 203 dots

per inch)
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:
• Lowest horizontal pitch: 11 characters per inch (permits up to 30 characters

per line)
• Medium horizontal pitch: 13 characters per inch (permits up to 35 characters

per line)
• Highest horizontal pitch: 19 characters per inch (permits up to 49 characters

per line)
• Lowest vertical pitch: 6 lines per inch
• Highest vertical pitch: 8 lines per inch
ix/CSP Series 48-column Thermal Consumer Printer

On Diebold ixSeries terminals, Agilis 91x for ix/CSP supports the 48-column
Thermal Consumer Printer (models 1670 and 1879) for use as the receipt printer.
The 48-column Thermal Consumer Printer has the following features:
• Can use paper with top-of-form (TOF) marks or blank paper
• Prints on paper up to 80 millimetres (3.14 inches) wide
• 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:
• PCX logo files: 448 pixels wide by 152 pixels high

• PCX and WIN32 graphics files: 448 pixels wide by 1169 pixels high
If a pass-through strategy or pass-through mode is preferred, refer to the 80 mm

Thermal Receipt Printer Application Guide (TP-799984-001C) for information
on the printer’s native control sequences and character sets.
ix/CSP Series 35-column Consumer Printer (956)

Agilis 91x for ix/CSP supports the 35-column Consumer Printer (model 956)
on Diebold ixSeries terminals. The 35-column Consumer Printer is an impact
receipt printer. This receipt printer has the following features:

• Supports graphic printing
3-13
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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 support graphics-related printing

strategies. Either the pass-through strategy or a text-related strategy must be used
with this receipt printer. If the pass-through strategy is preferred, the following
printing pitches are available through the native capabilities of the receipt printer:

per line with normal margins)

per line with normal margins)
• Highest horizontal pitch: 16.5 characters per inch (permits up to 35

characters per line with normal margins)
For information on the printer’s native control sequences and character

sets, refer to the 35/40 Column Impact Receipt Printer Application Guide
(TP-820211-001A).
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.
3.9 Journal Printer
To print transaction information on the journal printer, the network must send
of print data to the journal printer.
Depending on printer capabilities and network requirements, the journal printer

can be configured for any one of the following printing strategies:
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Opteva Journal Printer

The Opteva journal printer uses direct thermal printing. The journal printer
has the following features:
• Provides high-resolution graphic printing (8 dots per millimeter, 203 dots

per inch)
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:

per line)

per line)
• Highest horizontal pitch: 21 characters per inch (permits up to 43 characters

per line)
3-15
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
ix/CSP Series Journal Printer

The Diebold ix/CSP Series journal printer is an impact printer that prints up to 40
characters per line on rolled paper.
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.
If a pass-through strategy or pass-through mode is preferred, refer to

Appendix C.8 for information on the printer’s native control sequences and
character sets.
3.10 Statement Printer
Agilis 91x for ix/CSP supports a statement printer.
To print transaction information on the statement printer, the network must send
of print data to the statement printer.
Depending on printer capabilities and network requirements, the statement

printer can be configured for any one of the following printing strategies:
• 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.
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). This
method doubles the size of the printer data transmitted to the terminal, but
removes all restrictions on the content of the printer data. As an example,
expanded ASCII format can be useful for transmitting 8-bit data across 7-bit
networks.
Receipt Printer Emulation

If the statement printer is the only consumer print device in the terminal, it can
serve as both a statement printer and as a receipt printer. When the statement
printer serves as the receipt printer, this service is called receipt printer emulation.
With receipt printer emulation, Agilis 91x for ix/CSP routes both statement jobs
and receipt jobs to the statement printer.
3-16
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Another method of handling lengthy printer data is to use the Statement

Printer state (Section 4.5.12). The Statement Printer state allows the
network programmer to send printer data for the statement printer in normal
(non-expanded) ASCII format, taking up half the number of bytes as the
expanded ASCII formatted printer data. State data in the Statement Printer state
would then specify that the expected format of the printer data is normal ASCII.
EXAMPLE
The following example shows how the Statement Printer state could be used to
print data that is in normal (non-expanded) ASCII format.
1. The Function Command message sent by the network contains the

following data:
• Function ID Z (do nothing)

• Printer flag ; (store printer data in buffer S)
3-17
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• Printer data in normal ASCII format

• Next state ID pointing to the first Statement Printer state
2. The first Statement Printer state contains the following data:
• Operation 004 (print and wait)

• Print data ID 083 (buffer S)
• Print data type 003 (data in buffer is normal ASCII)
• Good operation next state pointing to a second Statement Printer state
3. The second Statement Printer state specifies operation 003 (deliver and
wait) to deliver the printed statement.
Opteva Two-color Statement Printer

The Opteva two-color statement printer uses direct thermal printing technology.
The statement printer offers high-resolution graphic printing (8 dots per

millimeter, 203 dots per inch) on A4-sized paper (210 millimetres wide, 8.27
inches wide) or letter-sized paper (216 millimetres, 8.5 inches wide). The
statement printer supports programmable page length, if desired. The statement
printer offers a single-document retract feature, but not multi-document bundling.
The statement printer is equipped with an exit sensor.
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.
3.11 Deposit Printer
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).
3.11.1 Transaction Serial Number
The transaction serial number is the same four-character transaction serial

number sent in the Function Command message. This number originates at the
network and identifies the transaction to the network.
3.11.2 Dollar and Cents Keyboard Entry
The dollar and cents keyboard entry is the dollar amount entered by the
consumer. This field is 12 characters long.
3-18
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
If a deposit transaction follows another transaction with no Close state between,

and if the deposit transaction does not go through a Dollar Entry state or a Set
Dollar Buffer state, the deposit printer prints the previous transaction’s Dollar
Buffer. A Tellergram is an example of such a transaction. If it is not appropriate
to print the previous buffer data for the transaction, you can add a Set Dollar
Buffer state to the transaction sequence to set the Dollar Buffer to zeros.
3.11.3 Track Data
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.
3.11.4 Printing Network Data on the Envelope
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
Figure 3-2 Example Default Printing on the Deposit Envelope
3-19
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.11.5 Deposit Printer Text
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
Figure 3-3 Example Default Printing on the Deposit Envelope
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.
If a deposit transaction follows another transaction without a Close state between,

and if the deposit transaction does not go through a Dollar Entry state or a Set
Dollar Buffer state, the deposit printer prints the previous transaction’s Dollar
Buffer. A Tellergram is an example of such a transaction. If it is not appropriate
to print the previous transaction’s Dollar Buffer data for the deposit, you can add
a Set Dollar Buffer state to the transaction sequence to set the Dollar Buffer
to zeros.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Network Generated Text

The network can send text to print on the deposit envelope, instead of the
default data. The maximum number of characters that can be printed on the
envelope depends on the deposit printer used in the terminal. Refer to Section 5.5
and Section 5.6 for more information on sending network deposit printer data
to a terminal.
3.12 Print Data Programming for Graphics-related Strategies
Print data programming is the same for all graphics-related strategies. This
section discusses the following aspects of print data programming:
• Character sets (Section 3.12.1)

• Control sequences (Section 3.12.2)
• Changing character sets (Section 3.12.4)
• Standard format for the receipt (Section 3.12.5)
3.12.1 Character Sets
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:
• Standard English (Table 3-2)

• Standard Alternate (Table 3-3)
• Greek (Table 3-4)
• Portuguese (Table 3-5)
• Cyrillic/Latvian (Table 3-6)
• Hungarian/Latin (Table 3-7)
• Turkish (Table 3-8)
• Hebrew (Table 3-9)
• Arabic (Table 3-10)
• Arabic Script (Table 3-11)
• Lithuanian (Table 3-12)
• Code Page 850 (Table 3-13)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-2 Standard English Character Set
3-22
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-2 Standard English Character Set (continued)
3-23
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-3 Standard Alternate Character Set
3-24
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-4 Greek Character Set
3-25
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-4 Greek Character Set (continued)
3-26
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-5 Portuguese Character Set
3-27
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-6 Cyrillic/Latvian Character Set
3-28
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-6 Cyrillic/Latvian Character Set (continued)
3-29
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-7 Hungarian/Latin Character Set
3-30
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-8 Turkish Character Set
3-31
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-8 Turkish Character Set (continued)
3-32
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-9 Hebrew Character Set
3-33
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-9 Hebrew Character Set (continued)
3-34
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-10 Arabic Character Set
3-35
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-10 Arabic Character Set (continued)
3-36
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-11 Arabic Script Character Set
3-37
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-11 Arabic Script Character Set (continued)
3-38
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-12 Lithuanian Character Set
3-39
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-12 Lithuanian Character Set (continued)
3-40
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-13 Code Page 850 Character Set
3-41
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-13 Code Page 850 Character Set (continued)
3-42
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.12.2 Control Sequences for Receipt Printers and Journal Printers
The graphics-related strategies allow the network to change the printing

characteristics of the receipt printer and the journal printer by sending appropriate
control sequences with the printer text in the Printer Data field in a Function
Command message. The printing characteristics include the character set, the
horizontal and vertical pitches, the printing density, and the printing width.
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
The TCS control sequences for graphics mode (+ = / and

ESC =) are not directly supported by Agilis 91xfor ix/CSP.
However, certain Epson impact printers support them as part
of their native print capabilities. If desired, these control
sequences can be sent directly to graphics-mode-capable
printers by the use of the pass-through strategy or pass-through
mode.
Table 3-14 Printer Control Sequences for Receipt and Journal Printers
Control Sequence Description
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.
CR Prints a line of characters, then does a carriage return.
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 Cuts and delivers a form.
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)
ESC D Prints the specified file.
ESC E 0 Disables emphasized (bold) printing.
ESC E 1 Enables emphasized (bold) printing.
ESC h 0 Disables double high printing

[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.
3-43
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-14 Printer Control Sequences for Receipt and Journal Printers (continued)
ESC h 1 Enables double high printing
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 L 0 Disables landscape printing.
ESC L 1 Enables landscape printing.
ESC N 0 Disables data pass-through mode.
ESC N 1 Enables data pass-through mode.
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 T The following data is a continuation of the previous data.
ESC U 0 Disables underline printing.
ESC U 1 Enables underline printing.
ESC $ Sets lowest vertical pitch (default). [2]
ESC % Sets highest vertical pitch. [2]
ESC & Sets lowest horizontal pitch. [2]
ESC ’ Sets medium horizontal pitch (default). [2]
ESC ( Sets highest horizontal pitch. [2]
ESC ) Sets lowest horizontal pitch with double-density printing. [2]
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.
ESC W 0 Cancels double-width printing.
ESC W 1 Sets double-width printing.
ESC Z 0 Disables compressed margin printing.
ESC Z 1 Enables compressed margin printing.

3-44
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Table 3-15 Printer Control Sequence Cross-reference
Control ASCII Hex EBCDIC Hex

Code Equivalent Equivalent
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-15 Printer Control Sequence Cross-reference (continued)

Code Equivalent Equivalent
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.
The printing characteristics from previous Function Command messages do not

remain in effect for subsequent Function Command messages because Agilis 91x
resets the printer to its default characteristics each time Agilis 91x receives a
Function Command message for a print operation. The network must specify all
the applicable print characteristics in each Function Command message.
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.
PCX-format files must meet the following requirements:
• ZSoft PCX format

• Non gray-scaled: Monochrome, 16 colors, or 256 colors
• Gray-scaled: 16 shades or 256 shades
3-46
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• PCX version 2.5, 2.8, or 3.0

• PCX Run Length Encoding (RLE)
• Single color plane with up to 256 colors, or four color planes with 1-bit color
WIN32 bitmap files must meet the following requirements:
• Version 4 header
• Non gray-scaled: Monochrome, 16 colors, or 256 colors
• Gray-scaled: 16 shades or 256 shades
A PCX-format graphics file must use the extension .PCX. A PCX-format

logo file must have the extension .LCX. WIN32 bitmap files must have the
extension .BMP.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
The host programmer using pass-through mode is responsible

for making sure that the data passed through to the printer is
compatible with the printer-specific character sets, control
sequences, and operating characteristics of the target printer.
Refer to the documentation provided with the printer.
Pass-through mode is enabled by the control sequence ESC N 1. The printer

data that follows ESC N 1 must be in expanded ASCII format. Agilis 91x
compresses the data into normal (non-expanded) ASCII format before passing
the data to the printer. Agilis 91x performs no other processing or filtering
of the data that follows ESC N 1.
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). This method doubles the size of the printer data transmitted
to the terminal, but removes all restrictions on the content of the printer data.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
ESC Q (terminals with IDM and RSS only)

The ESC Q control sequence prints a scanned image from the Recognition
Subsystem (RSS). ESC Q prints the contents of the last window defined by an
Image Character Recognition state with an Enable operation (operation 000).
The default size for this image is 100%. However, these images can be scaled by
modifying the Depositor device properties. The valid range for the size of the
scanned image is 100% to 200%.
ESC R (terminals with IDM and RSS only)

The ESC R control sequence prints a scanned check image. The format for the
ESC R control sequence is as follows:
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
If the width of the image exceeds the width of the printable

area on the paper (paper width, minus print margins), Agilis
91x automatically adjusts the size of the check image to fit.
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:
• Standard English - STD14CPI.MAP

• Standard Alternate - STDOPT.MAP (or STDOPT58.MAP, or
STDOPT60.MAP)
• Greek - GREEK.MAP
• Portuguese - PORTUGU.MAP
• Cyrillic/Latvian - CYRILLIC.MAP
3-49
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.12.3 Control Sequences for Statement Printers (Agilis 91x for Opteva only)
The graphics-related strategies allow the network to change the printing

characteristics of the statement printer by sending appropriate control sequences
with the printer text in the Printer Data field in a Function Command message.
The printing characteristics include the character set, the horizontal and vertical
pitches, the printing density, and the printing width.
The control sequences for the statement printer are shown in Table 3-16.
Table 3-16 Printer Control Sequences for Statement Printers
Control Sequence ASCII Hex Description
BS 08 Moves the print position to the left one space.
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.
SO n 0E n Fills an area with blanks (space characters). The parameter n

specifies the number of blanks. The range for n is ASCII hex 31
through 3F (1 to 15 blanks).
ESC ! n 1B 21 n Selects a combination of typestyles. The parameter n is the sum of

the following values (weights):
• 1 - 12 CPI (if bit = 0, 10 CPI)
• 8 - Bold
• 32 - Double width
• 64 - Italic
• 128 - Underline
This is a bitmap. All undefined bits must be zero.
ESC $ n1 n2 1B 24 n1 n2 Sets the horizontal print position to an absolute value. The position is
determined by the following formula:
left margin + (n2 * 256 + n1) * (1/203 inch)
If the specified position is beyond the right margin, the command

is ignored.
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
top margin + (n2 * 256 + n1) * (1/203 inch)
If the specified position is beyond the bottom margin, the vertical

print position is set to the top margin of the next page, resulting in a
form feed.
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
current position + (n2 * 256 + n1) * (1/203 inch)
3-51
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-16 Printer Control Sequences for Statement Printers (continued)
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 - 0 1B 2D 30 Disables underline printing.
ESC - 1 1B 2D 31 Enables underline printing.
ESC 0 1B 30 Sets the vertical pitch to 8 LPI.
ESC 2 1B 32 Sets the vertical pitch to 6 LPI.
ESC 3 n 1B 33 n Sets the vertical pitch to 203/n LPI (n/203-inch line spacing).
ESC 4 1B 34 Enables italic font.
ESC 5 1B 35 Disables italic font. Resets printing to the standard font.
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 0 1B 63 30 Disables text color printing.
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 E 1B 45 Enables emphasized (bold) printing.
ESC F 1B 46 Disables emphasized (bold) printing.
ESC J n 1B 4A n Advances the vertical print position by n/203 inch.
ESC L 0 1B 4C 30 Disables landscape printing.
ESC L 1 1B 4C 31 Enables landscape printing.
ESC M 1B 4D Sets the horizontal pitch to 12 CPI.
ESC N 0 1B 4E 30 Disables data pass-through mode. Disables the conversion of

expanded ASCII print data to non-expanded ASCII.
ESC N 1 1B 4E 31 Enables data pass-through mode. Refer to the description of the

ESC N 1 control sequence for the receipt and journal printers.
ESC P 1B 50 Sets the horizontal pitch to 10 CPI.
ESC Q 1B 51 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 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-16 Printer Control Sequences for Statement Printers (continued)
ESC T 1B 54 The following data is a continuation of the previous data. Refer to

the description of the ESC T control sequence for the receipt and
journal printers.
ESC u 0 1B 75 30 Ends a Unicode encoding block.
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 W 0 1B 57 30 Cancels double-width printing.
ESC W 1 1B 57 31 Sets double-width printing.
ESC \ n1 n2 1B 5C n1 n2 Sets the horizontal print position to a relative value. The position is
current position + (n2 * 256 + n1) * (1/203 inch)
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 g 1B 67 Sets the horizontal pitch to 15 CPI.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.12.4 Changing Character Sets
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.
Propagation of Character Attributes

When changing from one character set to another (for example, from the primary
character set to the first alternate character set), the vertical and horizontal
pitch settings for the first character set are always propagated to the second
character set.
If Agilis 91x is configured to enable attribute persistence, the following attributes

are also propagated to the second character set:
• Emphasis (bold)
• Underline
• Double height
• Double width
To determine if attribute persistence is enabled for your system, refer to the

Agilis 91x installation documentation for your system.
First Alternate Set, Single Character

To print a single character from the first alternate character set, use the VT
control character, as in the following procedure:
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.
ASCII Data Description
0B VT control character enabling the first alternate character set
20 ASCII code for the first character in the first alternate character set
XX [1] Printing automatically returned to the primary character set

[1] XX denotes any character.
First Alternate Set, Multiple Characters

On receipt printers and journal printers, the ESC 4 and ESC 5 control sequences
can be used to print multiple characters from the first alternate character set.
3-54
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
3. Revert to the primary character set using the ESC 5 control sequence.
An example of this procedure is shown in the following table.
1B 34 ESC 4 control sequence enabling 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
1B 35 ESC 5 control sequence enabling the primary character set
NOTE
On statement printers, to print multiple characters from the

first alternate character set, use a procedure similar to the
preceding procedure, but use ESC 6 in place of ESC 4, and use
ESC 7 in place of ESC 5.
Second Alternate Set

To print several characters from the second alternate character set, use the ESC z
1 control sequence, as in the following procedure:
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
3. Revert to the primary character set by using the ESC z 0 control sequence.
1B 7A 31 ESC z 1 control sequence enabling the second alternate character

set
20 ASCII code for the first character in the second alternate character
set
3-55
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
21 ASCII code for the second character in the second alternate

character set
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
1B 7A 30 ESC z 0 control sequence enabling the primary character set
Other Character Sets

To print characters from a character set that is not one of the configured
primary or alternate character sets, use the ESC s control sequence, as in the
following procedure:
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.)
2. Enable the desired character set (temporarily equivalent to the first

alternate character set) using the ESC 4 control sequence.
3. Specify the characters of the first alternate character set by using the
4. Revert to the primary character set using the ESC 5 control sequence.
IB 73 xx ... 3B ESC s X...X;
ESC s control sequence selecting a character set to use as the first

alternate character set. X...X represents any valid map filename.
xx... represents the ASCII hex data for X...X.
1B 34 ESC 4 control sequence enabling 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
1B 35 ESC 5 control sequence enabling the primary 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.
ESC z 1 cannot be used with ESC 4 or VT on the same print line.
3-56
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.12.5 Standard Format for the Receipt
Figure 3-4 shows an example of a receipt printed in the standard format.
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
Figure 3-4 Standard Format for Receipts
3-57
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-17 Standard Print Format for the Receipt
Area on Form Line Description
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
Machine 1 The three-character LUNO used in the Consumer Request message
Account Number 4 The consumer’s account number containing up to 20 contiguous characters
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 3-18 Example of Printer Data Field
Characters ASCII Hex Code Description
08/19/04 b/b/ 30 38 2F 31 39 2F 30 34 20 20 Date to be printed
12:00 b/b/ 31 32 3A 30 30 20 20 Time to be printed
021 30 32 31 Terminal number to be printed is equivalent to the logical

unit number (LUNO) specified in the original Consumer
Request message from the terminal
LF 0A Control character that specifies a print and line feed
LF LF 0A 0A Two more line feeds position printer head to line 4 on the

receipt
1234567890123456 31 32 33 34 35 36 37 38 39 30 31 32 Account number to be printed (this number can be read

33 34 35 36 from track 1, 2, or 3 of consumer’s card. Track data is
normally sent to the network in the Consumer Request
message)
LF 0A Print and line feed
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 BANKING 0E 37 42 41 4E 4B 49 4E 47 Seven spaces, then the second 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
LF 0A One line feed positions printer head to line 9
08/19/04 30 38 2F 31 39 2F 30 34 Business date to be printed
LF LF 0A 0A Two line feeds position printer head to line 12
11 SO 3 31 31 0E 33 A transaction code of 11 is to be printed (the reverse side

of form typically gives an explanation of these codes). The
SO control character specifies that the number following it
(3 in this case) is the desired number of spaces to follow
the code characters
1234 b/b/b/b/ 31 32 33 34 20 20 20 20 Serial number of transaction to be printed (this number is

generated by the network and is increased by one digit for
each consumer transaction)
£150.00 0B 25 31 35 30 2E 30 30 Pound amount of transaction to be printed
FF 0C Command to the receipt printer to do a form feed and

receipt paper burst
3-59
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3.12.6 Journal Printer Roll Format
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
TP-821029 (Ed. A)
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.
• Miscellaneous - Miscellaneous data consists of terminal parameters

(capabilities), LUNO (a unique number identifying each terminal), and
terminal timer values.
• Financial Institution Tables (FIT) entries - FIT entries provide information

used for identifying the institution a card is issued by, decoding or encoding
of data, and for electronic fund transfers. Refer to the Data Security
Procedures and Reference Manual (TP-799530-001D) for details.
Because configuration data resides in terminal memory, configuration data is

erased when the terminal loses power or is turned off. When power is restored
or the terminal is turned on, the network requests a configuration ID from
the terminal. If the configuration ID sent by the terminal does not match the
configuration ID at the network, the network sends a new configuration load
to the terminal.
4-1
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Buffers
4.1 Buffers
The terminal contains buffers A through Z, specified in a three-digit decimal

format as 065 through 090, and enhanced buffers 256 through 355. Some of
these buffers are used by Agilis 91x for ix/CSP for specific purposes and should
not be used for other functions to avoid conflict with other internal operations of
the terminal. Some of these buffers are reserved to ensure compatibility with
TCS. The following list shows how the terminal buffers are used.
Buffer ID Use
A (065) Dollar
B (066) General Purpose Buffer
C (067) General Purpose Buffer
D (068) - K (075) Reserved
L (076) Printer Line Length
M (077) Reserved
N (078) Customer Name from Track 1
O (079) Operation Key Buffer
P (080) Receipt Printer Data
Q (081) Depositor Printer Data
R (082) Journal Printer Data
S (083) Statement Printer Data
T (084) Transaction Serial Number
U (085) OAR
V (086) Passbook Printer (currently not supported)
W (087) MICR Data (used with IDM)
X (088) Track 1 data
Y (089) Track 2 data
Z (090) Track 3 data
256 Internal Statement Printer
257 Reserved
258-299 Available and may be used at the network

programmer’s discretion.
300 Bar Code Reader
301-338 Reserved for future use
339 Terminal’s EPP data
340-342 Reserved for future use
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Buffers
Buffer ID Use
344 Bills unloaded amount
345 Bills retained data
346 Receipt number data
347 Operator log data
348 Date and time of load
349 Loaded amount
350 Bills returned data
351 Bills loaded data
352 Inventory amount
353 Inventory data
354 Operator password
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command Messages Overview
4.2 Write Command Messages Overview
The following Write Command messages are used to load configuration data:
• Write Command 1 message - This message is used to load state information.

This state information directs the terminal tasks during a transaction. There
are two types of states: the 9000-compatible states and enhanced states.
• Write Command 2 message - This message is used to load screen

information. This screen data can contains display, control, and delimiter
characters for different screens that must be shown during different parts
of a transaction. The Voice feature, the Multilingual feature, and the Rear
Balance feature also need to load screen information using the Write
Command 2 message.
• Write Command 3 message - This message is used to load miscellaneous

configuration information. This information includes the following items:
- Miscellaneous configuration parameters

- Logical Unit Number (LUNO) for the terminal
- Timer information
• Write Command 6 message - This message is used to load Financial

Institution Table (FITs) information.
• Write Command 7 message - This message is used to load encryption keys

to replace the current keys at the terminal.
• Write Command 8 message - This message is used to load the configuration

ID for the terminal configuration data.
• Write Command 13 message - This message is used to load icon definitions

for custom icons for terminals using the Enhanced Monochrome Graphics
feature.
• Write Command 14 message - This message is used to load the character

set definitions for custom character sets for terminals using the Enhanced
Monochrome Graphics feature.
• Write Command 15 message - This message is used to load cell data

for custom icons and character sets for terminals using the Enhanced
Monochrome Graphics feature.
• Write Command 18 message - This message is used to load format templates.
All the message tables in this manual use the notation conventions set forth
in Table 4-1.
4-4
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-1 Notation Conventions for Message Tables
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.
Table 4-2 Write Command Message Common Fields
Description Data Number of Characters
Protocol Dependent Header Variable Variable
Write Command Identifier 3 1
[ Response Flag ] [ X ] [ 1 ]
Field Separator (FS) hex 1C 1
[ Logical Unit Number (LUNO) ] [ X ] [ 3 ]
[ Message Sequence Number ] [ X ] [ Variable (8 max) ]
Write Identifier (Configuration) - - - 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.
[ Field Separator (FS) ] [ hex 1C ] [ 1 ] [1]
[ MAC Data ] [ - - - ] [ 8 ] [1]
Protocol Dependent Trailer Variable Variable

[1] This group of fields (FS/MAC Data) is present only when message authentication
(MAC) is used.
4-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The following paragraphs describe the common fields in a Write Command

message.
Protocol Dependent Header

Field Size: Variable
Valid Range: Variable
Description: The Protocol Dependent Header field contains one or more
characters used for communications protocol processing. The contents of the
field depend on the communications protocol used by the system. Refer to your
system’s network documentation for protocol header requirements, and to the
documentation supplied with the Agilis Base Communications software for
implementation instructions.
Write Command Identifier

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 a Write Command message is 3.
Logical Unit Number (LUNO)

Field Size: 3 or 9 characters
Valid Range:
Description: This three-character data field is defined in the configuration
data transmitted to the terminal. If a machine number is entered, this field
contains nine characters with the last six characters of this field being the
machine number. Refer to the Data Security Procedures and Reference Manual
(TP-799530-001D) for additional details.
Message Sequence Number

Field Size: Variable (up to 8 characters)
Valid Range: Refer to the description
Description: The message sequence number is a network-generated number that
identifies the message for tracking. The terminal does not use this number. If the
Message Sequence Number in Solicited Status Messages feature is selected,
Agilis 91x for ix/CSP returns this number to the network in the Solicited Status
message sent in response to the Write Command message.
Write Identifier
Valid Range: 1 through 3
Description: This one-character data field tells the terminal that configuration
data follows. The valid value is ’1’.
Modifier
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 1 Message (States)
• = - EMG library cell data

• @ - Format templates
• A - Stored value card
If the Write Identifier is 3 (encryption key change), this field tells the terminal
which key(s) to use for encryption and message authentication.
4.3 Write Command 1 Message (States)
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
State table 000 is the first state table the terminal is in

when the terminal enters the In-service mode.
State table 000 is usually a Card Read state.
The terminal should always return to a Close state after the

consumer’s transaction(s) have been completed.
4-7
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
State Processing Failure

If, at any time, a state fails to process properly, an Unsolicited Status message is
sent to the network. This status message contains the power fail code (1) and
the terminal LUNO. For example, a status message of 12.nnn..1 is sent, where
nnn is the LUNO number of the affected terminal, and the period characters
represent field separators (hex 1C).
4.3.1 Valid State Numbers
For Agilis 91x for ix/CSP, the valid range of state numbers is 000 through 254,
256 through 999, and A00 through ZZZ.
4.3.2 Write Command 1 Message Format
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.
Table 4-3 Write Command 1 Message Format
Write Identifier (Configuration) 1 1
Modifier (States) 2 1

[1] This group of fields (FS / State Number / State Data) can be repeated, as necessary,
to a maximum of 1920 bytes per Write Command 1 message.
(MAC) is used.
4-8
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-3 Write Command 1 Message Format (continued)
State Number - - - 3
State Data - - - 25
[ State Number ] [- - - ] [ 3 ][1]
[ State Data ] [- - - ] [ 25 ] [1]
[ MAC Data ] [- - - ] [ 8 ] [2]

[1] This group of fields (FS / State Number / State Data) can be repeated, as necessary,
to a maximum of 1920 bytes per Write Command 1 message.
(MAC) is used.
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
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
State number, state data, and field separator fields can be

repeated as necessary to a maximum of 1920 bytes (total
message length).
MAC Data
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.
Protocol Dependent Trailer

Description: The variable-length Protocol Dependent Trailer field indicates the
end of the message.
4-9
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4 9000 States
A summary of all the 9000-style states is shown in Table 4-4.
Table 4-4 9000-style State Summary
State Name State Type Description
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.
PIN Entry M Converts to B 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Table 4-4 9000-style State Summary (continued)
State Name State Type Description
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.
The following sections describe each of the 9000-style states.
4-11
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.1 Card Read State (A)
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.
The Card Read state table performs the following functions:
• Identifies the number of the consumer display screen displayed for

prompting card entry
• Identifies the consumer display screen displayed after a misread
• 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
• Tells the terminal the next state to go to if there is no FIT match
Refer to Table 4-5 for the Card Read state table format.
Table 4-5 Card Read State Entries
Entry Valid Range
1 State Type A
2 Screen Number Valid screen numbers (Section 4.6)
3 Good Read Next State Valid state numbers (Section 4.3.1)
4 Error (Misread) Screen Number Valid screen numbers (Section 4.6)
5 Read Condition 1 001 - 015
8 Card Return Flag 000, 001
9 No FIT Match Next State Valid state numbers (Section 4.3.1)
The Card Read (A) state entries are defined as follows:
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
TP-821029 (Ed. A)
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.
Good Read Next State

Entry Number: 3
Valid Data Range: Valid state numbers (Section 4.3.1)
Description: The number of the state the terminal goes to after a good read of the
consumer’s card. Normally the next state is a PIN entry type of state.
Error (Misread) Screen Number

Entry Number: 4
Description: This is the number of the screen displayed if the card is not read
properly. Normally, this screen prompts the consumer to check the card for
proper orientation and reinsert the card.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Card Return Flag

Entry Number: 8
Valid Data Range: 000 and 001
Description: This entry tells the terminal whether the card should be returned
immediately or at transaction closing. The valid values are as follows:
• 000 - Return card immediately

• 001 - Return card at transaction closing
No FIT Match Next State

Entry Number: 9
Description: The number of the state the terminal goes to if the Financial
Institution Table (FIT) number on the card does not match any member
institution.
Table 4-6 Read Condition Entry Definitions
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)
1 only 004 004 004
2 only 002 002 002
3 only 001 001 001
1 and 2 006 006 006
1 and 3 005 005 005
2 and 3 003 003 003
1 and 2 and 3 007 007 007
2 or 3 002 001 001
1 or 3 004 001 001
1 or 2 004 002 002
1 or 2 or 3 004 002 001
(1 and 2) or (1 and 3) 006 005 005
(2 and 1) or (2 and 3) 006 003 003
(3 and 1) or (3 and 2) 005 003 003
1 or (2 and 3) 004 003 003
2 or (1 and 3) 002 005 005
3 or (1 and 2) 001 006 006
4-14
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.2 PIN Entry State (B)
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.
Table 4-7 PIN Entry State Entries
Entry Definition
1 State Type
2 Screen Number
3 Time-out Next State
4 Cancel Next State
5 Good PIN Next State
6 Maximum Bad PINs Next State
7 Error Screen Number
8 No Local PIN Check Next State
9 Maximum PIN Tries
The PIN Entry (B) state entries are defined as follows:
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
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.
Time-out Next State

Entry Number: 3
Description: The number of the state the terminal goes to if the consumer fails
to enter a PIN within the specified time limit. Enter 255 to deactivate the
time-out function. Entering 255 keeps the terminal in this state until a function
key is pressed.
4-15
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Cancel Next State

Entry Number: 4
Description: This is the number of the state the terminal goes to if the consumer
presses the Cancel key without correctly entering a PIN.
Good PIN Next State

Entry Number: 5
Description: The number of the state the terminal goes to after the terminal
verifies that the consumer entered the correct PIN (if local check). Normally
the next state is a Clear Keys state.
Maximum Bad PINs Next State

Entry Number: 6
Description: The number of the state the terminal goes to after the consumer
incorrectly enters a PIN the number of times specified by state entry 9 or from
card if specified by FIT. Normally, the next state is a Close state that forces the
consumer off the terminal.
Error Screen Number

Entry Number: 7
Description: The number of the screen to display to prompt the consumer to enter
a PIN again. This screen is displayed each time the consumer enters an incorrect
PIN until the retry value is reached in state entry 9 (or from card). This screen
must position the consumer display cursor at the beginning of the X display area.
No Local PIN Check Next State

Entry Number: 8
Description: The number of the state the terminal goes to if no local PIN
check (remote) is specified in FIT.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.3 Deposit State (C) for Envelope Depository
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.
Refer to Table 4-8 for the Deposit state table format.
Table 4-8 Deposit State Entries (Envelope Depository)
Entry Definition
1 State Type
2 Next State
3 - 9 Reserved
The Deposit state (C) entries are defined as follows:
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
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
TP-821029 (Ed. A)
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.
Refer to Table 4-9. for the Deposit state table format.
Table 4-9 Deposit State Entries (IDM)
Entry Definition
1 State Type
2 Good Next State
3 Screen Number
4 Timeout or Cancel Next State
5 Fault Next State
6 Operation
7 Deposit Bin ID
8 Image Capture
9 Reserved
The Deposit state (C) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: C
Description: This state ID identifies this state table as a Deposit state table.
Good Next State

Entry Number: 2
Description: The number of the state the terminal goes to if the indicated
operation is completed without problem.
Screen Number
Entry Number: 3
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.
Timeout or Cancel Next State

Entry Number: 4
Description: The number of the state the terminal goes to if either of the
following events occur:
• Timer 04 or timer 20 expires during operation 001 or 002

• Timer 09 expires during operation 004
4-18
TP-821029 (Ed. A)
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.
Fault Next State

Entry Number: 5
Description: The number of the state the terminal goes to if a hard fault occurs.
Operation
Entry Number: 6
Description: This entry tells the terminal which Deposit operation to perform.
The valid values are as follows:
• 000 - Unlock deposit supplies door. On terminals equipped with an envelope

dispenser, operation 000 asks the consumer if they require an envelope
(reserved screen 910). 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, the terminal proceeds to the Fault Next State.
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.
• 001 - Deposit envelope. This operation requires an envelope depository. The

envelope depository is enabled for a complete envelope deposit.
Timeout of this operation is controlled by timer 20 (if timer 20 has a non-zero

value) or by timer 04. The Cancel key is enabled during this operation.
• 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:
- Accept a check or document
- Read the MICR line as directed by the Override MICR configuration

option setting entry of the Deposit Extension state (if applicable) or the
MICR search preference set in the Depositor device properties
- Capture the image(s) of the check or document as directed by the Image

Capture entry.
- Hold the check or document in the escrow position

If a check or other document is in escrow at the start of this operation, the

check or document is moved to the deposit bin specified in the Deposit Bin
ID entry. The deposit then proceeds as described in the preceding paragraphs.
4-19
TP-821029 (Ed. A)
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.
The Cancel key is disabled 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.
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 Deposit Bin ID entry.
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
TP-821029 (Ed. A)
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:
• Bits 7 through 3 - Reserved. Must be 0.
• Bit 2:
- 0 - Print on front of document

- 1 - Print on back of document
• Bit 1:
- 0 - Do not scan back of document

- 1 - Scan back of document
• Bit 0:
- 0 - Do not scan front of document

- 1 - Scan front of document
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
Description: The terminal does not use this entry.
4-21
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.5 Clear Keys State (D)
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.
• Preset selected bytes of the Function Key buffer with A, B, C, or D.
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.
Table 4-10 Clear Keys State Entries
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
The Clear Keys (D) state entries are defined as follows:
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
Description: The number of the state the terminal goes to after clearing or
presetting the function key buffer.
Clear Mask
Entry Number: 3
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
A Preset Mask
Entry Number: 4
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
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
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
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
Description: Entries 8 and 9 are reserved and must be 000.
EXAMPLE 1
Clear Mask (Entry 3)
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
TP-821029 (Ed. A)
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
Weights 1 + 2 + 4 + 8 + 16 + 32 + 128 = 191
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
A, B, C, D Preset Masks (Entries 4 through 7)
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
The buffer appears as follows:
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
The entries would have to be set as follows:
• Entry 4 (A Preset Mask) - 1 + 4 = 005

• Entry 5 (B Preset Mask) - 2 + 32 = 034
• Entry 6 (C Preset Mask) - 8 = 008
• Entry 7 (D Preset Mask) - 16 + 128 = 144
4-24
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.6 Select Function State (E)
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
If the Select Function state is used with the Function Key

Extension state, up to eight function keys can be activated,
allowing the consumer to select one of up to eight functions.
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.
Table 4-11 Select Function State Entries
Entry Definition
1 State Type
2 Screen Number
4 Cancel Next State
5 Function Key A Next State
6 Function Key B Next State
7 Function Key C Next State
8 Function Key D Next State
9 Function Key Buffer Location
The Select Function state (E) entries are defined as follows:
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
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Time-out Next State

Entry Number: 3
Description: State number terminal proceeds to if a consumer fails to make
a selection within the specified time limit. (Program in 255 if the time-out
function is not used.)
Cancel Next State

Entry Number: 4
Description: State number terminal proceeds to if a consumer presses the
Cancel key instead of a function key.
Function Key A Next State

Entry Number: 5
Description: State number terminal proceeds to if a consumer presses the A
function key. (Program in 255 to deactivate the A function key during this state.)
Function Key B Next State

Entry Number: 6
Description: State number terminal proceeds to if a consumer presses the B
function key. (Program in 255 to deactivate the B function key during this state.)
Function Key C Next State

Entry Number: 7
Description: State number terminal proceeds to if a consumer presses the C
function key. (Program in 255 to deactivate the C function key during this state.)
Function Key D Next State

Entry Number: 8
Description: State number terminal proceeds to if a consumer presses the D
function key. (Program in 255 to deactivate the D function key during this state.)
Function Key Buffer Location

Entry Number: 9
Description: Specifies the function key buffer byte in which the key code for the
selected function key is to be stored. The network downloads the following data
to select the indicated buffer byte:
• 000 = buffer position 0

4-26
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Buffer positions are as follows:
_ _ _ _ _ _ _ _
0 1 2 3 4 5 6 7
4-27
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.7 Dollar Entry State (F)
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.
Table 4-12 Dollar Entry State Entries
Entry Definition
1 State Type
2 Screen Number
4 Cancel Next State
9 Dollar Display Screen Number
The Dollar Entry state (F) entries are defined as follows:
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
Description: Number of display screen that prompts an amount entry. This
screen is displayed upon entry into the Dollar Entry state.
Time-out Next State

Entry Number: 3
Description: State number the terminal proceeds to if a consumer fails to enter
an amount within the specified time limit. (Program in 255 if the time-out
function is not used.)
Cancel Next State

Entry Number: 4
Description: State number the terminal proceeds to if a consumer presses the
Cancel key before pressing a function key.
4-28
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States

Entry Number: 5
Description: State number the terminal proceeds to if a consumer presses the A

Entry Number: 6
Description: State number terminal proceeds to if a consumer presses the B

Entry Number: 7
Description: State number terminal proceeds to if a consumer presses the C

Entry Number: 8
Description: State number terminal proceeds to if a consumer presses the D
NOTE
Normally one function key is used to indicate whether the

amount entered is correct and another function key is used
to indicate that the amount entered is incorrect. The other
function keys are inactive.
Dollar Display Screen Number

Entry Number: 9
Description: This is an overlay screen that only sets the consumer display cursor.
It sets the cursor to the left side of the transaction amount display field (eleven
positions long for 8-digit entry or 14 positions long for 12-digit entry) on the
consumer display. The data already displayed remains displayed. When the
amount is keyed on the numeric keys, that amount is displayed (Figure 4-1).
4-29
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
g1959024
View A 8-digit Transaction Amount Entry
g1959025
View B 12-digit Transaction Amount Entry
Figure 4-1 Transaction Amount Display Format - Example
4-30
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.8 Cent Check State (G)
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.
Table 4-13 Cent Check State Entries
Entry Definition
1 State Type
2 Whole Dollar Entry Next State
3 Non-whole Dollar Entry Next State
4 - 9 Reserved
The Cent Check (G) state entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: G
Description: This state ID identifies this state table as a Cent Check state table.
Whole Dollar Entry Next State

Entry Number: 2
Description: State number the terminal enters upon finding 00 for the rightmost
two digits in the dollar buffer (zero cents).
Non-whole Dollar Entry Next State

Entry Number: 3
Description: State number the terminal enters upon finding a value other than
00 for the rightmost two digits in the dollar buffer.
Reserved
4-31
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.9 Information Entry State (H)
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.
Table 4-14 Information Entry State Entries
Entry Definition
1 State Type
2 Screen Number
4 Cancel Next State
9 Buffer and Display Parameters
The Information Entry state (H) entries are defined as follows:
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
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.
Time-out Next State

Entry Number: 3
Description: State number the terminal proceeds to if a consumer fails to respond
to the consumer display message within a specified time limit. (Program in 255 if
the time-out function is not used.)
4-32
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Cancel Next State

Entry Number: 4
Description: State number the terminal proceeds to if a consumer presses Cancel
key before pressing a function key.

Entry Number: 5
Description: State number the terminal proceeds to if a consumer presses the A

Entry Number: 6
Description: State number the terminal proceeds to if a consumer presses the B

Entry Number: 7
Description: State number the terminal proceeds to if a consumer presses the C

Entry Number: 8
Description: State number the terminal proceeds to if a consumer presses the D
Buffer and Display Parameters

Entry Number: 9
Description: This entry specifies whether or not the actual data entered, or X, is
to be displayed, beginning at the current cursor position. This entry also specifies
which general purpose buffer (B or C) is used for storing the numeric data input.
The valid characters are as follows:
• 000 - Display X for each numeric key pressed. Store keys in general
purpose buffer C.
• 001 - Display data as entered. Store keys in general purpose buffer C.
• 002 - Display X for each numeric key pressed. Store keys in general
purpose buffer B.
• 003 - Display data as entered. Store keys in general purpose buffer B.
4-33
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.10 Transaction Request State ( I )
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.
Table 4-15 Transaction Request State Entries
Entry Definition
1 State Type
2 Screen Number
3 Network Response Time-out Next State
4 Send Track 2 Data
5 Send Track 1, Track 3, and/or MICR Data
6 Send Function Key Buffer Data
7 Send Dollar Buffer Data
8 Send PIN Buffer Data
9 Send General Purpose Buffer(s) B and/or C Data
The Transaction Request state (I) entries are defined as follows:
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
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.
Network Response Time-out Next State

Entry Number: 3
Description: The state number the terminal goes to if the network does not
respond to the Consumer Request message in the time specified by timer 03
(Section 4.23). This timer checks that a Function Command message is received
in response to the Consumer Request message.
4-34
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Send Track 2 Data

Entry Number: 4
Description: This entry indicates whether track 2 data should be sent in the
Consumer Request message. The valid values are as follows:
• 000 - Do not send data

• 001 - Send data
Send Track 1, Track 3 Data, and/or MICR Data

Entry Number: 5
Description: This entry specifies whether track 1 data, track 3 data, MICR data,
or some combination of this data is sent to the network. The valid values
are as follows:
• 000 - No additional tracks

• 001 - Send track 3 only
• 003 - Send tracks 1 and 3
• 004 - Send MICR only
• 005 - Send MICR and track 3
• 007 - Send MICR and tracks 1 and 3
Send Function Key Buffer Data

Entry Number: 6
Description: This entry indicates whether the Function Key Buffer data should
be sent in the Consumer Request message. The valid values are as follows:

• 001 - Send data
Send Dollar Buffer Data

Entry Number: 7
Description: This entry indicates whether the Dollar Buffer data should be sent
in the Consumer Request message. The valid values are as follows:

• 001 - Send data
Send PIN Buffer Data

Entry Number: 8
Description: This entry indicates whether the consumer entered PIN should be
sent in the Consumer Request message. The valid values are as follows:

• 001 - Send data
If the PIN is included in the message, the PIN is in encrypted form, based
on the applicable FIT entry.
4-35
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Send General Purpose Buffers B and/or C Data

Entry Number: 9
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.
• 000 - Do not send data from either buffer

• 001 - Send general purpose buffer B data only
• 002 - Send general purpose buffer C data only
• 003 - Send general purpose buffers B and C data
4-36
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.11 Close State (J)
The Close state terminates the consumer’s current terminal interface. This state
performs the following functions:
• Shows a consumer display screen
• Completes any printing on the consumer or journal printer initiated by

a Function Command message.
• Returns or retains the consumer’s card as directed by the Function

Command message.
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.
Refer to Table 4-16 for the Close state table format.
Table 4-16 Close State Entries
Entry Definition
1 State Type
2 Receipt Delivered Screen Number
3 Next State
4 No Receipt Delivered Screen Number
5 Card Retained Screen Number
6 - 9 Reserved
The Close state (J) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: J
Description: This state ID identifies this state table as a Close state table.
Receipt Delivered Screen Number

Entry Number: 2
Description: Number of the display screen that asks consumers to please take
their card and receipt. This screen is displayed upon entry to the Close state only
if the consumer’s card is returned and a receipt was printed.
4-37
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Next State
Entry Number: 3
Description: The state number the terminal goes to after the Close state
is completed.
No Receipt Delivered Screen Number

Entry Number: 4
Description: Number of the display screen that asks consumers to please take
their card. This screen is displayed upon entry to the Close state only if the
consumer’s card is returned and no receipt was printed.
Card Retained Screen Number

Entry Number: 5
Description: Number of the display screen that informs the consumer that the
card has been retained. This screen is displayed upon entry to the Close state
only if the consumer’s card has been retained by the terminal as directed by the
network. Consumer timeouts do not cause this screen to be displayed.
Reserved
4-38
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.12 Indirect Next State (K)
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.
Table 4-17 Indirect Next State Entries
Entry Definition
1 State Type
2 - 9 Next State
The Indirect Next state (K) entries are defined as follows:
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
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:
Entry Number Definition
2 Next state number if PSTDX = 0
4-39
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.13 Card Write State (L)
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:
• A good track read
• 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
The card always remains within the card reader/writer after

the Card Write state. A Close state must be used to return
or retain the card.
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.
Table 4-18 Card Write State Entries
Entry Definition
1 State Type
2 Screen Number
3 Good Write Next State
4 Bad Write Next State
5 No Write Attempted Next State
6 Track to Write
7 - 9 Reserved
The Card Write state (L) entries are defined as follows:
4-40
TP-821029 (Ed. A)
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
Description: Number of the screen displayed during the Card Write process.
Good Write Next State

Entry Number: 3
Description: The state number the terminal goes to after a successful track write.
Bad Write Next State

Entry Number: 4
Description: The state number the terminal goes to after repeated unsuccessful
track write attempts.
No Write Attempted Next State

Entry Number: 5
Description: The state number the terminal goes to if no write is attempted
because the track data buffer contains no data, the start or stop sentinel is
missing, or the track data buffer is too long.
Track to Write
Entry Number: 6
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
4-41
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.14 PIN Entry State (M)
This PIN Entry state is identical to PIN Entry (B) state described in Section 4.4.2.
4.4.15 Set Dollar Buffer State (R)
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.
Table 4-19 Set Dollar Buffer State Entries
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
TP-821029 (Ed. A)
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
Description: The terminal does not use this entry.
Digits 12 and 11
Entry Number: 4
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
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
place in positions 8 and 7, respectively, of the Dollar Buffer.
Digits 6 and 5
Entry Number: 7
Digits 4 and 3
Entry Number: 8
Digits 2 and 1
Entry Number: 9
4-43
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.16 Card Read State (for Non-state 000 Applications) (T)
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.
Table 4-20 Card Read State (T) Entries
Entry Definition
1 State Type
2 Screen Number
4 Cancel Next State
5 Good Read Next State
6 Error (Misread) Next State
7 Card Read Conditions
8 Card Return Flag
9 No FIT Match Next State
The Card Read state (T) entries are defined as follows:
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
Description: The number of the screen that prompts the consumer to insert a
debit or credit card.
Time-out Next State

State Entry: 3
Description: The number of the state that the terminal goes to if the consumer
fails to insert a debit or credit card in the specified time.
4-44
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Cancel Next State

State Entry: 4
Description: The number of the state the terminal goes to if the consumer
presses the Cancel key.
Good Read Next State

State Entry: 5
Description: The number of the state that the terminal goes to after a good read
of the debit or credit card.
Error (misread) Next State

State Entry: 6
Description: The number of the state that the terminal goes to if there was
not a good read.
Card Read Conditions

State Entry: 7
Valid Data Range: The Card Read Conditions entry has the following valid
values:
• 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
Description: This entry specifies which tracks to read.
Card Return Flag

State Entry: 8
Description: The card is returned to the consumer as follows:
• 000 - Return card immediately

• 001 - Return card at transaction close
NOTE
The Card Return Flag is honored only if the Good Next

State exit is taken.
4-45
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
No FIT Match Next State

State Entry: 9
Description: The number of the state that the terminal goes to if the card does
not match any FIT entry.
4-46
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.17 Check Track Buffer State (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.
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.
Table 4-21 Check Track Buffer State Entries
Entry Definition
1 State Type
2 Match Next State
3 No Match Next State
4 Indirect Next State Index
5 Buffer ID/Delimiter
6 Delimiter Index
7 First and Second Characters
8 Third and Fourth Characters
9 Fifth and Sixth Characters
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.
Match Next State

Entry Number: 2
Description: The Match Next State entry specifies the state table that the
terminal processes if the data in the specified buffer (entries 5 and 6) matches
all six characters specified in entries 7, 8, and 9.
No Match Next State

Entry Number: 3
Description: The No Match Next State entry specifies the state table that the
terminal processes if the data in the specified buffer (entries 5 and 6) does not
match one or more of the characters specified in entries 7, 8, and 9.
4-47
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Indirect Next State Index

Entry Number: 4
Valid Data Range: Decimal numbers less than or equal to 255. When this entry
is converted to hexadecimal, each hex digit must be 0 to 7, or F.
Description: The Indirect Next State Index entry specifies a new Indirect Next
state index for the current transaction.
The terminal converts entry 4 to a two-digit hexadecimal number. If entries 7, 8,

and 9 match the buffer data, the most significant digit of that number specifies
the new index. If no match is found, the least significant digit specifies the new
index. If the digit is from 0 to 7, this number is the new Indirect Next state index.
If the digit is F, the index is not altered.
Buffer ID/Delimiter
Entry Number: 5
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.
The terminal converts entry 5 to a two-digit hexadecimal number. The most

significant digit represents the track data buffer containing the data to compare
with entries 7, 8, and 9 as follows:
• 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:
• 0 - Start sentinel; count forward

• 1 - First field separator; count forward
• 2 - End sentinel; count backward
• 3 - Last field separator; count forward
Delimiter Index
Entry Number: 6
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
For entries 7, 8, and 9, the terminal converts each decimal

number to a two-digit hexadecimal number, then converts each
hexadecimal digit to a character.
4-48
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
First and Second Characters

Entry Number: 7
is converted to hexadecimal, each hex digit must be from 0 to 9, or F.
Description: The First and Second Characters entry specifies the characters to
compare with the first and second characters of track data. The first character is
compared to the character at the specified offset in the buffer, and subsequent
characters are counted from there. F always matches any buffer character.
Third and Fourth Characters

Entry Number: 8
Description: The Third and Fourth Characters entry specifies the characters
to compare with the third and fourth characters in the track data buffer. F
always matches any buffer character.
Fifth and Sixth Characters

Entry Number: 9
Description: The Fifth and Sixth Characters entry specifies the characters to
compare with the fifth and sixth characters in the track data buffer. F always
matches any buffer character.
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.
3. The terminal proceeds as follows based on the result of the comparison:
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Table 4-22 Check Track Buffer State Example
Entry Contents
State Type Z
Match Next State 100
No Match Next State 150
Indirect Next State Index 095 (Hex 5F)
Buffer ID/Delimiter 019 (Hex 13)
Delimiter Index 012
First and Second Characters 003 (Hex 03)
Third and Fourth Characters 073 (Hex 49)
Fifth and Sixth Characters 127 (Hex 7F)
4-50
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.18 Deposit Extension State ( # or > ) (terminals with IDM only)
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.
Table 4-23 Deposit Extension State Entries
Entry Definition
1 State Type
2 Check Accepted Screen
3 Check Handling Delay Screen
4 Check Handling Delay Time
5 MICR Fault Next State
6 Media Fault Next State
7 Cancel Next State
8 Document Handling Next State
9 Override MICR Configuration Setting
The Deposit Extension state (# or >) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: # or >
Description: This state ID identifies this state table as a Deposit Extension
state table.
Check Accepted Screen

Entry Number: 2
Description: This entry contains the number of the screen to display when the
IDM has accepted a check but has not yet read or scanned the check. If the value
in this entry is 000, the terminal does not change the screen currently showing.
NOTE
The beeper stops when the IDM accepts the check.
4-51
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Check Handling Delay Screen

Entry Number: 3
Description: This entry contains the number of the screen to display if the time
specified in the Check Handling Delay Time entry expires. This time might
expire if the IDM has difficulty locating the MICR data on the check. This screen
is used to assure the consumer that the check is still being processed. If the value
in this entry is 000, the terminal does not change the screen currently showing.
Check Handling Delay Time

Entry Number: 4
Description: This entry specifies how long to wait after the check is accepted
before displaying the Check Handling Delay screen. The time is specified in
800-millisecond increments. A value of 255 disables this feature. The suggested
value for this entry is 025 (20 seconds).
MICR Fault Next State

Entry Number: 5
Description: The number of the state the terminal goes to if the IDM is not able
to read a valid MICR line. It is possible to continue processing the check if this
exit is taken, depending on the institution’s MICR requirements.
Media Fault Next State

Entry Number: 6
Description: The number of the state the terminal goes to if the document
inserted was too long, too short, too thick, or too thin. If this exit is taken, the
check is in escrow and the terminal has not attempted to read the MICR data
or scan the check.
Cancel Next State

Entry Number: 7
Description: The number of the state the terminal goes to if the consumer
presses the Cancel key before inserting a check or envelope during a check or
envelope deposit operation.
Document Handling Next State

Entry Number: 8
Description: The number of the state the terminal goes to if the terminal could
not transport the check properly through the depository. This condition is a
soft fault condition. The terminal can return the check, and the consumer
can retry the deposit.
4-52
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Override MICR Configuration Setting

Entry Number: 9
Valid Data Range: Refer to the description
Description: This entry is used to override the MICR search preference set in the
Depositor device properties. 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.
• 001 - Use the setting in the Depositor device properties.
• 002 through 255 - The remaining values, that override the setting in the
Depositor device properties are created using the following bitmap:
- Bit 7 (weight 128):

0 - Enable MICR search on left side of check
1 - Disable MICR search on left side of check

0 - Enable MICR search on right side of check
1 - Disable MICR search on right side of check
- Bits 5 through 0: Reserved - leave as 0
4-53
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.19 Voice State ( ; )
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.
Table 4-24 Voice State Entries
Entry Definition
1 State type
2 Prompting Enable Flag
3 Next State
4 Feedback Enable Flag
5 Beeping/Voice Prompting
Coordination Flag
6 Reserved
7 Reserved
8 Reserved
9 Reserved
The Voice state ( ; ) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: ;
Description: This state ID identifies this state table as a Voice state table.
Prompting Enable Flag

Entry Number: 2
Description: This entry is a flag to tell the terminal whether to enable or disable
voice prompting. The valid values are as follows:
• 000 - Disables voice prompting

• 001 - Enables voice prompting
Next State
Entry Number: 3
Description: The state which is executed immediately following completion
of the Voice state.
4-54
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Feedback Enable Flag

Entry Number: 4
Description: This entry is a flag to tell the terminal whether to enable or disable
voice keypad feedback. The valid values are as follows:
• 000 - Disables voice keypad feedback

• 001 - Enables voice keypad feedback
Beeping/Voice Prompting Coordination Flag

Entry Number: 5
Description: This entry is a flag to tell the terminal how to coordinate voice
prompting commands and attention beeping. The valid values are as follows:
• 000 - Voice prompting commands take precedence, beeping is suppressed

• 001 - Voice prompting commands and beeping coexist, both are heard
Reserved
Description: Must be 000.
4-55
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.20 Copy Buffer State ( = )
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.
The structure of the Copy Buffer state is shown in Table 4-25.
Table 4-25 Copy Buffer State Entries
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
The Copy Buffer state ( = ) entries are defined as follows:
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
Description: The number of the state that is executed immediately following
completion of the Copy Buffer state.
Source Buffer ID
Entry Number: 3
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
4-56
TP-821029 (Ed. A)
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.
• 002 - General purpose buffer B

• 003 - General purpose buffer C
All other values are reserved.
Reserved
4-57
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.21 Transaction Request Extension State ( ) )
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.
Table 4-26 Transaction Request Extension State Entries
Entry Definition
1 State Type
2 Cancel Key Next State
3 Cancel After Function Next State

(912 mode only)
4 - 9 Reserved
The Transaction Request 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 Transaction
Request Extension state table.
Cancel Key Next State

Description: This entry tells the terminal which state to go to if the Cancel Key
is pressed. If the Cancel key is enabled in the Transaction Request state and it is
pressed before the Function Command message is received by the terminal, the
transaction request state is terminated and the Cancel Next State is executed.
Enter 255 to deactivate the Cancel key during this state.
Cancel After Function Next State (912 mode only)

Description: The Cancel After Function Next State entry tells the terminal which
state to go to if the consumer presses the Cancel key during the processing of a
function command. The terminal terminates function processing in between
function IDs. A function command reject is sent to the network and the terminal
goes to the next state specified by this entry. Enter 255 to deactivate the Cancel
key during this state.
Reserved
4-58
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.22 Function Key Extension State ( > )
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:
• PIN Entry state (B)

• Clear Keys state (D)
• Select Function state (E)
• Dollar Entry state (F)
• Information Entry state (H)
• Transaction Request state (I)
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 state that is being extended (B, D, E, F, H, or I) is referred to as the base

state. The function of all the entries in the base state table remains the same as if
the state were not extended. The extension process merely adds definitions for
operating the additional keys.
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
There is an option to designate a function key (E, J, K, L, or M)

to be used by the consumer to control the volume (loudness) of
voice messages. If a function key has been assigned to voice
volume control, ignores any attempt to enable that function
key for any other use during a consumer session. For details,
Refer to Table 4-27 for the Function Key Extension state table format.
Table 4-27 Function Key Extension State Entries
Entry Definition
1 State Type
2 Function Key F
3 Function Key G
4 Function Key H
5 Function Key I
6 Function Key J (OK)
4-59
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Table 4-27 Function Key Extension State Entries (continued)
Entry Definition
7 Function Key K (CORR)
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
If your system or network software requires a separate

extension state ID for each type of base state, the following
extension state IDs have been assigned:
Base State Extension State ID
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
Function Key H
Entry Number: 4
4-60
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Function Key I
Entry Number: 5
Function Key J (OK)

Entry Number: 6
Function Key K (CORR)

Entry Number: 7
Function Key L
Entry Number: 8
Function Key M
Entry Number: 9
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.
3. The consumer presses the OK 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Table 4-28 Function Key Extension State Example
State 057 Entry Contents State 058 Entry Contents
State Type > State Type E
Function Key F 104 Screen Number 023
Function Key G 105 Time-out Next State 026
Function Key H 106 Cancel Next State 020
Function Key I 107 Function Key A Next 100

State
Function Key J (OK) 108 Function Key B Next 101

State
Function Key K (CORR) 109 Function Key C Next 102

State
Function Key L 255 Function Key D Next 103

State
Function Key M 255 Function Key Buffer 003

Location
Function Key Extension State Used with PIN Entry State

When the Function Key Extension state is used with the PIN Entry state (B),
the operation is functionally different. The extension state supports the use of
function keys A, B, C, D, J, K, L, and M. All enabled keys perform only one
function, the termination of a variable-length PIN entry. The keys are either
enabled (value of 001) or disabled (value of 255).
Function Key Extension State Used with Transaction Request

State (912 only)
When the Function Key Extension state is used with the Transaction Request
state (I), the operation is functionally different. The extension state only supports
the Cancel Key Next State feature and the Cancel after Function Next State
feature (912 mode only). Using this state with a Transaction Request state
allows the consumer to cancel the transaction before a Function Command
message is received by the terminal or, after a Function Command message is
received, between function IDs. When used this way, the applicable entries are as
described in the following paragraphs.
State Type
Entry Number: 1
Valid Data Range: >
Description: The State Type entry identifies this state table as a Function
Key Extension state table.

Entry Number: 2
Description: The Cancel Key Next State entry tells the terminal which state to go
to if the consumer presses the Cancel key before a Function Command message is
received by the terminal. Enter 255 to deactivate the Cancel key during this state.
4-62
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Cancel after Function Next State (912 mode only)

Entry Number: 3
Description: The Cancel After Function Next State entry tells the terminal what
function command. The terminal terminates function command processing in
between function IDs. A function command reject is sent to the network and the
terminal goes to the next state specified by this entry. If the Function Command
message contained multiple function IDs, the host must parse the Check Point
status included in the Reject message in order to determine which functions were
executed before processing was cancelled.
Enter 255 to deactivate the Cancel key during this state.
Reserved
Description: These entries are reserved.
4-63
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.23 Withdrawal Area Sensors State ( ? )
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.
Table 4-29 Withdrawal Area Sensors State Entries
ENTRY DEFINITION
1 State Type
2 Clear Sensors Next State
3 Blocked Sensors Next State
4 - 9 Reserved
The Withdrawal Area Sensors ( ? ) 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 Withdrawal Area
Sensors state table.
Clear Sensors Next State

Entry Number: 2
Valid Data Range: Valid state numbers (Section 4.3.1).
Description: The Clear Sensors Next State entry specifies the state table that the
terminal processes if no withdrawal area sensor is blocked.
Blocked Sensor Next State

Entry Number: 3
Valid Data Range: Valid state numbers (Section 4.3.1).
Description: The Blocked Sensor Next State entry specifies the state table that
the terminal processes if one or more withdrawal area sensors are blocked.
Reserved
Entry Numbers: 4 through 9
Description: The terminal does not use these entries.
4-64
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.24 Set Language Bank State ( [ )
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.
Table 4-30 Set Language Bank State Entries
Entry Definition
1 State Type
2 Next State
3 Language Bank Number
4 - 9 Reserved
The Set Language Bank 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 Set Language
Bank state table.
Next State
Entry Number: 2
processes after establishing the Language Bank number.
Language Bank Number

Entry Number: 3
Description: The Language Bank number entry specifies the language bank
to use for screens.
Reserved
Description: The terminal does not use these entries.
4-65
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
4.4.25 Buffer Arithmetic State ( \ )
The Buffer Arithmetic state ( \ ) adds or subtracts ASCII decimal buffers.
The structure of the Buffer Arithmetic state is shown in Table 4-31.
Table 4-31 Buffer Arithmetic State Entries
Entry Definition
1 State type
2 Positive Result Next State
3 Negative Result Next State
4 Buffer 1 ID
5 Buffer 2 ID
6 Result Buffer ID
7 Operation to Perform
8 Reserved
9 Reserved
The Buffer Arithmetic state ( \ ) entries are defined as follows:
State Type
Entry Number: 1
Valid Data Range: \
Description: This state ID identifies this state table as a Buffer Arithmetic state.
Positive Result Next State

Entry Number: 2
Description: The state to go to for the addition operation. This exit is also taken
for the subtraction operation if the value contained in buffer 1 is as large as or is
larger than the value contained in buffer 2.
Negative Result Next State

Entry Number: 3
Description: The state to go to for the subtraction operation. This exit is only
taken if the value contained in buffer 2 is larger than the value contained in
buffer 1.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
9000 States
Buffer 2 ID
Entry Number: 5
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
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
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
If two 8-digit ASCII buffers are added, the result might

need to be expanded to a 9-digit ASCII buffer. The result
buffer size is always at least as large as the larger of the
two buffers to be added.
• 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
Description: These entries are reserved and are always 000.
4-67
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5 Enhanced States
The enhanced states that are supported are as follows:
• Text To Speech (AU b/)

• Card Reader (CR b/)
• Depositor (DP b/)
• Dispenser Door (for presenter operations)(DR b/)
• Get Encrypted PIN (EP b/)
• Image Character Recognition (ICb/)
• Lead-through Indicators (LT b/)
• Network Connection (NC b/)
• Passbook Printer (PB b/) (currently not supported)
• Printer (PR b/)
• Statement Printer (SP b/)
• Check FIT (@B b/)
• Check PIN (@C b/)
• Information Entry (@D b/)
• Enhanced Buffer Compare (@E b/)
• Set Buffer (@F b/)
• Buffer Copy (@G b/)
• Check Buffer (@H b/)
• Transaction Request (@I b/)
• Indirect Next (@K b/)
• Create Buffer (@L b/)
• Track Buffer Compare (@M b/)
• Buffer Shift (@N b/)
• Buffer Arithmetic (@O b/)
• Copy Buffer Data (@P b/)
• Buffer Overlay (@Q b/)
• Time Delay (@S b/)
• Multi-tasking (@X b/)
• Set Language Bank (@Y b/)
• Close (@Z b/)
Required and Optional Entries

All the states contain entries that the network is required to send with the state.
Some states also contain optional entries. The optional entries are shown in
italics in this section. All entries must be in three-byte decimal form. Use
decimal equivalents for all ASCII, Hex, and bit-mapped values.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.1 Text To Speech State (AU b/)
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.
Table 4-32 Text To Speech State Format
Entry Valid Range
State Number Valid state numbers
State Type AU b/
Unit Number 001
Next State Valid state numbers
Interrupt Flag 000 - 002
Buffer ID 064 - 090
Template Number 000 - 099
Delay 000 - 255
Reserved 000
Reserved 000
Reserved 000
The following paragraphs describe each entry in the Text To Speech state.
State Number
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Next State
Description: The Next State entry identifies the next state the terminal goes to
after performing the Text To Speech state processing.
Interrupt Flag
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.
• 002 - Terminate the message in progress. Purge the message queue.
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
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
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.2 Card Reader State (CR b/)
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.
Table 4-33 Card Reader State Format
Entry Valid Range
State Type CR b/
Unit Number 001
Operation 001 - 007, 009 - 015
Screen Number Valid screen numbers
Consumer Response Time 000 - 255, 900 - 931, 999
Good Operation Next State [1] Valid state numbers
Consumer Fault Next State Valid state numbers
Hardware Fault Next State Valid state numbers
Network Fault Next State Valid state numbers
Read Conditions [2] 000 - 017
Reserved [3] 000
Reserved [3] 000
Reserved [3] 000
Reserved [3] 000
Pre-head 000 - 002

[1] A retain operation that results in the card being taken before it can be retained
(:3F:40:60) results in a Good Operation Next State exit. This is because there are
no adverse effects of such an event on the terminal. In this case, the retain count is
not incremented.
[2] The Read Conditions entry is only necessary when the Operation entry is 001,
013, or 014.
[3] These Reserved entries are only necessary when the Operation entry is 001, 013, or
014, and the card reader is a smart card reader.
The following paragraphs describe each entry in the Card Reader state.
State Number
Description: The State Number entry identifies groups of related state data
4-71
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: CR b/
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
If the terminal uses a swipe-style or standard dip card reader,

the only applicable Operation entry is 001.
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).
• 005 - Reserved for future use
• 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
TP-821029 (Ed. A)
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
The name track data cannot be displayed for screens which

insert the name field from track 1 of the card, until the
card read operation is complete. Operation 010 must be
performed to complete the sequence. System operation is
unpredictable if another card read operation is attempted
between operation 009 and 010.
• 010 - Wait until the card read started by operation 009 is completed. The
sequence of operation 009 and 010 is equivalent to operation 001.
verifies the track 1 data or a fault is encountered. This operation requires a
card reader capable of writing on track 1.
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:
• 000 - Do not change the screen currently showing

• 001 through 950, and 999 - Screen number
4-73
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Consumer Response Time

Valid Range: 000 through 255, 900 through 931, and 999
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:
• 000 through 255 - Number of ticks (no beeping)

• 900 through 931 - Configured timers 900 through 931
• 999 - Wait forever
Refer to Section 4.23 for additional timer information
Good Operation Next State

Description: The Good Operation Next State entry identifies the exit state to
which the terminal goes when the operation specified is successful.
Consumer Fault Next State

Description: The Consumer Fault Next State entry identifies the exit state to
which the terminal goes when the consumer fails to respond to the screen shown
on the Consumer Display. The terminal goes to this next state when the time
defined in the Consumer Response Time entry expires or when the card fails
the read conditions.
Hardware Fault Next State

Description: The Hardware Fault Next State entry identifies the exit state to
which the terminal goes when the operation specified by the state fails because
of a hardware fault in the terminal.
Network Fault Next State

Description: The Network Fault Next State entry identifies the exit state to
of a network fault.
Read Conditions (composite)

Description: If the Operation entry contains 001 (read the card), the Read
Conditions entry tells the terminal which card track(s) it must read correctly. The
terminal must satisfy the Read Conditions before going to the Good Operation
Next State. The valid values are as follows:
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
TP-821029 (Ed. A)
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.

• 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)
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.
Reserved (four entries)

Valid Range: 000
Description: These entries are reserved for future use.
NOTE
If the Pre-head entry is being used, the four Reserved entries

are required.
The Pre-head entry is only applicable for motorized card

readers with the pre-head option.
Pre-head
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
• 000 - Use the default in the .INI file

4-75
TP-821029 (Ed. A)
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:
• Define the state number as 200
• Show screen 011 upon entering the state
• Read tracks 2 and 3 from the consumer’s card
• Exit to one of the following state numbers:
- 003 if tracks 2 and 3 are read successfully
- 004 if track 3 has an LC error, the consumer fails to enter a card in 60

ticks, or the card jams
- 005 if the card reader fails to communicate properly
- 006 if unit number 001 is not defined in the Card Reader configuration
setting.
Table 4-34 Example Card Reader State
Entry Value
State Number 200
State Type CR b/
Unit Number 001
Operation 001
Screen Number 011
Consumer Response Time 060
Good Operation Next State 003
Consumer Fault Next State 004
Hardware Fault Next State 005
Network Fault Next State 006
Read Conditions 006
4-76
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.3 Depositor State (DP b/) (terminals with IDM only)
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.
Table 4-35 Depositor State Format
Entry Valid Range
State Type DP b/
Unit Number 001
Operation 000 - 004
Good Operation Next State Valid state numbers
Print Buffer ID [1] 000, 064 - 090
MICR Buffer ID [1] 064 - 090
Deposit Bin ID [1] 000 - 003
Image Enable [1] 000, 001, 003, 005, 007
Check Accepted Screen [1] Valid screen numbers
Check Handling Delay Screen [1] Valid screen numbers
Check Handling Delay Time [1] 000 - 255, 900 - 931, 999
MICR Fault Next State [1] Valid state numbers
Media Fault Next State [1] Valid state numbers
Cancel Next State [1] Valid state numbers
Document Handling Next State [1] Valid state numbers
MICR Read Position Setting [1] 000 - 001, 004 - 252
Maximum Document Length [1][2] 150 - 225
Scanner Fault Next State [1][2] Valid state numbers

[1] These entries are not required for operations 000 and 001.
[2] These entries are only included if the Recognition Subsystem is used.
The following paragraphs describe each entry in the Depositor state.
State Number
4-77
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: DP b/
Unit Number
Valid Range: 001
Description: The unit number for the Depositor state must be 001.
Operation
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.


- Read the MICR line as directed by the MICR Read Position Setting entry
or the MICR search preference set in the Depositor device properties

Enable entry.


ID entry. The deposit then proceeds as described in the preceding paragraphs.
4-78
TP-821029 (Ed. A)
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.
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.

the Deposit Bin ID entry.
Screen Number
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:

• 001 through 950, 999 - Screen number

screen, the terminal goes to the exit state identified by the Consumer Fault
Next State entry.
This entry is used only with operations 001, 002, and 004. This entry is not
used with operations 000 and 003.
The valid values for this entry are as follows:

4-79
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States

which the terminal goes when the specified operation is successful.

which the terminal goes if the consumer fails to respond to the screen shown on
the consumer display. The terminal goes to this state when the time specified in
the Consumer Response Time entry expires.

which the terminal goes if the specified operation fails because of a hardware
fault.

Description: The Network Fault Next State entry identifies the exit state the
terminal goes to if the specified operation fails because of a network fault.
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
TP-821029 (Ed. A)
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

Description: This entry contains the number of the screen to display when the
IDM has accepted a check, but has not yet read or scanned the check. If the value
in this entry is 000, the terminal does not change the screen currently showing. If
this entry is not included, the value defaults to 000.

Description: This entry contains the number of the screen to display if the time
specified in the Check Handling Delay Time entry expires after the check is
accepted. This screen is used to assure the customer that the check is still being
handled in case the IDM has difficulty locating the MICR data. If the value in
this entry is 000, the terminal does not change the screen currently showing. If
this entry is not included, the value defaults to 000.

Description: The value in this entry specifies how long, in 800-millisecond ticks,
to wait from the time the check is accepted until displaying the Check Handling
Delay screen. The valid values for this entry are as follows:

MICR Fault Next State

Description: The MICR Fault Next State entry identifies the exit state to which
the terminal goes when the terminal encounters a fault when reading the MICR
data.
Media Fault Next State

Description: The Media Fault Next State entry identifies the exit state to which
the terminal goes when the terminal encounters a problem with the deposited
document. For example, the document might be longer than the maximum length
specified in the Maximum Document Length entry.
4-81
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Cancel Next State

Description: The Cancel Next State entry identifies the exit state to which the
terminal goes when the consumer cancels the operation by using the Cancel key.
Document Handling Next State

Description: The Document Handling Next State entry identifies the exit state
to which the terminal goes when the IDM encounters a problem in handling
the document.
MICR Read Position Setting

Description: This entry is used to override the MICR search preference set in the
Depositor device properties. If this entry is not included, the value defaults to
001. The valid values are as follows:


Maximum Document Length

Description: The Maximum Document Length entry tells the terminal the
maximum length of the deposit document. The valid range is 150 to 225
millimetres (approximately 6 to 9 inches). If this entry is left blank or is invalid,
the terminal uses the value specified in the Depositor device properties. If
neither source has a valid value, the IDM uses the hardware default value. If
the document exceeds this length, the terminal takes the Media Fault Next
State exit. The default value is 225.
Scanner Fault Next State

Description: The Scanner Fault Next State entry identifies the exit state to which
the terminal goes when the scanner operation fails, if the scanner failure is a hard
fault. If the Scanner Fault Next State is not included in the state table data, the
default exit is the Hard Fault Next State.
4-82
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of a Depositor state is shown in Table 4-36. This example state

instructs the terminal to do the following:
• Show screen number 030 upon entering the state
• Perform a check deposit with the following criteria:
- Read the MICR data as defined in the Depositor device properties

- Store the MICR data in buffer 087 (W)
- Show screen 013 when the check is accepted
- Store the check in deposit bin 2
- 035 if the check deposit operation is successful
- 090 if the consumer cancels the transaction or does not insert a check
- 100 if the depository fails to communicate properly with , or if the

depository is not enabled (Depositor device properties)
- 050 if the MICR read operation fails
- 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Table 4-36 Example Depositor State
Entry Value
State Number 300
State Type DP b/
Unit Number 001
Operation 002
Screen Number 030
Print Buffer ID 081
MICR Buffer ID 087
Deposit Bin ID 002
Image Enable 001
Check Accepted Screen 013
Check Handling Delay Screen 000
Check Handling Delay Time 000
MICR Fault Next State 050
Media Fault Next State 060
Cancel Next State 090
Document Handling Next State 080
MICR Read Position Setting 001
4-84
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.4 Dispenser Door State (DR b/)
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.
Table 4-37 Dispenser Door State Format
Entry Valid Range
State Type DR b/
Unit Number 001
Operation 001 - 003, 005 - 008, 010 - 016
The following paragraphs describe each entry in the Dispenser Door state.
State Number
State Type
Valid Range: DR b/
Unit Number
Valid Range: 001
Description: The unit number for the Dispenser Door state must be 001.
4-85
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
Valid Range: 001 through 003, 005 through 008, and 010 through 016
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.
• 006 - Conditional exercise
• 007 - Unconditional exercise
• 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.
• 011 - Restore and wait for operation to complete.
• 012 - Retract and wait for operation to complete.
• 013 - Retain and wait for operation to complete.
• 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
• 016 - Retain and do not wait for operation to complete. The terminal goes
4-86
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Screen Number
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:



Refer to Section 4.23 for additional timer information


which the terminal goes when the consumer fails to respond to the screen shown
on the consumer display. The terminal goes to this next state when the time
defined in the Consumer Response Time entry expires.


of a network fault.
EXAMPLE
An example of a Dispenser Door state is shown in Table 4-38. This example state
4-87
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
• Present the bills to the consumer.
- 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
- 006 if a fault occurs during the operation
- 007 if unit number 001 is not defined in the Fascia configuration setting
Table 4-38 Example Dispenser Door State
Entry Value
State Number 300
State Type DR b/
Unit Number 001
Operation 002
Screen Number 012
4-88
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.5 Get Encrypted PIN State (EP b/)
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.
Table 4-39 Get Encrypted PIN State Format
Entry Valid Range
State Type EP b/
Operation 001
Buffer ID 064 - 090, 256 - 355
Error Next State Valid state numbers
The following paragraphs describe each entry in the Get Encrypted PIN state.
State Number
State Type
Valid Range: EP b/
Operation
Valid Range: 001
during the processing of the state. The only valid value for the Get Encrypted
PIN state is 001.
4-89
TP-821029 (Ed. A)
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.

which the terminal goes when the encrypted PIN block has been successfully
retrieved from the encrypting PIN pad and stored in the specified buffer.
Error Next State

Description: The Error Next State entry identifies the exit state the terminal goes
to when the operation fails for any reason.
4-90
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.6 Image Character Recognition State (IC b/)
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.
Table 4-40 Image Character Recognition State Format
Entry Valid Range
State Type IC b/
Operation 000, 001
Good Next State Valid state numbers
Execution Fault Next State Valid state numbers
Document Type 001 - 999
Document Index 001 - 999
Document Window 001 - 999
Buffer ID 064 - 090, 256 - 355

•
•
•
Document Window 001 - 999
Buffer ID 064 - 090, 256 - 355
The following paragraphs describe each entry in the Image Character

Recognition state.
State Number
4-91
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: IC b/
Operation
Valid Range: 000, 001
Description: The Operation entry tells the terminal which operation to perform.
• 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


Execution Fault Next State

Description: The Execution Fault Next State entry identifies the exit state to
which the terminal goes when the specified operation fails.

which the terminal goes when the specified operation fails because of an invalid
state entry or an entry out of range.
Document Type
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
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Document Window
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
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
The state accepts a maximum of up to 25 window/buffer

pairs. The Buffer ID is needed to process the state entries
correctly, but is only used for a Read operation. This
number can be any number in the valid range. However,
no results are placed in that buffer for an Enable operation.
EXAMPLE
The following table shows the standard, predefined document types, document
indexes, and document windows used by Agilis 91x for ix/CSP:
Document Document Document

Type Index Window
U.S. Check Courtesy Amount 1 1 1
U.S. Check E13B MICR Line 1 1 2
4-93
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.7 Lead-through Indicators State (LT b/)
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).
Table 4-41 Lead-through Indicators State Format
Entry Valid Range
State Type LT b/
Lamp Number 001 - 011, 100
Condition 000 - 002
Time 000 - 999
Flash Rate 000 - 255
Color [1] 000 - 002

[1] This entry is optional. If it is not included in the state table, the value defaults to
000 (green).
The following paragraphs describe each entry in the Lead-through Indicators

state.
State Number
State Type
Valid Range: LT b/
4-94
TP-821029 (Ed. A)
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:
• 001 - Passbook printer currently not supported)

• 002 - Card reader
• 003 - Bill dispenser
• 004 - Envelope depository
• 005 - Coin dispenser
• 006 - All indicators
• 007 - Receipt printer
• 008 - Check depository
• 009 - After Hour depository
• 010 through 011 - Reserved
• 100 - Automatic mode
If 100, automatic mode, is used, then the condition and flash rate values are
applied to future automatic lead-through operations.
Condition
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
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
Description: The Flash Rate entry specifies the rate at which to flash the
indicator. The flash rate is specified in the following manner:
• 1 through 85 - Low rate

• 86 through 170 - Medium rate
• 170 through 254 - High rate
• 255 - Reserved
Next State
Description: The Next State entry identifies the next state the terminal goes to
after performing the desired indicator operation.
4-95
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Color
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
An example of the Lead-through Indicators state is shown in Table 4-42. This

state directs the terminal to do the following:
• Have the card reader lead-through indicator flash for 30 seconds at a low rate
• Exit to state 300
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.
Table 4-42 Example Lead-through Indicators State
Entry Value
State Number 340
State Type LT b/
Lamp Number 002
Condition 002
Time 030
Flash Rate 005
Next State 300
4-96
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.8 Network Connection State (NC b/)
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.
Table 4-43 Network Connection State Format
Entry Valid Range
State Number 000 - 250, 256 - 511
State Type NC b/
Unit Number 001
Operation 000 - 002
The following paragraphs describe each entry in the Network Connection state.
State Number
associated state number either while performing another state or performing a
function commanded by the network.
State Type
Valid Range: NC b/
Unit Number
Valid Range: 001
Description: The unit number for the Network Connection state must be 001.
4-97
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
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: 000
Description: The Consumer Response Time entry is not used and must be 000.

Description: The Good Operation Next State entry identifies the exit state the
terminal goes to when the operation specified is successful.

Valid Range: 000
Description: The Consumer Fault Next State entry is not used and must be 000.

Valid Range: 000
Description: The Hardware Fault Next State entry is not used and must be 000.

Description: The Network Fault Next State entry identifies the exit state the
terminal goes to when the operation specified by the state fails because of a
network fault. An example of a network fault is if the value in the operation
entry is out of range.
4-98
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of a Network Connection state is shown in Table 4-44. This example

state directs the terminal to do the following tasks:
• Begin the network connect process
- 300 Good Operation Next State
- 500 Network Fault Next State
Table 4-44 Example Network Connection State
Entry Value
State Number 075
State Type NC b/
Unit Number 001
Operation 001
Screen Number 100
4-99
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.9 Passbook Printer State (PB b/)
The Passbook Printer state is not currently supported.
4-100
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.10 Printer State (PR b/)
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).
Table 4-45 Printer State Format
Entry Valid Range
State Type PR b/
Unit Number 001 - 003
Operation 001 - 008
Print Buffer ID 064 - 090, 256 - 355
Unremoved Document Flag 000 - 001
The following paragraphs describe each entry in the Printer state.
State Number
Command messages. The State Type entry identifies the specific type of state
data entries associated with the state number.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Unit Number
Description: The unit number for the Printer state tells the terminal which device
this state is for. The valid values are as follows:
• 001 - Receipt printer (or statement printer emulating a receipt printer)

• 002 - Journal printer
• 003 - Electronic data capture (EDC)
Operation
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
TP-821029 (Ed. A)
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:
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.
• 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.
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.
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
TP-821029 (Ed. A)
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.
operation to complete. The terminal takes a Good Operation Next State exit
after the printer successfully dumps the receipt.
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
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


that the terminal waits for the consumer to take the delivered document.
4-104
TP-821029 (Ed. A)
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.
• 000 - The interpretation depends on which operation is specified, as follows:
- Operations 001 and 002 - Use timer 21 (If the value of timer 21 is 000, the
terminal does not automatically retain the receipt.)
- Operation 003 - Exit to the Good Operation Next State immediately

after delivering the receipt
• 900 through 931 - Configured timers 900 through 931.
• 999 - Wait forever (no beeping)


which the terminal goes when the consumer fails to take the printed document
within the allotted time (as specified by the Consumer Response Time entry).
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.


of a network fault.
Print Buffer ID
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Unremoved Document Flag

Valid Range: 000 and 001
Description: The Unremoved Document Flag entry tells the terminal what action
to take when a document has not been removed in the time allotted (as specified
in the Consumer Response Time entry).
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.
• 000 - Retain the document in the retain bin

• 001 - Retain the document on the ground
If a document is retained or dumped due to a timeout, an unsolicited status is

sent to the network.
4-106
TP-821029 (Ed. A)
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)
- 300 if the operation is successful
- 400 if the printer faults
- 500 if the print data is invalid, or if unit number 001 is not defined in the
Receipt Printer configuration setting
Table 4-46 Example Printer State (Receipt Printer without Exit

Sensor)
Entry Value
State Number 075
State Type PR b/
Unit Number 001
Operation 003
Screen Number 100
4-107
TP-821029 (Ed. A)
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:
• Do not change the screen shown upon entering the state
• Start printing the consumer’s receipt and do not wait for the operation to
complete (operation 001)
- 300 if the printing starts successfully

- 400 if the printer fails to communicate properly
- 500 if unit number 001 is not defined in the Receipt Printer configuration
setting
• 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 Number 075
State Type PR b/
Unit Number 001
Operation 001
Screen Number 000
Print Buffer ID 080
Unremoved Document Flag 000
4-108
TP-821029 (Ed. A)
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).
- 300 if printing is successful
- 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 Number 075
State Type PR b/
Unit Number 001
Operation 004
Screen Number 000
Print Buffer ID 080
4-109
TP-821029 (Ed. A)
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
• Start printing on the journal printer and do not wait for the operation to
complete (operation 001)
- 150 if the printing starts successfully
- 200 if the printer fails to communicate properly
- 250 if unit number 002 is not defined in the Journal Printer configuration
setting
• Continue printing the consumer’s receipt using the data in buffer R
Table 4-49 Example Printer State (Journal Printer)
Entry Valid Range
State Number 077
State Type PR b/
Unit Number 002
Operation 001
Screen Number 000
Print Buffer ID 082 (R)
4.5.11 Supplemental Dispenser Module (SDM) State (SDb/)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
NOTE
The SDM has 010 units of power allocated to it while

performing a dispense operation.
Table 4-50 Supplemental Dispenser Module (SDM) State Format
ENTRY VALID RANGE
State Type ’SD b/’
Unit Number 001
Operation 001-002
Screen #1 000, 001-511
Screen #2 000, 001-511
Consumer Response Time 000-255, 900-931, 999
The following paragraphs describe each field in the Enhanced Supplemental

Dispenser State.
State Number
Description: The State Number entry identifies groups of related State data
State Type
Valid Range: SD b/
Description: The State Type entry identifies the specific type of State data entries
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
• 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
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

• 001 through 899, 900 through 850, 999 - Screen Number
Screen #2
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:

• 001 through 899, 900 through 850, 999 - Screen Number

Valid Range: 000-255, 900-931, 999
consumer display. If this entry contains a value other than 999 and the 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:
• 000-255 - Number of ticks (no beeping)

• 900-931 - Configured Timers 900 - 931


Description: The Consumer Fault Next State entry identifies the next state to
be taken if the time indicated in the Consumer Response Time entry expires
4-112
TP-821029 (Ed. A)
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.


of an invalid state entry or an entry out of range.
4-113
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.12 Statement Printer State (SP b/)
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.
Table 4-51 Statement Printer State Format
Entry Valid Range
State Type SP b/
Unit Number 001
Operation 001 - 008
Print Data ID 064 - 090, 256 - 355, ’@’, ’A’ - ’Z’
Print Data Type 000 - 003
Reserved 000
The following paragraphs describe each entry in the Statement Printer state.
State Number
4-114
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: SP b/
Unit Number
Valid Range: 001
Description: The unit number for the Statement Printer state must be 001.
Operation
• 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
• 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
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.
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
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
• 007 - Retain any statement that is still in the delivery position. Wait for the
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
that the terminal shows on the consumer display when the function is being
performed. The valid values are as follows:


that the terminal waits for the consumer to take a presented statement. This
entry is used only with operations 002 and 003. The valid values for this entry
are as follows:



Description: The Consumer Fault Next State entry identifies the next state to
be executed in either of the following situations:
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States

which the terminal goes if the state processing encounters data that it does not
know how to handle while processing an operation that waits to complete before
responding. This can include (but is not limited to) the following items:
• Invalid operation number

• Invalid print data
• A file containing print data could not be found
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.
Print Data Type

Description: The Print data Type entry identifies the type of print data to print
on the statement printer. This field is only used for print operation 001 and
• 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.
• 002 - The print data is stored in a file in c:\DIEBOLD\TCS\sp. The file

name is SPDATA_x.TXT, where ’x’ is the value in the Print Data ID entry.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
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:
• 000 - Retain the document in the retain bin.

• 001 - Retain the document on the ground.
This entry is only used for print operation 002, deliver and do not wait.
EXAMPLE
An example of a Statement Printer state is shown in Table 4-52. This state

• Show screen number 100 upon entering the state
• Print the statement and wait for the operation to complete (operation 004)
• Get the print data from a file called DIEBOLD\TCS\sp\SPDATA_S.TXT
• Exit to one of the following states:
- 300 if the operation is successful

- 500 if a statement printer is not defined
Table 4-52 Example Statement Printer State
Entry Value
State Number 075
State Type SP b/
Unit Number 001
Operation 004
Screen Number 100
Print Data ID ’S’
Print Data Type 002
Reserved 000
4-118
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.13 Check FIT State (@B b/)
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
details on FIT.
NOTE
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 FIT entries, refer to the Data Security
Procedures and Reference Manual (TP-799530-001D).
Table 4-53 Check FIT State Format
Entry Valid Range
State Type @B b/
Match Next State Valid state numbers
No Match Next State Valid state numbers
PIN Retry Count 000 - 255
The following paragraphs describe each entry in the Check FIT state.
State Number
State Type
Valid Range: @B b/
4-119
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Match Next State

Description: This entry specifies the state number of the exit to be taken if the
Institution ID from the card matches an Institution ID in the FIT entries.
No Match Next State

Institution ID from the card does not match an Institution ID in the FIT entries.


of a network fault.
PIN Retry Count

Description: If programmed to do so in the FIT, the PIN Retry Count entry
specifies the maximum number of times a consumer can enter an incorrect PIN
before the terminal goes to the Maximum Bad PINs Next State (identified in
the Check PIN state).
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
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
• Store the Institution ID data read from the consumer’s card
4-120
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
• Check the FIT entries for match with the Institution ID
- 200 if the Institution ID from the card matches an Institution ID in the

FIT entries
- 300 if the Institution ID from the card does not match an Institution ID
in the FIT entries
Table 4-54 Example Check FIT State
Entry Value
State Number 110
State Type @B b/
4-121
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.14 Check PIN State (@C b/)
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
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 FIT entries, refer to the Data Security
Table 4-55 Check PIN State Format
Entry Valid Range
State Type @C b/
Maximum Bad PINs Next State Valid state numbers
No Local PIN Check Next State Valid state numbers
PIN Buffer ID 064
PIN Retry Count 000 - 255
The following paragraphs describe each entry in the Check PIN state.
State Number
4-122
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: @C b/
Match Next State

PIN entered by the consumer matches the calculated PIN.
No Match Next State

PIN entered by the consumer does not match the calculated PIN.


of a network fault.
Maximum Bad PINs Next State

Description: The Maximum Bad PINs Next State entry identifies the exit state to
which the terminal goes if the consumer exceeds the maximum number of PIN
attempts (PIN Retry Count entry in the Check FIT state or Check PIN state).
No Local PIN Check Next State

Description: The No Local PIN Check Next State entry identifies the exit state
to which the terminal goes when the consumer’s associated FIT entry specifies
that the terminal send the consumer’s PIN to the network for verification (no PIN
check performed at the terminal).
PIN Buffer ID
Valid Range: 064
Description: The only valid entry for this state is 064.
PIN Retry Count

Description: If programmed to do so in the FIT, the PIN Retry Count entry
specifies the maximum number of times a consumer can enter an incorrect PIN
before the terminal goes to the Maximum Bad PINs Next State (identified in
the Check PIN state).
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
TP-821029 (Ed. A)
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
• Verify the consumer-entered PIN according to the directions in the FIT entry
4-124
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
• If programmed to do so in FIT, use the state’s PIN Retry Count (003) to

determine the number of maximum bad PIN entry attempts the consumer is
allowed
- 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
- 070 if the hardware faults
- 080 if the network faults
- 090 if the consumer entered too many bad PINs
- 095 if the FIT entry tells the terminal to send the PIN to the network for
verification
Table 4-56 Example Check PIN State
Entry Value
State Number 120
State Type @C b/
Maximum Bad PINs Next State 090
No Local PIN Check Next State 095
PIN Buffer ID 064
PIN Retry Count 003
4-125
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.15 Information Entry State (@D b/)
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)
• Format the way consumer-entered data is shown (format templates)
• Select the buffers in which to store consumer keystroke data
• Exit to another state depending on whether the consumer presses a function

key or fills the format template shown on the screen.
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.
The Information Entry state can also be used as a time delay

state. To accomplish this, only the entries up to and including
the Timeout #2 Next State be defined, even if no function keys
are enabled.
4-126
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
NOTE
If a function key has been assigned to voice volume control,

Agilis 91x for ix/CSP ignores any attempt to enable that
function key for any other use during a consumer session. For
details, refer to Section 4.17.
Table 4-57 Information Entry State Format
Entry Valid Range
State Type @D b/
Screen #1 Valid screen numbers
Screen #2 Valid screen numbers
Do You Want More Time? 000 - 001
Timeout #1 000 - 255, 900 - 931, 999
Timeout #2 000 - 255, 900 - 931, 999
Timeout #1 Next State Valid state numbers
Timeout #2 Next State (refer to the Note Valid state numbers

above)
Format Template Number 000 - 099
Number of Keys 001 - 255
Numeric Key Buffer ID 065 - 090, 256 - 355
Format Template Full Next State Valid state numbers
Function Key Buffer ID 000, 064 - 090, 256 - 355
Function Key Buffer Byte 001 - 255
Function Key A Next State (refer to the Valid state numbers

Note above)
Function Key B Next State Valid state numbers
Function Key C Next State Valid state numbers
Function Key D Next State Valid state numbers
Function Key E Next State Valid state numbers
Function Key F Next State Valid state numbers
Function Key G Next State Valid state numbers
Function Key H Next State Valid state numbers
Function Key I Next State Valid state numbers
Function Key J Next State Valid state numbers
Function Key K Next State Valid state numbers
Function Key L Next State Valid state numbers
Function Key M Next State Valid state numbers
The following paragraphs describe each entry in the Information Entry state.
4-127
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Number
State Type
Valid Range: @D b/
Screen #1
Description: The Screen #1 entry specifies the number of the first screen
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:

• 001 through 511, 900 through 950, and 999 - Screen number
Screen #2
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:

• 001 through 511, 900 through 950, and 999 - Screen number
Do You Want More Time? Screen Enable

Description: This entry enables the terminal to show the Do You Want More
Time? special screen. If this entry is set to 001 (enabled) and either Timeout #1
or Timeout #2 expires, the terminal shows the special screen and waits for a Yes
or No response from the consumer.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Timeout #1
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

Refer to Section 4.23 for additional timer information.
Timeout #2
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

Timeout #1 Next State

Description: The Timeout #1 Next State entry identifies the exit state to which
the terminal goes when the consumer fails to press a key timed by Timeout #1.
Timeout #2 Next State

Description: The Timeout #2 Next State entry identifies the exit state to which
the terminal goes when the consumer fails to press a key timed by Timeout #2.
Format Template Number

Description: The Format Template Number entry specifies which format
template the terminal uses to define and show the data that the consumer
enters using the numeric keys of the keypad. The valid values for this entry
are as follows:
• 000 - Disable the numeric keys

• 001 through 099 - Format template number
Number of Keys (First Timeout)

4-129
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Description: The Number of Keys entry defines the number (amount) of

keypresses timed by Timeout #1. These keys are the first set of keys the
consumer presses to enter data during the state (for example, the numeric
keys for a transaction amount). Timeout #2 times any additional keys that the
consumer must press during the state (for example, a function key to terminate
the entry of the transaction amount).
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:
• 001 through 254 - Number of keypresses timed by Timeout #1

• 255 - All keypresses timed by Timeout #1
Numeric Key Buffer ID

Valid Range: 064 (PIN entry) 065 through 090 (buffers A through Z), and
258 through 299 (enhanced buffers)
Description: The Numeric Key Buffer ID entry identifies which buffer the
terminal uses to store the numeric data entered by the consumer during the
Information Entry state. The terminal automatically clears this buffer upon
entering the Information Entry state.
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 @).
Format Template Full Next State

Description: The Format Template Full Next State entry identifies the exit state
to which the terminal goes when the consumer fills the format template shown
on the consumer display.
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.
• Valid state numbers - State number

• 255 - Remain in current state until function key is pressed
Function Key Buffer ID

Valid Range: 000, 065 through 090 (A through Z), and 256 through 355
Description: The Function Key Buffer ID entry identifies which buffer contains
the key code data for the function key pressed by the consumer. The valid
values for this entry are as follows:
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Function Key Buffer Byte From Start

Description: The Function Key Buffer Byte From Start entry identifies the
position in the buffer where the terminal stores the key code data for the function
key pressed by the consumer. The function key byte is counted from the first
byte in the buffer.
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
Function Key X Next State

Description: The Function Key X Next State entry identifies the exit state to
which the terminal goes when the consumer presses the related function key
during the state (X = any of the function keys, A through M). The valid values
• Valid state numbers - State number

• 255 - Disable the function key while in the state
4-131
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of an Information Entry state is shown in Table 4-58. This example

• Show Screen #1 (026) upon entering the state
• Disable Screen #2
• Disable the Do You Want More Time? screen
• Set Timeout #1 for 8 ticks
• Disable Timeout #2 (Number of Keys entry is 255)
• Call format template 002, enabling the numeric keys of the keypad
• Place any numeric data entered into buffer B
• Place the key code for any function key pressed into the third byte of buffer O
• Enable function keys A, C, and E (Cancel)
- 001 if a timeout occurs (Timeout #l)

- 002 if the consumer fills the format template
- 003 if the consumer presses function key A
- 004 if the consumer presses function key C
- 005 if the consumer presses the Cancel key
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.
Table 4-58 Example Information Entry State
Entry Value
State Number 050
State Type @D b/
Screen #1 026
Screen #2 000
Do You Want More Time? 000
Timeout #1 008
Timeout #2 XXX [1]
Timeout #1 Next State 001

[1] XXX denotes any character
4-132
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Table 4-58 Example Information Entry State (continued)
Entry Value
Timeout #2 Next State XXX [1]
Format Template Number 002
Number of Keys (First Timeout) 255
Numeric Key Buffer ID 066 (B)
Format Template Full 002
Function Key Buffer ID 079 (O)
Function Key Buffer Byte From Start 003
Function Key A Next State 003
Function Key B Next State 255
Function Key C Next State 004
Function Key D Next State 255
Function Key E Next State 005

[1] XXX denotes any character
4-133
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.16 Buffer Compare State (@E b/)
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:
• Buffer 1 < Buffer 2

• Buffer 1 = Buffer 2
• Buffer 1 > Buffer 2
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.
Table 4-59 Buffer Compare State Format
Entry Valid Range
State Type @E b/
Compare Mode 001, 002
Buffer_1 ID 064 - 090, 256 - 355
Buffer_1 Offset 001 - Buffer_1 Length
Buffer_2 ID 064 - 090, 256 - 355
Buffer_2 Offset 001 - Buffer_2 Length
Buffer_1 Value < Buffer_2 Value Next State Valid state numbers
Buffer_1 Value = Buffer_2 Value Next State Valid state numbers
Buffer_1 Value > Buffer_2 Value Next State Valid state numbers
Compare Error Next State Valid state numbers
4-134
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
The following paragraphs describe each entry in the Buffer Compare state.
State Number
State Type
Valid Range: @E b/
Compare Mode
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:
• 001 - Compare as ASCII decimal numeric data (ignore leading 0s)

• 002 - Compare as binary data 00 through FF (ignore leading NULLs)
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
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
Description: The Buffer_2 ID entry identifies the ID of the second buffer
in the comparison.
4-135
TP-821029 (Ed. A)
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.
Buffer_1 < Buffer_2 Next State

Description: The Buffer_1 < Buffer_2 Next State entry tells the terminal what
state to go to if the value in Buffer_1 is less than the value in Buffer_2.
Buffer_1 = Buffer_2 Next State

Description: The Buffer_1 < Buffer_2 Next State entry tells the terminal what
state to go to if the value in Buffer_1 is equal to the value in Buffer_2.
Buffer_1 > Buffer_2 Next State

Description: The Buffer_1 > Buffer_2 Next State entry tells the terminal what
state to go to if the value in Buffer_1 is greater than the value in Buffer_2.
Compare Error Next State

Description: The Compare Error Next State entry tells the terminal what state to
go to if the value in either Buffer_1 or Buffer_2 is not valid for the compare mode.
4-136
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.17 Set Buffer State (@F b/)
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.
Table 4-60 Set Buffer State Format
Entry Valid Range
State Type @F b/
Buffer ID 064 - 090, 256 - 355
Most Significant Byte From Start 001 - 255
Value 000 - 255
Value 000 - 255

• •
• •
• •
Value 000 - 255
The following paragraphs describe each entry in the Set Buffer state.
State Number
4-137
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States

State Type
Valid Range: @F b/

which the terminal goes once the buffer is set.
Buffer ID
Description: The Buffer ID entry identifies the buffer being set.
Most Significant Byte From Start

Description: The Most Significant Byte From Start entry identifies the position
in the buffer at which to begin setting values. The most significant byte is
counted from the first 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
g1959027
Figure 4-3 Example Most Significant Byte from Start Entry
Value
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

• Exit to state number 001 after changing the specified buffer bytes
• Set the fifth byte of buffer B to an A (041 hex, 065 decimal)
• Do not change the sixth byte of buffer B
• Set the seventh byte of buffer B to a 2 (032 hex, 050 decimal)
EXAMPLE
The example in Figure 4-4 shows the contents of buffer B before and after the
terminal performs the example Set Buffer state.
Table 4-61 Example Set Buffer State
Entry Value
State Number 120
State Type @F b/
Buffer ID 066 (B)
Most Significant Byte from Start 005
Value 065
Value 255
Value 050
4-139
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
g1959028
Figure 4-4 Set Buffer State Example
4-140
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.18 Buffer Copy State (@G b/)
The format of the Buffer Copy state table is shown in Table 4-62. The Buffer
Copy state copies a buffer to another buffer.
Table 4-62 Buffer Copy State Format
Entry Valid Range
State Type @G b/
Source Buffer ID 064 - 090, 256 - 355
Destination Buffer ID 064 - 090, 256 - 355
The following paragraphs describe each entry in the Buffer Copy state.
State Number
State Type
Valid Range: @G b/

which the terminal goes when the buffer copy is successful.
Source Buffer ID
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.
4-141
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Description: The Destination Buffer ID is the ID of the buffer to which

information is 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.
EXAMPLE
An example of a Buffer Copy state is shown in Table 4-63. This example state

• Exit to state 150 after the buffer is copied
• The Source Buffer ID is A
• The Destination Buffer ID is B
Table 4-63 Example Buffer Copy State
Entry Value
State Number 100
State Type @G b/
Source Buffer ID 065
Destination Buffer ID 066
4-142
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.19 Check Buffer State (@H b/)
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
The last value in the state data is compared to the value

contained in the buffer position indicated by the Least
Significant Byte From End entry. The values preceding the last
value in the state data are compared to more significant bytes
in the buffer (bytes to the left of the Least Significant Byte
from End buffer position).
Table 4-64 Check Buffer State Format
Entry Valid Range
State Type @H b/
Compare Mode 001 - 002
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
Buffer ID 064 - 090, 256 - 355
Least Significant Byte From End 001 - 255
Value 000 - 255
Value 000 - 255

• •
• •
• •
Value 000 - 255
The following paragraphs describe each entry in the Check Buffer state.
State Number
4-143
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: @H b/
Compare Mode
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 Least Significant Byte from End entry is 003
• 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)
• The state data values are ASCII 000
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.
Buffer Data Less Than State Data Next State

Description: This entry identifies the exit state to which the terminal goes when
the values in the buffer are less than the values in the state.
4-144
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer Data Equal To State Data Next State

the values in the buffer are equal to the values in the state.
Buffer Data Greater Than State Data Next State

the values in the buffer are greater than the values in the state.
Buffer ID
Description: The Buffer ID entry identifies a buffer.
Least Significant Byte From End

Description: The Least Significant Byte From End identifies the position in
the buffer at which to begin comparing values. The least significant byte is
counted from the last byte in the buffer.
A value of 001 in this entry represents the last (right-most) byte in the buffer. In
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
Figure 4-5 Example Least Significant Byte From End Entry
Value
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of a Check Buffer state is shown in Table 4-65. As shown in

Figure 4-5, the terminal goes to the different Next State exits depending on the
values in buffer B (an X denotes a "do not care" condition).
Table 4-65 Example Check Buffer State
Entry Value
State Number 100
State Type @H b/
Compare Mode Refer to Section 4.5
Buffer Data Less Than State Data Next State 001
Buffer Data Equal To State Data Next State 002
Buffer Data Greater Than State Data Next State 003
Buffer ID 066
Least Significant Byte From End 003
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.20 Transaction Request State (@I b/)
The Transaction Request state can be in two different formats. Format 0

of the Transaction Request state table is shown in Table 4-66. Format 1 of
the Transaction Request state table is shown in Table 4-68. The Transaction
Request state directs the terminal to build a Consumer Request message, and
then sends the message to the network. Specifically, the state data identifies
the following information:
• The buffers to send in the Consumer Request message
• 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
Table 4-66 Transaction Request State Format (format 0)
Entry Valid Range
State Type @I b/
Network Response Time 000 - 255, 900 - 931, 999
Network Response Timeout Next State Valid state numbers
Format Indicator 000 - 001
Send Track 2 Data 000 - 001
Send Track 1, Track 3, and/or MICR Data 000 - 007
Send Function Key Buffer Data 000 - 001
Send Dollar Buffer Data 000 - 001
Send PIN Buffer Data 000 - 001
Send General Purpose Buffer B/C Data 000 - 001
Cancel Key Enable Flag [1] 128
Cancel Key Next State [1] Valid state numbers
Cancel After Function Next State [1] Valid state numbers
Buffer ID [2] 065 - 090, 256 - 355

[1] If the Cancel Key Enable Flag entry is used, then the Cancel Key Next State and
Cancel After Function Next State entries must be included.
[2] The Buffer ID entry can be repeated, as needed, for multiple buffers.
The following paragraphs describe each entry in the Transaction Request state.
State Number
4-147
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: @I b/
Screen Number
the terminal shows on the consumer display when the terminal enters the state.

Network Response Time

Description: The Network Response Time entry defines the amount of time that
the terminal waits for the network’s response message to the Consumer Request
message. The valid values for this entry are as follows:

• 900 through 931 - Configured timers 00 through 31 (defined by silent
time entry only)
If this time expires before the network responds, the terminal goes to the exit
state identified by the Network Response Timeout Next State entry.
Network Response Timeout Next State

Description: The Network Response Timeout Next State entry identifies the
exit state to which the terminal goes when the network does not respond to
an terminal Consumer Request message within the specified time (Network
Response Time entry).
Format Indicator
Description: This entry indicates the format of the message. The valid values
are as follows:
• 000 - Format 0
• 001 - Format 1
4-148
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Send Track 2 Data

Description: The Send Track 2 Data entry indicates whether track 2 data should
be sent in the Consumer Request message. The valid values are as follows:

• 001 - Send data
Send Track 1, Track 3, and/or MICR Data

Description: This entry specifies whether track 1 data, track 3 data, MICR data,
or some combination of this data is sent to the network. The valid values
are as follows:
• 000 - No additional tracks

• 003 - Send track 1 and 3
• 004 - Send MICR only
• 007 - Send MICR and tracks 1 and 3
Send Function Key Buffer Data

Description: This entry indicates whether the Function Key data should be sent

• 001 - Send data
Send Dollar Buffer Data

Description: This entry indicates whether the Dollar Buffer data should be sent

• 001 - Send data
Send PIN Buffer Data

Description: This entry indicates whether the consumer entered PIN should be
sent in the Consumer Request message. The valid values are as follows:

• 001 - Send data
If the PIN is included in the message, the PIN is in encrypted form, based
on the applicable FIT entry.
Send General Purpose Buffers B and/or C Data

4-149
TP-821029 (Ed. A)
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.
• 000 - Do not send data from either buffer

• 001 - Send General Purpose Buffer B data only
• 002 - Send General Purpose Buffer C data only
• 003 - Send General Purpose Buffers B and C data
Cancel Key Enable Flag

Valid Range: 128
Description: This optional entry is used to enable the Cancel key in the
Transaction Request state. The only valid value is 128. If there is any other value
in this entry, the terminal ignores it.
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.

Description: This optional entry tells the terminal which state to go to if the
Cancel Key Enable Flag entry is 128 and the Cancel key is pressed. If the Cancel
key is enabled in the Transaction Request state and it is pressed before the
Function Command message is received by the terminal, the transaction request
state is terminated and the Cancel Next State is executed.
Cancel After Function Next State (912 mode only)

Description: The Cancel After Function Next State entry tells the terminal which
function command. The terminal terminates function processing in between
function IDs. A function command reject is sent to the network and the terminal
goes to the next state specified by this entry. Enter 255 to deactivate the Cancel
key during this state.
Buffer ID
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
Transaction Request state (format 0)
An example of a format 0 Transaction Request state is shown in Table 4-67. This

example state directs the terminal to do the following:
• Show screen 200 upon entering the state (usually a screen that asks the
consumer to please wait)
4-150
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
• Send the following information to network:
- Track 2 data
- Track 1 and 3 data
- Function Key data
- Dollar Buffer data
- Consumer-entered PIN
- General Purpose Buffer B data
• Wait 30 ticks for the network’s response message
• 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.
Table 4-67 Example Transaction Request State (format 0)
Entry Value
State Number 150
State Type @I b/
Screen Number 200
Network Response Time 030
Network Response Timeout Next State 300
Format Indicator 000
Send Track 2 Data 001
Send Track 1, Track 3, and/or MICR Data 001
Send Function Key Buffer Data 001
Send Dollar Buffer Data 001
Send PIN Buffer Data 001
Send General Purpose Buffers B and/or C Data 001
Changes for Format 1

The Transaction Request state table shown in Table 4-68 is format 1. The format 1
state table contains a list of buffers to send. This buffer list can be used with the
Recognition Subsystem to identify buffers used in the scanning process. The
shaded areas in Table 4-68 indicate the areas of the state format that are the same.
Table 4-68 Transaction Request State Format (format 1)
Entry. Valid Range
State Type @I b/
Screen Number 000 - 511
Network Response Time 000 - 255, 900 - 931, 999
4-151
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Table 4-68 Transaction Request State Format (format 1) (continued)
Entry. Valid Range
Network Response Timeout Next State Valid state numbers
Format Indicator 001
Buffer ID [1] 064 - 090, 256 - 355
Cancel Key Enable Flag 128
Cancel Key Next State Valid state numbers
Cancel After Function Next State Valid state numbers

[1] The Buffer ID entry can be repeated, as needed, for multiple buffers.
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.
The buffer ID entry can be repeated a necessary, if multiple buffers need to be

sent.
4-152
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.21 Indirect Next State (@K b/)
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.
Table 4-69 Indirect Next State Format
Entry Valid Range
State Type @K b/
Buffer ID 064 - 090, 256 - 355
Next State if Value = 00 Valid state numbers

• •
• •
• •
The following paragraphs describe each entry in the Indirect Next state.
State Number
4-153
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: @K b/
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.

of a network fault.
Next State if Value = XX

Description: The Next State If Value = xx entry identifies an exit state to which
the terminal goes based on matching the value of the two most significant bytes
in a buffer (or the value of the PSTDX entry in FIT) with the value contained in
the entry (xx).
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
The data in each buffer byte must be in the range of ASCII 0

through ASCII 9 ( :30 through :39). If either byte is outside this
range, the terminal takes the Network Fault Next State exit.
4-154
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer Byte 1 Buffer Byte 2 Equivalent State Value to Match
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
The data in the buffer byte must be in the range of ASCII 0

through ASCII 9 (hex 30 through hex 39). If the byte is outside
this range, the terminal takes the Network Fault Next State exit.
Buffer Byte Equivalent State Value to Match
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
TP-821029 (Ed. A)
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
• Read the value of PSTDX in FIT (Buffer ID is 000)
- 010 if the PSTDX entry does not equal any of the values listed in the
state data
- 100 if the PSTDX entry equals 00
Table 4-70 Example Indirect Next State
Entry Value
State Number 080
State Type @K b/
Buffer ID 000
Next State if Value = 00 100
4-156
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.22 Create Buffer State (@L b/)
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:
• Filling a buffer with a numerical amount associated with a single-key

amount selection
• Deleting an existing buffer by creating it again with no data defined in the

state’s Value byte entries
• Clearing a buffer
• Initializing a buffer to a given length with specific data
Table 4-71 Create Buffer State Format
Entry Valid Range
State Type @L b/
Buffer ID 064 - 090, 256 - 355
Value 000 - 255
Value 000 - 255

• •
• •
(38 entries maximum) •
• •
• •
Value 000 - 255
4-157
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
The following paragraphs describe each entry in the Create Buffer state.
State Number
State Type
Valid Range: @L b/

which the terminal goes once the buffer is created.
Buffer ID
Description: The Buffer ID entry identifies the buffer being created.
Value
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

• Create buffer J
• Fill the buffer with the Value bytes shown
• Exit to state 028
4-158
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Table 4-72 Example Create Buffer State
Entry Value
State Number 027
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.23 Track Buffer Compare State (@M b/)
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.
Table 4-73 Track Buffer Compare State Format
Entry Valid Range
State Type @M b/
Indirect Next State Index 000 - 255
Buffer ID/Delimiter 000 - 003, 016 - 019, 032 - 035
Delimiter Index 000 - 999
Match Character (first) 048 - 057, 063
Match Character (second) 048 - 057, 063
Match Character (third) 048 - 057, 063
Match Character (fourth) 048 - 057, 063
Match Character (fifth) 048 - 057, 063
Match Character (sixth) 048 - 057, 063
The following paragraphs describe each entry in the Track Buffer Compare state.
State Number
State Type
Valid Range: @M b/
4-160
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Match Next State

Description: This entry specifies the state number of the exit to be taken if
the data in the specified buffer matches all six characters specified in the six
Match Character entries.
No Match Next State

data in the specified buffer does not match all six characters specified in the
six Match Character entries.
Indirect Next State Index

Description: This entry specifies a new Indirect Next State index to be used
for the current transaction. The terminal converts this entry to a two-digit
hexadecimal number. If the buffers match, the most significant digit of the entry
specifies the new index. If the buffers do not match, the least significant digit of
the entry specifies the new index. If the digit is from 0 to 7, this number is the
new Indirect Next state index. If the digit is F, the index is not altered.
Buffer ID/Delimiter
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:
• 0 - Start sentinel, count forward

• 1 - First field separator, count forward
• 2 - End sentinel, count backward
• 3 - Last field separator, count forward
Delimiter Index
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
EXAMPLE
An example of a Track Buffer Compare state is shown in Table 4-74. This

example state directs the terminal to do the following:
• 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 Indirect Next State index is 098
• Track 3 is used to examine for matching 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.
Table 4-74 Example Track Buffer Compare State
Entry Value
State Number 100
State Type @M b/
Indirect Next State Index 098
Buffer ID/Delimiter 016
Delimiter Index 010
Match Character (first) 049
Match Character (second) 048
Match Character (third) 056
Match Character (fourth) 052
Match Character (fifth) 053
Match Character (sixth) 051
4-162
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.24 Buffer Shift State (@N b/)
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.
Table 4-75 Buffer Shift State Format
Entry Valid Range
State Type @N b/
Fault Operation Next State Valid state numbers
Buffer ID 064 - 090, 256 - 355
Operation 001 - 004
Number of Positions to Shift Valid range based on buffer length
Pad Character 000 - 255
The Buffer Shift state entries are defined as follows:
State Number
State Type
Valid Data Range: @N b/
Description: This State Type identifies this state table as a Shift Buffer state.

which the terminal goes when the buffer shift is successful.
Fault Operation Next State

Description: The Fault Operation Next State entry identifies the exit state to
which the terminal goes when the buffer shift is unsuccessful. Reasons for
failure include illegal operation, illegal or empty buffer, or number of positions
to shift greater than buffer length.
4-163
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Buffer ID
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
should be set to 065.
Operation
during the state. The valid values for the Shift Buffer state are as follows:
• 001 - Shift data to the right.

• 002 - Rotate data to the right.
• 003 - Shift data to the left.
• 004 - Rotate data to the left.
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.
The overall buffer length of the buffer is not altered.
Number of Positions to Shift

Valid Data Range: No greater than buffer length
Description: The Number of Positions to Shift entry tells the terminal how far
the data in the buffer should be shifted.
Pad Character
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.25 Buffer Arithmetic State (@O b/)
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.
The structure of the Buffer Arithmetic state is shown in Table 4-76.
Table 4-76 Buffer Arithmetic State Format
Definition Valid Range
State Type @O b/
Positive Result Next State Valid state numbers
Negative Result Next State Valid state numbers
Buffer 1 ID 064 - 090, 256 - 355
Buffer 2 ID 064 - 090, 256 - 355
Result Buffer ID 064 - 090, 256 - 355
Operation to Perform 000 - 001
The Buffer Arithmetic state entries are defined as follows:
State Number
State Type
Valid Data Range: @O b/
Description: This State Type identifies this state table as a Buffer Arithmetic
state.
Positive Result Next State

Description: The state to go to for the addition operation. This exit is also taken
for the subtraction operation if the value contained in Buffer 1 is as large or larger
than the value contained in Buffer 2.
4-165
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Negative Result Next State

Description: This is the state to go to for the subtraction operation. This exit is
only taken if the value contained in Buffer 2 is larger than the value contained in
Buffer 1.
Buffer 1 ID
Description: This is the ID of the buffer that contains the value to be added to
or subtracted from.
Buffer 2 ID
Description: This entry contains the buffer ID of the buffer that contains the
value to be added or subtracted.
Result Buffer ID
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
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
If two 8-digit ASCII buffers are added, the result might

need to be expanded to a 9-digit ASCII buffer. The result
buffer size is always at least as large as the larger of the
two buffers to be added.
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.26 Copy Buffer Data State (@P b/)
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.
Table 4-77 Copy Buffer Data State Format
Entry Valid Range
State Type @P b/
Fault Operation Next State Valid state numbers
Source Buffer ID 064 - 090, 256 - 355
Source Direction 000, 001
Source Offset 000 - 255
Destination Buffer ID 064 - 090, 256 - 355
Destination Direction 000, 001
Destination Offset 000 - 255
Number of Bytes to Copy 000 - 255
Truncation Allowed 000, 001
Pad Enable 000 - 003
Leading Pad Character 000 - 255
Trailing Pad Character 000 - 255
The Copy Buffer Data state entries are defined as follows:
State Number
4-167
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Data Range: @P b/
Description: This State Type identifies this state table as a Copy Buffer Data
state.

which the terminal goes when the copy operation is successful.
Fault Operation Next State

Description: The Fault Operation Next State entry identifies the exit state to
which the terminal goes when the copy operation is unsuccessful. Reasons
for failure include illegal or empty buffer, attempting to copy more data than
available, and not enough space to copy data to if Truncation Allowed entry
indicates no truncation is permitted.
Source Buffer ID
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.
Source Buffer Direction

Description: The Source Buffer Direction entry tells the terminal how the data is
to be copied from the source buffer. The valid values are as follows:
• 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.
Source Buffer Offset

Description: The Source Buffer Offset entry indicates the position in the source
buffer from which data should start to be copied. The actual position in the
buffer is dependent on the source buffer direction entry. If left to right, then
offset of 0 is the first character in the buffer, while using right to left, the offset of
0 is the last character in the buffer.
NOTE
If the Source Buffer Offset is greater than the length of the

buffer, the Fault Operation Next State is taken and there is no
change to the destination buffer.
4-168
TP-821029 (Ed. A)
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.
Destination Buffer Direction

Description: The Source Buffer Direction entry tells the terminal how the data is
copied to the destination buffer. The valid values are as follows:
• 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.
Destination Buffer Offset

Description: The Destination Buffer Offset entry indicates the position in the
destination buffer where the data should start to be copied to. The actual position
in the buffer is dependent on the destination buffer direction entry. If left to right,
then offset of 0 is the first character in the buffer, while using right to left, the
offset of 0 is the last character in the buffer.
NOTE
If the Destination Buffer Offset is greater than the length of

the buffer, the Fault Operation Next State is taken and there
is no change to the destination buffer.
Number of Bytes to Copy

Description: The Number of Bytes to Copy entry tells the terminal the number
of bytes of data to be copied from the source buffer to the destination buffer. An
entry of 000 indicates to copy all source buffer data from source buffer offset to
end (or beginning base on source direction).
Truncation Allowed
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
4-169
TP-821029 (Ed. A)
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
• 000 - Do not fill with pad characters.
• 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.
Leading Pad Character

Description: The Leading Pad Character entry contains the value to be placed
into the buffer positions prior to that of the data being copied into the destination
buffer. The value entered must be the decimal equivalent of the ASCII Hex
value. For example, 0 would be entered as 048.
Trailing Pad Character

Description: The Trailing Pad Character entry contains the value to be placed
into the buffer positions after the characters that are being copied into the
destination buffer. The value entered must be the decimal equivalent of the
ASCII Hex value. For example, 0 would be entered as 048.
4-170
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.27 Buffer Overlay State (@Q b/)
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
To use the Buffer Overlay state, the network must either

use buffers that already exist or must define two buffers
before using the state. The network defines buffers with
Write Command messages or Function Command messages
(Section 5.5 and Section 5.6).
Table 4-78 Buffer Overlay State Format
Entry Valid Range
State Type @Q b/
Base Buffer ID 064 - 090, 256 - 355
Overlay Buffer ID 064 - 090, 256 - 355
Most Significant Byte From Start 001 - 255
The following paragraphs describe each entry in the Buffer Overlay state.
State Number
4-171
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State Type
Valid Range: @Q b/

which the terminal goes when the buffer overlay is complete.
Base Buffer ID
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
is set to 065.
Overlay Buffer ID
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.
Most Significant Byte From Start

Description: The Most Significant Byte From Start entry identifies the position
in the buffer at which to begin setting values. The most significant byte is
counted from the first 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
g1959030
Figure 4-6 Example Most Significant Byte from Start Entry
EXAMPLE
An example of a Buffer Overlay state is shown in Table 4-79. This example state

• Exit to state number 001 after overlaying the specified base buffer bytes
• Define the Base Buffer as Buffer A
• Define the Overlay Buffer as Buffer B
• Start the overlay at the first byte of the Base Buffer
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.
Table 4-79 Example Buffer Overlay State
Entry Valid Range
State Number 120
State Type @Q b/
Base Buffer ID 065
Overlay Buffer ID 066
Most Significant Byte From Start 001
4-173
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
g1959031
4-174
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.28 Time Delay State (@S b/)
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.
Table 4-80 Time Delay State Format
Entry Valid Range
State Type @S b/
Operation 001 - 002
Time Delay Timeout 001 - 255, 900 - 931
The following paragraphs describe each entry in the Time Delay state.
State Number
State Type
Valid Range: @S b/

which the terminal goes once the operation specified is started.
4-175
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Operation
during the state. The valid values for the Time Delay State entry are as follows:
• 001 - Start timing
• 002 - Stop timing. Remain in this state until the elapsed time is greater than
or equal to the Time Delay Timeout value.
Time Delay Timeout

Description: The Time Delay Timeout entry defines the amount of time to delay
state sequencing. This optional value is only included if the Operation value
with the state is 2. The valid values are as follows:

Examples of Time Delay states are shown in Table 4-81 and Table 4-82.
EXAMPLE 1
The example in Table 4-81 directs the terminal to do the following:

• Start timing and exit to state 150
Table 4-81 Example Time Delay State (start timing)
Entry Value
State Number 100
State Type @S b/
Operation 001
EXAMPLE 2
The example state in Table 4-82 directs the terminal to do the following:

• Stop timing after the Time Delay Timeout value of 60 ticks has expired
• Exit to state 160 after the Time Delay Timeout value has expired
4-176
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
Table 4-82 Example Time Delay State (stop timing)
Entry Value
State Number 110
State Type @S b/
Operation 002
Time Delay Timeout 060
4-177
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.29 Multi-tasking State (@Xb/)
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.
Table 4-83 Multi-tasking State Format
ENTRY VALID RANGE
State Type @X b/
Screen Number Valid screen numbers (Section 4.6)
State #1 Valid state numbers
State #2 Valid state numbers
The following paragraphs describe each field in the Multi-tasking State.
State Number
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/
Screen Number

• 001-899, 900-950, 999 - Screen Number
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
State #1
Description: The state number of an Information Entry State (@D) or Card
Read State (CR) that is to be executed.
State #2
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 type - @Xb/

- Screen Number - 000
- State #1 - 461
- State #2 - 462
• State #461
- State type - @Db/

- Screen #1 - 000-511
- Screen #2 - 000
- Do You Want More Time? - 000
- Timeout #1 - 999
- Timeout #2 - 999
- Timeout #1 Next State - 000
- Timeout #2 Next State - 000
- Format Template Number - 000
- Number of Keys - 001
- Numeric Key Buffer ID - 064 - 090
- Format Template Full - 000
- Operation Key Buffer ID - 000
- Operation Key Buffer Byte - 000
- Operation Key A Next State - Valid state numbers (Section 4.3.1)
- Operation Key B Next State - Valid state numbers (Section 4.3.1)
- Operation Key C Next State - Valid state numbers (Section 4.3.1)
- Operation Key D Next State - Valid state numbers (Section 4.3.1)
• 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
TP-821029 (Ed. A)
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)
• State #464
- State Type CR b/
- Unit Number - 001
- Operation - 001
- Screen Number - Valid screen numbers (Section 4.6)
- Consumer Response Time - 915
- Consumer Fault Next State - 465
- Hardware Fault Next State - 464
- Read Conditions - 011
• State #465
- State Type - @Z b/
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.30 Set Language Bank State (@Y b/)
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
Refer to Table 4-84 for the Set Language Bank state table format.
Table 4-84 Set Language Bank State Format
Entry Valid Range
State Type @Y b/
Language Bank Number 000 - 255
The Set Language Bank state entries are defined as follows:
State Number
State Type
Valid Range: @Y b/
Next State
processes after establishing the Language Bank number.

Description: The Language Bank number entry specifies the language bank
to use for screens.
4-181
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced States
4.5.31 Close State (@Z b/)
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.
Table 4-85 Close State Format
Entry Valid Range
State Type @Z b/
The following paragraphs describe each entry in the Close state.
State Number
State Type
Valid Range: @Z b/

which the terminal goes once all device tasks are closed.
4-182
TP-821029 (Ed. A)
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:

• Close all device tasks
• Go to state number 000
Table 4-86 Example Close State
Entry Valid Range
State Number 114
State Type @Z b/
4-183
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 2 Message (screens)
4.6 Write Command 2 Message (screens)
Consumer display screen data is a type of configuration data.
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.
The Write Command 2 message is used to write consumer display screen

configuration data into terminal memory. The maximum message length is
1920 characters. Table 4-87 shows message format. The fields common to all
Write Command messages are shaded. Only the fields specific to the Write
Command 2 message are described here.
Table 4-87 Write Command 2 Message
Modifier (Screens) 1 1
Field Separator (FS) hex 1C 1 [1]
Screen Number - - - 3 [1]
[ Language Bank Number ] [-- -] [ Variable ] [1]
[ Voice prompting commands ] [-- -] [ Variable ] [1]
[ Voice keypad feedback commands ] [-- -] [ Variable ] [1]
[ Touch Template Data ] [-- -] [ Variable ] [1][2]
[ Screen Data ] [-- -] [ Variable ] [1]

[1] This group of fields (FS / Screen Number / Language Bank Number / Voice
Commands / Touch Template Data / Screen Data) can be repeated, as necessary, to
a maximum of 1920 bytes per Write Command 2 message.
[2] This field is not applicable for the CashSource Plus 400 terminal.
4-184
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
message.
Screen Number
Description: This is a three-character field that identifies the screen number for
the screen data that follows.

Description: This is a control sequence used to designate the correct language
bank to use when the multi-lingual feature is installed. The structure of this
control sequence is ESC L xxx, where xxx is the language bank number. If this
field is not included, the default language bank is used. For more details on the
Voice Prompting Commands

Description: This is a special control sequence used to load voice prompting
commands associated with a particular screen. The structure of this control
sequence is ESC ; t mmm ddd xxx for voice prompting using control files, or
ESC ; t "message" ddd xxx for voice prompting using individual voice messages.
The parameters used with the ESC ; control sequence are defined as follows:
• t - This parameter controls the termination of any voice messages in

progress. The valid settings are as follows:
- 0 - Add the message to the message queue, do not terminate the message
currently in progress.
- 1 - Terminate the message in progress, proceed with the new message
- 2 - Terminate the message in progress, purge the message queue
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• "message" - The parameter "message" is used only with voice prompting

commands using individual voice messages. The message field is a
.WAV file name (Section 4.17.1.1) or a .TXT file name or a text string
(Section 4.17.3).
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:
- b - Buffer containing the data to be formatted. Valid range is @, and

A through Z.
- ff - Format template number.
An example of both Voice Prompting screen control sequences is as follows:
ESC ; 1 "ESC ZK A 09" 000 000
NOTE
The ESC ZK control sequence requires .WAV files to

function. To perform the same function with .TXT files,
use the TCSBuffer tag (Section 4.17.3).
• 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.
• xxx - This is a reserved field that must be set to 000.
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.
Voice Keypad Feedback Commands

Description: This control sequence defines a Keypad Feedback Template within
screen data. This template maps a keypress to a corresponding .WAV file or
.TXT file or to a text string (Section 4.17.3). The Keypad Feedback Template
must be defined within the base screen (the screen number referenced in the state
or function), the template cannot be defined within overlay screens. The Keypad
Feedback Template is saved according to both screen number and language bank.
The format of this control sequence is ESC ZH k cccc xxx "message".
4-186
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The parameters of this control sequence are defined as follows:
• 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.
The contents of the FEEDBACK.DAT file are as follows:
- 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"
The contents of the FEEDBACK.TTS file are as follows:
- 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• xxx - This is a reserved field that must be set to 000.
• "message" - The message field is a .WAV file name (Section 4.17.1.1) or

a .TXT file name or a text string (Section 4.17.3). The quotes must be
included in this field. When the value of cccc is 0023 or 0021 to default the
numeric keys, this field is ignored, but at least the quotes need to be present.
Touch Template Data (not applicable for CashSource Plus 400)

Description: This is a control sequence used to define a template for use with
a touch screen. This template defines the areas of the screen that correspond
to a particular key. The structure of this control sequence is ESC ZD and
the seven following fields:
• Touch template number

• Key
• Xlow
• Xhigh
• Ylow
• Yhigh
• Icon number
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,
Screen Data
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
Screen Number, Language Bank Number, Touch Template

Data, Voice commands, Screen Data, and field separator
fields can be repeated as necessary to a maximum of 1920
bytes (total message length).
4-188
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.6.1 General Screen Information
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.
The possible values for Option 1 are as follows:
Value Columns Rows Side
001 40 20 Not applicable
002 32 16 Right (default)
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
Figure 4-7 40-by-20 Display Grid
4-189
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959073
Figure 4-8 32-by-16 Display Grid Positioning
4-190
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Displayable Characters
The terminal has the following sets of displayable characters stored in files:
• Standard characters
• Alternate characters
• Mosaic characters
• Predefined icons
If the terminal is configured for Enhanced Monochrome Graphics (EMG), Color

Graphics Feature (CGF), or VGA Plus, the terminal uses additional character
sets, control sequences, and icons that differ from those discussed here. Refer to
the Enhanced Monochrome Graphics Programming Manual (TP-799300-000A)
for EMG information. Refer to the Color Graphics Feature Programming
Manual (TP-799344-000A) for CGF information. Refer to Appendix D for
VGA Plus information.
4.6.2 Standard, Alternate, and Mosaic Characters
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.
Table 4-88 Standard Character Set
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-88 Standard Character Set (continued)
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
4-192
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-89 Alternate Character Set
g1959074
4-193
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-90 Mosaic Display Characters
g1959075
4-194
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-90 Mosaic Display Characters (continued)
g1959076
4-195
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-90 Mosaic Display Characters (continued)
g1959077
4-196
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Screen Control Sequences
4.7 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.
Table 4-91 Screen Control Sequences
Control Description
Sequence
BS Moves the cursor back one position
CR Moves the cursor to the first position in the current row
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
LF Moves the cursor to the current column in the next row
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 A Displays an animation sequence using icons.
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 C Establishes colors for displaying text and prepackaged icons.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-91 Screen Control Sequences (continued)
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 I Inserts a specified screen into the current screen.
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 L Set Language Bank.
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 P Displays a specified icon.
ESC Q Display the check icon at the current cursor position.
ESC R Repeats a specified cell a specified number of times.
ESC T Specifies a background color or pattern in the area around the addressable area.
ESC U Creates a specified background color or pattern in a specified rectangle.
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 W Blinks the display within a specified rectangle.
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 Y Allows you to select a special effect time in milliseconds.
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 ZF Display animated graphics files (FLC/FLI)
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.
ESC < Provides a fade-out transition between screens.
ESC = Changes the row size to the size specified.
4-198
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-91 Screen Control Sequences (continued)
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.
Table 4-92 Screen Control Sequence Cross-reference

Sequence Equivalent Equivalent
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-92 Screen Control Sequence Cross-reference (continued)

Sequence Equivalent Equivalent
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
4.7.1 BS Control Character
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.
4.7.2 CR Control Character
The CR control character moves the cursor to column @ in the current row.
4.7.3 FF Control Character
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.
4.7.4 HT Control Character
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
4.7.5 LF Control Character
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.
4.7.6 SI Control Sequence
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 terminal places the cursor at row I, column 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
Graphic Characters ASCII Hex Code Definition
FS 1C Field separator that acts as a screen delimiter for this screen
018 30 31 38 Screen number (screen 018)
FF 0C Screen control character that clears screen and positions cursor to

the upper left hand corner
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
HT 09 Shows the name encoded on track 1 (MR. BOB JONES in this

example), starting at the current cursor position (row A and column
@)
SI F @ 0F 46 40 Sets the cursor to row F, column @
PLEASE b/ ENTER b/ YOUR 50 4C 45 41 53 45 20 45 4E Shows the graphic characters on row F

54 45 52 20 59 4F 55 52
SI H @ 0F 48 40 Sets the cursor to row H, column @
PERSONAL b/ ID 50 45 52 53 4F 4E 41 4C 20 Shows the graphic characters on row H

49 44
SI C B 0F 43 42 Sets the cursor to row C, column B. This is where the cursor is

positioned at the beginning of the X display area
4-201
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959078
Figure 4-9 Example Screen 018 - Use of the HT Control Character
Table 4-94 Example Screen 016 Data - Use of the FF and SI Control Sequences
FS 1C Field separator that acts as a screen delimiter for this screen
FF 0C Screen control character that clears screen and positions

cursor to the upper left hand corner
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
SI I I 0F 49 49 Sets the cursor to row I, column I
FROM b/ CHECKING b/ 46 52 4F 4D 20 43 48 45 43 4B 49 4E 47 Shows the graphic characters on row I

ACCOUNT .......... 20 41 43 43 4F 55 4E 54 2E 2E 2E 2E
2E 2E 2E 2E 2E 2E
SI L I 0F 4C 49 Sets the cursor to row L column I
FROM b/ SAVINGS b/ 46 52 4F 4D 20 53 41 56 49 4E 47 53 20 Shows the graphic characters on row L

ACCOUNT ........... 41 43 43 4F 55 4E 54 2E 2E 2E 2E 2E
2E 2E 2E 2E 2E 2E
SI O I 0F 4F 49 Sets the cursor to row O column I
PAYMENT b/ ENCLOSED b/ 50 41 59 4D 45 4E 54 20 45 E4 43 4C Shows the graphic characters on row O

IN b/ ENVELOPE ... 4F 53 45 44 20 49 4E 20 45 4E 56 45 4C
4F 50 45 2E 2E 2E
4-202
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959079
Figure 4-10 Example Screen 016 - Use of the FF and SI Control Sequences
4.7.7 SO Control Sequence
The SO control sequence inserts a specified screen into the current screen. The
SO nnn
SO operates the same as the ESC I control sequence.
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:
• Screen #1: 600 characters

• Screens #s 2 through 6: 310 characters each
The total number of characters for all six screens can be no more than 1,800
characters.
4-203
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
FS 1C Field separator that acts as a screen delimiter for this

screen
SO 016 0E 30 31 36 Picks up the screen data specified for screen 016
SI A E 0F 41 45 Sets the cursor to the start of the data area to be

overlayed (row A, column E)
MORTGAGE b/ LOAN b/ 4D 4F 52 54 47 41 47 45 20 4C 4F Data to replace CREDIT CARD PAYMENT on screen 016

PAYMENT 41 4E 20 50 41 59 4D 45 4E 54
g1959080
Figure 4-11 Example Screen 017 - Use of the SO Control Sequence
4-204
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959081
Figure 4-12 Example Screen Using Animation
4-205
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.8 US Control Character
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.
4.7.9 VT Control Sequence
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
4.7.10 ESC A - Animation
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.
The format of the control sequence is as follows:
ESC A nnn s ttt
The terminal displays an animation sequence using sequentially numbered icons,

numbered from nnn to (nnn + s). The terminal places the upper left corner of
each icon at the current cursor position. The parameter ttt determines how
fast the animation moves. The animation sequence repeats until the terminal
processes an FF or ESC M control sequence.
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).
Table 4-96 Icon Animation Sets
Numbers Animation Value of S
001 - 003 Insert card (large) 2
004 - 008 Insert card (small) 4
009 - 011 Swipe card (large) 2
012 - 016 Swipe card (small) 4
018 - 020 Enter PIN 2
023 - 026 Select transaction (right key) 3
027 - 030 Select transaction (left key) 3
049 - 052 Insert envelope 3
056 - 060 Take cash 4
062 - 064 Take card (large) 2
4-206
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-96 Icon Animation Sets (continued)
Numbers Animation Value of S
066 - 070 Take card (small) 4
071 - 073 Take receipt 2
The valid values for s are 1 to 9.
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.
ESC A does not change the cursor position.
EXAMPLE FOR ESC A
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g40970A18
Figure 4-13 Animation (ESC A Example)
4-208
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.11 ESC B - Display Buffer Content
The ESC B control sequence displays contents of a buffer. The format of

the control sequence is as follows:
ESC B a or ESC B aaa
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.
4.7.12 ESC C - Select Color
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 affect the color of custom icons.
ESC C does not change the color of text and icons already displayed.
4.7.13 ESC D - Animation Delay
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.
EXAMPLE FOR ESC D
In this example, the terminal displays the Take Card animation sequence that
moves in the direction of the receipt slot (Figure 4-14).
Screen 100 contains the following screen data.
FF
4-209
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g40970b18
Figure 4-14 Animation (ESC D Example)
4-211
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.14 ESC F - Select Font
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:
ESC F "fontname" ppp
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.
4.7.15 ESC G - Select Character Set and Display Mode
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:
• 0 - basic (standard and alternate character sets)

• 1 - helvetica character set
• 2 through 7 - icon 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
When reverse video is programmed, it is possible to inadvertently cause the

entire lower portion of the screen to appear temporarily in reverse video during a
screen refresh. To prevent this, first place the control sequence that inserts the
normal mode attribute in a position that is at the end of the text. Then, program
the text for reverse display mode. Refer to Figure 4-15 for an example.
g1959082
Figure 4-15 Example Screen Using the Inverse Video Feature (ESC G)
4.7.16 ESC H - Select Foreground Color
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
EXAMPLE FOR ESC H
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.
4.7.17 ESC I - Insert Screen
The ESC I control sequence inserts a specified screen into the current screen.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
Fast animation (less than 3.2 seconds between changes) might

interfere with other terminal tasks and might slow down
overall terminal operation.
Usually fast-animation slowdown is only significant during a consumer

transaction. It is normally not a problem with a Welcome screen. If an animation
sequence slows down terminal operation, modify one of the ESC D control
sequences in the loop. A value of 004 or greater for the ttt parameter allows the
terminal time to process other tasks.
EXAMPLE FOR ESC I
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g40970a13
Figure 4-16 Template (ESC I Example)
4-216
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.18 ESC J - Use Color Wheel
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:
ESC J nnn rrr sss [sss... sss] ESC
NOTE
The terminal ignores this control sequence when Consumer

Display configuration setting is not set for VGA color.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
sss Description
000 Cycle up and down from Black to Peach
001 Cycle up and down from Black to Blue
002 Cycle up and down from Black to Green
003 Cycle up and down from Black to Cyan
004 Cycle up and down from Black to Red
005 Cycle up and down from Black to Magenta
006 Cycle up and down from Black to Yellow
007 Cycle up and down from Black to White
008 Cycle up and down from Black to Gray
009 Cycle up and down from Black to Orange
010 Cycle up and down from Black to Rust
011 Cycle up and down from Black to Silver
012 Cycle up and down from Black to Gold
013 Cycle up and down from Black to Pink
014 Cycle up and down from Black to Brown
015 Cycle up and down from Black to Purple
016 Cycles through a spectrum of colors
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.
ESC J is terminated by an FF, ESC M, or ESC O control sequence.
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).
EXAMPLE FOR ESC J
This example demonstrates how ESC J cycles the text and icons, displayed with
color 014 on screen 311, through a range of colors.
ESC M 00 Specify resolution mode 00 (640 x 480 x 16)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.19 ESC K - Initiate Scrolling
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:
ESC K d nnn r1 r2 ttt
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
The valid values for d (the direction of scrolling) are as follows:
U (up) D (down) L (left) R (right)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
ESC K does not change the cursor position.
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
The CR control sequence is used as a line terminator for text scrolled up or

down. If you specify leftward or rightward scrolling, the terminal ignores
the CR control sequence.
If screen nnn contains an ESC C control sequence, the color specified by that
ESC C affects only the text in screen nnn.
There is no restriction on how many times ESC F or ESC G is used in a screen

being scrolled. The terminal uses the specified character set but ignores the
display mode parameter (although both parameters must be present). However,
your character set selections should take into account the row size, as discussed
in the description of the ESC = control sequence. Also, the following rules
should be observed.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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).
EXAMPLE 1 FOR ESC K
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g40970a19
Figure 4-17 Scrolling Upward (ESC K Example)
4-223
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
EXAMPLE 2 FOR ESC K
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.
Screen 200 contains a promotional message as follows:
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g40970b19
Figure 4-18 Scrolling Leftward (ESC K Example)
4-225
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.20 ESC L - Select Language Bank
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.
4.7.21 ESC M - Change Resolution
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
Resolution mode numbers range from 00 through 04.
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.
Resolution Mode Horizontal Vertical Number of Colors

Number (in pixels) (in pixels)
00 640 480 16
01[1] 320 240 256
02 320 200 256
03 640 480 256
04[1] 1024 768 256
05 800 600 256

[1] Not applicable for the CashSource Plus 400.
NOTE
You cannot display 16-color icons in the resolutions that

support 256 colors.
4-226
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
EXAMPLE FOR ESC M
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
4.7.22 ESC N - Select Palette Registers
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.
Default Palette Settings

Palette setup number 000 contains the default palette settings that the terminal
sets at powerup or when the terminal encounters an ESC M 00 (resolution 640 x
480 x 16) in a screen file. The default palette setting stays in effect until the
terminal encounters a new ESC M or ESC N in the screen data.
4-227
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
EXAMPLE FOR ESC N
This example directs the terminal to load palette registers associated with
palette setup number 123.
ESC N 123
4.7.23 ESC O - Select DAC Setup
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
DAC setup numbers range from 256 through 999.
Default DAC and All Black DAC

The reserved values for ESC O are shown in the following table.
DAC Setup Description

Number
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.
001 DAC settings set to black for all colors.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
EXAMPLE FOR ESC O
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.
Refer to Appendix D.17.3 for information on the DAC files.
4.7.24 ESC P - Display Icon
The ESC P control sequence displays a specified icon. The format of the control
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.
The display mode remains in effect until changed by another ESC P or by an

ESC F, ESC G, ESC M, or FF control sequence.
ESC P does not change the cursor position.
The valid values for d are as follows:
• 0 - Normal video
• 1 - Blinking video
• 2 - Inverse video
• 3 - Blinking inverse video
• 4 - Sprinkle image
• 50 - Wipe image
When d is equal to 4 (sprinkle), the d character specifies a special effect that

pertains to the display of icons created with DDU or in the PCX or GIF graphic
format. If the terminal is displaying a character-based icon instead of a DDU,
PCX, or GIF icon, the terminal ignores the special effect and assumes a normal
video attribute. All special effects are done within the size limits of the DDU icon.
The icon must be at least 8 pixels across by 8 pixels down for sprinkle to work.
4-229
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
NOTE
You cannot use ESC P to display 16-color icons in those

resolutions that support 256 colors.
EXAMPLE FOR ESC P
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:
ESC M 02 Set the resolution to 320 x 200 x 256
ESC O 001 Set the DAC to all black, no display
ESC P 176 0 Display icon 176
NOTE
Nothing is displayed on the screen at this point since the DAC

has all colors mapped to black.
ESC > 176 Fade icon 176 in from black using palette setup
number 176
ESC D 007 Delay about 5 seconds
ESC < Fade

the icon out to black
ESC P 177 0 Display icon 177 (the screen

is still black)
ESC > 177 Fade icon 177 in from black

using palette setup number 177
Transparent GIF Files

You can also use ESC P to display icons created from files in the transparent
GIF format.
4.7.25 ESC Q - Display Check Icon
The ESC Q control sequence displays the check icon at the current cursor
position.
4-230
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.26 ESC R - Repeat Cell
The ESC R control sequence repeats a specified cell a specified number of times.
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.
Row Size Maximum sss
10 960
11 840
4-231
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Row Size Maximum sss
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.
EXAMPLE FOR ESC R
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g40970a20
Figure 4-19 Border (ESC R Example)
4.7.27 ESC T - Tile Non-addressable Area
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
• ESC T control sequence is for use with a 32-by-16

display format only. If the terminal’s Consumer Display
configuration setting specifies a 40-by-20 format instead
of a 32-by-16 format, the terminal ignores ESC T.
• The terminal does not support ESC T when it is in one of

the resolutions that support 256 colors.
4-233
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959093
Figure 4-20 Tile Display Area Outside Addressable Area
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
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.
ESC T does not change the position of the cursor.
4-234
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.28 ESC U - Tile Rectangular Area
The ESC U control sequence creates a specified background color or pattern in a

specified rectangle. The format of the control sequence is as follows:
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
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.
ESC U does not change the position of the cursor.
EXAMPLE FOR ESC U
4-235
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The ESC U control sequence provides an efficient method of generating a

background for large areas. This example demonstrates the use of ESC U to tile
the entire addressable area with the cell ’)’ from character set @ (borders and
backgrounds), as shown in the following illustration:
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
Figure 4-21 Background (ESC U Example)
4.7.29 ESC V - Display Buffer Content
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
ESC V a tt or ESC V aaa tt
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.
4.7.30 ESC W - Select Blinking
The ESC W control sequence blinks the display within a specified rectangle.
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
The terminal does not support ESC W when it is in one of

the resolutions that support 256 colors.
4-237
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
ESC W does not change the cursor position.
4.7.31 ESC X - Position Cursor Using Global Coordinates
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:
ESC X xxxx yyyy
ESC X uses a global coordinate system independent of the screen’s resolution.

The range of xxxx is 0 through 9999, and the range of yyyy is 0 through 9999.
As shown in the following figure, 0,0 (x,y) is the lower left corner. 9999, 9999
(x,y) is the upper right corner. 5000, 5000 (x,y) is the center of the display.
4-238
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Pixel Coordinates in the 640 x 480 x 16 Resolution

When the resolution is 640 x 480 x 16, the terminal sets the cursor’s vertical
position to the scan line according to the following calculation:
(y * vres) / 10000
Where: vres = screen vertical resolution.
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:
Truncate (((x * hres) / 10000) / 8)
where: hres = screen horizontal resolution.
The horizontal position is scaled to a byte boundary because 16-color display

algorithms are better suited to byte output on even 8-pixel boundaries. This
provides 80 horizontal positions for the cursor.
Pixel Coordinates in Resolutions Which Permit 256 Colors

When the screen is in one of the resolutions which permit 256 colors, the
terminal sets the cursor’s vertical position the same way it does in the 16-
color mode. The terminal sets the cursor’s horizontal position according to
the following calculation:
(x * hres) / 10000
Where: hres = screen horizontal resolution.
4-239
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
EXAMPLE FOR ESC X
This example demonstrates how ESC X displays shadow text.
021 Screen number
ESC M 03 Select
640 x 480 x 256 resolution
ESC O 001 Select

DAC setup number 001 (black)
ESC P 239 Display

icon 239 in the normal display mode
ESC 0 239 DAC

setup number 239
ESC X 2000 7999 Position the cursor in the

upper-left quadrant of the screen (2000 on
the x axis, 7999 on the y axis)
ESC H 000 Select foreground color 000
ESC F 1 Select font 1 and normal display mode
SHADOW TEXT Display the text at the cursor position
ESC X 2150 7800 Reposition the cursor about 150 pixel

positions
from its previous position.
ESC H 004 Select

foreground color 004
SHADOW TEXT Display the same text at

the offset cursor position
4-240
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.7.32 ESC Y - Select Special Effect Time
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 ESC ZD control sequence specifies the touch screen configuration

information. The format for ESC ZD is as follows:
ESC ZD nnn ff xxxx wwww yyyy zzzz
The valid values for the parameters are shown in the following table:
Value Description
nnn template number in ASCII
ff function key (refer to the following table)

xxxx the x low coordinate of the touch point
wwww the x high coordinate of the touch point
yyyy the y low coordinate of the touch point
zzzz the y high coordinate of the touch point
### the icon number to display
4-241
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The valid values for the key parameter (ff) are detailed in the following table:
Key Name Parameter Key Name Parameter
Numeral 0 00 [1] Function key B ESC B
Numeral 1 01 [1] Function key C ESC C
Numeral 2 02 [1] Function key D ESC D
Numeral 3 03 [1] Function key E ESC E
Numeral 4 04 [1] Function key F ESC F
Numeral 5 05 [1] Function key G ESC G
Numeral 6 06 [1] Function key H ESC H
Numeral 7 07 [1] Function key I ESC I
Numeral 8 08 [1] Function key J ESC J
Numeral 9 09 [1] Function key K ESC K
Decimal point ( . ) 0. [1] Function key L ESC L
Function key A ESC A Function key M ESC M

[1] Both characters must be used for this field.
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:
ESC ZE ttt ~filename 1~... ~filename n~
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,
4.7.36 ESC ZF - Display FLC/FLI Animation
The ESC ZF control sequence displays animated graphic files in the

high-resolution modes. The graphic files must be in the FLC or FLI graphic
format. VGA Plus can display files in the FLI graphic format in the 640 x 480 x
16 and 640 x 480 x 256 resolutions. In addition to these resolutions, VGA Plus
can display graphic files in the FLC format in the 1024 x 760 x 256 resolution.
ESC ZF str A 0 xxxx yyyy
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
filename.ext
The files must be available in the following directory:
\DIEBOLD\TCS\MOVIES
The parameter A can have one of the following values:
• W - A value of W indicates that VGA Plus displays the animated graphic

file once. Wait for it to complete, then continue screen processing.
• 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.
A mandatory zero (0) follows.
The parameter xxxx designates the x coordinate of the upper-left corner of

the animation in global coordinates.
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.
EXAMPLE FOR ESC ZF
This example demonstrates how ESC ZF displays animation files.
ESC M 03 Select 640 x 480 x 256 resolution
ESC ZF "FLAGSEQ.FLC" W Display file FLAGSEQ.FLC once at X

000009999 coordinate 0000 and Y coordinate 9999 (upper
left hand corner of the screen).
4-243
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:
ESC ZI xxxx yyyy nnn
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.
4.7.39 ESC ZU "MPEGPlay" - Media Player Control
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:
• MPEG audio product (optional)
• SCSI CDROM drive and controller product (optional)
• Windows NT 4.0
• Agilis 91x for ix/CSP
4-244
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The Media Player commands use a number of control sequence command

parameter variations that allow you to perform the following tasks:
• Set up an MPEG window for immediate play
• Stop the currently playing MPEG video sequence
• Change the audio volume level of the MPEG video sequence
The following paragraphs describe the control sequences that perform the
preceding tasks.
MPEG Window Set up/Play

An MPEG video playing window is set up, or set up and played, using the
following ESC ZU control sequence format:
ESC ZU "MPEGPlay" 1 m "filename" xxxx yyyy hhhh wwww n ooo p
Valid values for the preceding parameters are described in the following table:
4-245
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
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
• W = play once and delay screen processing until the MPEG(s)

has completed
• R = play repeatedly and continue screen processing
If the MPEG is to play across screen changes, the C or R designation

must be used.
EXAMPLE DISPLAYS
The following figures illustrate the results obtained by using ESC ZU

"MPEGPlay" to display MPEG video information on the consumer display. Each
example contains three screens: the first showing the MPEG playing window
alone, the second showing the VGA data screen alone, and the third showing the
combined MPEG and VGA data on the consumer display.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g41007a07
4-247
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g41007b07
4-248
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
MPEG Window Set up/Play - Filename Formats and the Environment

Variable TCSMEDIAPATH
The following points apply when specifying file names in the Media Player
command sequence:
• All MPEG file names must include the extension .MPG.
• 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.
The TCSMEDIAPATH environment variable can be used to indicate the

location(s) of MPEG files on the system. Multiple search paths (directories)
can be specified by seperating each entry with a semicolon (that is, SET
TCSMEDIAPATH=c:\video;e:\main). When the complete path is not specified in
the command sequence file name, the environment variable directory entries
is used to search for the specified file. The search process also includes the
system’s dynamic language-based subdirectory.
The system appends the dynamic language bank subdirectory (LANGxxx) to

each directory specified in the environment variable to search for MPEG files. If
the file is not in the language bank subdirectory of one environment variable
directory, the system continues the search in the language bank subdirectory
of the next environment variable directory. If the file is still not found when
all environment variable directories have been searched, the system redoes the
search in the environment variable directories, this time without appending the
dynamic language bank directory to the search paths.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
2 nd search:Environmentstring#2\langxxx\filename.mpg
3 rd search:Environmentstring#1\filename.mpg
4 th search:Environmentstring#2\filename.mpg
EXAMPLE FOR VARIATION 1
Assume that the environment variable is set as follows:
SET TCSMEDIAPATH=C:\DIEBOLD\TCS\MOVIES;E:\MOVIES
and assume that the language bank is 002.
The file name specification in the command sequence is:
ESC ZU "MPEGPlay" 1 1 "welcome.mpg"...
The search progresses as follows:
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
The second variation specifies the command sequence file name as

"subdir1\subdir2\filename.mpg" (one or more subdirectories and the file name).
The search for the file progresses as follows (assume only two environment
variables in TCSMEDIAPATH):
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.
ESC ZU "MPEGPlay" 1 1 "shortclp\short.mpg"...
4-250
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
The third variation specifies the command sequence file name as

"\subdir1\subdir2\filename.mpg" (one or more subdirectories from the root and
the file name). The search for the file progresses as follows:
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.
Assume that the TCSVolume is C: and the language bank is 002.
ESC ZU "MPEGPlay" 1 1 "\MOVIES\HELLO.MPG"...
1 st search: C:\MOVIES\HELLO.MPG
VARIATION 4
The fourth variation specifies the command sequence file name as

"volumeletter:\subdir1\subdir2\filename.mpg" (a complete path). The search
for the file progresses as follows:
1 st search: volumeletter:\subdir1\subdir2\filename.mpg
Assume that the language bank is 002.
ESC ZU "MPEGPlay" 1 1 "D:\MOVIES\LONGCLIP\LONG.MPG"...
4-251
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
The play of an MPEG video stops without the use of the

MPEG stop command sequence when: a) the MPEG file or
files play to completion, or b) a screen change occurs while
playing an MPEG by using the W play mode option of the
MPEG set up/play command.
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:
ESC ZU "MPEGPlay" 1 4 svvv
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
4.7.40 ESC ZU - Screen Marker
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
4.7.41 ESC ZV - Browser Control Sequence
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:
ESC ZV “URL spec” ssss p ttt bbb
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.
• F – Displays a fullscreen browser window, where the size ssss is assumed to

be the entire screen and the specified value is ignored.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
If displaying in “mixed-mode”, the browser window does not shift or resize

any legacy screen contents; it simply overlays the specified portion of the
legacy screen.
4.7.42 ESC : (Colon) - Display Date and Time
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
ESC : nnn
The terminal updates the time continuously.
If more than one ESC : control sequence is used, then only the last sequence that
referenced time is in effect.
Format Template Screen

The format template screen lets the terminal know where to position the time and
date on a given screen. The only control sequences that you can include in a
format template screen are as follows:
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Format Template Characters

The terminal replaces the format template characters with the appropriate
numeric values for the current date and time. The valid format template
characters are as follows:
• MM - Month
• YY - Year
NOTE
The year field is always 2 digits.
• 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...
[M] M indicates military time or 24-hour time.
[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.
[] An empty bracket indicates 12-hour time.
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).
EXAMPLES FOR ESC :
These examples show how the terminal replaces characters in the format template.
4-256
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The following example shows three ways to display the time 20:12:15.
Format Template Example Display
HH:RR:SS[M] 20:12:15
HH-RR-SS [AM!PM] 08-12-15 PM (HH-RR-SS [A!P]M also works)
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.
MM/DD/YY HH:RR:SS[ ] 01/26/00 08:12:15
MM/DD/YY HH:RR:SS[A!P] 01/26/00 08:12:15A
HH:RR:SS[M] DD/MM/YY 20:12:15 26/01/00
HH:RR:SS[A!P]M DD/MM/YY 08:12:15PM 26/01/00
HH:RR[ ] DD\MM\YY 08:12 26\01\00
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
4.7.43 ESC < (less than) - Fade-out Transition
The ESC < control sequence provides a fade-out transition between screens.
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.
ESC < in 640 x 480 x 16 Resolution

As a time saving measure, when the screen data contains an ESC < and the
resolution is 640 x 480 x 16, the terminal only fades the DAC registers
referenced by the palette registers because these are the only colors the terminal
is displaying. This is important in case ESC N is used to point to new DAC
registers. Only the 16 DAC registers that were used are black, the others are
left alone. In this case, use ESC O 001 before ESC N after an ESC <. Refer to
Appendix D for information on DAC and palette registers.
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.
EXAMPLE FOR ESC <
4-258
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Fade in.

ESC O 001 Load DAC setup number 001 (all black)
ESC P 242 0 Display icon 242 in the normal video
mode
ESC > 242 Fade the contents of icon 242 into view
ESC D 004 Delay for about 2 seconds
Fade out then display another icon.
ESC < Fade to black

ESC P 231 0 Display icon 231 in the normal video
mode
ESC > 231 Fade the contents of icon 231 into view
ESC D 004 Delay for about 2 seconds
4.7.44 ESC = (equal) - Select Row Size
The ESC = control sequence changes the row size to the size specified. The
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:
• Processes another ESC =

• Processes another ESC M
• Enters the Maintenance mode
The valid values for hh are 10 through 16 (decimal).
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
4.7.45 ESC > (greater than) - Fade-in Transition
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:
ESC > nnn
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.
ESC > in 640 x 480 x 16 Resolution

When the screen data contains an ESC > and the resolution is 640 x 480 x 16, the
terminal only fades the DAC registers referenced by the palette registers because
these are the only colors the terminal displays in the 640 x 480 x 16 resolution.
This is important in case ESC N is used to point to new DAC registers. Only
the 16 DAC registers that were used are black, the others are left alone. In this
case, use ESC O 001 before ESC N after an ESC >. Refer to Appendix D for
information on DAC and palette registers.
4.7.46 ESC ? (Question Mark) - Use Sprites
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.
Refer to Appendix D for information on how to create a Sprite Definition file.
4-260
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The ESC ? control sequence is terminated by an FF or ESC M control sequence.
NOTE
You cannot use sprites in the same screen areas as other

animation techniques such as ESC A or ESC D type animations.
4-261
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Touch Screen (not applicable on the CashSource Plus 400)
4.8 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:
• Touch template number

• Key
• Xlow
• Xhigh
• Ylow
• Yhigh
• Icon number
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:
ESC ZD 123 0A 5000 9999 5000 5500 016

ESC ZD 123 0B 5000 9999 3500 4000 017
ESC ZD 123 0C 5000 9999 2000 2500 018
ESC ZD 123 0D 5000 9999 0500 1000 019
Refer to Figure 4-22 for the areas of the screen defined by this touch template.
4-262
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g40970b16
Figure 4-22 Touch Template Example
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.
Touch Screen Notes

The following notes apply to use of the touch screen:
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
xlow xhigh ylow yhigh

A 5000 9999 4750 5750
B 5000 9999 3250 4250
C 5000 9999 1750 2750
D 5000 9999 0250 1250
E 0000 9999 8000 9999
F 0000 4999 4750 5750
G 0000 4999 3250 4250
H 0000 4999 1750 2750
I 0000 4999 0250 1250
4.9 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.
Refer to the Enhanced Graphics Product Description (i Series/MDS)

(TP-799345-000A) for details on enhanced graphic capabilities. ??? Do we
still have enhanced graphics ?????
4-264
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959016
Figure 4-23 Example Screen Combining Text and an Icon
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
SI-#-# ESC-G-5-0 VT-25 3F 20... VT-26 ESC-G-0-0
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.
Disregard the hyphens when translating the following control sequences:
Control Group Hexadecimal (ASCII)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959001
Figure 4-24 Welcome Icon
4-267
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959002
Figure 4-25 Insert Card Animation Icon 1
4-268
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959003
4-269
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959004
4-270
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959005
Figure 4-28 Enter PIN Icon
4-271
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959006
Figure 4-29 Right Hand Select Transaction Icon
4-272
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959007
Figure 4-30 Left Hand Select Transaction Icon
4-273
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959008
Figure 4-31 Please Wait Icon
4-274
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959009
Figure 4-32 Take Cash Icon
4-275
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959010
Figure 4-33 Insert Envelope Icon
4-276
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959011
Figure 4-34 Take Receipt Icon
4-277
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959012
Figure 4-35 Take Card Icon
4-278
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959013
Figure 4-36 Swipe Card Animation Icon 1
4-279
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959014
4-280
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Predefined Icons
g1959015
4-281
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Reserved Screens
4.10 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.
Table 4-97 Reserved Screens
Screen Function
Number
000 More Time screen (default)
001 Off Line screen (default)
002 Out of Service screen (default)
003 Not used
004 Currency Characters screen
005 Thousands Separator Character(s) screen
006 Decimal Character screen
007 Not used
008 Rear Balance menu text
009 Rear Balance function definitions
900 OAR screen
901 Multi-lingual screen
902 Rear Balance Function Failure screen
903 Continuous Availability Continue screen
904 Continuous Availability Take Card screen
905 Voice Guidance Enable screen
906 Continuous Availability Depository Not Available screen
907 Continuous Availability Bill Dispenser Not Available screen
908 Continuous Availability Coin Dispenser Not Available screen
909 Continuous Availability Statement Printer Not Available screen
910 Envelope Dispense screen
911 Envelope Dispense Failure (Continue/Cancel) screen
912 Reserved for future use
913 Envelope Dispense Failure screen
914 Continuous Availability Envelope Dispenser Not Available screen
915 Dip Card Reader Prompt for Removal screen
916 Continuous Availability After Hour Depository Not Available screen
917 - 950 Reserved for future use
999 More Time screen (internal)
4-282
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Reserved Screens
Screen 000 (More Time screen)

Screen 000 prompts a consumer who fails to respond within a specified interval.
Screen 000 must be defined and must conform to the following function key A
and B requirements:
• 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.
Screen 001 (Off Line screen)

Screen 001 is displayed when the terminal is in the Off-line mode. The screen’s
text defaults to OFF LINE at terminal powerup or reset.
Screen 002 (Out of Service screen)

Screen 002 is displayed when the terminal is in the Out-of-service mode. The
screen’s text defaults to OUT OF SERVICE at terminal powerup or reset.
NOTE
The network can temporarily change the More Time screen

from screen 000 to another screen number by means of the
enhanced Function Command message (Section 5.6). At
terminal powerup or reset, the terminal reverts to using screen
000 as the More Time screen. Similarly, the network can
temporarily change the Off Line screen and the Out of Service
screen to other screen numbers.
Screen 003
Agilis 91x for ix/CSP does not use this screen. This screen is reserved for
compatibility with TCS.
Screens 004, 005, and 006 (Currency Characters, Thousands

Separator Character, and Decimal Character screens)
Screens 004 through 006 are displayed when the terminal is in the Dollar Entry
state.
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
TP-821029 (Ed. A)
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)
These screens revert to their default content at powerup or reset.
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
As shown in the following example, a full 12-digit transaction amount field

requires 19 character positions. This example assumes that the network
downloads reserved screen 005. Otherwise, 16 character positions are required.
4-284
TP-821029 (Ed. A)
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.
Screen 008 (Rear Balance menu text) (not applicable on the

CashSource Plus 400)
Screen 008 is used by the Rear Balance feature. This screen provides the text for
the selectable entries on the Rear Balance menu. For more details on the use
of screen 008, refer to Section 4.16.
Screen 009 (Rear Balance function definitions) (not applicable

on the CashSource Plus 400)
Screen 009 is used by the Rear Balance feature. This screen provides the data
that defines the rear balance functions. For more details on the use of screen
009, refer to Section 4.16.
Screen 900 (OAR screen) (not applicable on the CashSource Plus

400)
Screen 900 is applicable to touch screen terminals only. This screen is used
by the Open Account Relationship (OAR) feature. Screen 900 provides the
cross-reference between the screen number, the language bank, and the touch
screen template. For more details on the use of reserved screen 900, refer to
Section 4.15.
4-285
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Reserved Screens
Screen 901 (Multi-lingual screen)

Screen 901 is used by the Multi-lingual feature. This screen provides a language
selection method. Refer to Section 4.15 for details on the Multi-lingual feature.
Screen 902 (not applicable on the CashSource Plus 400)

Screen 902 is used by the Rear Balancing feature. Refer to Section 4.16 for
details on the Rear Balancing feature and reserved screen 902.
Screen 903 (Continuous Availability Continue screen) (not applicable

Screen 903 is used by the Continuous Availability feature (Section 2.3.5).
This screen appears if a consumer uses the ATM while receipt printer is being
serviced (or while the statement printer is being serviced, if the statement
printer is emulating a receipt printer). The screen asks consumers if they want
to continue with their transaction even though a receipt is not available. Refer
to the Agilis 91x for ix Maintenance Manual (TP-820589-001E) for details
on Continuous Availability.
Screen 904 (Continuous Availability Take Card screen) (not

applicable on the CashSource Plus 400)
Screen 904 is used by the Continuous Availability feature (Section 2.3.5). If
the consumer elects not to continue a transaction as prompted by reserved
screen 903, screen 904 is displayed, directing the consumer to take their card.
Refer to the Agilis 91x for ix Maintenance Manual (TP-820589-001E) for
details on Continuous Availability.
Screen 905 (Voice Guidance Enable screen)

Screen 905 is used by the Voice feature. This screen is displayed to allow the
consumer to select voice guidance or no voice guidance. Refer to Section 4.17
for more details on the Voice feature.
Screen 906 (Continuous Availability Depository Not Available

screen) (not applicable on the CashSource Plus 400)
Screen 906 is used by the Continuous Availability feature (Section 2.3.5).
This screen appears if the consumer selects a deposit while the depository is
being serviced. The consumer is given the option to wait for the transaction
to continue (when servicing is completed) or to cancel the transaction. Refer
Screen 907 (Continuous Availability Bill Dispenser Not Available

Screen 907 is used by the Continuous Availability feature (Section 2.3.5). This
screen appears if the consumer selects a bill dispense while the bill dispenser is
being serviced. The consumer is given the option to wait for the transaction
to continue (when servicing is completed) or to cancel the transaction. Refer
Screen 908 (Continuous Availability Coin Dispenser Not Available

screen appears if the consumer selects a coin dispense while the coin dispenser is
being serviced. The consumer is given the option to wait for the transaction to
continue (when servicing is completed) or to cancel the transaction. Refer to the
Agilis 91x for ix Maintenance Manual (TP-820589-001E) , as applicable, for
4-286
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Reserved Screens
Screen 909 (Continuous Availability Statement Printer Not Available

screen appears if the consumer selects a statement while the statement printer is
being serviced. The consumer is given the option to wait for the transaction to
continue (when servicing is completed) or to cancel the transaction. Refer to the
Agilis 91x for ix Maintenance Manual (TP-820589-001E)
Screen 910 (Envelope Dispense screen) (not applicable on the

CashSource Plus 400)
Screen 910 is displayed before envelope dispensing for either automatic
dispensing or C state processing. The consumer is given the option to receive an
envelope or proceed directly to the next operation.
Screen 911 (Envelope Dispense Failure [Continue/Cancel] screen)

(not applicable on the CashSource Plus 400)
Screen 911 is used for automatic envelope dispensing and C state processing.
This screen appears if the envelope dispenser is unavailable due to a device
problem. The consumer is given the option to continue or cancel the transaction.
Screen 912
This screen is reserved for future use.
Screen 913 (Envelope Dispense Failure screen) (not applicable

Screen 913 is used by the C state. This screen appears if the envelope dispenser
is unavailable due to a device problem. Consumers are informed that envelopes
are unavailable, and are instructed to cancel the deposit operation after it starts if
they do not want to continue. This screen is displayed for a fixed time period of
three seconds.
Screen 914 (Continuous Availability Envelope Dispenser Not

Available screen) (not applicable on the CashSource Plus 400)
screen appears if the consumer selects an envelope dispense while the envelope
dispenser is being serviced. The consumer is given the option to wait for the
transaction to continue (when servicing is completed) or to cancel the transaction.
Screen 915 (Dip Card Reader Prompt for Removal screen)

Screen 915 is used by the dip card reader. This screen prompts consumers to
remove their card. The default wording for this screen is as follows:
PLEASE REMOVE YOUR CARD TO CONTINUE
This screen appears if the consumer does not remove the card within a specified
amount of time (determined by timer 18).
4-287
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Reserved Screens
Screen 916 Continuous Availability After Hour Depository Not

Available screen
screen appears if the consumer selects a bag deposit while the After Hour
depository is being serviced. The consumer is given the option to wait for the
transaction to continue (when servicing is completed) or to cancel the transaction.
Refer to the Maintenance Manual for ix (TP-820589-001E), as applicable, for
Screen 921 (not applicable on the CashSource Plus 400)

Screen 921 is used by the Continuous Availability Service (CAS) feature. This
screen displays if the consumer selects a currency acceptor cash deposit while the
currency acceptor is being serviced. The consumer is given the option to wait for
the transaction to continue (servicing is complete) or to cancel the transaction.
details on CAS.
4-288
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Default Screen File Management
4.11 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:
• DIEBOLD\TCS\cge - For standard monochrome screens
• DIEBOLD\TCS\emg - For Enhanced Monochrome Graphics screens
• DIEBOLD\TCS\cgf - For Color Graphics Feature screens
• DIEBOLD\TCS\adp00 - For VGA Plus screens
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:
• ???32lb - For 32 x 16 screens with buttons on the left side

• ???32rb - For 32 x 16 screens with buttons on the right side
• ???40lb - For 40 x 20 screens with buttons on the left side
• ???40rb - For 40 x 20 screens with buttons on the right side
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:
1. The directory to be read is decided based on the Consumer Display

configuration setting.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Modifying the Contents of a Screen File
4.12 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
To convert cgf32rb.scr to cgf32rb.msc type the following string:
screen cgf32rb.scr cgf32rb.msc
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.
The format of the MSC files is as follows:
• 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 end of each screen is signified by a |FS.
• 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.
Table 4-98 Hex Value/ASCII Symbol Conversion Table
Hex Value Symbol Hex Value Symbol
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Creating a New Default Screen File
Table 4-98 Hex Value/ASCII Symbol Conversion Table (continued)
Hex Value Symbol Hex Value Symbol
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.
Comment Delimiter |?!

Another control character that can be placed in the configuration files is a
comment delimiter. This is a special set of characters used to designate comment
text in a file. This delimiter is placed before and after text used only as a
comment and that means nothing to the configuration. This character sequence
must start in column zero. Any spaces used outside of the trailing comment
symbol become part of the configuration file. The following is an example of a
comment delimiter:
|?! This text is comment text. |?!
4.13 Creating a New Default Screen File
To convert the new .MSC files, use the utility SCREEN.EXE. This utility
converts files from the .MSC to .SCR format.
EXAMPLE
To make a .MSC file to a .SCR file type the following string:
screen cgf32rb.msc cgf32rb.scr
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.
If you are accustomed to working with PCEDIT or VGASCRN and need to

modify the .SCR file, you can use the SCREEN utility to get an editable .DA0 file.
4-291
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced Monochrome Graphics
EXAMPLE
type screen cgf32rb.scr cga32rb.msc and then type screen cgf32rb.msc

cga32rb.da0
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
type screen cgf32rb.da0 cgf32rb.scr
4.14 Enhanced Monochrome Graphics
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).
The character sets are stored in the \DIEBOLD\TCS\emg directory. This

directory has the following files:
• EMGD???A.LIB - Standard character set (formerly named SCDxxA.LIB)
• EMGD???B.LIB - Chinese character set (formerly named CDSxxA.LIB)
• EMGD???C.LIB - Simplified Chinese character set
• 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:
??? - the revision number of the data file.
Changing EMG Graphics Packages

1. Change directories using the following command at a command prompt
(<ENTER> refers to the ENTER or RETURN key):
4-292
TP-821029 (Ed. A)
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:
copy /b emgd???b.lib lprom.lib <ENTER>
• Simplified Chinese graphics:
copy /b emgd???c.lib lprom.lib <ENTER>
• Standard graphics:
copy /b emgd???a.lib lprom.lib <ENTER>
3. Shut down and reboot the system.
4-293
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Multilingual Feature
4.15 Multilingual Feature
The Multilingual feature provides a method of referencing screens of different

languages without the burden on having parallel states for each language. There
are two main aspects of this feature:
• Storing screens of different languages so that only one state flow is required
to show screens of any language.
• Selecting the appropriate language for each consumer.
4.15.1 Screen Storage
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.
To distinguish between the different languages, embed a language control

sequence immediately after the screen number. This control sequence is read
when the terminal is configured and determines which language bank to use for
storing the screen. If any screen does not contain this control sequence, then the
default language bank is used for storage.
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 ----- >
4.15.2 Language Selection
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
Only one screen 901 is required for selecting languages.

Any additional 901 screens that are downloaded overwrite
the previous screen 901.
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.
If the consumer selects CANCEL instead of selecting a language, the transaction

continues using the default language bank (000). If the consumer times out
before selecting a language, the DO YOU WANT MORE TIME screen from
the default language bank (000) is shown. If the consumer chooses NO, the
transaction continues using the default language bank (000).
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
4.15.3 OARs in Conjunction with the Multilingual Feature
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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 touch screen option uses touch templates. The touch template defines which
in and out icons are displayed in addition to defining the coordinates of the hot
spot. Therefore, each language can have a different touch template since the text
within the icon would be different.
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
TP-821029 (Ed. A)
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.
4.16.1 Entry Methods
There are two methods of entry into a rear balance session:
• 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
Stored card data used to initiate a rear balance session must

match an entry in the terminal’s FIT library. If no match is
found, the Maintenance software does not start a rear balance
session.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
If the Maintenance Mode Log to Network feature is enabled,

initiating a rear balance session in Continuous Availability
generates an Unsolicited Status message with a menu code
of 045 in the Maintenance Mode Log field. In Maintenance
mode, initiating a rear balance session does not generate an
Unsolicited Status message.
4.16.2 Rear Balance Functions
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
Because reserved screens 008 and 009 are used to download

function data for a rear balance session, these screens are not
displayable screens. The network should not attempt to use
screen 008 or screen 009 on the consumer display.
Screen 008 (Rear Balance menu text)

Screen 008 defines the text of the menu entries for the Rear Balance menu. The
following example shows the format for screen 008.
4-299
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Screen 009 (function definition data)

The network can define up to 99 rear balance functions. Each function defined
by the network must have an associated record downloaded in screen 009. Each
record must contain the fields shown in Table 4-99.
Table 4-99 Reserved Screen 009 Fields
Field Name Number of

Characters
Autoexecute/Chain Flag 1
Track Data Flag 1
Function Key Data Flag 1
Function Key Data 8
PIN Flag 1
Operator Input Flag 1
Input Screen Number 3
Expected Next State ID 3
Exit on Next State ID Mismatch 1
Data Separator 1
Additional Data Flag 1
Additional Data Variable
Function Definition 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:
• 0 - Execute this function by menu selection only

• A - Autoexecute this function
• 1 - Chain this function to the function defined in the previous record
4-300
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Autoexecute: This specification means that the function is to be executed

automatically at the start of a rear balance session. As soon as an operator has
successfully started a rear balance session, before the Rear Balance menu is
displayed, the indicated function is executed and the corresponding Consumer
Request message is sent to the network. This feature can be particularly useful
for networks that want to do a remote PIN check before the operator selects
any rear balance function.
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
If a function fails the Expected Next State ID check during a

series of chained functions, chaining stops and no more
Consumer Request messages are sent without operator
selection.
Track Data Flag

For a rear balance session initiated using stored card data, this flag indicates
whether to include one or more tracks of the stored card data in the Consumer
Request message. The value in this field is one decimal digit. The following
values are valid:
• 0 - No tracks
• 1 - Track 1 only
• 3 - Tracks 1 and 2
• 7 - Tracks 1 and 2 and 3
4-301
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Function Key Data Flag

This flag indicates whether to include the data specified in the Function Key Data
field in the Consumer Request message. The value in this field is one decimal
digit. The following values are valid:
• 0 - No
• 1 - Yes
Function Key Data

If the flag in the preceding field is 1, the data specified in the Function Key Data
field is placed in the Consumer Request message. If the flag in the preceding
field is 0, the characters in this field are ignored (but still must be present). This
field is eight characters in length.
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
If the rear balance session was initiated using stored card

data, the PIN is sent encrypted, using the method indicated
in the FIT entry. If the rear balance session was initiated
without stored card data, the operator’s password is sent in
place of a PIN, and the password is sent unencrypted.
Operator Input Flag

If operator input is required, this flag specifies the format to use for entering the
data, and where to store the input. The value in this field is one hexadecimal
digit. The following values are valid:
4-302
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Value Format Buffer
0 No operator input is required
1 Non-dollar Dollar Buffer
2 Non-dollar General Purpose Buffer B
3 Non-dollar General Purpose Buffer C
4 Reserved. Do not use.
5 Dollar Dollar Buffer
6 Dollar General Purpose Buffer B
7 Dollar General Purpose Buffer C
8 Reserved. Do not use.
9 Dollar, no cents Dollar Buffer
A Dollar, no cents General Purpose Buffer B
B Dollar, no cents General Purpose Buffer C
D Defined by download Dollar Buffer
Operator input is allowed in the following formats:
• Dollar format (similar to that used in a Dollar Entry State)

• Non-dollar format (similar to that used in an Information Entry State)
• Dollar format with no cents (similiar to that used in a Dollar Entry state
with a Cent Check state)
In dollar format entry (including dollar, no cents), the Maintenance software

uses eight or twelve digits and two or three decimal places, depending on
how the terminal is currently configured. In non-dollar format entry, input is
restricted to 15 characters.
Operator input, regardless of the format, can be stored in the following buffers:
• General purpose buffer B

• General purpose buffer C
• Dollar Buffer
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).
Input Screen Number

If operator input is required, this field contains the number of the screen used to
prompt the operator for input. These characters are ignored (but still must be
present) if no operator input is required. This field is three characters in length.
Expected Next State ID

This field contains a three-digit number that the Maintenance software compares
with the Next State ID field of the next Function Command message. If the value
in the Function Command message matches the value in the Expected Next State
ID field, the Maintenance software proceeds with normal processing. If the value
in the Function Command message does not match the value in the Expected
Next State ID field, the Maintenance software takes the error recovery action
specified in the Exit on Next State ID Mismatch field.
4-303
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The following values are valid in this field:
• 000 through 249 - Expected Next State ID

• 255 - Do not check the Next State ID
Exit on Next State ID Mismatch

If the value in the Expected Next State ID field does not match the value in the
Next State ID field in the Function Command message, this field specifies
which error recovery action to take. This field contains one character. The
following values are valid:
• 0 - Display reserved screen 902 for 10 seconds

• 1 - Exit the rear balance session immediately
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.
Additional Data Flag

This field defines whether additional data should be sent to the network in the
Consumer Request message, and which buffer to use for the additional data.
If additional data is required for this function, the additional data is specified
in the Additional Data field, which follows this flag. This field contains one
character. The following values are valid:
• 0 - There is no additional data to send

• B - Place additional data in general purpose buffer B
• C - Place additional data in general purpose buffer C
• D - Place additional data in the Dollar Buffer
NOTE
If the function definition data specifies that both the operator

input and the additional data are to be placed in the same
buffer, the operator input is placed into the specified buffer,
and the additional data is not included in the Consumer
Request message.
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
If additional data is sent in the Dollar Buffer, the specified data

is padded or truncated, as required, to the maximum Dollar
Buffer size (eight or twelve digits).
4-304
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Function Definition Separator

A capital Z enclosed in single quotes (’Z’) is used as a function definition
separator. The traditional field separator, hex 1C, cannot be used because it
is not a valid screen data character.
4.16.3 Network Activity during a Rear Balance Function
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 Function Command message results in either a command reject or a

solicited device fault status, the terminal reports the fault to the network. The
Maintenance software continues to display PLEASE WAIT while the terminal
waits for another Function Command message. Again, timer 03 is monitored in
case of a communications timeout.
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.16.4 Exiting Rear Balance Mode
If the operator chooses to exit a rear balance session or is automatically exited

because of a mismatch with the expected Next State ID, if there is any print data
on the receipt, the receipt is delivered.
4-305
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.16.5 Example Rear Balance Implementation
This section provides an example that functionally duplicates the balancing

transaction illustrated in Figure 4-39. In this example, for purposes of remote
PIN check, a separate Consumer Request message is sent to the network
immediately after the operator enters the PIN. This remote PIN verification
function is autoexecuted.
NOTE
This is an example only. All screen data is entirely configurable

by the network. Screens used by the Rear Balance feature
do not have any default values and must be designed and
created by the institution.
g1959020
Figure 4-39 Example Balancing Transaction
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
TP-821029 (Ed. A)
4-307

Table 4-100 Reserved Screen 009
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
A 2 1 DDDDDDDD 1 0 000 110 1 ’Y’ 0 ’Z’
0 2 1 AAA b/b/b/b/b/ 0 0 000 110 0 ’Y’ 0 ’Z’
1 2 1 AAB b/b/b/b/b/ 0 0 000 110 0 ’Y’ 0 ’Z’
0 2 1 D b/b/b/b/b/b/b/ 0 0 000 110 0 ’Y’ 0 ’Z’
0 2 1 ABA b/b/b/b/b/ 0 5 301 110 0 ’Y’ 0 ’Z’

0 2 1 ABB b/b/b/b/b/ 0 5 301 110 0 ’Y’ 0 ’Z’
0 2 1 BA b/b/b/b/b/b/ 0 0 000 110 0 ’Y’ 0 ’Z’
Mon Nov 22 16:28:25 2004

TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
Transaction to Add Cash

The following sample transaction flow is for an Add Cash transaction.
1. While the terminal is in service, the operator accesses Continuous

Availability and selects Start RBM from the Tools menu.
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.
2. The Maintenance software displays the following message:
Enter your PIN for rear balancing
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:
• Track 2 stored card data in the Track 2 Data field

• DDDDDDDD in the Function Key Buffer field
• The PIN digits entered by the operator in the PIN Buffer field
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
NOTE
The rest of this example assumes that the remote

PIN check succeeds.
7. The operator selects the Cash Added function. The Maintenance

software displays a dialog box using the text from screen 301 to prompt
the operator for input:
ENTER AMOUNT
$ 0.00
8. The operator types in the amount and clicks on the OK button.
9. The terminal sends up a Consumer Request message with the following

data:
• Track 2 stored card data in the Track 2 Data field
• ABA in the Function Key Buffer field
• The transaction amount in the Dollar and Cents Keyboard Entry

field, right-justified and padded with zeros to the maximum Dollar
Buffer size.
10. The network sends a Function Command message to the terminal to

perform the requested function.
11. The terminal performs the function.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
4.17 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.
An optional auto prompt upon card insertion allows consumer activation or

deactivation of voice messages on a per-transaction basis without state changes
(requires reserved screen 905, Section 4.10). This option can be configured
through the Voice configuration setting.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
4.17.1 Voice Prompting
Voice prompting messages are played when a screen is displayed. Voice

prompting messages typically guide the consumer to perform a function, or the
messages describe the layout of the screen and prompt the consumer to make a
selection. Voice prompting commands can be embedded in either base screens
(the screen number referenced in the state or function) or in overlay screens. The
voice prompting command can include a reference to a .WAV file name, a control
file, or an interpretive command (ESC ZK control sequence).
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.
4.17.1.1 Voice Prompting Using .WAV Files
Voice prompting commands can reference individual .WAV files directly. The
following is an example of a voice prompting command using a .WAV file:
ESC ; 0 "TCS_TEST.WAV" 000 000
This command directs the terminal to play the file TCS_TEST.WAV, with no
delay before playing TCS_TEST.WAV.
There can be multiple voice prompting commands referring to .WAV files

within any given screen. However, all voice prompting commands must be
placed back-to-back. The maximum number of .WAV files that can be in the
queue at any one time is 50.
4.17.1.2 Voice Prompting Using Control Files
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.
Each entry in the control file is structured as follows:
• 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
TP-821029 (Ed. A)
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.
• Columns 11 through 22 specify the file name of the voice message.
Table 4-101 shows some examples of control files.
Table 4-101 Example Control Files
Content of the Control File Description

0 001 002 WELCOME.WAV The message WELCOME.WAV plays
immediately and repeats indefinitely, with a
2-tick delay between plays.
0 001 999 TCS_TEST.WAV The message TCS_TEST.WAV plays once
and stops, because the entry specifies 999
for the delay time.
0 001 003 3.WAV These four messages play sequentially
0 001 003 2.WAV with a 3-tick delay between each message.
0 001 003 1.WAV The sequence does not repeat, because
0 001 999 BLASTOFF.WAV the last entry specifies 999 for the delay
time.
0 003 001 ROW.WAV The sequence of play for this file is ROW
0 001 002 YOURBOAT.WAV (3 times), YOURBOAT, DOWNSTRM,
0 001 003 DOWNSTRM.WAV MERRILY (4 times), and LIFEIS. There is a
0 004 001 MERRILY.WAV 1-tick delay after each play of ROW.WAV,
0 001 001 LIFEIS.WAV a 2-tick delay after YOURBOAT.WAV,
and so on. The entire sequence repeats
indefinitely.
A control file cannot contain a reference to another control file. Only one
control file can be active at any time.
4-312
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
4.17.1.3 Interpretive Commands
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.
Recommendations for non-U.S. Currency

Despite the currency dispensed, the translated buffer should always be in the
form dollar sign, dollar digits, decimal point, cents digits (for example, $ 20.00).
A recommended format template for an eight-digit transaction amount is
C$ ZZZZZ9.99. The dollar sign is used as an indicator to the parser that a
currency amount follows. It does not reflect the actual currency type.
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
Standard .WAV Files

The following .WAV files must be recorded to support the capability of speaking
transaction amounts and account balances:
• 0.WAV, "zero"
• 1.WAV, "one"
• 2.WAV, "two"
• 3.WAV, "three"
• 4.WAV, "four"
4-313
TP-821029 (Ed. A)
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.17.2 Voice Keypad Feedback Commands
Voice keypad feedback messages are played in response to a keypress. These

messages indicate which function key or numeric key has been selected.
Voice keypad feedback commands must be embedded in the base screen (the
screen number referenced in the state or function); they cannot be embedded
in overlay screens.
A given screen can contain multiple voice keypad feedback commands.

Typically, a voice keypad feedback command is included for each enabled
function key. The text recorded could be the same as shown on the button (for
example,"WITHDRAWAL"). If the numeric keypad is enabled, a single voice
keypad feedback command (key code = 0023) can be used to set the .WAV files
for all the numeric keys to their default values.
4-314
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
Table 4-102 shows some examples of voice keypad feedback commands.
Table 4-102 Example Voice Keypad Feedback Commands

ESC ZH 0 0031 000 "1.WAV" Play the file 1.WAV when the 1 key is
pressed.
ESC ZH ESC 0041 000 Play the file WITHDRAW.WAV when
"WITHDRAW.WAV" function key A is pressed.
ESC ZH 0 0023 000 "" Play the default key assignment (as
defined in FEEDBACK.DAT) when a
numeric key is pressed.
Interaction between Prompting and Keypad Feedback

Because keypad feedback messages are spoken in response to a keypress, the
keypad feedback messages immediately terminate all voice prompting messages.
Keypad feedback messages also terminate previous keypad feedback messages,
in order to keep up with the consumer’s keypresses. A consumer can cut short
any guidance messages by making a selection.
Voice prompting messages cannot cut short or terminate a keypad feedback

message, regardless of the termination flag associated with the message.
Feedback from a keypress takes precedence over any subsequent voice prompting
message, allowing the consumer to confirm their selection before continuing.
4-315
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
4.17.3 Text To Speech
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.
TTS requires a text-to-speech synthesizer (called the TTS engine), a software

application that converts plain text to audible speech. Text can be converted
to one of several voices, which differ in pitch and speed, and are generally
categorized as male or female voices.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
Table 4-103 Text To Speech XML Tags (SAPI 5.1)
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 Emphasizes a word or section of text. An example follows:
<emph>text</emph>
The Emph tag causes the word text to be spoken emphatically.
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.
Pron Specifies the pronunciation of a word or section of text. An example follows:
<pron sym=’h eh 1 l ow’>hello</pron>
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
Table 4-103 Text To Speech XML Tags (SAPI 5.1) (continued)
Tag Description
Silence Inserts a specified number of milliseconds of silence. An example follows:
<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:
<voice required=’name=Microsoft Mary’>text</voice>
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
Table 4-104 Diebold Text To Speech Tags
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
TP-821029 (Ed. A)
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.
Voice Prompting Using Individual Messages

Table 4-105) shows some examples of voice prompting commands referencing
individual voice messages that are valid for terminals that have Text To Speech
capability.
Table 4-105 TTS Examples - Voice Prompting Using Individual

Messages
Voice Command Description

ESC ; 0 "TEST.WAV" 000 000 Play the file TEST.WAV.
ESC ; 0 "TEST.TXT" 000 000 Speak the text contained in the file
TEST.TXT.
ESC ; 0 "This a test." 000 000 Speak the text This a test.
ESC ; 0 "<tcsbuffer=A>" 000 000 Speak the text contained in buffer A.
ESC ; 0 "Buffer A contains Append the contents of buffer A to the
<tcsbuffer=A>" 000 000 text Buffer A contains, then speak the
combined text.
ESC ; 0 "ESC ZK A 09" 000 000 Interpret the contents of buffer A using
format template 9, concatenate the
applicable .WAV files, then play the
result.
ESC ; 0 Interpret the contents of buffer A using
"<tcsbuffer=A,template=9>" 000 000 format template 9, then use TTS to
speak the result.
Voice Prompting Using Control Files

As was previously stated, a control file cannot contain a reference to another
control file. In addition, a control file cannot contain a control list.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Voice Feature
Table 4-106 TTS Examples - Voice Prompting Using Control Files
Content of the Control File Description

0 001 002 WELCOME.WAV Play the file WELCOME.WAV immediately
and repeat indefinitely, with a 2-tick delay
between repetitions.
0 001 002 WELCOME.TXT Speak the text contained in the file
WELCOME.TXT immediately and repeat
indefinitely, with a 2-tick delay between
repetitions.
0 001 002 Welcome to our bank. Speak the text Welcome to our bank
immediately and repeat indefinitely, with a
2-tick delay between repetitions.
0 001 002 Play the file WELCOME.WAV immediately
<speakfile=WELCOME.WAV> and repeat indefinitely, with a 2-tick delay
between repetitions.
0 001 999 <tcsbuffer=A> Speak the text contained in buffer A once,
then stop.
0 001 999 Buffer A contains Append the contents of buffer A to the text
<tcsbuffer=A> Buffer A contains, speak the combined
text once, then stop.
Voice Prompting Using Control Lists

Control lists are similar to control files. However, unlike control files, control
lists are defined entirely within screen data, using the ESC ; control sequence.
The following example shows how a control list would appear in screen data.
ESC ; 0 "<controllist repeat=999>" 000 000

ESC ; 0 "Row <repeat=3>" 000 000
ESC ; 0 "your boat, gently down the stream." 000 000
ESC ; 0 "Merrily, <repeat=4>" 000 000
ESC ; 0 "Life is but a dream." 000 000
ESC ; 0 "</controllist>" 005 000
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.
Voice Keypad Feedback

Table 4-107) shows some examples of voice keypad feedback commands that are
valid for terminals that have Text To Speech capability.
4-321
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Miscellaneous Screen Data
Table 4-107 TTS Examples - Voice Keypad Feedback

ESC ZH 0 0031 000 "1.WAV" Play the file 1.WAV when the 1 key is
pressed.
ESC ZH 0 0031 000 "1.TXT" Speak the text contained in the file 1.TXT
when the 1 key is pressed.
ESC ZH 0 0031 000 "1" Speak the word 1 when the 1 key is
pressed.
ESC ZH ESC 0041 000 "Withdrawal" Speak the word Withdrawal when
function key A is pressed.
defined in FEEDBACK.DAT) when a
defined in FEEDBACK.TTS) when a
4.18 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.
4.18.1 Inline HTML Code
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.
021 (screen number)

<HTML>
<HEAD>
<TITLE>INLINE EXAMPLE SCREEN</TITLE>
</HEAD>
<BODY TEXT="#000000" LINK="#0000ff" VLINK="#800080" BGCOLOR="#ffffff">
<CENTER>
<IMG SRC="blueDiebold.gif">
</CENTER>
</BODY>
</HTML>
4.18.2 URL Specification
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.
021 (screen number)
4-322
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Miscellaneous Screen Data
<URL="http://www.diebold.com">
4.18.3 Enhancing Legacy Screens
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
where nnn is the legacy screen to overlay
url is the web page or local document to be displayed by the browser.
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.
• F – Displays a fullscreen browser window, where the size ssss is assumed to

be the entire screen and the specified value is ignored.
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.
This file is read at startup or anytime that LOADCRT.EXE is executed. By

running LOADCRT.EXE, you can make changes to the HTMOVRLY.TXT
file without shutting down the ATM.
4-323
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 13 Message (custom icons for EMG)
An example file would appear as follows:
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.
4.19 Write Command 13 Message (custom icons for EMG)
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).
Modifier (Custom Icons) ; 1
Icon Definition - - - Variable
[ Field Separator (FS) ] [ hex 1C ] [ 1 ]
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
TP-821029 (Ed. A)
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).
4.20 Write Command 14 Message (custom character sets for EMG)
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.
Modifier (Custom Character Sets) < 1
Character Set Definition - - - Variable
message.
Character Set Definition

Valid Data: Refer to the description.
Description: This field contains the definitions for one set of characters. The
data is formatted the same as one record in the DDU’s CHAR.DEF file, not
including the ETX character used as a file record separator.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 14 Message (custom character sets for EMG)
Monochrome Graphics Programming Manual (TP-799300-000A).
4-326
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 15 Message (cell data for EMG)
4.21 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.
Description Data Number of

Characters
Modifier (Cell Data) = 1
Cell Data - - - Variable
Cell Data Set

Valid Data: Refer to the description.
Description: This field contains the definitions for one set of cells. The data is
formatted the same as one record in the DDU’s CELL.DAT file, not including
the ETX character used as a file record separator.
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.
Monochrome Graphics Programming Manual (TP-799300-000A).
4-327
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 18 Message (format templates)
4.22 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.

Characters
Modifier (Format Template) @ 1
Format Template Number - - - 3
Format Template Data - - - Variable (100 max)
[ Format Template Number ] [ - - - ] [ 3 ] [1]
[ Format Template Data ] [ - - - ] [ Variable (100 max) ] [1]
[ MAC Data ] [ - - - ] [ 8 ] [2]

[1] This group of fields (FS/Format Template Number/Format Template Data) can
be repeated, as necessary, to a maximum of 1920 bytes per Write Command 18
message.
(MAC) is used.
message.
Format Template Number

Description: This is a three-character field from 001 to 099. It identifies the
format template number for the format template data that follows.
4-328
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Format Template Data

Field Size: Variable (maximum of 100 characters)
Valid Range: Refer todescription
Description: The characters represent format template data.
NOTE
The Format Template number, state data, and field separator

fields can be repeated as necessary to a maximum of 1920
bytes (total message length).
Format Template Usage

The terminal uses format templates in select screens to format the way
consumer-entered data is shown on the consumer display.
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:
• Display method characters to determine how the data is shown on the

consumer display
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-112 Example Uses of 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|
3rd AB1 |A|B|1|
4th [1] AB12 |A|B|1|2|
XXXX No Entry
1st x |1|
2nd xx |1|2|
3rd xxx |1|2|3|
4th [1] xxxx |1|2|3|4|
(zzz)zzz-zzzz ( ) - No Entry
1st (1 ) - |1|
2nd (12 ) - |1|2|
3rd (123) - |1|2|3|
4th (123)4 - |1|2|3|4|

• • •
• • •
• • •
10th [1] (123)456-7890 |1|2|3|4|5|6|7|8|9|0|
C04ZZZZZ9699 $0.00 No Entry
1st $0.01 |1|
2nd $0.12 |1|2|
3rd $1.23 |1|2|3|
4th $12.34 |1|2|3|4
• • •
• • •
• • •
8th [2] $123456.78 |1|2|3|4|5|6|7|8|
D$b/AAAAAA.AA $ No Entry
1st $1 |1| | | |
2nd $ 12 |1|2| | |
3rd $ 12. |1|2| | |
4th $ 12.3 |1|2|3| |
5th $ 12.30 |1|2|3|0|

[1] If the data entry fills the format template, the terminal goes to the Format Template Full Next State. Refer to the
Information Entry states in Section 4.4.9 and Section 4.5.15.
[2] The 6 in this example indicates that the terminal should use reserved screen 006 (defaults to a [period]) in
this position. Refer to Section 4.10 for information on reserved screens.
4-330
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-112 Example Uses of Format Templates (continued)
Format Template Data Entry Display After Data Entry Contents of Input Buffer After Entry
C04ZZZ5ZZ9699 $0.00 No Entry
1st $0.01 |1|
2nd $0.12 |1|2|
3rd $1.23 |1|2|3|
4th $12.34 |1|2|3|4|
5th • •
• • •
• • •
8th [2] $123456.78 |1|2|3|4|5|6|7|8|

[1] If the data entry fills the format template, the terminal goes to the Format Template Full Next State. Refer to the
Information Entry states in Section 4.4.9 and Section 4.5.15.
[2] The 6 in this example indicates that the terminal should use reserved screen 006 (defaults to a [period]) in
this position. Refer to Section 4.10 for information on reserved screens.
4-331
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
4.22.1 Display Method
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.
• No Method Characters - If a format template does not contain display

method characters, the terminal defaults to a left-justified display field with
no decimal point and no leading zeros.
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).
• B - Display method B causes whatever is programmed in the format template

to be displayed, one character at a time, corresponding with each key input
from the keypad. For example, consider the following format template:
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.
Please note that any ASCII character or combination of characters in

the range of 20 to 60 (hex), inclusive, can be used in this template. Two
additional examples are as follows:
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
If the terminal is using a C format template and the

consumer presses a decimal point key, the terminal
ignores the key.
4-332
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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 consumer must enter a decimal point as part of the

normal data entry.
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
No characters other than data type A characters and a

single decimal point can appear in a D format template.
Commas cannot appear in a D format template.
When a D format template is used in an Information Entry state, the terminal

takes the Format Template Full Next State exit after the consumer fills the
character positions to the right of the decimal point. Therefore, in order to
allow consumers to verify their entries, the Format Template Full Next State
entry must contain 255. In this case, the terminal stops accepting numeric
input after the format template is full, and remains in the Information Entry
state until the consumer presses a function key.
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.
4.22.2 Data Type
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The valid entries for the data type characters are as follows:
• A - alphanumeric display, show any character entered
• X - alphanumeric display, but show only Xs on the display for any character
entered (not valid for D display method formats)
• V - alphanumeric display, show any character entered (not valid for C

and 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)
• 4 - insert reserved screen 004, which stores the dollar sign
• 5 - insert reserved screen 005, which stores the thousands separator character
• 6 - insert reserved screen 006, which stores the decimal point
• 9 - numeric display, show only numeric characters, zero filled (leading

zeros) before the consumer enters data (not valid for D display method
formats; show any leading zeros only in C display method formats)
• Z - numeric display, show only numeric characters, suppress leading zeros

(not valid for D display method formats)
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:
010|FF|SICCPLEASE ENTER YOUR PIN|SIGI......|SIGI
Format data:
033WWWWWW
4-334
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
If non-numeric data is entered into a numeric-only display field (9 or Z), the

terminal shows the data as a space.
Data type characters R, S, T, and U are reserved for future use.
4.22.3 Default Templates
The following is a list of available default templates and their uses:
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• Template 010
C04ZZZZZZZZZ9699 (used for transaction
• Template 011
C04ZZZZZZZZ96999 (used for transaction
Reserved Format Templates

The terminal defines several format templates for use in displaying data on the
screen. A list of applicable formats is as follows:
Numbers Contents Use
001 C04ZZZZ5ZZ9699 State F
002 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX OAR data entry
003 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA OAR data entry
004 XXXXXXXXXXXXXXXX States B, M
006 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX State H
007 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA State H
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
12 digit, 2 d.p., calculator C04ZZ5ZZZ5ZZZ5ZZ9699
12 digit, 3 d.p., calculator C04ZZZZ5ZZZ5ZZ96999
8 digit, 2 d.p., decimal AAAAAA.AA
12 digit, 2 d.p., decimal AAAAAAAAAA.AA
12 digit, 3 d.p., decimal AAAAAAAAA.AAA
4.22.4 Initialization Data
A prefix modifier of I followed by a 3-digit screen number results in the template

being formatted with the data in the screen number initially being displayed.
It is then overwritten by the incoming keypad data, as indicated by the format
template. The length of the initialization data taken from the screen library is
limited to a maximum of the length of the format. For example, if the screen is
longer than the format, only the first N characters of the initialization screen are
used, where N is the length of the format template.
4-336
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The length of the format is computed using the following rules:
1. The four-character initialization screen prefix does not count toward

the length.
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.
An example of a calculator style format with initialization is as follows.
001I123C
/
b
/ZZZZZZZZ Format Template 1, 8 digits zero suppression.
b
123*************** Screen 123, all asterisks.
The preceding format and screen is initially displayed as 8 asterisks, replaced by

8 digits displayed calculator-style with leading zeros being ignored. Note that
screen 123 can be used for any length format template up to 15 digits and only
displays as many asterisks as there are places in the format. Only one screen
need be defined for any pattern style entry, repeating the pattern as needed.
An example of a normal style format with initialization used for date entry
is as follows:
002I456AA AA AA Format Template 2, six digits displayed as 3

pairs.
456../../../.. Screen 456, pairs of periods separated by slashes.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 3 Message (terminal parameters, LUNO, timers)
4.23 Write Command 3 Message (terminal parameters, LUNO, timers)
The Write Command 3 message configures terminal parameters, the LUNO,

and terminal timers. The format of the Write Command 3 message is shown
in Table 4-113. This message downloads the Logical Unit Number (LUNO),
parameters and timers into terminal memory. Because this command defines
the LUNO and communications timers, use this configuration message first
after a powerup.

Characters
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
[ Reserved ] [3] [ 000 ] [ 3 ]
[ Miscellaneous Features 3 ] [3] [ - - - ] [ 3 ]

[1] This group of fields is used by TABS terminals as follows:
Deposit Printer and Camera Control
Card Reader Error Count
Hi-side Bill Size (TABS 911) or Reserved (TABS 912)
Lo-side Bill Size (TABS 911) or Reserved (TABS 912)
Track 3 Write Error Limit
These fields are included to provide compatibility with mixed networks running both
TABS and Agilis 91x for ix/CSP terminals.
[2] This group of fields (Timer Number/Number of Ticks) can be repeated as necessary.
[3] If you are including the Miscellaneous Features 3 field, you must also include the
Reserved field that precedes it.
Miscellaneous Features 3 field and the Reserved field that precedes it.
4-338
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 4-113 Write Command 3 Message (continued)

Characters
[ Miscellaneous Features 4 ] [4] [ - - - ] [ 3 ]
Logical Unit Number (LUNO) - - - 3
Timer Number - - - 2
Number of Ticks - - - 3
[ Timer Number ] [ - - - ] [ 2 ] [2]
[ Number of Ticks ] [ - - - ] [ 3 ] [2]

[1] This group of fields is used by TABS terminals as follows:
Deposit Printer and Camera Control
Card Reader Error Count
Hi-side Bill Size (TABS 911) or Reserved (TABS 912)
Lo-side Bill Size (TABS 911) or Reserved (TABS 912)
Track 3 Write Error Limit
These fields are included to provide compatibility with mixed networks running both
TABS and Agilis 91x for ix/CSP terminals.
[2] This group of fields (Timer Number/Number of Ticks) can be repeated as necessary.
Reserved field that precedes it.
Miscellaneous Features 3 field and the Reserved field that precedes it.
message.
Miscellaneous Features 1
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Weight Features
128 Append rollover counts
64 Decimal style
32 Deposit cancel status bit
16 Dollar decimal places
8 Dollar Buffer size
4 Reserved [1]
2 Automatic return to previous mode
1 Separate Ready response

[1] This bit is used by TABS terminals for the Fault Status
Print feature. The bit is reserved to provide compatibility
with mixed networks running both TABS and Agilis 91x
for ix/CSP terminals.
Append Rollover Counts

The Append Rollover Counts feature tells the terminal to append rollover counts
to Consumer Request messages and Solicited Status messages. The rollover
counts consist of a field separator and four groups of three decimal digits, one
group for each possible dispense position of the bill dispenser. The three digits
represent the low-order byte of the actual dispense counters available at the
terminal from the Supply menu. The range of these rollover counts is 000 to 255.
The counters continually increase from 000 and periodically roll over from 255
to 000 as bills are dispensed from each position.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
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
Before entry $
1st digit $ 1
2nd digit $ 12
3rd digit $ 123
4th digit $ 1234
5th digit $ 12345
4-341
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
6th digit $ 123456.

(decimal point is automatically displayed)
7th digit $ 123456.7
8th digit $ 123456.78
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.
Deposit Cancel Status Bit

The deposit cancel status bit feature (912 mode only) directs the terminal to
set a depository status bit in addition to the consumer timeout bit when the
consumer cancels a deposit operation. This option has no effect on terminals
operating in 911 mode.
Dollar Decimal Places

If the 12-digit Dollar Buffer is selected (Dollar Buffer size feature), the dollar
decimal places feature controls the position of the implied decimal point in the
Dollar Buffer. If this feature is selected, the decimal point is three places from
the right. If the feature is not selected, the decimal point is two places from the
right. This feature affects the position of the decimal point in the Dollar Display
screen and the operation of the Cent Check state.
Dollar Buffer Size

The Dollar Buffer size feature controls the number of decimal digits stored in the
Dollar Buffer. If the feature is selected, the Dollar Buffer holds 12 digits. If the
feature is not selected, the Dollar Buffer holds 8 digits. The size of the Dollar
Buffer affects the number of digits the consumer can enter during a Dollar Entry
state (F). The size also affects the number of bytes sent to the network in the
Dollar and Cents Keyboard Entry field of the Consumer Request message.
NOTE
If 912I is selected in the High-side Communication

configuration setting, a 12-digit Dollar Buffer size is
automatically selected.
Automatic Return to Previous Mode

The automatic return to previous mode feature can only be modified through a
configuration setting. The terminal ignores this weight component.
Separate Ready Response

Selecting the Separate Ready response feature enables the terminal to use a
Solicited Status message that contains a B status descriptor. The terminal uses
this status descriptor to indicate a Ready condition in response to a Function
Command message instead of using a 9 status descriptor.
4-342
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
select the following features:
• Reject Reason codes to network (Section 5.2.21)

• Expanded hardware configuration status (Section 5.2.20)
• Maintenance mode log to network (Section 5.3)
• MDS status to network (Section 5.3)
• Change MMD mispick timer to 30 seconds
Weight Features
128 Reserved
64 Reject Reason codes to network
32 MDS status to network
16 Maintenance mode log to network
8 Change MMD mispick timer to 30 seconds
4 Expanded hardware configuration status
2 Reserved
1 Reserved
select the following features:
• Enable OK and correction keys for 9000 states (B, M, H)

• Transaction verification status
• No retract bills
• Send all status
• Sending Message Sequence Number in Solicited Status messages
• Extended range for message coordination number
• Doubling timer 03
• Double expanded Hardware Configuration status (Section 5.2.20)
4-343
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Weight Features
128 Enable OK and correction keys for 9000

states (B, M, H)
64 Transaction verification status
32 No retract bills
16 Send all status
8 Message sequence number in Solicited

Status messages
4 Extended range for message coordination

number
2 Doubling timer 03 feature
1 Double expanded hardware configuration

status
Enable OK and Correction Keys for 9000 States

Selecting the Enable OK and Correction Keys for 9000 states (B, M, and
H) feature causes the terminal to enable the OK (J) and Correction (K) keys
during the 9000 PIN entry and information entry states. If this feature is
selected, pressing the Correction key during PIN entry erases the PIN digits
already entered. Pressing the OK key during PIN entry ends PIN entry and
causes a PIN check to be performed. Pressing the Correction key during the
information entry state erases all digits previously entered. Pressing the OK
key during the information entry state causes the terminal to take the Function
Key A Next State exit. If Function Key A Next State is set to 255, the OK key
is deactivated. This option is not enabled if states B, M or H are extended
using Function Key Extension states.
Transaction Verification Status

Selecting the Transaction Verification Status feature enables the terminal to
send a buffer of data to the network appended to each Consumer Request
message (Section 5.1) (if feature is enabled). This feature gives the network
information about any cash delivered to the consumer during execution of the
previous function command. This feature allows the financial institution to
obtain additional information that can be used for balancing procedures. For
additional details, refer to application notes in Appendix C.
No Retract Bills Feature

The No Retract Bills feature allows the terminal to present cash to the consumer
and, after a timeout, to leave it accessible (in the presenting position), instead
of retracting or dumping the cash. When this feature is enabled, bills are only
retracted or dumped under the following conditions:
• Powerup after reset or power failure

• During maintenance operations
• Network commanded dump
4-344
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
• Go Out of Service with Auto Back In Service When Money is Removed.

This mode requires network changes to the Out of Service Screen (screen
002) to direct the consumer to remove the blockage from the delivery area.
The network must also prevent the consumer from selecting additional bill
dispense transactions while unremoved cash remains in the presenting
position. Otherwise, because the terminal does not go out-of-service until the
current consumer session ends, if that consumer were to select another bill
dispense transaction, the terminal would have to retract and retain the cash
from the previous dispense before a new dispense command could be issued.
• Go Out of Service, Wait for Network Command to Go Back In Service.

This mode requires enabling the Money Forgotten and Money Removed
messages. This mode operates the same as the previous mode except that the
network should send an In Service Operational Command message after
receiving a Money Removed Unsolicited Status message.
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).
Send All Status

Selecting the Send All Status feature tells the terminal to append additional
hardware configuration status to the Hardware Configuration status message
after the double expanded hardware configuration fields (Section 5.2.20).
Message Sequence Number in Solicited Status Messages

Selecting the Message Sequence Number in Solicited Status Messages feature
tells the terminal to transmit the message sequence number it received in
a Function Command message, Operational Command message, or Write
Command message back to the network in the corresponding Solicited Status
message. If message authentication (MAC) is used, Function Command
messages contain a time variant number in place of the message sequence
number. If this is the case, then the Solicited Status message sent in response to
a Function Command message returns that time variant number rather than a
message sequence number.
4-345
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Extended Range for Message Coordination Number

Selecting the Extended Range for Message Coordination Number feature
increases the range for message coordination numbers from 31 through 3F
(hex) to 31 through 7E (hex).
select the features listed in the following table:
Weight Features
128 Reserved
64 Reserved
32 Reserved
16 Disallow dispense with safe door open
8 Reserved
4 Envelope Dispenser Configuration Control
2 Send Supplemental Dispenser status to

network
1 Reserved
Envelope Dispenser Configuration Control

The Envelope Dispenser Configuration Control feature applies only to terminals
equipped with an envelope dispenser (enabled). Selecting this feature allows
the network to modify certain configurable features of the envelope dispenser.
For further details, refer to the description of the Send Supplemental Dispenser
Status to Network feature, and to the description of the Disable Automatic
Envelope Dispensing feature.
Send Supplemental Dispenser Status to Network

The Send Envelope Dispenser Status to Network feature applies only to
terminals equipped with an envelope dispenser (enabled). This feature allows
the network to enable or disable sending statuses to the network for envelope
dispenser faults. This feature applies only to envelope dispenser faults that occur
during automatic envelope dispensing or during the processing of a Deposit state
(C state). Envelope dispenser faults that occur during the processing of an
Envelope Dispenser state (SD state) or an Envelope Dispenser function command
(SD function ID) are always reported to the network.
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.
Disallow Dispense with Safe Door Open

The Disallow Dispense with Safe Door Open option requires the chest door (safe
door) to indicate closed when doing a network authorized dispense operation.
Once this feature is enabled it can only be disabled by clearing terminal memory
and sending a Write Command 3 message with the option turned off (set to 0).
The MDS status generated when the chest door is open is DI01:3E:02:00.
4-346
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
NOTE
Not all terminal hardware vendors support reporting a closed

status for the safe door. In such cases, it is recommended that
you do not enable this feature.

Field Size: 3
Description: This three-character data field defines the three-character LUNO
number for the terminal. This number identifies the terminal for text-level
tracking at the network. If the key-entry person enters a machine number, the
terminal places the terminal number at the end of the LUNO in the Consumer
Request, solicited status, and Unsolicited Status messages (except the Power
Failure Unsolicited Status message).
Timer Number
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 00 - Timer 00 sets the keypad response timeout interval. When a

screen is displayed that prompts the consumer to make a keypad entry, the
consumer must respond within the timeout interval specified for timer 00.
Otherwise, the terminal exits its present state, displays screen 000, and starts
timer 01. There is no beeping while this timer is active.
• Timer 01 - Timer 01 sets the consumer response extension timeout interval.

If the consumer exceeds the timeout interval allowed for keypad entry (timer
00), for deposit insertion (timer 04 or timer 20), or for bag deposit insertion
(timer 08), screen 000 is displayed. Screen 000 asks if the consumer needs
more time. Timer 01 is the timeout interval for the consumer’s response to
screen 000. The keypad beeper sounds while this timer is active. If this
timer expires for the keypad, the terminal advances to the Timeout Next
State. If the timer expires for the deposit, the terminal sends solicited
status to the network.
• 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
A timeout interval of 000 is not permitted for timer 02.
• Timer 03 - Timer 03 sets the communications message timeout interval.

When the terminal is ready to transmit a Consumer Request message to
the network, the terminal starts timer 03. If the terminal does not receive a
Function Command message before timer 03 expires, the terminal exits
the transaction request state by going to the Network Response Timeout
Next State exit. If bit 1 of the Miscellaneous Features 3 field in the Write
Command 3 message is set, a tick for timer 03 is 1.6 seconds in length rather
than the standard 0.8 seconds. This feature can be used when you need the
timer to be longer than 204 seconds.
4-347
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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.
• Timer 06 - Timer 06 sets the communications offline timeout interval. This

timer is started each time the terminal receives a poll or select sequence
from the network. If the terminal has not been polled or selected within the
interval specified for timer 06, the terminal proceeds to the Off-line mode
(out-of-service to consumers) and displays screen 001.
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
Timers 10 and 11 are reserved for compatibility with TCS.

The value of these timers should not be changed.
Timers 12 through 14 are not used by Agilis 91x for

ix/CSP. These timers are set to 000.
4-348
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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
Timers 16 and 17 are not used by Agilis 91x for ix/CSP.

These timers are set to 000.
• 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
redisplayed. 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 19 is not used by Agilis 91x for ix/CSP. This

timer is set to 000.
• 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 21 - Timer 21 is used with receipt printers (or statement printers

emulating receipt printers) equipped with an exit sensor. This timer sets the
amount of time that Agilis 91x for ix/CSP waits for the consumer to take a
delivered receipt following a print and do not wait operation or a deliver and
do not wait operation. If the receipt is not removed in the alloted time, Agilis
91x for ix/CSP directs the printer to retain the receipt, depending on the
capabilities of the printer. A timer value of 000 (the default value), disables
the retaining (or dumping) of the receipt. For detailed information on the use
of timer 21, refer to the description of the Printer state (Section 4.5.10) and
the description of the Printer function ID (Section 5.6.14).
• Timer 22 - .Reserved
4-349
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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
Timers 25 and 26 are reserved for compatibility with TCS.

The value of these timers should not be changed.
• Timer 31 - Timer 31.Reserved
Number of Ticks
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Timer Number Default Value (in Suggested Value (in ticks)

ticks)
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
10 006 Reserved, do not change
12 - 14 000 Reserved, must be 000
15 000 038
16 - 17 000 Reserved, must be 000
18 012 012
19 000 075
21 000 038
22 030 030
23 000 003
31 030 030
NOTE
The Timer Number and Number of Ticks fields can be repeated

as necessary. Any timers with default values can be, but do not
have to be, downloaded.
4-351
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 6 Message (Financial Institution Tables)
4.24 Write Command 6 Message (Financial Institution Tables)
This message downloads Financial Institution Tables (FITs) into terminal

memory. Each message can include up to four tables. The terminal can store up
to 509 FITs. One FIT is necessary for each member financial institution. Refer to
details on FIT. Table 4-114 illustrates the message format.
Modifier (FIT) 5 1
FIT Number - - - 3
FIT Data (38 Bytes) - - - 114
[ FIT Number ] [ - - - ] [ 3 ] [1]
[ FIT Data (38 Bytes) ] [ - - - ] [ 114 ] [1]
[ MAC Data ] [ - - - ] [ 8 ]

[1] This group of fields (FS/FIT Number/FIT Data) can be repeated, as necessary, to a
maximum of four FITs per Write Command 6 message.
message.
FIT Number
Description: This three-character field designates the number assigned to the
FIT in the following field.
4-352
TP-821029 (Ed. A)
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
Valid Range:
represent the MAC calculation of the Write Command 6 message. Refer to
additional details.
4-353
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 7 Message (encryption key change)
4.25 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.
Write Identifier (Encryption Key Change) 3 1
[ Key Change ] [ - - - ] [ 1 ]
[ New Key Data ] [ - - - ] [ Variable ]
The following paragraphs describe the fields specific to to the Write Command 7
message.
Key Change
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:
• 1 - Decrypt new master key with current master key

• 2 - Decrypt new COMM key with current master key
• 3 - Decrypt new COMM key with current COMM key
• 4 - Use Power-up COMM key (B key) as current COMM key
• 5 - Decrypt MAC key with current Master key
• 6 - Decrypt MAC key with current COMM key
• 7 - Use Power-up COMM key (B key) as current MAC key
• 8 - Decrypt new Visa Master key with current Visa Master key
• 9 - Send Visa key table to the terminal
• ? - Remote key transport
• @ - Public key certificate
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
NOTE
If you are sending updated keys to a terminal with a keypad

incorporating an encryption/decryption module, you must
verify the keys are parity-correct. If they are not, the Write
Command message is rejected. For more details on keys,
refer to the Data Security Procedures and Reference Manual
(TP-799530-001D).
New Key Data

Description: The terminal receives, decrypts, and stores new key data inputs
for future use. The size of this field varies, depending on the Key Change
field. The field sizes are as follows:
• If the Key Change field is 4 or 7, there is no New Key data; this field is not
included in the message.
• If the Key Change field is 1, 2, 3, 5, 6, or 8, the New Key data field is 24

characters for single-length keys, 48 characters for double-length keys. It is
eight (or 16) hex bytes transmitted as eight (or 16) sets of three decimal
characters with a range of 000 through 255.
NOTE
If the terminal is set to use single-length keys, and 48

characters of key data are sent, the message is rejected.
If the terminal is set to use double-length keys, and 24
characters of key data are sent, the message is rejected.
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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:
- 001 - Master key (A key)

- 002 - Powerup COMM key (B key)
- 003 - Visa Master key (V key)
• 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
Key changes ? and @ are used by the Remote Key

Transport feature .
Refer to the Data Security Procedures and Reference Manual (TP-799530-001D)

for additional details.
4-356
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 8 Message (configuration ID)
4.26 Write Command 8 Message (configuration ID)
The Write Command 8 message contains an identifier for the configuration

data sent to the terminal and the configuration data in a given terminal. At
terminal startup, or any time when configuration data is sent to the terminal, the
configuration ID is set to 0000. The Write Command 8 message must be included
as the last of the downloaded configuration data to set the configuration ID to the
desired number. Thus, the Write Command 8 message acts as an authorization
signature for the preceding data. The configuration ID can be any number from
0001 to 9999. Refer to Table 4-116 for the message format.
The configuration ID can be used to verify configuration data. When it is properly

configured, the terminal memory contains the configuration ID assigned by the
Write Command 8 message during configuration. To verify the configuration
data, the network sends a Configuration ID Request Operational Command
message (Section 5.7). The terminal responds by sending the configuration ID to
the network. If the configuration data has been changed without the authorization
signature, the terminal had been powered down and has not been reconfigured, or
the encryption keys changed, the terminal sends 0000 to the network.
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).
Write Identifier (Configuration Data) 1 1
Modifier (Configuration ID Number) 6 1
Configuration ID Number - - - 4
message.
4-357
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 8 Message (configuration ID)
Configuration ID Number
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Section 5
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:
• Account card data (including the primary account number [PAN])

• The personal identification number (PIN)
• Various terminal keypad inputs
Refer to Figure 5-1 for an example of a typical message exchange sequence.
The Consumer Request message is sent to the network.
The network responds to a Consumer Request message with a Function

Command message. The Function Command message tells the terminal how to
accomplish the requested transaction.
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.
Messages from the Terminal to the Network

The terminal transmits the following three message types:
• Consumer Request messages (Section 5.1)

• Solicited Status messages (Section 5.2)
• Unsolicited Status messages (Section 5.3)
Messages from the Network to the Terminal

The following four basic message types transmitted from the network to the
terminal:
• Function Command (Message ID ’4’) (Section 5.5)
• Enhanced Function Command (Message ID ’7’) (Section 5.6)
• Operational Command (Message ID ’1’) (Section 5.7, Section 5.8, and

Section 5.9)
• Write Command (Message ID ’3’)
5-1
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
Figure 5-1 Transaction Message Flow
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Consumer Request Message
5.1 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.
The format of the Consumer Request message is dependent on the format of

the Enhanced Transaction Request state (Section 4.5.20). If the Enhanced
Transaction Request state is a Format 0 state, then the Consumer Request
message generated is a Format 0 message, which is shown in Table 5-1.
If the enhanced Transaction Request state ( @I ) is a format 1 state, then

the Consumer Request message generated is a format 1 message as shown
in Table 5-2. The portions of the message that are the same as the standard
Consumer Request message are shaded.
Table 5-1 Consumer Request Message (format 0)
Solicited/Unsolicited ID 1 1
Message Identifier 1 1
Logical Unit Number (LUNO) - - - 3 or 9
[ Time Variant Number ] [ - - - ] [ 8 ] [1]
Top-of-Form Flag - - - 1
Message Coordination Number - - - 1
[ Track 2 Data ] [ Variable ] [ Variable (40 max) ]
[ Track 3 Data ] [ Variable ] [ Variable (106 max) ]
[ Function Key Buffer ] [ - - - ] [ 0 or 8 ]

[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,
[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-3
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-1 Consumer Request Message (format 0) (continued)
[ Dollar and Cents Keyboard Entry ] [ - - - ] [ 0, 8, or 12 ] [2]
[ PIN Buffer ] [ Variable ] [ Variable (16 max) ]
[ General Purpose Buffer B ] [ Variable ] [ Variable (32 max) ]
[ General Purpose Buffer C ] [ Variable ] [ Variable (32 max) ]
[ Track 1 Data Buffer (1) Identifier ] [ 1 ] [ 1 ]
[ Track 1 Data Buffer ] [ Variable ] [ Variable (79 max) ]
[ MICR Data Buffer (2) Identifier ] [ 2 ] [ 1 ]
[ MICR Data Buffer ] [ - - - ] [ Variable (70 max) ]
[ Transaction verification status buffer ID ] [ 6 ] [ 1 ] [3]
[ Transaction serial number from last function command ] [ - - - ] [ 4 ] [3]
[ Response to last function command ] [ - - - ] [ 1 ] [3]
[ Retract operation ] [ - - - ] [ 1 ] [3]
[ Group separator (GS) ] [ hex 1D ] [ 1 ] [3]
[ Device ID ] [ DI01 ] [ 4 ] [3]
[ Record separator (RS) ] [ hex 1E ] [ 1 ] [3]
[ Bill Denomination ID, Position 1 ] [ - - - ] [ 1 ] [3]
[ Record separator (RS) ] [ hex 1E ] [ 1 ] [3]
[ Bills Delivered Count, Position 1 ] [ - - - ] [ 5 ] [3]
(Section 4.23).
5-4
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-1 Consumer Request Message (format 0) (continued)
[ Device ID ] [ CN01 ] [ 4 ] [3]
[ Record Separator (RS) ] [ hex 1E ] [ 1 ] [3]
[ Coin Denomination ID, Position 1 ] [ - - - ] [ 1 ] [3]
[ Record Separator (RS) ] [ hex 1E ] [ 1 ] [3]
[ Coins Delivered Count, Position 1 ] [ - - - ] [ 5 ] [3]
[ Device ID ] [ - - - ] [ 4 ] [3]
[ Field Separator ] [ hex 1C ] [ 1 ] [5]
[ Buffers to Follow ID ] [ 9 ] [ 1 ] [5]
[ Buffer ID ] [ - - - ] [ 3 ] [5]
[ Buffer Data ] [ - - - ] [ Variable ] [5]
[ Group Separator (GS) ] [ hex 1D ] [ 1 ] [5]
[ Buffer ID ] [ - - - ] [ 3 ] [5]
[ Field separator (FS) ] [ hex 1C ] [ 1 ] [4]
[ Rollover 1 Count ] [ - - - ] [ 3 ] [4]
[ Rollover 2 Count ] [ - - - ] [ 3 ] [4]
[ Rollover 3 Count ] [ - - - ] [ 3 ] [4]
[ Rollover 4 Count ] [ - - - ] [ 3 ] [4]
[ Field separator (FS) ] [ hex 1C ] [ 1 ] [1]
[ MAC Data ] [ - - - ] [ 8 ] [1]

(Section 4.23).
The following paragraphs describe the fields in the Consumer Request message:
5-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

characters used for communications protocol processing. The contents of
the field depend on the communications protocol used by the system. This
header typically includes the start-of-text (STX) character. Refer to your
Solicited/Unsolicited ID
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
In the case of the Consumer Request message, this field is 1.
Message Identifier
Valid Range: 1
transmitted. The only valid value for the Consumer Request message is 1.

Valid Range:
contains nine characters, with the last six characters of this field being the
Time Variant Number

Valid Range:
Description: This is an eight-character field containing hexadecimal characters
that are randomly generated by the ATM if message authentication (MAC)
is used. Refer to the Data Security Procedures and Reference Manual
Top-of-form (TOF) Flag

Description: This data field informs the network if this transaction is printing at
the top of the receipt. The valid values are as follows:
• 0 - Not printing this transaction at the top of the receipt

• 1 - Printing transaction at the top of the receipt
Message Coordination Number

5-6
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Valid Range: ASCII 31 through 7E

Description: This is a character assigned by the terminal to each Consumer
Request message. The terminal assigns a different coordination number, to each
successive Consumer Request message, on a rotating basis. The standard valid
range for the coordination numbers is graphic 1 through 9, : ; < = > and ? (ASCII
31 through 3F). If the extended range for message coordination number field bit
is selected in the Miscellaneous Feature 3 field of a Write Command 3 message
(Section 4.23), then the valid range is ASCII 31 through 7E. The network must
include the corresponding coordination number when responding with a Function
Command message. If the coordination numbers do not match, the terminal
sends a Solicited Status message with a Command Reject status.
Track 2 Data
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
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.
Function Key Buffer

Valid Range:
Description: The Function Key Buffer field can be either zero or eight characters
long. The following items determine the contents of this field:
• The function key(s) pressed by the consumer

• The Clear Keys state
• The Select Function state
The terminal stores the following information for each function key pressed:
Function Key Pressed Graphic Stored
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.
Dollar and Cents Keyboard Entry

Field Size: 0 or 8, 0 or 12
Valid Range:
5-7
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
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.
General Purpose Buffer B

Field Size: Up to 32 characters
Valid Range:
Description: The contents of the variable-length General Purpose Buffer B field
depend on whether the consumer message is being sent in response to an open
account relationship (OAR) screen.
If it is not being sent in response to an OAR screen, this field only contains up to
32 digits entered by the consumer.
If it is being sent in response to an OAR screen, this field contains up to 32 digits

entered by the consumer. If less than 32 digits were entered, this field also
contains the character representing the function key pressed or a timeout (A,
B, C, D, E (cancel) or T (timeout)).
General Purpose Buffer C

Valid Range:
Description: If selected to do so by the Information Entry state, the variable-
length General Purpose Buffer C field contains up to 32 digits entered by
the consumer.
Track 1 Data Buffer Identifier (1)

Valid Range: 1
Description: This one-character field identifies the data that follows in the
next field as track 1 data.
Track 1 Data
Field Size: Variable (79 maximum)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
MICR Data Buffer Identifier (2)

Valid Range: 2
Description: This one-character field identifies the data that follows in the next
field as MICR data.
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.
Transaction Verification Status Buffer ID

Valid Range: 6
Description: This one-character field identifies the data that follows in the next
group of fields as Buffer 6 data (transaction verification status data).
Transaction Serial Number from Last Function Command

Description: This four-character field contains the transaction serial number
from the last function command sent to the terminal.
Response to last Function Command

Description: This one-character field indicates the ATM’s response to the last
function command. If there was a power failure and the status or the Ready
response (9 or B) did not get sent, this field indicates what the terminal did or
tried to do. The valid values for this field are as follows:
• 0 - No response. This response appears in the first Consumer Request

message after a power failure occurred before a function response was
generated.
• 1 - Ready 9 or B
• 2 - Fault status reply
• 3 - Last function command rejected
Retract Operation
5-9
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Description: This one-character field indicates whether or not a retract operation

occurred during the last transaction. The valid values are as follows:
• 0 - No retract operation occurred

• 1 - Retract operation initiated during the last transaction
Device ID
Valid Range: DI01
Description: This is a four-character field that indicates the following status
information is for the bill dispenser.
Bill Denomination ID, Position x

Valid Range: A through H
Description: This byte indicates the denomination ID of the cassette in dispense
position x (x = from 1 up to 4) at the time of the last bill dispense.
NOTE
The Bill Denomination ID field is repeated for each dispense

position supported by the terminal. These fields can be
initialized to all @s (no cassette) before any bill dispense.
Bills Delivered Count, Position x

Description: This field indicates the number of bills dispensed and delivered
from position x (x = from 1 up to 4) since the last function command. This count
reflects those bills presented so that they were accessible to the consumer.
NOTE
The Bills Delivered Count field is repeated for each dispense

position supported by the terminal.
Device ID
Valid Range: CN01
information is for the coin dispenser.
Coin Denomination ID, Position x

Valid Range: A through H
Description: This byte indicates the denomination code of the coins in position x
(x = from 1 up to 4) at the time of the last coin dispense.
NOTE
The Coin Denomination ID field is repeated for each dispense

position supported by the terminal. The field can be initialized
to all @s (no bin) before any coin dispense.
Coins Delivered Count, Position x

5-10
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Description: This field indicates the number of coins dispensed from position
x (x = from 1 up to 4) since the last function command. Coins cannot be
retracted once they are dispensed.
NOTE
The Coins Delivered Count field is repeated for each dispense

position supported by the terminal.
Device ID
Valid Range: XXyy
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
The Device ID field and related status fields can be repeated

for any devices in the terminal.
Buffers to Follow ID
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
Description: The Buffer ID entry is a Group ID that identifies a buffer.
Buffer Data
Field Size: Maximum of 256 characters
Description: The Buffer Data entry contains the data stored in the buffer
identified in the Buffer ID entry preceding this entry.
NOTE
If the message contains multiple Buffer ID and Buffer Data

entries, there is a group separator (1D hex) between each entry.
Rollover Count
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
5-11
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Valid Range:
additional details.

end of the message.
Table 5-2 Consumer Request Message (format 1)
Message Identifier A 1
[ Time Variant Number ] [ - - - ] [ 8 ]
Top-Of-Form Flag - - - 1
Field ID (Buffers) ’9’ 3
Buffer ID [1] 064 - 090, 256 - 299 3
Buffer Data [1] - - - Variable (256 max)
[ Field Separator ] [ hex 1C ] [ 1 ]
[ Rollover 1 Count ] [ - - - ] [ 3 ]
[ Rollover 2 Count ] [ - - - ] [ 3 ]
[ Rollover 3 Count ] [ - - - ] [ 3 ]
[ Rollover 4 Count ] [ - - - ] [ 3 ]
[ MAC Data ] [ - - - ] [ 8 ]

[1] If multiple Buffer ID and Buffer Data entries occur in the message, they are separated
by group separators (1D hex).
The following paragraphs describe the modified or added fields in the Consumer
Request message:
5-12
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Message Identifier
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)
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
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
NOTE
If the message contains multiple sets of Buffer ID and Buffer

Data entries, there is a group separator (hex 1D) between
each set.
5-13
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Solicited Status Messages
5.2 Solicited Status Messages
The terminal’s response to a network transmitted command message is a

Solicited Status message. The maximum length of this message is 256 characters.
The network expects a reply concerning the results of the last function performed
through a Solicited Status message. If an error is detected during the last function
performed, error status data pertaining to the terminal is inserted into the status
message. If the functions are performed as commanded, a Ready status indicator
is inserted into the status message. Refer to Table 5-3 for a list of the data fields
associated with the Solicited Status message.
Table 5-3 Solicited Status Message
[ Message Sequence Number ] [ - - - ] [ Variable (8 max) ]
Status Descriptor - - - 1
[ Device Identifier (DID) ] [ - - - ] [ 1 ]
[ Status ] [ - - - ] [ Variable ]
[ Device Identifier (DID) ] [ - - - ] [ 1 ] [1]
[ Status ] [ - - - ] [ Variable ] [1]
[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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-3 Solicited Status Message (continued)
[ Amount of Coins Dispensed ] [ - - - ] [ 3 ] [2]
[ MDS Status ] [ - - - ] [ Variable ] [3]
[ Field Separator ] [ hex 1C ] [ 1 ] [4]
[ Buffers to Follow ID ] [ 9 ] [ 1 ] [4]
[ Buffer ID ] [ - - - ] [ 3 ] [4]
[ Buffer ID ] [ - - - ] [ 3 ] [4]
[ Rollover 1 Count ] [ - - - ] [ 3 ] [5]
[ Rollover 2 Count ] [ - - - ] [ 3 ] [5]
[ Rollover 3 Count ] [ - - - ] [ 3 ] [5]
[ Rollover 4 Count ] [ - - - ] [ 3 ] [5]

[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).
[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.
The following paragraphs describe the fields for the Solicited Status message:

5-15
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
In the case of the Solicited Status message, this field is 2.
Message Identifier
Valid Range: 2
transmitted. The only valid value for the Solicited Status message is 2.

Valid Range:

Description: The message sequence number is a network-generated number
that identifies the message for tracking. The network can send this number to
the terminal in a Function Command message, Write Command message, or
Operational Command message. The terminal does not use this number, but if
the Message Sequence Number in Solicited Status Messages feature is selected,
message.
If message authentication (MAC) is used, Function Command messages contain

a time variant number in place of the message sequence number. If this is the
case, then the Solicited Status message sent in response to a Function Command
message returns that time variant number rather than a message sequence number.
If the Message Sequence Number in Solicited Status Messages feature is not

selected, this field is empty.
Status Descriptor
5-16
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Description: This one-character field describes the terminal status as it

responded to the command. The valid values are as follows:
• ’8’ - Device Fault or Configuration Information. This character indicates

that a terminal device is reporting abnormal status or configuration
information follows.
• ’9’ - Ready. This character indicates the successful completion of either an

Operational Command message or a Function Command message when the
Separate Ready for Function Command Message feature is not selected.
• ’A’ - General Command Reject. This character indicates the unsuccessful

completion of either an Operational Command message or a Function
Command message. For example, the terminal can report a General
Command Reject in any of the following cases:
- The terminal receives an illegal command from the network

- The terminal receives illegal data from the network
- The terminal receives a Function Command message when it is not
in a Transaction Request state
Refer to Section 5.11 for a list of additional General Command Reject

conditions.
• ’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:
- Function Command message

- Write Command 1 message (states)
- Write Command 6 message (FITs)
• ’D’ - Specific Command Reject. The terminal can send specific reject
reasons to the network. Reject reason codes are described in Section 5.2.21.
• ’J’ - Enhanced Status. If a J is sent as the status descriptor, this message

contains status for one of the enhanced status devices. Refer to
Section 5.2.19 for further details.
Device Identifier (DID)

Description: When graphic ’8’ or ’C’ appears in the Status Descriptor field, this
one-character field identifies the device reporting the abnormal status as follows:
• If Status Descriptor field is ’8’, the status bytes following this field are
defined as follows:
- ’1’ - Not used
5-17
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
- ’2’ - Receipt printer or journal printer
- ’3’ - After Hour depository
- ’4’ through ’6’ - Not Used
- ’7’ - Enhanced function command
- ’8’ - Dispenser (911 mode)
- ’9’ - Presenter (Withdrawal Door status) (911 mode)
- ’:’ - Depository (envelope depository) (911 mode)
- ’;’ - Trap
- ’<’ - Configuration ID
- ’=’ - Card reader
- ’>’ - Card writer
- ’?’ - Dispenser (912 mode)
- ’@’ - Presenter (Withdrawal Door status) (912 mode)
- ’A’ - Depository (envelope depository or IDM) (912 mode)
- ’B’ - Hardware configuration
- ’C’ - Check point (912 mode)
- ’D’ - Cassette (912 mode). This device identifier is also used to indicate
that the statement printer is ready for more information (912 mode)
- ’E’ through ’F’ - Not used
- ’G’ - Coin dispenser (912 mode)
- ’H’ - Supply counts
- ’I’ - External Options Module (Enhanced Alarms Interface)
When the network sends an Operational Command message requesting

configuration information, the terminal responds with a status descriptor of
’8’ and the following information:
- In 911 mode: Configuration ID ( ’<’ ) and Hardware Configuration

status (’B’)
5-18
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
- In 912 mode: Configuration ID ( ’<’ ), Hardware Configuration status

(’B’), Check Point status (’C’), and Cassette status (’D’)
• If the Status Descriptor field is ’C’, this field contains one of the following
characters, and no device status bytes follow:
- ’1’ - Message Authentication Code (MAC) failure. The results of the

MAC calculation on a message did not equal the data in the MAC data
field.
- ’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
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.
EXAMPLE - ASCII 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.
EXAMPLE - EBCDIC Network
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.
Amount of Coin Dispensed

Valid Range: See description
Description: This is an optional field included in the Solicited Status message
for the coin dispenser only if the Function Command message that contained the
dispense command used the Dollar Amount of Coins field to determine the coin
dispense amount (Section 5.5). The range of this field is 000 to 499 ($0.00 to
$4.99) for coin dispensers equipped with a $1.00 denomination bin. Without the
$1.00 bin, the range of the field is limited to 000 to 099.
MDS Status
5-19
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
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
Buffer ID
Buffer Data
Valid Range: For each character, 0 through 9, A through Z, a through z, + / and =
NOTE

Rollover Count
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

end of the message.
5-21
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.1 Solicited Status Definitions
This section contains tables for the solicited status of the following components:
• Printer (DID = ’2’)

• After Hour depository (DID = ’3’)
• Card reader (DID = ’>’)
• Card writer (DID = ’=’)
• Dispenser (DID = ’8’ for 911 and ’?’ for 912)
• Presenter (Withdrawal Door status) (DID = ’9’ for 911 and ’@’ for 912)
• Depository (DID = ’:’ for 911 and ’A’ for 912)
• Configuration ID (DID = ’<’)
• Cassette (912 mode only) (DID = ’D’)
• Check point (912 mode only) (DID = ’C’)
• Coin dispenser (912 mode only) (DID = ’G’)
• Supply counts (DID = ’H’)
For Trap status (DID = ’;’), no status bytes are reported to the network.
As an option, a network can customize status data to send more descriptive

status messages to the network. For more details on status customization,
5-22
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.2 Printer Status (solicited) (DID = ’2’)
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.
Table 5-4 Printer Solicited Status (DID = ’2’)
Byte Bit Abbreviated Bit Definition Detailed Bit Definition
0 7 Print operation complete If this bit is set, the print operation has been completed.
6-5 ----- Not applicable
4 Data format error, cannot print
3 Passbook printer has faulted A fault has occurred on the passbook printer which requires
attention.
NOTE
Currently the passbook printer is not supported.
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.
6 ----- Not applicable
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.
4 ---- Not applicable
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-4 Printer Solicited Status (DID = ’2’) (continued)
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.
1 Fault occurred during a head return on the Refer to bit 2.

receipt printer
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.
• An electrical failure of the paper margin sensor. This

sensor indicates where on the form to begin printing.
• A failure of the printer electronics to send back a ready

signal when commanded to print a line.
2 7 Journal printer has run out of paper This fault is normally caused by a depleted journal printer
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
service assistance.
4-3 ---- Not applicable
5-24
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-4 Printer Solicited Status (DID = ’2’) (continued)
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.
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 can also be caused by an electronic
failure, caused by a failure of the printer electronics to send a
ready signal to the terminal’s microcomputer that indicates
task completion.

journal printer
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.
• An electrical failure of the paper margin sensor. This

sensor indicates where on the form to begin printing.
• A failure of the printer electronics to send back a ready

signal when commanded to do a line print.
5-25
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.3 After Hour Depository Status (solicited) (DID = ’3’)
There is one byte for After Hour depository (AHD) solicited status. See
Table 5-5 for detailed bit definitions.
Table 5-5 After Hour Depository Solicited Status (DID = ’3’)
0 7 ----- Not applicable
6 Door open at timeout or cancel
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.
1 AHD will not lock There might be a jam in the mechanism or an

electromechanical malfunction. Attention is required to clear
the jam or service the mechanism.
0 AHD will not open There is an electromechanical malfunction. Attention is

required to service the mechanism.
5-26
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.4 Card Reader Status (solicited) (DID = ’>’)
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.
Table 5-6 Card Reader Solicited Status (DID = ’>’)
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.
5 Track 2 read error
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.5 Card Writer Status (solicited) (DID = ’=’)
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.
Table 5-7 Card Writer Solicited Status (DID=’=’)
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.
6-1 Card write error limit exceeded Not applicable
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.
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 write
and allows future card writes. Soft failure refers only
to card motion and not card write errors.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.6 Dispenser Status 911 Mode (solicited) (DID = ’8’)
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.
6 --- Not applicable
5 HI performance low The HI side has had an unusually high number of

mispicks. Call Service when convenient.
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
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
Any one or combination of these faults sets the hard

fault bit (bit 0) 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-8 Dispenser Solicited Status for 911 Mode (DID = ’8’) (continued)
5 LO performance low The LO side has had an unusually high number of

mispicks. Call Service when convenient.
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
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
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
Any one or combination of these faults sets the hard

fault bit (bit 0) 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)
4 (HI de- 7-4 --- Not applicable

nomination
Status)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
5 (LO de- 7-4 ---- Not applicable

nomination
Status)
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)
5-31
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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)
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:
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).
7 (Machine 7-6 ---- Not applicable

Fault Status
#2)
5-32
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
• A HI-side transport exit sensor fails
Dispensing stops. This condition must be cleared

before initiating another dispense. This fault might
require service assistance. This condition also sets the
following bits:
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
• A LO-side transport exit sensor fails
Dispensing stops. This condition must be cleared

before initiating another dispense. This fault might
require service assistance. This condition also sets the
following bits:
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.7 Dispenser Status 912 Mode (solicited) (DID = ’?’)
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 = ’?’)
Byte Abbreviated Byte Definition Detailed Byte Definition
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.
3 Partial Dispense Status This byte defines dispense status as follows:

0 - Good dispense (bills dispensed = bills requested)
1 - Not applicable
2 - Bad dispense, continuation not possible
3 - Dispense is not possible (no money was dispensed)
4 - Denomination error after redefining the denominations present, a
second try is possible
5 - Good partial dispense, continuation is possible (bills dispensed =/ bills
requested), possibly out of bills
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)
5 Denomination ID This byte equals the denomination ID of the corresponding cassette

position in byte 4 of this message. The valid characters are as follows:
A through H - Type of bill
a through h - Type of bill that is low or empty
J - Denomination ID cannot be read
@ - No cassette present
_ (underscore) - No feed module present
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.
10 - 12 --- Not applicable (set to 000)
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.
31 - 39 Dispenser Status for fourth cassette These bytes contain the dispenser status of the fourth cassette position.
5-34
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-10 Dispenser Error Codes
Error Code Error Type Partial Dispense Is Repair

(bytes 1 and Status Field Required?
2 in Table 5-9) (byte 3 in Table [1]
5-9)
00 No error 0 No
01 Unsolicited bill from cassette position 1 (top) 2 No
02 Unsolicited bill from cassette position 2 2 No
03 Unsolicited bill from cassette position 3 2 No
04 Unsolicited bill from cassette position 4 (bottom) 2 No
09 Stream feed from cassette position 1 (top) 5 No
10 Stream feed from cassette position 2 5 No
11 Stream feed from cassette position 3 5 No
12 Stream feed from cassette position 4 (bottom) 5 No
17 Feed Failure from cassette position 1 (top) 5 No
18 Feed Failure from cassette position 2 5 No
19 Feed Failure from cassette position 3 5 No
20 Feed Failure from cassette position 4 (bottom) 5 No
25 Jam before double-detect switch from cassette position 1 (top) 2 Yes
26 Jam before double-detect switch from cassette position 2 2 Yes
27 Jam before double-detect switch from cassette position 3 2 Yes
28 Jam before double-detect switch from cassette position 4 (bottom) 2 Yes
33 Jam between double-detect switch and exit throat 2 Yes
34 Jam between double-detect switch and divert throat 2 Yes
35 Denomination error 4 No
36 Unidentified cassette 3 Yes
37 During dispenses, the diverter cannot go to the exit position 2 Yes
38 During dispenses, the diverter cannot go to the divert position 2 Yes
39 Double bill dispensed 2 No
40 Long or Short bill dispensed 2 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
(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
(bottom)
57 Bill dispenser received invalid data 3 Yes

[1] Repair refers to corrective action that cannot be done by the institution’s operator and is done by a Service Representative.
5-35
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-10 Dispenser Error Codes (continued)
Error Code Error Type Partial Dispense Is Repair

(bytes 1 and Status Field Required?
2 in Table 5-9) (byte 3 in Table [1]
5-9)
58 Too many bills dispensed 5 No
59 Timing wheel error 2 Yes
60 Feed, exit, or divert sensor blocked 2 Yes
63 Bill dispenser RAM error 3 Yes
64 Bill dispenser USART error 3 Yes
65 Cassettes shuffled 4 No
67 Diverter does not energize 2 Yes
68 Diverter in wrong position at start of dispense 2 Yes
78 Divert cassette is full 2 No
79 Divert cassette is not present 3 No
80 No cassette in feed module for test dispense 3 No
81 Dispense timeout 2 Yes
82 Not used
83 Linear Variable Differential Transformer (LVDT) double-detect, out of limits 2 Yes
84 Purge error following dispense error 2 Yes
90 Communication timeout 3 Yes
91 Communication data invalid 2 Yes
92 Excessive NAKs for a command 3 Yes
93 Not used
94 Unreported problem with feed module 1 (top) 0 No
95 Unreported problem with feed module 2 0 No
96 Unreported problem with feed module 3 0 No
97 Unreported problem with feed module 4 (bottom) 0 No

[1] Repair refers to corrective action that cannot be done by the institution’s operator and is done by a Service Representative.
5-36
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:
• 00 - Fault on present - consumer did not have access to cash

• 04 - Fault on present - consumer had access to cash
• 07 - No stack to present
• 30 - Money forgotten (the consumer did not take the cash)
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:

• 04 - Fault on present - consumer had access to cash, or no stack to present
5-37
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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 = ’:’)
0 (depository 7 --- Not applicable

status)
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.
1 (printer 7-5 --- Not applicable

module fault
status)
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
5-38
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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’)
0 (depository 7 --- Not applicable

status)
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.
1 (printer 7-5 ---- Not applicable

module fault
status)
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
3 Thousands module error The deposit thousands-digit print module has not increased to
2 Hundreds module error The deposit hundreds-digit print module has not increased to
1 Tens module error The deposit tens-digit print module has not increased to the
0 Units module error The deposit units-digit print module has not increased to the
2 (exit path) 7-0 Sequence ID The program exit path at the time of the fault (for service use
only).
5-39
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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’)
0 (depository 7 Abnormal document retain Abnormal document retain

status)
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.
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
2 7 Depository disabled The IDM has been disabled either due to a fault or by the
network.
6-5 ---- Reserved. Set to 0
5-40
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
0 MICR hardware error MICR processor fault.
3 7-4 Operation data Four bits of operation data defined as follows:

• 0000 - Reserved
• 0001 - Envelope deposit
• 0010 - Check deposit
• 0011 - Check retain
• 0100 - Return check with printing
• 0101 - 1111 - Reserved
3-0 Bin data Four bits of Bin data defined as follows:

• 0000 - bin 0
• 0001 - bin 1
• 0010 - bin 2
And so on.
5-41
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.13 Configuration ID Status (solicited) (DID = ’<’)
When the network sends a Request ID Operational Command message to the

terminal, one of the statuses sent is the Configuration ID status. This status
contains the configuration ID of the terminal as sent in a download and the
operating status of the terminal. Refer to Table 5-14 for detailed bit definitions
of this status.
Table 5-14 Configuration ID Solicited Status (DID = ’<’)
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.
3 7-1 ----- Not applicable
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.14 Cassette Solicited Status (912 mode only) (DID = ’D’)
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.
Table 5-15 Cassette Solicited Status (912 mode) (DID = ’D’)
Byte Bit Abbreviated Bit Detailed Bit Definition

Definition
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
Cassette Normal Currency No No Feed Denom-

Denomination Condition Supply Low Cassette Module ination ID
Present Present Cannot Be
Read
B0 B1 B0 B1 B0 B1 B0 B1 B0 B1
A < 1 > 1 < 0 = ? < :
B < 2 > 2 < 0 = ? < :
C < 3 > 3 < 0 = ? < :
D < 4 > 4 < 0 = ? < :
E < 5 > 5 < 0 = ? < :
F < 6 > 6 < 0 = ? < :
G < 7 > 7 < 0 = ? < :
H < 8 > 8 < 0 = ? < :
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.15 Check Point Status (solicited) (DID = ’C’)
When the network sends an Operational Command message requesting

configuration information to an Agilis 91x for ix/CSP terminal operating in 912
mode, the terminal sends the Check Point status bytes (Table 5-16) with the
configuration ID, the Hardware Configuration status bytes, and the Cassette
status bytes. Also, if the consumer cancels the transaction while the terminal
is waiting for a Function Command message, or the terminal is processing a
function command, a reject code of 58 is sent in a Solicited Status message
along with the Check Point status.
Table 5-16 Check Point Status Bytes (912 Mode) (DID = ’C’)
Byte Definition Detailed Definition
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):
; 2 ( ’2’ ) - Receipt printer or journal printer
;3 ( ’3’ ) - After Hour depository
; = ( ’ = ’ ) - Card reader
; > ( ’ > ’ ) - Card writer
; ? ( ’ ? ’ ) - Bill dispenser
< 0 ( ’@’ ) - Presenter
< 1 ( ’A’ ) - Depository (envelope depository or IDM)
< 7 ( ’G’ ) - Coin Dispenser
9 Last message coordination Status byte 9 contains the message coordination number that the network put in the
number last Function Command message.
Table 5-17 Check Point/Function ID Cross Reference
Check Point Status 912 Function ID Check Point Status 912 Function ID
; 4 ’4’ < = ’M’
; 5 ’5’ = 0 ’P’
; 6 ’6’ = 1 ’Q’
< 1 ’A’ = 2 ’R’
< 2 ’B’ = 3 ’S’
< 3 ’C’ = 4 ’T’
< 4 ’D’ = 5 ’U’
< 5 ’E’ = 6 ’V’
5-44
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-17 Check Point/Function ID Cross Reference (continued)
< 6 ’F’ = 7 ’W’
< 7 ’G’ = 8 ’X’
< 8 ’H’ = 9 ’Y’

< < ’L’ = : ’Z’
5-45
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.16 Coin Dispenser (solicited) (DID = ’G’)
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’)
Byte Abbreviated Byte Definition Detailed Byte Definition
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.
5-46
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-19 Coin Dispenser Error Codes
Error Code (Bytes 1 Error Type Partial Dispense Is Repair

and 2 in Table 5-18) Status Field (Byte Required [1]
3 in Table 5-18)
00 No error 0, 5 No
01 Unsolicited coin from feed module 1 (front) 2 No
02 Unsolicited coin from feed module 2 2 No
03 Unsolicited coin from feed module 3 2 No
04 Unsolicited coin from feed module 4 (back) 2 No
17 Feed failure from feed module 1 (front) 5 No
18 Feed failure from feed module 2 5 No
19 Feed failure from feed module 3 5 No
20 Feed failure from feed module 4 (back) 5 No
25 Jam failure from feed module 1 (front) 2 Yes
26 Jam failure from feed module 2 2 Yes
27 Jam failure from feed module 3 2 Yes
28 Jam failure from feed module 4 (back) 2 Yes
33 Jam between picker and delivery sensors 2 Yes
35 Denomination error 4 No
35 RAM error 3 Yes
58 Too many coins dispensed 2 Yes
60 Delivery sensor blocked 2 Yes
63 Coin dispenser RAM error 3 Yes
8A Feed module 1 (front) coin sensor stuck clear/blocked 2 Yes
8B Feed module 2 coin sensor stuck clear/blocked 2 Yes
8C Feed module 3 coin sensor stuck clear/blocked 2 Yes
8D Feed module 4 (back) coin sensor stuck clear/blocked 2 Yes
90 Communication timeout 3 Yes

[1] Repair refers to a corrective action that cannot be performed by the institution’s operator and is usually performed by a service
representative.
5-47
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.17 Supply Counts (solicited) (DID = ’H’)
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:
• 9 or : (colon character) - Basic supply counts (Table 5-20)

• ; (semicolon character) or < - Enhanced supply counts (Table 5-21)
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.
Table 5-20 Supply Counts Solicited Status (DID = ’H’)
Number of Abbreviated Byte Definition Detailed Byte Definition

Bytes.
4 DP01 Indicates the counts to follow are from the depository.
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.
1 Group separator hex 1D
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 Record separator hex 1E
1 Denomination ID position 1 This byte indicates the denomination ID of the cassette in position
1.The valid range is A through H.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-20 Supply Counts Solicited Status (DID = ’H’) (continued)

Bytes.
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.
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.
is 00000 through 65535.
(bottom) position (excludes bills sent to the divert cassette) from cassette
position 4 (bottom) since the last time the counter was cleared. The
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-21 Enhanced Supply Counts Solicited Status (DID = ’H’)

Bytes
4 DP01 Indicates the counts to follow are from the depository.
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.
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.
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.
1 Record Separator hex 1E

[1] These field are present only for terminals equipped with an IDM.
5-50
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-21 Enhanced Supply Counts Solicited Status (DID = ’H’) (continued)

Bytes
(top) position (excludes bills sent to the divert cassette) from cassette
position 1 (top) since the last time the counter was cleared. The
is 00000 through 65535.
is 00000 through 65535.
(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.
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-51
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Bytes
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
accesable to the consumer but might not have been taken, and
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
5 Loaded Count, Position 1 These bytes indicate the number of coins loaded in the bin in
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-52
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Bytes
1 Field Separator hex 1C
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.
5.2.18 External Options Module Status (solicited) (DID = ’I’)
There is one byte for External Options Module solicited status. The following
statuses can occur:
• 01 - Network fault. The network attempted to perform an operation using

a device that is not present or is not enabled. The device is either the
signage unit or the solenoid safe lock.
• 02 - Internal communications error. An error occurred in communications

between and the signage unit.
5-53
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.19 Enhanced Status (solicited) (Status Descriptor = ’J’)
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)
The format of an enhanced status is as follows:
• Operation Sequence Number. This is a three-character field with a range of

001 through 009. This field indicates which function caused the status. For
example, if the statement printer is directed to do a print, then a deliver, then
a retain and this field is 002, the second function (the deliver function ) is
the function that caused the status.
• 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:
- LT01 - Lead-through indicators

- PB01 - Passbook printer
NOTE
- SP01 - Statement printer
• 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 Descriptor J
Field Separator hex 1C
Operation Sequence Number 002
Device ID SP01
Fault Status :3D:00:04
The operation sequence number 002 indicates that the fault was caused by the
second operation in the Function Command message.
5-54
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.20 Other 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.
Hardware Configuration Status

There are several levels of hardware configuration status, depending on
configuration options and Write Command 3 settings. These levels are as follows:
• Standard Hardware Configuration status

• Expanded Hardware Configuration status
• Double Expanded Hardware Configuration status
• Additional Hardware Configuration status
Standard Hardware Configuration Status

The standard hardware configuration status sent to the network in response to an
Operational Command message that requests configuration information is eight
bytes and is shown in Table 5-22 (shown as bytes 0 to 7). This status is always
sent in response to a configuration request, regardless of any configuration
options or Write Command settings.
Table 5-22 Hardware Configuration Status Bytes
Byte Bit Definition
0 7-0 Terminal type (01 for 911 mode, 02 for 912 mode (international), 03 for 912 mode (domestic))
1 7 Reserved (always 0)
6 Card reader type (0 for motorized or dip, 1 for swipe-style)
5 Enhanced deposit printer (1 if present)
4 Reserved (always 0)
3 Visa PIN PROM (always 1)
5 After Hour depository (1 if present and enabled)
4 DES PIN hardware (always 1)
3 Journal printer (1 if present and enabled)
2 Card reader (1 if present and enabled)
0 Depository (1 if present and enabled)
3 7-0 Reserved (always 00)
5-56
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-22 Hardware Configuration Status Bytes (continued)
Byte Bit Definition
4 Seventh entry of the machine number
3-1 Reserved (always 0)
0 Eighth entry of the machine number
5 If 0, double expanded hardware configuration compatible; if 1, double expanded hardware

configuration not available
4 Receipt printer type (0 for non 80-column, 1 for 80-column)
3 Receipt printer (1 if present and enabled)
2 Consumer display (1 if present and enabled)
1 Reserved
0 Bill dispenser (1 if present and enabled)
Expanded Hardware Configuration Status

When the expanded hardware configuration status feature is selected in the
Miscellaneous Features 2 field of the Write Command 3 message (Section 4.13),
the terminal sends 16 (0 to 15) bytes of hardware configuration status data. This
data includes the eight bytes of the standard hardware configuration status
(Table 5-22) plus the eight bytes of data shown in Table 5-23 (shown as bytes
8 to 15).
Table 5-23 Expanded Hardware Configuration Status Bytes
Byte Bit Definition
8 7 Function keys (0 for four keys, 1 for eight keys)
3 Receipt printer paper selection (0, paper with top-of-form mark, 1, blank paper)
2 Consumer display grid (0 if 32-by-16, 1 if 40-by-20)
1 Function keys mapped to ABCD (0 if right keys, 1 if left keys)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-23 Expanded Hardware Configuration Status Bytes (continued)
Byte Bit Definition
1 Denomination ID B
0 Denomination ID A
11 7 Check depository
6 Coin dispenser
5 Electronic Data Capture (EDC)
4 Color Graphics Feature (1 if present)
0 Dip card reader (1 if present)
12 7-0 Reserved (always FF)
13 7 Enhanced Monochrome Graphics (EMG) present (1 if present)
6 EMG Battery backup (1 if battery backed-up)
5-4 Site 3 type

00 - RAM
01 - PROM
02 - Unknown
3-2 Site 2 type

00 - RAM
01 - PROM
02 - Unknown
1-0 Site 1 type

00 - RAM
01 - PROM
02 - Unknown
6-5 Reserved (always 0)
4-3 Function key configuration

00 - Four right-side keys mapped to ABCD
01 - Four left-side keys mapped to ABCD
10 - Eight keys, right side mapped to ABCD, left side mapped to FGHI
11 - Twelve keys, right side mapped to ABCD, left side mapped to FGHI, color keys mapped to JKLM
2-1 Receipt printer vendor (always 10)
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).
Double Expanded Hardware Configuration Status

If the double expanded hardware configuration status feature is selected in the
Miscellaneous Features 3 field of the Write Command 3 message (Section 4.23),
additional bytes (at least eight, starting with byte 16) of hardware configuration
status can be sent (Table 5-24). The length of the double expanded hardware
configuration is variable and might exceed this additional eight bytes in the future.
5-58
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-24 Double Expanded Hardware Configuration Status Bytes
ByteE Bit Definition
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
6 Voice Option (1 if present)
5 Reserved
4 Track 1 and track 2 card writer
3 Smart card (chip card) reader
2 VGA Plus (reserved)
1 VGA Plus with 512K video memory
0 VGA Plus with 256K video memory
19 Reserved (always 00), if undefined
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.
22 - NN Reserved (always 00), if undefined
Additional Hardware Configuration Status

Additional configuration status can be appended to the message. This status
follows the double expanded hardware configuration status if the configuration
options are set to: Transaction Host, Messages Settings, Status Message, Send
maximum hardware configuration.
The devices that have status reported this way are as follows:
• ED01DK - Double-length DES keys

• EP01 - Keypad
• LT01 - Lead-through indicators
• MP01 - Media Player
• PB01 - Passbook printer
NOTE
• PR01 - Receipt printer

• SD01xy - Envelope dispenser
5-59
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• SP01 - Statement printer

• TS01 - Touch screen (not applicable on the CashSource Plus 400)
This data is in a slightly different format from the other hardware configuration
status. The format of this data is as follows:
Record Separator (RS) hex 1E
Device ID 4 bytes
Configuration information Variable bytes (not all devices use these bytes)
This information is repeated as needed, one record per device.
An example of a configuration message with double expanded hardware status

set and additional devices present appears as follows:
22 |FS |FS |FS 8

|FS <(four bytes of Config ID)
|GS B (at least 24 bytes of hardware configuration)
|RS SP01
|RS TS01
|RS LT01
|GS C (10 bytes of checkpoint status in 912 mode)
|GS D (4 bytes of cassette status in 912 mode)
Presently, the only devices that require the configuration information bytes
are as follows:
• Double-length DES keys for the DK designation
• Keypad. The designation 04 is added if the keypad is an EPP4. The

designation RK is added if the keypad supports the Remote Key Transport
feature.
• Envelope dispenser. The configuration information for the envelope

dispenser is in the form of xy where:
5-60
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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).
• Media Player. The configuration information for the media player is a

four-character revision number.
• Statement printer. Agilis 91x for ix/CSP sends a large amount of

configuration information as part of the record (Table 5-28).
5-61
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-25 Receipt Printer Hardware Configuration Data

Characters
Record Separator (RS) hex 1E 1
Printer Device ID PR01 4
Unit Separator (US) [1] hex 1F 1
Printer Vendor - - - Variable
Printer Model Number - - - 1
Printer Hardware Revision Number - - - Variable
Printer Software Revision Number - - - Variable
Printer Horizontal Resolution (dots per inch) - - - 3
Printer Vertical Resolution (dots per inch) - - - 3
Printer Primary Character Set - - - 3
Printer Alternate Character Set 1 - - - 3
Printer Retain Flag - - - 1
Printer Landscape Flag - - - 1
Printer Print File Flag - - - 1
Printer Logo Flag - - - 1
Printer Double Wide Flag - - - 1
Printer Bold Flag - - - 1
Printer Underline Flag - - - 1
Printer Margin Flag 0 1
Printer Horizontal Tab Flag 0 1
Printer Vertical Tab Flag 0 1
Printer Bar Code Flag 0 1
Printer Form Feed No Cut Flag 0 1
Printer Standard Graphics Flag 0 1
Printer Compressed Margin Flag - - - 1

[1] If the terminal is equipped with a statement printer emulating a receipt printer, all unit separators are
replaced by vertical tab characters (VT, hex 0B).
The following paragraphs describe the fields in the Receipt Printer Hardware
Configuration message.
5-62
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
Valid Range: PR01
Description: This is the device ID for the receipt printer.
Printer Vendor
Description: This is the vendor name of the hardware receipt printer device.
Printer Model Number

Description: For ixSeries terminals, the value in this field is always ? (ASCII
hex 3F).
Printer Hardware Revision Number

Description: For ixSeries terminals, the value in this field is always ? (ASCII
hex 3F).
Printer Software Revision Number

Description: This is the software revision number reported by the receipt
printer device.
Printer Horizontal Resolution (dots per inch)

Valid Range: 203 and ???
Description: For ixSeries terminals, the value in this field is always ???.
Printer Vertical Resolution (dots per inch)

Valid Range: 203 and ???
Description: For ixSeries terminals, the value in this field is always ???.
Printer Primary Character Set

Valid Range: 000 through 255 (Table 5-26)
Description: For ixSeries terminals, the value in this field is always 001,
regardless of the primary character set selected during configuration.
5-63
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-26 Agilis 91x for ix/CSP Printer Character Set Codes
Character Set Code Character Set
001 Standard English
002 Standard Optional
003 Greek
004 Portuguese
005 Cyrillic/Latvian
006 Hungarian/Latin
007 Turkish
008 Hebrew
009 Arabic
010 Lithuanian
011 Custom 1
012 Custom 2
015 Arabic Script
018 Code Page 850
Printer Alternate Character Set 1

Description: This is the Agilis 91x for ix/CSP character set code to describe the
character set selected using ESC 4 or VT.

character set selected using ESC z 1.
Printer Retain Flag

Description: This flag defines whether or not the receipt printer is capable of
retaining a form. 0 is defined as not capable, 1 is defined as capable. For ixSeries
terminals, the value in this field is always 1.
Printer Landscape Flag

Description: For ixSeries terminals, the value in this field is always 0.
Printer Print File Flag

Printer Logo Flag

5-64
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Printer Double Wide Flag

Printer Bold Flag

Printer Underline Flag

Description: For ix/CSP Series and non-Diebold terminals, the value in this
field is always 0.
Printer Margin Flag

Valid Range: 0
Description: This field is reserved for compatibility with TCS.
Printer Horizontal Tab Flag

Valid Range: 0
Printer Vertical Tab Flag

Valid Range: 0
Printer Bar Code Flag

Valid Range: 0
Printer Form Feed No Cut Flag

Valid Range: 0
Printer Standard Graphics Flag

Valid Range: 0
Printer Compressed Margin Flag

Valid Range: 0
Description: The value in this field is always 0.
5-65
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-27 shows an example of the hardware configuration reported by the

48-column thermal receipt printer. Character sets supported are Standard English
(001), Standard Optional (002), and Arabic (009).
Table 5-27 Example Hardware Configuration Data for Diebold 48-column Thermal Receipt Printer

Characters
Printer Device ID PR01 4
Unit Separator (US) hex 1F 1
Printer Vendor Diebold 7
Printer Model Number ? 1
Printer Hardware Revision Number ? 1
Printer Software Revision Number 2 1
Printer Horizontal Resolution (dots per inch) ??? 3
Printer Vertical Resolution (dots per inch) ??? 3
Printer Primary Character Set 001 3
Printer Alternate Character Set 1 002 3
Printer Alternate Character Set 2 009 3
Printer Retain Flag 1 1
Printer Landscape Flag 0 1
Printer Print File Flag 0 1
Printer Logo Flag 0 1
Printer Double Wide Flag 0 1
Printer Bold Flag 0 1
Printer Underline Flag 0 1
Printer Margin Flag 0 1
Printer Horizontal Tab Flag 0 1
Printer Vertical Tab Flag 0 1
Printer Bar Code Flag 0 1
Printer Form Feed No Cut Flag 0 1
Printer Standard Graphics Flag 0 1
Printer Compressed Margin Flag 0 1
5-66
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-28 Statement Printer Hardware Configuration Data

Characters
Printer Device ID SP01 4
Vertical Tab (VT) hex 0B 1
Printer Vendor DIEBOLD 7
Printer Model Number - - - 1
Printer Hardware Revision Number - - - Variable
Printer Software Revision Number - - - Variable
Printer Horizontal Resolution (dots per inch) 203 3
Printer Vertical Resolution (dots per inch) 203 3
Printer Primary Character Set - - - 3
The following paragraphs describe the fields in the Statement Printer Hardware
Configuration message.
Printer Device ID
Valid Range: SP01
Description: This is the device ID for the statement printer.
Printer Vendor
Valid Range: DIEBOLD
Description: This is the vendor name of the hardware statement printer device.
Printer Model Number

Description: This is the model number reported by the hardware statement
printer device.
Printer Hardware Revision Number

Description: This is the hardware revision number reported by the hardware
statement printer device.
Printer Software Revision Number

5-67
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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).
Printer Horizontal Resolution (dots per inch)

Valid Range: 203
Description: This field indicates the horizontal resolution of the statement
printer in dots per inch.
Printer Vertical Resolution (dots per inch)

Valid Range: 203
Description: This field indicates the vertical resolution of the statement printer in
dots per inch.
Printer Primary Character Set

primary character set selected during configuration.

character set selected using ESC 6 or VT.

character set selected using ESC z 1.
5-68
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.2.21 Message Reject Reason Codes
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:
Transaction Host, Message Settings, Status message, Send Reject reason

Codes
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.
Table 5-29 Reject Reason Codes Message

Characters
Solicited Status 2 1
Status Message Identifier 2 1
[ Message Sequence Number ] [ - - - ] [ Variable (8 max) ]
Status Descriptor D 1
Host Message Identifier - - - 1
Host Message Subidentifier - - - 2
Reject Reason Code - - - 2
[ Field Separator (FS) ] [1] [ hex 1C ] [ 1 ]
[ Check Point Status ID ] [1] [ C ] [ 1 ]
[ Function Identifiers ] [1] [ - - - ] [ 8 ]
[ Last Device Status ID ] [1] [ - - - ] [ 1 ]
[ Last Message Coordination Number ] [1] [ - - - ] [ 1 ]
End of Text (ETX) hex 03 1

[1] These fields are only included if the Reject Reason Code field is 58, Cancel key was
pressed during function command execution.
The following paragraphs describe the fields different from the standard
Solicited Status message.
5-69
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Host Message Identifier

Valid Range: 1, 3, 4, 5, 6, and 7
Description: This is a one-byte ASCII field taken from the first byte of the
message sent by the network, thus indicating whether the message was an
Operational Command message (’1’), a Write Command message (’3’), a
Function Command message (’4’), Enhanced Operational Command message
(’5’), Enhanced Write Command message (’6’), or an Enhanced Function
Command message (’7’). Values other than these indicate an error condition
(code 01).
Host Message Subidentifier

Description: This is a two-byte ASCII field used to further identify the message
which was sent by the network. The first byte of the field is called the class, and
the second byte of the field is called the modifier. The values of these two bytes
are set as shown in the following table.
State Tables (Write Command 1) 1 = Class

2 = Modifier
Screens (Write Command 2) 1 = Class

1 = Modifier
LUNO, parameters, and timers (Write Command 3) 1 = Class

3 = Modifier
Open Account Relationship case (Write Command 5) 2 = Class

1 = Modifier (default)
FIT data (Write Command 6) 1 = Class

5 = Modifier
Encryption Key Change case (Write Command 7) 3 = Class

x = Modifier (key command code sent)
Configuration ID (Write Command 8) 1 = Class

6 = Modifier
EMG - Icon Definition (Write Command 13) 1 = Class

; = Modifier
EMG - Font Definition (Write Command 14) 1 = Class

< = Modifier
EMG - Cell Definitions (Write Command 15) 1 = Class

= = Modifier
Operational Command case 1 = Class

x = Modifier (command sent)
Function Command case 1 = Class

x = Modifier (function ID that there was a problem with)
Reject Reason Code

5-70
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
There are reasons for rejecting a message that do not have a

Reject Reason Code assigned. If no specific code is specified,
a 99 code is sent. This code can mean anything that is not
specifically coded.
Table 5-30 Reject Reason Codes
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).
06 FIT, Screen, or State Number is outside of the valid range.
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.
08 Message is too long for Receive Buffer.
09 Reserved
OPERATIONAL COMMAND CASE
10 The command code is out of range.
11 The ATM is busy (in use), and the Operational Command message cannot be processed.
12 Incorrect modifier field
13 Reserved
GENERAL WRITE COMMAND CASES
14 The write identifier is out of range.
15 The modifier field is out of range.
16 Reserved
WRITE COMMAND 7 CASES - ENCRYPTION KEY CHANGES
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.
19 Decrypted key does not have correct parity.
20 - 21 Reserved
WRITE COMMAND 2 CASES - SCREENS
5-71
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-30 Reject Reason Codes (continued)
Code Reason
22 The message contained illegal oriental screen data. (Write Command 11 only).
23 The message contained illegal touch screen data.
24 Reserved
WRITE COMMAND 1 CASES - STATE TABLES
25 There are not eight three-character numeric entries in a state table data field.
26 - 29 Reserved
WRITE COMMAND 3 CASES - LUNO, PARAMETERS, & TIMERS
30 There are too many characters in the overall parameter field.
31 An improper LUNO field was detected.
32 The entry in a Timer Number field exceeds 31.
33 The entry in a timer’s Number of Ticks field exceeds 255.
34 - 39 Reserved
WRITE COMMAND 8 CASES - CONFIGURATION ID
40 An invalid configuration ID number was found.
41 - 44 Reserved
OPEN ACCOUNT RELATIONSHIP (OAR) CASES
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.
47 An invalid display flag was found.
48 - 49 Reserved
FUNCTION COMMAND CASES
50 A field separator character is missing after the bill denomination field(s).
51 At least one bill denomination field is out of range.
52 The transaction serial number is invalid.
53 An illegal function ID was found.
54 Message format is incorrect in an Enhanced Function Command message.
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.
57 An illegal printer flag was found.
58 Cancel key was pressed during function command execution.
59 The message contained multiple function IDs of the same type.
60 The amount authorized did not match the amount requested.
5-72
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-30 Reject Reason Codes (continued)
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
WRITE COMMAND 13, 14, 15 CASES---EMG CONFIGURATION
68 - 79 Reserved
GENERAL CASES
80 A Base64 conversion failure occurred.
81 The Tag field is invalid.
82 An incorrect length was specified.
83 The command is not supported with the current hardware.
84 - 98 Reserved
99 The message has an error not covered by one of the preceding codes.
Examples of Reject Cases

An operational command is rejected because it is out of range. A reject code of
10 is generated, and the following reject message is sent by the ATM:
22\#L\\D\11x10
where #L = LUNO, and x = the bad operational command ID.
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.
A function command is rejected because the function specified is illegal or

non-existent. A reject code of 53 is generated, and the following reject message
is sent by the ATM:
22\#L\\D\41x53
where #L = LUNO, and x = the bad function ID.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
where #L = LUNO.
NOTE
Check Point status is not valid for enhanced functions.
Check Point Status ID

Valid Range: C
Description: This one character field indicates that the information following is
Check Point status.
Function Identifiers
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).
; 4 ’4’ < D ’M’
; 5 ’5’ = 0 ’P’
; 6 ’6’ = 1 ’Q’
< 1 ’A’ = 2 ’R’
< 2 ’B’ = 3 ’S’
< 3 ’C’ = 4 ’T’
< 4 ’D’ = 5 ’U’
< 5 ’E’ = 6 ’V’
< 6 ’F’ = 7 ’W’
< 7 ’G’ = 8 ’X’
< 8 ’H’ = 9 ’Y’
< C ’L’ = A ’Z’
Last Device ID
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):
• ; 2 ( ’2’ ) - Receipt printer or journal printer

• ; 3 ( ’3’ ) - After Hour depository
• ; = ( ’ = ’ ) - Card reader
• ; > ( ’ > ’ ) - Card writer
5-74
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• ; ? ( ’ ? ’ ) - Bill dispenser
• < 0 ( ’@’ ) - Presenter
• < 1 ( ’A’ ) - Depository (envelope depository or IDM)
• < 7 ( ’G’ ) - Coin dispenser
Last Message Coordination Number

Description: The Last Message Coordination Number contains the message
coordination number that the network put in the last Function Command message.
5-75
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Unsolicited Status Messages
5.3 Unsolicited Status Messages
This message is transmitted to the network when a change of status occurs at

the terminal. Maximum length is 256 characters. Table 5-31 shows the data
fields associated with the Unsolicited Status message.
Table 5-31 Unsolicited Status Message

Characters
Status Source - - - 1
Status - - - Variable
[ Field Separator (FS) ] [ hex 1C ] [1]
[ MDS Status ] [- - - ] [ Variable ]
[ Field Separator (FS) ] [ hex 1C ] [1]
[ Maintenance Mode Log ] [- - - ] [ Variable ]
[ Field Separator (FS) ] [1] [ hex 1C ] [1]
[ Buffers to Follow ID ] [1] [ 9 ] [1]
[ Buffer ID ] [1] [- - - ] [3]
[ Buffer Data ] [1] [- - - ] [ Variable ]
[ Group Separator (GS)] [1] [ hex 1D ] [1]
[ Buffer ID ] [1] [- - - ] [3]
[ Buffer Data ] [1] [- - - ] [ Variable ]

The following paragraphs describe the fields in the Unsolicited Status message.

5-76
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

In the case of the Unsolicited Status message, this field is 1.
Message Identifier
Valid Range: 2
transmitted. The only valid value for the Unsolicited Status message is 2.

Valid Range:
(TP-799530-001D) for additional details. This field is not sent for a Power
Failure status.
Status Source
Description: This one-character field describes the source of the status change
as follows:
• ’1’ - Power failure
• ’2’ - Alarm (Diebold terminals only)
• ’3’ - Supervisory and supply actions
• ’4’ - Printers
• ’5’ - Card reader
• ’6’ - Not used
• ’7’ - Card writer
• ’8’ - Reserved for compatibility with TCS
• ’<’ - Withdrawal area sensors
5-77
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• ’?’ - Dispenser (912 mode) (if the following configuration option is set:
Transaction Host, Message Settings, Command Message, Function ID ’D’)
• ’@’ - Presenter (Withdrawal Door status) (if the following configuration

option is set: Transaction Host, Message Settings, Command Message,
Function ID ’D’)
• ’A’ - IDM (912 mode)
• ’G’ - Coin dispenser (912 mode)
• ’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
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.
Maintenance Mode Log

Field Size:
Valid Range:
Description: As an option, Agilis 91x for ix/CSP can send the network
Unsolicited Status messages that contain Maintenance mode log information.
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 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-32 Operator Codes and Menu Selection Codes
Operator Code Group and Operator Menu Code Menu Item Selected
000 [1] 000 Log On
001 - 008 Group 0, Operators 1 through 8 001 Manager
011 - 018 Group 1, Operators 1 through 8 002 DES Keys
021 - 028 Group 2, Operators 1 through 8 003 Device Adjustments
031 - 038 Group 3, Operators 1 through 8 004 Supply
041 - 048 Group 4, Operators 1 through 8 005 Reserved
051 - 058 Group 5, Operators 1 through 8 006 Status List
007 Clear Status List
008 Reserved
009 Reserved
010 Attention Message
011 Exit (Log Off)
012 Reserved
013 Remote Balancing
014 Reserved
032 Continuous Availability Logon [2]
036 Continuous Availability Supply [2]
038 Continuous Availability Status List [2]
039 Continuous Availability Clear Status

List [2]
040 Reserved
043 Continuous Availability Logoff [2]
045 Continuous Availability Rear Balance
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Table 5-33 Example Maintenance Mode Log
Action Status Byte Log Entry
The operator logs on. 20 000 000
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:
001 011 GS 001 006 GS 000 000
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
Buffer ID
Buffer Data
Valid Range: For each character, 0 through 9, A through Z, a through z, + / and =
5-80
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
NOTE


end of the message.
5-81
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.1 Unsolicited Status Tables
This section contains tables for the unsolicited status of the following devices:
• Alarm (SSF = ’2’) (Diebold terminals only)

• Supervisory and supply actions (SSF = ’3’)
• Printer (SSF = ’4’)
• Card reader (SSF = ’5’)
• Card writer (SSF = ’7’)
• Dispenser (912 mode) (SSF = ’?’)
• Presenter (Withdrawal Door status) (912 mode) (SSF = ’@’)
• Withdrawal area sensors (SSF = ’<’)
• IDM (912 mode) (SSF = ’A’)
• Coin dispenser (912 mode) (SSF = ’G’)
• Enhanced status (SSF=’J’)
As an option, a network can customize status data to send more descriptive

status messages to the network. For more details on status customization,
5.3.2 Alarm Status (unsolicited) (SSF = ’2’) (Diebold terminals only)
There is one byte for alarm unsolicited status. Refer to Table 5-34 for detailed
bit definition of this byte.
Table 5-34 Alarm Unsolicited Status (SSF = ’2’)
0 7-3 Reserved Always 0
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.
0 Burglary Someone is burglarizing the terminal. Possible causes for

this indication are the safe lining has been penetrated, the
thermal sensor has been activated, or the other sensing
devices indicate a security breach.
5-82
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.3 Supervisory and Supply Actions Status (unsolicited) (SSF = ’3’)
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’)
Byte Bit Abbreviated Bit Detailed Bit Definition

Definition
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.
The interpretation of the status byte depends on configurable terminal options, as

described in Section 5.3.3.1 and Section 5.3.3.2.
5.3.3.1 Supervisory and Supply Actions Status for ixSeries terminals
For ixSeries terminals, the interpretation of the status byte depends on

configuration options. The Send Supervisory Status at Logon configuration
option control when and how the terminal advises the network of operator
activity (Table 5-36). The requirements of your network determine the correct
setting for the following configuration options:
Transaction Host, Message Settings, Maintenance message, At Logon or At

Logoff
Table 5-36 Supervisory and Supply Actions Status Byte Mapping
Bit [1] Interpretation
Terminals with no options selected 6 Send Attention Message selected
5 Supply selected
Terminals with Send Status at Logon option 6 Send Attention Message selected
5 Maintenance mode logon
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Additionally, selecting the Send Supervisory Status at Logoff configuration

option reverses the bit pattern sent to the network at logoff. With this option
selected and both status bits set during Maintenance mode operation, during
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.
NOTE
The Send Supervisory Status at Logon option and the

Send Supervisory Status at Logoff option are two separate
configuration options. These two configuration options can be
selected as follows and used independently of each other:
Transaction Host, Message Settings, Maintenance message,

At Logon or At Logoff
Refer to the following examples for clarification.
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)
Action Status Byte
1. The operator logs on. no message
2. The operator selects Supply. 20
3. The operator makes any selections other than Send Attention Message and Exit no message
(logoff).
4. The operator selects Exit. 00
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-37 Supervisory and Supply Actions Example (with no options selected) (continued)
Action Status Byte
3. The operator selects Send Attention Message. 40
3. The operator makes any selections other than Send Attention Message and Exit no message
(logoff).
5. The operator selects Exit. 20 (first message) [1]

00 (second message)
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)
Action Status Byte
1. The operator logs on. 20
2. The operator makes any selections other than Send Attention Message and Exit (logoff). no message

00 (second 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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)
Action Status Byte
3. The operator makes any selections other than Exit (logoff). no message

00 (second message)
Status Messages for Attention Message Selection in Continuous

Availability
NOTE
The Continuous Availability feature is applicable only to

terminals equipped with the optional Agilis Supply Manager.
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.
The following options affect the statuses sent to the network:
• Send Status at Logon ( configuration option: Transaction Host, Message

Formats)
• Send Supervisory Status at Logon (configuration option: Transaction Host,

Message Settings, Maintenance message, At Logon)
5-86
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• Send Supervisory Status at Logoff (configuration option: Transaction Host,

Message Settings, Maintenance message, At Logoff)
• Maintenance Mode Log to Network (Write Command 3, Miscellaneous

Features 2 field, weight 016)
Table 5-40 shows how the setting of these options determines which statuses are
sent to the network.
Table 5-40 Statuses Sent for Attention Message in Continuous Availability
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 300 (320 360 320 300) 300
X (340 300)
X X 300 (320 360 340 300) 300
X [2] (340 300)
X [2] X 300 (340 300) 300
X [2] X (340 300)
X [2] X X 300 (340 300) 300
X (320 360 320 300)
X X 300 (320 360 320 300) 300
X X (320 360 340 300)
X X X 300 (320 360 340 300) 300
X X (340 300)
X X X 300 (340 300) 300
X X X (340 300)
X X X X 300 (340 300) 300

[1] X = Option selected; Blank = Option not selected
[2] Agilis 91x for ix/CSP ignores this setting because the Send Status at Logon option is not selected.
An example of the messages sequence for the last case in Table 5-40 is shown
below:
Operation Unsolicited Status Sent to Network
Enter Continuous 12.000..300.000032

Availability:
5-87
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Select ATTN: 12.000..340.000010 (First message)
12.000..300.000010 (Second message)
Exit Continuous 12.000..300.000043

Availability:
5-88
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.3.2 Supervisory and Supply Actions Status
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.
Table 5-41 Supervisory and Supply Actions Status Byte Mapping
At Logon Property Bit [1] Interpretation
Send no status 6 Send Attention Message selected
5 Supply selected
Send supply status 6 Send Attention Message selected
5 Maintenance mode logon
Send supervisory status 6 Maintenance mode logon
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.
Refer to the following examples for clarification.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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)
Action Status Byte
2. The operator makes any selections other than Supply, Send Attention Message, and Exit (logoff). no message

00 (second 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 5 of the last procedure in this table.
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)
Action Status Byte
5-90
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-43 Supervisory and Supply Actions Example (Send Supply Status selected) (continued)
Action Status Byte

00 (second message)
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)
Action Status Byte
3. The operator makes any selections other than Exit (logoff). no message

00 (second message)
Status Messages for Attention Message Selection in Continuous

Availability
NOTE
The Continuous Availability feature is applicable only to

terminals equipped with the optional Agilis Supply Manager.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
The following elements control the statuses sent to the network:
• 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.
Table 5-45 Statuses Sent for Attention Message in Continuous

Availability
At Logon, At Logoff, Maintenance Statuses Sent for Attention

Send: Send: Mode Log to Message
Network [1]
No status Supply (340 300)
No status Supply X 300 (320 360 320 300) 300
No status Supervisory (340 300)
No status Supervisory X 300 (320 360 340 300) 300
Supply Supply (320 360 320 300)
Supply Supply X 300 (320 360 320 300) 300
Supply Supervisory (320 360 340 300)
Supply Supervisory X 300 (320 360 340 300) 300
Supervisory Supply (340 300)
Supervisory Supply X 300 (340 300) 300
Supervisory Supervisory (340 300)
Supervisory Supervisory X 300 (340 300) 300

[1] X = Option selected. Blank = Option not selected
An example of the messages sequence for the last case in Table 5-45 is shown
below:
Enter Continuous 12.000..300.000032

Availability:
Send Attention Message: 12.000..340.000010 (First message)
12.000..300.000010 (Second message)
Exit Continuous Availability: 12.000..300.000043
5-92
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.4 Printer Status (unsolicited) (SSF = ’4’)
There are three bytes in printer unsolicited status. Refer to Table 5-46 for
detailed bit definition of each of these three bytes.
Table 5-46 Printer Unsolicited Status (SSF = ’4’)
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.
6 ----- Not applicable
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.

receipt printer
5-93
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-46 Printer Unsolicited Status (SSF = ’4’) (continued)
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.
• An electrical failure of the paper margin sensor. This sensor

indicates where on the form to begin printing.
• A failure of the printer electronics to send back a ready signal

when commanded to print a line.
2 7 Journal printer has run out of paper This fault is normally caused by a depleted journal printer paper roll. It
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
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.
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, caused by a failure
of the printer electronics to send a ready signal to the terminal’s
microcomputer that indicates task completion.

journal printer
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.
• An electrical failure of the paper margin sensor. This sensor

indicates where on the form to begin printing.
• A failure of the printer electronics to send back a ready signal

when commanded to do a line print.
5-94
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.5 Card Reader Status (unsolicited) (SSF = ’5’)
There is one byte for the card reader unsolicited status. Refer to Table 5-47 for
detailed bit definition of this byte.
Table 5-47 Card Reader Unsolicited Status (SSF = ’5’)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.6 Card Writer Status (unsolicited) (SSF = ’7’)
There is one byte for the card writer unsolicited status. Refer to Table 5-48 for
detailed bit definition of this byte.
Table 5-48 Card Writer Unsolicited Status (SSF = ’7’)
0 7-2 ----- Not applicable
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.
5.3.7 Dispenser Status (unsolicited) for 912 Mode (SSF = ’?’)
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:
• MDS Status to Network feature enabled in Write Command 3, Miscellaneous

Features 2
• Unsolicited Maintenance status reporting set in configuration option:

Transaction Host, Message Settings, Status message, Send unsolicited
status messages during maintenance AND send dispenser and fascia
unsolicited status messages anytime
The format of the status message is as follows:
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:

• 04 - Fault on present - consumer had access to cash or no stack to present
5.3.9 Withdrawal Area Sensors Status (unsolicited) (SSF = ’<’)
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:

• 40 - Forgotten money removed
• 80 - Sensors blocked
5-97
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.10 IDM Status (unsolicited) for 912 Mode (SSF = ’A’)
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’)
0 7 Abnormal document retain Abnormal document retain

(depository
status)
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
2 Hundreds module error The deposit hundreds-digit print module has not increased to the
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
6-5 ---- Reserved. Set to 0.
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.
0 MICR hardware error MICR processor fault.
3 7-4 Operation data Four bits of operation data defined as follows:

• 0000 - Reserved
• 0001 - Envelope deposit
• 0010 - Check deposit
• 0011 - Check retain
• 0100 - Return check with printing
• 0101 - 1111 - Reserved
3-0 Bin data Four bits of bin data defined as follows:

• 0000 - bin 0
• 0001 - bin 1
• 0010 - bin 2
And so on.
5-99
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:
• MDS Status to Network feature enabled in Write Command 3, Miscellaneous

Features 2
• Unsolicited Maintenance Status reporting set in configuration option:

Transaction Host, Message Settings, Status message, Send unsolicited
status messages during maintenance AND send dispenser and fascia
unsolicited status messages anytime
The format of the status message is as follows:
Device ID ’G’
Status CN01
If MDS Status to the network is selected, the MDS status is included with
this message.
5-100
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.3.12 Enhanced Status (unsolicited) (SSF = ’J’)
Agilis 91x for ix/CSP reports enhanced status for the following devices:
• Keypad
• Encryption/decryption device
• Envelope dispenser
• Lead-through indicators
• Passbook printer
NOTE
• Touch screen (not applicable on the CashSource Plus 400)
The format of this status is as follows:
• Operation Sequence Number. This field is always 000.
• 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:
- ED01 - Encryption/decryption device

- EP01 - Keypad
- LT01 - Lead-through indicators
- PB01 - Passbook printer
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
Operation Sequence Number 000
Device ID SP01
Fault Status :3D:00:04
5-101
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
For details on the actual status definitions, refer to the Agilis 91x for ix Status
Reference Manual (TP-820589-001E).
5-102
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Filtering and Translating Network Status
5.4 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
This section is not applicable to bill dispenser statuses. This

method cannot be used to customize bill dispenser statuses.
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
CUSTSTAT.TXT consists of one or more status translation tables, one table

for each terminal device. The example shows status translation tables for the
receipt printer (PR01) and for the touch screen (TS01). The start of the status
translation table for a particular terminal device is marked by its four-character
device identifier. The end of the table is marked by the END key word followed
by the device identifier. CUSTSTAT.TXT should contain status translation tables
for only those devices whose statuses you are customizing.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Agilis 91x for ix/CSP recognizes several special text strings to assist you in
producing the desired output for the network:
• The text NOTRANS (case-sensitive) is used with devices that report

TABS-type statuses to the network. This text directs Agilis 91x for ix/CSP to
send the standard TABS-type status to the network, without modification,
for the corresponding event-type (solicited or unsolicited).
• The text DEFAULT (case-sensitive) is used with devices that report

enhanced statuses (J-type statuses) to the network. This text directs Agilis
91x for ix/CSP to send the standard enhanced status to the network, without
modification, for the corresponding event-type (solicited or unsolicited).
• The text SUPPRESS (case-sensitive) causes Agilis 91x for ix/CSP

to suppress the status for the corresponding event-type (solicited or
unsolicited). In this case, no status message is sent to the network when the
corresponding MDS status occurs.
CAUTION
Do not use SUPPRESS for solicited status for devices

other than printers. If Agilis 91x for ix/CSP does not
return a Solicited Status message to the network,
Agilis 91x for ix/CSP might remain in the Transaction
Request state indefinitely, waiting for a response
from the host.
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
• White space between fields is ignored.
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.
:2D:50:00 "Paper Supply Low" "Supplies"
5-104
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
Protocol Dependent Header Variable
Solicited/Unsolicited ID 2
Message Identifier 2
Field Separator (FS) hex 1C
Logical Unit Number (LUNO) - - -
[ Message Sequence Number ] [ - - - ]
Status Descriptor 8
Custom Status Paper Supply Low
Protocol Dependent Trailer Variable
5-105
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Function Command Message (ID ’4’)
5.5 Function Command Message (ID ’4’)
The Function Command message is sent to the terminal in response to a

Consumer Request message. The following two conditions must occur for the
transmission of the Function Command message to the terminal:
• The consumer has entered all the required data for a specific Consumer
Request message.
• The request has been sent to the network.
The Function Command message acts as an authorization to the terminal to

complete the transaction. Depending on the mode in which the terminal is
operating (either 911 or 912 emulation mode) the Function Command message
format varies slightly. Refer to Table 5-50 for a list of the sequence of fields,
number of characters, and the code of the Function Command for 911 mode.
Refer to Table 5-51 for a list of those items for 912 mode. The paragraphs
following the tables describe the fields in the Function Command message.
Table 5-50 Function Command Message (911 Mode)
Function Command Identifier 4 1
[ Message Sequence Number ] [ X ] [ Variable (8 max) ] [1]
[ Next State ID ] [ - - - ] [ 3 ]
[ Number of High Bills to Dispense ] [ - - - ] [ 2 ]
[ Number of Low Bills to Dispense ] [ - - - ] [ 2 ]
Transaction Serial Number - - - 4
Function Identifier - - - 1
[ Screen Number ] [ - - - ] [ 3 ]
[ Screen Display Update Data ] [ - - - ] [ Variable ]
Card Return/Retain Flag - - - 1

[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 can be repeated as often as needed, up to the maximum message length.
5-106
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-50 Function Command Message (911 Mode) (continued)
Printer Flag - - - 1
Printer Data - - - Variable
[ Printer Flag ] [ - - - ] [ 1 ]
[ Printer Data ] [ - - - ] [ Variable ]
[ Buffer Identifier ( Track 3 Field ID ) ] [ 4 ] [ 1 ]
[ Track 3 Data ] [ - - - ] [ Variable (106 max) ]
[ Buffer Identifier ( Depository Settings Field ID ) ] [ 6 ] [ 1 ]
[ Network Deposit Printer Data ] [ - - - ] [ Variable ]
[ Buffer Identifier ( Track 1 Field ID ) ] [ 9 ] [ 1 ]
[ Buffer Identifier ( Track 2 Field ID ) ] [ : ] [ 1 ]
[ Field Separator (FS) ] [ hex 1C ] [2] [ 1 ]
[ Enhanced Configuration Data Buffer ID ] [ ’ ] [2] [ 1 ]
[ Enhanced Configuration Data Buffer Data ] [ - - - ] [2] [ Variable ]
[ MAC Data ] [ - - - ] [ 8 ]

5-107
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-51 Function Command Message (912 Mode)
Description Data Number

of Char-
acters
Function Command Identifier 4 1
[ Message Sequence Number ] [ X ] [ Vari-

able (8
max) ] [1]
[ Next State ID ] [ - - - ] [ 3 ]
[ Number of Bills to Dispense ] [ - - - ] [ Vari-

able ]
Group Separator (GS) hex 1D [2] 1
Number of Coins to Dispense - - - Variable
Screen Number [ - - - ] 3
Screen Display Update Data [ - - - ] Variable
Screen Number [ - - - ] 3
Screen Display Update Data [ - - - ] Variable
Card Return/Retain Flag - - - 1

[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-108
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

of Char-
acters
Field Separator (FS) hex 1C [2] 1
Track 3 Field ID 4 1
Track 3 Data - - - Variable

(106
max)
Depository Settings Field ID 6 1
Deposit Printer Data - - - Variable
Group Separator (GS) hex 1D 1
Deposit Bin ID - - - 3
Image Capture - - - 3
Check Accepted Screen - - - 3
Check Handling Delay Screen - - - 3
Check Handling Delay Time - - - 3
Override MICRConfiguration Setting - - - 3
Maximum Document Length - - - 3
be specified.
5-109
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

of Char-
acters
Coin Field ID 8 1
Reserved 000 3
Dollar Amount of Coins - - - 8
Track 1 Field ID 9 1

(78 max)
Track 2 Field ID : 1

(39 max)
Field Separator (FS) hex 1C [2][5] 1
Enhanced Configuration Data Buffer ID ’ 1
Enhanced Configuration Data Buffer Data - - - Variable
MAC Data - - - 8

be specified.
The following paragraphs describe the fields in the Function Command message.

5-110
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Function Command Identifier

Valid Range: 4
transmitted. The only valid value for the Function Command message is 4.

Valid Range:

the terminal in Function Command messages, Write Command messages, and
Operational Command messages. The terminal does not use this number, but if
message sent in response to the network’s message.
If message authentication (MAC) is used, the Function Command message

contains a time variant number in place of the message sequence number. For
more details on the time variant number, refer to the Data Security Procedures
and Reference Manual (TP-799530-001D).
Next State ID
Description: This field defines the state number which the terminal should
execute after the normal completion of the specified Function Command.
Number of High Bills to Dispense (911 mode only)

Description: This field indicates the number of high bills to dispense.
Number of Low Bills to Dispense (911 mode only)

Description: This field indicates the number of low bills to dispense.
Number of Bills to Dispense (912 mode only)

Description: The Number of Bills to Dispense field contains the number of A
through H bills to dispense. Each A through H denomination has an associated
two-character number. The A through H bills are arranged in this field as follows:
5-111
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Characters
Number of A bills to dispense - - - 2
Number of B bills to dispense - - - 2
Number of C bills to dispense - - - 2
Number of D bills to dispense - - - 2
Number of E bills to dispense - - - 2
Number of F bills to dispense - - - 2
Number of G bills to dispense - - - 2
Number of H bills to dispense - - - 2
For example, to direct the terminal to dispense one A bill, two B bills, and one D
bill, enter 01020001 into this field.
The Diebold standard for bill denominations is as follows:
Denomination Value
A $1
B $5
C $10
D $20
E $50
F Reserved
G Reserved
H Reserved
Number of Coins to Dispense (912 mode only)

Description: The Number of Coins to Dispense field contains the number
of A through H coins to dispense. Each A through H denomination has an
associated two-character number. The A through H coins are arranged in this
field as follows:

Characters
Number of A coins to dispense - - - 2
Number of B coins to dispense - - - 2
Number of C coins to dispense - - - 2
Number of D coins to dispense - - - 2
Number of E coins to dispense - - - 2
Number of F coins to dispense - - - 2
5-112
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Characters
Number of G coins to dispense - - - 2
Number of H coins to dispense - - - 2
For example, to direct the terminal to dispense one A coin, two B coins, and one
D coin, enter 01020001 into this field.
The Diebold standard for coin denominations is as follows:
Denomination Value
A Penny (1¢)
B Nickel (5¢)
C Dime (10¢) (not presently supported)
D Quarter (25¢)
E Dollar ($1.00)
F Reserved
G Reserved
H Reserved
NOTE
Only 27 coins total can be dispensed for any one transaction.
Transaction Serial Number

Description: The transaction serial number data is four characters of graphic
code that identify the transaction to the network. This number originates at the
network when a Consumer Request message is received. The depository printer
prints this number on the deposit envelope.
Function Identifier
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.
Envelope depository only. For an IDM, the equivalent function can be

performed using a Depository function () or states ( and ).
5-113
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• B - Dispense currency (912 mode)

• C - Deliver currency (912 mode)
• D - Print and wait for completion (912 mode)
• E - Return card immediately (912 mode)
• F - Write track 3 (912 mode)
• G - After Hour depository deposit (912 mode)
• H - Print and do not wait for completion (912 mode)
• J - Return card, dispense, deliver, and print (911 mode)
• K - Deposit envelope, return card, dispense, deliver, and print (911 mode)
• O - Print, return card, dispense, and deliver (911 mode)
• P - Print data and stay in present state
• Q - Perform presenter retain operation
• R - Deposit check to escrow (912 mode) (<emphasis
type="ITALIC">ix</emphasis> Series terminals with IDM only)
• S - Return check if in escrow (912 mode) (<emphasis
• T - Retain check if in escrow (912 mode) (<emphasis
• U - Present card (912 mode)
• V - Write track 1
• W - Write track 2
• X - Disable IDM (912 mode) (<emphasis type="ITALIC">ix</emphasis>
Series terminals with IDM only)
• Y - Unlock the solenoid safe lock (or electronic safe lock) (912 mode)
• Z - Do nothing (912 mode)
• ? - Deposit, write card, return card, dispense, deliver, and print (911 mode)
• = - Write card, return card, dispense, deliver, and print (911 mode)
• ; - Execute enhanced functions
Terminal processing of function IDs 4 through = are described in Section 5.5.1

through Section 5.5.29.
The Execute Enhanced Functions function ID ( ; ) directs the terminal to execute

the enhanced functions in the ’ : ’ buffer. The enhanced functions are described
in Section 5.6.1 through Section 5.6.18.
NOTE
Each function identifier can be used once and only once in

a given Function Command message. Do not duplicate any
function identifiers in a given Function Command message.
Each Function Command message can contain no more than

one print function identifier (4, 5, D, H, or P). Multiple print
function identifiers in a single message are not permitted.
Screen Number
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.
Screen Display Update Data

5-114
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
In 912 mode, the Function ID, Screen Number, and Screen

Display Update fields can be repeated up to seven times in
a single Function Command message.
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.

Request message. The terminal assigns a different message coordination number,
to each successive Consumer Request message, on a rotating basis. The standard
valid range for the message coordination numbers is 1 through 9, : ; < = > and ?
(ASCII 31 through 3F). If the Extended Range for Message Coordination
Number field feature is selected in the Miscellaneous Feature 3 field of a Write
Command 3 message (Section 4.23), then the valid range is ASCII 31 through
7E. The network must include the corresponding message coordination number
when responding with a Function Command. If the message coordination
numbers do not match, the terminal sends a Solicited Status message with
a Command Reject status.
5-115
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
NOTE
If the Message Coordination Number field in the Function

Command message contains 0 (zero), the terminal accepts
the Function Command message without attempting to verify
that the number matches the message coordination number
sent in the Consumer Request message.
Card Return/Retain Flag

Description: This one-character field directs the terminal to either return or
retain the consumer’s account card during the Close state. The valid values
are as follows:
• 0 - Return card
• 1 - Retain card
Printer Flag
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
If printing is to be done on the statement printer (as indicated by the ; printer

flag), the Function Command message should not contain additional Printer Flag
fields for either the receipt printer or the journal printer. If an attempt is made to
print to the statement printer and either (or both) of the other printers, Agilis
91x for ix/CSP prints on the statement printer only.
Printer Data
Field Size: Variable (limited only by the total length limit for the message)
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
Multiple printer flag and printer data fields must be

consecutive.
Track 3 Field ID
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Track 3 Data
Field Size: Variable (106 characters maximum)
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.
Depository Settings Field ID

Valid Setting: 6
Description: This one-character field ID tells the terminal that depository-related
data follows.
Deposit Printer Data

Description: The Deposit Printer Data field contains text to be printed on the
envelope that the consumer inserts into the depository.
Deposit Bin ID (912 mode, <emphasis type="ITALIC">ix</emphasis>

Series terminals with IDM only)
Description: The deposit bin ID tells the terminal in which bin to place a
deposit. Agilis 91x for ix/CSP uses the value in this field only when the Function
Command message contains one of the following function IDs:
• R - Deposit check to escrow

• S - Return check if in escrow
• T - Retain check if in escrow
If any other function ID is specified in the Function Command message, the

value in the Deposit Bin ID field should be 000.
Image Capture (912 mode, <emphasis type="ITALIC">ix</emphasis>

Series terminals with IDM and RSS only)
Valid Range: 000, 001, 003, 005, and 007
Description: The Image Capture field is applicable only to function ID R
(deposit check to escrow). 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:

5-117
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• Bit 1:

• Bit 0:

Check Accepted Screen (912 mode, <emphasis

Description: This field contains the number of the screen to display when the
IDM has accepted a check but has not yet read or scanned the check. If the value
in this field is 000, the terminal does not change the screen currently showing. If
this field is not included in the message, the value defaults to 000.
Check Handling Delay Screen (912 mode, <emphasis

Description: This field contains the number of the screen to display if the time
specified in the Check Handling Delay Time field expires, after the check is
accepted. This time might expire if the IDM has difficulty locating the MICR
data on the check. This screen is used to assure the consumer that the check
is still being processed. If the value in this field is 000, the terminal does not
change the screen currently showing. If this field is not included in the message,
the value defaults to 000.
Check Handling Delay Time (912 mode, <emphasis

Description: The value in this field specifies how long to wait after the check
is accepted before displaying the Check Handling Delay screen. The time is
specified in 800-millisecond increments. A value of 255 disables this feature.
The suggested value is 25 (20 seconds). If this field is not included in the
message, the value defaults to 255.
Override MICR Configuration Setting (912 mode)

5-118
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:


Maximum Document Length (912 mode, <emphasis

Description: The Maximum Document Length field specifies the maximum
length of a document, in millimetres, that can be accepted by the IDM. The
range is 150 to 225 millimetres (approximately 6 to 9 inches). Any document
exceeding this length causes a Solicited Status message with the Document Size
Error bit set to be sent to the network. Any value less than 150 or greater than
225 is ignored. The default value is 225.
Coin Field ID (912 mode, coin dispenser only)

Valid Setting: 8
Description: This one character Coin Field ID field tells the terminal that
Dollar Amount of Coins data follows.
Reserved (912 mode)

Valid Range: 000
Description: This field is reserved.
Dollar Amount of Coins (912 mode, coin dispenser only)

Description: This field contains the dollar value of the coins to be dispensed.
The entries in this field override the values in the Number of Coins to Dispense
field. The ATM determines the coin mix. The range of this field is 00000000
to 00000499 ($0.00 to $4.99) for coin dispensers equipped with a $1.00
denomination bin. Without the $1.00 bin, the range of the field is limited
to 00000000 to 00000099.
5-119
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
NOTE
Either the Number of Coins to Dispense field or the Dollar

Amount of Coins field can be used to specify the coin
dispense amount, so long as both are not used (if they are,
the Dollar Amount of Coins field takes precedence). If the
Dollar Amount of Coins field is present, the terminal uses
a least-coin algorithm to determine the mix. This algorithm
assumes the presence of all four coin denominations and is
fixed and unconfigurable.
Track 1 Field ID
Valid Setting: 9
Description: This one-character Track 1 field ID field tells the terminal that
track 1 data follows.
Track 1 Data
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
Valid Setting: : (colon character)
Description: This one-character Track 2 field ID field tells the terminal that
track 2 data follows.
Track 2 Data
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.
Enhanced Configuration Data Buffer ID

Valid Setting: ’ (single quote character)
Description: This one-character field tells the terminal that an enhanced
configuration buffer ID and enhanced configuration data follows. The valid
buffer IDs are as follows:
• ’1’ - Update Configuration ID

• ’2’ - Update Special Keys
• ’3’ - Update Configured Timers
• ’4’ - Update Special Screens
• ’5’ - Update States
• ’6’ - Update Screen
• ’7’ - Update Format Templates
• ’8’ - Update FIT
• ’9’ - Update Buffers
• ’:’ - Perform Function
Enhanced Configuration Data Buffer Data

5-120
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Description: This field contains the corresponding data for the previous buffer
ID. For details on the data in this field, refer to Section 5.6.
NOTE
The Field Separator, Enhanced Configuration Data Buffer ID,

and Buffer Data fields can be repeated as often as required up
to the message length restriction.
MAC Data
Valid Range:
additional details.

end of the message.
5-121
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.1 Print Immediate (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 terminal processes the Print Immediate function as follows.
1. Shows the screen specified in the Function Command message
2. Initializes for printing
3. Directs the printer(s) (receipt, journal, or statement) specified by the

printer flag in the Function Command message to print, cut, and deliver
the printed document (if applicable)
4. Sends a Ready message
5.5.2 Set Next State and Print (5)
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.

5.5.3 After Hour Depository Deposit and Print (6)
The terminal processes the After Hour Depository Deposit and Print function
(function ID 6) as follows:
2. Starts timer 08 (bag deposit insertion time)
5-122
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
3. Checks for the completion of the deposit. The deposit is complete

when the consumer closes the After Hour depository door and the
door cycles successfully.
• If timer 08 expires before the deposit is complete, the terminal starts

timer 01 (consumer response extension timer) and shows screen 000.
If timer 01 expires before the deposit is complete, the terminal sends
an After Hour Depository Solicited Status message indicating a fault
and waits for a new Function Command message.
• If the Cancel key is pressed while the terminal is checking for

the completion of the deposit, the terminal sends an After Hour
Depository Solicited Status message indicating a fault and waits for a
new Function Command message.
• If the deposit is completed successfully, the terminal goes to Step 4.

5.5.4 Deposit and Print (7) (911 mode)
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)
3. Checks for deposit insertion
• If timer 04 or timer 20 expires before the consumer inserts the

envelope, the terminal starts timer 01 (consumer response extension
timer) and shows screen 000. If timer 01 expires before the consumer
inserts the envelope, the terminal sends a Depository Solicited
Status message indicating a fault and waits for a new Function
Command message.
• 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.
• If an envelope is inserted, the terminal goes to Step 4.
4. Initializes for envelope entry
5-123
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5. Transports the deposit envelope
• If a fault occurs while the terminal is performing the deposit, the

terminal sends a Depository Solicited Status message indicating a
fault and waits for a new Function Command message.
• If a fault does not occur, the terminal goes to Step 6.
6. Increases the deposit envelope count by one
7. Prints the transaction serial number, the contents of the Dollar Buffer, and
the first 20 characters of track 2 data on the envelope
8. Initializes for finishing the deposit
9. Waits for the deposit to finish
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.5 Dispense, Deliver, and Print (8) (911 mode)
The terminal processes the Dispense, Deliver, and Print function (function
ID 8) as follows.
1. On <emphasis type="ITALIC">ix</emphasis> Series walk-up terminals,

checks for a trap condition
• If a trap condition exists, the terminal sends a Trap Solicited Status

message, then waits for a new Function Command message.
• If a trap condition does not exist, the terminal goes to Step 2.
3. Initializes for the dispense function
4. Starts dispensing
5. If a fault occurs while the terminal is dispensing, the terminal proceeds

as follows.
a. Sends a Dispenser Solicited Status message indicating a fault
b. Waits for a new Function Command message
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.

8. Starts presenting the bills to the consumer
9. If a fault occurs during the present operation, the terminal proceeds

as follows.
a. Sends a Withdrawal Door Solicited Status message indicating a fault
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
11. If timer 07 expires before all the bills are removed, and the No Retract
Bills feature is enabled, the terminal proceeds as follows.
• If Money Forgotten and Money Removed messages are enabled,

the terminal sends a Withdrawal Door Solicited Status message
indicating money forgotten, then waits for a new Function Command
message.
• If Money Forgotten and Money Removed messages are not enabled,

the terminal initializes for printing, then goes to Step 14.
Bills feature is not enabled, the terminal dumps the bills, then proceeds
as follows.
• If the configuration option is set to: Presenter, Presenter Action after

customer timeout, Retain and report status; the terminal sends a
Withdrawal Door Solicited Status message indicating a fault, then
waits for a new Function Command message.

customer timeout, Retain and do not report status; the terminal
initializes for printing, then goes to Step 14.
13. If all the bills are removed before timer 07 expires, the terminal initializes
for printing.

5-126
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.6 Deliver and Print (9) (911 mode)
The terminal processes the Deliver and Print function (function ID 9) as follows.
1. On ix/CSP Series walk-up terminals, checks for a trap condition

4. If a fault occurs during the present operation, the terminal proceeds

as follows.
a. Sends a Withdrawal Door Solicited Status message indicating a fault

message.

the terminal initializes for printing, then goes to Step 9.
as follows.


customer timeout, Retain and do not report status;, the terminal
initializes for printing, then goes to Step 9.
8. If all the bills are removed before timer 07 expires, the terminal initializes
for printing.
5-127
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

5.5.7 Deposit Envelope (A) (912 mode)
The Deposit Envelope function (function ID A) specifies an envelope deposit

for an envelope depository.
NOTE
For an IDM, the equivalent function can be performed using

a Depositor function (Section 5.6.6).
The terminal processes the Deposit Envelope function as follows.
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)
3. Checks for deposit insertion
• If timer 04 or timer 20 expires before the consumer inserts the

envelope, the terminal starts timer 01 (consumer response extension
timer) and shows screen 000. If timer 01 expires before the consumer
inserts the envelope, the terminal sends a Depository Solicited
Command message.
• 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.
• If an envelope is inserted, the terminal goes to Step 4.
4. Initializes for envelope entry
5. Transports the deposit envelope
• If a fault occurs while the terminal is performing the deposit, the

terminal sends a Depository Solicited Status message indicating a
fault and waits for a new Function Command message.
6. Increases the deposit envelope count by one
5-128
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
7. Prints one of the following items on the envelope:
• The transaction serial number, the contents of the Dollar Buffer,

and the first 20 characters of track 2 data
• Network print data sent in the Function Command message
8. Initializes for finishing the deposit
9. Waits for the deposit to finish
• 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.
• If a fault does not occur, the terminal checks for an additional

function identifier in the Function Command message.
5.5.8 Dispense Currency (B) (912 mode)
The Dispense Currency function (function ID B) directs the terminal to dispense

bills, coins, or both
The terminal processes the Dispense Currency function as follows.
1. On walk-up terminals, checks for a trap condition

3. Initializes for the dispense function
4. Starts dispensing
5. If a fault occurs while the terminal is dispensing, the terminal proceeds

as follows.
a. Sends a Dispenser Solicited Status message indicating a fault
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.9 Deliver Currency (C) (912 mode)
The Deliver Currency function (function ID C) directs the terminal to deliver

the currency previously dispensed.
The terminal processes the Deliver Currency function as follows.
1. On <emphasis type="ITALIC">ix</emphasis> Series walk-up terminals,

checks for a trap condition

4. If a fault occurs during the present operation, the terminal sends a

Withdrawal Door Solicited Status message indicating a fault, then waits
for a new Function Command message.
6. If all the bills are removed before timer 07 expires, the terminal goes to
Step 9.

message.

the terminal goes to Step 9.
5-130
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
as follows.


customer timeout, Retain and do not report status; the terminal
goes to Step 9.
9. The terminal checks for an additional function identifier in the Function

Command message.
5.5.10 Print and Wait for Completion (D) (912 mode)
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.

4. Depending on configuration options, the terminal checks for an additional

function identifier in the Function Command message or proceeds as
follows in Step 5.
5. The terminal proceeds as follows.
• If a fault occurs while printing (either printer), the terminal sends a

Printer Solicited Status message indicating a fault, then waits for a
• If a fault does not occur while printing, the terminal checks for an
additional function identifier in the Function Command message.
5.5.11 Return Card Immediately (E) (912 mode)
The Return Card Immediately function (function ID E) directs the terminal to

return the card immediately and wait for the consumer to remove the card
before processing the next function.
5-131
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The terminal processes the Return Card Immediately function as follows.
1. Returns the card to the consumer
• 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 a fault does not occur, the terminal goes to step 2.
3. Starts timer 09 (card removal time-out interval before card capture

attempt)
4. Checks for card removal by the consumer
• If the card is removed before timer 09 expires, the terminal checks for
an additional function identifier in the Function Command message.
• If timer 09 expires before the card is removed, the terminal goes to

step 5.
5. Begins transporting the card back into the terminal
• 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
• 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.
6. Begins retaining the card
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.
a. Increases the cards captured count by one
b. Sends a Card Reader Solicited Status message indicating a completion
c. Waits for a new Function Command message
5-132
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.12 Write Track 3 (F) (912 mode)
The Write Track 3 function (function ID F) directs the terminal to immediately

write onto the card the data from the track 3 buffer. The track 3 buffer contains
either data read from the card or data obtained from the Track 3 Data field of
the Function Command message.
The terminal processes the Write Track 3 function as follows.
2. Checks for data in the track 3 buffer (this data might be from the card or
the Function Command message)
• If no track 3 data is found, the terminal sends a Card Writer Solicited

Command message.
• If track 3 data is found, the terminal goes to step 3.
3. Initializes for writing
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.13 After Hour Depository Deposit (G) (912 mode)
The terminal processes the After Hour Depository Deposit function (function
ID G) as follows:
2. Starts timer 08 (bag deposit insertion time)
3. Checks for the completion of the deposit. The deposit is complete

when the consumer closes the After Hour depository door and the
door cycles successfully.
• If timer 08 expires before the deposit is complete, the terminal starts

timer 01 (consumer response extension timer) and shows screen 000.
If timer 01 expires before the deposit is complete, the terminal sends
an After Hour Depository Solicited Status message indicating a fault
and waits for a new Function Command message.
• If the Cancel key is pressed while the terminal is checking for

the completion of the deposit, the terminal sends an After Hour
Depository Solicited Status message indicating a fault and waits for a
• If the deposit is completed successfully, the terminal checks for an

additional function identifier in the Function Command message.
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.

4. Checks for an additional function identifier in the Function Command

message
5-134
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
2. During the Return Card function, the terminal shows the specified
screen plus one.
plus two.
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.
plus one.
5-135
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.18 Print Data and Stay in Present State (P)
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
If printing is to be done on the statement printer (as indicated by the character ;

[semicolon] in the Printer Flag field), the Function Command message should not
contain additional Printer Flag fields for either the receipt printer or the journal
printer. If an attempt is made to print to the statement printer and either (or both)
of the other printers, Agilis 91x for ix/CSP prints on the statement printer only.
When function ID P is used, it must be the last function ID in the Function

Command message. Function ID P can be used with or without other function
IDs in the message (but cannot be used with another print function ID, such
as 4, 5, D, H, or P).
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.5.19 Perform Presenter Retain (Q)
The Perform Presenter Retain function (function ID Q) directs the terminal to

perform a retain operation of the cash presenter. The terminal returns a Ready
message to the network. This is used when the previous consumer had an
incomplete transaction and cash was left in the presenter.
5-136
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.20 Deposit Check to Escrow (R) (912 mode) (<emphasis type="ITALIC">ix</emphasis> Series
terminals with IDM only)
The Deposit Check to Escrow function (function ID R) directs the terminal to

accept a check or other document and hold the check or document in the escrow
position. This function is intended to be the first step of a check deposit sequence.
If there is no check or other document in escrow, the terminal enables the IDM to
perform the following operations:
• Accept a check or document
• Read the MICR line as directed by the MICR Search configuration setting
field or by the Depositor device configuration options
• Capture the image(s) of the check or document as directed by the Image

Capture field. (Bit 0 of the Image Capture field must be set to 1.)
• Hold the check or document in the escrow position

value) or by timer 04. The Cancel key is enabled during processing of this
function.
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
The Return Check if in Escrow function (function ID S) directs the terminal to

return a check or other document to the consumer, after printing on the check
or document. The terminal moves the check or 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 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.
The Cancel key is disabled during processing of this function.
5-137
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.5.22 Retain Check if in Escrow (T) (912 mode) (<emphasis type="ITALIC">ix</emphasis> Series
The Retain Check if in Escrow function (function ID T) directs the terminal to

retain a check or other document, after printing on the check or document. The
terminal moves the check or document from the escrow position to the deposit
bin specified in the Deposit Bin ID field. If no deposit bin is specified, the
default deposit bin is used.
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 Cancel key is disabled during processing of this function.
5.5.23 Present Card (U) (912 mode)
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.
The terminal processes the Present Card function as follows.
1. Returns the card to the consumer
• 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 a fault does not occur, the terminal goes to step 2.
3. The terminal checks for an additional function identifier in the Function

Command message.
5.5.24 Write Track 1 (V) (912 mode)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Command message.
• If a fault occurs after three attempts to write on the card, the terminal
goes to step 5.
5.5.25 Write Track 2 (W) (912 mode)
The Write Track 2 function (function ID W) directs the terminal to write to track
2 if the card reader has that capability.

Command message.
5-139
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• If a fault occurs after three attempts to write on the card, the terminal
goes to step 5.
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.27 Do Nothing (Z) (912 mode)
The Do Nothing function (function ID Z) directs the terminal to show a screen,

update the screen data, and check for an additional function ID.
The terminal processes the Do Nothing function as follows.
2. Checks for an additional function identifier in the Function Command

message
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
2. During the Write Card and the Return Card functions, the terminal
shows the specified screen plus one.
5-140
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
plus two.
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.
plus one.
plus two.
5-141
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced Function Command Message (ID ’7’)
5.6 Enhanced Function Command Message (ID ’7’)
The network transmits a Function Command message to update the configuration

data or to tell the terminal how to complete a consumer transaction or both. The
Enhanced Function Command provides more versatility and flexibility than the
standard Function Command message described in Section 5.5. The format of
the Enhanced Function Command message entries is shown in Table 5-52.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-52 Enhanced Function Command Message Format
Message ID (Enhanced Function Command) 7 1
[ Message Sequence Number ] [ X ] [ Variable (8 max) ] [1]
[ Good Operation Next State ] [ - - - ] [ 3 ]
Field ID (Update Configuration ID) ’1’ 3
Configuration ID Data - - - Variable (16 max)
Field ID (Update Special Keys) ’2’ 3
Group ID (Yes Key ID) 001 3
Yes Key - - - 3
Yes Key - - - 3
Yes Key - - - 3
Group ID (No Key ID) 002 3
No Key - - - 3
No Key - - - 3
No Key - - - 3
Group ID (Cancel/Stop Key ID) 003 3
Cancel/Stop Key - - - 3
Field ID (Update Configured Timers) ’3’ 3

[1] 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 can be repeated as often as required up to the maximum message length.
[3] Buffer ID, Buffer Data, and GS can be repeated as often as required up to the maximum message length.
[4] Device ID, Function Data, and GS can be repeated as often as required up to the maximum message length.
5-143
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-52 Enhanced Function Command Message Format (continued)
Group ID (Configured Timer Number) - - - 3
Silent Time - - - 3
Beeper Rate - - - 3
Beeping Time - - - 3
Group ID (Configured Timer Number) - - - [2] 3
Silent Time - - - [2] 3
Beeper Rate - - - [2] 3
Beeping Time - - - [4] 3
Field ID (Update Special Screens) ’4’ 3
Group ID (More Time Screen) 001 3
Screen Number - - - 3
Silent Time - - - 3
Beeper Rate - - - 3
Beeping Time - - - 3
Group ID (Off Line Screen) 002 3
Screen Number - - - [2] 3
Group ID (Out of Service Screen) 003 3
Screen Number - - - 3
Field ID (Update States) ’5’ 3
Group ID (State Number) - - - 3
State Data - - - Variable (150 max)
Group ID (State Number) - - - [2] 3
State Data - - - [2] Variable (150 max)
Field ID (Update Screen) ’6’ 3
Group ID (Screen Number) - - - 3
Screen Data - - - Variable (512 max)
Group ID (Screen Number) X 3

5-144
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-52 Enhanced Function Command Message Format (continued)
Screen Data - - - Variable (512 max)
Field ID (Update Format Templates) ’7’ 3
Group ID (Format Template Number) - - - 3
Group ID (Format Template Number) - - - 3
Field ID (Update FIT) ’8’ 3
Group ID (FIT Number) - - - 3
FIT Data - - - 114
Group ID (FIT Number) - - - 3
FIT Data - - - 114
Field ID (Update Buffers) ’9’ 3
Group ID (Buffer ID) - - - [3] 3
Buffer Data - - - [3] Variable
Group ID (Buffer ID) - - - [3] 3
Buffer Data - - - [3] Variable
Field ID (Perform Function) ’ : ’ 3
Group ID (Device ID) - - - [4] 3
Function Data - - - [4] Variable
Group ID (Device ID) - - - [4] 3
Function Data - - - [4] Variable
[ MAC Data ] [ - - - ] [ 8 ]

The following paragraphs describe the fields in the Enhanced Function

Command message.
5-145
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Message ID
Valid Range: 7
transmitted. The only valid value for the Enhanced Function Command message
is 7.
Response Flag
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.

Field Size: 3 to 16 ASCII characters
Description: The LUNO entry contains a number that allows the network to track
which terminal sent a message once the network removes the communication
protocol from the message. The network can assign a unique LUNO to each
terminal by downloading a LUNO entry as part of the terminal’s installation data.
The terminal then sends this LUNO in the logical protocol of each message that
the terminal sends to the network.
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.

If message authentication (MAC) is used, the Function Command message

contains a time variant number in place of the message sequence number. For
more details on the time variant number, refer to the Data Security Procedures
and Reference Manual (TP-799530-001D).
5-146
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Request message. The terminal assigns a different coordination number to
each successive Consumer Request message on a rotating basis. The valid
range for the coordination numbers is 1 through 9, : ; < = > and ? (ASCII 31
through 3F). If the extended range for message coordination number field bit is
selected in the Miscellaneous Feature 3 field of a Write Command 3 message
(Section 4.23), then the valid range is ASCII 31 through 7E. The network must
include the corresponding coordination number when responding with a Function
Command message. If the coordination numbers do not match, the terminal
sends a Solicited Status message with a Command Reject status.
NOTE
If the Message Coordination Number field in the Function

Command message contains 0 (zero), the terminal accepts
the Function Command message without attempting to verify
that the number matches the message coordination number
sent in the Consumer Request message.
Transaction Serial Number

Description: The Transaction Serial Number entry contains a four-digit decimal
number (0000 through 9999) assigned by the network, on a rotating basis, to the
Function Command messages the network sends to the terminal. It is a required
field in the function command. If a fault occurs while the terminal is performing
a Function Command, this number allows the network to identify which Function
Command the terminal was performing.
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:
• Solicited Status message containing Function Status
• Unsolicited Status message containing Device Status (only when tied to

a Solicited Status message; refer to the Device Status information in this
section)

Description: This three-character data field contains a decimal number in three
bytes of graphic code. This field defines the state number that the terminal should
execute after the normal completion of the specified function command.
Field ID (Update Configuration ID)

Valid Range: ’1’
Description: This three-character field is a field ID that tells the terminal the
next message entry contains Configuration ID data.
5-147
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:
• Configuration Information Request Operational Command ’3’

• Power-up Status
If the configuration data is lost (for example, because of a terminal memory

error or a power failure), the terminal automatically sets its Configuration ID
Data to 0000.
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.
Field ID (Update Special Keys)

Description: The Update Special Keys entry is a field ID that tells the terminal
the next message entries contain data for the Yes, No, and Cancel/Stop keys.
Group ID (Yes Key ID)

Valid Range: 001
Description: The Yes Key ID entry is a Group ID that tells the terminal the next
message entry(ies) contain Yes Key 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
For <emphasis type="ITALIC">ix</emphasis> Series

terminals, there is an option to designate a function key (E, J,
K, L, or M) to be used by the consumer to control the volume
(loudness) of voice messages. If a function key has been
assigned to voice volume control, Agilis 91x for ix/CSP ignores
any attempt to enable that function key for any other use during
a consumer session. For details, refer to Section 4.17.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Yes Key
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.
Group ID (No Key ID)

Valid Range: 002
Description: The No Key ID entry is a Group ID that tells the terminal the next
message entry(ies) contain No Key data.
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
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.
Group ID (Cancel/Stop Key ID)

Valid Range: 003
Description: The Cancel/Stop Key ID entry is a Group ID that tells the terminal
the next message entry(ies) contain Cancel/Stop Key data.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
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
If the Cancel/Stop key top is moved to a physical position other

than the one in which it was delivered, the network must define
the new position as the Cancel/Stop key position.
Field ID (Update Configured Timers)

Description: The Update Configured Timers entry is a field ID that tells the
terminal the next message entries contain Configured Timer Numbers and Timer
data (Silent Time, Beeper Rate, and Beeping Time for each timer).
NOTE
The following four fields, Group ID (Configured Timer

Number), Silent Time, Beeper Rate, and Beeping Time,
can be repeated as often as required, up to the maximum
message length, to include multiple timers. Each set needs
to be separated by a group separator.
Group ID (Configured Timer Number)

Description: Each Configured Timer Number entry is a Group ID that identifies
a group of data entries (Silent Time, Beeper Rate, and Beeping Time) for a
specific configured timer.
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
5-150
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Description: The Silent Time entry defines the amount of time, in ticks, that
a Configured Timer runs or a Special Screen is shown with no beeping. The
terminal uses this timer before starting the timer defined in the Beeping Time
entry.
Beeper Rate
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
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.
Field ID (Update Special Screens)

Description: The Update Special Screens entry is a field ID that tells the terminal
the next message entries contain data for the following Special Screens:
• More Time screen

• Off Line screen
• Out of Service screen
These screens are the only screens that the terminal can show without network
involvement.
Group ID (More Time)

Valid Range: 001
Description: The More Time entry is a Group ID that tells the terminal the next
message entries contain information about the More Time special screen.
Screen Number
5-151
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Description: The Screen Number entry tells the terminal the screen number for
the More Time special screen. The valid values are as follows:
• 000 - Do not show a screen

• 001 through 950, and 999 - Screen number (default value is 000)
Silent Time
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
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
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.
Group ID (Off Line)

Valid Range: 002
Description: The Off Line entry is a Group ID that tells the terminal the next
message entry contains information about the Off Line special screen.
Screen Number
the Off Line special screen. The valid values are as follows:

Group ID (Out of Service)

Valid Range: 003
Description: The Out of Service entry is a Group ID that tells the terminal the
next message entry contains information about the Out of Service special screen.
5-152
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Screen Number
the Special Screen Out-of-service. The valid values are as follows:

Field ID (Update States)

Description: The Update States entry is a field ID that tells the terminal the next
message entries contain State Number and State Data entries. The state data must
be for enhanced states only. Standard 9000 states are not applicable for this field.
NOTE
The following two fields, Group ID (State Number) and State

Data, can be repeated as often as required, up to the maximum
message length, to include multiple states. Each set needs
to be separated by a group separator.
Group ID (State Number)

Description: The State Number entry is a Group ID that tells the terminal the
State Number for the following state data entry.
State Data
Field Size: Maximum length is 150 characters
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.
Field ID (Update Screens)

Description: The Update Screen entry is a field ID that tells the terminal the next
message entries contain Screen Number and Screen Data entries.
Group ID (Screen Number)

Description: The Screen Number entry is a Group ID that identifies specific
Screen Data entries.
Screen Data
5-153
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Each entry is identified by a related Screen Number entry. A complete screen

library stored in terminal memory can hold up to 511 Screen Data entries.
However, unused entries do not need to be downloaded.
Field ID (Update Format Templates)

Description: The Update Format Templates entry is a field ID that tells the
terminal the next message entries contain Format Template Number and
Format Template Data entries. For more details on Format Templates, refer to
Section 4.22.
Group ID (Format Template Number)

Description: The Format Template Number entry is a Group ID that identifies a
specific Format Template Data entry.
Format Template Data

Description: The Format Template Data entries define the type of data the
consumer can enter and how that data is shown on the consumer display.
Field ID (Update FIT)

Description: The Update FIT entry is a field ID that tells the terminal the next
message entries contain FIT Number and FIT Data entries.
Group ID (FIT Number)

Description: The FIT Number entry is a Group ID that identifies a specific
FIT Data entry.
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
messages.
Some examples of the functions a FIT Data entry serves are as follows:
• Allows the terminal to accept consumer identification cards with different

formats and from different institutions
• Tells the terminal the type of PIN verification to perform
5-154
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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
• Allows the terminal to follow alternate branches of state sequencing
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.
Field ID (Update Buffers)

Description: The Update Buffers entry is a field ID that tells the terminal the
next message entries contain Buffer ID and Buffer Data entries.
Group ID (Buffer ID)

Valid Range: ’@’, ’A’ through ’Z’, and 256 through 355
Buffer Data
Field Size: Variable (limited only by the total length limit for the message)
Description: The Buffer Data entry contains the data the terminal stores in the
buffer identified in the Buffer ID entry preceeding this entry.
Field ID (Perform Function)

Valid Range: ’:’
Description: The Perform Function entry is a field ID that tells the terminal the
next message entries contain Device ID and Function Data entries.
Group ID (Device ID)

Valid Range: Any three ASCII-printable characters
Description: The Device ID entry identifies a device type.
Function Data
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.

end of the message.
5-156
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.1 Function Data
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:
• After Hour depository (AH b/)

• Coin dispenser (CN b/)
• Card reader (CR b/)
• Bill dispenser (DI b/)
• Depositor (DP b/)
• Dispenser door (for presenter operation) (DR b/)
• External Options Module (for signage unit and traffic lights, or for solenoid
or electronic safe lock) EX b/)
• Lead-through indicators (LT b/)
• Multiple functions (MF b/)
• Passbook printer (PB b/)
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:
• One or multiple Perform Function entries
• One or multiple update configuration data entries; usually data used in

conjunction with the Perform Function entries (for example, buffer data to
be printed on the receipt printer)
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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 an unsuccessful operation occurs while performing a do

not wait operation, the terminal does not stop the function
processing and does not send the network a Solicited
Device Status message indicating a fault. Instead, the
terminal stores the device status and sends it to the
network only after the transaction is closed (as unsolicited
status). In effect, the terminal treats this type of operation
as completed whether or not a fault occurs.
• 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
While in a Transaction Request state, the terminal does not

send an Unsolicited Status message to the network.
Device Operation Overlap

If sequencing speed is important, the network can use device operation overlap
during function processing. However, the network programmer must consider
carefully the sequence and number of devices that are to operate simultaneously.
5-158
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.2 After Hour Depository (AH b/) Function Data
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
During the deposit operation, the terminal enables

the Cancel/Stop key using either the default key or
network-defined Special Keys, whichever is current. The
terminal voids the deposit operation if the consumer presses
the Cancel/Stop key before inserting the deposit material.
Table 5-53 After Hour Depository Function Data Format
Entry Valid Range
Group ID (Device ID) AH b/
Unit Number 001
Operation 101
The following paragraphs describe the fields for the After Hour Depository
Function Data.

Valid Range: AH b/
Description: The Group ID (Device ID) entry identifies the specific device that
the following function data is for. The only valid value for the After Hour
depository is AH b/.
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
5-160
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
the terminal shows on the consumer display while the terminal is performing the
function. The valid values are as follows:


Description: The Consumer Response Time entry contains the amount of time
screen, the terminal sends the network a Timeout Status message.

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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.3 Coin Dispenser (CN b/) Function Data
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.
Table 5-54 Coin Dispenser Function Data Format
ENTRY VALID RANGE
Group ID (Device ID) CN b/
Unit Number 001
Operation 101, 102
Number of A Coins 000 - 050
Number of B Coins 000 - 050
Number of C Coins 000 - 050
Number of D Coins 000 - 050
Number of E Coins 000 - 050
Number of F Coins 000 - 050
Number of G Coins 000 - 050
Number of H Coins 000 - 050
The following paragraphs describe the fields for the Coin Dispenser Function
Data.

Valid Range: CN b/
the following function data is for. The only valid value for the coin dispenser
is CN b/.
Unit Number
Valid Range: 001
5-162
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Description: The unit number for the Coin Dispenser Function Data must be 001.
Operation
Valid Range: 101, 102
• 101 - Perform a dispense operation, deliver the coins to the withdrawal area,
and wait for the operation to complete.
• 102 - Not used for <emphasis type="ITALIC">ix</emphasis> Series

coin dispensers.
Screen Number

• 001 through 950, 999 - Screen number

Valid Range: 000
consumer display. The only valid value is 000.
NOTE
The terminal requires that the Coin Dispenser Function Data

contain all the Number of Coin entries up to, and including,
the final desired coin type. Intermediate coin type entries
that are not desired must contain a value of 000. However,
the terminal does not require any of the entries after the
final desired coin type entry.
Number of A Coins
Description: The Number of A Coins entry tells the terminal how many A
denomination coins to dispense.
Number of B Coins
Description: The Number of B Coins entry tells the terminal how many B
Number of C Coins
Description: The Number of C Coins entry tells the terminal how many C
Number of D Coins
5-163
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Description: The Number of D Coins entry tells the terminal how many D
Number of E Coins
Description: The Number of E Coins entry tells the terminal how many E
Number of F Coins
Description: The Number of F Coins entry tells the terminal how many F
Number of G Coins
Description: The Number of G Coins entry tells the terminal how many G
Number of H Coins
Description: The Number of H Coins entry tells the terminal how many H
5-164
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.4 Card Reader (CR b/) Function Data
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
Table 5-55 Card Reader Function Data Format
Entry Valid Range
Group ID (Device ID) CR b/
Unit Number 001
Operation 101 - 104, 106 - 107, and 109 - 115
Read Conditions 001 - 017
Reserved 000
Reserved 000
Reserved 000
Reserved 000
The following paragraphs describe the fields for the Card Reader Function Data.

Valid Range: CR b/
the following function data is for. The only valid value for the card reader is CR b/.
Unit Number
Valid Range: 001
Description: The unit number for the card reader Function Data must be 001.
Operation
NOTE
If the terminal uses a swipe-style or dip card reader, the only

applicable Operation entry is 101.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
The valid values for the card reader are as follows:
• 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.
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
card leaves the transport.
• 105 - This value is reserved.
• 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.
• 108 - This value is reserved.
• 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
The name track data cannot be displayed for screens which

insert the name field from track 1 of the card until the
card read operation is complete. Operation 110 must be
performed to complete the sequence. System operation is
unpredictable if another card read operation is attempted
between operation 109 and 110.
• 110 - Wait until the card read started by operation 109 is completed. The
sequence of operation 109 and 110 is equivalent to operation 101.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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

• 001 through 950, and 999 - Screen number to display


Read Conditions
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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.
Reserved (four fields)

Valid Range: 000
Description: These fields are reserved for future use.
5-168
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.5 Bill Dispenser (DI b/) Function Data
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
Typically, the Bill Dispenser Function Data is followed by a

network command to deliver the bills (for example, Dispenser
Door Function Data, operation 101).
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.
Table 5-56 Bill Dispenser Function Data Format
Entry Valid Range
Group ID (Device ID) DI b/
Unit Number 001
Operation 101
Number of A Bills 000 - 050
Number of B Bills 000 - 050
Number of C Bills 000 - 050
Number of D Bills 000 - 050
Number of E Bills 000 - 050
Number of F Bills 000 - 050
Number of G Bills 000 - 050
Number of H Bills 000 - 050
The following paragraphs describe the fields for the Bill Dispenser Function Data.
5-169
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Valid Range: DI b/
the following function data is for. The only valid value for the bill dispenser is
DI b/.
Unit Number
Valid Range: 001
Description: The unit number for the Bill Dispenser Function Data must be 001.
Operation
Valid Range: 101
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: 000
consumer display. The only valid value is 000.
NOTE
The terminal requires that the Bill Dispenser Function Data

contain all the Number of Bill entries up to, and including, the
final desired bill denomination. Intermediate bill denomination
entries that are not desired must contain a value of 000.
However, the terminal does not require any of the entries after
the final desired bill denomination entry.
Number of A Bills
Description: The Number of A Bills entry tells the terminal how many A
denomination bills to dispense.
Number of B Bills
Description: The Number of B Bills entry tells the terminal how many B
Number of C Bills
Description: The Number of C Bills entry tells the terminal how many C
5-170
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Number of D Bills
Description: The Number of D Bills entry tells the terminal how many D
Number of E Bills
Description: The Number of E Bills entry tells the terminal how many E
Number of F Bills
Description: The Number of F Bills entry tells the terminal how many F
Number of G Bills
Description: The Number of G Bills entry tells the terminal how many G
Number of H Bills
Description: The Number of H Bills entry tells the terminal how many H
5-171
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.6 Depositor (DP b/) Function Data for Envelope Depository
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.
For function processing purposes, a deposit operation is considered complete

when the terminal detects that the depository’s rear switch is made and the gate is
closed. The depository’s motor then runs for approximately 0.25 seconds longer
before the terminal continues with function processing.
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
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
When the terminal receives Depositor Function Data, the

terminal enables the Cancel/Stop key using either the default
key or network defined Special Keys, whichever is current. The
terminal voids the deposit operation if the consumer presses
the Cancel/Stop key before inserting a deposit envelope.
If the cumulative Consumer Response Time entry is longer than 15 minutes,

the depository times out at 15 minutes, and the terminal sends the network a
Timeout Status message. However, if the terminal detects a Deposit Cassette Full
condition, the depository times out after 2 minutes.
Table 5-57 Depositor Function Data Format (Envelope Depository)
Entry Valid Range
Group ID (Device ID) DP b/
Unit Number 001
Operation 101
Print Buffer ID ’@’, ’A’ - ’Z’
The following paragraphs describe the fields for the Depositor Function Data.

Valid Range: DP b/
5-172
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
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

• 001 through 950, and 999 - Screen number to display


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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.7 Depositor (DP b/) Function Data for IDM
The format of the Depositor Function Data entries is shown in Table 5-58.
terminal performs.
Table 5-58 Depositor Function Data Format (IDM)
Entry Valid Range
Group ID (Device ID) DP b/
Unit Number 001
Operation 101 - 104
Print Buffer ID ’@’, ’A’ - ’Z’
MICR Buffer ID [1] ’@’, ’A’ - ’Z’
Deposit Bin ID [1] 000 - 003
Image Enable [1] 000, 001, 003, 005, 007
Check Accepted Screen [1] Valid screen numbers
Check Handling Delay Screen [1] Valid screen numbers
Check Handling Delay Time [1] 000 - 255, 900 - 931, 999
MICR Read Position Setting [1] 000 - 001, 004 - 252

[1] These fields are not required for operations 100 and 101.
The following paragraphs describe the fields for the Depositor Function Data.

Valid Range: DP b/
the following function data is for. The only valid value for the IDM is DP b/.
Unit Number
Valid Range: 001
Description: The unit number for the Depositor Function Data must be 001.
Operation
The valid values for the IDM are as follows:
• 100 - No action. The terminal goes immediately to the next function in

the message.


5-174
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
- Read the MICR line as directed by the MICR Read Position Setting field
or the MICR search preference set in the Depositor device properties

Enable field.


ID field. The deposit then proceeds as described in the preceding paragraphs.
• 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.
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.

the Deposit Bin ID field.
Screen Number
5-175
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.


Description: The Consumer Response Time field defines the amount of time
This field is used only with operations 101, 102, and 104. This field is not
used with operations 100 and 103.

Print Buffer ID
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
Description: The MICR Buffer ID field identifies which buffer the terminal uses
to store MICR data read from the check.
Deposit Bin ID
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:


Description: This field contains the number of the screen to display when the
IDM has accepted a check, but has not yet read or scanned the check. If the value
in this field is 000, the terminal does not change the screen currently showing. If
this field is not included, the value defaults to 000.

Description: This field contains the number of the screen to display if the time
specified in the Check Handling Delay Time field expires after the check is
accepted. This screen is used to assure the customer that the check is still being
handled in case the IDM has difficulty locating the MICR data. If the value in
this entry is 000, the terminal does not change the screen currently showing. If
this field is not included, the value defaults to 000.

Description: The value in this entry specifies how long, in 800-millisecond ticks,
to wait from the time the check is accepted until displaying the Check Handling
Delay screen. The valid values for this field are as follows:

MICR Read Position Setting

5-177
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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


5-178
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.8 Dispenser Door (DR b/) Function Data
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.
terminal performs.
Table 5-59 Dispenser Door Function Data Format
Entry Valid Range
Group ID (Device ID) DR b/
Unit Number 001
Operation 101, 103, 105 - 116
The following paragraphs describe each field in the Dispenser Door Function
Data.

Valid Range: DR b/
that the following function data is for. The only valid value for the dispenser
door is DR b/.
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
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
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.
• 106 - Conditional exercise
5-179
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 107 - Unconditional exercise
• 108 - Retain restore, or retract (as applicable), and do not wait. If the current
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.
• 111 - Restore and wait for operation to complete.
• 112 - Retract and wait for operation to complete.
• 113 - Retain and wait for operation to complete.
• 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
• 116 - Retain and do not wait for operation to complete. The terminal goes
Screen Number


screen, the terminal sends the network a Timeout Status message. The valid
values for this entry are as follows:

5-180
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
<emphasis type="ITALIC">ix</emphasis> Series terminals

use an Enhanced Alarms Interface instead of an External
Options Module to control the signage unit. The functionality
is the same.
Table 5-60 Signage Unit Function Data Format
Entry Valid Range
Group ID (Device ID) EX b/
Unit Number 001
Operation 101 - 104
Reserved 000
The following paragraphs describe each field in the Signage Unit Function Data.

Valid Range: EX b/
that the following function data is for. The only valid value for the signage
unit is EX b/.
Unit Number
Valid Range: 001
Description: The unit number for the signage unit function data must be 001.
Operation
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
5-181
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 103 - Turn on the side panel light, turn on the green traffic light, and turn off
• 104 - Turn off the side panel light, the turn off green traffic light, and turn on
Screen Number

Reserved
Valid Range: 000
5-182
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
<emphasis type="ITALIC">ix</emphasis> Series terminals

use an Enhanced Alarms Interface instead of an External
Options Module to control the safe lock. Also, an electronic
safe lock is used instead of a solenoid. The functionality
is the same.
Table 5-61 Solenoid Safe Lock Function Data Format
Entry Valid Range
Group ID (Device ID) EX b/
Unit Number 002
Operation 101 - 102
The following paragraphs describe each field in the Solenoid Safe Lock
Function Data.

Valid Range: EX b/
that the following function data is for. The only valid value for the solenoid
safe lock is EX b/.
Unit Number
Valid Range: 002
Description: The unit number for the Solenoid Safe Lock Function Data
must be 002.
Operation
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Screen Number

5-184
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.11 Lead-through Indicators (LT b/) Function Data
The format of the Lead-through Indicators Function Data entries is shown in

Table 5-62. The Lead-through Indicators Function Data directs the terminal to
perform specific operations.
Table 5-62 Lead-through Indicators Function Data Format
Entry Valid Range
Group ID (Device ID) LT b/
Lamp Number 000 - 255
Condition 000 - 002
Time 000, 001 - 999
Flash Rate 001 - 255
Color [1] 000 - 002

[1] This field is optional. If it is not included in the function data, the value defaults to
000 (green).
The following paragraphs describe each field in the Lead-through Indicators

Function Data.

Valid Range: LT b/
the following function data is for. The only valid value for the lead-through
indicators is LT b/.
Lamp Number
Description: The Lamp Number entry tells the terminal for which lead-through
indicator the function data is specified. The valid values are as follows:
• 001 - Passbook printer
NOTE
• 002 - Card reader

• 003 - Bill dispenser
• 004 - Envelope depository
• 005 - Coin dispenser
• 006 - All indicators
• 007 - Receipt printer
• 008 - Check depository
• 009 - After Hour depository
• 010 through 011 - Reserved
• 100 - Automatic mode
If 100, automatic mode, is used, then the condition and flash rate values are
applied to future automatic lead-through operations.
5-185
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Condition
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
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
Description: The Flash Rate entry specifies the rate at which to flash the
indicator. The flash rate is specified in the following manner:
• 1 through 85 - Low rate

• 86 through 170 - Medium rate
• 171 through 254 - High rate
• 255 - Reserved
Color
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.12 Multiple Functions (MF b/) Function Data
The format of the Multiple Functions Function Data entries is shown in

Table 5-63. The Multiple Functions Function Data allows the terminal to accept
multiple enhanced function commands without requiring Consumer Request
messages between each enhanced function command. This function allows the
network, for example, to send a lot of print data in multiple function commands.
This must be the last function ID in the enhanced function command.
Table 5-63 Multiple Functions Function Data Format
Entry Valid Range
Group ID (Device ID) MF b/
Data 001
The following paragraphs describe each field in the Multiple Functions Function
Data.

Valid Range: MF b/
that the following function data is for. The only valid value for the multiple
functions is MF b/.
Data
Valid Range: 001
Description: The Data entry follows the device ID and must contain 001.
5-187
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.13 Passbook Printer (PB b/) Function Data
NOTE
5-188
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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).
Table 5-64 Printer Function Data Format for Receipt Printer
Entry Valid Range
Group ID (Device ID) PR b/
Unit Number 001
Operation 101 - 108
Print Buffer ID ’@’, ’A’ - ’Z’, 256 - 355
The following paragraphs describe each field in the Printer Function Data for
the receipt printer.

Valid Range: PR b/
that the following function data is for. The only valid value for the receipt
printer is PR b/.
Unit Number
Valid Range: 001
Description: The unit number for the receipt printer function data must be 001.
Operation
If the receipt printer is not equipped with an exit sensor, the valid values are
as follows:
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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.
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:
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.
• 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.
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.
• 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.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
operation to complete. The terminal goes to the next function specified in
the message after the printer has successfully retained the form.
the operation to complete. The terminal immediately goes to the next
function specified in the message.
operation to complete. complete. The terminal goes to the next function
specified in the message after the printer has successfully dumped the form.
the operation to complete. The terminal immediately goes to the next
function specified in the message.
Screen Number


that the terminal waits for the consumer to take the delivered document.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 000 - The interpretation depends on which operation is specified, as follows:
- Operations 001 and 002 - Use timer 21 (If the value of timer 21 is 000, the
terminal does not automatically retain the receipt.)
- Operation 003 - Go to the next function immediately after delivering the

receipt
• 900 through 931 - Configured timers 900 through 931.
Print Buffer ID
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.

to take when a document that has not been removed in the time allotted (as
specified in the Consumer Response Time entry).
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.
• 000 - Retain the document in the retain bin

• 001 - Retain the document on the ground
5-192
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Table 5-65 Printer Function Data Format for Journal Printer
Entry Valid Range
Unit Number 002
Operation 101, 104
Print Buffer ID ’@’, ’A’ - ’Z’, 256 -355
The following paragraphs describe each field in the Printer Function Data for
the journal printer.

Valid Range: PR b/
that the following function data is for. The only valid value for the journal
printer is PR b/.
Unit Number
Valid Range: 002
Description: The unit number for the journal printer function data must be 002.
Operation
• 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

5-193
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004


Print Buffer ID
Valid Range: ’@’, ’A’ through ’Z’, 256 through 355
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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.
Table 5-66 Printer Function Data Format for EDC
Entry Valid Range
Unit Number 003
Operation 101, 104
Print Buffer ID ’@’, ’A’ - ’Z’, 256 -355
The following paragraphs describe each field in the Function Data for EDC.

Valid Range: PR
the following function data is for. The only valid value for EDC is PR b/.
Unit Number
Valid Range: 003
Description: The unit number for the EDC function data must be 003.
Operation
• 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


5-195
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Print Buffer ID
Valid Range: ’@’, ’A’ through ’Z’, 256 through 355
that the terminal prints on the EDC device. The network must fill the buffer
with data before sending the EDC function data.
5-196
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.17 Statement Printer (SP b/) Function Data
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
Table 5-67 Statement Printer Function Data Format
Entry Valid Range
Group ID (Device ID) SP b/
Unit Number 001
Operation 001 - 008
Print Buffer ID ’@’, ’A’ - ’Z’, 256 - 355
Print Data Type 000 - 003
Reserved 000
The following paragraphs describe each field in the Statement Printer Function
Data.

Valid Range: SP b/
Description: The Group ID (Device ID) entry identifies the specific device for
which the following function data is specified. The only valid value for the
statement printer is SP b/.
Unit Number
Valid Range: 001
Description: The unit number for the Statement Printer Function Data must be
001.
Operation
5-197
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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.
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.
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
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Screen Number


that the terminal waits for the consumer to take a presented statement. This
entry is used only with operations 002 and 003. The valid values for this entry
are as follows:

Print Data ID
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.
Print Data Type

Description: The Print Data Type entry identifies the type of print data to print
on the statement printer. This field is only used for print operation 001 and
• 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.
• 002 - The print data is stored in a file in c:\DIEBOLD\TCS\sp. The file

name is SPDATA_x.TXT, where ’x’ is the value in the Print Data ID entry.
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
5-199
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Description: The Unremoved Document Flag entry tells the terminal which
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:
• 000 - Retain the document in the retain bin.

• 001 - Retain the document on the ground.
This entry is only used for print operation 002 (deliver and do not wait).
5-200
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
5.6.18 Do Nothing (.A b/) Function Data
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.
Table 5-68 Do Nothing Function Data Format
Entry Valid Range
Group ID (Device ID) .A b/
Screen Wait Time 001 - 255, 900 - 931
The following paragraphs describe each field in the Do Nothing Function Data.

Valid Range: .A b/
the following function data is for. The only valid value for the Do Nothing is .A b/.
Screen Number

Screen Wait Time

Description: The Screen Wait Time entry tells the terminal the amount of time
to show a screen before going to the next operation. The valid values for this
entry are as follows:

5-201
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Operational Command Message
5.7 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.
The following paragraphs describe each Operational Command message type.
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.
Configuration Information Request

This Operational Command message requests the terminal to send a Solicited
Status message that contains configuration information.
5-202
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Table 5-69 Operational Command Message
Operational Command Identifier 1 1
Command Code - - - 1
[ Data ] [---] [ Variable ]
[ Status Flag ] [---] [1] [ 1 ]
[ Device Name ] [---] [1] [2] [ 4 ]

[1] These fields are included only if Command Code field is = and the network wants to
run an individual device self test.
[2] The Device Name field can be repeated for as many devices as need to be tested.
The following paragraphs describe the fields in the Operational Command

message.

Message ID
Valid Range: 1
transmitted. The only valid value is 1, Consumer Request message or Operational
Command message

Valid Range:
5-203
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004

Command Code
Description: This one-character field is used to identify the type of command.
The valid values for this field are as follows:
• ’1’ - Go in-service to consumers (startup).
• ’2’ - Go out-of-service to consumers (shutdown). This code includes

a modifier which is the number of the screen to be displayed when the
terminal goes out-of-service. If no modifier is included, the default Out-
of-service screen is displayed.
• ’3’ - Configuration information request. This setting directs the terminal

to send Configuration ID status and hardware configuration status for 911
mode and configuration ID status, hardware configuration status, check point
status, and cassette status for 912 mode in one Solicited Status message.
• ’6’ - Authorize unlocking the solenoid safe lock.
5-204
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• ’7’ - Disallow unlocking the solenoid safe lock.
The following paragraph describes a typical use of command codes 6 and

7. This use requires enabling the Maintenance Mode Log to Network
feature through the Miscellaneous Features 2 field of the Write Command 3
message (Section 4.23).
When the network receives a Maintenance mode log entry indicating

that a terminal operator has selected the Supply menu, the network sends
the terminal an Operational Command message that either authorizes or
disallows the unlocking of the solenoid safe lock. Authorization is based on
whether or not the operator identified in the Maintenance mode log entry
is allowed access to the terminal’s safe. For detailed information about
Maintenance mode log entries, refer to Section 5.3.
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.
Refer to the Agilis 91x for ix Maintenance Manual (TP-820589-001E)

for more information on the Supply menu command that unlocks the
solenoid safe lock.
• ’8’ - Enhanced Monochrome Graphics operational command. Refer to the

Enhanced Monochrome Graphics Programming Manual (TP-799300-000A)
for details.
• ’9’ - Retrieve Supply counts (refer to Section 5.2.17 for a list of the supply
counts).
• ’ : ’ - Retrieve and Clear Supply counts.
• ’ ; ’ - Retrieve Enhanced Supply counts (refer to Section 5.2.17 for a list

of the enhanced 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.
• ’ = ’ - Causes terminal to run a self test, provided a consumer is not using

the terminal or the terminal is not in Maintenance mode or Continuous
Availability. If either of these conditions is not met, the command is rejected.
To see the results of tests (unsolicited statuses) at the network, the following
configuration option must be selected: Transaction Host, Message Settings,
Status message, Send unsolicited status messages during maintenance
AND send dispenser and fascia unsolicited status messages anytime.
5-205
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• ’ > ’ - Conditional Go Out-of-service to consumers (shutdown). This

command takes the terminal out-of-service only if the terminal is not in use
when the command is issued. If a consumer is using the terminal or if the
terminal is in Maintenance mode, the terminal rejects the command.
• ’ ? ’ - Reserved for compatibility with TCS
• ’A’- Reserved for compatibility with TCS
• ’B’- Begin network disconnect process (dial-up systems) (Appendix C.2)
• ’C’ - Reserved for compatibility with TCS
• ’D’ - Reserved for compatibility with TCS
• ’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
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:
• ’2’ - Go out-of-service to consumers (optional out-of-service screen number)
• ’8’ - EMG Control Sequence. Refer to the Enhanced Monochrome Graphics

Programming Manual (TP-799300-000A).
• ’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:
- 000 - EPP’s encipherment/decipherment public key certificate

- 001 - EPP’s signature/verification public key certificate
Status Flag
5-206
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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:
• 0 - No unsolicited status is sent unless there is a fault on the device

being tested.
• 1 - Unsolicited status is sent whether there is a device fault or not. If there is

no fault, a :00:00:00 ’J’ type status is sent. For example, if the card reader is
tested and there is no fault, the status CR01:00:00:00 is sent.
Device Name
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:
• AH01 - After Hour depository

• CN01 - Coin dispenser
• CR01 - Card reader
• DI01 - Bill dispenser
• DP01 - Depository (envelope depository or IDM)
• DR01 - Presenter
• PB01 - Passbook printer
NOTE
• PR01 - Receipt printer

• PR02 - Journal printer
• PR03 - EDC
• SD01 - Envelope dispenser
• SP01 - Statement printer
NOTE
If a device requested is not present or not enabled, then

a :3E:00:00 status is sent to the network in response to the
self test request. If an unknown device name is used, the
Operational Command message is rejected.

end of the message.
5-207
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Retrieve and Set/Clear Enhanced Supply Counts Operational Command Message
5.8 Retrieve and Set/Clear Enhanced Supply Counts Operational Command

Message
The format of an Operational Command message used to Retrieve and Set/Clear

Enhanced Supply Counts is shown in Table 5-70. The fields in the message that
are the same as a standard Operational Command message are shaded in the table.
The remainder of the entries are optional. You only need to include the fields that
you wish to set or clear. You must, however, include all the field separators.
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
Command Code < 1
[ Device ID ] [ DP01 ] [1] [ 4 ]
[ Clear Deposit Counts Flag ] [ - - - ] [1] [ 1 ]
[ Device ID ] [ CR01 ] [1] [ 4 ]
[ Clear Card Count Flag ] [ - - - ] [1] [ 1 ]
[ Device ID ] [ DI01 ] [1] [ 4 ]
[ Loaded Count, Position 1 ] [ - - - ] [1] [ 5 ]
Group Separator hex 1D [1] 1

[1] All the fields in these boxed areas are optional. If any of these fields are included, 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.
[2] All the fields in this boxed area are optional. The fields only need to be included if the After Hour depository needs to be
[3] This field separator is only needed if any of the following fields, up to the Protocol Trailer, are included in the message.
[4] All the fields in this boxed area are optional. The Device ID fields and their associated fields can appear in any order.
5-208
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
(continued)
[ Dispense Count, Position 1 ] [ - - - ] [1] [ 5 ]
[ Divert1 Count, Position 1 ] [ - - - ] [1] [ 5 ]
[ Group Separator ] hex 1D [1] [ 1 ]
[ Retract Count, Position 1 ] [ - - - ] [1] [ 5 ]
[ Device ID ] [ CN01 ] [1] [ 4 ]
[ Device ID ] [ AH01 ] [2] [ 4 ]
[ Clear Deposit Counts Flag ] [ - - - ] [2] [ 1 ]

5-209
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
(continued)
[ Device ID ] [ SD01 ] [4] [ 4 ]
[ Loaded Count ] [---] [3] [4] [ 5 ]
Group Separator hex 1D [3] [4] 1
[ Dispense Count ] [---] [3] [4] [ 5 ]

Operational Command message.
Device ID
Valid Range: DP01
Description: This is a four-character field that indicates the following
information affects the depository.
Clear Deposits Count Flag

Description: The Clear Deposits Count Flag tells the terminal to clear the
Deposits counts if this field contains a 1. If it contains a 0, the counts are not
cleared, but are included in the Solicited Status message sent back to the network.
Device ID
Valid Range: CR01
information affects the card reader.
Clear Card Count Flag

Description: The Clear Card Count Flag tells the terminal to clear the Retained
Cards count if this field contains a 1. If it contains a 0, the count is not cleared
but is included in the Solicited Status message sent back to the network.
Device ID
Valid Range: DI01
information affects the bill dispenser.
5-210
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Loaded Count
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
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
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
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
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
Valid Range: CN01
Description: This field indicates that the following information affects the
coin dispenser.
Loaded Count
Description: The Loaded Count fields load counter information into the
Loaded counters for each dispense position. The Loaded counters record the
5-211
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
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
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
Valid Range: AH01
information affects the After Hour depository.
Clear Deposit Counts Flag

Description: This flag tells the terminal to clear the deposit counts for the After
Hour depository if this field contains a 1. If it contains a 0, the counts are not
cleared, but are included in the Solicited Status message sent back to the network.
Device ID
Valid Range: SD01
information affects the envelope dispenser.
Loaded Count
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
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced Operational Command Message
5.9 Enhanced Operational Command Message
The Enhanced Operational Command message is used to set or retrieve the

current system time and date at a terminal. The structure of this message is similar
to the standard Operational Command message. Only the areas that are different
are described in this section. Table 5-71 shows the format of the Operational
Command message with the unchanged fields shaded. The response to this
message is a Ready Solicited Status message with any buffer data appended.
Table 5-71 Enhanced Operational Command Message
Command Code 025 3
Data Identifier (action code) - - - 2
Command Data - - - Variable
Operational Command message.
Operational Command Identifier

Valid Range: 5
transmitted. The only valid value is 5, Enhanced Operational Command message
Command Code
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
Description: The Data Identifier field contains the code indicating which action
the command should take. The valid values are as follows:
• SD - Set date and time

• GD - Get date and time
5-213
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Enhanced Operational Command Message
Command Data
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:
- YYYY - four-digit year

- MM - two-digit month
- DD - two-digit day
- HH - two-digit hour (24-hour style)
- MM - two-digit minutes
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Write Command 5 Message (Open Account Relationship [OAR] screens)
5.10 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.
[ Logical Unit Number (LUNO) ] [ X ] [ 3 or 9 ]
Write Identifier (OAR) 2 1
Display Flag - - - 1
[ Format Template ] [1] [ - - - ] [ 3 ]
[ Options ] [2] [ - - - ] [ 3 ]
Active Keys - - - 6, 10, or 14
Screen Timer - - - 3
Screen Data - - - Variable

[1] The Format Template field is only included if the Display Flag field is 3 or 4.
[2] The Options field is only included if the Display Flag field is 4.
The following paragraphs describe the fields in the Write Command 5 message.

5-215
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Message ID
Valid Range: 3
transmitted. The only valid value for the Write Command 5 message is 3.

Valid Range:

Write Identifier
Valid Range: 2
Description: This one-character data field tells the terminal that OAR screen
data follows. The valid value is ’2’.
Display Flag
Description: This one-character field directs the terminal display as follows:
• ’0’ - Display Xs as consumer response.
• ’1’ - Display consumer response.
• ’2’ - Display Xs as consumer response.
• ’3’ - Use the Format Template specified in the three characters that follow
the Display Flag field in the OAR Write Command 5 message.
• ’4’ - Use the options specified in the three-character Options field.
The keyed response is stored in General Purpose Buffer B for later transmission
in a Consumer Request message.
Format Template
5-216
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Description: This three-character field is only necessary if the Display Flag

field is 3 or 4. This field tells the terminal what Format Template to use
for this transaction.
Options
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:
• 000 - No options set.
• 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.
• 002 - Function Key required to terminate OAR and send up Transaction

Request. This setting allows the consumer to stay in the OAR function after
the format template has been filled. It forces the consumer to press a
function key (A,B,C, and so on) to exit the OAR function.
Active Keys
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:
• First character selects all numeric keys

• Second character selects function key A
• Third character selects function key B
• Fourth character selects function key C
• Fifth character selects function key D
• Sixth character selects the Cancel key (function key E)
• Seventh character selects function key F
• Eighth character selects function key G
• Ninth character selects function key H
• Tenth character selects function key I
• Eleventh character selects function key J
• Twelfth character selects function key K
• Thirteenth character selects function key L
• Fourteenth character selects function key M
NOTE

5-217
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Screen Timer
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
Valid Range:
Description: This is a variable-length field that represents data to be displayed
on the consumer display.

end of the message.
5-218
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959062
Figure 5-2 Write Command 5 Message Sequence
5-219
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Common Command Reject Conditions
5.11 Common Command Reject Conditions
The terminal sends Common Command Reject status if an error is detected in

any command sent from the network to the terminal. The following examples
cause a command reject from a terminal:
• Message ID field was not a 1, 3 or 4.
• 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).
• Two-byte ASCII field does not convert to 00 through 99 (for example,

terminal timer 07; ’30 37’ converts to 07).
• Dispense amount exceeds 30 bills on either side.
• End of text field or a field separator was in the transaction serial number
field.
• Error found in Function Command screen number data field or screen

display update 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 ’;’.
• Command Code field was not ’1’, ’2’ or ’3’.
• 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 ’>’.
• Write Command Identifier field was not ’1’, ’2’ or ’3’.
• Configuration ID Number field contains End of Text code.
• The Logical Unit Number field contains End of Text code.
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
• 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.
• Write Command Modifier for Write Command 7 (encryption key change)

message was not in the range of ’1’ through ’9’.
• The terminal is in the In-service mode, but not in the Transaction Request
state.
• A message is missing a non-optional field.
• A field in a message contains an invalid character.
• The terminal does not have enough available memory to store all the
downloaded data.
If any of the following occurs in a Function Command message, the terminal

sends a general command reject Solicited Status message.
• 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 received a Function Command message that contains more

than eight function identifiers.
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959064
Figure 5-3 Function Command Message Accept/Reject Flowchart
5-222
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Appendix A
ASCII-to-EBCDIC Code Conversion Chart
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
ASCII-to-EBCDIC Code Conversion Chart
@ 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Appendix B
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
Figure B-1 Legend
B-1
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959066
Figure B-2 Main Flow Diagram
B-2
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959067
Figure B-3 Check Deposit with Cash Back Transaction Flow Diagram
B-3
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959068
Figure B-4 Cash Check and Deposit Check Transaction Flow Diagram
B-4
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959069
Figure B-5 Possible Network Actions Flow Diagram
B-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959070
Figure B-6 Error Recovery Flow Diagram (sheet 1 of 2)
B-6
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
g1959071
Figure B-6 Error Recovery Flow Diagram (sheet 2 of 2)
B-7
TP-821029 (Ed. A)
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.
C.1 General Operation Guidelines
This section contains general operation guidelines for operating Diebold ATMs.
The host should not allow withdrawals when the chest door (safe door) is open.
C.2 Transaction Verification Status Feature
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:
• Transaction serial number from previous function command

• Response to previous function command
• Whether or not a retract operation occurred
• Bill denomination IDs and bill delivered counts for each dispense position
• Coin denomination IDs and coin delivered counts for each dispense position
This information makes it easier to verify a transaction in case of a power failure

or communication problems during the transaction.
Enabling the Transaction Verification Status Feature

To enable the Transaction Verification Status feature, bit 6 of the Miscellaneous
Features 3 field in the Write Command 3 message must be set (Section 4.23).
C.3 Media Player
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.
C.3.1 Hardware and Software Requirements
The following software and hardware is necessary for the Media Player feature:
• Agilis 91x for ix/CSP

• CDROM drive
These are the minimum requirements for the Media Player feature.
C-1
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
C.3.2 Implementation Information
A control sequence imbedded in screen data is used to identify a MPEG movie

file to be played by the media player. The format and implementation of this
control sequence is described in Section 4.7.39.
C.3.3 Programming Considerations
The MPEG encoding bit rate recommended is 2.0 Megabits/second, 1.80

Megabits/second video and 192 Kilobits/second audio. This bit rate yields a high
quality MPEG. Lower bit rates produce noticeable quality degradation.
C.3.4 Making the Media Player Work
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):
ECM03 (sets the screen resolution to 640 x 480)
ECC0F (sets the background and forground colors)
FF (clear the screen)
ECF20 (select a font)
SICCWELCOME! (screen text)
SINCINSERT CARD|SIPCFOR SERVICE (more screen text)
ECZU"MPEGPlay"1 1 "welcome.mpg" 0000 9999 0000 0000 1 000 R

(play the Welcome MPEG file, full screen, colorkey black, repeat mode)
FS
This data displays a screen showing WELCOME! INSERT CARD FOR

SERVICE with a repeating Welcome MPEG playing.
C-2
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
C.3.5 Working with Channels
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.
Some possible examples of channel types are as follows (significance

highlighted):
• Channel(s) to display content in a captivated session to the consumer.
• Channel(s) to display content in a non-captivated (ability to cancel or

move on) session.
• Channel to display content after a withdrawal function.
• Channel to display content after a deposit operation.
• Channel used for attraction to the ATM (card read welcome state).
Channel Search Algorithm

The search algorithm for channel files referenced within a screen library is
identical to the search algorithm used by the ATM system for MPEG file
references described in Section 4.7.39.
C-3
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
File Exchange Protocol

The file exchange protocol utilizes the file system to solve the following two
requirements:
• 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.
C.3.6 Updating Files
Update Protocol for Channel Files

Since Channel data is very short compared to MPEG data, a temporary file is
not necessary. The channel file cannot be temporarily deleted because this
causes a "hole" in the Agilis 91x for ix/CSP search path resulting in possible
delays and/or missed MPEG play operations. The channel file can be updated
by the following methods:
• Copying a new channel file into its place.

• Opening channel file (non-share), updating contents, then closing the file.
Update Protocol for MPEG files

To avoid possible collisions between systems when operating on MPEG files
(play, read, write, rename, update) a file semaphore is used. The semaphore file
shall have no specific content (0 length). The semaphore must be named using the
same root as the MPEG file; however, the extension must be .sem. The location
of the semaphore is the same as the underlying MPEG file. Non-writeable media
such as CDROM does not require semaphore control for MPEG file access.
The semaphore file serves two purposes in the system:
• Synchronize access to the MPEG file. Protection from multiple applications

accessing and operating on the file at the same time.
• 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.
Locking the semaphore requires the application to open the semaphore in

read-write, non-share mode. This mode prevents other applications from opening
the file in the same mode while the semaphore is locked.
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
TP-821029 (Ed. A)
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.
• c:\movies\lang000\welcome.mpg - The MPEG file

• c:\movies\lang000\welcome.sem - The semaphore file
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.
In order to maximize availability of MPEG files in the system any application

that desires to update an MPEG file must first create a temporary (.mp_) file
in the same location as the MPEG file. Then the application should delete the
original MPEG file and (quickly) rename the temporary file to the original name
(.mpg). This effectively updates the MPEG file very quickly and, in the case of a
collision, minimizes wait time at the ATM.
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).
Logging Channel and MPEG Play Information

To assist in managing client accounts for companies playing advertising on
ATMs, each time a MPEG file is accessed and played by Agilis 91x for ix/CSP
Media Player Support, information is logged. To enable Agilis 91x for ix/CSP
to log information, an entry must be made in the CONFIG.SYS file. This
entry is as follows:
set TCSMEDIALOGUTILITY=c:\ibold\utils\(program filespec)
where program filespec is the name of a user-provided program that is called

each time an MPEG file is played at the ATM. The parameters passed to the
filespec specified are as follows:
• -c"ChannelFileSpec" (the MPEG channel file)

• -m"MPEGFileSpec" (the MPEG file played)
• -t"mm:dd:yyyy:hh:mm:ss" (the current time)
• -s"mm:dd:yyyy:hh:mm:ss" (MPEG start time)
• -e"mm:dd:yyyy:hh:mm:ss" (MPEG end time)
• -p"c" (completion code, 1 = complete, 0 = incomplete)
NOTE
The ChannelFileSpec field is optional and can be null or

not present when the MPEG file is played directly and not
from a channel.
Example REXX Application

A sample REXX program called chsutil.cmd is provided with Agilis 91x for
ix/CSP. This utility provides a means to automatically rotate MPEG files
referenced in a channel file. The next MPEG played is based on a list of MPEG
files located in a channel configuration file.
C-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Channel Configuration File

A configuration file that has the same root as the channel file with a.cnf
extension is used to control what MPEG references are used in the channel
file. The configuration file must be located in the same subdirectory (and
drive) that the channel file is located. The media must be writeable such as a
hard disk (not CDROM).
The format of the configuration file is as follows:
FirstMPEGReferenceLine
SecondMPEGReferenceLine
ThirdMPEGReferenceLine
...
...
LastMPEGReferenceLine
Where an MPEG reference line can contain from one to three

MPEG file references in the same format as ATM screen data (e.g.
mpeg1.mpg+mpeg2.mpg+mpeg3.mpg).
NOTE
To ensure complete play of a MPEG reference line, verify

that the last MPEG file referenced in the line is unique when
compared to the other MPEG references in the line.
C.4 Intelligent Depository Module
This section discusses the implementation of character recognition for the

Intelligent Depository Module (IDM). For a description of the IDM device
and capabilities, refer to Section 3.4.
Generalized State Flow

To perform character recognition on a deposited document, the following
generalized state flow is required:
1. An Image Character Recognition state (IC b/) specifying operation

000 (enable) is used to define the document fields on which character
recognition should be performed.
2. A Depositor state or function (DP b/) specifying operation 002 (deposit to

escrow) is used to accept and scan the deposited document.
3. An Image Character Recognition state (IC b/) specifying operation 001

(read) reads the specified document fields from the captured image and
places the data in the specified buffers.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Defining the Required Document Fields

An Image Character Recognition state (IC b/) specifying operation 000 (enable) is
used to define the document fields on which character recognition should be
performed. The state data must specify windows for all document fields that
character recognition should be performed on. At minimum, the state data must
specify the MICR window (window 1-1-2).
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.
Accepting and Scanning the Document

A Depositor state or function (DP b/) specifying operation 002 (deposit to
escrow) is used to accept and scan the deposited document. To enable the IDM to
scan the document, the Image Enable field must contain a non-zero value (001,
003, 005, or 007).
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.
Reading the Document Fields

An Image Character Recognition state (IC b/) specifying operation 001 (read)
reads the specified document fields from the captured image and places the
data in the specified buffers.
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.
Verifying That the Courtesy Amount Characters Are Valid

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.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
EXAMPLE
The following example shows how to perform character recognition on a U.S.

personal check. The terminal reads both the MICR line and the courtesy amount.
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
C.5 Euro Support
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:
Video Mode Font
CGE Standard set
C-8
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Video Mode Font
CGF Standard set

Helvetica set
Century set
VGA Plus Standard set

Helvetica set
Century set
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.
If the printer is configured for one of the text-related strategies or the

pass-through strategy, the euro character does not necessarily reside at hex 7F.
Its presence or location (implementation) is printer specific. In the case of the
48-column thermal receipt printer, this character resides at hex D5. Refer to the
documentation supplied with the printer.
C.6 Agilis 91x Browser Support
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.
This following sections provide information on how information is transferred

between the browser and Agilis 91x.
C.6.1 Transferring Event/information from the Browser to Agilis 91x
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
All reserved URLs are case sensitive.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
NOTE
The browser never really tries to navigate to a.tcskey, because

Agilis 91x is in an information entry state (@D, E, F, H, M, B)
waiting for keystroke input. In addition, the URL is intercepted
and acted on prior to navigation and then suppressed, so that
the browser never really tries to navigate to a.tcskey.
g5233034
Figure C-1 HTML to Agilis 91x Data Transfer
Table C-1 Predefined Reserved URLs
Reserved URLs Description

(Case Sensitive)
a.tcskey Sends function key code "a"
b.tcskey Sends function key code "b"
c.tcskey Sends function key code "c"
d.tcskey Sends function key code "d"
e.tcskey Sends function key code "e"
f.tcskey Sends function key code "f"
g.tcskey Sends function key code "g"
C-10
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Table C-1 Predefined Reserved URLs (continued)
Reserved URLs Description

(Case Sensitive)
h.tcskey Sends function key code "h"
i.tcskey Sends function key code "i"
j.tcskey Sends function key code "j"
k.tcskey Sends function key code "k"
l.tcskey Sends function key code "l"
m.tcskey Sends function key code "m"
period.tcskey Sends the decimal point character ( . )
0.tcskey through 9.tcskey Sends the numbers 0 through 9, respectively,
@.getbuf Causes Agilis 91x to invoke the javascript method,

showbuf(), with the content of buffer @
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
@.setbuf Sets the content of buffer @
A.setbuf through Z.setbuf Sets the content of buffers a through z and buffers 256
256.setbuf through through 355, respectively
355.setbuf
C.6.2 Transferring Data from Agilis 91x to the Browser
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
TP-821029 (Ed. A)
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
Figure C-2 Agilis 91x to HTML Data Transfer
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
TP-821029 (Ed. A)
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();
}
}
C.7 ATM Soft Lock Feature
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.
Using ASL allows software upgrades and other software service-related

operations to be completed at the ATM knowing that the ATM is not being
used by a consumer, service person, teller, or host application during the time
that the service is being performed.
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 out-of-service state and is not in Maintenance mode.
• 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Agilis 91x for ix/CSP GUI Interface

During the period of time that the ATM is soft locked, the Agilis 91x for ix/CSP
GUI interface blocks access to maintenance-related menu items (such as Logon
and Shutdown) on the Agilis 91x for ix/CSP Software Logon screen. An icon
representing the soft-locked status is displayed in the position used to display the
current state number on the Agilis 91x for ix/CSP Interface. The icon is a picture
of a padlock. The text next to the icon reads "Locked". Upon removal of the soft
lock, this icon and text are removed from the Agilis 91x for ix/CSP Interface.
Issuing Soft Lock and Unlock Commands

The following command, typed at the command line, soft locks the ATM:
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 -?
C.8 Native Capabilities of the Journal Printer
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.
Table C-2 Journal Printer Standard Character Set
Character ASCII (Hex) EBCDIC Character ASCII (Hex) EBCDIC (Hex)

(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
C-14
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Table C-2 Journal Printer Standard Character Set (continued)
Character ASCII (Hex) EBCDIC Character ASCII (Hex) EBCDIC (Hex)

(Hex)
% 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
C-15
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Table C-3 Journal Printer Alternate Character Set
Table C-4 Journal Printer Control Sequences
LF Prints a line of characters, then does a carriage return and a line feed.
VT Enables the alternate character set for one character.
FF Does a line feed.
C-16
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Application Notes
Table C-4 Journal Printer Control Sequences (continued)
CR Prints a line of characters, does a carriage return.
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 P Does a line feed.
ESC & Sets 10 CPI horizontal pitch.
ESC ’ Sets 12 CPI horizontal pitch (default).
ESC ( Sets 16 CPI horizontal pitch.
ESC ) Sets 10 CPI horizontal pitch with double-density printing.
ESC 4 Enables the alternate character set (more than one character).
ESC 5 Disables the alternate character set.
ESC @ Resets the printer to the standard character set, single-width printing, and the default horizontal and
vertical pitches.
ESC W 0 Cancels double-width printing.
ESC W 1 Sets double-width printing.
Table C-5 Printer Control Sequence Cross-reference
Control Code ASCII Hex EBCDIC Hex

Equivalent Equivalent
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Appendix D
VGA Plus
This appendix is for application programmers responsible for the configuration

and operation of Agilis 91x for ix/CSP terminals that use 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.
About the VGA Plus Feature

The VGA Plus Feature provides enhanced graphic capabilities for both the
VGA color consumer display and the VGA monochrome consumer display.
This section presents an overview of the VGA Plus Feature and it offers some
suggestions about getting started with VGA Plus.
To implement VGA Plus, a terminal’s consumer display must meet the following
minimum requirements:
• Monitor capable of 640-by-480 resolution and at least 24 colors

• DirectX-compatible video card
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:
• Specifying the text of screen messages

• Positioning text and icons on the consumer display
• Selecting background and foreground colors
• Selecting the appropriate character set for text
• Establishing backgrounds for text and icons
• Using icons to create animation
• Invoking special effects such as scrolling and blinking
The following additional display actions are functions of screen data available
with VGA Plus:
• Displaying the date and time on the screen
• Specifying the screen resolution
• Selecting a foreground color with a transparent background color
D-1
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
• Using a color wheel to cycle a specific color on the screen through a

series of colors
• Selecting fade-out and fade-in transitions between screens
• Using sprites to create enhanced animation effects
• Defining positions on the screen at a pixel level
• Invoking special effects, such as sprinkle and wipe
• Displaying FLC and FLI file types
• Displaying transparent GIF file types
The application can send screen data to the terminal at various times during
terminal operation, as described in Appendix D.1.
D.1 Background Information
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.
About Screen Data

Screen data specifies what the terminal displays and how it should display it.
Screen data consists of control sequences and text. You can use screen data to
control display features such as fonts, icons, sprites, colors, blinking, sprinkle,
and inverse video.
Powerup Screen Data

Powerup screen data is screen data stored in powerup screen files. At powerup,
the terminal loads the powerup screen files into memory and overwrites any
screen data that exists in the screen library. If desired, the terminal can use
powerup screen data to define screens instead of downloading the screens from
the network. Powerup screen data is not a substitute for the Local Screen
Changes (LSC) application.
The default powerup screen file (VGADFLT.SCR) contains the following

reserved screens:
• 001 - Off Line screen

• 002 - Out of Service screen
D-2
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
• 004 - Currency Character screen

• 006 - Decimal Character screen
• 007 - Remove Currency screen
For more information about reserved screens, refer to Section 4.10.
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:
PPP x SSS x CCC
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:
Pixels Scan Lines Colors Resolution Type
640 480 16 high
320 240 256 low
320 200 256 low
640 480 256 high
1024 768 256 high
Sometimes, this appendix describes resolutions collectively. Refer to the

following table for examples:
Phrase used in Appendix Resolutions indicated
Resolutions that permit 256 colors 1024 x 768 x 256

640 x 480 x 256
320 x 240 x 256
320 x 200 x 256
High-resolution modes 1024 x 768 x 256

640 x 480 x 256
640 x 480 x 16
Low-resolution modes 320 x 240 x 256

320 x 200 x 256
About the DAC

Since the terminal’s processor is digital and the consumer display is analog,
the terminal must convert digital signals to analog signals using a DAC. The
DAC enables the terminal to display as many as 256 different colors at once
from a range of 262,144 colors by generating analog red, green, and blue signals
for the consumer display.
D-3
TP-821029 (Ed. A)
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:
• Video DAC logical AND mask (a register)

• 256 18-bit video DAC registers (used to set up VGA video DAC 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.
Figure D-1 DAC Block Diagram
About the Palette

The terminal uses a set of 16 palette registers to display text and icons in the 640
x 480 x 16 resolution. Palette registers allow you to select 16 custom colors and
map them to 16 of the available 256 colors of the current DAC setup. This manual
uses the term palette setup to indicate the current values in the palette registers.
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
TP-821029 (Ed. A)
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:
Byte Flag Description
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.
2 Color select register value. Range 0 through 15.
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.
3 - 18 Palette register 0 through 15 values. Range 0 through 63

for each register.
Figure D-2 Relationship Between Palette and DAC
D-5
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
About Custom Icons and Custom Files

When this appendix uses the term custom to define icons and files, it means you
must create the icons and files. You can use the Diebold Design Utility (DDU)
to create custom icons and custom DAC files. Sometimes custom icons are
called DDU icons. Refer to Appendix D.5.6 for more information on DDU.
You can also rename existing files in the PCX and GIF format as iconxxx.pcx
and iconxxx.gif and use them as custom icons. Or, you can use any third party
software designed for the purpose to create GIF and PCX files for use as custom
icons. Refer to Appendix D.17 for information on creating custom Palette and
Color Wheel files.
About Default Files, Prepackaged Icons, and Prepackaged Character

Sets
Prepackaged icons and character sets are provided with VGA Plus. When
this appendix uses the term default to define files, it means they are provided
with VGA Plus.
D-6
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.2 Directories, Files, and Libraries
This section describes VGA Plus directories, files, and libraries.
D.2.1 Directories
When consumer display is configured for VGA color, the terminal loads
configuration data from the following \DIEBOLD\TCS subdirectories:
• ADP00 - Contains files associated with high resolutions

• ADP01 - Contains files associated with low resolutions
There are two subdirectories because the high-resolution screens require

the enhanced character set, and low-resolution screens require the standard
character set.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-1 Configuration Files in ADP00 and ADP01 Subdirectories
File Type Naming Default Description

Conventions[1]
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.
Frame FRAMEnnn.SPR No Frame files store 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.
Table D-2 Configuration Files in \DIEBOLD\TCS
File Type Naming Default Description

Conventions
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.
The terminal automatically processes configuration files at powerup. Since the

monochrome consumer display requires different DAC and palette configuration
files, the install disk requests information on the type of display system present
and then copies the proper configuration files.
D-8
TP-821029 (Ed. A)
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.
Table D-3 Sample Files
File Name Description
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:
Character Set Definitions Directory
16 x 24 \DIEBOLD\TCS\ADP00\*.LIB
8 x 12 \DIEBOLD\TCS\ADP01\*.LIB
D.3 Screen Data Flow
This section presents simplified block diagrams that show how the terminal
performs the following tasks:
• Accesses the correct directory based on the ESC M control sequence

(select resolution) parameters
• Selects the correct DAC file based on the ESC O control sequence (select
DAC) parameters
D-9
TP-821029 (Ed. A)
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
• Displays the screen on the consumer display in the correct resolution

and colors
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.
Figure D-3 Screen Data Flow for 16-color Screen
D-10
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Figure D-4 Screen Data Flow for 256-color Screens
D-11
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.4 Terminal Operation
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.
If your terminals have a terminal-resident application, such as the Terminal

Control Software Extended Application (SXA), the application can load the
screen data from the terminal’s hard disk. If you have a host- or controller-based
application, the host or controller sends the screen data to the terminal in Write
Command 2 messages. The application uses the same message sequencing and
message formats to send screen data to terminals equipped with VGA Plus as it
uses for standard Agilis 91x for ix/CSP terminals.
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.
Maintenance of Graphics during Power Loss

The files that define icons, palette, DAC converter, powerup screens, sprites, and
character sets are maintained on the terminal’s hard disk. This data is not lost
during power loss. A terminal that supports SXA with LSC stores configuration
data on its hard disk and might maintain screen data during power loss. If
the terminal’s configuration ID is still correct after powerup, the previous
configuration data, including the screen data is intact.
D.5 Getting Started
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.5.1 How the Network Recognizes VGA Plus Terminals
The network sends an Operational Command message (command code 3) to

request the configuration status from terminals. Terminals respond by sending
Solicited Status message containing configuration information. Part of this
configuration information indicates if a terminal supports VGA Plus. After the
network verifies that a terminal is a VGA Plus terminal, the network can send
VGA Plus screens to the terminal. Refer to Section 5.7 for details on using an
Operational Command message from the network to request configuration
status data from terminals.
D.5.2 How to Set Up a Terminal to Support the VGA Plus Feature
The consumer display configuration options must be set to permit the terminal to
support the VGA Plus feature.
D.5.3 Modifying Screen Data
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.5.4 Using Chinese Characters
The prepackaged Chinese characters require a 40-by-20 screen type. To meet

this requirement, the following configuration option must be selected on all
terminals that are displaying the prepackaged Chinese characters: Consumer
Display, Display Grid, 40 x 20.
D.5.5 Replacing the ESC Character
The ESC character (hexadecimal 1B in ASCII) is part of several of the screen

data control sequences. The use of ESC in screen data should not present a
problem for most ATM systems. However, if your institution cannot use the
ESC character in screen data or does not wish to use the ESC character, you
can select an alternate character. To avoid a conflict with other screen data and
communication control characters, characters between hexadecimal 60 and 7E
on the ASCII chart are recommended as an alternative to ESC. This range
includes all the lowercase letters a through z and a few other symbols. Refer to
Appendix A for the ASCII chart. The alternate ESC character you select must be
entered during configuration (Consumer Display, Escape Character, 027). After
you enter the character during configuration, the terminal accepts both ESC and
the alternate character in screen data and interprets both to mean ESC.
D-13
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.5.6 Creating Custom Icons
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).
Compatible Graphic Format

VGA Plus accepts icons in the following formats:
• 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
TP-821029 (Ed. A)
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.
Icon Size and Resolution

There are times that you might wish to display the same icon in different
resolutions. Assume you have a custom icon that is 200 pixels across by
200 pixels down. If you want it to take up most of the screen, put it in the
low-resolution library (ADP01). Then, use an ESC M in the screen data to display
the icon in one of the following resolutions: 320 x 240 x 256 or 320 x 200 x 256.
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.
Storing Custom Icons

After creating custom icons, you should store the icon files and, if applicable,
custom palette or custom DAC files on diskettes. Be sure to label the diskettes
with the filename(s) and the appropriate library for each file. Refer to
Appendix D.16.1 for information on loading the custom icons.
D.5.7 Using a High-intensity Monochrome Monitor
The VGA monochrome consumer display is a high-intensity monochrome

monitor. If you intend to display the same screens on all terminals in the system,
and you have both VGA color consumer displays and VGA monochrome
consumer displays in your system, the colors you select might not be readable on
the VGA monochrome consumer displays under intense sunlight conditions. You
should try your color screens out on high-intensity VGA monochrome monitors.
If you have trouble reading them, the following paragraphs provide suggestions to
make color screens easier to read on high-intensity VGA monochrome monitors.
If You Are Using a Color Graphics Feature Screen Load

Select the monochrome DAC to display 16-color icons on high-intensity
VGA monochrome monitors. When the system is installed, terminals with
monochrome monitors default to the monochrome DAC.
If You Are Using Custom Icons

Use a paint package that runs on your PC to convert your custom icons to a
gray scale. The gray scale provides the proper intensity for each color. After
you convert the custom icons to a gray scale, use DDU to create a custom
DAC for each icon.
D-15
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
If You Are Using Prepackaged Icons

Create a custom high-intensity DAC that sets the colors you want visible to
high-intensity colors, such as bright white, and the background colors to
low-intensity colors, such as black.
D.5.8 System Requirements
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.
D.5.9 Related Documentation
The documents described in the following paragraphs provide additional

information on VGA Plus.
VGA Plus Quick Reference Guide (TP-799502-000A)

The quick reference guide summarizes the information presented in this
appendix. When you are familiar with the concepts, examples, and information
presented in this appendix, you can use the quick reference guide to aid you in
designing screens.
VGA Plus Prepackaged Icons and Character Sets (TP-799508-000A)

This manual describes the prepackaged icons and character sets available for
VGA Plus.
D.6 Screen Design
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
A screen is a unit of consumer display information. Each screen has an

identifying number (called the screen number) between 000 and 999 (decimal)
and contains screen data, which specifies what to display and how to display
the screen.
D-16
TP-821029 (Ed. A)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
In This Appendix Hex Equivalent (ASCII)
FF 0C
SI B K 0F 42 4B
PLEASE b/TAKE b/CASH 50 4C 45 41 53 45 20 54 41 4B 45 20 43 41 53 48
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.6.2 Display Area, Format, and Resolution
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 (controlled by screen data)

• Resolution (controlled by screen data)
• Screen type (controlled by configuration settings)
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.
Table D-4 Number of Rows in the Display Area
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-5 VGA Plus Resolutions
Mode Pixels Scan Lines Colors Resolution Type
00 640 480 16 high
01 320 240 256 low
02 320 200 256 low
03 640 480 256 high
04 1024 768 256 high
05 800 600 256 high
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
VGA Plus displays existing 640 x 240 x 16 DDU icons, which

were created using the Color Graphics Feature, in the 640 x
480 x 16 resolution. When VGA Plus encounters a 640 x 240 x
16 icon type, VGA Plus doubles the horizontal scan lines.
This makes the Color Graphics Feature icons compatible with
VGA Plus screens.
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)
The screen type is controlled by configuration settings: VGA Plus supports

all the above screen types.
NOTE
To achieve the 64-by-32 screen type, the configuration setting

must be set for 40-by-20, and the screen resolution must be
set to 1024-by-768 (using the ESC M control sequence). If
you want to use the 64-by-32 screen type, you must have
at least a 15-inch monitor.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
ix/CSP Seriesterminals support the 32-by-16 screen type to maximize

compatibility with systems that use TABS terminals. When an ix/CSP Series
terminal is configured for the 32-by-16 screen type, the text and icons are offset
to the fourth row of the display area. You cannot address the top three rows or the
bottom row. Also, there are eight columns that you cannot address. For right
justified displays, these are the leftmost eight columns. For left justified displays,
they are the rightmost eight columns
NOTE
If your terminals are configured for the 32-by-16 screen type,

use a row size of 12 scan lines only. Using a row size other
than 12 might yield unpredictable results.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Figure D-5 Screen Types
D-22
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.7 Row and Column Designator
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
TP-821029 (Ed. A)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Figure D-8 Location of Row @, Column @
D-25
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Arrows and Lead-through Lines for the Function Keys

Arrows and lead-through lines are frequently used to show the consumer which
function key to press. To correctly place these arrows or lines on the display, you
need to know which rows align with which function keys in the 32-by-16 and
40-by-20 screen type (Figure D-9). The alignment between the function keys
and the rows depends on the display format. Refer to Table D-6 for a list of the
rows recommended for arrows or lead-through lines for each display format.
In Table D-9, row size 12 is emphasized because it is the most common row
size. Refer to Figure D-10 for the function key rows associated with each
screen type and resolution.
Figure D-9 Function Key Rows
D-26
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-6 Recommended Rows for Lead-through Lines
Screen Type Row Size A Key Row B Key Row C Key Row D Key Row
(Scan Lines)
Resolution 320 x 200 x 256
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
Resolution 1024 x 768 x 256
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
TP-821029 (Ed. A)
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
TP-821029 (Ed. A)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.8 Character Sets
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:
Character Set Font Number
Basic set 0
Helvetica font 1
Century font 2
Rolling font 3
Borders and backgrounds (8 x 12) @
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
TP-821029 (Ed. A)
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
Icons are pictures, such as pictorial representations of keypads or terminals or

hands taking cash. Each icon is assigned an identifying number between 000
and 999 (decimal).
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).
A set of prepackaged icons is supplied as part of VGA Plus. Prepackaged icons

can be displayed in any pair of colors. The background color and foreground
color for the icon are selected by embedding an ESC C control sequence in the
screen data. The height of each prepackaged icon is some multiple of 12 scan
lines. Because the number of scan lines might not be evenly divisible by 16, when
a row size of 16 scan lines is in effect, the lower edge of a given icon might not
extend all the way to the bottom scan line of the last row that the icon occupies.
NOTE
In some prepackaged icons, the image is not centered in

the icon’s rectangle (for example, the image in icon 045, a
question mark inside a block, occupies the leftmost two
thirds of the rectangle). For most uses, these displacements
are not significant.
Refer to the VGA Plus Prepackaged Icons and Character Sets manual
(TP-799508-000A) for more information on the prepackaged icons.
D-31
TP-821029 (Ed. A)
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.
640 x 480 x 16 Resolution

The terminal can use the default colors shown in the following table to display
text and icons. This table also lists the red, green, and blue color designator to
assist you in setting up a paint program.
Color Code Red Green Blue
Black 0 000 000 000
Blue 1 000 000 168
Green 2 000 168 000
Cyan 3 000 168 168
Red 4 168 000 000
Magenta 5 168 000 168
Brown 6 168 084 000
White 7 168 168 168
Gray 8 084 084 084
Bright Blue 9 084 084 252
Bright green A 084 252 084
Bright cyan B 084 252 252
Bright red C 252 084 084
Bright magenta D 252 084 252
Yellow E 252 252 084
Bright white F 252 252 252
You can change the default colors shown in the preceding table by changing
the values in the palette or the DAC.
D-32
TP-821029 (Ed. A)
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.
Resolutions that permit 256 Colors

The terminal uses the DAC to display 256 colors. Refer to Appendix D.1 for
information on how the DAC works. Refer to Appendix D.17.3 for information
on the DAC file. Refer to Appendix D.18.3 for information on the default DAC
values. You can select the foreground color for screen text by embedding an
ESC H control sequence in the screen data. The background color is transparent.
Refer to Section 4.7.16 for more information on ESC H.
D.11 Color Wheel
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.
D.12 Display Mode
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.
Mode Code Display Text Icon Type
Normal 0 yes Prepackage and Custom
Blinking 1 yes Prepackage
Inverse video 2 yes Prepackage
Blinking inverse 3 yes Prepackage
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
TP-821029 (Ed. A)
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.
Default Blinking Values

Unless you select a custom palette using ESC N, the terminal uses a default
palette for blinking values. However, the terminal does not blink colors 0 through
7. The terminal blinks colors 8 through F, as follows:
• Gray (8) blinks black (0)

• Bright blue (9) blinks blue (1)
• Bright green (A) blinks green (2)
• Bright cyan (B) blinks cyan (3)
• Bright red (C) blinks red (4)
• Bright magenta (D) blinks magenta (5)
• Yellow (E) blinks brown (6)
• Bright white (F) blinks white (7)
Custom Blinking Values

If you have selected a custom palette using ESC N, the terminal blinks the
colors 8 through F, as follows:
• Color (8) blinks color (0)

• Color (9) blinks color (1)
• Color (A) blinks color (2)
• Color (B) blinks color (3)
• Color (C) blinks color (4)
• Color (D) blinks color (5)
• Color (E) blinks color (6)
• Color (F) blinks color (7)
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
TP-821029 (Ed. A)
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.
D.13 Overscan Area
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
This example is for the 640 x 480 x 16 resolution.
ESC C 1 F
EXAMPLE
This example is for those resolutions which permit 256 colors.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.14 Control Characters and Sequences
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.
Table D-7 Common Display Functions
Function Sequence For information refer to...
Brighten from a black screen to colors ESC > Section 4.7.45

corresponding to a new DAC setup number
Call user control sequence ESC ZU Section 4.7.40
Change resolution ESC M Section 4.7.21
Clear consumer display FF Section 4.7.3
Create backgrounds ESC R, ESC U Section 4.7.26

Section 4.7.28
Create borders ESC R, ESC U Section 4.7.26

Section 4.7.28
Display buffer content ESC B Section 4.7.11
Display buffer content (format template) ESC V Section 4.7.29
Display date and/or time ESC : Section 4.7.42
Display an icon ESC P Section 4.7.24
Display an icon of the scanned check face ESC Q Section 4.7.25
Display IN touch screen button (not applicable ESC ZI Section 4.7.37

Display OUT touch screen button (not applicable ESC ZO Section 4.7.38
Extend character set range VT Section 4.7.9
Fade from current DAC setup number to black ESC < Section 4.7.43
Initiate animation ESC A Section 4.7.10
Initiate animation with FLC or FLI graphic files ESC ZF Section 4.7.36
Initiate animation with sprites ESC ? Section 4.7.46
Initiate color wheel ESC J Section 4.7.18
Initiate delay ESC D Section 4.7.13
Initiate scrolling ESC K Section 4.7.19
D-36
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-7 Common Display Functions (continued)
Function Sequence For information refer to...
Insert name HT Section 4.7.4
Insert screen ESC I Section 4.7.17
Insert screen SO Section 4.7.7
Position cursor (column @ in current row) CR Section 4.7.2
Position cursor (down a row in current column) LF Section 4.7.5
Position cursor (left one column in current row) BS Section 4.7.1
Position cursor (pixel position) ESC X Section 4.7.31
Position cursor (row r column c) SI Section 4.7.6
Position cursor (up a row in current column) US Section 4.7.8
Select blinking ESC F, ESC P, ESC W Section 4.7.14

Section 4.7.24
Section 4.7.30
Select color ESC C Section 4.7.12
Select DAC file ESC O Section 4.7.23
Select font (character set) ESC F Section 4.7.14
Select inverse video ESC F, ESC P Section 4.7.14

Section 4.7.24
Select language bank ESC L Section 4.7.20
Select row size ESC = Section 4.7.44
Select special effects time ESC Y Section 4.7.32
Select text foreground color ESC H Section 4.7.16
Select touch screen configuration data (not ESC ZD Section 4.7.34

applicable on the CashSource Plus 400)
Select touch screen template (not applicable on ESC ZC Section 4.7.33

the CashSource Plus 400)
Set up palette register ESC N Section 4.7.22
Tile an area ESC T Section 4.7.27
Voice keypad feedback ESC ZH Section 4.17.2
Voice prompting ESC ; Section 4.17.2
D-37
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.15 Programming Techniques
The following subsections discusses the ways in which you can us the VGA Plus
features effectively.
D.15.1 Reducing Phosphor Burn on Color Consumer Displays
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.
Reduce Screen Intensity

If possible try to stay away from static (stationary) images that use full intensity
red, green, or blue colors.
Blink or Flash the Screen

You can blink or flash a screen on and off by including an ESC P in the
screen data. For example, you can blink the Welcome icon by including the
following line in your screen data:
ESC P 000 1
Move the Image Around on the Screen

You can display an icon in different positions on the screen, fade to black
between each position, and change the color between each position.
The following example demonstrates this technique by building the Welcome

screens shown in Figure D-11.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus

ESC O 001 Set the DAC to all black, no display
SI A D Position cursor at row A, column D
ESC C 0 7 Set the background to 0 (black); foreground to 7 (white)

SI J D Position cursor at row J, column D
ESC A 004 4 001 Display animation sequence 004 (insert card) for time 001
SI 2 D Position cursor at row 2, column D
PLEASE Display PLEASE
SI 3 B Position cursor at row 3, column B
INSERT b/CARD Display INSERT CARD
ESC D 008 Delay for time 008
ESC < Fade the icon out to black
FF Clear the consumer display
SI E D Position cursor at row E, column D

SI J = Position cursor at row J, column =
ESC A 004 4 001 Display animation sequence 004 (insert card) for time 001
SI 2 = Position cursor at row 2, column =
PLEASE Display PLEASE
SI 3 ; Position cursor at row 3, column ;
INSERT b/CARD Display INSERT CARD
ESC D 008 Delay for time 008
ESC < Fade the icon out to black
ESC I 011 Insert screen 011
D-39
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A31
Figure D-11 Moving an Image around on the Screen -- Example
Periodically Change the Image

You can display the Welcome icon for a few seconds, then switch to a custom
icon for a few seconds and then back again.
Another suggestion is to create custom Welcome icons and put them in an

animation sequence. For example, you might want to display the word Welcome
in different languages.
Select Colors that Are Less Susceptible to Phosphor Burn

Images displayed in blue shades are the most susceptible to phosphor burn.
Images displayed in red shades are less susceptible to phosphor burn. Images
displayed in green shades are the least susceptible to phosphor burn.
Using these techniques does not totally eliminate phosphor burn, but should
extend the life of the consumer display.
D-40
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.15.2 General Techniques
The suggestions in the following paragraphs might help to optimize the creation
and display of VGA screens.
Use Graph Paper to Design Screens

Always lay out the text, icons, and borders on graph paper to determine the
correct positioning of all the elements.
Use ESC R Instead of ESC U

If you can display something with either an ESC R control sequence or an ESC
U control sequence, use the simpler ESC R. It requires fewer bytes of screen
data and, therefore, saves space in terminal memory.
Use Templates for Similar Screens

When you design a group of screens with similar functions, you might be able to
simplify the design process and make the screens consistent in appearance by
setting up templates that contain whatever text, icons, and borders the screens
have in common. Refer to the description of the ESC I control sequence for
an example of template construction. (The SO control sequence can also be
used to construct templates.)
Create Shading with Background Characters

You can create shading or the illusion of a different color by mixing two colors
on the $ block from the backgrounds and borders set. For example, to create a
background area of dark blue, you can mix blue and black (using ESC C 1 0), then
tile the desired area with the $ block. You can mix any two colors in this fashion.
Do Not Waste Screen Processing Time

The simplest screen design does not always result in the fastest display. For
example, the following screen data displays a large blue rectangle, then places a
large red rectangle over it:
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.
Limit the Use of 640 x 480 x 256 Resolution Screens

Screens with resolutions of 640 x 480 x 256 require four times as much memory
as Color Graphics Feature 640 x 240 x 16 screens. It also takes more processor
time to display the 640 x 480 x 256 screens. Assess the image you want to
display and only select the 640 x 480 x 256 resolution if necessary.
D-41
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Conserve CPU Time

It is possible to design screens that use too much of the processor’s time. If you
design CPU-intensive screens, there is no time left for other operations in Agilis
91x for ix/CSP. Frequently, the Welcome screen is a CPU-intensive screen. The
Welcome screen serves to attract attention, so there is much activity on the screen.
If too much of the processor’s time is used to display screens, the consumer
cannot use the terminal because the terminal cannot read the consumer’s card.
Avoid the following CPU intensive tasks when you create screens:
• Long animation sequences that have no visible delays between pictures

• More than two color wheels active at the same time with a zero rate
• Insertion of screens that loop back with no delays
• Scrolling with time delays of zero
• ESC W control sequences with short delays
D.15.3 Using Borders
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
Figure D-12 Border Technique Example
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
EXAMPLE
The following screen data generates the border itself:
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
TP-821029 (Ed. A)
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).
D.15.4 Using Arrows
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-8 Extension of Arrows
Icon Row Size (Scan Lines)
Small left arrow (096) 10 to 16
Small right arrow (097) 10 to 16
Small up arrow (094) 10 to 12
Small down arrow (095) 10 to 12
Large left arrow (088) 12
Large right arrow (089) 12
Large up arrow (086) 12
Large down arrow (091) 12
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.
Table D-9 Character Sets for the Extending Pieces
Icon SET
Small left arrow (096) 0
Small right arrow (097) 0
Small up arrow (094) 0
Small down arrow (095) 0
Large left arrow (088) 7 [1]
Large right arrow (089) 7 [1]
Large up arrow (086) 5 [1]
Large down arrow (091) :

[1] If your institution uses a LIB file generated by the DDU, use B instead of 5, and use D
instead of 7.
D-45
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A29
Figure D-13 Arrows and Extension Pieces (sheet 1 of 2)
D-46
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A30
Figure D-13 Arrows and Extension Pieces (sheet 2 of 2)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
g40970A24
Figure D-14 Arrows Example
D.16 Custom Graphic Data Updates
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:
• Enter the Maintenance mode and select Load DDU Files.

• Run Loadcrt at a command prompt.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.16.1 Procedure to Load Custom Icon and DAC Files
Use the following procedure to load custom icon files and custom DAC files.
1. Open a Command Prompt window.
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.
DDU files in the C:\DIEBOLD\TCS\ADP00\UPD and

C:\DIEBOLD\TCS\ADP01\UPD directories are known as update icons.
6. Load the icons for verification using either one of the following methods.
• Type the following command at a command prompt:
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.
7. Place the terminal in service. Perform some consumer transactions to

verify the icons are appropriate for your application. If there is a problem
with any of the icons, delete them from the appropriate directory (either
C:\DIEBOLD\TCS\ADP00\UPD or C:\DIEBOLD\TCS\ADP01\UPD)
before performing Step 8, because the update icons become permanent
when you restart the terminal. Completing this step of the procedure
allows the terminal manager to try out an icon before making the icon
permanent.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
Each time the terminal is powered up or reset, the

system copies the update icons in the \UPD directories
to the appropriate configuration directory: either
the C:\DIEBOLD\TCS\ADP00 directory or the
C:\DIEBOLD\TCS\ADP01 directory.
Icons can be changed as often as necessary by following this procedure.
Refer to Appendix D.16.3 for information on how to load icons automatically.
D.16.2 Procedure to Load Custom Character Sets
As described in Appendix D.2 there are two libraries: one to store high-resolution
characters and one to store low-resolution characters.
If you have high-resolution custom character sets to load, proceed as follows

to replace the standard high-resolution LIB file with your customized
high-resolution LIB file.
1. Use the following command to delete the standard high-resolution

LIB file:
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:
COPY A:\*.LIB C:\DIEBOLD\TCS\ADP00\*.LIB
3. Use the following command to delete the standard low-resolution 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:
COPY A:\*.LIB C:\DIEBOLD\TCS\ADP01\*.LIB
5. Turn off the terminal, then turn it on again.
Refer to the following section for information on how to load graphics

automatically.
D-50
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.16.3 Procedure to Load Graphics Automatically
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.
D.16.4 Screen Design Example
The following paragraphs present an example of screen design.
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:
• VGA Cmnds|Resolution|640 x 480 x 256

• VGA Cmnds|DAC|200
• Graphics|Icon|200|Normal
Save these changes and exit the VGA Screen utility.
D-51
TP-821029 (Ed. A)
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:
screen vgattf.da0 test.scr
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
In a direct-connect environment, the screen changes also need

to be made at the network controller. The method described in
the example in this section is used to try graphics out at the
terminal and is not meant to be a permanent solution.
D.17 VGA Plus Files
The following subsections describe the following VGA Plus files:
• Power-up screen files

• Revert file
• DAC files
• Datetime file
• Palette files
• Color wheel files
• Sprite definition files
• Frame files
If you wish to customize the default configuration files, you must read this
appendix.
NOTE
You might wish to refer to Appendix D.2.2, for a table that

summarizes the files described in this section.
D.17.1 Powerup Screen Files
Powerup screen files store screen data. The extension for powerup screen
files is as follows:
.scr
D-52
TP-821029 (Ed. A)
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).
The terminal loads powerup screen files at powerup. During powerup

initialization, the video subsystem code looks in any directory that it loads
configurations from for files with a SCR extension. The terminal reads all files
with the SCR extension into the screen library. The terminal loads the default
screens for offline and out-of-service this way at powerup.
How to Produce Power-up Screen Files

You can use the Diebold utility VGA Screen to produce a DA0 file. Then
you can use the resident screen format conversion utility on the DA0 files to
build the powerup screen file.
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.
3. Save your changes.
4. Exit from VGA Screen.
5. Type the following command to run the screen file format conversion
utility:
screen dcttfd.da0 dcttfd.scr
where dcttfd.da0 is the file you just changed with the VGA Screen utility.
6. Press Enter.
The conversion utility creates a dcttfd.scr file.
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
The screens read from disk at powerup can still be

overwritten by the network. Therefore, this feature
does not replace the functionality provided by Local
Screen Changes or a network load.
D-53
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
D.17.2 Revert File
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
What Purpose Does the Revert File Serve?

The revert file can be used to change screen resolutions. This technique can
substitute for changing screens at the network. Two examples of when a revert
file might be used are as follows:
• 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)
• If the check icon is to be displayed on VGA Plus machines equipped

with an IDM
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
TP-821029 (Ed. A)
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.
The revert file should contain the following two lines:
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
The revert file is not checked for resolution information when a

screen is displayed from within another screen. For example,
the terminal checks the revert file when screen 300 is displayed
normally, but does not check the revert file when screen 300
is displayed from within another screen using the ESC I
300 command sequence.
Installing the Revert File

The \DIEBOLD\TCS\SAMPLE directory contains a sample revert file
(REVERT.CFG). The sample revert file 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 the revert file. If you only want the revert effect
for some of your new screens, you can edit the sample revert file before you
install it. If your terminal load contains Dollar Entry states, you must edit the
sample revert file and remove the Dollar Display screen numbers as described
in the following paragraph.
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
TP-821029 (Ed. A)
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.
Removing Dollar Display Screen Numbers from the Sample Revert

File
The sample revert file contains a line for all valid screen numbers. If your
terminal load contains Dollar Entry states, you have to edit the sample revert file
and remove the lines that list your Dollar Display screen numbers. Listing a
screen number in the revert file has the same effect as putting an ESC M in the
screen data for the screen. Since ESC M clears the screen to black after it changes
the resolution, it is necessary to remove the lines with Dollar Display screen
numbers so the terminal does not clear the Dollar Entry state screen. If these lines
are not removed, the only thing you see on the display is the Dollar Entry field.
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.
Use the following procedure to edit the sample revert file.
1. Copy the sample revert file (REVERT.CFG) from the

\DIEBOLD\TCS\SAMPLE directory to the \DIEBOLD\TCS directory.
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
Remove all lines that list Dollar Display screens.
3. Turn off the terminal, then turn it on again.
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.
D.17.3 DAC Files
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
If you are using the ESC C sequence, avoid changing the

values of the default DAC registers 0 through 15. The ESC C
sequence relies on the fact that colors 0 through 15 are set to
default EGA colors. The default EGA colors are shown in
the default DAC setup (Appendix C).
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
The \DIEBOLD\TCS\SAMPLE directory provides a

sample assembly language file for the default DAC file
(DAC000.DAT). You might wish to look at DAC000.ASM if
you are creating a custom DAC.
The naming convention for the DAC files is as follows:
DACnnn.DAT
Where nnn indicates the DAC setup number referenced in the ESC O control
sequence.
Custom DAC Files

This section tells you how to create custom DAC files. You can skip this section
if you use DDU to generate your custom icons because DDU provides a custom
DAC file for each custom icon that you create with DDU.
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.
The naming convention for a DAC source file is as follows:
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.
If you have to create a custom DAC file, proceed as follows.
1. Use a text editor at your PC to create a DAC source file. Refer to

Appendix D.17.3 for information on the format of the source file.
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
The system generates a binary DAC file, DACnnn.DAT.
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.
DAC File Format

The following table shows the format of the DAC file:
Description
First byte DAC logical AND mask register value
Reg 0 Red 1 byte value for red (bit0 - bit5 significant)
Reg 0 Green 1 byte value for grn (bit0 - bit5 significant)
Reg 0 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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
g1959085
Figure D-15 Sample DAC File (DAC000.ASM) (sheet 1 of 2)
D-59
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
g1959086
Figure D-15 Sample DAC File (DAC000.ASM) (sheet 2 of 2)
D.17.4 Datetime File
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.
The naming convention for the datetime file is as follows:
DATETIME.DAT
D-60
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
The datetime file is stored in the following directory:
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.
• Follow the T/D screen number with a single space.
• A 3-digit format screen number.
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
D.17.5 Palette Files
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.
The naming convention for the palette file is as follows:
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.
The palette files are binary files.
D-61
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
The \DIEBOLD\TCS\SAMPLE directory provides a sample

assembly language source file for the default palette file
(PAL000.DAT). You might wish to look at PAL000.ASM if
you are creating a custom palette.
Format
The following table shows the format of the palette file:
Byte Flag Description
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.
2 Color select register value. Range 0 through 15.
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.
3 - 18 Palette register 0 through 15 values. Range 0 through 63 for each register.
D.17.6 Color Wheel Files
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.
The color wheel files are binary files.
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
The \DIEBOLD\TCS\SAMPLE directory provides a sample

assembly language source file for the default color wheel file
(CLRW000.DAT). You might wish to look at CLR000.ASM if
you are creating a custom color wheel.
The naming convention for the color wheel files is as follows:
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Byte Color Period
1 Red 1 6 bit value
2 Green 1 6 bit value
3 Blue 1 6 bit value

•
•
•
(n * 3) - 2 Red n 6 bit value
(n * 3) - 1 Green n 6 bit value
(n * 3) Blue n 6 bit value
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.
D.17.7 Sprite Definition Files and Frame 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
You cannot use sprites in the same screen areas as other

animation techniques such as ESC A, ESC D, or ESC: type
animations.
The following sections describe how to create both sprite definition and frame
files.
D.17.7.1 Creating Frame Files
The naming convention for the frame file is as follows:
FRAMEnnn.SPR.
D-63
TP-821029 (Ed. A)
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
The maximum size of a frame is 64-by-64 pixels.
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:
Enter transparent color (-1 = none)
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.
D.17.7.2 Creating Sprite Definition Files
The naming convention for the sprite definition file is as follows:
SPRTEnnn.DEF
where nnn represents the sprite definition number.
D-64
TP-821029 (Ed. A)
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.
D.17.7.3 Format of the ASCII Text Sprite Definition File
Each line of a sprite definition file contains a command, parameters for the
command, and optional comments as follows:
RATE ttt #comment

LAYER n
STEP, xxxx, yyyy, FrameNum
•
•
•
MOVE, xxxx
1, yyyy
1, xxxx
2, yyyy
2, Steps, FrameNum
1, ...., FrameNum
N
SPRITE sss
REPEAT/CLEAR/LEAVE (requires one of these as a terminating
keyword)
# comment on a line by itself
The # character designates a comment. Comments can appear anywhere in the

file. As soon as the Mksprite utility encounters the # character, the utility
considers the remainder of the line a comment.
D-65
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
NOTE
The RATE, LAYER, STEP, MOVE, SPRITE, commands can

appear in any order and can be repeated as often as necessary.
One of the following keywords must end the file: REPEAT,
CLEAR, or LEAVE.
The following section describes each command in detail. Refer to

Appendix D.17.7.6, for an example of a sprite definition file.
D.17.7.4 Sprite Definition File Commands
The following paragraphs describe each sprite definition file command.
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:
42ms = 10ms + (001 * 32ms)
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
TP-821029 (Ed. A)
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
In this example there are three sprites on three layers as follows:
• A star on layer 1 at position 4000,4500

• A moon on layer 2 moves from 0000,0000 to 8000,8000
• A star on layer 3 at position 2500,2500
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
where FrameNum is a frame file number.
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.
STEP, 5000, 5000, 121
MOVE
The MOVE command moves a sprite on the screen.
The format of the MOVE command is as follows:
g1959089
The MOVE command has the following parameters:
• 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:
MOVE 0, 9999, 0, 3200, 4, 23, 24, 25, 26
D-68
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
The MOVE command in the following example, displays frame 23 in four

equally spaced steps across the top of the screen:
MOVE 0, 9999, 8000, 9999, 4, 23
NOTE
Since the global pixel coordinate system displays a frame

starting at the coordinate, the y-axis positions take the size of
the frame into account. If the second y-axis position in the first
example was 0, the frame would be clipped off.
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.
D.17.7.5 Sprite Numerical Limits
The following table shows sprite numerical limits:
Parameter Limit
Max frame size in pixels 64 x 64
Frame numbers 000 - 255
Sprite numbers 000 - 127
Layers 0-5
Rates 0 - 255
xxxx, yyyy coordinates 0 - 9999
D.17.7.6 Sprite Definition File Example
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
• FRAME200.SPR - butterfly with wings up

• FRAME201.SPR - butterfly with wings in mid-flight position
• FRAME202.SPR - butterfly with wings down
D-69
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
This example requires the following ASCII text file:
RATE 002 Step through the commands in the file every 74ms.
LAYER 5 The butterfly sprite operates behind any other sprites

that happen to be active at the same time.
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.
LEAVE The butterfly remains on the screen.
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.
D.18 Palette, Color Wheel, and DAC Defaults
This section lists the default values for the palette, color wheel, and DAC files.
Refer to Appendix D.18.1 for the default palette register values.
Refer to Appendix D.18.2 for the default color wheel values.
Refer to Appendix D.18.3 for the default DAC values.
D.18.1 Palette Default Values
Refer to Table D-10 for the default palette register values.
D-70
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-10 Default Palette Register Values
Default Value
Attribute mode register FALSE [1]
Color select register 0
Palette Register 0 0
[1] Refer to Appendix D.17.5 for information on setting the flag for the attribute mode
register.
D.18.2 Color Wheel Default Values
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.
Table D-11 Default Color Wheel Set-up Number 000
Order Red Green Blue Order Red Green Blue
0 000 000 000 20 060 047 040
1 005 004 003 21 059 047 039
2 009 007 006 22 059 046 039
3 014 011 009 23 058 046 038
4 018 015 012 24 057 045 038
5 023 018 015 25 055 043 036
6 027 021 018 26 053 042 035
D-71
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-11 Default Color Wheel Set-up Number 000 (continued)
7 031 025 021 27 051 040 034
8 035 028 023 28 048 038 032
9 039 031 026 29 045 036 030
10 042 033 028 30 042 033 028
11 045 036 030 31 039 031 026
12 048 038 032 32 035 028 023
13 051 040 034 33 031 025 021
14 053 042 035 34 027 021 018
15 055 043 036 35 023 018 015
16 057 045 038 36 018 015 012
17 058 046 038 37 014 011 009
18 059 046 039 38 009 007 006
19 059 047 039 39 005 004 003
D-72
TP-821029 (Ed. A)
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.
0 000 000 000 20 000 000 063
1 000 000 005 21 000 000 063
2 000 000 010 22 000 000 062
3 000 000 015 23 000 000 061
4 000 000 019 24 000 000 060
5 000 000 024 25 000 000 058
6 000 000 029 26 000 000 056
7 000 000 033 27 000 000 054
8 000 000 037 28 000 000 051
9 000 000 041 29 000 000 048
10 000 000 045 30 000 000 045
11 000 000 048 31 000 000 041
12 000 000 051 32 000 000 037
13 000 000 054 33 000 000 033
14 000 000 056 34 000 000 029
15 000 000 058 35 000 000 024
16 000 000 060 36 000 000 019
17 000 000 061 37 000 000 015
18 000 000 062 38 000 000 010
19 000 000 063 39 000 000 005
D-73
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
002. This color wheel cycles from black to green in the order indicated in the
0 000 000 000 20 000 063 000
1 000 005 000 21 000 063 000
2 000 010 000 22 000 062 000
3 000 015 000 23 000 061 000
4 000 019 000 24 000 060 000
5 000 024 000 25 000 058 000
6 000 029 000 26 000 056 000
7 000 033 000 27 000 054 000
8 000 037 000 28 000 051 000
9 000 041 000 29 000 048 000
10 000 045 000 30 000 045 000
11 000 048 000 31 000 041 000
12 000 051 000 32 000 037 000
13 000 054 000 33 000 033 000
14 000 056 000 34 000 029 000
15 000 058 000 35 000 024 000
16 000 060 000 36 000 019 000
17 000 061 000 37 000 015 000
18 000 062 000 38 000 010 000
19 000 063 000 39 000 005 000
D-74
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
003. This Color Wheel cycles from black to cyan in the order indicated in the
0 000 000 000 20 000 063 063
1 000 005 005 21 000 063 063
2 000 010 010 22 000 062 062
3 000 015 015 23 000 061 061
4 000 019 019 24 000 060 060
5 000 024 024 25 000 058 058
6 000 029 029 26 000 056 056
7 000 033 033 27 000 054 054
8 000 037 037 28 000 051 051
9 000 041 041 29 000 048 048
10 000 045 045 30 000 045 045
11 000 048 048 31 000 041 041
12 000 051 051 32 000 037 037
13 000 054 054 33 000 033 033
14 000 056 056 34 000 029 029
15 000 058 058 35 000 024 024
16 000 060 060 36 000 019 019
17 000 061 061 37 000 015 015
18 000 062 062 38 000 010 010
19 000 063 063 39 000 005 005
D-75
TP-821029 (Ed. A)
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.
0 000 000 000 20 063 000 000
1 005 000 000 21 063 000 000
2 010 000 000 22 062 000 000
3 015 000 000 23 061 000 000
4 019 000 000 24 060 000 000
5 024 000 000 25 058 000 000
6 029 000 000 26 056 000 000
7 033 000 000 27 054 000 000
8 037 000 000 28 051 000 000
9 041 000 000 29 048 000 000
10 045 000 000 30 045 000 000
11 048 000 000 31 041 000 000
12 051 000 000 32 037 000 000
13 054 000 000 33 033 000 000
14 056 000 000 34 029 000 000
15 058 000 000 35 024 000 000
16 060 000 000 36 019 000 000
17 061 000 000 37 015 000 000
18 062 000 000 38 010 000 000
19 063 000 000 39 005 000 000
D-76
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
This color wheel cycles from black to magenta in the order indicated in the
0 000 000 000 20 063 000 063
1 005 000 005 21 063 000 063
2 010 000 010 22 062 000 062
3 015 000 015 23 061 000 061
4 019 000 019 24 060 000 060
5 024 000 024 25 058 000 058
6 029 000 029 26 056 000 056
7 033 000 033 27 054 000 054
8 037 000 037 28 051 000 051
9 041 000 041 29 048 000 048
10 045 000 045 30 045 000 045
11 048 000 048 31 041 000 041
12 051 000 051 32 037 000 037
13 054 000 054 33 033 000 033
14 056 000 056 34 029 000 029
15 058 000 058 35 024 000 024
16 060 000 060 36 019 000 019
17 061 000 061 37 015 000 015
18 062 000 062 38 010 000 010
19 063 000 063 39 005 000 005
D-77
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
This color wheel cycles from black to yellow in the order indicated in the
0 000 000 000 20 063 063 000
1 005 005 000 21 063 063 000
2 010 010 000 22 062 062 000
3 015 015 000 23 061 061 000
4 019 019 000 24 060 060 000
5 024 024 000 25 058 058 000
6 029 029 000 26 056 056 000
7 033 033 000 27 054 054 000
8 037 037 000 28 051 051 000
9 041 041 000 29 048 048 000
10 045 045 000 30 045 045 000
11 048 048 000 31 041 041 000
12 051 051 000 32 037 037 000
13 054 054 000 33 033 033 000
14 056 056 000 34 029 029 000
15 058 058 000 35 024 024 000
16 060 060 000 36 019 019 000
17 061 061 000 37 015 015 000
18 062 062 000 38 010 010 000
19 063 063 000 39 005 005 000
D-78
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
007. This color wheel cycles from black to white in the order indicated in the
0 000 000 000 20 063 063 063
1 005 005 005 21 063 063 063
2 010 010 010 22 062 062 062
3 015 015 015 23 061 061 061
4 019 019 019 24 060 060 060
5 024 024 024 25 058 058 058
6 029 029 029 26 056 056 056
7 033 033 033 27 054 054 054
8 037 037 037 28 051 051 051
9 041 041 041 29 048 048 048
10 045 045 045 30 045 045 045
11 048 048 048 31 041 041 041
12 051 051 051 32 037 037 037
13 054 054 054 33 033 033 033
14 056 056 056 34 029 029 029
15 058 058 058 35 024 024 024
16 060 060 060 36 019 019 019
17 061 061 061 37 015 015 015
18 062 062 062 38 010 010 010
19 063 063 063 39 005 005 005
D-79
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
008. This color wheel cycles from black to gray in the order indicated in the
0 000 000 000 20 031 031 031
1 002 002 002 21 031 031 031
2 005 005 005 22 031 031 031
3 007 007 007 23 030 030 030
4 010 010 010 24 029 029 029
5 012 012 012 25 029 029 029
6 014 014 014 26 028 028 028
7 016 016 016 27 026 026 026
8 018 018 018 28 025 025 025
9 020 020 020 29 024 024 024
10 022 022 022 30 022 022 022
11 024 024 024 31 020 020 020
12 025 025 025 32 018 018 018
13 026 026 026 33 016 016 016
14 028 028 028 34 014 014 014
15 029 029 029 35 012 012 012
16 029 029 029 36 010 010 010
17 030 030 030 37 007 007 007
18 031 031 031 38 005 005 005
19 031 031 031 39 002 002 002
D-80
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
This color wheel cycles from black to orange in the order indicated in the
0 000 000 000 20 063 031 000
1 005 002 000 21 063 031 000
2 010 005 000 22 062 031 000
3 015 007 000 23 061 030 000
4 019 010 000 24 060 029 000
5 024 012 000 25 058 029 000
6 029 014 000 26 056 028 000
7 033 016 000 27 054 026 000
8 037 018 000 28 051 025 000
9 041 020 000 29 048 024 000
10 045 022 000 30 045 022 000
11 048 024 000 31 041 020 000
12 051 025 000 32 037 018 000
13 054 026 000 33 033 016 000
14 056 028 000 34 029 014 000
15 058 029 000 35 024 012 000
16 060 029 000 36 019 010 000
17 061 030 000 37 015 007 000
18 062 031 000 38 010 005 000
19 063 031 000 39 005 002 000
D-81
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
010. This color wheel cycles from black to rust in the order indicated in the
0 000 000 000 20 043 011 021
1 003 001 002 21 042 011 021
2 007 002 003 22 042 011 021
3 010 003 005 23 041 010 021
4 013 003 007 24 040 010 020
5 016 004 008 25 039 010 020
6 019 005 010 26 038 010 019
7 022 006 011 27 036 009 018
8 025 006 012 28 034 009 017
9 028 007 014 29 032 008 016
10 030 008 015 30 030 008 015
11 032 008 016 31 028 007 014
12 034 009 017 32 025 006 012
13 036 009 018 33 022 006 011
14 038 010 019 34 019 005 010
15 039 010 020 35 016 004 018
16 040 010 020 36 013 003 007
17 041 010 021 37 010 003 005
18 042 011 021 38 007 002 003
19 042 011 021 39 003 001 002
D-82
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
011. This color wheel cycles from black to silver in the order indicated in the
0 000 000 000 20 045 049 051
1 004 004 004 21 045 049 051
2 007 008 008 22 045 048 050
3 011 011 012 23 044 048 049
4 014 015 016 24 043 047 048
5 017 019 019 25 042 045 047
6 021 022 023 26 040 044 045
7 024 026 027 27 039 042 043
8 027 029 030 28 037 040 041
9 029 032 033 29 034 037 039
10 032 035 036 30 032 035 036
11 034 037 039 31 029 032 033
12 037 040 041 32 027 029 030
13 039 042 043 33 024 026 027
14 040 044 045 34 021 022 023
15 042 045 047 35 017 019 019
16 043 047 048 36 014 015 016
17 044 048 049 37 011 011 012
18 045 048 050 38 007 008 008
19 045 049 051 39 004 004 004
D-83
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
012. This color wheel cycles from black to gold in the order indicated in the
0 000 000 000 20 052 037 012
1 004 003 001 21 052 036 012
2 008 006 002 22 051 036 012
3 012 009 003 23 050 035 012
4 016 011 004 24 049 035 011
5 020 014 005 25 048 034 011
6 023 017 005 26 046 033 011
7 027 019 006 27 044 031 010
8 030 021 007 28 042 030 010
9 034 024 008 29 039 028 009
10 037 026 008 30 037 026 008
11 039 028 009 31 034 024 008
12 042 030 010 32 030 021 007
13 044 031 010 33 027 019 006
14 046 033 011 34 023 017 005
15 048 034 011 35 020 014 005
16 049 035 011 36 016 011 004
17 050 035 012 37 012 009 003
18 051 036 012 38 008 006 002
19 052 036 012 39 004 003 001
D-84
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
014. This color wheel cycles from black to brown in the order indicated in the
0 000 000 000 20 016 005 000
1 001 000 000 21 016 005 000
2 003 001 000 22 016 005 000
3 004 001 000 23 016 005 000
4 005 002 000 24 015 005 000
5 006 002 000 25 015 005 000
6 007 002 000 26 014 004 000
7 008 003 000 27 014 004 000
8 010 003 000 28 013 004 000
9 011 003 000 29 012 004 000
10 011 004 000 30 011 004 000
11 012 004 000 31 011 003 000
12 013 004 000 32 010 003 000
13 014 004 000 33 008 003 000
14 015 004 000 34 007 002 000
15 015 005 000 35 006 002 000
16 016 005 000 36 005 002 000
17 016 005 000 37 004 001 000
18 016 005 000 38 003 001 000
19 016 005 000 39 001 000 000
D-85
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
015. This color wheel cycles from black to purple in the order indicated in the
0 000 000 000 20 043 011 053
1 003 001 004 21 042 011 053
2 007 002 008 22 042 011 053
3 010 003 012 23 041 010 052
4 013 003 016 24 040 010 051
5 016 004 020 25 039 010 049
6 019 005 024 26 038 010 047
7 022 006 028 27 036 009 045
8 025 006 031 28 034 009 043
9 028 007 035 29 032 008 040
10 030 008 038 30 030 008 038
11 032 008 040 31 028 007 035
12 034 009 043 32 025 006 031
13 036 009 045 33 022 006 028
14 038 010 047 34 019 005 024
15 039 010 049 35 016 004 020
16 040 010 051 36 013 003 016
17 041 010 052 37 010 003 012
18 042 011 053 38 007 002 008
19 042 011 053 39 003 001 004
D-86
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
This color wheel cycles through a range of colors in the order indicated in the
0 001 000 063 25 039 000 063
1 003 000 063 26 040 000 063
2 004 000 063 27 042 000 063
3 006 000 063 28 043 000 063
4 007 000 063 29 045 000 063
5 009 000 063 30 046 000 063
6 010 000 063 31 048 000 063
7 012 000 063 32 049 000 063
8 013 000 063 33 051 000 063
9 015 000 063 34 052 000 063
10 016 000 063 35 054 000 063
11 018 000 063 36 055 000 063
12 019 000 063 37 057 000 063
13 021 000 063 38 058 000 063
14 022 000 063 39 060 000 063
15 024 000 063 40 061 000 063
16 025 000 063 41 063 000 063
17 027 000 063 42 063 000 063
18 028 000 063 43 063 000 061
19 030 000 063 44 063 000 060
20 031 000 063 45 063 000 058
21 033 000 063 46 063 000 057
22 034 000 063 47 063 000 055
23 036 000 063 48 063 000 054
24 037 000 063 49 063 000 052
50 063 000 051 75 063 000 013
51 063 000 049 76 063 000 012
52 063 000 048 77 062 000 010
53 063 000 046 78 063 000 009
54 063 000 045 79 063 000 007
55 063 000 043 80 063 000 006
56 063 000 042 81 063 000 004
57 063 000 040 82 063 000 003
58 063 000 039 83 063 000 001
D-87
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
59 063 000 037 84 063 000 000
60 063 000 036 85 063 000 000
61 063 000 034 86 063 001 000
62 063 000 033 87 063 003 000
63 063 000 031 88 063 004 000
64 063 000 030 89 063 006 000
65 063 000 028 90 063 007 000
66 063 000 027 91 063 009 000
67 063 000 025 92 063 010 000
68 063 000 024 93 061 012 000
69 063 000 022 94 060 013 000
70 063 000 021 95 058 015 000
71 063 000 019 96 057 016 000
72 063 000 018 97 055 018 000
73 063 000 016 98 054 019 000
74 063 000 015 99 052 021 000
100 063 022 000 125 063 060 000
101 063 024 000 126 063 061 000
102 063 025 000 127 063 063 000
103 063 027 000 128 063 063 000
104 063 028 000 129 061 063 000
105 063 030 000 130 060 063 000
106 063 031 000 131 058 063 000
107 063 033 000 132 057 063 000
108 063 034 000 133 055 063 000
109 063 036 000 134 054 063 000
110 063 037 000 135 052 063 000
111 063 039 000 136 051 063 000
112 063 040 000 137 049 063 000
113 063 042 000 138 048 063 000
114 063 043 000 139 046 063 000
115 063 045 000 140 045 063 000
116 063 046 000 141 043 063 000
117 063 048 000 142 042 063 000
118 063 049 000 143 040 063 000
119 063 051 000 144 039 063 000
120 063 052 000 145 037 063 000
121 063 054 000 146 036 063 000
D-88
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
122 063 055 000 147 034 063 000
123 063 057 000 148 033 063 000
124 063 058 000 149 031 063 000
150 030 063 000 175 000 063 007
151 028 063 000 176 000 063 009
152 027 063 000 177 000 063 010
153 025 063 000 178 000 063 012
154 024 063 000 179 000 063 013
155 022 063 000 180 000 063 015
156 021 063 000 181 000 063 016
157 019 063 000 182 000 063 018
158 018 063 000 183 000 063 019
159 016 063 000 184 000 063 021
160 015 063 000 185 000 063 022
161 013 063 000 186 000 063 024
162 012 063 000 187 000 063 025
163 010 063 000 188 000 063 027
164 009 063 000 189 000 063 028
165 007 063 000 190 000 063 030
166 006 063 000 191 000 063 031
167 004 063 000 192 000 063 033
168 003 063 000 193 000 063 034
169 001 063 000 194 000 063 036
170 000 063 000 195 000 063 037
171 000 063 001 196 000 063 039
172 000 063 003 197 000 063 040
173 000 063 004 198 000 063 042
174 000 063 006 199 000 063 043
200 000 063 045 225 000 045 063
201 000 063 046 226 000 043 063
202 000 063 048 227 000 042 063
203 000 063 049 228 000 040 063
204 000 063 051 229 000 039 063
205 000 063 052 230 000 037 063
206 000 063 054 231 000 036 063
207 000 063 055 232 000 034 063
208 000 063 057 233 000 033 063
209 000 063 058 234 000 031 063
D-89
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
210 000 063 060 235 000 030 063
211 000 063 061 236 000 028 063
212 000 063 063 237 000 027 063
213 000 063 063 238 000 025 063
214 000 061 063 239 000 024 063
215 000 060 063 240 000 022 063
216 000 058 063 241 000 021 063
217 000 057 063 242 000 019 063
218 000 055 063 243 000 018 063
219 000 054 063 244 000 016 063
220 000 052 063 245 000 015 063
221 000 051 063 246 000 013 063
222 000 049 063 247 000 012 063
223 000 048 063 248 000 010 063
224 000 046 063 249 000 009 063
250 000 007 063 253 000 003 063
251 000 006 063 254 000 001 063
252 000 004 063 255 000 000 063
D.18.3 DAC Default Values
Refer to Table D-27 for the default DAC values.
Table D-27 Default DAC Register
DAC Red Green Blue

Register
Number
0 - 15 EGA Colors 0 000 000 000
1 000 000 042
2 000 042 000
3 000 042 042
4 042 000 000
5 042 000 042
6 042 021 000
7 042 042 042
8 021 021 021
9 021 021 063
10 021 063 021
D-90
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
Table D-27 Default DAC Register (continued)
DAC Red Green Blue

Register
Number
11 021 063 063
12 063 021 021
13 063 021 063
14 063 063 021
15 063 063 063
16 - 31 Shades of Gray 16 000 000 000
17 005 005 005
18 008 008 008
19 011 011 011
20 014 014 014
21 017 017 017
22 020 020 020
23 024 024 024
24 028 028 028
25 032 032 032
26 036 036 036
27 040 040 040
28 045 045 045
29 050 050 050
30 056 056 056
31 063 063 063
High Intensity 32 - 103 32 000 000 063
Least White 32 - 55 33 016 000 063
34 031 000 063
35 047 000 063
36 063 000 063
37 063 000 047
38 063 000 031
39 063 000 016
40 063 000 000
41 063 016 000
42 063 031 000
43 063 047 000
44 063 063 000
45 047 063 000
46 031 063 000
47 016 063 000
D-91
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
DAC Red Green Blue

Register
Number
48 000 063 000
49 000 063 016
50 000 063 031
51 000 063 047
52 000 063 063
53 000 047 063
54 000 031 063
55 000 016 063
56 -79 Medium White 56 031 031 063
57 039 031 063
58 047 031 063
59 055 031 063
60 063 031 063
61 063 031 055
62 063 031 047
63 063 031 039
64 063 031 031
65 063 039 031
66 063 047 031
67 063 055 031
68 063 063 031
69 055 063 031
70 047 063 031
71 039 063 031
72 031 063 031
73 031 063 039
74 031 063 047
75 031 063 055
76 031 063 063
77 031 055 063
78 031 047 063
79 031 039 063
80 045 045 063
80 to 103 Most White 81 049 045 063
82 054 045 063
83 058 045 063
84 063 045 063
D-92
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
DAC Red Green Blue

Register
Number
85 063 045 058
86 063 045 054
87 063 045 049
88 063 045 045
89 063 049 045
90 063 054 045
91 063 058 045
92 063 063 045
93 058 063 045
94 054 063 045
95 049 063 045
96 045 063 045
97 045 063 049
98 045 063 054
99 045 063 058
100 045 063 063
101 045 058 063
102 045 054 063
103 045 049 063
Intermediate Intensity 104 - 175 104 000 000 028
104 - 127 Least White 105 007 000 028
106 014 000 028
107 021 000 028
108 028 000 028
109 028 000 021
110 028 000 014
111 028 000 007
112 028 000 000
113 028 007 000
114 028 014 000
115 028 021 000
116 028 028 000
117 021 028 000
118 014 028 000
119 007 028 000
120 000 028 000
121 000 028 007
D-93
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
DAC Red Green Blue

Register
Number
122 000 028 014
123 000 028 021
124 000 028 028
125 000 021 028
126 000 014 028
127 000 007 028
128 - 151 Medium White 128 014 014 028
129 017 014 028
130 021 014 028
131 024 014 028
132 028 014 028
133 028 014 024
134 028 014 021
135 028 014 017
136 028 014 014
137 028 017 014
138 028 021 014
139 028 024 014
140 028 028 014
141 024 028 014
142 021 028 014
143 017 028 014
144 014 028 014
145 014 028 017
146 014 028 021
147 014 028 024
148 014 028 028
149 014 024 028
150 014 021 028
151 014 017 028
152 - 175 Most White 152 020 020 028
153 022 020 028
154 024 020 028
155 026 020 028
156 028 020 028
157 028 020 026
158 028 020 024
D-94
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
DAC Red Green Blue

Register
Number
159 028 020 022
160 028 020 020
161 028 022 020
162 028 024 020
163 028 026 020
164 028 028 020
165 026 028 020
166 024 028 020
167 022 028 020
168 020 028 020
169 020 028 022
170 020 028 024
171 020 028 026
172 020 028 028
173 020 026 028
174 020 024 028
175 020 022 028
176 - 247 Low Intensity 176 000 000 016
176 - 199 Least White 177 004 000 016
178 008 000 016
179 012 000 016
180 016 000 016
181 016 000 012
182 016 000 008
183 016 000 004
184 016 000 000
185 016 004 000
186 016 008 000
187 016 012 000
188 016 016 000
189 012 016 000
190 008 016 000
191 004 016 000
192 000 016 000
193 000 016 004
194 000 016 008
195 000 016 012
D-95
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
DAC Red Green Blue

Register
Number
196 000 016 016
197 000 012 016
198 000 008 016
199 000 004 016
200 - 223 Medium White 200 008 008 016
201 010 008 016
202 012 008 016
203 014 008 016
204 016 008 016
205 016 008 014
206 016 008 012
207 016 008 010
208 016 008 008
209 016 010 008
210 016 012 008
211 016 014 008
212 016 016 008
213 014 016 008
214 012 016 008
215 010 016 008
216 008 016 008
217 008 016 010
218 008 016 012
219 008 016 014
220 008 016 016
221 008 014 016
222 008 012 016
223 008 010 016
224 - 247 Most White 224 011 011 016
225 012 011 016
226 013 011 016
227 015 011 016
228 016 011 016
229 016 011 015
230 016 011 013
231 016 011 012
232 016 011 011
D-96
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
VGA Plus
DAC Red Green Blue

Register
Number
233 016 012 011
234 016 013 011
235 016 015 011
236 016 016 011
237 015 016 011
238 013 016 011
239 012 016 011
240 011 016 011
241 011 016 012
242 011 016 013
243 011 016 015
244 011 016 016
245 011 015 016
246 011 013 016
246 011 013 016
247 011 012 016
248 - 255 All Black 248 000 000 000
249 000 000 000
250 000 000 000
251 000 000 000
252 000 000 000
253 000 000 000
254 000 000 000
255 000 000 000
D-97
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Index
35-column Consumer Printer (956) 3-13 C

48-column Thermal Consumer Printer 3-13 card insertion time, T state 4-349
Card Read state (A) 4-12
A Card Read state (T) 4-44
After Hour depository 5-26 card reader 3-1
After Hour Depository function data 5-160 Card Reader function data 5-165
Alarm status 5-82 Card Reader state (CR) 4-71
alarms 3-11, 5-82 card removal time 4-348
alternate characters 3-24 card return flag 4-14, 4-45
animation 4-209, 4-242 Card Write state (L) 4-40
Append Rollover Counts feature 4-340 Card Writer statuses 5-28, 5-96
application software 2-10 cash removal extension time 4-348
Arabic characters 3-35, 3-37 cash removal time 4-348
ATM Soft Lock feature C-13 Cassette status 5-43
automatic envelope dispensing 4-346 cell data for EMG 4-7, 4-327
Automatic Return to Previous Mode feature 2-6, Cent Check state (G) 4-31
4-342 channel files 4-243, C-2–C-6
character recognition C-6
B character sets
background colors on screens 4-235 consumer display 4-191
bag deposit insertion time 4-348 printers 3-21
bill dispenser Write Command 14 message 4-325
statuses 5-29, 5-34, 5-96 Check Buffer state (@H) 4-143
Bill Dispenser function data 5-169 Check FIT state (@B) 4-119
blinking display areas 4-237 Check PIN state (@C) 4-122
browser support C-9 Check Point status 5-18, 5-44, 5-56, 5-74, 5-204
from Agilis 91x to the browser C-11 Check Track Buffer state (Z) 4-47
from the browser to Agilis 91x C-9 Clear Keys state (D) 4-22
reserved URLs C-9–C-10 Close state (@Z) 4-182
tcsvideo.js C-11 Close state (J) 4-37
Buffer Arithmetic state ( \ ) 4-66 Close state screen time 4-347
Buffer Arithmetic state (@O) 4-165 Code Page 850 3-41
Buffer Compare state (@E) 4-134 coin dispenser
Buffer Copy state (@G) 4-141 solicited status 5-46
Buffer Overlay state (@Q) 4-171 unsolicited status 5-100
Buffer Shift state (@N) 4-163 Coin Dispenser function data 5-162
buffers 4-2 color wheels 4-198, 4-217, D-2, D-8–D-9, D-33,
Buffer Arithmetic state ( \ ) 4-66 D-42, D-62, D-71
Buffer Arithmetic state (@O) 4-165 colors on screen 4-209
Buffer Compare state (@E) 4-134 communications message time 4-347
Buffer Copy state (@G) 4-141 configuration data 2-1–2-4, 4-1
Buffer Overlay state (@Q) 4-171 configuration ID 4-1
Buffer Shift state (@N) 4-163 assigning 4-357, 5-147–5-148
card track data buffers (X, Y, Z) 4-40 reporting 5-42
Check Buffer state (@H) 4-143 requesting 5-202, 5-204
Create Buffer state (@L) 4-157 configured text 3-47
dollar buffer (A) 3-20, 4-28, 4-35, 4-42–4-43, consumer display 3-8
4-56, 4-149, 4-340, 4-342, 5-124, 5-129 consumer interface panel 3-6
general purpose buffer B (B) 4-32–4-33, 4-36, consumer keypad 3-8
4-56–4-57, 4-149, 5-8, 5-215–5-216, 5-218 Consumer Keypad 1-3
PIN buffer (@) 4-35, 4-149, 4-167, 5-8, C-11 Consumer Request message 5-3
Set Buffer state (@F) 4-137 consumer response extension time 4-347
Track Buffer Compare state (@M) 4-160 Continuous Availability 2-6, 4-286–4-288, 5-86,
5-91
Copy Buffer Data state (@P) 4-167
Index-1
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Index
Copy Buffer state ( = ) 4-56 Write Command 14 message 4-325

Create Buffer state (@L) 4-157 Write Command 15 message 4-327
Cyrillic characters 3-28 enhanced Operational Command message 5-213
enhanced states 4-8, 4-68
D See also states
DACs 4-228, D-90 Enhanced States
date and time display 4-255 Multi-tasking State 4-178
Decimal Style feature 4-340 Supplemental Dispenser Module (SDM)
deliver request string 3-15 State 4-110
Deposit Cancel Status Bit feature 4-342 enhanced statuses 5-54, 5-101
Deposit Extension state (# or >) 4-51 envelope depository 5-38–5-39
deposit insertion time 4-348–4-349 envelope dispenser 4-17, 5-60
Deposit state (C) 4-17–4-18 ESC < screen control 4-258
Depositor function data ESC = screen control 4-259
envelope depository 5-172 ESC > screen control 4-260
IDM 5-174 ESC ? screen control 4-260
Depositor state (DP) 4-77 ESC D screen control 4-209
device identifiers 5-17 ESC F screen control 4-212
Dial-up Connection feature ESC G screen control 4-212
Network Connection state (NC) 4-97 ESC H screen control 4-213
dip card reader ESC I screen control 4-214
card removal timeout 4-350 ESC J screen control 4-217
Retry screen 4-349 ESC K screen control 4-219
dip card removal time 4-350 ESC L screen control 4-226
Disallow Dispense with Safe Door Open option 4-346 ESC M screen control 4-226
Dispenser Door function data 5-179 ESC N screen control 4-227
Dispenser Door state (DR) 4-85 ESC O screen control 4-228
Display Date and Time template 4-255 ESC P screen control 4-229
display mode 4-212 ESC Q screen control 4-230
Do Nothing function data 5-201 ESC R screen control 4-231
document removal time 4-349 ESC T screen control 4-233
dollar buffer 4-28 ESC U screen control 4-235
Dollar Buffer Size feature 4-342 ESC W screen control 4-237
Dollar Decimal Places feature 4-342 ESC X screen control 4-238
Dollar Entry state (F) 4-28 ESC Y screen control 4-241
ESC ZC screen control 4-241
E ESC ZD screen control 4-241
ESC ZE screen control 4-242
Electronic Data Capture (EDC) 4-102, 4-104, 5-58,
ESC ZF screen control 4-242
5-207 ESC ZI screen control 4-244
Printer state (PR) 4-101
ESC ZO screen control 4-244
EMG. See Enhanced Monochrome Graphics
ESC ZU "MPEGPlay" screen control 4-244
Enable OK and Correction Keys for 9000 States ESC ZU "ScrnMark" screen control 4-253
feature 4-344
ESC: (colon) screen control 4-255
encrypting PIN pad (EPP) 3-9
euro character 4-191, C-8, C-14
encryption keys 4-354 expanded ASCII format 5-116
English characters 3-22
expanded ASCII format: 3-16, 3-48
Enhanced Alarms Interface 5-18
Extended Range for Message Coordination Number
enhanced Function Command message 5-142 Field feature 4-346
function data entries 5-157
External Options Module
Enhanced Function Command Message
solicited status 5-53
Coin Dispenser 5-162 External Options Module function data 5-181, 5-183
Lead-through Lamps 5-185
Enhanced Monochrome Graphics 4-292
F
Enhanced Monochrome Graphics (EMG)
Write Command 13 message 4-324 fade-in transitions 4-198–4-199, 4-260, D-2
Index-2
TP-821029 (Ed. A)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Index
Set Language Bank state (@Y) 4-181 solicited statuses 5-23

touch screen 4-297 standard character set C-14
Multiple Functions function data 5-187 unsolicited status 5-93
printing
N attribute persistence 3-54
network configurations 2-1 character attributes 3-54
Network Connection state (NC) 4-97 printing strategies 3-11
Network SDM DIT Control feature 4-346
network to terminal messages 5-1 R
No Retract Bills feature 4-344 Rear Balance feature 4-298
receipt printer 3-11
O Printer state (PR) 4-101
Off-line mode 2-3 receipt printer emulation 3-16
off-line time 4-348 Recognition Subsystem (RSS) 4-151
Open Account Relationship (OAR) reject reason codes 5-69
Multilingual feature 4-296 Remote Key Transport feature 4-356, 5-20, 5-60,
Write Command 5 message 5-215 5-80
Operational Command message 5-202 reserved screens 4-282
command codes 5-204 dip card removal 4-350
functions 5-202 envelope dispensing 4-17
supply counts 5-208 Rear Balance feature 4-299
Out-of-service mode 2-3 screens 004, 005, and 006 4-296
Voice feature 4-310
P reserved URLs. See browser support
Retrieve Enhanced Supply Counts 5-208
palette D-70
Retrieve System Time and Date 5-213
palette registers 4-227
Retry screen time, swipe/dip card readers 4-349
pass-through mode/strategy 3-12, 3-48 row size of screen 4-259
Passbook Printer state (PB) 4-100
PIN
S
Check PIN state (@C) 4-122
PIN Entry state (B) 4-15 screen data D-2
PIN Entry state (B) 4-15 screen font selection 4-212
PIN Entry state (M) 4-42 screens
PIN Retry Count 4-123 alternate character set 4-193, 4-206
Portuguese characters 3-27 animation 4-206, 4-209, 4-242, 4-260
position cursor 4-238 blinking area 4-237
Power-up mode 2-3 character sets 4-191, 4-212
power-up screen data D-2 check icon 4-230
Prepackaged Icon Animation Sets 4-206 clearing the screen 4-200
printer control sequences 3-43, 3-51 colors 4-209, 4-213, 4-217, 4-232, 4-235
ESC D 3-46 consumer name 4-200
ESC I 3-47 control sequences 4-197
ESC L 3-48 cursor positioning 4-200–4-201, 4-238
ESC N 3-48 DACs 4-228
ESC Q 3-49 date and time 4-255
ESC R 3-49 display grids 4-189
ESC T 3-50 display mode 4-212
Printer function data 5-189, 5-193, 5-195 Enhanced Monochrome Graphics 4-292
Printer state (PR) 4-101 fade-in, fade-out 4-258, 4-260
printers FLC/FLI files 4-242
alternate character set C-16 fonts 4-212
character sets 3-21 format templates 4-329
control sequences 3-43, 3-51 icons 4-206, 4-229, 4-264
first alternate character set 3-54 language selection 4-226
second alternate character set 3-55 mosaic character set 4-194
Index-4
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Index
MPEGs 4-244, 4-253 SSF. See Status Source field

Multilingual feature 4-294 Standard Alternate characters 3-24
non-addressable area 4-233 Standard English characters 3-22
Off Line screen 2-4 statement printer 3-16
Out of Service screen 2-3 Statement Printer function data 5-197
palette registers 4-227 Statement Printer state 4-114
repeating cells 4-231 states
reserved screens 4-282 9000-style states 4-7, 4-10
resolution 4-226 card reading/writing 4-44
row size 4-259 enhanced states 4-8, 4-68
screen insertion, nesting 4-203, 4-214 state processing failure 4-8
scrolling text 4-219 valid state numbers 4-8
special effect time 4-241 Write Command 1 message 4-7
sprites 4-260 status descriptors 5-16
standard character set 4-191 Status Source field 5-77
tiling an area 4-231, 4-235 Supervisory and Supply Actions 5-83
touch screen 4-241–4-242, 4-244 Supplemental Dispenser Module (SDM)
Write Command 2 message 4-184 Description 3-2
scrolling text on screens 4-219 Supplemental Dispenser Module (SDM) State 4-110
SDM 3-2 supply counts 5-208
Select Function state (E) 4-25 solicited status 5-48
Send All Status feature 4-345 swipe card reader
Send Envelope Dispenser Status to Network Retry screen 4-349
feature 4-346
Separate Ready Response feature 4-342 T
Set Buffer state (@F) 4-137 tcsvideo.js. See browser support
Set Dollar Buffer state (R) 4-42 Terminal Control Software Extended Application
Set Language Bank state ( [ ) 4-65 (SXA) D-12
Set Language Bank state (@Y) 4-181 terminal parameters 4-338
Set System Time and Date 5-213 terminal response to network commands 2-6
Set/Clear Enhanced Supply Counts 5-208 terminal to network messages 5-1
side panel light 5-181–5-182 Text To Speech 4-316
signage unit 5-181 Text To Speech state (AU) 4-69
solenoid safe lock 5-183 text-related strategies 3-12
Solicited Status message 5-14 tiling a screen area 4-233
solicited statuses Time Delay state (@S) 4-175
After Hour Depository 5-26 timers 4-347
Card Reader 5-27 enhanced states 4-68
Card Writer 5-28 recommended values 4-350
Cassette 5-43 timer 00 (keyboard response) 4-347, 5-217
Check Point 5-44 timer 01 (consumer response extension) 4-347,
Coin Dispenser 5-46 5-123, 5-128
Configuration ID 5-42 timer 02 (Close state screen) 4-37, 4-347–4-348
customizing 5-103 timer 03 (communications message) 4-34, 4-344,
Depository 5-38–5-40 4-347
Dispenser 5-29, 5-34 timer 04 (deposit insertion) 4-347–4-348, 5-123,
enhanced statuses 5-54 5-128
External Options Module 5-53 timer 05 (cash removal) 4-348, 5-125, 5-127,
Hardware Configuration 5-56 5-130
Printer 5-23 timer 06 (off-line) 4-348
reject reason codes 5-69 timer 07 (cash removal extension) 4-348,
Supply Counts 5-48 5-125–5-127, 5-130–5-131
Withdrawal Door 5-37 timer 08 (bag deposit insertion) 4-348
special effect time 4-241 timer 09 (card removal) 4-348, 5-132
sprites 4-260 timer 15 (card insertion, T state) 4-44, 4-349
Index-5
TP-821029 (Ed. A)
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
TP-821029 (Ed. A)
Mon Nov 22 16:28:25 2004
Index
VGA Plus files Voice state ( ; ) 4-54

color wheel files D-62 .WAV files 4-313
frame files D-63 Voice state ( ; ) 4-54
sprite definition files D-64
VGA Plus Files D-52 W
Custom DAC Files D-57 Withdrawal Area Sensors state ( ? ) 4-64
DAC File Format D-58 Withdrawal Area Sensors status 5-97
DAC Files D-56 Withdrawal Door status 5-37, 5-97
Datetime File D-60 Write Command messages 4-4
Installing the Revert File D-55 common fields 4-5
Palette File D-61 Write Command 1 4-7
power-up screen files D-53 Write Command 13 4-324
Power-up Screen Files D-52 Write Command 14 4-325
Revert Files D-54 Write Command 15 4-327
Sprite Definition File Commands D-66 Write Command 18 4-328
Sprite Definition Files and Frame Files D-63 Write Command 2 4-184
What Does a Revert File Do D-54 Write Command 3 4-338
Voice feature 4-286, 4-310 Write Command 5 5-215
keypad feedback 4-186, 4-314 Write Command 6 4-352
non-U.S. currency 4-313 Write Command 7 4-354
prompting and feedback 4-315 Write Command 8 4-357
voice prompting commands 4-185
Index-7
TP-821029 (Ed. A)

Agilis For ixCSP Terminal Programming Manual PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Agilis For ixCSP Terminal Programming Manual PDF

Uploaded by

Copyright:

Available Formats

PRELIMINARY - DRAFT COPY

Mon Nov 22 16:28:25 2004

Agilis® 91x for ix/CSP

Document Number Date Remarks

Section 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Section 2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Section 3 ix Series Terminals and Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Section 4 Configuration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

4.3.1 Valid State Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

4.5.27 Buffer Overlay State (@Q b/) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-171

4.7.44 ESC = (equal) - Select Row Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-259

Section 5 Transaction Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

5.5.23 Present Card (U) (912 mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-138

Appendix A ASCII-to-EBCDIC Code Conversion Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Appendix B Network Integration for Check and Coin Processing . . . . . . . . . . . . . . . . . . . . . . B-1

Appendix C Application Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Appendix D VGA Plus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

D.18.2 Color Wheel Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-71

Figure 2-1 Sample Terminal Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Figure 4-37 Swipe Card Animation Icon 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-280

Table 1-1 Device/Feature Support Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Table 3-16 Printer Control Sequences for Statement Printers . . . . . . . . . . . . . . . . . . . . . . . . 3-51

Table 4-53 Check FIT State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-119

Table 4-108 Write Command 13 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-324

Table 5-46 Printer Unsolicited Status (SSF = ’4’) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-93

Table D-24 Default Color Wheel Set-up Number 014 . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-85

1.1 About This Manual

This manual is divided into the following sections:

Code Conversion Chart

Network Integration for Check and Coin Processing

1.2 Related Documents

The following manuals provide additional information on ixSeries terminal

• Agilis 91x for ix/CSP Maintenance Manual (TP-820589-001E)

• Agilis 91x for ix/CSP Installation and Configuration Guide

• TABS Activator Card Magnetic Encoding Format Reference Manual

• Data Security Procedures and Reference Manual (TP-799530-001D)

• Enhanced Monochrome Graphics Programming Manual (TP-799300-000A)

• Color Graphics Feature Programming Manual (TP-799344-000A)

For information about network protocols, refer to the documentation supplied

For programming information about implementing smart card transactions on

The abbreviation TCS refers to Diebold’s Terminal Control Software, including

Transaction Host, Message Settings, Status Message, Terminal Model Number

For further information about configuration settings and configuration

The abbreviation ABC refers to Agilis Base Communications. ABC is a

1.4 Supported Devices and Features

Table 1-1 Device/Feature Support Summary

Feature Supported/required by Agilis

Hard Drive Capacity 15GB or higher

Minimum Memory 256MB

Minimum Processor Support Pentium III 500Mhz or higher

Operating system XP Professional

911 Bill Mix Support Yes

Advanced Supply Manager Yes

After Hours Depositor (AHD) Yes

Bulk Note Acceptor No

Bulk Note, Article 6 Support (Back tracing) No

Card Reader, Chip Card Support Yes

Card Reader, Motorized Yes

Card Reader, Swipe Yes

Card Reader, Dip Yes

Continuous Availability (CAS) Yes

Check Depositor IDM Yes -IDM2/3

- Burroughs Async Poll Select (TC 500) Yes