Data Connect Manual

8/10/2019 Data Connect Manual

1/44

Data Connect Manual,

Issue 6.0.2

SECURITY MANAGEMENT SYSTEM

9600-0458


2/44

Group 4 Technology 2007

All rights reserved. No part of this publication may be reproduced in any form without the written permission of

Group 4 Technology.

Group 4 Technology cannot be held liable for technical and editorial omissions or errors made herein; nor for

incidental or consequential damages resulting from the furnishing, performance or use of this material.

NOTE:This equipment has been tested and found to comply with the limits for a Class A digital device,

pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against

harmful interference when the equipment is operated in a commercial environment. This equipment

generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with

the instruction manual, may cause harmful interference to radio communications.

Operation of this equipment in a residential area is likely to cause harmful interference. In which case, the

user will be required to correct the interference at his own expense.

Data Connect Manual

(9600-0458)

Issue 6.0.2 30th January 2007Applies to version 6.0.2 or later of the SMS Software, until superseded by a later issue of the manual.

All trademarks acknowledged.

Microsoft and Windows are registered trademarks of Microsoft Corporation.

Image compression software is based in part on the work of the Independent JPEG Group.


3/44

Data Connect Manual i

Contents

1 Preface ................................................................................................. iiAbout this Manual................................................................................................................................. ii

2 Chapter 1: Importing Card Data............................................................1Introduction.......................................................................................................................................... 1Data Import Screen............................................................................................................................. 2The Import Process............................................................................................................................. 3Additional Data Maintained by the SMS Software............................................................................... 4Record Request Field.......................................................................................................................... 4

RecordRequest = 0 (Add/Modify) ................................................................................................. 4RecordRequest = 1 (Modify)......................................................................................................... 5RecordRequest = 2 (Make Inactive) ............................................................................................. 6RecordRequest = 3 (Add Access Rights) ..................................................................................... 6RecordRequest = 4 (Remove all Access Rights) ......................................................................... 6RecordRequest = 5 (Reactivate Card) ......................................................................................... 6RecordRequest = 6 (Remove Individual Access Rights).............................................................. 6

RecordRequest = 42 (Delete) ....................................................................................................... 7Password Encryption........................................................................................................................... 7

Example........................................................................................................................................ 7

3 Chapter 2: Exporting Card Data............................................................9Introduction.......................................................................................................................................... 9Data Export Screen........................................................................................................................... 10

4 Chapter 3: Importing Card Data into the CCH Database ....................11Introduction........................................................................................................................................ 11

Data Import Screen .................................................................................................................... 12Region Definition Screen ............................................................................................................ 12

5 Chapter 4: Importing Transaction Data ...............................................13

A Appendix A: SQL Database Formats for Card Data Import.................14SQL Server - DataImportTable ......................................................................................................... 14SQL Server - VisitorDataImportTable ............................................................................................... 16SQL Server - MessageTable............................................................................................................. 19SQL Server - ReaderGroupTable ..................................................................................................... 20SQL Server - TimeCodeTable........................................................................................................... 20SQL Server - AccessCodeTable ....................................................................................................... 20SQL Server - ReaderTable ............................................................................................................... 20SQL Server - CardFingerprintTemplateImportTable......................................................................... 21SQL Server - VersionTable............................................................................................................... 21SQL Server - CompanyTable............................................................................................................ 21SQL Server BadgeFormatIDTable ................................................................................................. 21

B Appendix B: ASCII Database Formats for Card Data Import...............22Import.txt ........................................................................................................................................... 22VisitorImport.txt ................................................................................................................................. 25Reader.txt.......................................................................................................................................... 27ReaderGp.txt..................................................................................................................................... 27TimeCode.txt..................................................................................................................................... 28AccessCd.txt ..................................................................................................................................... 28Company.txt ...................................................................................................................................... 28Badge.txt ........................................................................................................................................... 28


4/44

About this Guide

ii Data Connect Manual

Message.txt........................................................................................................................................28Export.txt and VisitorExport.txt...........................................................................................................29

C Appendix C: SQL Database Formats for Card Data Export................ 30SQL Server - DataExportTable ..........................................................................................................30

D Appendix D: ASCII Database Formats for Card Data Export.............. 33Exported Import.txt.............................................................................................................................33

E Appendix E: SQL Database Formats for CCH Card Data Import........ 36SQL Server - DataImportTable ..........................................................................................................36SQL Server - MessageTable .............................................................................................................38SQL Server - VersionTable................................................................................................................39SQL Server BadgeFormatIDTable..................................................................................................39

F Appendix F: SQL Database Formats for Transaction Data Import ..... 40SQL Server - TxnImportTable............................................................................................................40

1 Preface

About this Manual

This guide explains how to import and export data to and from the Security Management System (SMS)software.

This guide is intended to be of use to personnel who are responsible for interfacing third-party systems withthe SMS software through the import/export databases documented in this manual.

This document is supported by context-sensitive online help available from the SMS software.


5/44

Data Connect Manual 1

2 Chapter 1: Importing Card Data

Introduction

This chapter describes how to import details of card holders or visitors from a third-party system into thesecurity management system (SMS). The following diagram illustrates the process.

Note: Please refer to Chapter 3 if you want to import card details for use at a Central Card Handler Client.

Importing Card Details

Third-PartySystem

SMSSoftware

Import database

The third-party system exports card data (e.g. person's

name, card number, personal data, reader group and timecode, etc.) to an import database.

The database can be an SQL Server database or an ASCIIdatabase. The required format of the database isdescribed in this manual. The type of database to usemust be specified during the installation of the SMSsoftware. The ASCII database is stored by default on the

