Data Connect Manual

Data Connect Manual,
Issue 6.0.2
SECURITY MANAGEMENT SYSTEM
9600-0458
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 2007
Applies 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.
Contents
1
Preface ................................................................................................. ii
About this Manual................................................................................................................................. ii
Chapter 1: Importing Card Data ............................................................1

Introduction.......................................................................................................................................... 1
Data Import Screen ............................................................................................................................. 2
The Import Process............................................................................................................................. 3
Additional Data Maintained by the SMS Software............................................................................... 4
Record Request Field.......................................................................................................................... 4
RecordRequest = 0 (Add/Modify) ................................................................................................. 4
RecordRequest = 1 (Modify)......................................................................................................... 5
RecordRequest = 2 (Make Inactive) ............................................................................................. 6
RecordRequest = 3 (Add Access Rights) ..................................................................................... 6
RecordRequest = 4 (Remove all Access Rights) ......................................................................... 6
RecordRequest = 5 (Reactivate Card) ......................................................................................... 6
RecordRequest = 6 (Remove Individual Access Rights).............................................................. 6
RecordRequest = 42 (Delete)....................................................................................................... 7
Password Encryption........................................................................................................................... 7
Example........................................................................................................................................ 7
Chapter 2: Exporting Card Data............................................................9

Introduction.......................................................................................................................................... 9
Data Export Screen ........................................................................................................................... 10
Chapter 3: Importing Card Data into the CCH Database ....................11

Introduction........................................................................................................................................ 11
Data Import Screen .................................................................................................................... 12
Region Definition Screen ............................................................................................................ 12
Chapter 4: Importing Transaction Data ...............................................13
Appendix A: SQL Database Formats for Card Data Import.................14

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

Import.txt ........................................................................................................................................... 22
VisitorImport.txt ................................................................................................................................. 25
Reader.txt.......................................................................................................................................... 27
ReaderGp.txt ..................................................................................................................................... 27
TimeCode.txt..................................................................................................................................... 28
AccessCd.txt ..................................................................................................................................... 28
Company.txt ...................................................................................................................................... 28
Badge.txt ........................................................................................................................................... 28
Data Connect Manual
About this Guide
Message.txt........................................................................................................................................28
Export.txt and VisitorExport.txt...........................................................................................................29
Appendix C: SQL Database Formats for Card Data Export................ 30

SQL Server - DataExportTable ..........................................................................................................30
Appendix D: ASCII Database Formats for Card Data Export.............. 33

Exported Import.txt.............................................................................................................................33
Appendix E: SQL Database Formats for CCH Card Data Import........ 36

SQL Server - DataImportTable ..........................................................................................................36
SQL Server - MessageTable .............................................................................................................38
SQL Server - VersionTable ................................................................................................................39
SQL Server BadgeFormatIDTable..................................................................................................39
Appendix F: SQL Database Formats for Transaction Data Import ..... 40

SQL 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 with
the 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.
ii
Data Connect Manual
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 the
security 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.
Third-Party
System
Import database
SMS
Software
The third-party system exports card data (e.g. person's

name, card number, personal data, reader group and time
code, etc.) to an import database.
The database can be an SQL Server database or an ASCII

database. The required format of the database is
described in this manual. The type of database to use
must be specified during the installation of the SMS
software. The ASCII database is stored by default on the
database machine in the Import subfolder (e.g. c:\Program
Files\Security Management System\Import).
The SMS software reads the database and creates or modifies

the card record. The import process can be controlled by the
Data Import screen in the Tools menu. If an SQL database is
used, records can be imported automatically by setting the
ImportNow field to 1 in the Import database.
Importing Card Details
Data Connect Manual
Importing Card Data
Data Import Screen

You can use the Data
Import screen in the Tools
Menu to carry out a data
import immediately.
You specify the file(s) to

import here.
This shows the number of
records to be imported.
If you are using an SQL Server

database, you can carry out the data
import automatically at regular
intervals.
Database housekeeping
options are provided.
A password, if specified,
prevents unauthorized
records in the database from
being imported.
Note: Refer to the Online Help for full details of how to use the Data Import screen.
Data Connect Manual
Importing Card Data
The Import Process

Note:
Refer to the appropriate appendix for details of the required format of the import database. A
template database is generated when the software is installed.
The ASCII import database is located by default in the Program Files\Security Management
System\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
VisitorDataImportTable
For card holders

For visitors
When using an ASCII text file database, the import database must be named:
Import.txt
VisitorImport.txt
For card holders

