Download as pdf or txt
Download as pdf or txt
You are on page 1of 152

VeriCentre

Technical Reference Manual

VeriFone Part Number 53040, Revision G


VeriCentre Technical Reference Manual
© 2011 VeriFone Systems
All rights reserved. No part of the contents of this document may be reproduced or transmitted in any form without the
written permission of VeriFone Systems.
The information contained in this document is subject to change without notice. Although VeriFone has attempted to
ensure the accuracy of the contents of this document, this document may include errors or omissions. The examples
and sample programs are for illustration only and may not be suited for your purpose. You should verify the applicability
of any example or sample program before placing the software into productive use. This document, including without
limitation the examples and software programs, is supplied “As-Is.”

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

VERICENTRE TECHNICAL REFERENCE MANUAL 3


C ONTENTS

Using the PF Configuration Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52


Configuration of Purge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring Purge for VeriCentre Enterprise . . . . . . . . . . . . . . . . . . . . . . . . 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

4 VERICENTRE TECHNICAL REFERENCE MANUAL


C ONTENTS

<application name>.dld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103


Sample .dld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
<application name>.tdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Sample .tdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
<export>.exp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Sample Export File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Extended .tdf File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
<application name>.tdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Sample .tdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

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

VERICENTRE TECHNICAL REFERENCE MANUAL 5


C ONTENTS

6 VERICENTRE TECHNICAL REFERENCE MANUAL


PREFACE

VeriCentre 3.0 is a complete terminal management system from VeriFone that


provides you an efficient method for managing POS (Point Of Sale) terminals.
VeriCentre 3.0 is referred as VeriCentre in this manual.
This manual provides technical information on VeriCentre components.

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.

Document This document is organized as follows:


Organization Table 1 Document Organization
Chapter Definition
Chapter 1, Architecture Describes the VeriCentre architecture, its
components and supported features. It also lists
and describes various modules of VeriCentre.
Chapter 2, Message Parser and Explains the components and working of MPR.
Router (MPR)
Chapter 3, Tunable Parameters Describes all tunable parameters used in
VeriCentre.
Chapter 4, Ports Used by VeriCentre Lists the ports used by VeriCentre.
Chapter 5, Algorithms Describes the algorithms used in VeriCentre.
Chapter 6, File Formats Explains the various file formats like VeriCentre
MIs, Import/Export, Report SQL and XML,
ZONTALK and extended file formats.
Chapter 7, Upgrading License Lists the steps to obtain additional licenses.
Chapter 8, How To Describes how to perform a specific task.
Appendix A, Errors and Lists the error messages and possible
Troubleshooting solutions.

VERICENTRE TECHNICAL REFERENCE MANUAL 7


P REFACE
Conventions and Acronyms

Table 1 Document Organization (continued)


Chapter Definition
Appendix B, ‘Check for Updates’ Lists the formats for Check Update Request and
Request and Schedule Response Schedule Response.
Formats
Appendix C, Directives Explains various directives and their usage.

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.

Table 2 presents acronyms and their definitions.


Table 2 Acronym Definitions
Acronym Definition
ADO Active Data Objects
AMS Appliance Management Scheduler
API Application Programming Interface
CDMA Code Division Multiple Access
DA Download Automation
DAPS Download Automation Proxy Server
DAS Download Automation Server
DASM Download Automation Scheduler Maintenance
DASWS Download Automation Scheduler Windows Service
DLL Dynamic Linked Library
DLR Download Request
DSN Domain Server Name
ENQ Enquiry
FCFS First Come First Serve
GPRS General Packet Radio Service

8 VERICENTRE TECHNICAL REFERENCE MANUAL


P REFACE
Conventions and Acronyms

Table 2 Acronym Definitions (continued)


Acronym Definition
GSM Global System for Mobile communication
HTTP Hyphenated Text Transfer Protocol
ICM Information Collection Module
IIS Internet Information Services
ISDN Integrated Services Digital Network
LAN Local Area Network
MI Monitored Items
MPR Message Parser and Router
NLB Network Load Balance
ODBC Open Database Connectivity
PPP Point-to-Point Protocol
POS Point Of Sale or Service
PSTN Public Switched Telephone Network
RD Remote Diagnostics
SMTP Simple Mail Transfer Protocol
SQL Structured Query Language
SSL Secure Socket Layer
TAPI Telephony Application Programming Interface
TCP/IP Transmission Control Protocol / Internet Protocol
TDF Terminal Definition File
TID Terminal ID
UDL Universal Data Link
UNC Universal Naming Code
VCDSN VeriCentre Data Source Name
VEM VeriCentre Environment Monitor
VID VeriCentre Initiated Downloads
VMAC Verix/Verix V Multi-App Conductor
VTSRA VeriCentre Server Remote Agent

VERICENTRE TECHNICAL REFERENCE MANUAL 9


P REFACE
Reference

Reference Following documents are referenced in this manual:


• Online help for VeriCentre 3.0, VDN 53044
• VeriCentre Installation Guide for Enterprise, VDN 27656
• VeriCentre for SQL Server and SQL Express Database Schema, VDN 52966
• VeriCentre for Oracle Database Schema, VDN 53041

10 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 1

Architecture

The VeriCentre Terminal Management System is a scalable, secure and multi-


user solution for downloading applications and updates to VeriFone terminals, and
managing terminal operations.
Figure 1 illustrates the VeriCentre Architecture.

Figure 1 VeriCentre Architecture


VeriCentre installation setup consists of:
• one Primary server,
• one or more Secondary server(s),
• one or more Client(s),
• one VeriCentre database,
• one Backup Primary server,

VERICENTRE TECHNICAL REFERENCE MANUAL 11


A RCHITECTURE

Secondary server(s) and Backup Primary server are optional components.


Servers, clients and database can be setup either on same or multiple machines.
Number of servers and clients that can be used for a VeriCentre setup is
determined based on number of licenses purchased.

VeriCentre Primary/Backup Primary/Secondary server(s)


VeriCentre servers are the back end systems, which processes terminal requests
that arrive over different communication media like Dial/TCPIP (Ethernet/GSM/
GPRS/CDMA/Wi-Fi) /X.25. These requests can be to:
• perform downloads,
• send/receive messages and graphics,
• collect information, or
• perform remote diagnostics.
Apart from handling processing requests, Primary server acts as a license server
which contains the license information and services required to run VeriCentre
licensing feature.
Since the Primary Server provides licenses for all licensed features in VeriCentre,
it must always be running for the entire VeriCentre setup to be functional. In case
of emergency, Backup primary server can be used in-place of the Primary server
temporarily.
For more information on how to switch to a Backup primary server contact
VeriCentre support team.

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:

12 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Features

• Download Management Module - This module enables you to download


applications to terminals. Applications are downloaded to terminals during
deployment or when existing applications on terminals require an upgrade.

Refer to Download Management Module section for more information.


• Message Management Module - This module enables you to transfer
messages between VeriCentre and terminals. You can send pre-defined or
custom text, or graphics messages either to a single terminal or to a range of
terminals.

Refer to Message Management Module section for more information.


• Information Collection Module - This module enables you to collect
information on the critical parameters of a terminal. For example, the number
of card swipes, and the free memory on a terminal.
The information thus collected can be used to identify the potential problems
and rectify it in advance.

Refer to Information Collection Module section for more information.


• Remote Diagnostics Module - This module enables you to identify problems
with terminals that are located remotely, and also check for the correctness of
application parameter values.

Refer to Remote Diagnostics Module section for more information.


• Download Automation Module - This module enables you to configure for
automated downloads. The application download is automated for all updates.

Refer to Download Automation Module section for more information.

NOTE
The availability of modules depends on the type of license that you have.

Features Following features are supported by VeriCentre:


• A simple UI (User Interface) that helps you to configure the essential
VeriCentre operations.
• Individual modules are provided to perform specific tasks which are
independent of other modules except when data is required from another
module.
• Download Manager Module is provided to download and maintain
applications on terminals. Refer to Download Management Module section
for more information.
• Message Manager Module is provided to transfer messages between
terminals and Composer Application users. Refer to Message
Management Module section for more information.

VERICENTRE TECHNICAL REFERENCE MANUAL 13


A RCHITECTURE
Other Features

• Information Collection Module is provided to collect information on the


critical parameters of the terminal. Refer to Information Collection Module
section for more information.
• Remote Diagnostics Module is provided to diagnose terminal and
application errors on remotely located terminals. Refer to Remote
Diagnostics Module section for more information.
• An easy migration path for users of previous versions of VeriCentre.
• Customized Reports option - apart from standardized reports, customized
report option is provided for the user to generate customized reports by
providing terminal data.

Other Features Following are the other main features of VeriCentre:


• High Availability
• Load Balancing
• Scalability

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

At the System Level


The dispersing of work is not handled automatically by VeriCentre. The VeriCentre
system administrator needs to configure terminal requests to be routed to the
servers using hunt lines or similar mechanisms that are operational.

At the Application Level


When one of the server processes among the multiple instances launched goes
down, other instances should be able to pick up download requests and handle
them.

At the Management Communication Server Level


When an instance of the management communication server goes down, the
other instances should be able to pickup and handle requests from the following
process:
• Terminal Communication Handler
• ICM

14 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Other Features

• 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.

If there is considerable change in any of these factors, the number of


VeriCentre servers required will also change.

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 15


A RCHITECTURE
Other Features

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

16 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

servers. For example, there can be two communication servers and


multiple instances of Help Request Client.

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.

Modules VeriCentre consists of the following components:


• Core Components
• Download Management Module
• Message Management Module
• Information Collection Module
• Remote Diagnostics Module
• Download Automation Module
• Database

License Service The primary server contains the license information of VeriCentre, and the service
required for running the license feature.

Core Components The core modules of VeriCentre consists of:


• Core Services - handles the database operations and privilege checks for all
other VeriCentre modules.
• Communication Services - handles the communication between VeriCentre
and external devices/terminals.
• VeriCentre Environment Monitor - monitors database activity and manages
the server modules, depending on the availability of the database connection.

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.

To open the debug support tool, double-click the VCDebugClient.exe file


from the “<VeriCentre Installation directory>\Bin” directory. To
debug a component, select it from the list and click Start.

VERICENTRE TECHNICAL REFERENCE MANUAL 17


A RCHITECTURE
Modules

Communication Services
VeriCentre has several sub-modules that provide communication services. These
sub-modules are listed and described in the following table:

Module Description Executable


Dial Handles all dial requests. CM_DIAL.exe
Dial Scheduler Schedules dial sessions. CM_Provider.exe
Write CM Config Updates the .ini files for the CMCreateIni.exe
selected VeriCentre server.
Message Router Routes terminal communication MsgRouter.exe
requests to the corresponding
modules.
TCP/IP Provides a TCP/IP interface in CM_SN_TCPIP.exe
VeriCentre to perform IP
downloads.
Trace Server Handles the trace requests from TraceServer.exe
VeriCentre Trace Clients.
Management Handles terminal management srcomsvr.exe
Communication Server related requests and responses
used by the Message
Management Module, Information
Collection Module and the
Remote Diagnostics Module.
AMS Server (Appliance Handles the following: MaintananceMgr.exe
Management Scheduler) • Scheduling VeriCentre initiated
mail read/delivery calls.
• Monitoring calls for Information
Collection and Automated
diagnostics.
X.25 Handles X.25 sessions. cm_x25.exe

VeriCentre Environment Monitor


VEM (VeriCentre Environment Monitor) monitors database activity and manages
the server modules, depending on the availability of the database connection. The
VEM runs as an automatic service on any machine that has the VeriCentre server
components installed, and monitors VeriCentre server service, which in turn,
starts or stops the VeriCentre server modules.

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.

18 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

The VEM module is comprised of:

Module Description Executable


VeriCentre Monitors database activity and manages the crvemsrv.exe
Environment server modules, depending on the availability
Monitor of the database connection.

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.

Module Description Executable name


Download Parameters Server Assists in parameter vtplistserver.exe
downloads.
Download Server Handles download vtserver.exe
requests.
VID Server Handles VeriCentre- vtvid.exe
initiated downloads.
Monitor Server Enables monitoring vtmonitorserver.exe
downloads from remote
clients.

VERICENTRE TECHNICAL REFERENCE MANUAL 19


A RCHITECTURE
Modules

Figure 2 illustrates the working of the Download Management module.

Figure 2 Download Management Module

Download Download Automation solution provides an option to download application


Automation updates automatically to the terminal. Download Automation solution supports
Module automated downloads to the terminal from multiple VeriCentre hosts. This
Download Automation solution is supported only for the Verix and Verix V
terminals.
The solution comprises of:
• VeriCentre

VeriCentre comprises of software distribution and terminal-application


management system that provides a quick and efficient method for handling
concurrent downloads. VeriCentre manages the application updates, and
schedules the distribution of these application update to the terminal(s).

• AutoDL
20 VERICENTRE TECHNICAL REFERENCE MANUAL
A RCHITECTURE
Modules

AutoDL is a terminal application responsible for checking the availability of


application updates with VeriCentre on regular intervals. If application updates
are available, VeriCentre sends a schedule that comprises of date and time
when the terminal requires to call in. AutoDL will call VeriCentre as per the
schedule to obtain an automated download.

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.

All applications running on a terminal have to be AutoDL compliant. AutoDL


