Preface

The ADK TMS Agent is part of an Estate Management system called Verifone Estate Manager. It is a client side terminal application that communicates with the TMS server and runs in the background through its own communication channel. The ADK TMS Agent sends and receives various messages in performance of managing the device. It periodically sends a heartbeat message to indicate to the TMS Server the device is active and communicating. This document describes the functionality of ADK TMS Agent and provides the steps to install and configure for various supported platforms.

 


This guide provides the information required for application developers to install and utilize the functionality of the ADK TMS Agent.


This guide is organized as follows:

Overview. Provides a summary and architecture of ADK TMS Agent.

Installation and Configuration. Shows the steps for installing and setting up ADK TMS Agent.

Automated Download Bundle Creation. Discusses the download bundles for ADK TMS Agent.

Maintenance Window, Heartbeats and Events. Supplies information on ADK TMS Agent Maintenance Window, Heartbeat and Events.

Downloads. Presents details on downloading ADK TMS Agent.

Diagnostics. Gives diagnostics support for ADK TMS Agent.

Application Integration with ADK TMS Agent. Shows how to integrate different OS versions with ADK TMS Agent.

Content Management. Discusses application updates for ADK TMS Agent.

System Mode Functionality. Gives a brief list of System Mode functions available for ADK TMS Agent.

Multi-Server Support. Presents multi-server support for ADK TMS Agent.

ADK TMS IP Over USB Overview. Shows the information on implementing IP over USB for ADK TMS Agent.

Capturing Logs. Discusses the procedures for downloading and investigating error logs.

ADK TMS Agent Troubleshooting. Provides resolutions for some ADK TMS Agent issues you may encounter.

Appendix A, ADK TMS Agent Configuration Parameters. Gives ADK TMS Agent configuration parameters.

Appendix B, ADK Communication Options. Presents a brief discussion of ADK TMS Agent communication options.


To learn more about the ADK framework, please refer to the following documents and their associated Verifone Part Numbers (VPN):

DocumentVPN
mADK PINPad Interface API Programmers Guide VPN DOC00660
ADK EMV Contact Programmers Guide VPN DOC00661
ADK EMV Contactless Programmers Guide VPN DOC00662
ADK GUI Programmers Guide VPN DOC00663
ADK Communication Service Programmers Guide VPN DOC00664
ADK EVENT Programmers Guide VPN DOC00665
ADK Import-Export Utility Programmers Guide VPN DOC00666
ADK Information Service Programmers Guide VPN DOC00667
ADK IPC Programmers Guide VPN DOC00668
ADK Logging Programmers Guide VPN DOC00669
ADK MSR Programmers Guide VPN DOC00670
ADK HTML PRINTER Programmers Guide VPN DOC00671
ADK Security Programmers Guide VPN DOC00672
ADK SYS Programmers Guide VPN DOC00673

Please refer to the document conventions for quickly identifying special formatting. The following table describes these conventions and provides examples of their use.

Table 1: Document Conventions

ConventionMeaningExample
Blue Text in blue indicates terms that are cross-references. See Guide Conventions.
Italics Italic typeface indicates book titles or emphasis. You must not use this unit underwater.
NOTE
01 agt note
The pencil icon is used to highlight important information. RS-232-type devices do not work on this communication port.
CAUTION
02_agt_caution.png
The caution symbol indicates hardware or software failure, or loss of data. The unit is not waterproof or dustproof, and is intended for indoor use only.
WARNING
03_agt_warning.png
The lighting symbol is used as a warning when bodily injury might occur. Due to risk of shock do not use the unit near water.

Please refer to Acronym Definitions table for the acronyms used in this manual.

Table 2 Acronym Definitions

AcronymDefinitions
3DES Triple DES encryption
ADK Application Development Kit
AES Advanced Encryption Standard
API Application Programming Interface
CRC Cyclical Redundancy Checking
DES Data Encryption Standard
DUKPT Derived Unique Key Per Transaction Method
EMV Europay, Mastercard and Visa
GISKE Global Interoperable Secure Key Exchange
GUI Graphical User Interface
HSM Hardware Security Module
IPC Inter Process Communication
KLK Key Loading Key
KSN Key Serial Number
MAC Message Authentication Code
OS Operating System
PED PIN Entry Device
PIN Personal Identification Number
POS Point-of-Sale
RSA Rivest-Shamir-Adleman
TAK Terminal Authentication Key
TMK Terminal Master Key
TPK Terminal PIN Key
UI User Interface
UID Unique Identifier
V/OS Verifone Operating System
VPN Verifone Part Number
VSS VeriShield Security Scripts