For visitors
2.
If a password is specified in the Tools/Data Import screen, the SMS software checks the encrypted
password in the import database. The system will process a record in the import database only if the
encrypted password is correct (see Password Encryption on page 7).
3.
The RecordRequest field in the import database (see page 4) specifies whether to add the details of
a new card, modify the details of an existing card, make the card inactive, add additional access
rights, remove all access rights, reactivate the card or delete the card. The SMS software carries out
the 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 the
database 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) have
been 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 the
records in Import.txt or VisitorImport.txt are deleted.
6.
The SMS software updates the RecordStatus field in the SQL Server database, Export.txt or
VisitorExport.txt (as appropriate) to specify whether importing of the card record was successful or
unsuccessful. 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 Management
System\Import folder.
Data Connect Manual
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 application
when adding the card records to the import database:
Company names. Whenever a new company is added or its name changed, the SMS software
writes 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 software
writes the reader group name, ID and company to a table called ReaderGroupTable (SQL Server
database) 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 the
time code name, ID and company to a table called TimeCodeTable (SQL Server database) or to a
file called TimeCode.txt (ASCII database).
Badge designs. Whenever a new badge design is added or its name changed, the SMS software
writes the badge design name, ID and company to a table called BadgeFormatIDTable (SQL Server
database) 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 software
writes the access code name, ID and company to a table called AccessCodeTable (SQL Server
database) 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 the
reader name, ID and company to a table called ReaderTable (SQL Server database) or to a file
called 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 (see
next section).
The method for determining whether or not the card already exists is the same as when RecordRequest =
1 (see next section).
Data Connect Manual
Importing Card Data
When RecordRequest field is set to 0:
The LastName and FirstName fields are mandatory.
If a new card record is being added to the SMS software and the CardNumber field is empty, the
SMS software will automatically set the card number to the lowest unused card number if the Auto
Card Number preference is set in Configure/Preferences/System. If the Auto Card Number
preference is not set, the record will be imported with a card number of zero and set to inactive. Note
that there are separate Auto Card Number preferences for card holders and visitors.
If the PIN field is empty, the SMS software will generate a PIN. A PIN of 0000 is not allowed.
If the ActiveDate field is empty, the active date will be set to the current date.
If the ExpiryDate field is empty (named Inactive Date in the SMS user interface), the inactive date
will be left empty, which means no inactive date.
For a visitor, if the Visitor Maximum No. of Days preference is set in the
Configure/Preferences/System screen, the inactive date is automatically set to be the ActiveDate,
plus the number of days specified by the Visitor Maximum No. of Days. If the Visitor Maximum
No. of Days preference is not set and there is no ExpiryDate, there will be no inactive date.
If the CompanyID field is empty the company assigned (see CompanyTable or Company.txt) is the
one associated with the facility/customer code entered. If multiple companies use the same
facility/customer code, CompanyID field must contain a valid company ID.
The CardIssueLevel field is used only if the Card Issue Levels option in the
Configure/Preferences/System screen is set.
If importing with a badge design that has access rights associated with it, the access rights are only
assigned to the card if no reader time code data, reader group time code data or access code is
given in the import record.
Only one type of access right can be imported in a single record.
The import process ignores the Approving Official Is Mandatory preference.
Personal data must be supplied for a card record for those personal data fields that are mandatory.
RecordRequest = 1 (Modify)
If the RecordRequest field is set to 1 (or to 0 and the card already exists), the specified card
holder's/visitor's details are updated with the data contained in the import database. If any fields are empty,
the corresponding fields in the SMS software remain unchanged.
The existing card in the SMS software is found by using one of the following three methods:
1.
Card number, or if there are no matching records by:
2.
Employee reference, or if there are no matching records by:
3.
Last name and first name.
If more than one card is found, all matching records are modified.
Data Connect Manual
Importing Card Data
Once the relevant record in the SMS database has been located, any field can be updated, except the card
number.
The CardIssueLevel field is used to update the details only if the Card Issue Levels option in the
Configure/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 is
inserted. 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, 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 are
added to the cards existing access rights. 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, all matching records are changed.
Note: other modifications made to the card record, e.g. changing a personal data field entry, will be ignored
by 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 advanced
access 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, all
matching records have their access rights removed.
Note: other modifications made to the card record, such as changing a personal data field entry, will be
ignored 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). The
system 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, these
must be made using a separate import record, with RecordRequest set to 1 or 0. Set RecordRequest to 5
only 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 be
selected by reader, reader group or access code as specified by the ReaderID, ReaderGroupID or
Data Connect Manual
Importing Card Data
AccessCodeID field. 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, 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 the
card 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 for
the existing card in the same way as when RecordRequest is set to 1. If more than one card is found, all
matching records are deleted.
Password Encryption
Protection against importing an unauthorized database is provided by the Encryption field. Encryption is
applicable to both SQL and text import databases.
If a password is specified in the Tools/Data Import screen, the system checks that the password matches
the encrypted password in each record of the import database. Processing of a record is not carried out if
the 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 mean
converting 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 o

XOR 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.
Data Connect Manual
Importing Card Data
Field Name
LastName
FirstName
CardNumber
CompanyID
CardIssueLevel
EmployeeReference
PIN
PersonalData1
PersonalData2
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
ActiveDate
ExpiryDate
ReaderGroupID
TimeCodeID
RecordRequest
InactiveComment
Encryption
Value
Soap
Joe
45
1
Note
456
EmployeeReference is not
relevant for visitor records
and takes no part in
encryption
Neil Smith
29/6/2000
1
2
1
2091
Data Connect Manual
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 system
or to another similar SMS software installation. The following diagram illustrates the process.
Note: You cannot export visitor records from the SMS software.
SMS
Software
Export database
Third-Party or other
SMS software
installation
The SMS software exports card holder data (e.g. card

holder's name, card number, personal data, etc.) to an
export database. The export process is controlled by the
Data Export screen in the Tools menu.
The database is a SQL Server or ASCII text

database. The format of the database is
described later in this manual.
The third-party system reads the database

and processes the data as required.
Exporting Card Holder Details
Note: By default, card details are exported only after a user adds, modifies or deletes a card from the
Identity/Card Holders or Identity/Bulk Card Amendments screen in the SMS software. However, an INI file
parameter set at the server allows imported card data also to be exported. The optional parameter in the
[multiMax] section is DataExportAfterImport=1.
Data Connect Manual
Exporting Card Data
Data Export Screen
Select the information you wish to export.

The export database will contain a null field
for any data item that has No selected.
Select this option,

then OK if you wish to
delete ALL records in
the export database.
Data export occurs automatically

whenever relevant changes are made
to card-holder details. You can export
data manually by selecting Export All
Records, then OK.
10
Select this option to

enable automatic
exports to a text file.
Data Connect Manual
4 Chapter 3:
Importing Card Data into the

CCH Database
Introduction
The following describes the process of importing card details from a third-party system when the Central
Card Handler (CCH) software is being used in a Global Edition system.
Third-Party
System
Import database
CCH Client
CCH Database
Administration Client
Regional import
databases
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 not

supported). The database is created during the software installation process
and can be located at the Head Office server, or on a different SQL Server
machine. The format of this database is specified in Appendix E.
The data in the import database can be imported into the Central Card Handler
Database. This can be actioned only from the Tools/Data Import screen at a
CCH Client PC. An option in the Tools/Data Import screen enables imports to
take place automatically.
Any card details set up at a CCH Client are stored in this SQL database. Any
data imported from the third-party system can be accessed and edited from a
CCH Client.
Each region can import the data in the CCH database into the region's import
database (the format of which is documented in Appendix A). The import can
be actioned from the Tools/Data Import screen at an Administration client
located at the region. Alternatively, an option in the Install/Regions screen at a
CCH client enables imports to take place automatically.
The data now in each region's import database is automatically transferred to