checks with all the applications running on the terminal before proceeding with
the download. Only after getting a positive acknowledgement from all these
applications, AutoDL proceeds with the download. The VMAC and
Communication Server applications are also required on the terminal, except
in the case of Dial without PPP downloads where the Communication Server
application is not required.

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).

VERICENTRE TECHNICAL REFERENCE MANUAL 21


A RCHITECTURE
Modules

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.

Figure 3 Download Automation Architecture


Following are the tasks handled by VeriCentre Download Automation solution:

22 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

Handling Check for Updates Requests


Check for updates request from terminals over Ethernet, Dial with PPP and
Wireless media are handled by DAS. Check for updates request from
terminals over Dial without PPP (with/without dial concentrators) will be handled
by DAPS (Download Automation Proxy Server) that redirects the requests to DAS
(Download Automation Server). Check for updates request from terminals
over Dial without PPP and X.25 use signature packet with a new request type
(XCU). DAS is an XML Web service hosted in Microsoft IIS. DAPS is a COM
server that can be independently started and stopped using Server Manager. DAS
and DAPS components are available on all VeriCentre servers where Download
Automation Add-on is installed.

VERICENTRE TECHNICAL REFERENCE MANUAL 23


A RCHITECTURE
Modules

Figure 4 illustrates the tasks performed by DAS:

Figure 4 Tasks Performed by DAS

24 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

Figure 4 Tasks Performed by DAS (continued)


VERICENTRE TECHNICAL REFERENCE MANUAL 25
A RCHITECTURE
Modules

Figure 5 illustrates the tasks performed by DASWS:

Figure 5 Tasks Performed by DASWS


Schedule Generation
Download Automation Scheduler Windows Service (DASWS) is a Windows
service responsible for generating download schedules. DAS places the check
for updates request in a queue, if it requires responding back to the terminal
with a schedule. DASWS processes these requests from the queue on FCFS
basis and generates the schedule. DAS picks the generated schedule and
responds back to the terminal.
The schedule sent to the terminal comprises of:
• date and time when the terminal should call VeriCentre for automated
download.

26 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

• connectivity details of VeriCentre server that terminal require to contact to


obtain the automated download.
DASM job is a Windows job which is scheduled to run at mid night. The job runs
DASM utility responsible for performing maintenance tasks related to generation
of new schedules and clearing of expired schedules.

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.

Schedule Generation Algorithm


DASWS tries to find the earliest possible time on one of the VeriCentre servers
enabled for Download Automation. It reserves a time slot based on the download
duration and download media. Scheduler takes care of the time off-set between
VeriCentre and the terminal, and ensures that the time slot is within the non-
business hours of the terminal. Schedule date and time will be as per the time
zone of the terminal.
DASWS tries to find and reserve the time slot for a range of days based on
Download schedule lag and Generate schedule count system
configuration parameters (refer to the Table 3 for more details). If DASWS cannot
find a free time slot, 513-NO SLOTS AVLBL error is returned to the terminal. Refer
to Appendix A for details on error messages.

NOTE
Download Automation solution does not consider daylight savings.

Handling Automated Downloads


Download Server module of VeriCentre is responsible for handling automated
download request from the terminals. AutoDL calls VeriCentre at the scheduled
time for VeriCentre to send all the available application file and parameter
updates.
Automated download request from terminal will always be for a partial download
and VeriCentre will respond with full download of all the updated applications and
parameters. If parameters of an application are updated, only the parameters are
downloaded. If application version is updated, then both files and parameters will
be downloaded.
If an application is enabled for Differential Download option, for a file download,
VeriCentre will download only the files that got changed since the last Full or
Partial download. If the Differential Download option is not enabled and if the
current application version has changed, then VeriCentre will download all the
files of this application that are marked with a download tag of 'F' or 'FP'.
VERICENTRE TECHNICAL REFERENCE MANUAL 27
A RCHITECTURE
Modules

For automated downloads, all the updated applications will always be


downloaded. Certain terminal applications like the Terminal OS have to be
downloaded independent of the other applications for a given Terminal ID and
such applications can be marked for exclusive downloads in VeriCentre.
Applications marked for exclusive downloads will be downloaded independently
(not along with any other applications). These applications will be downloaded
before any other non-exclusive applications are downloaded. This exclusive
download feature is applicable only for automated downloads.

Message The Message Management module (Message Manager) of VeriCentre enables


Management you to send text messages and graphics to terminals.
Module

NOTE
The Message Management module is available only for the VeriCentre
Enterprise edition.

The Message Management Module consists of the following components:

Module Description Executable


Message Manager This module runs on the primary server. It mmserver.exe
Server handles the exchange of mails between the
terminal and the composer user.
The Message Manager Server module
provides:
• mail management services.
• mail handling between terminals and the
Composer application.
• implements the SMTP server. This has a
minimum implementation of SMTP
protocol to send and receive mails from
the users.
• SMTP server connects to the local mail
server to send out mails.
• receive mails from any mail server using
SMTP protocol.

Terminal This module communicates with the mmcomcli.exe


Communication communication server to send mails stored
Handler in the database to the terminal, and receive
mails from the terminal and store it in the
database.

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.

28 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

Figure 6 Message Management 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.

VERICENTRE TECHNICAL REFERENCE MANUAL 29


A RCHITECTURE
Modules

The Information Collection module is comprised of:

Module Description Executable


ICM Collects information for the srstatcl.exe
configured MIs through the
Management Communication
server. The collected information
is stored in the database.

Figure 7 illustrates the working of the Information Collection module.

Figure 7 Information Collection Module

Remote The Remote Diagnostics module helps in identifying problems occurring on


Diagnostics remotely located terminals.
Module

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

30 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

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:

Module Description Executable


Threshold Analyzer Communicates with the srthanal.exe
management communication
server to collect information about
the MIs configured for automatic
diagnostics. The Threshold
Analyzer compares the collected
values with the actual values using
associated rules. If the mentioned
condition is met, it raises an alert
and performs the configured
actions.

VERICENTRE TECHNICAL REFERENCE MANUAL 31


A RCHITECTURE
Modules

Module Description Executable


Help Request Client When a help request is received TerminalMgr.exe
from the terminal, the help request
client communicates with the
management communication
server. A help request client:
• executes the queries configured
for MIs. This action involves
retrieving terminal data, applying
the query rules, displaying the
results, raising an alert, and
stating the action to be
performed.
• retrieves the values of the
application parameters from the
terminal. You can view the
system values and the values on
the terminal. If there is a
difference, you can correct the
value on the terminal.

Configuring automatic diagnostics actions


Configure an action to be performed when an MI crosses the threshold condition.
VeriCentre provides the following actions:
• Log to File
• Log into VeriCentre Database
• Log into Other Database
• Send Mail

• Log to File

VeriCentre records the MI values that cross the threshold condition in a file
selected by the user.

The action to Log to File requires the following configuration on a Windows


XP/2003 machine:
a Create a share folder on the server.
b Ensure that the server has both read and write permissions. You need to
assign read permission to the client.
To log into a remote system using UNC:

Configure the VeriCentre server:

a Create a Windows user in the same domain as the remote system.


b VeriCentre user needs to have full access permissions to the shared
folder(s) where the log files need to be created.

32 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

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.

d Restart the VeriCentre server service.


Contact your system administrator for more information on providing these
permissions to shared folders.
• Log into VeriCentre Database

VeriCentre records the MI values that cross the threshold condition in


VeriCentre database. This is a default action. You can generate reports of the
alarm logged and take preventive action for the terminal.
• Log into Other Database

VeriCentre records the MI values that cross the threshold condition in


database selected by the user.
If you change the database details, for the changes to be effective, you have
to restart RD DLL host in the Remote Diagnostics modules of all server
managers.

In case of VeriCentre for SQL Server, the pre-requisites to log into other
database are given below:

Inputs required to log into other database action in Diagnose Action


Configuration are:
• DSN, for e.g., testdsn
• Tablename, for e.g., AlarmLog
• Username, for e.g., abc
• Password, for e.g., abc

Use the following steps to configure the required inputs:


1 Create a user for other database with the following details:
• username - abc
• password - abc

2 Open the Query Analyzer and execute the following statements:


EXEC sp_addlogin 'abc', 'abc'
DROP DATABASE abc
CREATE DATABASE abc ON (NAME = abc_dat,FILENAME =
'c:\mssql7\data\abcdat.mdf', SIZE = 10, MAXSIZE = 50, FILEGROWTH
= 5)
LOG ON (NAME = 'abc_log', FILENAME = 'c:\mssql7\data\abclog.ldf',
SIZE = 5MB, MAXSIZE = 25MB, FILEGROWTH = 5MB)
USE abc
EXEC sp_adduser 'abc', 'abc', 'db_owner'

VERICENTRE TECHNICAL REFERENCE MANUAL 33


A RCHITECTURE
Modules

3 Configure the DSN (Domain Server Name) in VeriCentre servers by


supplying the user details created for the other database.

To configure the DSN:

a Click Start > Settings > Control Panel > ODBC.


b Click the Add button.
c Select SQL Server and click Finish.
d Enter the DSN name (testdsn) and a description.
e Click Next.
f Select the option With SQL Server authentication using a login ID
and password entered by user.

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.

Open Query Analyzer and execute the following statement (Italic):

EXEC sp_adduser ’xyz’, 'xyz', 'db_owner'


• Send Mail

VeriCentre sends mails and alerts to the user when the MI value on the
terminal crosses the threshold condition.

VeriCentre collects the MI values whenever the terminal is online. VeriCentre


compares the terminal values with the set threshold rules and performs the
configured action if the MI value has crossed the threshold condition.

Figure 8 illustrates the working of the Remote Diagnostics module.

34 VERICENTRE TECHNICAL REFERENCE MANUAL


A RCHITECTURE
Modules

Figure 8 Remote Diagnostics Module

Database VeriCentre uses an ODBC-compliant (Open Database Connectivity) relational


database to store the VeriCentre data. The UI and the server components use
ODBC to access the database. VeriCentre tables are created at the time of
installation.
For more details, refer to:
• VeriCentre for SQL Server and SQL Express Database Schema for,
VeriCentre for SQL Server and VeriCentre LE.
• VeriCentre for Oracle Database Schema for, VeriCentre for Oracle.
The database connection parameters are stored in the database section of
VeriCentre’s registry editor. Following are the database connection parameters:

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 35


A RCHITECTURE
Modules

36 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 2

Message Parser and Router (MPR)

This chapter describes the exchange of messages between the communication


modules and application servers.
Messages are exchanged between the communication modules and the
application servers through the Message Parser and Router (MPR). Application
servers are the application components that exchange messages with terminals.
The communication modules are responsible for transporting the messages
between the terminals and the application servers. Initial request packets from the
terminals are handed over to the MPR, which routes the messages to the various
application servers.

Components The MPR functionality is divided between the following components:


• Scheduler.exe: Schedules the packets amongst the registered application
servers.
• MsgRouter.exe: Routes valid packets to the scheduler.

Figure 9 The components of MPR


MPR consists of one COM component that handles routing, scheduling, and
formatting of packets into structures. Messages are identified by string identifiers.
Each message group has an attribute using which MPR determines whether the
message group must be formatted as a structure.

Working of Each instance of an application server that is interested in processing a message


MPR needs to register with the MPR.
The message or set of messages that the application server is interested in
receiving has to be specified using the MsgId parameter.

VERICENTRE TECHNICAL REFERENCE MANUAL 37


M ESSAGE P ARSER AND R OUTER (MPR)
Working of MPR

On receiving an initial request packet, MPR routes the message to the


applications in a round-robin fashion. Certain application servers, like the
VTServer, require the request packets in a predefined format. MPR converts the
request packets into the predefined format. The message parameter must type-
cast appropriately in the application servers. Application servers, like the
SRDServer, receive the raw initial request packet. The VID module initiates the
download by posting a request packet to the MPR. Application servers must
register for this message.
Request packets and routing information are stored in the registry (Windows
registry).

Figure 10 Exchange of Messages between the Application Server


Components and the Communication Modules

38 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 3

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.

2 Double-click CfgParamEditor.exe file.


3 Select Common from the Server drop-down list. Select one of the VeriCentre
servers from the Server drop-down list to configure parameters specific to a
server.
4 Select the parameter to be modified.

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 TECHNICAL REFERENCE MANUAL 39


TUNABLE P ARAMETERS
Configuring System Parameters

Table 3 Tunable Parameters