database machine in the Import subfolder (e.g. c:\ProgramFiles\Security Management System\Import).

The SMS software reads the database and creates or modifiesthe card record. The import process can be controlled by theData Import screen in the Tools menu. If an SQL database is

used, records can be imported automatically by setting theImportNow field to 1 in the Import database.


6/44

Importing Card Data

2 Data Connect Manual

Data Import Screen

Note: Refer to the Online Helpfor full details of how to use the Data Import screen.

You can use the DataImport screen in the ToolsMenu to carry out a dataimport immediately.

If you are using an SQL Serverdatabase, you can carry out the dataimport automatically at regularintervals.

A password, if specified,prevents unauthorizedrecords in the database frombeing imported.

Database housekeepingoptions are provided.

This shows the number of

records to be imported.

You specify the file(s) toimport here.


7/44

Importing Card Data


The Import Process

Note:

Refer to the appropriate appendix for details of the required format of the import database. Atemplate database is generated when the software is installed.

The ASCII import database is located by default in the Program Files\Security ManagementSystem\Import subfolder on the database machine and may be changed.

During a data import, the following events take place:

1. The SMS software reads the card details in the import database.

When using an SQL Server database, these must be stored in the table named:

DataImportTable For card holdersVisitorDataImportTable For visitors

When using an ASCII text file database, the import database must be named:

Import.txt For card holders

VisitorImport.txt For visitors

2. If a password is specified in the Tools/Data Import screen, the SMS software checks the encryptedpassword in the import database. The system will process a record in the import database only if theencrypted password is correct (see Password Encryptionon page 7).

3. The RecordRequest field in the import database (seepage 4)specifies whether to add the details ofa new card, modify the details of an existing card, make the card inactive, add additional accessrights, remove all access rights, reactivate the card or delete the card. The SMS software carries outthe requested action.

4. The system reads face and signature images, which must be JPEG files stored in the \Security

Management System\Import\Faces and \Security Management System\Import\Sigs folders on thedatabase machine. Note: ensure that each file has a .jpg file extension.

5. ASCII database only: when all records in the import database (Import.txt and VisitorImport.txt) havebeen processed, each record is added (concatenated) to a file called Export.txt or VisitorExport.txt in\Security Management System\Import on the database machine or the other selected folder. All therecords in Import.txt or VisitorImport.txt are deleted.

6. The SMS software updates the RecordStatus field in the SQL Server database, Export.txt orVisitorExport.txt (as appropriate) to specify whether importing of the card record was successful orunsuccessful. There are several status codes for different error conditions.

The meaning of each status code is stored in a table called MessageTable (SQL Server database) or

in a text file called Message.txt (ASCII database). Message.txt is stored in the Security ManagementSystem\Import folder.


8/44

Importing Card Data


Additional Data Maintained by the SMS Software

The SMS software maintains the following information, which should be used by the third-party applicationwhen adding the card records to the import database:

Company names. Whenever a new company is added or its name changed, the SMS softwarewrites the company details to a table called CompanyTable (SQL Server database) or to a file called

Company.txt (ASCII database).

Reader groups. Whenever a new reader group is added or its name changed, the SMS softwarewrites the reader group name, ID and company to a table called ReaderGroupTable (SQL Serverdatabase) or to a file called Readergp.txt (ASCII database).

Time codes. Whenever a new time code is added or its name changed, the SMS software writes thetime code name, ID and company to a table called TimeCodeTable (SQL Server database) or to afile called TimeCode.txt (ASCII database).

Badge designs. Whenever a new badge design is added or its name changed, the SMS softwarewrites the badge design name, ID and company to a table called BadgeFormatIDTable (SQL Serverdatabase) or to a file called Badge.txt (ASCII database).

Access codes. Whenever a new access code is added or its name is changed, the SMS softwarewrites the access code name, ID and company to a table called AccessCodeTable (SQL Serverdatabase) or to a file called Accesscd.txt (ASCII database).

Readers. Whenever a new reader is added or its name is changed, the SMS software writes thereader name, ID and company to a table called ReaderTable (SQL Server database) or to a filecalled Reader.txt (ASCII database).

Record Request Field

The value of the RecordRequest field affects the behavior of the import process, as detailed next.

RecordRequest = 0 (Add/Modify)

If the RecordRequest field is set to 0 (add/modify), one of two outcomes are possible:

If the card holder/visitor card does not already exist in the SMS software, a new record is added.

If the card holder/visitor card already exists in the SMS software, the card details are modified (seenext section).

The method for determining whether or not the card already exists is the same as when RecordRequest =1 (see next section).


9/44


10/44

Importing Card Data


Once the relevant record in the SMS database has been located, any field can be updated, except the cardnumber.

The CardIssueLevel field is used to update the details only if the Card Issue Levelsoption in theConfigure/Preferences/System screen is set.

Note: It is not possible to modify the card access rights by changing the ReaderID, ReaderGroupID,AccessCodeID, TimeCodeID or BadgeFormatID fields; any entries made to the ReaderGroupID or

TimeCodeID fields will be ignored, as will the access rights associated with the badge design.

It is not possible to modify a card record with a card number of zero.

RecordRequest = 2 (Make Inactive)

If RecordRequest is set to 2, the specified card is made inactive and the supplied InactiveComment isinserted. The system searches for the existing card in the same way as when RecordRequest is set to 1. Ifmore than one card is found, all matching records are made inactive.

RecordRequest = 3 (Add Access Rights)