the main SMS database at each region.
SMS Database
Data Connect Manual
11
Importing Card Data into the CCH Database
Data Import Screen

The following is the Tools/Data Import screen at a CCH Client.
Select this if you want

to import records
immediately.
If you want to enable automatic

imports, select this option and
enter the time you want automatic
imports to start each day.
A password, if specified, prevents

unauthorized records in the
database from being imported.
This shows the number of

records to be imported.
Database housekeeping
options are provided.
Note: Please refer to the Online Help at a CCH Client for further details.
Region Definition Screen

The following is the Install/Regions screen at a CCH Client.
If you select this option,

card holders will be
automatically imported to
the region as soon as they
are created or modified.
Note: Please refer to the Online Help at a CCH Client for further details
12
Data Connect Manual
5 Chapter 4:
Importing Transaction Data
Transaction data from third-party systems can be imported into the SMS transaction database via the
import database. This allows SMS clients to display live transactions in the Alarm and Activity windows and
to 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 database
at times when cards are being imported into the SMS database.
Third-Party
System
Import database
The third-party system exports transaction data into the TxnImportTable

of the import database (multiMaxImport). The format of TxnImportTable
is specified in Appendix F. The data includes the transaction type,
location, and the date and time of the transaction.
The import database must be in SQL Server format (ASCII database

format is not supported). The database is automatically created during
the installation of the SMS software.
Transaction
database
The SMS support service reads the transactions entered into the import
database and automatically checks and moves the transactions into the
live transaction database (multiMaxTxn). This occurs for each transaction
as it is added to the table (as opposed to import batches used in the card
import mechanism).
SMS
Client
SMS clients can display the transactions in the Alarms screen and produce
reports that include the transactions
Importing Transactions
Data Connect Manual
13
A Appendix A: SQL Database Formats for

Card Data Import
This appendix describes the format of the data expected by the Tools/Data Import screen when an SQL
import 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).
14
Field Name
Data Type
RecordCount
integer
LastName
FirstName
CardNumber
CompanyID
CardIssueLevel
EmployeeReference
PIN
PersonalData1
PersonalData2
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
ActiveDate
ExpiryDate
ReaderGroupID
TimeCodeID
RecordRequest
nvarchar(40)
nvarchar(40)
integer
integer
tinyint
nvarchar(12)
smallint
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
datetime
datetime
integer
integer
smallint
Used for
Encryption
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Comments
Value assigned automatically by SQL
database
Valid Range: 1 to 64
Valid Range 0 to 9
Valid Range 1 to 9999
Enter date only

Enter date only
Obtain by referring to ReaderGroupTable
Obtain by referring to TimeCodeTable
0 = Add/Modify record
1 = Modify record
Data Connect Manual
SQL Database Formats for Card Data Import
RecordStatus
smallint
No
InactiveComment
Encryption
CustomerCode
nvarchar(40)
integer
integer
Yes
Yes
No
FaceFile
SignatureFile
InitLet
BadgeFormatID
PersonalData11
PersonalData12
PersonalData13
PersonalData14
PersonalData15
PersonalData16
PersonalData17
PersonalData18
PersonalData19
PersonalData20
PersonalData21
nvarchar(128)
nvarchar(128)
nvarchar(1)
integer
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
PersonalData22
PersonalData23
PersonalData24
PersonalData25
PersonalData26
PersonalData27
PersonalData28
PersonalData29
PersonalData30
PersonalData31
PersonalData32
PersonalData33
PersonalData34
PersonalData35
PersonalData36
PersonalData37
PersonalData38
PersonalData39
PersonalData40
PersonalData41
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
Data Connect Manual
2 = Make existing record inactive

3 = Add access rights
4 = Remove all access rights
5 = Reactivate Card
6 = Remove individual access rights
42 = Delete record
Set to 0 for import. MessageTable gives
meaning of updated value
Reason for card being made inactive
Valid range 0-999999. This field is mandatory
if there is more than one customer/facility code
defined in the SMS software.
Middle initial
See also the DefaultBadge field
Personal data 21 through to 50 are available