Category Parameter Units Default Description
Message Mail Log Status Enable Enable this option to log details of the mails
Manager On/Off sent. This log information will be used to
generate message reports.
Max Length of 100000 This is the maximum message size (in bytes)
Message Que of mail including attachment.
Maximum Mail 1 Displays the maximum number of mail
send to terminal messages sent to a terminal during a session.
Regenerate Enable Controls regeneration of terminal mails
terminal mails whenever a terminal is added to the database.
Any changes made to this, take effect
immediately.
DirectDownload DirDld_PollCounts 300 Number of times Direct Download client
should try connecting to the terminal with
specific baud rate.
DirDld_PollTimers 50 The duration in milliseconds that Direct
Download client should wait after each
connection retry.
DirDld_PollBauds 115200, Baud rate with which Direct Download client
19200, should try connecting to the terminal.
2400
Client Multi-app Export Enable Enable this option to export terminals and their
parameters from the Terminal Manager or
Terminal Editor.
Import in Disable Enable this option to import application files
Application wizard and parameter attributes using the New
Application wizard.
Parameter Auditing Enable/ Disable Enable this option to store the history of
Disable modifications performed on terminal
parameter.
Download Download Days 1 Number of days to be skipped for scheduling a
Automation schedule lag download slot from the day of check for
updates. The maximum value of this
parameter is 30 and minimum value is 1.
For example, if the value is set as 2, and terminal checks for update on 01-Jan-2006 10:00 AM,
then VeriCentre schedules a download on or after 03-Jan-2006 12:00 AM.
Generate schedule Days 60 Number of days within which VeriCentre will
count schedule a download slot from the day of
check for updates. The maximum value of
this parameter is 365 and minimum value is
30.
For example, if the value is set as 30 and terminal checks for update on 01-Jan-2006, then
VeriCentre schedules a download on or before 30-Jan-2006.

40 VERICENTRE TECHNICAL REFERENCE MANUAL


TUNABLE P ARAMETERS
Configuring System Parameters

Table 3 Tunable Parameters (continued)


Category Parameter Units Default Description
Callback Enable/ Enable • Enable this option to obtain downloads
immediate Disable immediately after the terminal checks for
availability of application updates.
• Disable this option to obtain a download
schedule. Terminal will call as per this
schedule to obtain the download.
Send Connection Enable/ Enable Enable this option to send host name (or IP
details - TCPIP Disable address) and port number of VeriCentre
server on which the download is scheduled,
along with the schedule to the terminal.
If this option is disabled, then AutoDL will use
the IP address and port number that is defined
by the AutoDL parameters,
#ADL_DL_HOST_URL and
#ADL_DL_HOST_PORT to initiate the
automated download request.
Send Connection Enable/ Enable Enable this option to send PSTN phone
details - PSTN Disable number of VeriCentre server on which the
download is scheduled, along with the
schedule to the terminal.
If this option is disabled, then AutoDL will use
the phone number that is defined by the
AutoDL parameter, #ADL_DL_HOST_PHONE
to initiate the automated download request.
Send Connection Enable/ Enable Enable this option to send ISDN phone
details - ISDN Disable number of VeriCentre server on which the
download is scheduled, along with the
schedule to the terminal.
If this option is disabled, then AutoDL will use
the phone number that is defined by the
AutoDL parameter, #ADL_DL_HOST_PHONE
to initiate the automated download request.
Send Connection Enable/ Enable Enable this option to send X.25 phone number
details - X25 Disable of VeriCentre server on which the download is
scheduled, along with the schedule to the
terminal.
If this option is disabled, then AutoDL will use
the phone number that is defined by the
AutoDL parameter, #ADL_DL_HOST_PHONE
to initiate the automated download request.
Default App Minutes 15 If the download duration is not configured for
Download Duration an application, VeriCentre will use this
configuration to calculate the number of slots
required to schedule an automated download.
The maximum value of this parameter is 120
and minimum value is 5.

VERICENTRE TECHNICAL REFERENCE MANUAL 41


TUNABLE P ARAMETERS
Configuring System Parameters

Table 3 Tunable Parameters (continued)


Category Parameter Units Default Description
All Terminal Media Comma Ethernet, This is a comma separated list of terminal
separated ISDN, download media that will be supported on
PSTN, VeriCentre. To add a new terminal download
GPRS, media that should be supported on
CDMA, VeriCentre, the same can be added at the end
Wi-Fi, of the list.
X.25
Scheduler Service Millisecond 300 Poll interval used by the VeriCentre DASWS,
Poll Timer s to check if new check for updates
requests which are to be processed are
available. The maximum value of this
parameter is 5000 and minimum value is 100.
Scheduler & Maint Primary This is the host name of the VeriCentre server
Util Server server on which DASWS and DASM job have to run.
name
DAS Server Host localhost This is the hostname of VeriCentre server on
Name which Download Automation Server web
service runs. Check update calls on Dial
media will be routed to this service to get the
download schedule.
DAS Server Port 80 This is the port on VeriCentre server on which
Download Automation Server web service
listens. Check update calls on Dial media will
be routed to this port to get the download
schedule.
Resumable Resumable Enable/ Enable Enable this option to perform resumable
Download Download features Disable downloads on this VeriCentre setup. If this
option is disabled resumable download will fail
with error 'RD NOT ENABLED'.
Split File Size Kilo Bytes 50 The compressed file will be split into segments
of this size before it is sent to the terminal. The
value is in Kilo Bytes and it can range from 10
KB to 500 KB.
RD Info Retention Hours 4 The time period to retain the resumable
Period download information to resume a failed
download. The value is in hours and it can be
any number ranging from 1 to 24.
Server Server Controller 9000 This is the port on VeriCentre server on which
Port Server Controller listens. Server Controller
controls start and stop of all VeriCentre server
modules.

42 VERICENTRE TECHNICAL REFERENCE MANUAL


TUNABLE P ARAMETERS
VeriCentre Registry Editor

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.

VeriCentre Table 4 lists the VeriCentre Environment Monitor parameters.


Environment Table 4 VeriCentre Environment Monitor Parameters
Monitor
Parameters Parameter Default Value Description
vem_Enabled 1 When enabled, VEM periodically
polls for database connectivity.
Database\vem_Connection 5 Interval, in hours, for VEM to stop
TimeoutInterval polling when the database is down.
Database\vem_Connection 5 Interval (in minutes) to check the
ConsistancyInterval database connectivity after it comes
up.
Database\vem_Connection 1 Interval (in minutes) for the VEM
RetryInterval Server service to poll for database
connectivity.

Common Table 5 describes common parameters.


Parameters Table 5 Common Parameters
Parameter Default Value Description
Path <Path name> Refers to the location of VeriCentre installation.
PrimaryServer If the value is Yes, VeriCentre server is the
primary server.
Server Enterprise Server type of the current installation.
System
Server Name <server name> The server name as it appears in the database.

Composer Table 6 describes composer parameters.


Parameters
CAUTION
The behavior of the Composer Application is not known for invalid values for the
parameters listed in Table 6 . Use the Composer Options dialog to edit these values.

VERICENTRE TECHNICAL REFERENCE MANUAL 43


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Table 6 Composer Parameters


Default
Parameter Description
Value
Authentication level While sending mails, the value set to this
parameter specifies whether user authentication
is required by an outgoing SMTP server or not.
Password User password.
SenderEmailID No E-mail ID of the sender.
SMTPServerAddr IP address of the SMTP server.
TerminalDataFile Location where the import file details are stored.
TimeLimit 5 Time (in seconds) to wait for the response from
the server.
ToTargetApplication ID of the application to which the message is
targeted.
VCMessageManagerSvr Refers to VeriCentre Message Manager server.
UserName Name of the user.
SendReceiveTimeout 10 Time-out period for Message Manager server
and client while sending and receiving mails.

Terminal Manager Table 7 describes the Terminal Manager parameters.


Parameters Table 7 Terminal Manager Parameters
Default
Parameter Description
Value
DynamicVal No If the value of this parameter is set to Yes,
terminal parameter values are dynamically
validated.
ParameterSearchEnabled Yes If the value of this parameter is set to Yes,
the parameters matching the text are
displayed in the drop down list. This is
applicable while adding new parameters to a
terminal record.
BlocksizeTerms 250 Maximum number of terminals that will be
updated to the database at a time, in batch
processing.
MaxFetchForFinder 250 For the selected find criteria, maximum
number of terminals to be displayed in the UI
initially.

44 VERICENTRE TECHNICAL REFERENCE MANUAL


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Table 7 Terminal Manager Parameters (continued)


Default
Parameter Description
Value
MaxFetchTerms 250 Maximum number of terminals to be
displayed in the UI initially.
Show_Clusters_On_Load Yes Enable this option to display all the clusters
when the user selects the Cluster view.
Disable this option to display only the Default
cluster when the user selects the Cluster
view. User can specify wild card search to
display the matching clusters.
If Portfolio feature is enabled, the clusters
that are available only to the logged-in user
are displayed.
This option can be used to speed up loading
of clusters in Cluster view, if there are a huge
number of clusters.

NOTE
If the DynamicVal parameter is modified, restart the Terminal Manager.

Database Table 8 describes the database parameters.


Parameters Table 8 Database Parameters
Parameter Default Value Description
DB_UserName VeriCentre The user name for logging into the
database.
DB_DBName VCDSN ODBC database name used by UI
components.
DB_Password Encrypted database The database password to connect to
password provided VeriCentre database.
during installation.
DB_Dsn VCDSN ODBC datasource name used by UI
components.
DB_ServerDsn VCDSN ODBC datasource name used by
VeriCentre server components to
connect to the database.
DataBaseType • Oracle (for Oracle The supported database type.
version)
• MSSQL (for SQL
Server version)
CURRENT_DATE SYSDATE The current system date identifier for
the given database.
SEPARATOR . The separator for the given database.

VERICENTRE TECHNICAL REFERENCE MANUAL 45


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Table 8 Database Parameters (continued)


Parameter Default Value Description
DB_TimeOut 40 Maximum time-out period before
canceling any database operation.
Note: Increase this parameter value
in case of slow database
connectivity.
DB_Owner VeriCentre database Database owner for VeriCentre
user name. database objects.

Download Server Table 9 describes the download server parameters.


Parameters
Table 9 Download Server Parameters
Parameter Default Value Description
Dld_LocalFactor 1 Factor for computing estimated time
from estimated size. This factor is used
for direct download.
Dld_RemoteFactor 1 Factor for computing estimated time
from estimated size. This factor is used if
the download is TID or VID.
Dld_QtmOfProg 10 Percentage by which the terminal
display shows the progress of the
download.
Dld_SendMessage Checked If the value of this parameter is set to
True, messages are displayed in
terminals.
Dld_App Tid Checked Decides whether the application name
and terminal ID are to be downloaded to
the terminals or not.
Dld_ParamDispMsg Parameters are Displays this string in the Monitor
being downloaded. window.
Dld_VfiIntern VeriTalk_CS_V100 Special VeriCentre signature for
identifying a protocol packet between the
UI and download server. Maximum size
is 30.
Note: VeriFone recommends not to
change the value of this
parameter.
Dld_ProtocolNameDial Dial The protocol name used in the Monitor
window for dial downloads.
Dld_ProtocolNameX25 X25 The protocol name used in the Monitor
window for X.25 downloads.
Dld_ProtocolNameTcp TCP/IP The protocol name used in the Monitor
for SmartNet and TCP/IP downloads.
Dld_ProtocolDirect RS-232 The protocol name used in the monitor
for direct download.

46 VERICENTRE TECHNICAL REFERENCE MANUAL


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Table 9 Download Server Parameters (continued)


Parameter Default Value Description
Dld_PListTimer 2 Timer used by the download server to
wait for Parameter List response.
Dld_EnableNonUniqueRel Unchecked Enable/disable non-unique terminal
records (Injecting Terminal IDs).
Dld_ServerName <Server name> The VeriCentre server name.
Dld_DBMessage DataBase Query If no messages corresponding to the
failed action are found in the database, the
default message is displayed on the
terminal.
Dld_MaxDldPeriod 90 Minimum period (in minutes) to wait
before re-initiating download for an
unsuccessful download attempt.
Dld_ClearLocked 30 min Interval at which the locked terminal is
TermInterval verified and cleared.
Dld_EnableStarToIPConv 1 Specifies whether to convert * sent as
the terminal ID by the PIN pad to an
internal terminal ID. Used while
performing direct download to PIN pads.
Dld_LogSolution Disabled If enabled on a failed download,
suggested action will also be logged into
the database. This log can be viewed
using download reports.
Dld_SendEnhancedMsg Disabled Send enhanced download status to
terminals in percentage.
Dld_UnzipFiles Enable Send unzip parameters to the terminals
Automatically automatically.
Dld_CmprsFileExtn .ZIP The extension of the compressed
download file.
Dld_CompressionCmd zip.exe The command for compressing the files
to be downloaded.
Dld_CompressionCmd_PKZIP pkzip.exe In case PKZIP is used as the
compression utility, rename this key to
Dld_CompressionCmd.

VERICENTRE TECHNICAL REFERENCE MANUAL 47


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Table 9 Download Server Parameters (continued)


Parameter Default Value Description
Dld_ClearBothDrives 1 Enable this parameter to clear the GID of
both RAM and FLASH even though file
is downloaded to any one of the drives.
Disabling this parameter clears only the
GID of the drive to which the file is
downloaded. Enabling or disabling this
parameter is effective only if one of the
following options is selected as pre-
download operation, or the
corresponding value for FLASH directive
is configured for a terminal.
1 Clear target GIDs or
2 Clear target GIDs and de-fragment
the Flash or
3 Enhanced Clear target GID and de-
fragment the Flash.
Dld_ZipCacheEnable Enabled Enable this parameter to cache and re-
use the zip files created on compressed
download.
Dld_ZipCacheCleanupInterval 30 Interval (in minutes) at which the cache
folder must be checked for cleanup.
Dld_ZipCacheFolderSize 100KB Maximum hard disk space that zip cache
manager can occupy.
Note: This will be verified in the
interval of
Dld_ZipCacheCleanupInterval
(minutes). If this maximum limit
exceeds, the cache is cleaned
up to ensure that only 60% of
the space is occupied. The
clean-up happens when the
download server is idle for
Dld_ZipCacheSvrIdleDuration.
Dld_ZipCacheSvrIdleDuration 15 Zip cache manager assumes the
download server is idle, if a download
has not been initiated for this duration (in
minutes).
Dld_ContinueOnTrailerError Yes Continue download on a trailer update
error during pre-compressed zip file
downloads.
Dld_UnzipFilesAutomatically Disable Sends *UNZIP parameter to the terminal
automatically.
Svr_FamNmFor53 TRANZ-420 Mapping request packet code for the
Tranz 420 terminal.
Svr_FamNmFor54 TRANZIT-1200C Mapping request packet code for the
Tranz 1200 terminal.

