Knwledge Base Article Crystal Matrix Interface Cmparisn TCP/IP vs. SDK Cpyright 2008-2012, ISONAS Security Systems All rights reserved
Table f Cntents 1: INTRODUCTION... 3 1.1: TCP/IP INTERFACE OVERVIEW:... 4 1.2: SDK-BASED INTERFACE OVERVIEW:... 4 2: DIFFERENCE BETWEEN SDK AND TCP/IP OPTIONS... 5 2.1: MAKING THE DECISION ON WHICH OPTION TO USE.... 5 2.2: INITIAL IMPLEMENTATION.... 5 2.2: SIX MONTHS LATER (VERSION 2).... 6 2.3: SUMMARY.... 7 Dcument Versin ( KBA0040InterfaceCmparisn.Dc ) Date f Revisin Revisin Authr Descriptin 1/3/2008 1.0 Shirl Jnes Initial Release 1/18/2008 1.0.1 Shirl Jnes Minr changes frm user reviews
1: INTRODUCTION The ISONAS Crystal Matrix Sftware supprts a number f methds t interface the access system with exterir systems. The vast majrity f interface prjects use ne f tw interface ptins. This dcument utlines these tw chices, and thrugh an example describes where each ptin is apprpriate. In this dcument, we will reference t the tw systems invlved as: ISONAS System & Assciated System The tw interface methds that we will fcus n are the TCP/IP interface, and the Sftware Develpment Kit (SDK). Belw are tw diagrams, shwing a typical netwrk tplgy used with the tw ptins. When the TCP/IP interface is used, the ISONAS System hst manages the site s installed reader-cntrllers. The Assciated System transmits cmmands and data t/frm the ISONAS System hst. If the TCP/IP interface was cnnecting a Human Resurces system t the ISONAS System, then this data frm the HR system may be a new persnnel recrd fr the ISONAS System t add t the ISONAS databases If the TCP/IP interface was cnnecting a Vide Management System t the ISONAS System, then this data may be event data cming frm the ISONAS System that the Vide Management System uses t bkmark related vide clips. SDK vs TCP/IP Cmparisn 3
When the SDK is used, the Assciated System makes all the decisins, and handles all the lw-level cmmunicatins with the netwrk f reader-cntrllers. The ISONAS hst is nt invlved. The Assciated System will need t have persnnel databases, scheduling databases, and a database f the reader-cntrllers. A Building Cntrl System might use the SDK t cntrl the reader-cntrllers directly frm the Building Cntrl sftware. 1.1: TCP/IP INTERFACE OVERVIEW: 1. When using the TCP/IP interface, the ISONAS Server prvides the access cntrl lgic. It s prgrams and databases handle the details f wh is admitted, when they are admitted, and where they are admitted. 2. The ISONAS Server prvides the cmmunicatins functinality. The Assciated System des nt have t wrry abut handling the IP traffic t/frm the reader-cntrllers. The ISONAS Server prvides heartbeats, IP message retries, and manages the IP scket cnnectins. 3. The message structure used between the Assciated System and the ISONAS System cnsists f easy t read, text-based messages. a. Fr Example, if the Assciated System is requesting that the Frnt Dr t be pened, the syntax f the request wuld read: <ADMIT><FrntDr> 4. This is an easy slutin fr the Assciated System t implement. This interface has a simple message frmat. The Assciated System nly needs t implement the features that it requires cntrl ver, nt all the functinality that the reader-cntrllers require. 1.2: SDK-BASED INTERFACE OVERVIEW: 1. The ISONAS reader-cntrllers are used, but the Assciated System supplies all the server-based sftware functinality. The Assciated System understands the basic access cntrl cncepts related t wh/where/when access is granted. 2. The Assciated System cmmunicates with the ISONAS reader-cntrllers using the messaging structure defined within the SDK. These messages are designed t cnserve netwrk bandwidth, s they are shrt, binary messages. 3. Fr mst applicatins, the reader-cntrller s standalne mde is an imprtant reliability feature. In these cases, the Assciated System maintains and updates the reader-cntrller s n-bard standalne databases. 4. Deplyment may be simplified. By eliminating the ISONAS hst, the number f cmpnents that need installatin is reduced. This may als simplify Using the ISONAS Reader-cntrller s TTL Leads 4
custmer training, since they nly need t be trained n ne system. 2: DIFFERENCE BETWEEN SDK AND TCP/IP OPTIONS 2.1: MAKING THE DECISION ON WHICH OPTION TO USE. Hw d yu make the decisin n which interface t use, the TCP/IP interface r the SDK? T help illustrate the advantages f the tw ptins, we will fllw a fictinal example cmpany thru their implementatin prcess. Clck-In, Inc is a time and attendance sftware cmpany. They are lking t expand the flexibility and cst-effectiveness f their prduct line, by adding supprt fr the ISONAS IP reader-cntrllers. They have reviewed these tw interface ptins, and because f required delivery schedule, and limited availability f develpment resurces, have decide t implement this integratin thrugh the use f the TCP/IP interface. 2.2: INITIAL IMPLEMENTATION. The functinality Clck-In is implementing includes: The Clck-In sftware maintains the master persnnel database, and the TCP/IP interface is used t update the ISONAS persnnel database frm the Clck-In system. TCP/IP cmmands are used t add/change/delete specific persnnel entries in the ISONAS database. A persnnel data purge-and-resync prcess will be implemented t purge the ISONAS persnnel file, and then re-ppulate it with data frm the Clck-In database. This functinality is used during initial system implementatin and as a fall-back methd t re-sync the tw system s databases. The ISONAS System will ntify the Clck-In sftware whenever peple present their badges t the ISONAS reader-cntrllers. The Clck-In sftware will use that infrmatin t update its attendance database. This prject s implementatin is straightfrward. The Clck-In sftware s interface establishes an IP scket cnnectin t the ISONAS system, and text-based cmmands are used between the tw systems. Clck-In is able t quickly annunce that their system is nw available with a 100% IP and PE slutin set. SDK vs TCP/IP Cmparisn 5
2.2: SIX MONTHS LATER (VERSION 2). Clck-In has installed their IP-based slutin at a number f their custmer sites. The market acceptance has been great. But like always, the custmers are asking fr mre. T address these needs, Clck-In designs a simple cmpanin mdule t the ISONAS reader that gives the user feedback t their status when they punch-in. If the user is n-time, then ne sund is prduced by the cmpanin device. If the user is either t early r t late, then the cmpanin device prduces anther sund. The reader-cntrller is able t prvide plenty f pwer fr this cmpanin device. The reader-cntrller s input & utput lines can be used t cntrl the cmpanin device, but it is determined that the lgic required t cntrl the device is nt cnvenient t implement when using the ISONAS sftware. In additin, after installing a number f sites, it is recgnized that by eliminating the ISONAS sftware at the custmer s lcatin, there will be ne less area requiring training fr the installers and end-users. S, Clck-In develps Versin 2 f their interface, which will directly cntrl the reader-cntrller frm within the Clck-In sftware. With this implementatin, Clck-In has full cntrl f the actins f the reader-cntrller. This integratin will be dne using the messaging structure that is described in the ISONAS SDK. Using the ISONAS Reader-cntrller s TTL Leads 6
The Clck-In sftware will be respnsible fr a number f huse-keeping tasks that the ISONAS sftware was previusly handling. These include: Establish and maintain a TCP/IP Scket cnnectin t each reader-cntrller Peridically send a heartbeat message t each reader-cntrller. If stand-alne peratin is t be supprted, be able t maintain the readercntrller s stand-alne databases. The Clck-In sftware will be respnsible fr a mre detailed handling f the actins f the reader-cntrller. Fr example, when a dr is unlcked, there are a grup f micr-actins that ccur. The Lwer LED is turned Green The Lck Cntrl Relay is activated A delay fr the Latch Interval ccurs The Lwer LED is turned Red The Lck Cntrl Relay is deactivated. Previusly, when Check-IN was using the TCP/IP interface, this actin was a single cmmand, and the ISONAS sftware tk care f the micr-actins. Nw the Clck- In sftware must implement and cntrl these micr-actins. S Clck-In s sftware is a little mre invlved than befre, but this allws the Clck-In sftware t cntrl the reader-cntrller with fine granularity. Fr example, it has full cntrl f the reader-cntrller s TTL utput lines, which are used t cntrl the cmpanin device s sund generatin. 2.3: SUMMARY. The TCP/IP interface is a gd chice if the assciated system des nt need the reader-cntrller t implement special nn-standard actins. Using the TCP/IP interface results is a faster implementatin and is typically easier t accmplish. The integratin using the SDK is attractive if the assciated system already has all the required wh/where/when databases, and there is need fr either mre detailed cntrl f the reader-cntrller s actins r a simplified installatin tplgy at the custmer s site. SDK vs TCP/IP Cmparisn 7
Fr mre infrmatin: Web: www.isnas.cm E-mail: sales@isnas.cm Tel: 800-581-0083 x102 (tll-free) r 303-567-6516 x102 (CO) Fax: 303-567-6991 ISONAS Headquarters: 4720 Walnut Street, Suite 200, Bulder, Clrad 80301 USA Using the ISONAS Reader-cntrller s TTL Leads 8