only when enabled in the servers multimax.ini
file (set ImportExportAllPersonalData to 1).
15
PersonalData42
PersonalData43
PersonalData44
PersonalData45
PersonalData46
PersonalData47
PersonalData48
PersonalData49
PersonalData50
HandTemplateValue1
HandTemplateValue2
HandTemplateValue3
HandTemplateValue4
HandTemplateValue5
HandTemplateValue6
HandTemplateValue7
HandTemplateValue8
HandTemplateValue9
ReaderID
AccessCodeID
ImportNow
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
integer
integer
bit
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
BatchReference
uniqueIdentifier (16)
No
DefaultBadge
bit
No
Valid Range 0 - 255

Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Obtain by referring to ReaderTable
Obtain by referring to AccessCode Table
Valid Range 0 or 1. When set to 1 and
RecordStatus set to 0, the import process is
started within 10 seconds.
Each import is given a unique reference
number, which the SMS software writes back
to this field in the database.
Specifies whether or not to use the default
card holder badge design, as specified in the
Tools/Badge Designer screen. 1 = use default
badge design. 0 = don't use default badge
design. When set to 1, do not specify
BadgeFormatID.
SQL Server - VisitorDataImportTable

This table is used only for visitor records.
16
Field Name
Data Type
RecordCount
integer
LastName
FirstName
CardNumber
CompanyID
CardIssueLevel
PIN
PersonalData1
PersonalData2
nvarchar(40)
nvarchar(40)
integer
integer
tinyint
smallint
nvarchar(40)
nvarchar(40)
Used for
Encryption
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Comments
database
Valid Range 0 to 9
Data Connect Manual
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
ActiveDate
ExpiryDate
ReaderGroupID
TimeCodeID
RecordRequest
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
datetime
datetime
integer
integer
smallint
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
RecordStatus
smallint
No
InactiveComment
Encryption
CustomerCode
nvarchar(40)
integer
integer
Yes
Yes
No
FaceFile
SignatureFile
InitLet
BadgeFormatID
PersonalData11
PersonalData12
PersonalData13
PersonalData14
PersonalData15
PersonalData16
PersonalData17
PersonalData18
PersonalData19
PersonalData20
PersonalData21
nvarchar(128)
nvarchar(128)
nvarchar(1)
integer
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
PersonalData22
PersonalData23
PersonalData24
PersonalData25
PersonalData26
PersonalData27
PersonalData28
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
No
No
No
No
No
No
No
Data Connect Manual
Enter date only

Enter date only
Obtain by referring to ReaderGroupTable
Obtain by referring to TimeCodeTable
1 = Modify record
5 = Reactivate Card
42 = Delete record
Valid range 0-999999. This field is mandatory
if there is more than one customer/facility code
defined in the SMS software.
Middle initial

17
18
PersonalData29
PersonalData30
PersonalData31
PersonalData32
PersonalData33
PersonalData34
PersonalData35
PersonalData36
PersonalData37
PersonalData38
PersonalData39
PersonalData40
PersonalData41
PersonalData42
PersonalData43
PersonalData44
PersonalData45
PersonalData46
PersonalData47
PersonalData48
PersonalData49
PersonalData50
HandTemplateValue1
HandTemplateValue2
HandTemplateValue3
HandTemplateValue4
HandTemplateValue5
HandTemplateValue6
HandTemplateValue7
HandTemplateValue8
HandTemplateValue9
ReaderID
AccessCodeID
ImportNow
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
integer
integer
bit
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
BatchReference
uniqueIdentifier (16)
No
Representing
Vehicle
ArrivalDate
DepartureDate
Visiting
Message
BusinessCardFile
ContactNumber
nvarchar(40)
nvarchar(40)
datetime
datetime
nvarchar(40)
nvarchar(256)
nvarchar(128)
nvarchar(40)
No
No
No
No
No
No
No
No
Valid Range 0 - 255

Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Obtain by referring to ReaderTable
Obtain by referring to AccessCode Table
Valid Range 0 or 1. When set to 1 and
Each import is given a unique reference
number, which the SMS software writes back
to this field in the database.
Data Connect Manual
DefaultBadge
bit
No

visitor badge design (specified in Tools/Badge
Designer screen). 1 = use default badge
design. 0 = don't use default badge design.
When set to 1, do not specify BadgeFormatID.
SQL Server - MessageTable

Field Name
RecordStatus
Message
Data Type
smallint
nvarchar(120)
MessageTable contents:
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
24
25
26
27
28
29
30
31
32
33
34
The record has not been imported yet.

The record has been successfully imported.
The mandatory fields have not been specified in this record.
The card issue levels preference must be set to import this record.
Could not find the specified record in the database.
The format of this record is incorrect.
This record has an encryption error.
A general error has occurred on this record.
Cannot add this card as it already exists in the database.
The specified card issue level is out of range.
The specified PIN is out of range.
The specified company is not defined in the database.
The specified reader group is not defined in the database.
The specified time code is not defined in the database.
The specified expiry date is before the active date.
An unknown record request has been specified.
The card holders face image file could not be found.
The card holders signature image file could not be found.
The specified customer code is not valid for this company.
More than one customer code exists for the selected company.
More than one company exists for the selected customer code.
The specified badge format ID is not valid for the specified company.
The Card Number needs to be specified for this system.
The employee reference has not been supplied or it already exists in the database.
There is a reader group time code conflict.
The reader group and time code already exist.
Biometric data incorrect.
Mandatory personal data not set.
The specified reader is not defined in the database.
The specified access code is not defined in the database.
There is a reader time code conflict.
The reader and time code already exist.
Data Connect Manual
19
35
36
38
39
There is an access code conflict.

The access code already exists.
The specified card is used in a conditional command
The specified card has no visitor escort assigned to it.
SQL Server - ReaderGroupTable