48 VERICENTRE TECHNICAL REFERENCE MANUAL


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Table 9 Download Server Parameters (continued)


Parameter Default Value Description
Svr_FamNmFor55 TRANZ Mapping request packet code for the
Tranz 330 terminal.
Svr_FamNmFor56 JR-XL Mapping request packet code for the
JR-XL terminal.
Svr_SpecialCharFileOnly # If security level is zero and terminal ID
contains this character, no parameters
are downloaded.
Svr_BlankPadding Enable A terminal ID can be blank padded as
part of the request packet. VeriCentre
strips the padding if the setting is
enabled.
Svr_LeadingZero Unchecked If the value of this parameter is set to
True, VeriCentre strips off the leading
zeros in the terminal ID field.

Monitor Table 10 describes the monitor parameters.


Parameters Table 10 Monitor Parameters
Parameter Default Value Description
Mon_MemoryMap MonitorMemMap Name of the file mapping object used
for monitoring.
Mon_NoOfWindows 10 Number of monitor windows that can
be opened simultaneously to store the
download details.
Mon_WindowSize 5 Number of records per window.

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 49


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Import Parameters Table 12 describes the import parameters.


Table 12 Import Parameters
Parameter Default Value Description
MaxEXPFileSizeinMB 20 Maximum size set for an .EXP file. This
parameter checks the registry of the client
for file sizes. If the file size exceeds the
value set in the registry, an error is flagged.
ParamValuesInUpper 1 • Enabled (1) - to import the parameter
Case values in upper case.
• Disabled (0) - to import the parameter
values as it is in the .EXP file, retaining
the case.

NOTE
The minimum import file size is 1 MB, and the maximum size is 100 MB. The
default file size is 20 MB.

Export Parameters Table 13 describes the export parameters.


Table 13 Export Parameters
Parameter Default Value Description
MaxTerms2Sel4Export 1000 Maximum number of terminals that can be
exported at any given time.

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.

Query Builder Table 14 describes the Query Builder parameters.


Parameters
Table 14 Query Builder Parameters
Parameter Default Value Description
QB_DbPromptSymbol & The prompt symbol configured in the database.

50 VERICENTRE TECHNICAL REFERENCE MANUAL


TUNABLE P ARAMETERS
VeriCentre Registry Editor

Trace Client Table 15 describes the Trace Client parameters.


Parameters Table 15 Trace Client Parameters
Default
Parameter Description
Value
Trc_DialInterval 2000 Polling interval (in milliseconds) for dial
download data.
Trc_LANInterval 100 Polling interval (in milliseconds) for direct
download data.
Trc_RS232Interval 500 Polling interval (in milliseconds) for RS-232
secure download data.
Trc_SNInterval 500 Polling interval (in milliseconds) for SmartNet
and TCP/IP download data.
Trc_X25Interval 1000 Polling interval (in milliseconds) for X.25
download data.

VID Server Table 16 describes the VID Server parameters.


Parameters Table 16 VID Server Parameters
Parameter Default Value Description
VTVid_Interval 1 Interval (in minutes) after which the
database is queried for the scheduled
data.
VTVid_SleepTimer 5 Interval (in seconds) between dial-outs
through the same COM port.
VTVid_ConnectTimer 1 Maximum time-out value (in minutes)
between dial-out and connect.
VTVid_TermRespTimer 1 Maximum time-out value (in minutes) for
terminal response (ENQ).
VTVid_DialAckTimer 1 Maximum time-out value (in minutes) for
an acknowledgment from the terminal.
VTVid_DldRespTimer 45 Maximum time-out value (in minutes) for a
download to complete.
VTVid_CallBackPhone None Phone number that the terminal calls for a
download.

VID Client Table 17 describes the VID Client parameters.


Parameters (VID) Table 17 VID Client Parameters
Parameter Default Value Description
VID_StatRefreshRate 1 Refresh rate (in minutes) for job
statistics.
VID_DefaultDldType F (full download) Default download type to select when
new relations are added to the VID job.
VID_Instantdld duration 1 Default duration for an operator-initiated
download job.

VERICENTRE TECHNICAL REFERENCE MANUAL 51


TUNABLE P ARAMETERS
Configuration of Portfolio Management

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.

Using the Use the following procedure to enable Portfolio Management.


PF Configuration
1 Go to the VeriCentre Bin installation directory
Utility
(...<VeriCentre Installation Directory>\Bin).
2 Double-click PFConfig.exe file.

3 Select Enable Portfolio Management check box.

4 Click OK.

A confirmation dialog appears.


5 Click Yes to enable Portfolio Management feature.

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.

VeriCentre purges logs at regular intervals. By default, purge is configured to


run at 00:00 hours every day. This is achieved through the Task Scheduler
service on Windows, and the service must be running for purging to occur.
VeriCentre installation starts the service (if not already started) and configures
the job to run at the scheduled time.

52 VERICENTRE TECHNICAL REFERENCE MANUAL


TUNABLE P ARAMETERS
Configuration of Purge

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.

To manually purge database logs:


1 Select Tools > Purge from the VeriCentre Terminal Management System to
open the VeriCentre - Purge Configuration dialog box.

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 details displayed are as follows:

VERICENTRE TECHNICAL REFERENCE MANUAL 53


TUNABLE P ARAMETERS
Configuration of Purge

• 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.

3 Change the value of the parameter in the Parameter value field.

4 Click Apply.

5 Do one of the following:

• 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.

54 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 4

Ports Used by VeriCentre

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

VERICENTRE TECHNICAL REFERENCE MANUAL 55


P ORTS U SED BY VERI C ENTRE

Table 18 Ports used by VeriCentre (continued)


Port Number Protocol Where? Description
8013 TCP Server This is a listener port on the server. This is the port
used by VeriCentre for TCP/IP downloads through
a Network concentrator like SmartNet or from
VeriFone IP terminals. This port can be changed
through the VeriCentre Communications Settings
UI. This port need not be open in the firewall if you
are not performing TCP/IP downloads.
8700 TCP Server This is a listener port on the server. The VeriCentre
Trace client connects to this port on the server to
get the Trace information from the server(s). This is
a hard coded value and it cannot be changed.
8701 TCP Server This is a listener port on the server. The VeriCentre
Initiated Download (VID) client connects to this port
on the server for initiating VID jobs from the server.
This port need not be open in the firewall if you will
not perform VID. This is a hard coded value and it
cannot be changed.
9000 TCP Server This is a listener port on the server. The VeriCentre
Server Manager client connects to this port on the
server for getting status of the server(s) as well as
for starting and stopping the server(s). This port
can be configured for any of the VeriCentre
server(s).
To configure this port:
1 Invoke System Parameters Editor utility
(VeriCentre\Bin\CFGParamEditor.exe).
2 Select the VeriCentre server (for which you want
to configure this port) from the Server drop
down list.
3 Select Server > Server Controller Port
parameter.
4 Specify a value for this port.
5 Click OK.
1521 TCP Database server Oracle Listener. Firewall should have SQLNet
(Oracle only) Proxy protocol support. This port is configurable in
Oracle listener configuration.
1433 TCP Database server SQL Server listener for connections. This is
(SQL Server) configurable in SQL Server.

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

56 VERICENTRE TECHNICAL REFERENCE MANUAL


P ORTS U SED BY VERI C ENTRE

Table 18 Ports used by VeriCentre (continued)


Port Number Protocol Where? Description
80 TCP Server This is the HTTP server port on IIS. HTTP server
listens on this port to route the Check for Update
requests from the terminal to Download Automation
Server. This port can be configured using
CFGParamEditor utility.
To configure this port:
1 Invoke System Parameters Editor utility
(VeriCentre\Bin\CFGParamEditor.exe).
2 Select the Common from the Server drop down
list.
3 Select Download Automation > DAS Server
Port parameter.
4 Specify a value for this port.
5 Click OK.
8086 TCP Primary Server License Information Manager service listens on this
port. Secondary server and client installations
connect to this port to get the licensing and
database connectivity details.

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 57


P ORTS U SED BY VERI C ENTRE

58 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 5

Algorithms

This chapter discusses the algorithms used in VeriCentre.

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

VERICENTRE TECHNICAL REFERENCE MANUAL 59


A LGORITHMS
Computation of Download Time

60 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 6

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:

.dtd file format


The .dtd file format is as follows:
<!-- VeriCentre MI data type definitions-->
<!-- Each MI set contains MI set information and one more MI categories-->
<!ELEMENT MISet (MICategory+)>
<!ATTLIST MISet
MISetNameCDATA#REQUIRED
DescriptionCDATA#IMPLIED
GUIDCDATA#REQUIRED

VERICENTRE TECHNICAL REFERENCE MANUAL 61


F ILE F ORMATS
VTMS Main UI Layout

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.

62 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
VTMS Main UI Layout

Steps to customize the VTMS UI:


1 Select Start > Programs > VeriCentre 3.0 > VeriCentre Terminal
Management System to start VeriCentre Terminal Management System.
VeriCentre login screen is displayed.
2 Login to VeriCentre by providing login credentials.

3 Right click on the panel. Context menu appears.

4 Select Options. Configure Items dialog appears.

5 The XML used to form the VTMS layout is displayed.

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.

VTMS Layout XML <MENULIST>


Format <MAINMENU NAME= "">
<MENUITEM NAME= "" DESCRIPTION= "" IMAGE= "">
<ID VALUE= ""/>
</MENUITEM>
<MENUITEM NAME= "" DESCRIPTION= "" IMAGE= "">
<ID VALUE= ""/>
</MENUITEM>
<MENUITEM NAME= "" DESCRIPTION= "" IMAGE= "">
<ID VALUE= ""/>
</MENUITEM>
<MENUITEM NAME= "" DESCRIPTION= "" IMAGE= "">
< APPLICATIONPATH PATH = "" SINGLETON = "" />
</MENUITEM>
</MAINMENU>
<OTHERCONFIGINFO TABSTRIPPLACEMENT=" " MAXFAVORITESITEM=""/>
</MENULIST>

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 63


F ILE F ORMATS
VTMS Main UI Layout

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.

Add/Modify/ Add a New Tab


Remove a Tab
In XML, add the new tab as <MAINMENU> tag. This <MainMenu> tag should be
the child of <Menulist> root tag. Specify the name of the tab as ‘name’ attribute
of the <MAINMENU> tag. The ‘name’ attribute is mandatory for <MAINMENU> tag.
Example,
<MENULIST>
< MAINMENU ......
......
......
......
</ MAINMENU >
< MAINMENU NAME="My Tab">
<MENUITEM NAME= "MyItem" DESCRIPTION= "This is the new item to be added">
<ID VALUE= "VeriCentre Standard Application ID"/>
</MENUITEM>
</ MAINMENU >
</ MENULIST >

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

corresponding <MAINMENU> tag in the XML.

Modify a Tab
You can modify the details of a tab by changing the attribute values of the
corresponding MAINMENU node

64 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
VTMS Main UI Layout

Remove a Tab
To remove a tab/item from the UI, delete the corresponding <MAINMENU> tag in
the XML file.

Add/Modify/ Add a New Item


Remove an Item in
In the XML file, add the new item as <MENUITEM> tag. This <MENUITEM> tag
a Tab
should be the child of <MAINMENU> tag corresponding to a tab to which this item
should be added.

To Add a VeriCentre Standard Application


<MAINMENU NAME= "MyTab" >
<MENUITEM NAME= "MyItem" DESCRIPTION= "This is the new item to be added">
<ID VALUE = "VeriCentre Standard Application ID"/>
</MENUITEM>
</MAINMENU>

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

VERICENTRE TECHNICAL REFERENCE MANUAL 65


F ILE F ORMATS
VTMS Main UI Layout

Table 19 VeriCentre Applications and Associated IDs (continued)


Application IDs
Message Manager ID_MESSAGE_MANAGER
Model and Application Manager ID_MODELAPP_MANAGER
Options ID_OPTIONS
Portfolio Manager ID_PORTFOLIO_MANAGER
Database Purge ID_PURGE
Report Manager ID_REPORT_MANAGER
Scheduler ID_SCHEDULER
Server Manager ID_SERVER_MANAGER
Terminal Manager ID_TERMINAL_MANAGER
User Manager ID_USER_MANAGER
View Privileges ID_VIEW_PRIVILEGES
Knowledge Base ID_VERIFONE_DEVNET
VeriFone Zone ID_VERIFONE_ZONE
Web Console ID_WEB_CONSOLE
Legacy Import ID_LEGACY_IMPORT
Legacy Export ID_LEGACY_EXPORT
Legacy file format to XML ID_ZONTALK_TO_XML_CONVERSION_TOOL
conversion tool