If RecordRequest is set to 3, the specified card access rights are extended, as specified in the ReaderID,ReaderGroupID, TimeCodeID and AccessCodeID fields, provided that there is no conflict when they areadded to the cards existing access rights. The system searches for the existing card in the same way aswhen RecordRequest is set to 1. If more than one card is found, all matching records are changed.

Note: other modifications made to the card record, e.g. changing a personal data field entry, will be ignoredby this request.

RecordRequest = 4 (Remove all Access Rights)

If RecordRequest is set to 4, all of the specified cards' access rights are removed, including any advancedaccess rights assigned and access rights belonging to another company. The system searches for the

existing card in the same way as when RecordRequest is set to 1. If more than one card is found, allmatching records have their access rights removed.

Note: other modifications made to the card record, such as changing a personal data field entry, will beignored by this request.

RecordRequest = 5 (Reactivate Card)

If RecordRequest is set to 5, the specified card's Force Inactive field is cleared (if previously set). Thesystem searches for the existing card in the same way as when RecordRequest is set to 1.

Note: Other changes to the card details may be necessary before the card can be used. For example, the

Active and Expiry dates may need to be updated. If other modifications to the card details required, thesemust be made using a separate import record, with RecordRequest set to 1 or 0. Set RecordRequest to 5only to change the card's Force Inactive setting.

RecordRequest = 6 (Remove Individual Access Rights)

If RecordRequest is set to 6, the specified access right is removed from the selected card. This may beselected by reader, reader group or access code as specified by the ReaderID, ReaderGroupID or


11/44

Importing Card Data


AccessCodeID field. The system searches for the existing card in the same way as when RecordRequestis set to 1. If more than one card is found, all matching records have their access rights removed.

Note:when RecordRequest is set to 6, only remove an access right; do not make other changes to thecard record. It is not possible to remove advanced access rights.

RecordRequest = 42 (Delete)

If RecordRequest is set to 42, the specified card is deleted from the database. The system searches forthe existing card in the same way as when RecordRequest is set to 1. If more than one card is found, allmatching records are deleted.

Password Encryption

Protection against importing an unauthorized database is provided by the Encryption field. Encryption isapplicable to both SQL and text import databases.

If a password is specified in the Tools/Data Import screen, the system checks that the password matchesthe encrypted password in each record of the import database. Processing of a record is not carried out ifthe encrypted password is incorrect.

If password security is required, the third-party software must be able to encrypt the password as follows:

1. Concatenate every field that is used for encryption (see DataImportTable on page 14). This will meanconverting all numbers and dates to their string representations.

Dates must be converted to the string representation dd/mm/yyyy, without leading zeroes.

Any empty fields must not be included.

The order of concatenation is the same as the order of the fields (see the appropriate appendix).

2. Perform an exclusive OR between the concatenated string and the password.

3. Sum the resulting character string.

Example

The following gives an example of an encryption of the password "enigma" for a card holder record.

The encryption value of 2091 was calculated as follows:

1. The concatenated string is:

"SoapJoe451456Neil Smith29/6/2000121"

2. The assumed password is enigma.

3. An exclusive OR with enigma (S XOR e, o XOR n, a XOR i, p XOR g, J XOR m and oXOR a) produces a resultant string of characters.

4. The ASCII value of each character in this string is summed to produce a value of 2091.


12/44

Importing Card Data


Field Name Value Note

LastName Soap

FirstName Joe

CardNumber 45

CompanyID 1

CardIssueLevel

EmployeeReference 456 EmployeeReference is notrelevant for visitor recordsand takes no part inencryption

PIN

PersonalData1 Neil Smith

PersonalData2

PersonalData3

PersonalData4

PersonalData5

PersonalData6

PersonalData7

PersonalData8

PersonalData9

PersonalData10

ActiveDate 29/6/2000

ExpiryDate

ReaderGroupID 1

TimeCodeID 2

RecordRequest 1

InactiveComment

Encryption 2091


13/44


3 Chapter 2: Exporting Card Data

Introduction

This chapter describes how to export details of card holders from the SMS software to a third-party systemor to another similar SMS software installation. The following diagram illustrates the process.

Note: You cannot export visitor records from the SMS software.

Exporting Card Holder Details

Note: By default, card details are exported only after a user adds, modifies or deletes a card from theIdentity/Card Holders or Identity/Bulk Card Amendments screen in the SMS software. However, an INI fileparameter set at the server allows imported card data also to be exported. The optional parameter in the[multiMax] section is DataExportAfterImport=1.

SMSSoftware

Third-Party or otherSMS software

installation

Export database