Field Name
ReaderGroupID
CompanyID
ReaderGroupName
Data Type
integer
integer
nvarchar(40)
SQL Server - TimeCodeTable

Field Name
TimeCodeID
TimeCodeName
CompanyID
Data Type
integer
nvarchar(40)
integer
SQL Server - AccessCodeTable

Field Name
AccessCodeID
CompanyID
AccessCodeName
Data Type
integer
integer
nvarchar(40)
SQL Server - ReaderTable

Field Name
ReaderID
CompanyID
ReaderName
20
Data Type
integer
integer
nvarchar(40)
Data Connect Manual
SQL Server - CardFingerprintTemplateImportTable

Field Name
CardFingerprintTemplateID
RecordCount
FData
Data Type
integer
integer
binary
SQL Server - VersionTable

Field Name
VersionID
ReleaseVersion
LanguageVariant
BuildLevel
RegionID
InternalBuildNumber
Data Type
integer
nvarchar(40)
nvarchar(40)
nvarchar(40)
integer
integer
SQL Server - CompanyTable

Field Name
CompanyTableID
CompanyID
CompanyName
CustomerCode
Data Type
integer
integer
nvarchar(40)
integer
SQL Server BadgeFormatIDTable

Field Name
BadgeFormatID
BadgeFormatName
CompanyID
Data Connect Manual
Data Type
integer
nvarchar(40)
integer
Note
21
B Appendix B: ASCII Database Formats for

Card Data Import
This appendix describes the format of the data expected by the Tools/Data Import screen when a textformat import database is being used (DataImportEnabled = 2 in multimax.ini).
Import.txt
Note:
22
The following table 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 <cr>.
Field Name
LastName
FirstName
CardNumber
CompanyID
CardIssueLevel
Data Type
text(40)
text(40)
integer
integer
short
Example
"Smith",
"Neil",
456,
13,
1,
EmployeeReference
PIN
PersonalData1
PersonalData2
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
text(12)
short
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
"EMP456",
1234,
"Gloucester",
"England",
"P772 FJO",
,
,
,
,
,
,
,
Comments
Valid Range 1 to 64
Valid Range 0 to 9. The range for
CardIssueLevel must be 0 to 9 when the Card
Issue Levels preference is set to Yes, or
blank if set to No.
Data Connect Manual
ASCII Database Formats for Card Data Import
ActiveDate
date
17/03/2006,
ExpiryDate
date
19/12/2006,
ReaderGroupID
TimeCodeID
RecordRequest
integer
integer
short
1,
1,
0,
RecordStatus
InactiveComment
Encryption
CustomerCode
FaceFile
SignatureFile
InitLet
BadgeFormatID
short
text(40)
integer
integer
text(128)
text(128)
text(1)
integer
0,
,
,
999,
"face1.jpg",
"sig1.jpg",
"J",
3,
PersonalData11
PersonalData12
PersonalData13
PersonalData14
PersonalData15
PersonalData16
PersonalData17
PersonalData18
PersonalData19
PersonalData20
PersonalData21
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
"Contractor",
,
,
,
,
,
,
,
,
,
,
PersonalData22
PersonalData23
PersonalData24
PersonalData25
PersonalData26
PersonalData27
PersonalData28
PersonalData29
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
,
,
,
,
,
,
,
,
Data Connect Manual
The date format must follow that as set up on

the server, e.g. dd/mm/yyyy or mm/dd/yyyy,
etc.
If the card is currently expired and has not
been forced inactive in the Card Holder's
screen, the card's status is automatically set to
Active if the current date is between the active
and expiry dates.
etc.
Obtain by referring to ReaderGp.txt
Obtain by referring to TimeCode.txt
1 = Modify record
5 = Reactivate Card
42 = Delete record
Must be 0
Reason for making inactive
Valid range 0-999999
Middle initial
Obtain by referring to Badge.txt. See also the
DefaultBadge field.
PersonalData21 through to 50 are available

23
PersonalData30
PersonalData31
PersonalData32
PersonalData33
PersonalData34
PersonalData35
PersonalData36
PersonalData37
PersonalData38
PersonalData39
PersonalData40
PersonalData41
PersonalData42
PersonalData43
PersonalData44
PersonalData45
PersonalData46
PersonalData47
PersonalData48
PersonalData49
PersonalData50
HandTemplateValue1
HandTemplateValue2
HandTemplateValue3
HandTemplateValue4
HandTemplateValue5
HandTemplateValue6
HandTemplateValue7
HandTemplateValue8
HandTemplateValue9
ReaderID
AccessCodeID
DefaultBadge
24
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
<cr>
Valid range 0 - 255

Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Obtain by referring to Reader.txt
Obtain by referring to AccessCd.txt.
card holder badge design, as specified in the
Tools/Badge Designer screen. 1 = use default
badge design. 0 = don't use default badge
design. When set to 1, do not specify
BadgeFormatID. End entry with a carriage
return.
Data Connect Manual
VisitorImport.txt
Note:
The following table is used only for visitors.
Each visitor record in VisitorImport.txt must be separated by a <cr>.
Field Name
LastName
FirstName
CardNumber
CompanyID
CardIssueLevel
Data Type
text(40)
text(40)
integer
integer
short
Example
"Smith",
"George",
456,
13,
1,
PIN
PersonalData1
PersonalData2
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
ActiveDate
short
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
date
1234,
"Gloucester",
"England",
"VO54 FJO",
,
,
,
,
,
,
,
17/03/2006,
ExpiryDate
date
19/12/2006,
ReaderGroupID
TimeCodeID
RecordRequest
integer
integer
short
1,
1,
0,
RecordStatus
short
0,
Data Connect Manual
Comments
Valid Range 1 to 64
Valid Range 0 to 9. The range for
CardIssueLevel must be 0 to 9 when the Card
Issue Levels preference is set to Yes, or
blank if set to No.