To Add a Windows Application


<MAINMENU name= "MyTab" >
<MENUITEM NAME= "MyPluginItem" DESCRIPTION= "This is the new plugin item
to be added">
<APPLICATIONPATH PATH= "Path of the exe" SINGLETON = "TRUE"/>
</MENUITEM>
</MAINMENU>

NOTE
‘NAME’ attribute and ‘APPLICATIONPATH’ attributes are mandatory for plug-in
applications. Image attribute is optional.

To Add a Web Application

<MAINMENU name= "MyTab" >


MENUITEM NAME= "MyPluginWebItem" DESCRIPTION= "This is the new
plugin item to be added">
<APPLICATIONPATH PATH = "http://www.yahoo.com" SINGLETON ="FALSE"/>
</MENUITEM>
</MAINMENU>

66 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
VTMS Main UI Layout

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:

VERICENTRE TECHNICAL REFERENCE MANUAL 67


F ILE F ORMATS
Import/Export File Formats

• 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:

XML File Format


for Models

The attributes of model:

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.

68 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Import/Export File Formats

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.

XML File Format


for Applications

VERICENTRE TECHNICAL REFERENCE MANUAL 69


F ILE F ORMATS
Import/Export File Formats

<Applications> The <Applications> tag element gives the details of the


group of application that needs to be imported.
<Application> The <Application> tag element gives the details about the
particular application.
<SupportedModel> The <SupportedModel> tag gives information about the
models which supports this particular application.
<Drive> The <Drive> tag element gives the details of the Files in
that drive for this particular application. Specify Type=””
for Non-Verix terminals.
<FileGroup> The <FileGroup> tag element gives the information about
the files related to that application and the GID to which
they belong. Specify GID=”” for Non-Verix terminals.
<ParamDefs> The <ParamDefs> tag element gives the information
about different parameters and their GID configured for
the application.
<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.

70 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Import/Export File Formats

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.

XML File Format


for Terminals

VERICENTRE TECHNICAL REFERENCE MANUAL 71


F ILE F ORMATS
Import/Export File Formats

72 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Import/Export File Formats

<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.

VERICENTRE TECHNICAL REFERENCE MANUAL 73


F ILE F ORMATS
Form View

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.

Application Element Attributes

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

Tab Element Attributes

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 75


F ILE F ORMATS
Form View

Control Element Attributes

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

Label Control The Label Control Element format is:


Element
<Control ID="lblHostIDs" Type="Label">
<Caption>Host ID's</Caption>
<Width>200</Width>
<Height>19</Height>
<Top>10</Top>
<Left>10</Left>
<Enabled>True</Enabled>
<Visible>True</Visible>
<Visible>True</Visible>
<Bold>False</Bold>
<Italic>False</Italic>
<Underline> False </ Underline>
</Control>

The two attributes for the Label Element are as described for control element. The
tag's elements are described as below:

76 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Form View

Label Control Element Attributes

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.

TextBox Control The TextBox Control Element format is:


Element
<Control ID="txtZT" Type="TextBox">
<Caption>*ZT Download ID:</Caption>
<CaptionLeft>280</CaptionLeft>
<DataField>*ZT</DataField>
<ToolTip>Enter the terminal's download ID</ToolTip>
<Width>100</Width>
<Height>19</Height>
<Top>10</Top>
<Left>400</Left>
<Enabled>true</Enabled>
<Visible>true</Visible>
<Bold>false</Bold>
<Italic>false</Italic>
<Underline> false </ Underline>
<MaxLength>10</MaxLength>
<RegExp>^[0-9a-zA-W]{0,10}$</RegExp>
<ErrorMessage>*ZT must be alphanumeric, 1-10 length</
ErrorMessage>
</Control>

The two attributes of the TextBox Element are as described for control element.
The tag's elements are below.

VERICENTRE TECHNICAL REFERENCE MANUAL 77


F ILE F ORMATS
Form View

TextBox Control Element Attributes

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.

CheckBox Control The CheckBox Control Element format is:


Element
<Control ID="chkAutosettle" Type="CheckBox">
<Caption>Auto-Settle</Caption>
<DataField>ASTTL1</DataField>
<BusinessRule>
[me.checked]==true && [cbManualSettle.value]>0 ?
[cbManualSettle.enabled]=true;
[txtbatchhistory.enabled]=true;
[txtbatchhistory.enabled]=true :
[cbManualSettle.enabled]=false;
[txtbatchhistory.enabled]=false

78 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Form View

</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:

VERICENTRE TECHNICAL REFERENCE MANUAL 79


F ILE F ORMATS
Form View

CheckBox Control Element Attributes

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.

DropDown Control The DropDownList Control Element format is:


Element
<Control ID="cbAMEXSetup" Type="DropDown">
<Caption>AMEX Setup:</Caption>
<CaptionLeft>10</CaptionLeft>
<DataField>AMEXTYPE</DataField>
<BusinessRule></BusinessRule>
<ToolTip>Select the AMEX type used for this terminal</
ToolTip>
<Width>120</Width>
<Height>19</Height>
<Top>90</Top>

80 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Form View

<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.

VERICENTRE TECHNICAL REFERENCE MANUAL 81


F ILE F ORMATS
Form View

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.

82 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Form View

Datagrid Control Element Attributes

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.

DataGrid Control - The format for the Column Element is:


Column Element
<Column ID="chkSelected" Type="CheckBox">
.
.
.
</Column>
Column Elements in the DataGrid Control are similar to the Control Elements in
the Tab Controls.
There are two attributes for each Column Element; they are described in the chart
below.

VERICENTRE TECHNICAL REFERENCE MANUAL 83


F ILE F ORMATS
Form View

Datagrid Control Element Attributes

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>

84 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Form View

<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>

Business Rule Property (Visible, Enabled, etc.) Related Business Rules


Elements
<Enabled>{CDT~:10}==1||{CDT~:10}==2</Enabled>

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 85


F ILE F ORMATS
Form View

MIT Element Attributes

Attribute Description
Limit Maximum number of merchants.
MerchantID The unique ID of the merchant.
MerchantName The name of the merchant.

Host Element Attributes

Attribute Description
ID The unique ID of the host.
Config The configuration name.
Name The name of the host.

Default Element Attributes

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.

86 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Form View

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 87


F ILE F ORMATS
Structure of License File

CDT Element Attributes

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.

Default Element Attributes

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>

Counted Features Number of licenses for a feature is controlled.


Following is the list of all Counted Features:
Number of servers (Server),
Number of clients (Client),
Number of terminals (Terminals),
Number of maximum concurrent downloads allowed (ConcurrentDownloads),
Number of users (Users).

Format
FEATURE <Name of the feature> VFI01 <Product version> <Type of License =
permanent/demo> <Number of licenses available>

Example FEATURE VeriCentre VFI01 7.0 permanent 1 0


FEATURE Client VFI01 7.0 permanent 255 0

88 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Structure of License File

FEATURE Server VFI01 7.0 permanent 15 0


FEATURE Terminals VFI01 7.0 permanent 1000000 0
FEATURE ConcurrentDownloads VFI01 7.0 permanent 1000 0
FEATURE Users VFI01 7.0 permanent 500 0

UnCounted Availability of license for a feature is controlled.


Features
Following is the list of all Counted Features:
• Download (DLD)
• Message Manager (MM)
• Information Collection (ICM)
• Remote Diagnostics (RD)
• Download Automation (DA)
• Portfolio Management (PF)
• X25 session support (X25)
• Database Query Utility (DbQuery)
• Database purge configurations (Purge)

Format
FEATURE <Name of the feature> VFI01 <Product version> <Type of License =
permanent/demo> uncounted HOSTID=ANY

Example FEATURE MM VFI01 7.0 permanent uncounted 0 HOSTID=ANY


FEATURE DLD VFI01 7.0 permanent uncounted 0 HOSTID=ANY
FEATURE ICM VFI01 7.0 permanent uncounted 0 HOSTID=ANY
FEATURE RDC VFI01 7.0 permanent uncounted 0 HOSTID=ANY
FEATURE DA VFI01 7.0 permanent uncounted 0 HOSTID=ANY
FEATURE PF VFI01 7.0 permanent uncounted 0 HOSTID=ANY
FEATURE X25 VFI01 7.0 permanent uncounted 0 HOSTID=ANY
FEATURE DbQuery VFI01 7.0 permanent uncounted 0 HOSTID=ANY
FEATURE Purge VFI01 7.0 permanent uncounted 0 HOSTID=ANY

VERICENTRE TECHNICAL REFERENCE MANUAL 89


F ILE F ORMATS
Report SQL and Filter XML File Format

Report SQL This section explains the XML structure.


and Filter XML
File Format

Table 20 Report SQL and Filter Structure


Report SQL and Filter XML Structure (Nodes/
Description
Attributes)
<SQLQuery> Root node of the XML.
<SELECT> Specify the columns to be displayed in the report
<Column TableName="" Field="" (fields and respective tables), their display names
DisplayName="" SelectReplace="" /> and any specific data formatting required.
... ...
</SELECT>
<FROM></FROM> Specify from which table that column belongs.
<WHERE></WHERE> Specify the where condition. Optional tag.
[<WHEREFILTER> Specify the filter controls to be displayed in the report
filter and associated fields (and respective tables) in
database. Optional tag.
<Control ControlType="" ControlId=""
Title="">
<ValueInfo Type=" " Value=" "
Dependency="" />
<ColumnToAssociate TableName=""
Field="" DataBaseFieldType=""
Operator="" ValueToCompare =""/>
</Control>
...
</WHEREFILTER>]
[<ADDITIONALCONDITIONS> Specify the additional conditions to the where
conditions. Optional tag.
<CONDITIONS Type="Enum"
ColumnToAssociate="" Value =""
ControlIdsForBinding=""
DataBaseFieldTypeToCompare=" "
Operator ="" />
...
</ADDITIONALCONDITIONS>]
[<ORDERBY> Specify the order in which rows should be shown in
the report by default. Optional tag.
<ColumnToOrderBy TableName="" Field=""
SortingType="" />
<ORDERBY>]
</SQLQUERY>

90 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Report SQL and Filter XML File Format

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(&quot;AUTODLD_SCHEDULERLOG&quot;.&quot;LOGD
ATETIME&quot;,'yyyy-mm-dd hh24:mi:ss') &quot;Check
Update Date Time&quot;" />
• <Column TableName="AUTODLD_SCHEDULERLOG"
Field="SCHEDULEDATETIME" DisplayName="Schedule"
SelectReplace=" (Case when
((&quot;AUTODLD_SCHEDULERLOG&quot;.&quot;SCHEDULEDAT
ETIME&quot; IS NULL) and
(&quot;AUTODLD_SCHEDULERLOG&quot;.&quot;VC_DLDMEDIA&
quot; IS NOT NULL)) then 'Call back Immediate' else
TO_CHAR(&quot;AUTODLD_SCHEDULERLOG&quot;.&quot;SCHED
ULEDATETIME&quot;,'yyyy-mm-dd hh24:mi:ss') end)
&quot;Schedule&quot;"/>
• <Column TableName = "TERMLOG" Field = "STATUS"
DisplayName = "Status" SelectReplace =" &quot; Status
&quot; = (Case &quot;TERMLOG&quot;.&quot;STATUS&quot;
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.

VERICENTRE TECHNICAL REFERENCE MANUAL 91


F ILE F ORMATS
Report SQL and Filter XML File Format

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'.

92 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Report SQL and Filter XML File Format

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"/>

VERICENTRE TECHNICAL REFERENCE MANUAL 93


F ILE F ORMATS
Report SQL and Filter XML File Format

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.

94 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Report SQL and Filter XML File Format

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="&gt;=" />
• <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.

VERICENTRE TECHNICAL REFERENCE MANUAL 95


F ILE F ORMATS
Report SQL and Filter XML File Format

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}
&lt;&gt; 'Success' and
{AUTODLD_SCHEDULERLOG.STATUS} &lt;&gt; '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" />

96 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Report SQL and Filter XML File Format

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 97


F ILE F ORMATS
Report SQL and Filter XML File Format

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.

98 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
Report SQL and Filter XML File Format

Sample Report
XML for Download
Log

Example

VERICENTRE TECHNICAL REFERENCE MANUAL 99


F ILE F ORMATS
Report SQL and Filter XML File Format

100 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
XML Escape Sequence

XML Escape Table 22 represents the XML escape sequences:


Sequence Table 22 XML Escape Sequence
Character XML Escape Character
quote (") &quot;
apostrophe (') &apos;
ampersand (&) &amp;
less than (<) &lt;
greater than (>) &gt;
slash (\) No escape required.
space No escape required.

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>

VERICENTRE TECHNICAL REFERENCE MANUAL 101


F ILE F ORMATS
<application name>.dld

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.

Sample .tdd A sample .tdd file is presented in Table 23 .


Table 23 Sample .tdd File
Model Application
Working directory Security type
name name
JRPLUS JRPLUS C:\ZONTALK\JRPLUS SECURE0
XL TST0002 C:\ZONTALK\TST0002\TST0002 SECURE3
XL XLDEMO1 C:\ZONTALK\XLDEMO1\XLDEMO1 SECURE1
XL XLI0001 C:\ZONTALK\XLI0001\XLI0001
XL XLDEMO2 C:\ZONTALK\XLDEMO2\XLDEMO2 SECURE2
TRANZ IND0002 C:\ZONTALK\IND0002\IND0002 SECURE3
TRANZ PRT0002 C:\ZONTALK\PRT0002\PRT0002
TRANZ INV0002 C:\ZONTALK\INV0002\INV0002
TRANZ TST0001 C:\ZONTALK\TST0001\TST0001 SECURE0
ZON XPET001 C:\ZONTALK\XPET001\XPET001
ZON SAMYS01 C:\ZONTALK\SAMYS01\SAMYS01
OMNI-380 OMNITST C:\ZONTALK\OMNITST\OMNITST
TRANZ PRT0002 \\<REMOTE MACHINE
NAME>\ZONTALK\PRT0002\PRT0002

<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>

102 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
<application name>.tdf

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.

Table 25 Example .dld File #2


Key Key Value File Type File name Other
KEY 50 4 UPDATE.OUT Included only when the terminal
has the key value configured as
50.

<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>

VERICENTRE TECHNICAL REFERENCE MANUAL 103


F ILE F ORMATS
<application name>.tdf

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.

Sample .tdf A sample .tdf file is as follows:


• X - Alpha-numeric parameter type
• N - Numeric parameter type
~0~ X20~ Download Phone No ~

~4~ N6~ Download Date ~

~5~ N4~ Message Sequence No ~

~6~ N2~ Chars To Scroll ~

104 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
<export>.exp

~7~ N1~ Multi-Trans Timeout ~

~19~ X7~ Application ID ~

~20~ X60~ Login String # 0 ~

~21~ X60~ Login String # 1 ~

~22~ X60~ Login String # 2 ~

~23~ X60~ Login String # 3 ~

~24~ X60~ Login String # 4 ~

<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>

D <F/P/FP> <parameter name> <“data”> These correspond to any


------- ditto ----------- normal parameter value.
------- ditto -----------
D <F/P/FP> <parameter name>
<“data”>

C <F/P/FP> <value of CLOCK directive>


P <F/P/FP> <values of PASSWORD directive>

VERICENTRE TECHNICAL REFERENCE MANUAL 105


F ILE F ORMATS
Extended .tdf File Format

K <F/P/FP> <value of KEY directive>


H <F/P/FP> <value of FLASH directive>
S <F/P/FP> <value of SETGROUP directive>
L <value of DIAL directive>
E <Terminal ID>

Sample Export File A sample export file is as follows:

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.

106 VERICENTRE TECHNICAL REFERENCE MANUAL


F ILE F ORMATS
<application name>.tdf

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.

Sample .tdf A sample .tdf file is as follows:


• X - Alpha-numeric parameter type
• N - Numeric parameter type
~0~ X20~ Download Phone No ~ Y

~4~ N6~ Download Date ~ N

~5~ N4~ Message Sequence No ~ Y

~6~ N2~ Chars To Scroll ~ N

~7~ N1~ Multi-Trans Timeout ~ Y

~19~ X7~ Application ID ~ Y

~20~ X60~ Login String # 0 ~ N

~21~ X60~ Login String # 1 ~ Y

~22~ X60~ Login String # 2 ~ Y

~23~ X60~ Login String # 3 ~ Y

~24~ X60~ Login String # 4 ~ N

VERICENTRE TECHNICAL REFERENCE MANUAL 107


F ILE F ORMATS
<application name>.tdf

108 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 7

Upgrading License

1 Contact the VeriCentre vendor with the following information:


• Current license key
• Company name
• Number of Clients – the total number of clients that require licenses (a
value between 1 and 255)
• Number of Terminals – the total number of terminals that can be
configured in the database (a value between 500 and 1,000,000).

TIP
When you upgrade your VeriCentre license, it is recommended that you restart all
the communication servers and VeriCentre clients.

NOTE While invoking VeriCentre, warning messages display if:


• the number of terminals configured in the VeriCentre database reaches a
certain limit of the number of licenses purchased for terminal records.

error messages display if:


• the number of terminals configured exceeds the total number of licenses
purchased.
You cannot perform any downloads once the number of terminals configured
exceeds the number of licenses purchased.
To continue with downloads, either delete some configured terminals using the
Terminal Manager/Terminal Editor or obtain additional terminal licenses from
VeriFone.

2 Close all running VeriCentre clients on all machines.

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 109


U PGRADING L ICENSE

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.

110 VERICENTRE TECHNICAL REFERENCE MANUAL


CHAPTER 8

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 27 Validations on MI Category


MI Attribute Validation
Category name Maximum 32 characters, unique in MI set.
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).

VERICENTRE TECHNICAL REFERENCE MANUAL 111


H OW TO
Validations for an MI Import

Table 28 Validations on MI (continued)


MI attributes Validation
DataType Can be of the following types:
• Counter - the data type can contain only positive numbers.
• String - the data type can contain only character strings
(default).
• Binary - the data type can contain only binary data.
AccessType Can be of the following types:
• Read only
• Read/Write (default)
• Write only
DisplayFormatString Maximum 255 characters (optional).
FetchMethod Can have one of the following values:
• Once - retrieve once.
• Once per session - retrieve once per connection (default).
• Always - retrieve always.
LowWaterMark This field is optional and should be set only when a threshold
condition is selected.
• If data type is Counter, then this field should contain a
positive number between 0– 232 - 1.
• If data type is String, then the field can contain less than
255 characters.
HighWaterMark This field is optional and should be set only when a threshold
condition is selected.
• If data type is Counter, then this field should contain a
positive number between 0–232 - 1.
• If data type is String, then the field can contain a maximum
of 255 characters.
ThresholdCondition If data type is Counter, the values can be:
• None (default)
• Equal to
• Not equal to
• Less than
• Greater than
• Less than equal to
• Greater than equal to
• Inside
• Outside
If data type is String, the values can be:
• None
• Equal to
• Not equal to
Instances • ‘Single’ (default)
• ‘Multiple’

112 VERICENTRE TECHNICAL REFERENCE MANUAL


H OW TO
Image File Conversion Format for Mails

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.

4 Check the duration of the job if a COM port is available.

5 Dial out to the terminal if the duration of the job has not elapsed.

6 Update the job status.

VERICENTRE TECHNICAL REFERENCE MANUAL 113


H OW TO
Performing a Monitor Call or an Urgent Mail Job

114 VERICENTRE TECHNICAL REFERENCE MANUAL


APPENDIX A

Errors and Troubleshooting

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 115


E RRORS AND TROUBLESHOOTING
Download Management Module Error/Information Messages

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.

116 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Download Management Module Error/Information Messages

Table 29 Download Management Module Error/Information Messages (continued)


Message
Code
Message Cause Suggested Actiona

-117 DOWNLOAD ABORTED Download was aborted by


the user.
-118 APPL NOT FOUND The requested application is Add entries to the
not present. APPLICATION table.
-119 DLD FILE ERROR DLDTABLE table contains Check FileType, SeqInfo
invalid values. and DldType fields in the
DLDTABLE table.
-120 DOWNLOAD SUCCESS
-121 WRONG DLD FILE Wrong file type specified. Check the file type in the
DLDTABLE table.
-122 DOWNLOAD FAILED Download failed. Connection might have been
broken or a validation error
has occurred.
-123 VALIDATION ERROR The request packet failed to Check whether the model,
pass all checks. application and terminal ID
exist in the relevant tables,
and that proper access
permissions are set.
-125 INVALID DL TYPE Wrong DL type specified. Check the DLTYPE field in
the download request
packet.
-126 INVALID REQ TYPE The signature in the request Check the terminal.
packet is incorrect.
-127 DL NOT ALLOWED Access code mismatch. Send the access code to the
terminal or decrease the
security type in the
APPLICATION table.
-128 DOWNLOAD DONE C Download is successfully
performed and a new
CLOCK value was sent.
-129 DOWNLOAD DONE P Download is successfully
performed and a new
PASSWORD was sent.
-130 DOWNLOAD DONE CP Download is successfully
performed, and the
PASSWORD and CLOCK
parameters were sent.
-131 APPL NOT ALLOWED The application is not Check the DLALLOWED
allowed. field in the APPLICATION
table.
-132 TERMINAL LOCKED Terminal is locked after three Set the LOCKED field to U in
consecutive unsuccessful the RELATION table.
download attempts were
made.

VERICENTRE TECHNICAL REFERENCE MANUAL 117


E RRORS AND TROUBLESHOOTING
Download Management Module Error/Information Messages

Table 29 Download Management Module Error/Information Messages (continued)


Message
Code
Message Cause Suggested Actiona

-133 RECORD LOCKED Record is locked as a Wait for a period that is


download is on going. configured in the Registry
Entry Download/
Dld_MaxDldPeriod.
-134 TERMID EXHAUSTED TERMLIST table has no Configure the terminals for
terminals configured for the the cluster using the Non-
cluster or they have been unique Terminal Records
exhausted. utility.
-135 DATABASE ERROR Database error. Restart the database.
-136 CL ACCESS OVER Cluster access count in Change the access count in
ClusterInfo is zero or NULL. the CLUSTERINFO table.
-137 APPL ACCESS OVER Application access count in Change the access count in
the APPLIST table is zero or the APPLIST table.
NULL.
-138 RECURSIVE USES Recursive or cyclic USES in Change the recursion in the
the PARAMETER table. PARAMETER table.
-139 USES NOT FOUND Terminals configured using Ensure that the USES
USES directives were not directives points to a valid
found. terminal record.
-140 DLD Disabled License for downloads has Contact VeriFone support
expired. team or upgrade the license.
-141 CMPRSN TXT ERR Cannot generate Check if the file is read-only,
compress.txt file. and whether there is write
permission for the folder or
not.
-142 COMPRESSION ERR General compression error. Check if zip.exe is on
path.
-151 518-DA LIC NOT AVAILABLE Download Automation Contact VeriCentre support
license not available team to get the license
-152 519-X25 DLD LIC NOT AVAILABLE X25 Download license not Contact VeriCentre support
available team to get the license
-153 INVALID PKT SIZE Invalid Packet size sent by Change the packet size
terminal while initiating the download
-154 RD NOT ENABLED Resumable Download not Enable it in global
enabled at the global level configuration
-155 TERM RD NOT ENABLED Terminal is not enabled for Enable the terminal for
Resumable Download Resumable Download
-156 DL RESUME FAILED Download resumption failed Contact VeriCentre support
due to internal error. This is team for troubleshooting.
during the time of continuing
the failed download

118 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Download Management Module Error/Information Messages

Table 29 Download Management Module Error/Information Messages (continued)


Message
Code
Message Cause Suggested Actiona

-157 RD FAILED Resumable Download failed Contact VeriCentre support


due to internal error. team for troubleshooting.
This is during the
Resumable download
request.
-202 Reached endtime VeriCentre job as reached its Schedule a new job.
end time.
-203 No COM ports assigned. No COM ports assigned for a Assign the COM ports for the
VID job. VID job through the VID
screen in VeriCentre.
-204 Maximum retry is over
-205 Fatal error; cannot recover Fatal error. Contact the VeriFone
support team.
-206 Job is terminated
-207 No Record to download Terminal Record has not Specify the records for the
been specified for a job. job through the VID screen,
in VeriCentre.
-208 Job started
-209 Job paused
-210 Job resumed
-211 Job aborted
-212 Job completed
-213 COM port is busy The port assigned for VID is Ensure that no other process
busy. is using the COM port
assigned to VID.
-214 Schedule time error The scheduled time is Check the start and stop
incorrect. time.
-215 Download is terminated
-216 Time-out occurred The download timed-out. Ensure that the connections
are proper.
-217 Invalid MSG type from dial Invalid messages received Ensure that the modem
from the Dial communication connectivity is proper.
module.
-218 Line disconnected Line down. Check the connection.
-219 COM port is busy The COM port assigned for Ensure that no other process
the VID job is busy. is using the COM port.
-220 Unable to connect Unable to connect. Check the connection and
the phone number.
-221 Invalid DLR message received Invalid DLR message Check the modem-related
received from the modem. configurations.
-222 PutMessage failed PutMessage call failed. Check the IPC directory for
any deletions. Restart the
system.

VERICENTRE TECHNICAL REFERENCE MANUAL 119


E RRORS AND TROUBLESHOOTING
Download Management Module Error/Information Messages

Table 29 Download Management Module Error/Information Messages (continued)


Message
Code
Message Cause Suggested Actiona

-223 Invalid go-cb-no Invalid GO/CB/NO response Check the modem


is received. parameters.
-225 No Record entry No entry in the RELATION Ensure that the proper
table for this job. terminal records are
assigned to the VID job.
-251 Could not generate a Internal error. Contact the VeriFone
temporary filename support team.
-252 Unknown IPC Fatal error. Contact the VeriFone
request.....fatal. support team.
-253 IPC getmessage failed. VIKING IPC failed. Check the IPC directory for
any deletions.
-254 Could not respond to Download Cannot communicate with Ensure all processes are
module. the Download module. running.
-255 Could not open the temporary Cannot open a temporary file Ensure that adequate
file. in the specified directory. permissions for the directory
specified for PDir in PList
section of VTALKSYS.INI
file.
-256 No parameters found for No parameters were found To add parameters, use the
Model: for the given terminal record. Terminal Manager UI.
%0 App:%1 Terminal: %2.
-257 No more memory...Fatal Error Memory exhausted. Decrease the load on the
system or upgrade the
system memory.
-258 Cannot service requests from VIKING IPC failed. Check if all processes are
Download module. running. Restart the system.
-259 User aborted program
-261 Oracle error encountered. Oracle error occurred. Contact the VeriFone
support team.
-263 Could not login to Database Logging into the database Ensure that vtdbencript
failed. has been run after changing
the database password.
-264 VeriTalk Stop.
-265 Illegal request from download Internal error. Contact the VeriFone
/ internal error. support team.
-266 Recursion in USES. Recursion occurred in the Ensure that the USES
USES directive. directive does not form a
loop in the PARAMETER
table.
-267 USES not found. USES Terminal Record does Ensure that the USES
not exist. directive points to a valid
Terminal Record.

120 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Download Management Module Error/Information Messages

Table 29 Download Management Module Error/Information Messages (continued)


Message
Code
Message Cause Suggested Actiona

-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.

VERICENTRE TECHNICAL REFERENCE MANUAL 121


E RRORS AND TROUBLESHOOTING
Download Automation

Download
Automation

Error/Information Table 30 lists the possible error/information messages from VeriCentre in


Messages response to check for updates requests. XML response from VeriCentre will
have the following error/information messages in <ErrorMessage> tag.
Table 30 Error/Information Messages for Update Requests
Error/
Information Cause Suggested Action
Message
500-INV SERIAL Input parameter serial number Check the serial number sent
NUM is invalid or not in the correct to DAS. Give in the correct
format of XYZ-XYZ-XYZ. format; XYZ-XYZ-XYZ.
501-INV REQPKT Input parameter ReqPktId is Send the valid Request
invalid and is not present in the Packet ID configured on
VeriCentre Database. VeriCentre.
502-TERM NOT Terminal information could not Send the valid Terminal ID
AVLBL be found on VeriCentre. configured on VeriCentre.
503-INV Input parameter current The terminal has to send the
TERMINAL TIME terminal date time is not in the current date time in
correct format of YYYYMMDDHHMMSS format.
YYYYMMDDHHMMSS.
504-INV NON BUS Input parameter terminal non The terminal has to send non
HRS business hour is not in the business hour in HHMM-HHMM
correct format of HHMM-HHMM. format.
505-INV TERM Input parameter Update the All Terminal
MEDIA DownloadMedium is not Media system configuration
defined in VeriCentre using the variable to include the
system configuration variable download medium sent by the
All Terminal Media. terminal.
508-SRVR NOT None of the servers are Using Download Automation
ENABLED enabled for Download Server Configuration, enable
Automation. at least one server for
Download Automation.
509-APP NOT None of the applications Using Model App Manager,
ENABLED configured for this terminal are enable the required
enabled for Download applications for Download
Automation. Automation.
510-NO UPDATES VeriCentre does not have any
AVLBL a application update available for
this terminal. Applications on
the terminal are latest.
511-INV TIME The time off-set between the Check the current date time in
OFFSET terminal and VeriCentre is more the terminal and VeriCentre.
or less than 24 hrs.

122 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Download Automation

Table 30 Error/Information Messages for Update Requests (continued)


Error/
Information Cause Suggested Action
Message
512-INSUF NON Non-business hour duration Increase the non-business
BUS HRS send from terminal is less than hour duration.
the duration of the total
applications download.
513-NO SLOTS An update is available for the Increase the value of the
AVLBL terminal; but VeriCentre is not Generate schedule count
able to find a free download slot system configuration
within the duration specified by parameter or increase the
the Generate schedule count number of ports that are
system configuration available to VeriCentre for
parameter. automated downloads.
514-UNKNOWN DASWS is not running. Start DASWS on the
ERROR VeriCentre server machine.
System configuration variable
Scheduler & Maint Util
Server indicates the host
name or IP address of the
VeriCentre server machine
where DASWS should be
running.
An internal error has occurred. Contact VeriCentre support
team for troubleshooting.
516-CALLBACK VeriCentre is processing the Terminal will contact
AFTER XXXX a request. Callback after XXXX VeriCentre after XXXX
seconds to obtain a response. seconds to obtain a response.
(XXXX indicates time in
seconds).
a. Information messages

Table 31 lists the possible error/information messages from VeriCentre in


response to automated download requests. The error/information messages will
be sent as M packets.
Table 31 Error/Information Messages for Automated Download Requests
Error/
Information Cause Suggested Action
Message
509-APP NOT None of the applications Using Model App Manager,
ENABLED configured for this terminal is enable the application for
enabled for Download Download Automation.
Automation.
510-NO UPDATES VeriCentre does not have any
AVLBL a application update available for
this terminal. Applications on
the terminal are latest.

VERICENTRE TECHNICAL REFERENCE MANUAL 123


E RRORS AND TROUBLESHOOTING
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.

124 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Download Automation

Table 32 Event Logs (continued)


Error/Information
Cause Suggested Action
Message
Service has stopped. The User tries to run the service on Stop the service on the
service cannot run on multiple multiple server machines. server specified in the
VeriCentre server machines. VeriCentre Download error message, in order
Stop the service on <Server Automation Scheduler service to start the service on
name> machine. runs on only one VeriCentre another machine.
server based on the system
configuration variable
Scheduler & Maint Util
Server.
Service started successfully.a VeriCentre DASWS started on
this machine successfully.
a. Information Message

To view the Event log messages:


1 Invoke Event Viewer from the option sequence Control Panel >
Administrative Tools > Event Viewer.
Select Application. Once the application is selected the right pane displays the
list of messages.

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.

3 Select Enable Download Automation Logs check box.

4 Close VeriCentre Registry Editor Tool.

Windows service Issue:


“VeriCentre
After upgrade from VeriCentre 2.2.2 to VeriCentre 3.0 using the Custom Option
Download
connecting to an existing VeriCentre 2.2.2 database with Download Automation
Automation
Add-on, Windows service “VeriCentre Download Automation Scheduler” will not
Scheduler” is not
running run.

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 125


E RRORS AND TROUBLESHOOTING
Message Management Module Error/Information Messages

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.

Table 33 Message Management Module Error/Information Messages


Error Message Cause/Suggested Action
Your request cannot be processed as If you are a VeriCentre user, report this
you are not a registered user. problem to VeriCentre system
administrator.
You don't have privilege to perform Contact the VeriCentre system
the requested action. administrator to verify your assigned
privileges.
Your terminal message status Ensure that the unique mail identifier is
enquiry cannot be processed as correct.
there are no terminal messages
matching the unique mail You can obtain the unique mail identifier in
identifier you specified in the the response mail sent by VeriCentre
request. host.
Your request cannot be processed as Contact VeriCentre system administrator.
you do not belong to the same group
as the originator of the requested
terminal message.
Your request for creating a Make sure that the expiry date falls after
terminal message cannot be end collection date and try again.
processed as the expiration date
falls before the end collection
date.
Your request cannot be processed Report this error to VeriCentre system
because of system error. administrator.

Information Table 34 lists error messages specific to the Information Collection module.
Collection
Module Error/
Information
Messages

126 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Information Collection Module Error/Information Messages

Table 34 Information Collection Module Error/Information Messages


Error Message Cause/Suggested Action
Invalid date. This message appears when scheduling a
monitor call job using the New Monitor
Call wizard in the Scheduler.
You may have entered an invalid date for
scheduling collection.
Provide the correct date.
Collection end date must be later This message appears when scheduling a
than or equal to the same as the monitor call job using the New Monitor
start date.
Call wizard in the Scheduler.
The collection start date entered is later
than the current time.
Provide the correct date.
Job will not run since the This message appears when scheduling a
configured Start Time is earlier monitor call job using the New Monitor call
than the current time
wizard in the Scheduler.
You may have entered a start time that is
earlier than the current system time.
Provide the correct start and end times.
Job will not run since the This message appears when scheduling a
configured End date is earlier than monitor call job using the New Monitor
the current date.
Call wizard in the Scheduler.
The collection end date that entered is
earlier than the current date.
Provide the correct date.
Monitor call job does not exist in In a multi-client environment, another user
the database. Press F5 to refresh may have deleted the selected monitor
the list.
call job.
Press F5 and refresh the list.
Unable to delete the selected In a multi-client environment, another user
monitor call job as another user is may be using the monitor call job which
editing it.
you are trying to modify.
Try modifying when the other user finishes
working on the selected monitor call job.
Invalid display format string. The display format string defined in the
Verify the XML file. XML file is incorrect.
Contact the VeriFone support team.
Invalid data received from the The data sent from the terminal does not
terminal. follow the format defined by the display
format string, in the XML file for this MI.
Contact the VeriFone support team.
Display format not defined in the There is no display format defined for this
XML file. MI in the XML file.
Contact the VeriFone support team.

VERICENTRE TECHNICAL REFERENCE MANUAL 127


E RRORS AND TROUBLESHOOTING
Remote Diagnostics 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.

128 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Monitored Item Error/Information Messages

Table 35 Remote Diagnostics Module Error/Information Messages


(continued)
Error Message Cause/Suggested Action
Communication time out The communication between VeriCentre
and the terminal timed-out at either the
terminal end or at the VeriCentre end.
Try establishing the link again.
Unable to obtain query details from In a multi-client environment, another user
the database. might have modified or deleted the query.
To refresh the query information, reload
the Terminal properties dialog.

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?

VERICENTRE TECHNICAL REFERENCE MANUAL 129


E RRORS AND TROUBLESHOOTING
Monitored Item Error/Information Messages

Table 36 Monitored Item Error/Information Messages (continued)


Error Message Cause/Suggested Action
Unable to retrieve the category In a multi-client environment, the selected
from the database. Another user category might have been deleted by
might have deleted the category.
another user. Refresh the list of available
categories.
Database error: The network connection between the
Unable to retrieve MI category VeriCentre client, and the VeriCentre
names. database server might not be working.
Check the network connections.
Database error: The network connection between the
Unable to retrieve MI category VeriCentre client and the VeriCentre
information. database server might not be working.
Check the network connections.

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.

Table 37 Monitored Item Import Error/Information Messages


Error message Cause/Suggested Action
<Element> value not specified. The XML file does not have a value in this
field.
Enter a valid value.
Invalid <Element> value: The number of characters for the selected
<Element> value must not exceed field in the XML file exceeds the allowable
<parameter> characters. maximum limit.
Invalid <Element> value: The value for the field in the XML file may
<Element> value must be a positive be less than 0.
integer.
The value should be a positive integer.
Invalid <Element> value. The value for the field in the XML file is
Valid options are: <parameter> incorrect.
Invalid <Element> value: This field in the XML file contains invalid
Valid characters are: <parameters> characters.
Category name <value> already You may have specified a name that
exists in the MI set. already exists in the MI set.
Enter a category name unique to the MI
set.
The Reference ID <value> already You may have specified a Reference ID
exists in the MI set. that already exists in the MI set.
Enter a Reference ID unique to the MI set.

130 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Monitored Item Error/Information Messages

Table 37 Monitored Item Import Error/Information Messages (continued)


Error message Cause/Suggested Action
MI name <value> already exists in You may have specified a name that
the MI category. already exists in the MI set.
Enter a MI name unique to the MI set.
This MI cannot have a high You may have entered a value for the
watermark value for the threshold higher threshold.
condition specified.
Do not enter a higher threshold value for
the selected threshold condition.
This MI must have a high watermark You may not have entered a value for the
value for the threshold condition higher threshold.
specified.
Enter a higher threshold value for the
selected threshold condition.
This MI cannot have a low watermark You may have entered a value for the
value, as there is not threshold lower threshold.
condition specified.
As there is no threshold condition
specified, you should not enter a value for
the lower threshold.
This MI must have a lower watermark You may not have entered a value for the
value for the threshold condition lower threshold.
specified.
Enter a lower threshold value for the
threshold condition.
The value for the lower watermark You may have entered an invalid value.
must be less than the value for the
high watermark. Enter the correct values for higher and
lower threshold.
Invalid value for the GUID. You may have entered an invalid value.
The valid characters are: 0-9,A- Enter the correct value for the GUID. Also
F,{}-.
ensure that this value is entered in the
proper GUID format.
For e.g., {A11D2D3F-1A49-4953-
8E4B-13A4EC553367}
Invalid Request packet ID. The You may have entered an invalid value for
valid characters are: 0-9, A-Z, a- the request packet ID.
z
Enter the correct value for the request
packet ID.
Application name <variable> cannot The application name may be starting with
start with special characters. an invalid character.
Valid characters are 0-9, A-Z, a-z
Start application name with one of the
following valid characters: 0-9, A-Z, a-z.

VERICENTRE TECHNICAL REFERENCE MANUAL 131


E RRORS AND TROUBLESHOOTING
Miscellaneous Error/Information Messages

Table 37 Monitored Item Import Error/Information Messages (continued)


Error message Cause/Suggested Action
XML file mismatch: This message appears when the name
The model name specified in the XML specified for the model in the XML file is
file differs from that specified different from that specified for the model
in the VeriCentre database. in the VeriCentre database.
Contact the VeriFone support team.
XML file mismatch: Contact the VeriFone support team.
The model, or application name
specified in the XML file differs
from that specified in the
VeriCentre database.

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.

132 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Miscellaneous Error/Information Messages

Table 38 Miscellaneous Error/Information Messages (continued)


Error Message Cause/Suggested Action
Terminal <ID> cannot be One of the terminals that you have selected for
deleted, as there is a download download has an ongoing download operation.
in progress. Continue deleting
You can delete this terminal only after the
the other terminals?
download is complete.
Click Yes to continue deleting other terminals.
The terminals that could not be deleted due to
ongoing downloads should be deleted at a
later time.
Terminal does not exist in the In a multi-client environment, another user
database. Press F5 to refresh may have deleted the terminal.
the list.
Press F5 and refresh the list of available
terminals.
Terminal <ID> is locked for In a multi-client environment, when a user is
update by another user. Try modifying a terminal, another user cannot
modifying the terminal after
modify the same terminal.
some time.
You can modify the terminal once the record
lock is removed.
Cluster does not exist in the In a multi-client environment, another user
database. Press F5 and refresh might have deleted the selected cluster.
the list.
Press F5 and refresh the list.
Default cluster cannot be There is a pre-defined cluster in VeriCentre
deleted called the Default Cluster. You cannot delete
this cluster.
Cluster is locked for update by In a multi-client environment, when a user is
another user. Try modifying the modifying a cluster, another user cannot
cluster after some time.
modify the same cluster.
You can modify the cluster once the record
lock is removed.
Select a cluster to move. When you try to move terminals from one
cluster to another, you are provided with a list
of available clusters to select from. This
message appears when you provide a Move
command without selecting a cluster.
Select the cluster that you want to move the
terminals to, and then specify the Move
command.
Cannot move as only one cluster The VeriCentre database contains only the
exists. default cluster.
Create another cluster and then move the
terminals to the new cluster.

VERICENTRE TECHNICAL REFERENCE MANUAL 133


E RRORS AND TROUBLESHOOTING
Miscellaneous Error/Information Messages

Table 38 Miscellaneous Error/Information Messages (continued)


Error Message Cause/Suggested Action
Provide a name and an ID for This message appears when you do not
the new cluster. provide a cluster name and cluster ID for the
new cluster.
When you copy a cluster, all information about
the cluster is copied except the name and the
ID.
Provide the name and ID for the new cluster.
Application does not exist for In a multi-client environment, another user
the terminal in the database. might have deleted the application from the list
To refresh the list, close and of applications configured for the terminal.
open the Terminal Properties
dialog. Refresh the list by closing and opening the
Terminal Properties dialog.
You cannot modify the terminal This message appears when you try to modify
properties since download is in the properties of a terminal that is locked for a
progress. Do you want to
download operation.
continue viewing the
properties/ Click OK to continue viewing the properties of
the selected terminal.
To modify the terminal properties, close and
open the Terminal Properties dialog once the
download is complete.
Login failed. Another instance You might have opened another instance of
is already open. the same application, and it is waiting for you
to login.
Log in from the first instance of the application.
This application name already This message appears in the New
exists in the database. Provide Application wizard.
a different name for the new
application. The application you are trying to create exists
in the database.
Provide a different application name.
This Verix application logical This message appears in the New
name is associated with another Application wizard.
application. Provide a
different name. The Verix application logical name that you are
trying to provide is associated with another
application in the VeriCentre database.
Provide another name.
Unable to create a new terminal In a multi-client environment, the selected
as the selected model has been model may have been deleted by another
deleted.
user.
Refresh the list of models. If there are no
models configured in VeriCentre, you should
create the required model, and then create the
new terminal.

134 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Debugging the VeriCentre Server and Client Modules

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.

For example, to open a Remote desktop console session in a server named


my-server, type the following command from a DOS window:

mstsc /f /console /v:my-server

To Debug the VeriCentre Download Modules


1 Download the Debug Viewer and copy the .exe file to the Windows folder.

2 Launch the VCDebugclient.exe from the VeriCentre installation Bin folder


(C:\Program Files\<VeriCentre Installation
directory>\Bin).

VERICENTRE TECHNICAL REFERENCE MANUAL 135


E RRORS AND TROUBLESHOOTING
Debugging the VeriCentre Communication Modules

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.

NOTE Refer to the online help file (dbgview.chm) available at http://


technet.microsoft.com/en-us/sysinternals/default.aspx for more information about
the DBGVIEW tool.

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).

