Академический Документы
Профессиональный Документы
Культура Документы
Date
Date: 2013-09-06
Reviewed By:
Date:
Approved By:
Date:
Page 1 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
Change History
Changed By
Date
Version
Page
Description
Effective
Date
Page 2 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
Contents
1 Introduction ..................................................................................................................................................................4
1.1 Purpose ..................................................................................................................................................................4
2 Data Dictionary.............................................................................................................................................................5
2.1 User Information [user] .........................................................................................................................................5
2.2 Algorithm 9.0-based Fingerprint Template [fptemplate09] ...................................................................................7
2.3 Algorithm 10.0-based Fingerprint Template [templatev10]...................................................................................7
2.4 Attendance Data [transaction]................................................................................................................................8
2.5 Work Code [workcode] ..........................................................................................................................................9
2.6 SMS Message [sms] ..............................................................................................................................................9
2.7 User-specific SMS Message [usersms]................................................................................................................10
2.8 Time Zone for Access Control [acctimezone] .....................................................................................................10
2.9 Access Control Group [accgroup]........................................................................................................................10
2.10 Holiday Time Zone [accholiday] ....................................................................................................................... 11
2.11 Unlock Combination for Access Control [accunlockcomb] .............................................................................. 11
2.12 Function List [funclist] ......................................................................................................................................12
2.13 Status Information List [statekey] ......................................................................................................................12
2.14 Time List [statetimezone] ..................................................................................................................................13
2.15 State Change Time [statelist] .............................................................................................................................13
2.16 Shortcut Function List [keyfunc] .......................................................................................................................14
2.17 HID Card Format Information [HID_FORMAT] ..............................................................................................15
2.18 Operation Log Information [oplogs]..................................................................................................................16
Page 3 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
1 Introduction
1.1 Purpose
This document is to serve as a data dictionary for business development and a basis for business logic code
development.
Page 4 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
2 Data Dictionary
sms
PK
usersms
ID
LONG
StartTime
ValidTime
Type
Content
TEXT(24)
LONG
LONG
TEXT(320)
PK
ID
LONG
smsid
userid
LONG
TEXT(24)
ID
INTEGER
I1
PIN2
Fingerid
Valid
Size
Template
INTEGER
INTEGER
INTEGER
INTEGER
CHAR(0)
PK
ID
INTEGER
I1
PIN2
FingerID
Valid
Size
Template
INTEGER
INTEGER
INTEGER
INTEGER
CHAR(0)
PK
ID
INTEGER
Verification
VaildHoliday
Timezone1
Timezone2
Timezone3
LONG
LONG
LONG
LONG
LONG
user
PK
ID
INTEGER
PIN2
Pri
Name
Password
f
Group
h
IsGroupTz
verified
CardNo
TZ
valid
StartDatetime
EndDatetime
VaildCount
Timezone1
Timezone2
Timezone3
VARCHAR(24)
INTEGER
TEXT(48)
TEXT(16)
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
TEXT(24)
TEXT(24)
INTEGER
TEXT(24)
TEXT(24)
INTEGER
INTEGER
INTEGER
INTEGER
transaction
PK
workcode
PK
ID
LONG
WC_Code
WC_Name
TEXT(24)
TEXT(24)
ID
LONG
PIN2
verified
time_second
status
workcode
RESERVED1
RESERVED2
TEXT(24)
LONG
TEXT(24)
LONG
TEXT(24)
LONG
LONG
HID_FORMAT
PK
statetimezone
PK
ID
LONG
statetimezonename
montime
tuetime
wedtime
thutime
fritime
sattime
suntime
TEXT(64)
LONG
LONG
LONG
LONG
LONG
LONG
LONG
ID
INTEGER
Card_Bit
Format_Name
Card_Format
First_Even
Second_Even
First_Odd
Second_Odd
Format_Type
Status
INTEGER
VARCHAR(24)
VARCHAR(64)
VARCHAR(64)
VARCHAR(64)
VARCHAR(64)
VARCHAR(64)
INTEGER
INTEGER
statelist
PK
ID
LONG
funcname
statetimezonename
TEXT(64)
TEXT(64)
ID
LONG
statecode
funcname
statename
autochange
mon
tue
wed
thu
fri
sat
sun
LONG
TEXT(64)
TEXT(64)
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
PK
ID
LONG
OpType
Operator
OpTime
OpWho
Value1
Value2
Value3
LONG
TEXT(24)
TEXT(24)
TEXT(24)
LONG
LONG
LONG
templatev10
accunlockcomb
accgroup
acctimezone
PK
statekey
PK
OP_LOGS
fptemplate09
PK
ID
LONG
SunStart
SunEnd
MonStart
MonEnd
TuesStart
TuesEnd
WedStart
WedEnd
ThursStart
ThursEnd
FriStart
FriEnd
SatStart
SatEnd
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
PK
ID
LONG
Group1
Group2
Group3
Group4
Group5
LONG
LONG
LONG
LONG
LONG
accholiday
PK
ID
LONG
Holiday_Name
StartDate
EndDate
Timezone
TEXT(24)
LONG
LONG
LONG
KEY_CODE
PK
ID
LONG
Key_Name
Res_ID
Key_Value
TEXT(64)
LONG
LONG
keyfunc
PK
ID
LONG
Key
funcname
flag
TEXT(64)
TEXT(64)
LONG
funclist
PK
ID
LONG
funcname
funid
TEXT(64)
LONG
user
This table stores basic information of users.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
User ID
Primary key This field is a self-increasing field, and is used
as a foreign key for other data tables.
Page 5 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
Pri
VARCHAR(24)
Personal
identification
number (PIN) of a
user
INTEGER
User permission
Name
User name
VARCHAR(48)
Password
User password
VARCHAR(16)
Face group
INTEGER
Group
Access
control INTEGER
group
INTEGER
Department ID
PIN2
h
IsGroupTz
verified
CardNo
TZ
valid
Unique
VARCHAR(24)
Primary card
VARCHAR(24)
Standby card
User validity mode INTEGER
Page 6 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
VARCHAR(24)
VARCHAR(24)
VaildCount
Timezone1
INTEGER
INTEGER
Timezone2
Time zone
INTEGER
Timezone3
Time zone
INTEGER
StartDatetime
EndDatetime
the ID
default
the ID
default
the ID
default
Size
Valid
Template
fptemplate09
This table stores fingerprint data that is collected based on algorithm 9.0.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
Fingerprint ID
Primary key This field is a self-increasing field.
INTEGER
Fingerprint
For the value range of this field, see the user
number
ID in the user table.
Fingerprint ID of INTEGER
This field specifies the fingerprint ID of a
a user
user.
The value ranges from 0 to 9.
INTEGER
Fingerprint size
The fingerprint size of plus six equals the
value of this field.
The old firmware is compatible.
INTEGER
Fingerprint
Value options are as follows:
validity
0: invalid
1: valid
3: forcible
Fingerprint
BLOB
The fingerprint template is saved in binary
template
mode.
templatev10
This table stores fingerprint data that is collected based on algorithm 10.0.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
Fingerprint ID
Primary key This field is a self-increasing field.
Page 7 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
PIN2
Fingerprint number
INTEGER
FingerID
Fingerprint ID of a
user
INTEGER
Size
Fingerprint size
INTEGER
Valid
Fingerprint validity
INTEGER
Template
Fingerprint template
BLOB
time_second
status
transaction
This table stores user attendance data, including the attendance time, status, and verification type.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
Attendance
Primary key This field is a self-increasing field.
record ID
VARCHAR(24)
PIN of a user
For the value range of this field, see the
user PIN in the user table.
INTEGER
Verification type
Value options are as follows:
0: password
1: fingerprint
2: card
3: PIN
5: PIN and card
6: password and card
7: fingerprint, password, and card
9: PIN and fingerprint
10: fingerprint and password
11: PIN, fingerprint, and password
12: fingerprint and card
13: PIN and fingerprint
14: fingerprint, password, and card
15: PIN, fingerprint, password, and card
VARCHAR(24)
Verification time
This field specifies the verification time.
The time uses the ISO8601 format YYYYMM-DDThh:mm:ss.
Attendance status INTEGER
For the value range of this field, see the
statecode field in the statekey table.
0-250: normal attendance records
252:
attendance
records
saved
in
unauthorized time zones
253: attendance records with unauthorized
unlock combinations
254: attendance records in which the user
Page 8 of 17
Work code
INTEGER
RESERVED1
Number of the
fingerprint reader
Attendance
record flag
INTEGER
INTEGER
RESERVED2
workcode
This table stores information related to the work code, including the code and code name. Such
information is used to differentiate work types.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
Work code ID
Primary key
This field is a self-increasing field.
VARCHAR(24)
Work code value
VARCHAR(24)
Work code name
sms
This table stores information related to SMS messages.
Description
Data Type
Constraint
(Length)
INTEGER
SMS message ID
Primary key
Start
time
for
validating an SMS
message
Number of valid
minutes
VARCHAR(24)
Type
INTEGER
Content
VARCHAR(320)
StartTime
ValidTime
INTEGER
Remarks
This field specifies the SMS message
ID.
The time uses the ISO8601 format
YYYY-MM-DDThh:mm:ss.
Value options are as follows:
0: permanently valid
1-65535: number of valid minutes
Value options are as follows:
0xFD: public message
0xFF: draft message
0xFE: personal message
This field contains a maximum of 320
single-byte characters or 160 Unicode
characters.
Page 9 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
usersms
This table stores users' personal SMS messages. A user may have multiple SMS messages.
Description
Data Type
Constraint
Remarks
(Length)
ID of a user's SMS INTEGER
Primary key This field is a self-increasing field.
message
ID of an SMS INTEGER
For the value range of this field, see the
message
ID field in the sms table.
VARCHAR(24)
PIN of a user
For the value range of this field, see the
PIN2 field in the user table.
SunEnd
MonStart
MonEnd
TuesStart
TuesEnd
WedStart
WedEnd
ThursStart
ThursEnd
FriStart
FriEnd
SatStart
SatEnd
acctimezone
This table stores information of the time zones for access control.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
ID of the time zone
Primary key This field is a self-increasing field.
for access control
INTEGER
Start time on Sunday
The value 1159 indicates 11:59 a.m.
INTEGER
End time on Sunday
Start time on Monday INTEGER
End time on Monday INTEGER
Start time on Tuesday INTEGER
End time on Tuesday INTEGER
INTEGER
Start time on
Wednesday
INTEGER
End time on
Wednesday
INTEGER
Start time on
Thursday
End time on Thursday INTEGER
INTEGER
Start time on Friday
INTEGER
End time on Friday
INTEGER
Start time on
Saturday
End time on Saturday INTEGER
accgroup
This table stores access control group information.
Description
Data Type
Constraint
Remarks
Page 10 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
(Length)
Group ID
Group
verification mode
INTEGER
INTEGER
INTEGER
Timezone1
Is the holiday
valid or not
Time zone
Timezone2
Time zone
INTEGER
Timezone3
Time zone
INTEGER
ID
Verification
VaildHoliday
Primary key
INTEGER
accholiday
This table stores time zone information, such as the start date, end date, and time zone, of holidays.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
Holiday ID
Primary key This field specifies the ID of a holiday.
Holiday name
Start date of a holiday INTEGER
The value 401 indicates April 1.
End date of a holiday INTEGER
INTEGER
Time zone ID
For the value range of this field, see the ID
field in the acctimezone table.
The default value is 0.
accunlockcomb
Page 11 of 17
Description
Field
ID
Group1
Group2
Group3
Group4
Group5
see the ID
see the ID
see the ID
see the ID
see the ID
funclist
This table stores function information. Such information is used for shortcut definition and
permission management. This table must be configured at the factory.
Description
Data Type
Constraint
Remarks
(Length)
Function ID
INTEGER
Primary key This field is a self-increasing field.
Function name VARCHAR(64)
Function
INTEGER
The new firmware must be compatible with
shortcut ID
the old offline communication interface to
obtain shortcut functions.
funcname
statename
autochange
mon
statekey
This table stores status information.
Description
Data Type
(Length)
Status ID
INTEGER
Status value
INTEGER
State name
VARCHAR(64)
State description
VARCHAR(64)
Whether the state INTEGER
automatically changes
Constraint
Primary key
INTEGER
Remarks
This field is a self-increasing field.
Page 12 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
tue
wed
thu
fri
sat
sun
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
montime
tuetime
wedtime
thutime
fritime
sattime
suntime
statetimezone
This table stores time zone information of states.
Description
Data Type
Constraint
(Length)
State time zone ID
INTEGER
Primary key
State time zone name VARCHAR(64)
Time on Monday
Time on Tuesday
Time on Wednesday
Time on Thursday
Time on Friday
Time on Saturday
Time on Sunday
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
Remarks
This field is a self-increasing field.
statelist
This table stores the mappings between state keys and time.
Description
Data Type
Constraint
Remarks
(Length)
ID of the state change INTEGER
Primary key This field is a self-increasing field.
time
Name of a state key
VARCHAR(64)
For the value range of this field, see the
funcname field in the statekey table.
State time zone name VARCHAR(64)
For the value range of this field, see the
statetimezonename field in the
statetimezone table.
Page 13 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
keyfunc
This table stores the functions and status of shortcut keys.
Description
Data Type
Constraint
Remarks
(Length)
Shortcut key ID
INTEGER
Primary key This field is a self-increasing field.
Shortcut key name
VARCHAR(64) Unique
For the value range of this field, see the
Key_Name field in the KEY_CODE
table. The KEY_CODE table is fixed,
and cannot be configured or obtained.
Information of the key field is stored in
the KEY_CODE table.
The key field has the following value
options:
F1: key F1
F2: key F2
F3: key F3
F4: key F4
F5: key F5
F6: key F6
F7: key F7
F8: key F8
up: up arrow key
down: down arrow key
right: right arrow key
left: left arrow key
ok: key Enter
star: asterisk key (*)
funcname
Function
name
or
state
VARCHAR(64)
Page 14 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
flag
INTEGER
HID_FORMAT
This table stores information of HID card formats.
Page 15 of 17
Field
ID
Description
Data Type
(Length)
INTEGER
BYTE_T
Format_Name
Card format ID
Number of bits in the
card number
Format name
Card_Format
Card format
VARCHAR(64)
First_Even
VARCHAR(64)
Second_Even
First_Odd
VARCHAR(64)
VARCHAR(64)
Second_Odd
Format_Type
VARCHAR(64)
INTEGER
Status
Enabled or not
INTEGER
Card_Bit
Constraint
Primary key
VARCHAR(24)
Remarks
This field is a self-increasing field.
For example, 26 and 34.
For
example,
wiegand26
and
wiegand34.
For
example,
ECCCCCCCCCCCCCCCCCCCCCC
CCO.
In this example:
E: indicates the first even check
position.
e: indicates the second even check
position.
O: indicates the first odd check
position.
o: indicates the second odd check
position.
c or C: indicates the card number.
m or M: indicates the manufacturer
code (manufactureCode).
f or F: indicates the facility code
(facilityCode).
s or S: indicates the site code
(siteCode).
For
example,
01111111111110000000000000,
in
which 1 indicates the data intended for
even check.
This field is reserved for future use.
For
example,
00000000000001111111111110,
in
which 1 indicates the data intended for
odd check.
This field is reserved for future use.
Value options are as follows:
1: output
2: internal wiegand input
3: external wiegand input
Value options are as follows:
0: no
1: yes
oplogs
This table stores operation log information.
Description
Data Type Constraint
(Length)
Remarks
Page 16 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
ID
OpType
Operation log ID
Operation type
INTEGER
INTEGER
Operator
Operator
OpTime
Operation time
OpWho
Operated person
Value1
Value2
Value3
Additional data
Additional data
Additional data
VARCHA
R(24)
VARCHA
R(24)
VARCHA
R(24)
INTEGER
INTEGER
INTEGER
Primary key
Page 17 of 17
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com