etc.
If the card is currently expired and has not
been forced inactive in the Visitor's screen, the
card's status is automatically set to Active if
the current date is between the active and
expiry dates.
etc.
Obtain by referring to ReaderGp.txt
Obtain by referring to TimeCode.txt
1 = Modify record
5 = Reactivate Card
42 = Delete record
Must be 0
25
26
InactiveComment
Encryption
CustomerCode
FaceFile
SignatureFile
InitLet
BadgeFormatID
text(40)
integer
integer
text(128)
text(128)
text(1)
integer
,
,
999,
"face1.jpg",
"sig1.jpg",
"J",
3,
PersonalData11
PersonalData12
PersonalData13
PersonalData14
PersonalData15
PersonalData16
PersonalData17
PersonalData18
PersonalData19
PersonalData20
PersonalData21
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
"Contractor",
,
,
,
,
,
,
,
,
,
,
PersonalData22
PersonalData23
PersonalData24
PersonalData25
PersonalData26
PersonalData27
PersonalData28
PersonalData29
PersonalData30
PersonalData31
PersonalData32
PersonalData33
PersonalData34
PersonalData35
PersonalData36
PersonalData37
PersonalData38
PersonalData39
PersonalData40
PersonalData41
PersonalData42
PersonalData43
PersonalData44
PersonalData45
PersonalData46
PersonalData47
PersonalData48
PersonalData49
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
Reason for making inactive

Middle initial
Obtain by referring to Badge.txt. See also the
DefaultBadge field.
PersonalData21 through to 50 are available

Data Connect Manual
PersonalData50
HandTemplateValue1
HandTemplateValue2
HandTemplateValue3
HandTemplateValue4
HandTemplateValue5
HandTemplateValue6
HandTemplateValue7
HandTemplateValue8
HandTemplateValue9
ReaderID
AccessCodeID
Representing
Vehicle
ArrivalDate
DepartureDate
Visiting
Message
BusinessCardFile
ContactNumber
DefaultBadge
text(40)
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
text(40)
text(40)
date
date
text(40)
text(256)
text(128)
text(40)
integer
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
<cr>
Valid range 0 - 255

Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Obtain by referring to Reader.txt
Obtain by referring to AccessCd.txt.
Specifies whether to use the default visitor

badge design, as specified in the Tools/Badge
Designer screen. 1 = use default badge
design. 0 = don't use default badge design.
When set to 1, do not specify BadgeFormatID.
End entry with a carriage return.
Reader.txt
Field Name
ReaderID
CompanyID
ReaderName
Data Type
integer
integer
text(40)
ReaderGp.txt
Field Name
ReaderGroupID
CompanyID
ReaderGroupName
Data Connect Manual
Data Type
integer
integer
text(40)
27
TimeCode.txt
Field Name
TimeCodeID
TimeCodeName
CompanyID
Data Type
integer
text(40)
integer
AccessCd.txt
Field Name
AccessCodeID
CompanyID
AccessCodeName
Data Type
integer
integer
text(40)
Company.txt
Field Name
CompanyID
CompanyName
CustomerCode
Data Type
integer
text(40)
integer
Badge.txt
Field Name
BadgeFormatID
BadgeFormatName
CompanyID
Data Type
integer
text(40)
integer
Note
Data Type
short
text(120)
Example
0,
"The record has not
been imported yet."<cr>
Message.txt
Field Name
RecordStatus
Message
28
Data Connect Manual
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.
Data Connect Manual
29
C Appendix C: SQL Database Formats for

Card Data Export
This appendix describes the data exported by the Tools/Data Export screen when an SQL export database
is 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. By
default, 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.
30
Field Name
RecordCount
LastName
FirstName
CardNumber
CompanyID
CardIssueLevel
EmployeeReference
PIN
Data Type
integer
nvarchar(40)
nvarchar(40)
integer
integer
tinyint
nvarchar(12)
smallint
PersonalData1
PersonalData2
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
ActiveDate
ExpiryDate
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
datetime
datetime
Comments
Auto increment counter for sorting
Range: 1 to 64
Range 0 to 9.
Range 1 to 9999. Leading zeroes are not included in PIN
numbers.
Only date specified

Only date specified
Data Connect Manual
SQL Database Formats for Card Data Export
RecordRequest
smallint
InactiveComment
Encryption
CustomerCode
FaceFile
nvarchar(40)
integer
integer
nvarchar(128)
SignatureFile
nvarchar(128)
ExportTimeStamp
Active
AccessGranted
InitLet
BadgeFormatID
PersonalData11
PersonalData12
PersonalData13
PersonalData14
PersonalData15
PersonalData16
PersonalData17
PersonalData18
PersonalData19
PersonalData20
PersonalData21
datetime
bit
bit
nvarchar(1)
integer
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
PersonalData22
PersonalData23
PersonalData24
PersonalData25
PersonalData26
PersonalData27
PersonalData28
PersonalData29
PersonalData30
PersonalData31
PersonalData32
PersonalData33
PersonalData34
PersonalData35
PersonalData36
PersonalData37
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
Data Connect Manual
0 = The specified details are for a newly-created card holder,