2 Remove the # character in the Vik_Debug.ini file before you start


debugging.

136 VERICENTRE TECHNICAL REFERENCE MANUAL


E RRORS AND TROUBLESHOOTING
Debugging the VeriCentre Communication Modules

• For troubleshooting problems with the dial up (modem) communication


module, choose the CM_DIAL section.
• For troubleshooting problems with the TCP/IP communication module,
choose the CM_SN_TCPIP section.
3 Change the debug level from 0 to 1001.

4 Save the file in the same folder.

5 Restart VeriCentre. The debug file will be created in C:\debug folder or in


any other folder mentioned in the debug directory.

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 137


E RRORS AND TROUBLESHOOTING
Debugging the VeriCentre Communication Modules

138 VERICENTRE TECHNICAL REFERENCE MANUAL


APPENDIX B

‘Check for Updates’ Request and Schedule Response Formats

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 139


‘C HECK FOR U PDATES ’ R EQUEST AND S CHEDULE R ESPONSE F ORMATS
Format of ‘Check for Updates’ Request Over Dialup and X.25 (XCU calls)

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.

Schedule VeriCentre sends a HTTP response in the following format:


Response HTTP/1.1 200 OK
Format Server: Microsoft-IIS/5.0
Date: Fri, 22 Apr 2005 07:01:45 GMT
X-Powered-By: ASP.NET
X-AspNet-Version: 1.1.4322
Cache-Control: private, max-age=0
Content-Type: text/xml; charset=utf-8
Content-Length: 226
<Blank line>
<?xml version="1.0" encoding="utf-8"?>
<VeriCentre>
<DownloadSchedule>
<ErrorMessage>ErrorMessage</ErrorMessage>
<NextScheduleDateTime>NextScheduleDateTime</NextScheduleDateTime>
<IPAddress>IPAddress</ IPAddress >
<Port>Port</Port>
<DialPrefix>DialPrefix</DialPrefix >
<Phone>Phone#</ Phone >

