Professional Documents
Culture Documents
VeriCentre Technical Reference Manual
VeriCentre Technical Reference Manual
VeriFone, the VeriFone logo, Omni, VeriCentre, Verix, Verix V and ZonTalk are registered trademarks of VeriFone. Other brand
names or trademarks associated with VeriFone’s products and services are trademarks of VeriFone Systems.
All other brand names and trademarks appearing in this manual are the property of their respective holders.
Comments? Please e-mail all comments on this document to your local VeriFone Support Team.
VeriFone Systems
2099 Gateway Place, Suite 600
San Jose, CA, 95110 USA
(800) VeriFone (837-4366)
www.verifone.com
VeriFone Part Number 53040, Revision G
CONTENTS
PREFACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Target Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Document Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Conventions and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
CHAPTER 1
Architecture Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Other Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
High Availability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Scalability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
License Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Core Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Download Management Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Download Automation Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Message Management Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Information Collection Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Remote Diagnostics Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
CHAPTER 2
Message Parser Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
and Router (MPR) Working of MPR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
CHAPTER 3
Tunable Configuring System Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Parameters Modifying Values Using the CFGParamEditor . . . . . . . . . . . . . . . . . . . . . . . 39
VeriCentre Registry Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
VeriCentre Environment Monitor Parameters . . . . . . . . . . . . . . . . . . . . . . . . 43
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Composer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Terminal Manager Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Database Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Download Server Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Monitor Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Download Parameter Server - Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . 49
Import Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Export Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Message Router Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Query Builder Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Trace Client Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
VID Server Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
VID Client Parameters (VID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuration of Portfolio Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
CHAPTER 4
Ports Used by . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
VeriCentre
CHAPTER 5
Algorithms Computation of Download Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
CHAPTER 6
File Formats File Format for VeriCentre MIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Sample XML file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
VTMS Main UI Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
VTMS Layout XML Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Add/Modify/Remove a Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Add/Modify/Remove an Item in a Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Specify the Access Keys for Tabs/Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Invoking Single or Multiple Instances of Application from VTMS . . . . . . . . . 67
Configuring the Tab Strip Placement and the Maximum Number of Items in
Recently Used Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Import/Export File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
XML File Format for Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
XML File Format for Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
XML File Format for Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Form View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Application Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Tab Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
ControlGroup Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Control Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Label Control Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
TextBox Control Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
CheckBox Control Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
DropDown Control Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
DataGrid Control Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
DataGrid Control - Column Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
DataGrid Control - TextBox Column Element . . . . . . . . . . . . . . . . . . . . . . . . 85
DataGrid Control - CheckBox Column Element . . . . . . . . . . . . . . . . . . . . . . 85
DataGrid Control - DropDown Column Element . . . . . . . . . . . . . . . . . . . . . . 85
Business Rule Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Multi-Merchant XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Card Range XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Structure of License File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Counted Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
UnCounted Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Report SQL and Filter XML File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Sample Report XML for Download Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
XML Escape Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
ZONTALK File Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Terminal.tdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Sample .tdd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
CHAPTER 7
Upgrading License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
CHAPTER 8
How To Validations for an MI Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Image File Conversion Format for Mails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Performing a Monitor Call or an Urgent Mail Job . . . . . . . . . . . . . . . . . . . . . . . 113
Monitor Call and Urgent Mail Job Sequence . . . . . . . . . . . . . . . . . . . . . . . 113
APPENDIX A
Errors and Validation for a Download Request Packet . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Troubleshooting Download Management Module Error/Information Messages . . . . . . . . . . . . . 116
Download Automation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Error/Information Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Event Logs from VeriCentre DASWS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Enable Creation of Debug Log for Download Automation Server. . . . . . . . 125
Windows service “VeriCentre Download Automation Scheduler” is not running
125
Message Management Module Error/Information Messages. . . . . . . . . . . . . . 126
Information Collection Module Error/Information Messages. . . . . . . . . . . . . . . 126
Remote Diagnostics Module Error/Information Messages . . . . . . . . . . . . . . . . 128
Monitored Item Error/Information Messages . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Monitored Item Import Error/Information Messages . . . . . . . . . . . . . . . . . . 130
Miscellaneous Error/Information Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Debugging the VeriCentre Server and Client Modules . . . . . . . . . . . . . . . . . . 135
Debugging the VeriCentre Communication Modules . . . . . . . . . . . . . . . . . . . . 136
APPENDIX B
‘Check for Format of ‘Check for Updates’ Request Over Ethernet . . . . . . . . . . . . . . . . . . 139
Updates’ Request Format of ‘Check for Updates’ Request Over Dialup and X.25 (XCU calls). . . 140
and Schedule Schedule Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Response Formats
APPENDIX C
Directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
GLOSSARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Target This document is intended for VeriCentre system administrator, VeriCentre user,
Audience VeriCentre support personnel, Help desk administrator and Help desk operator.
The users of this manual should be familiar with:
• Microsoft Windows XP/2003 operating system.
• Database operations for Oracle, if you are using VeriCentre for Oracle, or
database operations for SQL Server, if you are using VeriCentre for SQL
Server or VeriCentre LE.
• Communication devices such as dial concentrators, modems, multi-modem
cards/devices, multi-port cards/boards.
• SQL (Structured Query Language).
• Usage of modems.
Conventions The following conventions help the reader distinguish between different types of
and Acronyms information:
• The courier typeface is used for code entries, filenames, and anything that
might require typing at the DOS prompt or from the terminal keypad.
• The italic typeface indicates book title or emphasis.
• Text in blue indicates terms that are cross-referenced. When the pointer is
placed over these references the pointer changes to the finger pointer,
indicating a link. Click on the link to view the topic.
NOTE
Note points out interesting and useful information.
CAUTION
Caution points out potential programming problems.
Architecture
VeriCentre Client(s)
Clients are used to manage the overall VeriCentre system configurations that
include:
• configuring terminals, servers etc.,
• performing direct download, remote diagnostics and information collection,
• managing messages,
• monitoring and tracing downloads, and
• generating reports.
VeriCentre Database
Most of VeriCentre configurations are managed by VeriCentre database. Servers
and clients access the database to store and retrieve data.
VeriCentre Modules
VeriCentre is comprised of five modules:
NOTE
The availability of modules depends on the type of license that you have.
High Availability When a server or a server process in the VeriCentre system fails, the server
responds by dispersing the work from the failed server to the other server or
server processes in VeriCentre. This ensures that the requests are still handled,
though at a lower throughput. This process is called high availability.
VeriCentre supports high availability at the following three levels:
• System level
• Application level
• Management Communication server level
• Threshold Analyzer
• Help Request Client
Load Balancing Load balancing is a technique that allows the performance of a server to be
scaled by distributing its requests across multiple processes within VeriCentre.
The load can be equally distributed across all the server processes. If a server
fails, the load balancing mechanism dynamically redistributes the load among the
remaining server processes.
VeriCentre servers can be setup using the Windows Network Load Balancing
(NLB) feature to evenly distribute the requests (from the terminals) across
VeriCentre servers. NLB is applicable only for the requests received over TCPIP
media. VeriCentre servers with Windows 2003 OS should be configured as part of
a NLB cluster. Terminals should initiate their requests to the cluster IP of the NLB
cluster. If one of the VeriCentre Secondary servers goes down or fails, requests
from the terminal are automatically re-routed to other servers. Refer to Windows
2003 documentation for more details.
Scalability Additional servers or instances of the server processes can be added to enhance
performance when some part of the system is overloaded. This boosts the
throughput of the system at the same time keeping response times at a lower
value. This process is called as Scalability.
VeriCentre supports scalability at the following levels:
• System level - This is the number of VeriCentre servers (also referred as
Communication servers). It is determined at the time of setting up VeriCentre.
The factors that determine the number of servers for VeriCentre are:
• number of terminals that should be supported.
• number of simultaneous connections that are required.
• downtime of VeriCentre server.
• configuration for the VeriCentre servers and the performance expected.
NOTE
Contact VeriFone support personnel for more details before making changes to
your VeriCentre setup. This involves tuning at the database and licensing level.
• Process level - This is the number of VeriCentre server processes that can be
launched on a VeriCentre server. Support for multiple instances is available for
the following VeriCentre server components:
• Dial process -The number of instances of the Dial module can be
increased to support scalability. The maximum number of instances per
VeriCentre server is four.
When you start VeriCentre server, the Dial scheduler module is started as
a part of VeriCentre startup which is responsible for scheduling the dial
session requests between multiple instances of the Dial module.
• Download server process - The number of instances of the Download
Server module can be increased to support Scalability. The maximum
number of instances per VeriCentre server is four. The Message Router
module takes care of scheduling download requests between the multiple
instances of the Download server.
• Management communication server - There can be a maximum of four
instances of the Management Communication server per VeriCentre
server. The Message Router module takes care of scheduling requests
between the multiple instances of the Management communication server.
• Communication client - There can be a maximum of four instances of the
communication client per VeriCentre server. The management
communication server module takes care of scheduling mail requests
between multiple instances of the communication client. Instances of the
communication client can be spread across multiple VeriCentre servers.
For example, there can be two communication servers and four
communication clients. Two of these communication clients can be on one
VeriCentre server and two on another.
• ICM - There can be a maximum of four instances of the ICM server
process per VeriCentre server. The management communication server
module takes care of collecting MI information from the terminal, at the
request of the Information Collection module. There can be multiple
instances of the Information Collection module that is spread across
multiple VeriCentre servers. For example, there can be two
communication servers and four ICM clients. Two of these ICM clients can
be on one VeriCentre server and two on another.
• Threshold Analyzer - There can be a maximum of four instances of the
threshold analysis server process per VeriCentre server. The management
communication server module collects MI information, at the request of the
Threshold Analyzer. There can be multiple instances of the Threshold
Analyzer that is spread across multiple VeriCentre servers. For example,
there can be two communication servers and four Threshold Analyzers.
Two of these Threshold Analyzers can be on one VeriCentre server and
two on another.
• Help Request Client - The Help Request Client is available on all
VeriCentre client installations, and can be viewed in the Terminal Manager.
The management communication server module collects MI information,
at the request of the Help Request Client. There can be multiple instances
of the Help Request Client that is spread across multiple VeriCentre
NOTE Before changing the number of servers or the number of instances to be installed
for VeriCentre, contact VeriFone support personnel for details. This involves tuning
at the database level and licensing level.
License Service The primary server contains the license information of VeriCentre, and the service
required for running the license feature.
Core Services
All VeriCentre modules use a set of common components to meet the basic
requirements. The components in core services provide features to handle
common requirements across modules.
The interfaces and libraries available in the Core Services are:
• Debug support - provide APIs for debug logging. The debug activity is
performed by Dbgview.exe, a third party application. This tool is available as
a free download at http://technet.microsoft.com/en-us/sysinternals/
default.aspx.
Communication Services
VeriCentre has several sub-modules that provide communication services. These
sub-modules are listed and described in the following table:
NOTE • In certain conditions, if you manually stop the VeriCentre server, VEM may bring
up the VeriCentre server service again. To avoid this, stop the VEM service.
• The VeriCentre server service sets a dependency on the VEM service used during
installation.
Refer to the VeriCentre Environment Monitor Parameters section for more details.
When this feature is disabled, VEM is idle except for bringing up the VeriCentre
server service the first time, VEM starts.
Download This module helps while downloading applications simultaneously to large number
Management of terminals. It also speeds the process of terminal deployment significantly, and
Module downloads the application updates for existing applications by streamlining the
download process.
• AutoDL
20 VERICENTRE TECHNICAL REFERENCE MANUAL
A RCHITECTURE
Modules
VeriCentre determines if there are any file/parameter updates for any of the
applications configured for this terminal, based on new application versioning
scheme introduced in VeriCentre. If the current version of an application in
VeriCentre for the given terminal model does not match with the version of this
application that was last downloaded to this terminal from this VeriCentre
system, then VeriCentre will detect this as an updated application. Parameter
updates will be automatically determined based on the last time the terminal
received a download and the time of the last parameter update.
If there are updates available, DAS will respond to the update check call with a
schedule (date/time) after reserving a slot in the system for that terminal. The
AutoDL application tracks this schedule and calls back to VeriCentre at the
scheduled time to obtain the actual application updates. If this terminal is
enabled for Callback Immediate in VeriCentre, then DAS will send a
special download schedule of '00000000000000' in the check update
response and this will indicate to AutoDL that it should call back immediately
for downloading the updated applications.
When AutoDL calls VeriCentre at the scheduled time, *UA is used as the value
for application field. This is a special designator for VeriCentre to send all the
available updates. This indicates that it is an automated download. All other
fields in the download request are identical to a normal terminal initiated
download (XDL call). Refer to the Appendix B for details on the message
structure for the check update request and response messages.
Architecture
VeriCentre Download Automation solution is primarily responsible for the following
tasks:
• Handle check for application update requests from the terminal(s).
• Generate and respond back with the download schedule, if application
updates are available.
• Handle automated download request from the terminal(s).
The solution handles the terminal requests (check for updates and automated
downloads) over the following media:
• Ethernet (LAN or WAN)
• Dial (PSTN or ISDN phone lines)
• With PPP
• Without PPP and with dial concentrators like Cisco Access Server 5350.
• Without PPP and without dial concentrators
• Wireless network (Wi-Fi, CDMA, GPRS media)
• GSM over Dial
• X.25
Figure 3 depicts the components responsible for handling terminal requests, and
the interaction across components for various download media.
NOTE DASWS and DASM job are available on all VeriCentre servers. By default, the
service and the job run only on the VeriCentre primary server. They can be
configured to run on any one of the VeriCentre servers. Refer to the Configure
DASWS and DASM Job to Run on a VeriCentre Secondary Server section In
VeriCentre Online Help for more details.
NOTE
Download Automation solution does not consider daylight savings.
NOTE
The Message Management module is available only for the VeriCentre
Enterprise edition.
Responses received from the terminal can be viewed using e-mail clients such as
Microsoft Outlook or Microsoft Exchange.
Figure 6 illustrates the working of the Message Manager module.
Messenger Application
The Messenger Application on the terminal is responsible for handling messages
between VeriCentre and applications running on terminals.
Composer Application
This is a stand-alone application to create and send messages to a selected
terminal or set of terminals through the Message Manager Server. Composer
application can also be invoked as a part of the Message Manager in VeriCentre.
Information The Information Collection module enables you to collect the information on
Collection Module model and application MIs from a terminal. The collected information is useful in
identifying potential terminal problems and preventing the same.
NOTE
The Information Collection module is available only for the VeriCentre Enterprise
edition.
You can generate reports from the collected information, thereby aiding you in
your business decisions. For example, you can obtain information on the number
of transactions performed, the number of rejected transactions or the number of
offline transactions.
NOTE
The Remote Diagnostics module is available only for the VeriCentre Enterprise
edition.
Some of these problems can be corrected online, avoiding the costs involved in
returning the terminal for repair. For example, you can rectify a problem occurring
due to an improper setting of an application configuration parameter, or setting of
an incompatible software device driver on the terminal.
Remote diagnostics can be of the following types:
• Interactive diagnostics
• Automatic diagnostics
Interactive diagnostics
In an interactive diagnostics session, a help desk operator performs a set of
diagnostic queries on a terminal that is online. The query retrieves values of the
configured MIs from the terminal. When executed, the query checks for the
threshold condition. If the MI value crosses the ‘alert’ threshold, the query
provides an alert message, and then you can perform the suggested corrective
action.
You can also view the values of the application parameters on the terminal with
the values configured in the VeriCentre database. If there is a difference, then you
can correct the MI value while the terminal is online.
Automatic diagnostics
Automatic diagnostics checks the MI values and alerts you about potential
problems on a terminal. This helps in the preventive maintenance of a terminal.
While configuring MIs for remote diagnostics, you should create a threshold rule
for an MI. You should also configure the Remote Diagnostics module to perform
pre-defined actions, if the threshold rule is violated. For example, log to
VeriCentre database, log to file, or send e-mail to raise an alert condition.
VeriCentre performs an automatic diagnostics session at the following instances:
• Scheduled - VeriCentre dials out to the terminal at a pre-configured time and
performs the remote diagnostics.
• Unscheduled - VeriCentre performs remote diagnostics, whenever a terminal
is online. The session can be initiated by a terminal, or by VeriCentre. The
session may have been initiated by VeriCentre to send an urgent mail, or to
perform interactive diagnostics.
The Remote Diagnostics modules are listed and described in the following table:
• Log to File
VeriCentre records the MI values that cross the threshold condition in a file
selected by the user.
c Change the user context service of the VeriCentre server with details of
the VeriCentre user by selecting Control Panel > Settings > Services >
VeriCentre Server and changing the user context.
In case of VeriCentre for SQL Server, the pre-requisites to log into other
database are given below:
g Enter the Login ID (xyz) and Password (xyz), where xyz is the
VeriCentre user name and password.
h Click Next.
i Change the default database to abc.
j Click Next.
k Click Finish.
The VeriCentre database user should have Create and Write
permissions for other database. For example, if the VeriCentre user is
xyz and the Log to Other Database user is abc, then xyz should have
Create and Write permissions for abc.
4 Log into SQL server from the SQL analyzer and provide permission to
VeriCentre database user (where processes are running) if user name is
xyz with password xyz.
VeriCentre sends mails and alerts to the user when the MI value on the
terminal crosses the threshold condition.
Parameter Description
DB_Username Stores the name of the database user.
DB_Password Stores the encrypted database password as text in registry.
DB_Dsn Stores the ODBC data source name used by the UI components.
Tunable Parameters
This chapter describes all the tunable parameters used in VeriCentre. VeriCentre
supports two editors to configure the tunable parameters. They are:
• Configuring System Parameters (CfgParamEditor.exe)
• VeriCentre Registry Editor (VCRegEditor.exe)
NOTE
For modifications performed using editors, server should be restarted for changes
to take effect.
Configuring This utility is used to customize settings, such as, the time-out values and system
System limits of VeriCentre. Some of the system parameters are server-specific though
Parameters the current version of VeriCentre does not have server-specific configuration data.
The CFGParamEditor is used by the technical support personnel to edit the
system parameters after the installation, or as part of region-specific
customization.
The CfgParamEditor.exe utility is located in the <VeriCentre
Installation directory>\Bin directory.
Modifying Values Following are the steps to modify parameters using the CFGParamEditor:
Using the
CFGParamEditor To modify the parameters:
1 Go to the <VeriCentre Installation directory>\Bin directory.
The description for the parameter can be viewed in the Description box. If the
parameter is read-only, the Value field is hidden. If the value is editable, then
change the value in the Value field.
5 Click Restore button to restore the original values.
Table 3 lists and describes the tunable parameters and their default values.
VeriCentre VeriCentre Registry Editor is used to modify the registry values of a VeriCentre
Registry Editor installation. If there are multiple installations of VeriCentre on your machine,
modify the registry values for a particular installation.
Registry values for VeriCentre consist of tunable parameters for download, data
source related information such as user name, password (encrypted) log file
locations and composer options.
The VeriCentre Registry Editor is an independent application that runs even if
VeriCentre is not running.
NOTE The procedure to modify the default values of VeriCentre Registry Editor is similar
to CFGParamEditor. Refer to the Modifying Values Using the CFGParamEditor
section for more details.
NOTE
If the DynamicVal parameter is modified, restart the Terminal Manager.
Download Table 11 describes the parameters for the download parameter server.
Parameter Server - Table 11 Download Parameter Server - Parameters
Parameters
Parameter Default Value Description
Plist_RemoveDupParam Unchecked Optimizes the download by
removing duplicate parameters.
Plist_stopifUSESNotFound Checked Stops the download if the USES
terminal is not found.
NOTE
The minimum import file size is 1 MB, and the maximum size is 100 MB. The
default file size is 20 MB.
Message Router This section of the registry contains the Regular Expressions to match with
Parameters requests coming from the terminal.
NOTE
It is not recommended to change these values.
Configuration Portfolio Management feature is used to restrict access to a group of clusters and
of Portfolio applications for a set of users and groups. By default, Portfolio Management
Management feature is disabled. It can be enabled or disabled using the PF Configuration utility,
located in ...<VeriCentre Installation Directory>\Bin.
4 Click OK.
NOTE
Portfolio Management can also be disabled using the PFConfig.exe utility.
Configuration Purge utility is pre-configured to run daily for deleting the data older than the
of Purge retention period.
Configuring Purge VeriCentre maintains database logs on the various activities that it performs. The
for VeriCentre stored information needs to be cleared at regular intervals to remove old and
Enterprise redundant information.
Purge is the database maintenance utility in VeriCentre. Purge is configured
during installation, and it runs on the database server system. You can perform a
manual purge operation from a VeriCentre client system. VeriCentre Purge has
the following functions:
• Purging old data from the database. The purge utility cleans up the log tables
in the database, retaining only the data that is within the retention period. The
period the database logs are retained is called the retention period.
• Performing complex and time consuming database operations after office
hours. For example, if mail is addressed to 500 terminals, deletion of the mail
(after activation date) during regular office hours will affect the performance of
the system, so it is scheduled after office hours.
From the VeriCentre client system, you can schedule VeriCentre to perform a
purge at a given time using the Task Scheduler service on Windows. For more
information on the Task Scheduler, refer to your Windows help documentation.
Besides purging data at predefined intervals, you can also purge the database
logs instantaneously using VeriCentre - Purge Configuration. This option also
allows you to modify the time period for which a database log is stored.
NOTE It is preferable to retain the default purge time. However, if you change it, ensure
that you set the purge schedule for after business hours, as purging data may
slow down your system.
The Purge category list displays the different VeriCentre modules (for
example, the Download Module and the Message Manager categories). The
different types of purge activities are organized within their respective
modules.
2 Select the purge activity that you want to perform. Details of the selected
activity appear on the right.
• The Purge category box displays the name of the purge activity that you
select in the Purge category list on the left pane.
• The Parameter value box displays the number of days the information will
be stored in the VeriCentre database. You can change this Parameter
value, except when it displays a NULL value. If the Parameter value is
NULL, purge occurs only according to the default schedule.
• The Last purge date box displays the date of the last purge on the
selected activity.
• The Description box displays a description of the purge activity.
4 Click Apply.
• Click Purge All to purge all the data of all the events logged in the
database.
• Click Purge to purge data of the selected event.
You can also select the entire Purge category, and click Purge All to purge
the entire contents of the selected category.
The purge activity purges all database logs that fall outside the retention
period of the database logs.
If you are using firewall ensure that following ports are added in the exceptions
port list.
Table 18 Ports used by VeriCentre
Port Number Protocol Where? Description
8000 TCP Server This is a listener port on the server. This is the port
used by the monitor server for publishing data to
the monitor clients. This port is not configurable
using any of the VeriCentre utilities. This port can
be configured for a server by directly updating
MONITOR_PUBLISH_PORT field in
CORE_SERVER table in database.
8001 TCP Server This is a listener port on the server. This is the port
used by the monitor server to listen to incoming
service requests from the monitor clients. This port
is not configurable using any of the VeriCentre
utilities. This port can be configured for a server by
directly updating MONITOR_LISTEN_PORT field
in CORE_SERVER table in database.
48723 TCP Client This is a listener port on the client. This is the port
used by the monitor client to receive data from the
monitor server. This port can be configured by
updating the following registry key on client
machine.
VeriCentre >v3.0 > Download Monitor Client >
Mon_ClientPortNo.
If you modify this port number, you need to execute
the following tasks so that non- administrative
users can use the Download Monitor Client:
1.Login to the client machine with a user having
administrative privileges.
2.On command prompt, go to VeriCentre\Bin
folder.
3.Execute following command
MonitorHTTPNameSpaceReservation.exe
For example, C:\Program Files\Bin>
MonitorHTTPNameSpaceReservation.exe
27008 TCP Primary Server This is a listener port on the server. It is used for
VeriCentre license management. This port can be
configured by updating the following registry key on
Primary Server machine.
VeriCentre >v3.0 > License > ListenerPort
Legend
• Server - The VeriCentre communication server from which downloads are
performed. There can be multiple communication servers in a VeriCentre
installation.
• Database server - The computer that hosts the Oracle or SQL Server
database. There is only 1 database server in a VeriCentre installation.
• Primary server - The server on which VeriCentre license manager is running.
There is only 1 Primary server in a VeriCentre installation.
• Client - The computer that runs client software for performing operations and
administration tasks on a VeriCentre system.
Algorithms
Computation of Download Monitor uses the following algorithm to compute the estimated time for
Download Time completion of downloads.
Estimated time to complete a download =
Time taken to transfer X Total number of bytes to be transferred
Number of bytes already transferred
File Formats
This chapter explains various file formats for VeriCentre MIs and VTMS main UI
layout.
File Format for MIs are defined in XML file format. Use the VeriCentre MI’s .dtd file while
VeriCentre MIs defining the MIs within an XML file.
Sample XML file This section describes a sample XML file showing a .dtd file reference:
RequestPacketIDCDATA#REQUIRED
ApplicationNameCDATA#IMPLIED
<!-- each MI category contains category name, description and one or more
MIs-->
<!ELEMENT MICategory (MI+)>
<!ATTLIST MICategory
CategoryNameCDATA#REQUIRED
DescriptionCDATA#IMPLIED
<!-- MI details -->
<!ELEMENT MI EMPTY>
<!ATTLIST MI
MINameCDATA#REQUIRED
ReferenceIDCDATA#REQUIRED
DescriptionCDATA#IMPLIED
DataType(String|Counter|Binary)
"String"
Instances(Single|Multiple)"Single"
AccessType(Read-only|Write-only|Read-Write) "Read-Write"
DisplayFormatStringCDATA#IMPLIED
FetchMethodAlways|Once|Once-per-session)"Always"
ThresholdCondition
(None|Equal-to|Not-equal-to|Less-than|Greater-than|Less-than-equal-
to|Greater-than-equal-to|Inside|Outside)
"None"
LowWatermarkCDATA#IMPLIED
HighWatermarkCDATA#IMPLIED
VTMS Main UI You can customize the layout of VeriCentre Terminal Management System to your
Layout requirement by modifying the VTMS Layout XML. The XML defines the tabs, and
items of each of the tabs. By default, XML contains entries for all VeriCentre
standard applications. You can customize the VTMS layout by performing any of
the following operations:
• Add/Modify/Remove a Tab
• Add/Modify/Remove an Item in a Tab
• To Add a VeriCentre Standard Application
• To Add a Windows Application (non VeriCentre standard applications).
• To Add a Web Application
• Specify the Access Keys for Tabs/Items
• Invoking Single or Multiple Instances of Application from VTMS (applicable
only for non VeriCentre Windows applications).
• Configuring the Tab Strip Placement and the Maximum Number of Items in
Recently Used Tab.
To restore the default configurations for all items, click on Restore Defaults
button.
6 Modify the XML appropriately to change the layout of the VTMS main user
interface. Refer to the VTMS Layout XML Format for more information.
where,
<MENULIST> Root node of the XML. It contains all the <MAINMENU> nodes
that define the tabs of the UI. <MAINMENU> node contains
<MENUITEM> nodes that define the items i.e., the
applications that should appear in the tab. The <MENUITEM>
item contains either the <ID> node or the
<APPLICATIONPATH> node. The <ID> should be given for
VeriCentre Standard Application and <APPLICATIONPATH>
for non VeriCentre standard applications including web
pages.
MAINMENU > NAME Name of the tab.
MENU ITEM > NAME Name of the tab item.
MENU ITEM > IMAGE Optional. Path of the icon image on local machine, to be
displayed next to the item in the tab. If it is not specified, icon
image of the application configured is displayed.
ID > VALUE A unique ID for the tab item.
APPLICATIONPATH > Path of the executable on local machine for Windows
PATH applications or URL for the Web applications.
APPLICATIONPATH > Allows single or multiple instances to be invoked from VTMS.
SINGLETON
MENU ITEM > Description of the item that appears in the UI.
DESCRIPTION
OTHERCONFIGINFO > Optional. Defines placement of the tab strip in the UI as TOP,
TABSTRIPPLACEMENT BOTTOM, LEFT or RIGHT.
OTHERCONFIGINFO > Optional. Maximum number of items that can be displayed in
MAXFAVORITESITEM Recently Used tab.
NOTE It is recommended not to specify the name of any tab as ‘Recently Used’ as there
is already VTMS generated ‘Recently Used’ tab which holds the list of recently
used applications. You can sort the tabs as desired, by changing the order in the
It
Modify a Tab
You can modify the details of a tab by changing the attribute values of the
corresponding MAINMENU node
Remove a Tab
To remove a tab/item from the UI, delete the corresponding <MAINMENU> tag in
the XML file.
NOTE Attributes ‘Name’ and tag ‘ID’ are mandatory for VeriCentre applications. Other
attributes are optional. You can sort the items as desired by changing the order of
the corresponding <MENUITEM> tag in the XML file. An item can be placed inside
any tab as desired by placing the corresponding <MENUITEM> tag in the
corresponding <MAINMENU> tag.
The list of standard VeriCentre IDs and their associated applications are given as
follows:
Table 19 VeriCentre Applications and Associated IDs
Application IDs
About VeriCentre ID_ABOUT_VERICENTRE
Build a Query ID_BUILD_QUERY
Change Password ID_CHANGE_PASSWORD
Communication Settings ID_COMMUNICATION_OPTIONS
Communication Port Trace ID_COMMUNICATION_PORTTRACE
Composer ID_COMPOSER
Data Check Utility ID_DATACHECK_UTILITY
Diagnose Action Configuration ID_DIAGNOSE_ACTION_CONFIGURATION
Direct Download ID_DIRECT_DOWNLOAD
Download Automation Server ID_DA_SERVER_MANAGER
Manager
Download Monitor ID_DOWNLOAD_MONITOR
Execute a Query ID_EXECUTE_QUERY
Contents ID_CONTENTS
Index ID_INDEX
Search ID_SEARCH
Import ID_IMPORT
License Info ID_LICENSE_INFO
NOTE
‘NAME’ attribute and ‘APPLICATIONPATH’ attributes are mandatory for plug-in
applications. Image attribute is optional.
NOTE ‘NAME’ attribute and ‘APPLICATIONPATH’ attributes are mandatory for plug-in
applications. Image attribute is optional. The URL that is specified in the
‘APPLICATIONPATH’ must be a fully qualified name.
(
(Example: http://www.yahoo.com)
Modify an Item
You can modify the details of a tab by changing the attribute values for the
corresponding <MENUITEM> node.
Remove an Item
To remove an item from the configuration, delete the corresponding <MENUITEM>
tag in the XML file completely.
Specify the The character that should be used as the access key in the ‘NAME’ attribute for
Access Keys for the tab/item should be specified with an underscore. For example, the name ‘My
Tabs/Items Ta_b’ will have 'b' as the access key.
If your ‘NAME’ attribute value has multiple underscore characters, only the first
one will be considered as an access key; Other underscores appear as normal
text.
If the underscore that should be converted as access key is not the first
underscore, use two consecutive underscores for any underscores that precede
the one that you want to convert. For example, giving the value of ‘NAME’
attribute as ‘My__Access__Ke_y’ makes it as equivalent to ‘My_Access_Key’
where 'y' is the access key.
NOTE
If there are duplicates of access key visible in the UI at a given time, the access
key will not work.
Invoking Single or To make a plugged-in Windows application invokable only as single instance at a
Multiple Instances given point of time, specify the value of 'Singleton' attribute in the
of Application APPLICATIONPATH tag as 'True' or 'Yes'. To allow multiple instances, specify the
from VTMS values as 'False' or 'No'.
NOTE
‘Singleton’ attribute is applicable only for non VeriCentre Window’s applications.
Configuring the You can configure the tab strip placement and the maximum number of items in
Tab Strip Recently Used tab by using the <OTHERCONFIGINFO> tag in the XML file as the
Placement and the child tag of <MENULIST> root tag.
Maximum Number
The attribute associated with the tab strip placement is ‘TABSTRIPPLACEMENT’.
of Items in
Recently Used Tab It can contain one of the following values:
• TOP
• BOTTOM
• LEFT or
• RIGHT
Default is BOTTOM.
The attribute associated with the maximum number of items in the Recently Used
tab is ‘MAXFAVORITESITEM’. It can take a value between 1 and 10. The
maximum number of items is restricted to 10.
Import/Export Individual XML files will be used for each logical unit of data, but the files can also
File Formats be combined into a single file for a one shot import. The file has mandatory and
optional elements. Sample XML files are given below:
Attribute Description
Model Tag Element This represents a model and its corresponding data.
Name The name of the model.
ModelID The model ID/request packet ID of the model.
Description The description for the model.
Protocol The protocol used by the model.
DirDldBaudRate The baud rate to use for direct download.
DirDldMaxDataPktSz The maximum data packet size to use when doing
direct downloads.
Attribute Description
ParamDataType The datatype of the parameters for this model.
ParamMaxLength The maximum length allowed for parameter.
PreDldOption The PreDldOption attribute is an optional attribute
and it is applicable only for Verix protocol. If the
PreDldOption attribute is not present for a terminal
model that uses Verix protocol, then a default value
of 7 will be assumed.
NOTE • Default values for some of the Application attributes are given below:
• EnableAppDld - If not present, then a default value of "Yes" will be
assumed.
• EnableParamDld - If not present, then a default value of "Yes" will be
assumed.
• DefaultTermID - If not present, then NO default value is to be assumed
and the corresponding database column will be NULL.
• EnableDiffDld - If not present, then a default value of "No" will be
assumed.
• EnableDA - If not present, then a default value of "No" will be assumed.
• EnableExclusiveDld - If not present, then a default value of "No" will
be assumed.
• TermFileFolder - If not present, then the value of Appfolder will be
used.
• The Application XML file can optionally contain the template terminals for the
given application. The template terminals can be defined in line in the
application XML file using the "Template" element as shown in the above
sample application XML file.
<Terminals> The <Terminals> tag element gives the details about a group
of terminals that needs to be imported.
<Terminal> The <Terminal> tag element gives the details about the
terminal like termid, model to which they belong, serial
number, group of application it has, etc.
<Application> The <Application> tag element gives the details of the
application that is with in this terminal.
<Group> The <Group> tag element gives the information about the
GID to which the parameters below it belong. Specify GID=””
for Non-Verix terminals.
<Parameter> The <Parameter> tag element gives the information about the
parameter like name value, etc.
<TermFiles> The <TermFiles> tag element gives details about the terminal
specific files that need to be downloaded.
<Drive> The <Drive> tag element gives the details of the files in that
drive for the particular terminal. Specify Type=”” for Non-Verix
terminals.
<FileGroup> The <FileGroup> tag element gives the information about the
files related to that terminal and the GID to which they belong.
Specify GID=”” for Non-Verix terminals.
NOTE • If the DldType attribute is not present for a parameter or for a directive, then a
default value of "FP" will be assumed.
• If the ClusterID attribute is not present for a terminal, then a default value of
"DEFAULT" will be assumed.
• If the NameOnTerminal attribute is not present, then the value of FileName
will be used.
• If ParamType is not present, then it is assumed to be D for Dial, Password,
Key, Rem, Clock and Flash parameters, and for other parameters it is
assumed to be P.
Form View When a Form view XML file exists for the selected terminal/application, then the
Form View screen is constructed based on the XML file. These XML files need to
be imported using Model app manager Application properties dialog. The Form
View is built at runtime based on an XML file. This file is used to define the tabs
and the contents of each tab. This section describes the XML file in detail.
Application The main section of the file is the <Application> element. It is described below.
Element
<Application ID="UEGA251" Description="SoftPay Global-East
Application"
Version="2.51">
<Tab . . .>
.
.
.
</Tab>
</Application>
This tag has one element, <Tab> described in the next section. The chart below
describes the attributes of the Application Element.
Attribute Description
ID The application ID.
Description Description of the application.
Version Application version.
Tab Element The Application Element contains a collection of Tab Elements. The Tab Element
is in the format:
<Tab ID="tabMerchant" Caption="Merchant"
Desc="Configure Merchant IDs and Settings">
<ControlGroup>
.
.
.
</ControlGroup>
</Tab>
The Tab tag has one element - a collection of one or more ControlGroups. This
element is described in the next section. The attributes of the Tab Element are
described in the chart below.
74 VERICENTRE TECHNICAL REFERENCE MANUAL
F ILE F ORMATS
Form View
Attribute Description
ID The tab ID.
Caption Caption displayed for the Tab on the Form View screen.
Desc Description of the tab.
ControlGroup The ControlGroup Element contains one or more Control Elements. This is just a
Element Logical grouping of controls. These elements are used to define the controls that
are displayed on the containing tab in the Form view. The Control Element is
described in the next section. The ControlGroup Element has no attributes. The
format for the ControlGroup Element is:
<ControlGroup>
<Control. . ./>
. . .
<Control. . ./>
</ControlGroup>
Control Element The Control Element is used to define each control displayed on the Form View.
Each Tab Element contains a collection of ControlGroup Elements, which in turn,
contain a collection of Control Elements. As tabs are clicked in the Form View, the
Controls contained in that tab are displayed. The format of the Control Element is:
<Control ID="lblHostIDs" Type="Label">
.
.
.
</Control>
This element has two attributes described below. The elements of the tag depend
upon the Control Type attribute. Each of these is describe in the following sections
of this document.
Attribute Description
ID The control ID; used internally by Form view to identify the
control.
Type The control Type. Currently, the following types are
supported in Form view. More details are provided in the
following section for each control type:
• Label
• TextBox
• CheckBox
• ComboBox
• DataGrid
The two attributes for the Label Element are as described for control element. The
tag's elements are described as below:
Tag Description
Caption The text to be displayed.
Width, Height, Top, Positioning elements used to display the control on the Form
Left View. (Is not used for windows form view)
Enabled, Visible Determines whether the control should be enabled / visible on
the Form View. This element can have the value of True, False,
or a business rule that will evaluate to True or False.
Bold, Italic, Determines the display characteristics of the control - can have
Underline the value of True or False.
RowIndex Tag is used mention the row to which the control belongs in a
table. If this tag exists the value in this tag will be used, if that tag
doesn't exist then the index will be created programmatically as
per the sequence in which the controls appear in the XML. An
XML can either have all its controls with a row index or no
controls with a row index. But it can't be a mix of both. If it is a
mix of both, then the controls will be placed in the order in which
they appear in the XML.
The two attributes of the TextBox Element are as described for control element.
The tag's elements are below.
Tag Description
Caption This caption is displayed in a Label Control next to the TextBox
Control.
CaptionLeft This is not currently used in the Windows Form View. It is used
by web console form view.
DataField The field or parameter from the VeriCentre database
PARAMETER table used to populate the control.
ToolTip The tooltip displayed when the cursor hovers over the control.
Width, Height, Top, Positioning elements used to display the control on the Form
Left View. This is not currently used as such in the Windows Form
View. It is used by web console form view.
Enabled, Visible Determines whether the control should be enabled / visible on
the Form View. This element can have the value of True, False,
or a business rule that will evaluate to True or False.
Bold, Italic, Determines the display characteristics of the control - can have
Underline the value of True or False.
MaxLength The maximum number of characters that can be entered in the
TextBox.
RegExp A regular expression used to validate the TextBox contents.
Regular expressions are described later in this document.
ErrorMessage The message displayed when the regular expression validation
fails.
RowIndex Tag is used mention the row to which the control belongs in a
table. If this tag exists the value in this tag will be used, if that tag
doesn't exist then the index will be created programmatically as
per the sequence in which the controls appear in the XML. An
XML can either have all its controls with a row index or no
controls with a row index. But it can't be a mix of both. If it is a
mix of both, then the controls will be placed in the order in which
they appear in the XML.
</BusinessRule>
<ToolTip>
Select whether or not this terminal should settle
automatically
at the Settle Time entered
</ToolTip>
<Width>200</Width>
<Height>19</Height>
<Top>30</Top>
<Left>25</Left>
<Enabled>true</Enabled>
<Visible>true</Visible>
<Bold>false</Bold>
<Italic>false</Italic>
<Underline> false</ Underline>
<Checked>1</Checked>
<Unchecked>0</Unchecked>
</Control>
The two attributes of the CheckBox Element are as described for the control
element. The tag's elements are described below:
Tag Description
Caption This caption is used for the CheckBox label.
DataField The field or parameter from the VeriCentre database
PARAMETER table used to populate the control.
BusinessRule A business rule used to modify properties of other controls
based on the value of the CheckBox Control. Business rules are
described in a later section of this document.
ToolTip The tooltip displayed when the cursor hovers over the control.
Width, Height,Top, Positioning elements used to display the control on the Form
Left View. This is not currently used as such in the Windows Form
View. It is used by web console form view.
Enabled, Visible Determines whether the control should be enabled / visible on
the Form View. This element can have the value of True, False,
or a business rule that will evaluate to True or False.
Bold, Italic, Determines the display characteristics of the control - can have
Underline the value of True or False.
Checked The value stored in the VeriCentre Database PARAMETER
Table if the CheckBox is checked. It is also used to set the
checked state of the control when it is displayed.
Unchecked The value stored in the VeriCentre Database PARAMETER
Table if the CheckBox is not checked. It is also used to set the
checked state of the control when it is displayed.
RowIndex Tag is used mention the row to which the control belongs in a
table. If this tag exists the value in this tag will be used, if that tag
does not exist then the index will be created programmatically as
per the sequence in which the controls appear in the XML. An
XML can either have all its controls with a row index or no
controls with a row index. But it cannot be a mix of both. If it is a
mix of both, then the controls will be placed in the order in which
they appear in the XML.
<Left>100</Left>
<Enabled>true</Enabled>
<Visible>true</Visible>
<Bold>false</Bold>
<Italic>false</Italic>
<Underline> false </ Underline>
<Item Caption="None" Value="0" />
<Item Caption="AMEX PIP" Value="1" />
<Item Caption="AMEX SPLIT" Value="2" />
</Control>
The two attributes of the DropDown Element are as described for the control
element. The tag's elements are described as below:
DropDown Control Element Attributes
Tag Description
Caption This caption is displayed in a Label Control next to the
DropDown Control.
CaptionLeft The CaptionLeft Element describes the left position of the Label
Control placement. This is not currently used as such in the
Windows Form View. It is used by web console form view.
DataField The field or parameter from the VeriCentre database
PARAMETER table used to populate the control.
BusinessRule A business rule used to modify properties of other controls
based on the value of the DropDown Control Business rules are
described in a later section of this document.
ToolTip The tooltip displayed when the cursor hovers over the control.
Width, Height, Top, Positioning elements used to display the control on the Form
Left View. This is not currently used as such in the Windows Form
View. It is used by web console form view.
Enabled, Visible Determines whether the control should be enabled / visible on
the Form View. This element can have the value of True, False,
or a business rule that will evaluate to True or False.
Bold, Italic, Determines the display characteristics of the label control next to
Underline the DropDown can have the value of True or False.
Tag Description
Item (Collection) Each DropDown Control has a collection of Item Elements.
These elements are used to determine the contents of the
DropDown. Each Item Element has two attributes:
The Caption Attribute defines the text to display for this item in
the DropDownList. The Value Attribute defines the value to store
in the VeriCentre Database PARAMETER Table when the item is
selected. It is also used to determine which item is selected
when the control is displayed.
RowIndex Tag is used mention the row to which the control belongs in a
table. If this tag exists the value in this tag will be used, if that tag
doesn't exist then the index will be created programmatically as
per the sequence in which the controls appear in the XML. An
XML can either have all its controls with a row index or no
controls with a row index. But it can't be a mix of both. If it is a
mix of both, then the controls will be placed in the order in which
they appear in the XML.
DataGrid Control The DataGrid Control Element is used to define a DataGrid on the FormView. An
Element example of the DataGrid Control Element format is:
<Control ID="dgCDT" Type="DataGrid">
<Width>730</Width>
<Height>320</Height>
<Top>10</Top>
<Left>0</Left>
<VisibleRows>{CDT~:1}!=12&&{CDT~:1}!=13</VisibleRows>
<Columns>
.
.
.
</Columns>
</Control>
The two attributes of the DataGrid Element are as described for the control
element. The elements are described below.
Tag Description
Width, Height, Top, Positioning elements used to display the control on the Form
Left View. This is not currently used as such in the Windows Form
View. It is used by web console form view.
VisibleRows The VisibleRows Element is a Business Rule that defines the
characteristics of the rows that will be displayed in the DataGrid
Control. The format of this element is described in the Business
Rules section later in this document. This is not currently used as
such in the Windows Form View. It is used by web console form
view.
Columns The Columns Element is a collection of Column Elements. The
Column Elements are used to define the DataGrid Columns.
They are detailed in the next sections.
RowIndex Tag is used mention the row to which the control belongs in a
table. If this tag exists the value in this tag will be used, if that tag
doesn't exist then the index will be created programmatically as
per the sequence in which the controls appear in the XML. An
XML can either have all its controls with a row index or no
controls with a row index. But it can't be a mix of both. If it is a
mix of both, then the controls will be placed in the order in which
they appear in the XML.
Attribute Description
ID The column ID; used internally by Form view to identify the
column.
Type The column type. Currently, the following types are supported in
Form view. More details are provided in the following section for
each column type:
• TextBox
• CheckBox
• DropDownList
DataGrid Control - The TextBox Column within the DataGrid Control utilizes the same attributes as
TextBox Column the TextBox Control described earlier in this section. An example of this column
Element type is shown below:
<Column ID="txtLabel" Type="TextBox">
<Caption>Label</Caption>
<DataField>CDT~:18</DataField>
<Enabled>true</Enabled>
<Width>120</Width>
<MaxLength>6</MaxLength>
</Column>
DataGrid Control - The CheckBox Column within the DataGrid Control utilizes the same attributes as
CheckBox Column the CheckBox Control described earlier in this section. An example of this column
Element type is shown below:
<Column ID="chkSelected" Type="CheckBox">
<Caption>Selected</Caption>
<DataField>CDT~:5</DataField>
<Enabled>true</Enabled>
<Width>50</Width>
</Column>
DataGrid Control - The DropDown Column within the DataGrid Control utilizes the same attributes as
DropDown the DropDown Control described earlier in this section with one exception. The
Column Element Item attribute in the main DropDown element is replaced by the DGItem attribute
within this element. An example of this column type is shown below:
<Column ID="ddlCardHost" Type="DropDown">
<Caption>Host</Caption>
<DataField>CDT~:3</DataField>
<Enabled>{CDT~:10}==1||{CDT~:10}==2</Enabled>
<Width>80</Width>
<DGItem Caption="FDR" Value="0" />
<DGItem Caption="Amex Split" Value="1" />
<DGItem Caption="Amex PIP" Value="2" />
</Column>
Example <BusinessRule>
[me.checked]==true && [cbManualSettle.value]>0 ?
[cbManualSettle.enabled]=true;
[txtbatchhistory.enabled]=true;
[txtbatchhistory.enabled]=true :
[cbManualSettle.enabled]=false;
[txtbatchhistory.enabled]=false
</BusinessRule>
Multi-Merchant The Multi-Merchant XML File is used to facilitate the maintenance of multi-
XML File merchant records for a given terminal application. This XML file must be imported
for the selected application to be able to configure multi merchant information in
form view.
The format of the file is very similar to the Form View XML File with the exception
of additional information at the head of the file that identifies multi-merchant
specific information. The illustration in Figure shows the additional header
information.
Attribute Description
Limit Maximum number of merchants.
MerchantID The unique ID of the merchant.
MerchantName The name of the merchant.
Attribute Description
ID The unique ID of the host.
Config The configuration name.
Name The name of the host.
Attribute Description
DataField The field or parameter from the VeriCentre database
PARAMETER table used to populate the control. The '~'
symbol will be replaced with the merchant ID.
Value The default value for that datafield.
The remainder of the XML File follows the same layout and structure as the XML
Form File described for the XML Form View in this document.
Card Range XML The Card Range XML File is used to facilitate the maintenance of Card (CDT)
File Table records for a given terminal application. This XML file must be imported for
the selected application to be able to configure card ranges information in form
view. The format of the file is very similar to the Form View XML File with the
exception of additional information at the head of the file that identifies card table
specific information. The illustration in figure shows the additional header
information.
Attribute Description
CardName The name of the card.
ParameterPrefix The prefix that needs to be added while mapping to the
corresponding parameter in VeriCentre database
PARAMETER table.
Attribute Description
DataField The field or parameter from the VeriCentre database
PARAMETER table used to populate the control. The '~'
symbol will be replaced with the merchant ID.
Value The default value for that datafield.
The remainder of the XML File follows the same layout and structure as the XML
Form File described for the XML Form View in this document.
Structure of VFILicense.dat file describes the license available for a given VeriCentre
License File setup. The file is available only on VeriCentre Primary Server machine.
It contains data regarding:
• The name and Disk serial number of the VeriCentre Primary Server.
• Counted and Uncounted features available for a given VeriCentre setup.
Structure of VFILicense.dat file is described below:
DISK_SERIAL_NUM=<Disk serial number of local machine>
Format
FEATURE <Name of the feature> VFI01 <Product version> <Type of License =
permanent/demo> <Number of licenses available>
Format
FEATURE <Name of the feature> VFI01 <Product version> <Type of License =
permanent/demo> uncounted HOSTID=ANY
This section explains XML structure and tags in detail. Optional part are enclosed
with the [].
Table 21 Details of the Report SQL and Filter XML Structure
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
<SQLQuery> Root node of the XML.
<SELECT> Specify the columns to be displayed in the report (fields and respective
tables), their display names and any specific data formatting required.
<Column/> This tag can be repeated as many fields to be selected. Column field tag
consists of the following attributes:
Column Tag Attributes:
• TableName - Table name from which the field has to be selected.
• Field - Field name that has to be selected.
• DisplayName - Column heading to be displayed for the selected field.
• [SelectReplace] - It is an optional attribute which can be specified to
use any valid select field statement. This should be used for selecting
the field. The display name and selected field column heading has to be
same.
Examples:
• <Column TableName="AUTODLD_SCHEDULERLOG"
Field="FAMNM" DisplayName="Model Name" />
• <Column TableName="AUTODLD_SCHEDULERLOG"
Field="LOGDATETIME" DisplayName="Check Update Date
Time" SelectReplace =
"To_DATE("AUTODLD_SCHEDULERLOG"."LOGD
ATETIME",'yyyy-mm-dd hh24:mi:ss') "Check
Update Date Time"" />
• <Column TableName="AUTODLD_SCHEDULERLOG"
Field="SCHEDULEDATETIME" DisplayName="Schedule"
SelectReplace=" (Case when
(("AUTODLD_SCHEDULERLOG"."SCHEDULEDAT
ETIME" IS NULL) and
("AUTODLD_SCHEDULERLOG"."VC_DLDMEDIA&
quot; IS NOT NULL)) then 'Call back Immediate' else
TO_CHAR("AUTODLD_SCHEDULERLOG"."SCHED
ULEDATETIME",'yyyy-mm-dd hh24:mi:ss') end)
"Schedule""/>
• <Column TableName = "TERMLOG" Field = "STATUS"
DisplayName = "Status" SelectReplace =" " Status
" = (Case "TERMLOG"."STATUS"
when 'S' then 'Successful' when 'U' then 'Failed'
else 'Aborted' end) " />
</SELECT> Select field’s end tag.
<FROM> This tag is to specify the table names from which fields are to be selected.
This tag does not contain attributes.
Table 21 Details of the Report SQL and Filter XML Structure (continued)
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
Examples:
• <FROM>RELATION, TERMINFO, TERMINFOVFIREL</FROM>
• <FROM>VIDDETAIL LEFT OUTER JOIN TERMLOG ON
VIDDETAIL.FAMNM = TERMLOG.FAMNM AND VIDDETAIL.APPNM =
TERMLOG.APPNM AND VIDDETAIL.TERMID = TERMLOG.TERMID
AND TERMLOG.JOBNAME IS NULL AND TERMLOG.EVDATE >
VIDDETAIL.DLENDDATETIME</FROM>
</FROM> From field’s end tag.
[<WHERE> This is an optional tag to specify the condition for the field that is to be
selected. It does not contain the attributes.
Example:
<WHERE> CLUSTERINFO.CLUSTERID =
TERMINFOVFIREL.CLUSTERID AND
TERMINFOVFIREL.MODELNAME = VIDDETAIL.FAMNM AND
TERMINFOVFIREL.APPNM = VIDDETAIL.APPNM AND
TERMINFOVFIREL.TERMID = VIDDETAIL.TERMID AND
VIDDETAIL.JOBNAME = VIDJOB.JOBNAME </WHERE>
</WHERE>] Where field’s end tag.
[<WHEREFILTER> Optional tag to display the filter controls.
<Control> This tag is used to specify the type of control tag for the filters to display. It
can be repeated as many filter controls required with child tags and
attributes.
Control Tag Attributes:
• ControlType - Type of control to be displayed. It has to be one of the
following:
VCCombo Box: Drop down control.
VCListBox: List box control.
VCTextBox: Text box control.
VCDateTimePicker: Date time control. It contains both date and
time.
VCDatePicker: Date control.
VCCheckBox: Check box control.
• Control ID - ID for the control.
• Title - The control name to be displayed. It should be used for the
label text.
• Mandatory - Mandatory factor to apply the filter values. It has to be
either 'Yes' or 'No'.
Table 21 Details of the Report SQL and Filter XML Structure (continued)
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
Examples:
• <Control ControlType="VCDateTimePicker"
ControlId="dtStart" Title="Start Date Time" Mandatory
="No">
• <Control ControlType="VCListBox"
ControlId="cbApplication" Title="Application Name"
Mandatory ="Yes">
[<ValueInfo/>] Optional tag. Contains the value information to be displayed in the
controls. It can be comma separated enumerated values, or SQL query, or
SQL query based on the previous control.
ValueInfo Tag Attributes:
• Type - Type of the value. It has to be either ‘Enum’ or ‘Sql’.
Enum: For enumerated values. It can be comma separated string to
display multiple values in VCComboBox or VCListBox.
Sql: Execute the SQL query to be displayed the values in the
control.
• Value - Attribute consists of the values to be display in the control. It
can be empty/single value/comma separated values/SQL query with or
without binding parameters.
• Dependency - Used to specify the value depending on the parent
control value. It can be either ‘Yes’ or ‘No’.
• [ValueOfParent ControlIdsForBinding] - Optional tag. If
Dependency is ‘Yes’, need to specify this. It is used to bind the parent
control values to the SQL statements to display the values. This control
ID should be specified in the child control tag of the parent control. If the
value depends on more than one control, the comma separated control
IDs should to be specified. Number of parameters and the number of
comma separated control IDs has to be the same.
Examples:
• <ValueInfo Type="Enum" Value="Success,No
Updates,Failures" Dependency="No" />
• <ValueInfo Type ="Sql" Value = " SELECT DISTINCT
FAMNM FROM FAMILY " Dependency ="No"/>
Table 21 Details of the Report SQL and Filter XML Structure (continued)
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
• <ValueInfo Type ="Sql" Value = "SELECT
PORTFOLIO.PORTFOLIONAME FROM
PORTFOLIO,PORTFOLIO_USERS WHERE PORTFOLIO.STATUS =
'ENABLED' AND PORTFOLIO.PORTFOLIOID =
PORTFOLIO_USERS.PORTFOLIOID AND
PORTFOLIO_USERS.USERID = (SELECT USERID FROM
CORE_USER WHERE UPPER(USERNAME) =
UPPER('$VC_LOGGEDIN_USERNAME$'))UNION SELECT
PORTFOLIO.PORTFOLIONAME FROM
PORTFOLIO,PORTFOLIO_GROUPS WHERE PORTFOLIO.STATUS =
'ENABLED' AND PORTFOLIO.PORTFOLIOID =
PORTFOLIO_GROUPS.PORTFOLIOID AND
PORTFOLIO_GROUPS.GROUPID IN (SELECT GROUPID FROM
CORE_GROUP_USERS WHERE USERID = (SELECT USERID FROM
CORE_USER WHERE UPPER(USERNAME)
=UPPER('$VC_LOGGEDIN_USERNAME$')))" Dependency
="No"/>
• <ValueInfo Type ="Sql" Value = " SELECT DISTINCT
APPNM FROM APPLICATION WHERE FAMNM = {0}" Dependency
="Yes" ValueOfParentControlIdsForBinding ="cbFamily"
/>
• <ValueInfo Type ="Sql" Value = " SELECT TERMID FROM
TERMINFOVFIREL,CLUSTERINFO WHERE
TERMINFOVFIREL.MODELNAME = {0} AND
TERMINFOVFIREL.APPNM = {1} and
TERMINFOVFIREL.CLUSTERID = CLUSTERINFO.CLUSTERID AND
CLUSTERINFO.CLUSTERNM = {2} " Dependency ="Yes"
ValueOfParentControlIdsForBinding
="cbModel,cbApplication,cbCluster" />
[<ColumnToAssociate/>] Optional tag to specify to which field name has to be compared with the
value of the control. The tag need not be specified if you do not want the
value to be compared.
ColumnToAssociate Tag Attributes:
• TableName - Table name of the field to compare.
• Field - Field name to compare the value.
• DataBaseFieldType - Database field type. It can be one of the
following:
ALPHA_NUMERIC: For non-numeric and non-date time data
types.
DATETIME: For date time field type.
DECIMAL: For numeric data type.
INT: For integer data type.
Table 21 Details of the Report SQL and Filter XML Structure (continued)
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
• Operator - Operator used to compare the value. It can be any
operator valid in SQL. Need to follow the XML escape character.
• [ValueToCompare] - Optional attribute to specify what to
compare. If same control value need to be used for this comparison,
ignore this attribute. If the value is to compare, then have different
values to specify this. It can be either ‘Condition’ or ‘Sql’.
• If ‘Condition’ is specified, include
ColumnToAssociateConditionValues tag with its child tag
and attributes.
• If ‘Sql’ is specified, include SqlValueToCompare tag with its
attributes.
Examples:
• <ColumnToAssociate TableName = "TERMINFOVFIREL" Field
= "TERMID" DataBaseFieldType ="ALPHA_NUMERIC"
Operator ="=" />
• <ColumnToAssociate TableName="AUTODLD_SCHEDULERLOG"
Field="LOGDATETIME" DataBaseFieldType="DATE_TIME"
Operator=">=" />
• <ColumnToAssociate TableName="AUTODLD_SCHEDULERLOG"
Field="Status" DataBaseFieldType="ALPHA_NUMERIC"
Operator="=" ValueToCompare ="Condition"/>
• <ColumnToAssociate TableName="TERMINFOVFIREL"
Field="UTID" DataBaseFieldType="ALPHA_NUMERIC"
Operator="=" ValueToCompare ="Sql"/>
[<ColumnToAssociateConditionVal Child tag
ues />] • <ConditionValue/> - Tag to specify the different condition based on
the filter control values. This tag can be repeated as many times as the
different values need to be compared. If ValueToCompare is condition
then this tag need to be specified.
ConditionValue Attributes
• Value - Value of the filter control selected.
• SelectCondition - The condition should be part of the where
clause, if the value is provided in the filter control.
Table 21 Details of the Report SQL and Filter XML Structure (continued)
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
Examples:
<ColumnToAssociateConditionValues>
<ConditionValue Value="Success"
SelectCondition="{AUTODLD_SCHEDULERLOG.STATUS} =
'Success'"/>
<ConditionValue Value="No Updates"
SelectCondition="{AUTODLD_SCHEDULERLOG.STATUS} =
'510-NO UPDATES AVLBL'"/>
<ConditionValue Value="Failures"
SelectCondition="{AUTODLD_SCHEDULERLOG.STATUS}
<> 'Success' and
{AUTODLD_SCHEDULERLOG.STATUS} <> '510-NO
UPDATES AVLBL'"/>
</ColumnToAssociateConditionValues>
[<SQLValueToCompare/>] Tag to specify the SQL, filter control values and the database filed type to
compare. There should be only one tag of this type for each control. If
ValueToCompare is Sql, then this tag should be specified.
SqlValueToCompare Attributes:
• Sql - To specify the parameterized SQL query.
• ControlIdsForBinding - The comma separated filter control IDs
for binding with the SQL query.
• DataBaseFieldTypeToCompare - Database field type. It can be
one of the following:
ALPHA_NUMERIC - For non-numeric and non-date time data
types.
DATETIME - For date time field type.
DECIMAL - For numeric data type.
INT - For integer data type.
Examples:
<SqlValueToCompare Sql ="SELECT CORE_USER.USERID FROM
CORE_USER,TERMNOTES WHERE
CORE_USER.USERID=TERMNOTES.MODIFIEDBY AND
CORE_USER.USERNAME = {0}" ControlIdsForBinding =
"cbModifiedBy" DataBaseFieldTypeToCompare= "INT"/>
<ChildControl/> Tag to specify the child control, if any. The Control value should be
bounded with the control. It is used to set the child control values based on
the control value. If this control ID is a part of the parent control, IDs
binding than this should be specified with the child control ID.
ChildControl Attributes:
ControlId - Child control ID which is used for linking.
Examples:
<ChildControl ControlId="cbModel" />
Table 21 Details of the Report SQL and Filter XML Structure (continued)
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
</Control> Control field’s end tag.
</WHEREFILTER>] Wherefilter field’s end tag.
[<ADDITIONALCONDITIONS> Optional tag to add additional conditions to the where conditions.
<CONDITIONS/> This tag can be repeated as many conditions should be added. Conditions
field tag consists of the following attributes.
Conditions Attributes:
• Type - Type of the value. It has to be either ‘Enum’ or "Sql".
Enum - For enumerated values.
Sql - Execute the SQL query to add the condition.
• ColumnToAssociate - To specify with which field name, the value has
to be compared.
• Value - The value to be compared; It can be enumerated value if it is
Enum type and SQL query if the type is Sql.
• ControlIdsForBinding - The comma separated filter control IDs
for binding with the SQL query. If the Type is ‘Enum’, provide a empty
string with double quotes.
• DataBaseFieldTypeToCompare - Data base field type. It can be
one of the following values:
ALPHA_NUMERIC - For non-numeric and non date time data
types.
DATETIME - For date time field type.
DECIMAL - For numeric data type.
INT - For integer data type.
• Operator - Operator used to compare the value. It can be any
operator valid in SQL. Should follow the XML escape character.
Examples:
<ADDITIONALCONDITIONS>
<CONDITIONS Type="Enum"
ColumnToAssociate="{SRD_MECOLLECTION.MESETTYPE}"
Value ="W" ControlIdsForBinding=""
DataBaseFieldTypeToCompare="ALPHA_NUMERIC" Operator
="=" />
<CONDITIONS Type="Sql" ColumnToAssociate
="{SRD_MEDATA.UTID}" Value =" SELECT UTID FROM
TERMINFOVFIREL WHERE TERMINFOVFIREL.MODELNAME = {0}
AND TERMINFOVFIREL.APPNM = {1} and
TERMINFOVFIREL.TERMID = {2} "
ControlIdsForBinding="cbModel,cbApplication,cbTerm
Id" DataBaseFieldTypeToCompare= "INT" Operator
="="/>
</ADDITIONALCONDITIONS>
</ADDITIONALCONDITIONS>] Additionalcondition field’s end tag.
Table 21 Details of the Report SQL and Filter XML Structure (continued)
Report SQL and Filter XML
Description
Structure (Nodes/Attributes)
[<ORDERBY> Optional tag to specify the sorting order.
<ColumnToOrderBy/> This tag can be repeated as many columns as to be sorted.
ColumnToOrderBy tag consists of the following attributes:
ColumnToOrderBy Attributes
• TableName - Table name from which the field has to be sorted.
• Field - Field name to be sorted.
• SortingType - The sorting type used for the field. It has to be either
‘ASC’ or ‘DESC’.
ASC - Ascending order.
DESC - Descending order.
Examples:
• <ColumnToOrderBy TableName="SRD_MEDATA"
Field="DATECOLLECTED" SortingType="ASC" />
• <ColumnToOrderBy TableName="SRD_MEDATA"
Field="INSTANCE" SortingType="DESC" />
</ORDERBY>] Orderby field’s end tag.
</SQLQUERY>
Note: $VC_LOGGEDIN_USERNAME$ can be used to substitute the logged in user name.
Sample Report
XML for Download
Log
Example
ZONTALK File Following are ZONTALK file formats used by VeriCentre 3.0 and earlier versions
Formats to import model, application and terminal data:
• Terminal.tdd
• <application name>.dld
• <application name>.tdf
• <export>.exp
Terminal.tdd This file is used to locate the download files for each application and the type of
terminal in which the application is used. Typically, each line in this file has the
following format:
<modelname> <application name> <workdir> <securitytype>
where,
<modelname> Identifies the terminal type, such as, JRPLUS, Tranz and
Omni 390.
<application name> The name of the application for that particular model.
<workdir> Includes the full path and file names where the application files
are stored.
<securitytype> This optional field indicates the security level of the
application. The security level can be:
• SECURE0 - No Security
• SECURE1 - Security Level 1
• SECURE2 - Security Level 2
• SECURE3 - Security Level 3
If no security level is specified, SECURE0 is default.
<application This file specifies the files that belong to the application to download. Each line
name>.dld has one of the following formats:
<flag> <type> <file> <other>
or
key <keyvalue> <type> <file> <other>
where,
flag An optional field that specifies if this file should be downloaded on a Full
download (full), Partial download (partial) or both (full and partial). If omitted,
the default is full and partial.
key This allows selective download of files to terminals requesting this application.
The value of this field cannot exceed 10 characters in length. If a key value is
specified, this file is downloaded to the terminal only if that terminal has
defined a KEY directive corresponding to this key value.
type This field is mandatory. It indicates the type of the file. This field can have the
following values:
• 1 - for ZON files
• 2 - for UDL files
• 3 - for Data Capture files
• 4 - for Omni code files
• 5 - for Omni data files.
file This field is mandatory. It specifies the name of the file. While downloading this
application, VeriCentre searches for this name in the directory specified in the
terminal.tdd file.
other This field is optional for all models, except those that follow ZON behavior, and
specifies the name of the file in the terminal.
If omitted, the file name in the terminal is that specified in the <file> field.
Sample .dld A sample .dld file is presented in Table 24 and Table 25.
Table 24 Example .dld File #1
Flag File Type File name Other
2 PRIMARY.UDL Included always.
2 PRIMARY.UDL Included always.
F 2 FULL.UDL Included only for full.
P 2 UPDATE.UDL Included only for partial.
FP 2 CHANGES.UDL Included always.
FP 1 SECONDARY.ZON Included always.
<application This file is an ASCII text file describing the parameters for an application. This file
name>.tdf is usually supplied by the application programmer. Each parameter description
occurs on a different line. Each line has the following format:
<FS> <mem.loc> <FS> <fldtype> <FS> <prompt> <FS> <Default value> <FS>
where,
FS Field separator that does not occur in the prompt. Import treats the first
character of every line as the field separator and uses it to distinguish the
fields.
mem.loc Specifies the location of the parameter. Its value depends on the terminal
type. For e.g.,
ZON models expect 2 digit memory locations
TRANZ-330 expects 3 digits
TRANZ-380 expects 4 digits
Omni models use alpha numerals.
fldtype This is a combination of alphabetic and numeric codes that specify the
type of data, and the minimum and maximum number of characters that
may be entered in a field. Valid lengths range from 0 to 255. For example,
a field type of A17 indicates that field is of alphabetic type that can hold up
to 17 characters.
The data type codes used in the TDF file are:
• A (Alphabetic) - the letters A...Z, a...z, #, -, ., and space.
• N (Numeric) - the digits 0...9.
• X (Alphanumeric) - the letters A...Z, a...z, #, -, ., space and the digits
0...9.
• P (Phone) - the digits 0...9 and the letters A...Z, -, *, #, semicolon,
comma and space.
• Q (Question) - the letters Y and N.
• B (Binary) - the digits 0 and 1.
• I (IBM) - the complete IBM ASCII character set.
• S (Specific Characters) - limits input to specific characters. Although
specifying the minimum number of characters in the field type is
optional, this can help ensure the validity of the data entered into the
field. For example, if you have a field that can hold a vendor number of
maximum 4 characters, you can specify a field type of N4,1. This limits
the numeric data to at least 1 digit, and at most 4 digits.
prompt This is the prompt displayed in the Terminal Manager while the parameter
is being edited. The maximum permissible length is 250 characters.
Default value Specify the default value for the parameter. This value will be displayed
automatically when you add a parameter for a terminal in Terminal
Manager.
<export>.exp This file is generated by VeriCentre or ZONTALK’s export utility. It contains data
about the terminals.
This file is organized as a set of terminal records. Each terminal record is a
collection of key-data lines. Apart from terminal records, a set of directives global
to the terminal records are also present. Refer to the Directives section for more
information. The format of the file is as follows:
F <model>
A <application>
G <Cluster ID>
M <mod. date> <mod. time>
W <who>
• The M directive provides the last modified date and time.
• The W directive provides the name of the person who last modified the terminal
record.
• F and A specify the model and application to which these terminals belong.
• The G directive provides the cluster ID of the cluster to which a terminal
belongs. This directive is introduced for supporting the SoftPay assist file
import operations.
• The terminal definition blocks follow this block. These blocks start with a T
directive and end with an E directive.
X <Last partial download date and time>
Y <Last full download date and time>
T <Terminal ID>
R <Remark - Value of the REMARK directive>
U <Uses - Value of the USES directive>
F OMNI-480
A CESCON
G DEFAULT
M 1-02-96 12:06P
X 1-02-96 2:27:00P
Y 1-04-96 10:04:52A
T 1
R HELLO
U TERMINAL 1
K FP KEY 1
D F *GO “SP2000.OUT”
E 1
Extended .tdf
File Format
<application This file is an ASCII text file describing the parameters for an application. This file
name>.tdf is usually supplied by the application programmer. Each parameter description
occurs on a different line. Each line has the following format:
<FS> <mem.loc> <FS> <fldtype> <FS> <prompt> <FS> <Default value> <FS>
<Diagnosable> <FS>
where,
FS Field separator that does not occur in the prompt. Import treats the
first character of every line as the field separator, and uses it to
distinguish the fields.
mem.loc Specifies the location of the parameter. Its value depends on the
terminal type. For example,
ZON models expect 2 digit memory locations.
TRANZ-330 expects 3 digits.
TRANZ-380 expects 4 digits.
Omni models use alpha-numerals.
fldtype Specifies the type and length of the value expected for this
parameter. This information is used by the Terminal Manager.
prompt This is the prompt displayed in the Terminal Manager while the
parameter is being edited. The maximum permissible length is 250
characters.
Default value Specifies the default value for the parameter. This value will be
displayed automatically when you add a parameter for a terminal in
the Terminal Manager.
Diagnosable This allows diagnosis of an application parameter. You can enable
or disable an application parameter for diagnosis.
By default, application parameters cannot be diagnosed.
Upgrading License
TIP
When you upgrade your VeriCentre license, it is recommended that you restart all
the communication servers and VeriCentre clients.
3 Check the status of the VeriCentre server and stop all running servers by
clicking Start > Settings > Control Panel > Services > VeriCentre Server.
4 Stop the VeriCentre License Manager service on the VeriCentre Primary
server.
5 Launch the "Upgrade VeriCentre License" tool from the VeriCentre Primary
server by choosing the following: Start > Programs > VeriCentre > Upgrade
VeriCentre License.
6 Enter the company name and license key provided by your VeriFone
representative and click Upgrade.
7 Start the VeriCentre License Manager Service on the VeriCentre Primary
server machine.
8 Start all VeriCentre servers and clients.
NOTE • As a Windows System User, you must have sufficient rights to start and stop
the license service.
• To view the license details, login to VeriCentre main UI and select Help >
About menu. Click License info button. It displays the license details where
you can verify whether the license is upgraded.
How To
Validations for VeriCentre validates the MIs at the time of an MI import. These validations are
an MI Import performed at three levels:
• on MI set
• on MI category
• on MI
Table 26 Validations on MI Set
MI Attribute Validation
MI Setname Maximum 32 characters. The Setname should be unique.
GUID Must be unique. 38 characters long, in the registry form -
{xxxxxxx-xxxx...xxx}.
For e.g., {47785940-7132-11d5-B78C-
0060B0EBFAAD}
Request packet ID Should match with the request packet ID of the model.
The maximum length is 20.
Application Name This field is optional. It requires to be specified only for the
application MI set, and the name that is specified here
should match the application name specified in the
VeriCentre database. The maximum length is 10.
Description Maximum 255 characters.
Table 28 Validations on MI
MI attributes Validation
MIname Maximum 32 characters. Should be unique within an MI set.
The characters &, ", and < are invalid.
ReferenceID Should be unique in an MI set. The value should be greater
than or equal to 0, and less than or equal to 9999.
Description The description should contain a maximum of 256 characters
(optional).
Image File The image sent from the Composer Application to the terminal is in Windows
Conversion monochrome bitmap (.bmp) format. Once the mail reaches the server, the image
Format for is converted to a terminal-specific image format.
Mails This conversion is done by the Message Manager Server before the mail is sent
to the terminals. The bitmap is converted into either of two formats based on the
message type: printer format (.lgo) and display format (.gra). After conversion,
these files are stored in the database.
NOTE
For more details about the conversion algorithms contact VeriCentre support
personnel.
Performing a The AMS server performs scheduled monitor calls and urgent mail jobs. The
Monitor Call or sequence of operations that the AMS server performs for both of these events is
an Urgent Mail same.
Job
NOTE
The Scheduler displays the scheduled monitor call jobs in the Monitor Call View.
The urgent mail jobs are not visible on the UI.
Monitor Call and The steps taken by the AMS server for a monitor call job or an urgent mail job are
Urgent Mail Job as follows:
Sequence
1 Pick the jobs for ‘today’ that have not yet been performed from the database.
NOTE
AMS server picks the jobs from the database as per the database server time.
2 Check the ‘current time’ and ‘end time’ for every terminal configured in the
job.
If the ‘current time’ falls within the configured ‘start time’ and ‘end time’, start
the scheduled job.
3 Check the availability of COM port for a dial session across all the servers.
NOTE
Ensure that at least one COM port, on any of the servers, is enabled for
Information Collection, Remote Diagnostics and Message Management modules.
5 Dial out to the terminal if the duration of the job has not elapsed.
This appendix lists VeriCentre error messages, and provides possible causes and
solutions.
Validation for a For a successful download, a set of validations are performed when a request
Download packet is received by the VeriCentre server. The validations are:
Request Packet • For Verix, Verix V, Omni and Tranz terminals, the VFI signature should be
present in the request packet.
• The model should be configured. Refer to the -109 error in Table 29 for more
details.
• The requested application should be configured and the Download Allowed
option should be selected when the application is being configured for
download. Refer to the -118 error in Table 29 for more details.
• The requested terminal record should be configured. Refer to the -110 error in
Table 29 for more details.
• The Access Counter should be -1 or greater than zero (infinite downloads
allowed). Refer to the -111 error in Table 29 for more details.
• The access code is checked or skipped according to the algorithm configured
for the application. Refer to the -127 error in Table 29 for more details.
• The terminal record should not be locked. A terminal gets locked when an
access code violation occurs thrice. Refer to the -132 error in Table 29 for
more details.
• The file(s) to be downloaded to the terminal as a part of the application should
be available for download in the location configured for that application. Refer
to -102, -105, -115, and -116 errors in Table 29 for more details.
Download Table 29 lists the error messages specific to Download Management module.
Management
Module Error/
Information
Messages
Table 29 Download Management Module Error/Information Messages
Message
Code
Message Cause Suggested Actiona
-101 VT SYS FAULT Illegal parameters in the Check the .ini files.
.ini file.
-102 FILE OPEN ERR Unable to open a file. Check the existence of all
the files or file permissions.
-103 BAD RECORD SIZE OMNI data file(s) is not Check all *.dc files.
proper.
-104 BAD UDL FORMAT UDL format error. Check the UDL file records
by running the UDL Check
Utility.
-105 FILE READ ERR Cannot read from the file. Check the files permissions/
corruption.
-106 OPEN PKT ERR Could not obtain the status Check the existence of all
of the OMNI file. the OMNI CODE FILES/
permissions.
-107 MEMORY ERROR Not enough memory. Decrease the load on the
system or increase the
memory.
-108 INVALID BHVR FAMILY table is corrupted. Check the FAMILY table for
invalid behavior entries.
-109 MODEL NOT CONFGD No corresponding model for Check the request packet
the request. and add a model if required.
-110 TERML NOT CONFGD Terminal is not present in the Add an entry in the
RELATION table or is being RELATION table or wait until
downloaded currently. the download is over.
-111 ACCESS CNT OVER Access count for the terminal Change the access count in
is exhausted. the RELATION table using
the Terminal Record Editor
screen in VeriCentre.
-112 DOWNLOAD DONE Download is completed.
-113 CL ID NOT FOUND Cluster for the terminal Check the database. Add a
record is not found. new cluster ID if required.
-114 VT SYSTEM FAULT Cannot communicate with Check if all the processes of
PLIST/MONITOR. the system are running.
-115 FILE NOT FOUND File is not found in the Ensure that all the download
specified directory. files are in their specified
directories.
-116 PATH NOT FOUND Path to the specified file Check the path provided in
does not exist. the APPLICATION table for
all download files.
-301 Spawner: Error in INI Improper .INI file entries. Check the SPAWN section of
file.... VTALKSYS.INI.
check section [SPAWN] entry
Procs.
-302 Spawner; Could not create IPC Cannot create IPC queue. The system may already be
queue....Already running? running.
-373 PARSE ERROR %0, File%1 Could not parse the import Ensure that proper files are
Line%2. files. present in proper format, in
the specified directory.
-374 PARSE WARNING%0, File%1, Some files may be incorrect Ensure that the proper files
Line%2. in the specified directory. are present in the specified
directory.
-375 FATAL%0 Fam%1, App%2, Trd%3: FATAL error occurred while Check the import directory
%4 parsing the import files. for consistency.
-376 WARNING%0 Fam %1, App%2, Entries in the files may not Check the import files for
Tid%3 : %4 be proper in the specified consistencies.
directory.
-377 SYNTAX ERROR in File%0 Line%1 Syntax error in the IMPORT Ensure files are in the
file. correct format.
-378 Error while importing File%0 Error occurred while Check the format of the file.
Line%1 importing the specified file.
-380 Success:%0 %1 52 %3
-381 Success: %0 %1 52 %3 %4
-382 IGNORED FILE %0, Ignored the specified file. Check the file for proper
Probably no or insufficient format.
Fam/App info
-400 INVALID_DLD_FILE Unable to open download Check file path/permissions.
file.
-401 INVALID_PASSWORD Password is not valid for the Check if model supports
model. non-numeric passwords.
-402 INVALID_DBS_FILE tcload.dbs is corrupted. Check format of
tcload.dbs.
-403 INVALID_LOC_NUM Terminal memory Check EPROM ID.
information is incorrect.
-404 APP_TOO_BIG Terminal memory is small. Check EPROM ID.
-405 ERROR_LOC_LOADED Memory has already been Check EPROM ID.
set.
-406 INVALID_EPROM_ID Invalid EPROM ID. Check EPROM ID.
a. All listed actions are specific to family and application.
Download
Automation
a. Information message
Event Logs from VeriCentre DASWS logs the following messages to Event Viewer:
VeriCentre DASWS Table 32 Event Logs
Error/Information
Cause Suggested Action
Message
Service has stopped. The User tries to start the service Start the service on the
host name/IP address on one of the VeriCentre VeriCentre server with
specified for Scheduler & servers, and the host name or the host name or IP
Maint Util Server in System IP address of the machine address specified in the
Parameters Editor does not does not match with the value system configuration
match with this Host name/IP specified for the system variable Scheduler &
address. configuration variable Maint Util Server.
Scheduler & Maint Util
Server.
VeriCentre DASWS runs on
only one VeriCentre server
based on the system
configuration variable
Scheduler & Maint Util
Server.
Service is not running on any User tries to start the service Ensure that value of
of the VeriCentre servers. on one of the VeriCentre host name/IP address
The host name/IP address servers and the host name or specified for Scheduler
specified in System IP address of any of the & Maint Util Server
Parameters Editor for VeriCentre servers do not should match with one
system configuration variable match with the value specified of the VeriCentre
Scheduler & Maint Util for the system configuration servers’ host name/IP
Server does not match with variable Scheduler & Maint address.
any of the VeriCentre servers’ Util Server.
Host name/IP address. VeriCentre DASWS runs on
only one VeriCentre server
based on the system
configuration variable
Scheduler & Maint Util
Server. The service should
run on at least one VeriCentre
server to process check for
updates request from
terminals.
Service cannot be started <Error Message> is the Contact VeriCentre
<Error Message>. description of the error system administrator.
because of which the service
could not be started.
Enable Creation of Download Automation Server modules log debug messages to Dbgview.exe, a
Debug Log for third party application. This tool is available as a free download at http://
Download www.sysinternals.com
Automation Server
1 Invoke VeriCentre Registry Editor tool. (available at <VeriCentre
Installation directory>\Bin\VCRegEditor.exe)
2 Select Download Automation > DA_EnableLog.
Resolution:
Use Configuration Parameter Editor and set the value of parameter 'Scheduler &
Maint Util Server' to name of the server where the “VeriCentre Download
Automation Scheduler” should run.
Message Table 33 lists error messages specific to the Message Management module.
Management
Module Error/
Information
Messages
NOTE
In Message Management module, error messages are sent to the user as e-mail.
Information Table 34 lists error messages specific to the Information Collection module.
Collection
Module Error/
Information
Messages
Remote Table 35 lists error messages specific to the Remote Diagnostics module.
Diagnostics Table 35 Remote Diagnostics Module Error/Information Messages
Module Error/
Information Error Message Cause/Suggested Action
Messages You do not have the privilege to Contact the VeriCentre administrator for
perform this operation. Contact the necessary privileges.
the VeriCentre administrator.
Terminal not connected. Establish The communication link between the
connection and try again. terminal and VeriCentre may be
disconnected.
Establish the connection once again and
commence the diagnostics.
Unable to start a new diagnostics You should close the Diagnose and Fix
session. Close the Diagnose and Fix dialog before attempting a new
dialog box and try again.
diagnostics session.
Diagnostic session active with This message occurs when starting a new
another terminal. Do you want to diagnostics session with a terminal and
close that session and start a new
there is an ongoing session with the same
session?
terminal.
Click Yes to close the ongoing session.
Then start a diagnostic session with the
required terminal.
Unable to close the diagnostics You should close the Diagnose and Fix
session. Close the Diagnose and Fix dialog before attempting to close the
dialog box and try again.
ongoing diagnostics session.
Unable to communicate with the The link between the terminal and
terminal. Terminal may have been VeriCentre may have disconnected.
disconnected.
Establish the connection and try again.
Unable to access the list of This message may occur due to the
applications on the terminal. following:
• The terminal may be offline. Establish a
connection and try again.
• The applications may not be configured
in the VeriCentre database. Configure
applications in VeriCentre using the
Model and Application Manager.
There are no diagnostic queries You are trying to perform remote
defined for this category. diagnostics on a query category without
defining any queries.
Define diagnostic queries for the category
and try diagnostics again.
NOTE If the required information is not being logged, even after configuring a Log to file
action while setting rules for MI collection, perform the following actions:
• Create a shared folder on the server and ensure that the server has both read
and write permissions. You should assign read permissions for the client.
Monitored Item Table 36 lists all error messages related to monitored items:
Error/ Table 36 Monitored Item Error/Information Messages
Information Error Message Cause/Suggested Action
Messages
Database error: The network connection between the
Unable to save changes. VeriCentre client and the VeriCentre
database server might not be working.
Check the network connections.
Database error: The network connection between the
Unable to retrieve query category VeriCentre client and the VeriCentre
information. database server might not be working.
Check the network connections.
This category name already exists While creating a new category, you might
in the database. Enter a unique have entered a category name that is
category name.
already present in the VeriCentre database.
Enter a unique category name.
A query category with this name While creating a new query category, you
already exists in the database. might have entered a category name that is
Enter a unique name for the query
already present in the VeriCentre database.
category.
Enter a query category name that is unique.
Database error: The network connection between the
Unable to add the query. VeriCentre client and the VeriCentre
database server might not be working.
Check the network connections.
All queries associated with this Click Yes to delete all queries associated
category will be deleted. with the selected query category.
Do you want to continue?
Monitored Item Table 37 lists all error messages occurring while importing monitored items.
Import Error/
Information
Messages
NOTE
Error messages occur if you import an invalid XML file. Obtain the correct XML file
and try importing again.
Miscellaneous Table 38 lists all error messages which occur while working in the Model and
Error/ Application Manager, Terminal Manager or Scheduler.
Information Table 38 Miscellaneous Error/Information Messages
Messages Error Message Cause/Suggested Action
Select an application for Using the Terminal Manager, you can globally
global update. update the properties of multiple terminals.
However, all terminals should have the same
application.
This message appears when you do not select
an application for global update.
Name the list.
Find is in progress. Try again This message appears while attempting
later. another operation when a search is ongoing in
the Finder view.
You may have been attempting one of the
following:
• Sort
• Delete
• Copy
• Move
• Global update
• Changing to Cluster View.
Wait for the completion of the Find operation,
and try again.
Enter at least one search You have provided a Find command in the
criterion to find terminals Finder View, without providing a search
criteria.
Provide the required search criteria in the
Finder view, and then click Find.
Database error Check the database connection.
Debugging the The support team requires the debug information generated by the Download
VeriCentre modules for better understanding of download issues and problems. The modules
Server and can be switched ON for debugging at runtime without restarting VeriCentre
Client Modules services. The generated debug file can be viewed only by a special program
called Debug Viewer (DbgView) that can be downloaded from http://
technet.microsoft.com/en-us/sysinternals/default.aspx.
The debug information that appears on the viewer can be saved to a file.
NOTE • To use the VCDebugClient.exe tool, the logged-in Windows user must
have administrator privileges.
• If the VeriCentre server is being accessed from a Remote Desktop session,
ensure that you open a Remote Desktop console session in order to capture
the debug log information.
3 Select the modules to be debugged and click Start. This changes the color of
the icons to green. Most download issues can be debugged by capturing the
log information for the Download, ParamList, ServerController and
ServerControllerDB modules.
4 After selecting all modules, click Launch viewer. This should launch the
viewer that will log the debug information.
5 Once the VeriCentre issue that is being debugged has been reproduced and
the debug information has been captured in the Debug Viewer (DBGVIEW)
window, save the log information that appears in the Debug Viewer window
by choosing the ‘Save As’ option and save it as a LOG file.
Debugging the The VeriCentre Communication modules can be debugged for any unexplained
VeriCentre behavior. The files generated will be sent to the VeriCentre Support Team for
Communication further analysis.
Modules
To Debug the VeriCentre Communication Modules
1 Open the Vik_Debug.ini file from the Windows folder (C:\WINDOWS for
Windows XP and Windows 2003).
NOTE After you have finished debugging, you need to disable the creation of the debug
log file. You need to undo the two changes done to the vik_debug.ini file,
save it, and restart the VeriCentre server. Please copy the debug log files from
the c:\debug folder to some other location, before restarting VeriCentre, since
these files will get deleted when VeriCentre communication modules are
restarted.
Format of ‘Check for Updates’ request over Ethernet is a HTTP GET request with the
‘Check for following format:
Updates’ Table 39 ‘Check for Updates’ Request (Ethernet) Format
Request Over Line# Request
Ethernet
1 GET/VeriCentreAutomationServer/CheckUpdateHandler.asmx/
IsUpdateAvailable?SerialNumber=<SerialNumber>
&ReqPktId=<ReqPktId>&TerminalId=<TerminalId>&TerminalTime=<Term
inalTime>
&NonBusinessHours=<NonBusinessHours>&DownloadMedium=<DownloadMe
dium>&OSVersion=<OSVersion> HTTP/1.1
2 Host: <VeriCentre IP address>
3 <Blank line>
where,
<SerialNumber> Serial number of terminal.
<ReqPktId> Request packet identifier.
<TerminalId> Terminal ID.
<TerminalTime> Current date and time on the terminal, in
YYYYMMDDHHMMSS format.
<NonBusinessHours> Start and end time of non-business hours in HHMM-
HHMM format.
<DownloadMedium> Media on which the terminal calls VeriCentre for
automated download. Valid values for this field are
Ethernet/ISDN/PSTN/GPRS/CDMA/GSM/WI-FI/X.25/
Other.
<OSVersion> Version of OS on the terminal.
Format of ‘Check for Updates’ request over Dialup (PSTN/ISDN) and X.25 network has the
‘Check for following format:
Updates’ Table 40 ‘Check for Updates’ Request (Dialup and X.25) Format
Request Over Format Description
Dialup and X.25
VFI Standard identifier.
(XCU calls)
, Comma separator.
Platform name Request packet identifier.
, Comma separator.
Request type XCU/Serial number.
, Comma separator.
Terminal ID Terminal identifier.
, Comma separator.
Terminal time Current date and time on the terminal in YYYYMMDDHHMMSS
format.
, Comma separator.
Non business hours Start and end time of non-business hours in HHMM-HHMM
format.
, Comma separator.
Download medium Media on which the terminal calls VeriCentre for automated
download. Valid values for this field are ISDN/PSTN/Other.
, Comma separator.
OS version Version of OS on terminal.
, Comma separator.
Block size Reserved for future use.
</DownloadSchedule>
</VeriCentre>
NextScheduleDateTime Date and time when the terminal should call DAS to
obtain download, in YYYYMMDDHHMMSS format.
Schedule response over Dialup is sent to the terminal in the following format:
<STX>D<4 byte length of XML data, excluding ETX and CRC><XML
Response><ETX><CRC1><CRC2>.
Directives
VeriCentre supports various directives that can be specified as the parameter for a
terminal record. These directives are available for all terminal records and they
can be added to the terminal record just like other parameters. The directives and
their usage are:
Table 41 Directives
Directives Usage
REM Used to indicate a comment. This is not a downloadable parameter.
The download engine ignores it.
DIAL Used to indicate to VeriCentre download server, the phone number
of the terminal that VeriCentre should dial for a VeriCentre-Initiated
Download (VID). This is not a downloadable parameter.
CLOCK The number of hours that is added or subtracted from the
VeriCentre server's time to allow synchronization of the clock on the
terminal. This is a positive or a negative number (in hours) that is
added to or subtracted from the current time on the terminal.
PASSWRD Used to set the file group password for Verix/VX terminals.
System Mode Password for Verix/VX Terminals:
Download the *SMPW Config.sys parameter to any GID in the
terminal to set the system mode password. Use only password
characters that can be entered from the terminal's keypad and the
new password will take effect after the terminal is restarted.
File Group Password for Verix/VX Terminals:
To set the file group password for a given GID in the terminal, you
need to define either the *PW Config.sys parameter or the
PASSWRD directive for the specified GID. Use only password
characters that can be entered from the terminal's keypad and the
new password will take effect after the terminal is restarted.
For example, to set the file group password for GID1 to 12345 and
file group password for GID2 to 54321, use the following sequence
of directives/parameters:
SETGROUP = 1
PASSWRD = 12345 or *PW=12345
SETGROUP = 2
PASSWRD = 54321 or *PW=54321
NOTE • The valid directives that are configurable for a used terminal are REM,
SETGROUP and USES. All other configured directives are not processed by
the Download server.
• If there are no entries in the DLDTABLE for application A1, then the default file
for the application (A1.OUT, if the behavior is OMNI, else A1.UDL) is
downloaded. Only if A1.OUT or A1.UDL is present in the working directory, files
are downloaded.
Access Counter It is the number of times that the appli- classes are derived.
cation can be downloaded to the terminal. Every time a
download is performed, the Access Counter value decre- COM Ports Communication ports are entry/exit points
ments by 1. If the Access Counter is 0, you cannot down- through which a system can communicate to external sys-
load an application to that terminal. An Access Counter of tems.
-1 indicates an infinite number of downloads to the termi-
nal. Cluster A collection of terminals is called as a cluster. An
organization or a merchant can own one or more termi-
ACK This character indicates that the terminal or host nals. These terminals may be of the same model or of dif-
has received the message without error and is now ready ferent models. A cluster could represent a single shop, a
to receive another message chain of shops or all shops in a geographical region.
API A set of routines that an application uses to request Connect This is a modem response indicating that a
and carry out lower-level services performed by an oper- connection has been established.
ating system. For computers running a graphical user in-
terface, an API manages an application's windows, icons, CRC Cyclic Redundancy Check is a type of error check
menus, and dialog boxes. performed on incoming and outgoing data.
Application It is the software program installed on a ter- Default Terminal Record An application may have
minal. All terminals belonging to a particular Model can some common parameters to be downloaded. VeriCentre
run only those applications that the Model supports. provides an option to create a template record that can be
marked as Default terminal for a terminal application. All
Application Server Application servers are the mod- new terminals that are added for this application inherits
ules that are registered with MPR to handle terminal re- all the common parameters from their default terminal.
quests. For example, the download server process is the Using a Default Terminal Record saves the user from con-
application server that handles download requests. figuring these common parameters for all the terminals
that are added.
ASCII An acronym for American Standard Code for Infor-
mation Interchange. It is a code in which the numbers DIAL This is a type of directive and is used to indicate to
from 0 to 255 stand for letters, numbers, punctuation the VeriCentre download server the phone number of the
marks, and other characters. ASCII code is standardized terminal that VeriCentre should dial, for a VeriCentre-initi-
to facilitate transmitting text between computers or be- ated download (VID). This is not a downloadable param-
tween a computer and a peripheral device. eter.
Baud Rate This is the transmission rate in remote com- Dial Connection This is a connection established over
munications and is expressed in bits per second. PSTN (Public Switched Telephone Network) between two
computer systems, through a pair of modems.
CLOCK If the clock directive is present, the download
server sends a parameter during download that requests Differential Download A download operation where
the terminal to set its internal clock to that value. The clock only the files that have changed are downloaded.
directive is specified as a positive or negative value, in the
terminal record. The download server translates this to a Dynamic-link Library file A file that contains one or
time value that will be added or subtracted in the server's more functions that are compiled, linked, and stored sep-
downloadable time. arately from the processes that use them. In Win32, the
operating system maps the dynamic-link libraries (DLLs)
COM An open architecture for cross-platform develop- into the address space of a process when the process is
ment of client/server applications based on object-orient- starting up or while it is running. The process then exe-
ed technology as agreed upon by Digital Equipment cutes functions in the DLL. Dynamic-link library files usu-
Corporation and Microsoft Corporation. The Component ally have a .DLL filename extension.
Object Model defines an interface (similar to an abstract
base class), Unknown, from which all COM-compatible Direct Download A download performed using RS-232
connections, through the VeriCentre User Interface.
Directives VeriCentre supports various directives that terminal by the host after the connection has been estab-
can be specified as the parameter attribute for an applica- lished to indicate that the host is ready to receive data
tion. These directives are available for all applications as from the POS terminal.
a pre-defined set of parameter attributes and they can be
added to the application just like other parameters. The Instant Download A download operation performed
different types of directives are: CLOCK, DIAL, PASS- from VeriCentre initiated download.
WRD, REM, SETGROUP and USES.
Interested Download An option in VeriCentre Monitor
Disconnect String A command string to a modem to to view details of an ongoing download for a specific ter-
disconnect an ongoing connection. minal record.
DSN The Data Source used by Database Clients for con- KEY This is a directive that allows files to be selectively
necting to the database downloaded to a terminal. An application can have one or
more files associated with it. Optional keys can be as-
EPROM An acronym for Erasable Programmable Read signed to some of these files, so that only terminals with
Only Memory. the corresponding keys in their terminal record will receive
the files.
EOT This character indicates that the primary station is
ready to receive or send data. For example, consider application A1 with files configured
for download as (only fields relevant to the key are shown
Escape String A command string to a modem, to bring here):
it from an online state to the command state.
DldType KeyVal SerFileNm
ETB This character indicates the end of a message in a F GeneralFull.OUT
message block. FP FM1 First.OUT
(Note: Dldtype is
ETX This character indicates the end of a message in
irrelevant if Key is
single message transfer, or the end of a block in block
present, Default
transfer.
FP)
Flash It is a type of file system in Verix terminals. FP FM2 Second.OUT
File Group A logic positioning of memory on Verix termi- On full download, T1 receives GeneralFull.out and
nals for storing applications.
First.out. T2 receives GeneralFull.out.
GID The group ID. It is an identification for a group on On partial download, T1 receives Second.out. T2 does
Verix terminals. not receive any files since the files in the DLDTABLE do
not match the type of download requested.
Global Update An update operation done in the termi-
nal manager user interface for changing terminal details If there are no entries in the DLDTABLE for application
or a large set of terminal records. A1, then the default file for the application (A1.OUT, if the
behavior is OMNI and A1.UDL otherwise,) is downloaded.
GUID It is the Globally Unique Identifier of an executable. Only is A1.OUT or A.UDL are present in the working di-
rectory, files will be downloaded.
HOST The acquirer's computer system that provides
electronic authorization/data capture. The term is also
Key Value This allows selective download of files to ter-
used to refer to the VeriCentre server system, in the case
minals requesting this application. The value of this can-
of VeriCentre.
not exceed 10 characters in length. If a key value is
specified, this file will be downloaded to the terminal only
Host Poll Character The character sent to the POS
if that terminal has defined a KEY directive corresponding
Log Files Files to store details of log data. This is used POS terminals: Point-of-sale device that reads infor-
for debugging purposes. mation from the magnetic stripe on a credit card, accepts
further information from its keypad, then sends the credit
Message Delimiters Special characters used to mark request to the authorization host.
the boundary of a message. Each message has a start
delimiter STX, and an end delimiter ETX. Polling The process of requesting information from con-
nected devices one after another, in a repeating cycle.
Modem Combined form of modulator/demodulator. A
modem is a communication device that translates digital Purge Permanently removes/cleans up the Database
information into analog information (and vice versa) so logs generated during VeriCentre Operations.
that it can be transmitted between digital devices over
phone lines. RAM The Random Access Memory on the terminal.
Memory that can be read and written by the CPU or other
Message Data sent from one device to another, as from hardware devices.
VeriCentre to a terminal.
REM This is type of directive and is used to indicate a
Model A model is the type of the terminal. These models comment. This is not a downloadable parameter. The
may differ from one another on factors such as their func- download engine ignores it.
tionality and communication protocol. Some terminal
models support only a single application while others are Request Packet It is the information sent by the termi-
multi-application terminals. nal while requesting information. Information relating to
model, application, terminal ID and Request Packet ID is
NAK This character indicates that the terminal or host supplied by the terminal in the request packet that it
has received the previous message with an error and is sends.
waiting for re-transmission of the message.
Reset String A modem command string used to reset
OS Abbreviation for Operating System. It is the interface the modem (bring it to default settings).
program running on the device between the user or appli-
cations and the hardware devices. Response String A sequence of characters sent by the
modem in response to a modem command.
Parameter A parameter is a set of name-value pairs
specific to an application. Parameters are used by termi- RS 232C A specification that defines the interface be-
nal applications. tween data terminal equipment and data communications
equipment using serial binary data interchange.
Parameter Attributes Information about the parame-
ters for a terminal application. SETGROUP Set group is a directive used to download
terminal parameters to a specific group while performing
Parity This is a data transmission attribute that enables downloads. This directive is applicable on terminals that
error-checking. support multiple applications. You should add this direc-
tive prior to the list of terminal parameters to be download-
Partial Download A download where only the por- ed to a specific group.
tion(s) marked for download are sent. A partial download
is usually sent when portions of an application have SID The Security Identification Number. It is used in Ora-
changed and require to be sent to the terminal, thus sav- cle for database connections.
ing download time.
Simple Mail Transfer Protocol (SMTP) A TCP/IP
PASSWRD This is a type of directive and is used to set protocol for sending messages from one computer to an-
the terminal system password. other on a network. This protocol is used on the Internet
to route e-mail. See also TCP/IP.
Privileges A set of access permission to use or launch
modules in VeriCentre. STX This character indicates the beginning of a message
in single message transfer, or of a message block in block
Protocol It is the behavior or the set of rules used to transfer.
SQL A database query and programming language. VeriCentre-initiated download A download initiated
by the system operator, at the PC with VeriCentre. This
SYN This character is a wait character that extends the download can be for a single terminal or a range of termi-
time between two protocol elements. nals.
Telephony Application Programming Interface VeriCentre Primary Server The system where Veri-
(TAPI) A set of functions in the Win32 API that lets a Centre License Manager is running.
computer communicate directly with telephone systems.
VeriCentre Secondary Server The system where
Transmission Control Protocol/Internet Protocol VeriCentre server components are running, and is not a
(TCP/IP) A protocol developed by the Department of De- Primary Server.
fense for communications between computers. It is built
into the UNIX system and has become the de facto stan- Wait Character The character sent to the terminal from
dard for data transmission over networks, including the In- the host, to indicate that it is busy.
ternet. TCP and IP are transport and address protocols;
TCP is used to establish a connection for data transmis- ZONTALK A PC-based software tool that helps you
sion, and IP defines the method for sending the data in manages the application programs and data used by Ver-
packets. iFone transaction terminals.
VeriCentre
Technical Reference Manual