or as a result of exporting all records from the Tools/Data
Export screen.
1 = The specified details contain modifications to the details of
an existing card holder (the record shows all the card-holder's
details, not just the details that have changed).
2 = The specified card holder has been deleted.
Not used
Range: 0 to 999999
JPEG face filename. The system exports face images as
JPEG files to their subfolders below the specified folder (e.g.
C:\Program Files\Security Management
System\Export\Faces).
JPEG signature filename. The system exports signature
images as JPEG files to their subfolders below the specified
folder (e.g. C:\Program Files\Security Management
System\Export\Sigs ).
Date and time that data was exported
Shows whether the card is active (true) or inactive (false)
Set to true if access rights for normal access are specified
Middle initial
PersonalData21 to 50 are exported only if enabled in the

server multimax.ini file (set ImportExportAllPersonalData to 1)
31
SQL Database Formats for Card Data Export
PersonalData38
PersonalData39
PersonalData40
PersonalData41
PersonalData42
PersonalData43
PersonalData44
PersonalData45
PersonalData46
PersonalData47
PersonalData48
PersonalData49
PersonalData50
HandTemplateValue1
HandTemplateValue2
HandTemplateValue3
HandTemplateValue4
HandTemplateValue5
HandTemplateValue6
HandTemplateValue7
HandTemplateValue8
HandTemplateValue9
32
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
Data Connect Manual
D Appendix D: ASCII Database Formats for

Card Data Export
This appendix describes the data exported by the Tools/Data Export screen when text-format export
database is being used (DataExportEnabled = 3 in multimax.ini).
Exported Import.txt
Note:
Each card holder record in Import.txt is separated by a <cr>.
Field Name
LastName
FirstName
CardNumber
CompanyID
CardIssueLevel
Data Type
text(40)
text(40)
integer
integer
short
Example
"Smith",
"George",
456,
13,
1,
EmployeeReference
PIN
text(12)
short
"EMP456",
1234,
PersonalData1
PersonalData2
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
ActiveDate
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
date
"Gloucester",
"England",
"VO54 FJO",
,
,
,
,
,
,
,
05/06/2006 00:00:00,
Data Connect Manual
Comments
Valid Range 0 to 9. If the
CardIssueLevel field is blank, it
indicates that a card issue level has not
been set in the SMS software.
Valid range: 1 to 9999. Leading zeroes
are not included in PIN numbers.
Created in local format. The date format

follows that as set up on the server, e.g.
dd/mm/yyyy or mm/dd/yyyy, etc.
33
ASCII Database Formats for Card Data Export
34
ExpiryDate
date
07/12/2006 00:00:00,
ReaderGroupID
TimeCodeID
RecordRequest
integer
integer
short
,
,
0,
RecordStatus
InactiveComment
Encryption
CustomerCode
FaceFile
short
text(40)
integer
integer
text(128)
0,
"",
0,
999,
"face1.jpg",
SignatureFile
text(128)
"sig1.jpg",
InitLet
BadgeFormatID
PersonalData11
PersonalData12
PersonalData13
PersonalData14
PersonalData15
PersonalData16
PersonalData17
PersonalData18
PersonalData19
PersonalData20
PersonalData21
text(1)
integer
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
"J",
3,
"Contractor",
,
,
,
,
,
,
,
,
,
,
PersonalData22
PersonalData23
PersonalData24
PersonalData25
PersonalData26
text(40)
text(40)
text(40)
text(40)
text(40)
,
,
,
,
,
Created in local format. The date format

follows that as set up on the server, e.g.
dd/mm/yyyy or mm/dd/yyyy, etc.
Always blank
Always blank
0 = The specified details are for a
newly-created card holder, or as a result
of exporting all records from the
Tools/Data Export screen.
1 = The specified details contain
modifications to the details of an
existing card holder (the record shows
all the card-holder's details, not just the
details that have changed).
2 = The specified card holder has been
deleted.
Always 0

The system exports face images as
JPEG files to their subfolders below the
specified folder (e.g. C:\Program
Files\Security Management
System\Export\Faces).
The system exports signature images
as JPEG files to their subfolders below
the specified folder (e.g. C:\Program
Files\Security Management
System\Export\Sigs ).
Middle initial
PersonalData21 through to 50 are

exported only when enabled in the
servers multimax.ini file (set
ImportExportAllPersonalData to 1);
otherwise PersonalData21 through to
50 will show a blank entry.
Data Connect Manual
ASCII Database Formats for Card Data Export
PersonalData27
PersonalData28
PersonalData29
PersonalData30
PersonalData31
PersonalData32
PersonalData33
PersonalData34
PersonalData35
PersonalData36
PersonalData37
PersonalData38
PersonalData39
PersonalData40
PersonalData41
PersonalData42
PersonalData43
PersonalData44
PersonalData45
PersonalData46
PersonalData47
PersonalData48
PersonalData49
PersonalData50
HandTemplateValue1
HandTemplateValue2
HandTemplateValue3
HandTemplateValue4
HandTemplateValue5
HandTemplateValue6
HandTemplateValue7
HandTemplateValue8
HandTemplateValue9
Data Connect Manual
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
text(40)
integer
integer
integer
integer
integer
integer
integer
integer
integer
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
,
Valid range 0 - 255

Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
Valid range 0 - 255
35
E Appendix E: SQL Database Formats for