140 VERICENTRE TECHNICAL REFERENCE MANUAL


‘C HECK FOR U PDATES ’ R EQUEST AND S CHEDULE R ESPONSE F ORMATS
Schedule Response Format

</DownloadSchedule>
</VeriCentre>

The response has the following structure:


• Status line
• Headers
• Blank line
• Message Body

Schedule details are sent as a part of the message body, where:

ErrorMessage Error message, if any.

NextScheduleDateTime Date and time when the terminal should call DAS to
obtain download, in YYYYMMDDHHMMSS format.

IPAddress IP address of VeriCentre communication server.


Terminal requires to connect to this IP address to
obtain automated download over TCP/IP.

Port Port of VeriCentre communication server. Terminal


requires to connect to the mentioned IP address and
port to obtain automated download over TCP/IP.

DialPrefix In case of automated downloads over Dial/X.25,


DialPrefix + Phone is used to identify the
VeriCentre phone number.

Phone Phone number of VeriCentre communication


server for automated downloads over Dial/X.25.

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>.

VERICENTRE TECHNICAL REFERENCE MANUAL 141


‘C HECK FOR U PDATES ’ R EQUEST AND S CHEDULE R ESPONSE F ORMATS
Schedule Response Format

142 VERICENTRE TECHNICAL REFERENCE MANUAL


APPENDIX C

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

VERICENTRE TECHNICAL REFERENCE MANUAL 143


D IRECTIVES

Table 41 Directives (continued)


Directives Usage
USES A valid value of the USES directive refers to another terminal of the
same family and application. The presence of a valid value causes
all the parameters of that terminal to get included for download at
this point. The terminal that has the USES directive in its terminal
record is referred to as the using terminal. The value of the USES
directive is the terminal ID of the used terminal. The used terminal
can use another terminal, and so on, to a nested level of 8.
Recursion is not allowed, that is, if terminal T1 uses terminal T2,
then terminal T2 should not use terminal T1.
You can use the uses check utility to check the validity of the USES
directive.
Use the USES directive to manage parameters that are common to
a set of terminals.
Configure all the common parameters in a dummy terminal, for
example, VISA1, (possibly assigned to the DEFAULT cluster, to
distinguish it from real terminals). Then, include a USES VISA1
parameter in all the terminal records that should receive the
parameters configured in VISA1.
Changes to the used terminal record will affect only the next
download to any of the using terminals. Thus, the effective usage of
USES directive helps keep the size of the database small, and
allow dynamic management of a group of terminals.
Example:
Consider the terminal record F1, A1, T1 having parameters:
REM Parameters of T1
CLOCK FP +5
0021 P “value for 21”
REM End
Consider the terminal record F1, A1, T2 having parameters:
REM Parameters of T2
USES FP T1
0019 F A1
REM End
If the terminal record F1, A1, T2 is receiving a FULL download, then
the parameters that get downloaded to T2 are:
CLOCK +5 (from T1)
0019 A1
If terminal record F1, A1, T2 is receiving a PARTIAL download, then
the parameters that get downloaded to T2 are:
CLOCK +5 (from T1)
0021 “value for 21” (from T1)

144 VERICENTRE TECHNICAL REFERENCE MANUAL


D IRECTIVES

Table 41 Directives (continued)


Directives Usage
KEY This is a powerful directive that allows files to be selectively
downloaded to a terminal. An application can have one or more
files associated with it. Optional keys can be assigned to some of
these files, so that only terminals with the corresponding keys in
their terminal record will receive the files.
Example:
Consider application A1 with files configured for download as (only
fields relevant to the key are mentioned):
DldType KeyVal SerFileNm
F GeneralFull.OUT
FP FM1 First.out
Note: Dldtype is
irrelevant if KEY
is present,
default FP.
FP FM2 Second.OUT
And two terminals T1 and T2 of the same application A1:
T1:
KEY F FM1
KEY P FM2
T2:
REM No Parameters
On full download, T1 receives GeneralFull.out and
First.out. T2 receives GeneralFull.out.
On partial download, T1 receives GeneralFull.out and
Second.out. T2 does not receive any files since the files in
DLDTABLE do not match the type of download requested.
SETGROUP This is a directive that allows the user to specify the GID (Group ID)
to which terminal parameter has to be downloaded. All the
subsequent parameters that are configured for the terminal record
will be downloaded to the GID specified by the value of this
directive.
FLASH This is a directive that allows the user to specify the Flash Coalesce
option for a terminal record.
This directive can be used while configuring records for terminals
that support Verix protocol.

VERICENTRE TECHNICAL REFERENCE MANUAL 145


D IRECTIVES

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.

146 VERICENTRE TECHNICAL REFERENCE MANUAL


GLOSSARY

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 147


G LOSSARY

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

And two terminals T1 and T2 of the same application A1:


Flash Coalesce Allowing files to grow automatically on
the terminal can cause fragmentation of those files if a T1:
large number of files share the same disk. The Flash co-
KEY F FM1
alesce operation is used to de-fragment the files.
KEY P FM2
Full Download All files and parameters for an applica- T2:
tion marked with F or FP get downloaded to the terminal. REM No parameters

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

148 VERICENTRE TECHNICAL REFERENCE MANUAL


G LOSSARY

to this key value. communicate between VeriCentre and a terminal. A pro-


tocol is pre-defined for a terminal and includes specifica-
LRC Longitudinal Redundancy Check is an error check tions for port settings, baud rate, file format and packet
performed on incoming and outgoing data. format.

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.

VERICENTRE TECHNICAL REFERENCE MANUAL 149


G LOSSARY

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.

TCP/IP LAN A LAN supporting TCP/IP communications


protocol.

Terminal-initiated download Downloads initiated by


the terminal, where the terminal dials the PC with Veri-
Centre installed on it, and sends a request packet. This
packet is processed by VeriCentre and a download is ini-
tiated over the telephone line to the terminal.

Timers A set of time-out values used by different stages


of link protocol to recover from protocol failures. Each set
of time limits that you configure is saved as a timer. The
timers follow a communications protocol defined by VISA
International for financial transactions using the ISO 1745
character set and VISA defined message formats.

In VeriCentre, two sets of timer values are defined.

• USVISA - defined for the US region.


• EMEAVISA - defined for the EMEA region.

Trace A record of all the data coming in or going out of a


given port.

Transaction An exchange between a program on a lo-


cal system and a program on a remote system that ac-
complishes a particular action or result.

Unique Mail ID (UMID) The unique 10-digit ID of the


message created and sent by a user in the Message ID
column. The first two digits of the message ID represent
the year the message was created. The remaining digits
are generated by a sequence generator.

USES A USES directive in a terminal implies that the se-


lected terminal uses the parameter values of another ter-
minal. The USES directive is helpful while configuring
multiple terminals.

150 VERICENTRE TECHNICAL REFERENCE MANUAL


G LOSSARY

VERICENTRE TECHNICAL REFERENCE MANUAL 151


VeriFone Systems
2099 Gateway Place, Suite 600
San Jose, CA, 95110 USA
(800) VeriFone (837-4366)
www.verifone.com

VeriCentre
Technical Reference Manual

VeriFone Part Number 53040, Revision G

You might also like