The SMS software exports card holder data (e.g. card

holder's name, card number, personal data, etc.) to anexport database. The export process is controlled by theData Export screen in the Tools menu.

The database is a SQL Server or ASCII textdatabase. The format of the database isdescribed later in this manual.

The third-party system reads the databaseand processes the data as required.


14/44

Exporting Card Data


Data Export Screen

Data export occurs automaticallywhenever relevant changes are madeto card-holder details. You can export

data manually by selecting Export AllRecords, then OK.

Select the information you wish to export.The export database will contain a null f ield

for any data item that has Noselected.

Select this option,

then OKif you wish todelete ALL records inthe export database.

Select this option toenable automaticexports to a text file.


15/44


4 Chapter 3: Importing Card Data into theCCH Database

Introduction

The following describes the process of importing card details from a third-party system when the CentralCard Handler (CCH) software is being used in a Global Edition system.

CCH Client

Import database

A third-party system can export card data (such as name, card number,personal data and access rights) into an import database.

This database is in SQL Server format (ASCII database format is notsupported). The database is created during the software installation processand can be located at the Head Office server, or on a different SQL Servermachine. The format of this database is specified in Appendix E.

Any card details set up at a CCH Client are stored in this SQL database. Anydata imported from the third-party system can be accessed and edited from aCCH Client.

The data now in each region's import database is automatically transferred tothe main SMS database at each region.

The data in the import database can be imported into the Central Card HandlerDatabase. This can be actioned only from the Tools/Data Import screen at aCCH Client PC. An option in the Tools/Data Import screen enables imports totake place automatically.

CCH Database

Administration ClientEach region can import the data in the CCH database into the region's importdatabase (the format of which is documented in Appendix A). The import canbe actioned from the Tools/Data Import screen at an Administration clientlocated at the region. Alternatively, an option in the Install/Regions screen at aCCH client enables imports to take place automatically.

Regional importdatabases

SMS Database

Third-PartySystem


16/44

Importing Card Data into the CCH Database


Data Import Screen

The following is the Tools/Data Import screen at a CCH Client.

Note: Please refer to the Online Helpat a CCH Client for further details.

Region Definition Screen

The following is the Install/Regions screen at a CCH Client.

Note:Please refer to the Online Helpat a CCH Client for further details

Select this if you wantto import records

immediately.

If you want to enable automaticimports, select this option andenter the time you want automatic

imports to start each day.

This shows the number of

records to be imported.

Database housekeepingoptions are provided.

A password, if specified, preventsunauthorized records in thedatabase from being imported.

If you select this option,card holders will beautomatically imported tothe region as soon as they

are created or modified.


17/44


5 Chapter 4: Importing Transaction Data

Transaction data from third-party systems can be imported into the SMS transaction database via theimport database. This allows SMS clients to display live transactions in the Alarm and Activity windows andto produce reports of these transactions.

The following diagram illustrates the import process.

Note: For performance reasons, it is recommended that transactions are not added to the import databaseat times when cards are being imported into the SMS database.

Importing Transactions

The import database must be in SQL Server format (ASCII databaseformat is not supported). The database is automatically created duringthe installation of the SMS software.

Third-PartySystem

SMSClient

Import database

The third-party system exports transaction data into the TxnImportTableof the import database (multiMaxImport). The format of TxnImportTableis specified in Appendix F. The data includes the transaction type,location, and the date and time of the transaction.

The SMS support service reads the transactions entered into the importdatabase and automatically checks and moves the transactions into thelive transaction database (multiMaxTxn). This occurs for each transactionas it is added to the table (as opposed to import batches used in the cardimport mechanism).

Transactiondatabase

SMS clients can display the transactions in the Alarms screen and producereports that include the transactions


18/44


A Appendix A: SQL Database Formats forCard Data Import

This appendix describes the format of the data expected by the Tools/Data Import screen when an SQLimport database is being used (DataImportEnabled = 1 in multimax.ini).

Note: You must belong to the "ACSUSERS" user group to be able to access the SQL Server databases.By default, all users set up to use the SMS software already belong to this group.

SQL Server - DataImportTable

Note: This table is used only for card holders (not visitors).

Field Name Data Type Used for Comments

Encryption

RecordCount integer No Value assigned automatically by SQLdatabase

LastName nvarchar(40) Yes

FirstName nvarchar(40) Yes

CardNumber integer Yes

CompanyID integer Yes Valid Range: 1 to 64

CardIssueLevel tinyint Yes Valid Range 0 to 9

EmployeeReference nvarchar(12) Yes

PIN smallint Yes Valid Range 1 to 9999

PersonalData1 nvarchar(40) Yes








PersonalData9 nvarchar(40) YesPersonalData10 nvarchar(40) Yes

ActiveDate datetime Yes Enter date only

ExpiryDate datetime Yes Enter date only

ReaderGroupID integer Yes Obtain by referring to ReaderGroupTable

TimeCodeID integer Yes Obtain by referring to TimeCodeTable

RecordRequest smallint Yes 0 = Add/Modify record1 = Modify record


19/44

SQL Database Formats for Card Data Import


2 = Make existing record inactive3 = Add access rights4 = Remove all access rights5 = Reactivate Card6 = Remove individual access rights42 = Delete record

RecordStatus smallint No Set to 0 for import. MessageTable givesmeaning of updated value

InactiveComment nvarchar(40) Yes Reason for card being made inactive

Encryption integer Yes

CustomerCode integer No Valid range 0-999999. This field is mandatoryif there is more than one customer/facility codedefined in the SMS software.

FaceFile nvarchar(128) No

SignatureFile nvarchar(128) No

InitLet nvarchar(1) No Middle initial

BadgeFormatID integer No See also the DefaultBadge field

PersonalData11 nvarchar(40) No










PersonalData21 nvarchar(40) No Personal data 21 through to 50 are availableonly when enabled in the servers multimax.inifile (set ImportExportAllPersonalData to 1).


PersonalData23 nvarchar(40) NoPersonalData24 nvarchar(40) No


















20/44











HandTemplateValue1 tinyint No Valid Range 0 - 255









ReaderID integer No Obtain by referring to ReaderTableAccessCodeID integer No Obtain by referring to AccessCode Table

ImportNow bit No Valid Range 0 or 1. When set to 1 andRecordStatus set to 0, the import process isstarted within 10 seconds.

BatchReference uniqueIdentifier (16) No Each import is given a unique referencenumber, which the SMS software writes backto this field in the database.

DefaultBadge bit No Specifies whether or not to use the defaultcard holder badge design, as specified in theTools/Badge Designer screen. 1 = use defaultbadge design. 0 = don't use default badgedesign. When set to 1, do not specify

BadgeFormatID.

SQL Server - VisitorDataImportTable

This table is used only for visitor records.


Encryption

RecordCount integer No Value assigned automatically by SQL

databaseLastName nvarchar(40) Yes

FirstName nvarchar(40) Yes

CardNumber integer Yes

CompanyID integer Yes Valid Range: 1 to 64






21/44










PersonalData10 nvarchar(40) YesActiveDate datetime Yes Enter date only


ReaderGroupID integer Yes Obtain by referring to ReaderGroupTable

TimeCodeID integer Yes Obtain by referring to TimeCodeTable

RecordRequest smallint Yes 0 = Add/Modify record1 = Modify record2 = Make existing record inactive3 = Add access rights4 = Remove all access rights5 = Reactivate Card6 = Remove individual access rights

42 = Delete recordRecordStatus smallint No Set to 0 for import. MessageTable gives

meaning of updated value


Encryption integer Yes

CustomerCode integer No Valid range 0-999999. This field is mandatoryif there is more than one customer/facility codedefined in the SMS software.




BadgeFormatID integer No See also the DefaultBadge field



















22/44
































ReaderID integer No Obtain by referring to ReaderTable

AccessCodeID integer No Obtain by referring to AccessCode Table

ImportNow bit No Valid Range 0 or 1. When set to 1 andRecordStatus set to 0, the import process isstarted within 10 seconds.

BatchReference uniqueIdentifier (16) No Each import is given a unique referencenumber, which the SMS software writes backto this field in the database.

Representing nvarchar(40) No

Vehicle nvarchar(40) No

ArrivalDate datetime NoDepartureDate datetime No

Visiting nvarchar(40) No

Message nvarchar(256) No

BusinessCardFile nvarchar(128) No

ContactNumber nvarchar(40) No


23/44



DefaultBadge bit No Specifies whether or not to use the defaultvisitor badge design (specified in Tools/BadgeDesigner screen). 1 = use default badgedesign. 0 = don't use default badge design.When set to 1, do not specify BadgeFormatID.

SQL Server - MessageTableField Name Data Type

RecordStatus smallint

Message nvarchar(120)

MessageTable contents:

0 The record has not been imported yet.

1 The record has been successfully imported.

2 The mandatory fields have not been specified in this record.

3 The card issue levels preference must be set to import this record.

4 Could not find the specified record in the database.

5 The format of this record is incorrect.

6 This record has an encryption error.

7 A general error has occurred on this record.

8 Cannot add this card as it already exists in the database.

9 The specified card issue level is out of range.

10 The specified PIN is out of range.

11 The specified company is not defined in the database.

12 The specified reader group is not defined in the database.

13 The specified time code is not defined in the database.

14 The specified expiry date is before the active date.15 An unknown record request has been specified.

16 The card holders face image file could not be found.

17 The card holders signature image file could not be found.

18 The specified customer code is not valid for this company.

19 More than one customer code exists for the selected company.

20 More than one company exists for the selected customer code.

24 The specified badge format ID is not valid for the specified company.

25 The Card Number needs to be specified for this system.

26 The employee reference has not been supplied or it already exists in the database.

27 There is a reader group time code conflict.

28 The reader group and time code already exist.

29 Biometric data incorrect.

30 Mandatory personal data not set.

31 The specified reader is not defined in the database.

32 The specified access code is not defined in the database.

33 There is a reader time code conflict.

34 The reader and time code already exist.


24/44



35 There is an access code conflict.

36 The access code already exists.

38 The specified card is used in a conditional command

39 The specified card has no visitor escort assigned to it.

SQL Server - ReaderGroupTable

Field Name Data Type

ReaderGroupID integer

CompanyID integer

ReaderGroupName nvarchar(40)

SQL Server - TimeCodeTable


TimeCodeID integer

TimeCodeName nvarchar(40)

CompanyID integer

SQL Server - AccessCodeTable


AccessCodeID integer

CompanyID integer

AccessCodeName nvarchar(40)

SQL Server - ReaderTable


ReaderID integer

CompanyID integer

ReaderName nvarchar(40)


25/44



SQL Server - CardFingerprintTemplateImportTable


CardFingerprintTemplateID integer

RecordCount integer

FData binary

SQL Server - VersionTable


VersionID integer

ReleaseVersion nvarchar(40)

LanguageVariant nvarchar(40)

BuildLevel nvarchar(40)

RegionID integer

InternalBuildNumber integer

SQL Server - CompanyTable


CompanyTableID integer

CompanyID integer

CompanyName nvarchar(40)

CustomerCode integer

SQL Server BadgeFormatIDTable

Field Name Data Type Note

BadgeFormatID integer

BadgeFormatName nvarchar(40)

CompanyID integer


26/44


B Appendix B: ASCII Database Formats forCard Data Import

This appendix describes the format of the data expected by the Tools/Data Import screen when a text-format import database is being used (DataImportEnabled = 2 in multimax.ini).

Import.txt

Note:

The followingtable is used only for card holders (not visitors).

The text delimiter is a quote ("). The field delimiter is a comma (,).

Each card holder record in Import.txt must be separated by a .

Field Name Data Type Example Comments

LastName text(40) "Smith",

FirstName text(40) "Neil",

CardNumber integer 456,CompanyID integer 13, Valid Range 1 to 64

CardIssueLevel short 1, Valid Range 0 to 9. The range for CardIssueLevel must be 0 to 9 when the Card

Issue Levelspreference is set toYes, orblank if set to No.

EmployeeReference text(12) "EMP456",

PIN short 1234, Valid Range 1 to 9999

PersonalData1 text(40) "Gloucester",

PersonalData2 text(40) "England",

PersonalData3 text(40) "P772 FJO",

PersonalData4 text(40) ,








27/44

ASCII Database Formats for Card Data Import


ActiveDate date 17/03/2006, The date format must follow that as set up onthe server, e.g. dd/mm/yyyy or mm/dd/yyyy,etc.If the card is currently expired and has notbeen forced inactive in the Card Holder'sscreen, the card's status is automatically set toActive if the current date is between the activeand expiry dates.

ExpiryDate date 19/12/2006, The date format must follow that as set up onthe server, e.g. dd/mm/yyyy or mm/dd/yyyy,etc.

ReaderGroupID integer 1, Obtain by referring to ReaderGp.txt

TimeCodeID integer 1, Obtain by referring to TimeCode.txt

RecordRequest short 0, 0 = Add/Modify record1 = Modify record2 = Make existing record inactive3 = Add access rights4 = Remove all access rights5 = Reactivate Card6 = Remove individual access rights42 = Delete record

RecordStatus short 0, Must be 0

InactiveComment text(40) , Reason for making inactive

Encryption integer ,

CustomerCode integer 999, Valid range 0-999999

FaceFile text(128) "face1.jpg",

SignatureFile text(128) "sig1.jpg",

InitLet text(1) "J", Middle initial

BadgeFormatID integer 3, Obtain by referring to Badge.txt. See also theDefaultBadge field.

PersonalData11 text(40) "Contractor",


PersonalData13 text(40) ,PersonalData14 text(40) ,







PersonalData21 text(40) , PersonalData21 through to 50 are availableonly when enabled in the servers multimax.inifile (set ImportExportAllPersonalData to 1).










28/44






















HandTemplateValue1 integer , Valid range 0 - 255









ReaderID integer , Obtain by referring to Reader.txt

AccessCodeID integer , Obtain by referring to AccessCd.txt.

DefaultBadge integer Specifies whether or not to use the defaultcard holder badge design, as specified in theTools/Badge Designer screen. 1 = use defaultbadge design. 0 = don't use default badgedesign. When set to 1, do not specifyBadgeFormatID. End entry with a carriagereturn.


29/44



VisitorImport.txt

Note:

The followingtable is used only for visitors.


Each visitor record in VisitorImport.txt must be separated by a .



FirstName text(40) "George",

CardNumber integer 456,

CompanyID integer 13, Valid Range 1 to 64

CardIssueLevel short 1, Valid Range 0 to 9. The range for

CardIssueLevel must be 0 to 9 when the CardIssue Levelspreference is set toYes, orblank if set to No.

PIN short 1234, Valid Range 1 to 9999



PersonalData3 text(40) "VO54 FJO",








ActiveDate date 17/03/2006, The date format must follow that as set up onthe server, e.g. dd/mm/yyyy or mm/dd/yyyy,etc.If the card is currently expired and has notbeen forced inactive in the Visitor's screen, thecard's status is automatically set to Active ifthe current date is between the active andexpiry dates.

ExpiryDate date 19/12/2006, The date format must follow that as set up onthe server, e.g. dd/mm/yyyy or mm/dd/yyyy,etc.

ReaderGroupID integer 1, Obtain by referring to ReaderGp.txt

TimeCodeID integer 1, Obtain by referring to TimeCode.txt

RecordRequest short 0, 0 = Add/Modify record1 = Modify record2 = Make existing record inactive3 = Add access rights4 = Remove all access rights5 = Reactivate Card6 = Remove individual access rights42 = Delete record

RecordStatus short 0, Must be 0


30/44



InactiveComment text(40) , Reason for making inactive

Encryption integer ,


FaceFile text(128) "face1.jpg",

SignatureFile text(128) "sig1.jpg",


BadgeFormatID integer 3, Obtain by referring to Badge.txt. See also the

DefaultBadge field.PersonalData11 text(40) "Contractor",










PersonalData21 text(40) , PersonalData21 through to 50 are availableonly when enabled in the servers multimax.inifile (set ImportExportAllPersonalData to 1).




























31/44










HandTemplateValue7 integer , Valid range 0 - 255HandTemplateValue8 integer , Valid range 0 - 255


ReaderID integer , Obtain by referring to Reader.txt

AccessCodeID integer , Obtain by referring to AccessCd.txt.

Representing text(40) ,

Vehicle text(40) ,

ArrivalDate date ,

DepartureDate date ,

Visiting text(40) ,

Message text(256) ,

BusinessCardFile text(128) ,ContactNumber text(40) ,

DefaultBadge integer Specifies whether to use the default visitor badge design, as specified in the Tools/BadgeDesigner screen. 1 = use default badgedesign. 0 = don't use default badge design.When set to 1, do not specify BadgeFormatID.End entry with a carriage return.

Reader.txt


ReaderID integer

CompanyID integer

ReaderName text(40)

ReaderGp.txt


ReaderGroupID integer

CompanyID integer

ReaderGroupName text(40)


32/44



TimeCode.txt


TimeCodeID integer

TimeCodeName text(40)

CompanyID integer

AccessCd.txt


AccessCodeID integer

CompanyID integer

AccessCodeName text(40)

Company.txt


CompanyID integer

CompanyName text(40)

CustomerCode integer

Badge.txt



BadgeFormatName text(40)

CompanyID integer

Message.txt

Field Name Data Type Example

RecordStatus short 0,Message text(120) "The record has not

been imported yet."


33/44



Message.txt contents:

0,"The record has not been imported yet."

1,"The record has been successfully imported."

2,"The mandatory fields have not been specified in this record."

3,"The card issue levels preference must be set to import this record."

4,"Could not find the specified record in the database."

5,"The format of this record is incorrect."

6,"This record has an encryption error."

7,"A general error has occurred on this record."

8,"Cannot add this card as it already exists in the database."

9,"The specified card issue level is out of range."

10,"The specified PIN is out of range."

11,"The specified company is not defined in the database."

12,"The specified reader group is not defined in the database."

13,"The specified time code is not defined in the database."

14,"The specified expiry date is before the active date."

15,"An unknown record request has been specified."

16,"The card holders face image file could not be found."

17,"The card holders signature image file could not be found."

18,"The specified customer code is not valid for this company."

19,"More than one customer code exists for the selected company."

20,"More than one company exists for the selected customer code."

24,"The specified badge format ID is not valid for the specified company."

25,"The Card Number needs to be specified for this system."

26,"The employee reference has not been supplied or it already exists in the database."

27,"There is a reader group time code conflict."

28,"The reader group and time code already exist."

29,"Biometric data incorrect."30,"Mandatory personal data not set."

31,"The specified reader is not defined in the database."

32,"The specified access code is not defined in the database."

33,"There is a reader time code conflict."

34,"The reader and time code already exist."

35,"There is a access code conflict."

36,"The access code already exists."

38,"The specified card is used in a conditional command."

39,"The specified card has no visitor escort assigned to it."

Export.txt and VisitorExport.txt

The format of Export.txt and VisitorExport.txt are the same as Import.txt and VisitorImport.txt respectively,except RecordStatus can be any one of the values (except 0) specified in Message.txt.


34/44


C Appendix C: SQL Database Formats forCard Data Export

This appendix describes the data exported by the Tools/Data Export screen when an SQL export databaseis being used (DataExportEnabled = 1 in multimax.ini).

Note: You must belong to the "ACSUsers" user group to be able to access the SQL Server databases. Bydefault, all users set up to use the SMS software already belong to this group.

SQL Server - DataExportTable

The SMS software stores the card-holder details in the DataExportTable of the SQL Server database.DataExportTable has the following format.

Field Name Data Type Comments

RecordCount integer Auto increment counter for sorting

LastName nvarchar(40)

FirstName nvarchar(40)

CardNumber integer

CompanyID integer Range: 1 to 64

CardIssueLevel tinyint Range 0 to 9.

EmployeeReference nvarchar(12)

PIN smallint Range 1 to 9999. Leading zeroes are not included in PINnumbers.

PersonalData1 nvarchar(40)







PersonalData8 nvarchar(40)PersonalData9 nvarchar(40)


ActiveDate datetime Only date specified

ExpiryDate datetime Only date specified


35/44

SQL Database Formats for Card Data Export


RecordRequest smallint 0 = The specified details are for a newly-created card holder,or as a result of exporting all records from the Tools/DataExport screen.1 = The specified details contain modifications to the details ofan existing card holder (the record shows all the card-holder'sdetails, not just the details that have changed).2 = The specified card holder has been deleted.

InactiveComment nvarchar(40) Reason for card being made inactive

Encryption integer Not usedCustomerCode integer Range: 0 to 999999

FaceFile nvarchar(128) JPEG face filename. The system exports face images asJPEG files to their subfolders below the specified folder (e.g.C:\Program Files\Security ManagementSystem\Export\Faces).

SignatureFile nvarchar(128) JPEG signature filename. The system exports signatureimages as JPEG files to their subfolders below the specifiedfolder (e.g. C:\Program Files\Security ManagementSystem\Export\Sigs ).

ExportTimeStamp datetime Date and time that data was exported

Active bit Shows whether the card is active (true) or inactive (false)

AccessGranted bit Set to true if access rights for normal access are specifiedInitLet nvarchar(1) Middle initial











PersonalData21 nvarchar(40) PersonalData21 to 50 are exported only if enabled in theserver multimax.ini file (set ImportExportAllPersonalData to 1)


















36/44

SQL Database Formats for Card Data Export














HandTemplateValue1 tinyint





HandTemplateValue6 tinyintHandTemplateValue7 tinyint




37/44


D Appendix D: ASCII Database Formats forCard Data Export

This appendix describes the data exported by the Tools/Data Export screen when text-format exportdatabase is being used (DataExportEnabled = 3 in multimax.ini).

Exported Import.txt

Note:


Each card holder record in Import.txt is separated by a .



FirstName text(40) "George",

CardNumber integer 456,

CompanyID integer 13, Valid Range: 1 to 64

CardIssueLevel short 1, Valid Range 0 to 9. If the

CardIssueLevel field is blank, itindicates that a card issue level has notbeen set in the SMS software.

EmployeeReference text(12) "EMP456",

PIN short 1234, Valid range: 1 to 9999. Leading zeroesare not included in PIN numbers.



PersonalData3 text(40) "VO54 FJO",








ActiveDate date 05/06/2006 00:00:00, Created in local format. The date formatfollows that as set up on the server, e.g.dd/mm/yyyy or mm/dd/yyyy, etc.


38/44

ASCII Database Formats for Card Data Export


ExpiryDate date 07/12/2006 00:00:00, Created in local format. The date formatfollows that as set up on the server, e.g.dd/mm/yyyy or mm/dd/yyyy, etc.

ReaderGroupID integer , Always blank

TimeCodeID integer , Always blank

RecordRequest short 0, 0 = The specified details are for anewly-created card holder, or as a resultof exporting all records from theTools/Data Export screen.1 = The specified details containmodifications to the details of anexisting card holder (the record showsall the card-holder's details, not just thedetails that have changed).2 = The specified card holder has beendeleted.

RecordStatus short 0, Always 0

InactiveComment text(40) "",

Encryption integer 0,


FaceFile text(128) "face1.jpg", The system exports face images asJPEG files to their subfolders below thespecified folder (e.g. C:\ProgramFiles\Security ManagementSystem\Export\Faces).

SignatureFile text(128) "sig1.jpg", The system exports signature imagesas JPEG files to their subfolders belowthe specified folder (e.g. C:\ProgramFiles\Security ManagementSystem\Export\Sigs ).


BadgeFormatID integer 3, See also the DefaultBadge field

PersonalData11 text(40) "Contractor",










PersonalData21 text(40) , PersonalData21 through to 50 areexported only when enabled in the

servers multimax.ini file (setImportExportAllPersonalData to 1);otherwise PersonalData21 through to50 will show a blank entry.







39/44

ASCII Database Formats for Card Data Export


































40/44


E Appendix E: SQL Database Formats forCCH Card Data Import

This appendix describes the format of the data expected by the Tools/Data Import screen at a Central CardHandler (CCH) Client. The database is named "CardHandlerImport" and is in SQL format.

Note: You must belong to the "ACSUSERS" user group to be able to access the SQL Server databases.By default, all users set up to use the SMS software already belong to this group.

Note:Only card holder details are imported. Central Card Handler Clients cannot be used to set up visitordetails.

SQL Server - DataImportTable


Encryption

RecordCount integer No Value assigned automatically by SQLdatabase

LastName nvarchar(40) Yes

FirstName nvarchar(40) YesCardNumber integer Yes


EmployeeReference nvarchar(12) Yes












ActiveDate datetime Yes Enter date only



41/44

SQL Database Formats for CCH Card Data Import


RecordRequest smallint Yes 0 = Add/Modify record1 = Modify record2 = Make existing record inactive

RecordStatus smallint No Set to 0 for import. MessageTable givesmeaning of updated value





BadgeFormatID integer No







































42/44










HandTemplateValue6 tinyint No Valid Range 0 - 255HandTemplateValue7 tinyint No Valid Range 0 - 255



Encryption integer No

CompanyID integer No

AssignAllRegions tinyint No Valid Range 0 or 1. When set to 1 importedcard is automatically allocated to ALL regionsdefined.

ImportNow bit No Valid range 0 or 1. When set to 1 andRecordStatus set to 0, the import process isstarted within 10 seconds.

SQL Server - MessageTable


RecordStatus smallint

Message nvarchar(120)

MessageTable contents:

0 The record has not been imported yet.

1 The record has been successfully imported.2 The mandatory fields have not been specified in this record.

3 The card issue levels preference must be set to import this record.

4 Could not find the specified record in the database.

5 The format of this record is incorrect.

6 This record has an encryption error.

7 A general error has occurred on this record.

8 Cannot add this card as it already exists in the database.

9 The specified card issue level is out of range.

10 The specified PIN is out of range.

11 The specified company is not defined in the database.

12 The specified reader group is not defined in the database.

13 The specified time code is not defined in the database.

14 The specified expiry date is before the active date.

15 An unknown record request has been specified.

16 The card holders face image file could not be found.

17 The card holders signature image file could not be found.

18 The specified customer code is not valid for this company.


43/44



19 More than one customer code exists for the selected company.

20 More than one company exists for the selected customer code.

24 The specified badge format ID is not valid for the specified company.

25 The Card Number needs to be specified for this system.

26 The employee reference has not been supplied or it already exists in the database.

27 There is a reader group time code conflict.

28 The reader group and time code already exist.

29 Biometric data incorrect.

30 Mandatory personal data not set.

31 The specified reader is not defined in the database.

32 The specified access code is not defined in the database.

33 There is a reader time code conflict.

34 The reader and time code already exist.

35 There is an access code conflict.

36 The access code already exists.

38 The specified card is used in a conditional command

SQL Server - VersionTable


VersionID integer

ReleaseVersion nvarchar(40)

LanguageVariant nvarchar(40)

BuildLevel nvarchar(40)

RegionID integer

InternalBuildNumber integer

SQL Server BadgeFormatIDTable



BadgeFormatName nvarchar(40)

CompanyID integer


44/44

F Appendix F: SQL Database Formats forTransaction Data Import

This appendix describes the format of the data expected by the TxnImportTable of the import database(multiMaxImport) for external transactions to be imported into the system.

SQL Server - TxnImportTable

Field Name Data Type Comments

TxnImportId integer Value assigned automatically by SQL database

TxnDateTime datetime Date and time; format according to locale of server

WhatField nvarchar(255)

WhereField nvarchar(255)

FirstName nvarchar(40)

LastName nvarchar(40)

TimeZone nvarchar(4) Time zone code associated with the transaction time

AlarmColour integer See Note below

AlarmPriority smallint Valid range 1 - 999Alarm tinyint Transaction type; 0 = event, 1= alarm

Note:The AlarmColour value can be calculated by taking the hex value of each of the three individual colorcomponents (blue, green, red), concatenating the values, then calculating the decimal equivalent. Forexample, pale blue has a blue color value of 255 (FF), green color value of 255 (FF) and a red color valueof 128 (80), as displayed in the color chart of Microsoft Paint. Concatenating the hex values (BGR) gives ahex value of FFFF80, which when converted to decimal is 16777088.

Examples of other commonly used colors are as follows:

Red: 255Blue: 16711680

Green: 32768Black: 0Brown: 4210816Pink: 16744703

Data Connect Manual

Documents

Transcript of Data Connect Manual