CCH Card Data Import
This appendix describes the format of the data expected by the Tools/Data Import screen at a Central Card
Handler (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 visitor
details.
SQL Server - DataImportTable
36
Field Name
Data Type
RecordCount
integer
LastName
FirstName
CardNumber
CardIssueLevel
EmployeeReference
PIN
PersonalData1
PersonalData2
PersonalData3
PersonalData4
PersonalData5
PersonalData6
PersonalData7
PersonalData8
PersonalData9
PersonalData10
ActiveDate
ExpiryDate
nvarchar(40)
nvarchar(40)
integer
tinyint
nvarchar(12)
smallint
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
datetime
datetime
Used for
Encryption
No
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Comments
database
Valid Range 0 to 9
Enter date only

Enter date only
Data Connect Manual
SQL Database Formats for CCH Card Data Import
RecordRequest
smallint
Yes
RecordStatus
smallint
No
InactiveComment
FaceFile
SignatureFile
InitLet
BadgeFormatID
PersonalData11
PersonalData12
PersonalData13
PersonalData14
PersonalData15
PersonalData16
PersonalData17
PersonalData18
PersonalData19
PersonalData20
PersonalData21
nvarchar(40)
nvarchar(128)
nvarchar(128)
nvarchar(1)
integer
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
Yes
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
PersonalData22
PersonalData23
PersonalData24
PersonalData25
PersonalData26
PersonalData27
PersonalData28
PersonalData29
PersonalData30
PersonalData31
PersonalData32
PersonalData33
PersonalData34
PersonalData35
PersonalData36
PersonalData37
PersonalData38
PersonalData39
PersonalData40
PersonalData41
PersonalData42
PersonalData43
PersonalData44
PersonalData45
PersonalData46
PersonalData47
PersonalData48
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
nvarchar(40)
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
No
Data Connect Manual
1 = Modify record
Middle initial

37
PersonalData49
PersonalData50
HandTemplateValue1
HandTemplateValue2
HandTemplateValue3
HandTemplateValue4
HandTemplateValue5
HandTemplateValue6
HandTemplateValue7
HandTemplateValue8
HandTemplateValue9
Encryption
CompanyID
AssignAllRegions
nvarchar(40)
nvarchar(40)
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
tinyint
integer
integer
tinyint
No
No
No
No
No
No
No
No
No
No
No
No
No
No
ImportNow
bit
No
Valid Range 0 - 255

Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 - 255
Valid Range 0 or 1. When set to 1 imported

card is automatically allocated to ALL regions
defined.
Valid range 0 or 1. When set to 1 and
SQL Server - MessageTable

Field Name
RecordStatus
Message
Data Type
smallint
nvarchar(120)
MessageTable contents:
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
38
The record has not been imported yet.

The record has been successfully imported.
The mandatory fields have not been specified in this record.
The card issue levels preference must be set to import this record.
Could not find the specified record in the database.
The format of this record is incorrect.
This record has an encryption error.
A general error has occurred on this record.
Cannot add this card as it already exists in the database.
The specified card issue level is out of range.
The specified PIN is out of range.
The specified company is not defined in the database.
The specified reader group is not defined in the database.
The specified time code is not defined in the database.
The specified expiry date is before the active date.
An unknown record request has been specified.
The card holders face image file could not be found.
The card holders signature image file could not be found.
The specified customer code is not valid for this company.
Data Connect Manual
19
20
24
25
26
27
28
29
30
31
32
33
34
35
36
38
More than one customer code exists for the selected company.
More than one company exists for the selected customer code.
The specified badge format ID is not valid for the specified company.
The Card Number needs to be specified for this system.
The employee reference has not been supplied or it already exists in the database.
There is a reader group time code conflict.
The reader group and time code already exist.
Biometric data incorrect.
Mandatory personal data not set.
The specified reader is not defined in the database.
The specified access code is not defined in the database.
There is a reader time code conflict.
The reader and time code already exist.
There is an access code conflict.
The access code already exists.
The specified card is used in a conditional command
SQL Server - VersionTable

Field Name
VersionID
ReleaseVersion
LanguageVariant
BuildLevel
RegionID
InternalBuildNumber
Data Type
integer
nvarchar(40)
nvarchar(40)
nvarchar(40)
integer
integer
SQL Server BadgeFormatIDTable

Field Name
BadgeFormatID
BadgeFormatName
CompanyID
Data Connect Manual
Data Type
integer
nvarchar(40)
integer
Note
39
F Appendix F: SQL Database Formats for

Transaction 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
TxnDateTime
WhatField
WhereField
FirstName
LastName
TimeZone
AlarmColour
AlarmPriority
Alarm
integer
datetime
nvarchar(255)
nvarchar(255)
nvarchar(40)
nvarchar(40)
nvarchar(4)
integer
smallint
tinyint
Value assigned automatically by SQL database

Date and time; format according to locale of server
Time zone code associated with the transaction time

See Note below
Valid range 1 - 999
Transaction type; 0 = event, 1= alarm
Note: The AlarmColour value can be calculated by taking the hex value of each of the three individual color
components (blue, green, red), concatenating the values, then calculating the decimal equivalent. For
example, pale blue has a blue color value of 255 (FF), green color value of 255 (FF) and a red color value
of 128 (80), as displayed in the color chart of Microsoft Paint. Concatenating the hex values (BGR) gives a
hex value of FFFF80, which when converted to decimal is 16777088.
Examples of other commonly used colors are as follows:
Red:
Blue:
Green:
Black:
Brown:
Pink:
40
255
16711680
32768
0
4210816
16744703
Data Connect Manual

Data Connect Manual

Încărcat de

Informații document

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Data Connect Manual

Încărcat de

Drepturi de autor:

Formate disponibile

Data Connect Manual,

Group 4 Technology 2007