Professional Documents
Culture Documents
Date
Date: 2013-09-06
Reviewed By:
Date:
Approved By:
Date:
Page 1 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
Change History
Changed By
Date
Version
Page
Description
Effective
Date
Page 2 of 18
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]........................................................................................................................11
2.10 Holiday Time Zone [accholiday]....................................................................................................................... 11
2.11 Unlock Combination for Access Control [accunlockcomb].............................................................................. 12
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].............................................................................................. 16
2.18 Operation Log Information [oplogs]..................................................................................................................17
Page 3 of 18
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 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
2 Data Dictionary
sms
PK
usersms
ID
LONG
StartTime
ValidTime
Type
Content
T E X T (2 4 )
LONG
LONG
T E X T (3 2 0 )
PK
ID
LONG
smsid
userid
LONG
T E X T (2 4 )
ID
INTEGER
I1
PIN2
Fingerid
Valid
Size
Template
INTEGER
INTEGER
INTEGER
INTEGER
C H A R (0)
PK
ID
INTEGER
I1
PIN2
FingerID
Valid
Size
Template
INTEGER
INTEGER
INTEGER
INTEGER
C H A R (0)
PK
ID
INTEGER
Verification
VaildHoliday
Timezone 1
Timezone 2
Timezone 3
LONG
LONG
LONG
LONG
LONG
user
PK
ID
INTEGER
PIN2
Pri
Name
Password
f
Group
h
IsGroupTz
verified
CardNo
TZ
valid
StartDatetime
EndDatetime
VaildCount
Timezone 1
Timezone 2
Timezone 3
VARCHAR(2 4 )
INTEGER
T E X T (4 8 )
T E X T (1 6 )
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
T E X T (2 4 )
T E X T (2 4 )
INTEGER
T E X T (2 4 )
T E X T (2 4 )
INTEGER
INTEGER
INTEGER
INTEGER
transaction
PK
workcode
PK
ID
LONG
W C _C o d e
W C _N a m e
T E X T (2 4 )
T E X T (2 4 )
ID
LONG
PIN2
verified
t i m e _second
status
workcode
RESERVED 1
RESERVED 2
T E X T (2 4 )
LONG
T E X T (2 4 )
LONG
T E X T (2 4 )
LONG
LONG
H I D _FORMAT
PK
statetimezone
PK
ID
LONG
statetimezonename
montime
tuetime
wedtime
thutime
fritime
sattime
suntime
T E X T (6 4 )
LONG
LONG
LONG
LONG
LONG
LONG
LONG
ID
INTEGER
C a r d _B i t
Format _N a m e
C a r d _Format
First _E v e n
Second _E v e n
First _O d d
Second _O d d
Format _T y p e
Status
INTEGER
VARCHAR (2 4 )
VARCHAR (6 4 )
VARCHAR (6 4 )
VARCHAR (6 4 )
VARCHAR (6 4 )
VARCHAR (6 4 )
INTEGER
INTEGER
PK
PK
PK
ID
LONG
funcname
statetimezonename
T E X T (6 4 )
T E X T (6 4 )
ID
LONG
statecode
funcname
statename
autochange
mon
tue
wed
thu
fri
sat
sun
LONG
T E X T (6 4 )
T E X T (6 4 )
LONG
LONG
LONG
LONG
LONG
LONG
LONG
LONG
PK
ID
LONG
OpType
Operator
OpTime
OpWho
Value 1
Value 2
Value 3
LONG
T E X T (2 4 )
T E X T (2 4 )
T E X T (2 4 )
LONG
LONG
LONG
templatev1 0
accunlockcomb
accgroup
acctimezone
statekey
statelist
O P _L O G S
fptemplate 0 9
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
Group 1
Group 2
Group 3
Group 4
Group 5
LONG
LONG
LONG
LONG
LONG
accholiday
PK
ID
LONG
Holiday _N a m e
StartDate
EndDate
Timezone
T E X T (2 4 )
LONG
LONG
LONG
K E Y _C O D E
PK
ID
LONG
K e y _N a m e
R e s _I D
K e y _Value
T E X T (6 4 )
LONG
LONG
keyfunc
PK
ID
LONG
Key
funcname
flag
T E X T (6 4 )
T E X T (6 4 )
LONG
funclist
PK
ID
LONG
funcname
funid
T E X T (6 4 )
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 18
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 18
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 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
INTEGER
PIN2
Fingerprint number
FingerID
Fingerprint ID of a INTEGER
user
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
10: fingerprint and password
11
11: PIN, fingerprint, and password
12
12: fingerprint and card
13
13: PIN and fingerprint
14
14: fingerprint, password, and card
15
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
State_No field in the SHORT_STATE
table.
250
0-250
250: normal attendance records
252
252:
attendance
records
saved
in
unauthorized time zones
253
253: attendance records with unauthorized
unlock combinations
Page 8 of 18
workcode
Work code
INTEGER
RESERVED1
Number of the
fingerprint reader
Attendance
record flag
INTEGER
254
254: attendance records in which the user
exists but is invalid
255
255: no attendance records
For the value range of this field, see the ID
field in the WORK_CODE table.
This field is reserved for future use.
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
ValidTime
sms
This table stores information related to SMS messages.
Description
Data Type
Constraint
(Length)
INTEGER
SMS message ID
Primary key
Start
time
for VARCHAR(24)
validating an SMS
message
Number of valid INTEGER
minutes
Type
INTEGER
Content
VARCHAR(320)
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
65535
1-65535
65535: number of valid minutes
Value options are as follows:
0xFD
0xFD: public message
0xFF
0xFF: draft message
0xFE
0xFE: personal message
This field contains a maximum of 320
single-byte characters or 160 Unicode
characters.
Page 9 of 18
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_INFO table.
VARCHAR(24)
PIN of a user
For the value range of this field, see the
User_PIN field in the USER_INFO
table.
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
Page 10 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
VaildHoliday
Timezone1
Timezone2
Timezone3
accgroup
This table stores access control group information.
Description
Data Type
Constraint
Remarks
(Length)
INTEGER
Group ID
Primary key This field is a self-increasing field.
INTEGER
Group
Value options are as follows:
verification mode
0: fingerprint, password, or card
1: fingerprint
2: PIN
3: password
4: card
5: fingerprint or password
6: fingerprint or card
7: password or card
8: PIN and fingerprint
9: fingerprint and password
10
10: fingerprint and card
11
11: password and card
12
12: fingerprint, password, and card
13
13: PIN, fingerprint, and password
14
14: fingerprint and card, or fingerprint and PIN
The default value is 0.
Is the holiday INTEGER
valid or not
INTEGER
Time zone
For the value range of this field, see the ID
field in the acc_timezone table.
The default value is 1.
INTEGER
Time zone
For the value range of this field, see the ID
field in the acc_timezone table.
The default value is 0.
INTEGER
Time zone
For the value range of this field, see the ID
field in the acc_timezone table.
The default value is 0.
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 acc_timezone table.
The default value is 0.
Page 11 of 18
accunlockcomb
This table stores information of unlock combinations.
Description
Data Type
Constraint
Remarks
(Length)
ID of an unlock INTEGER
Primary key This field is a self-increasing field.
combination
INTEGER
Group ID
For the value range of this field,
field in the acc_group table.
INTEGER
Group ID
For the value range of this field,
field in the acc_group table.
INTEGER
Group ID
For the value range of this field,
field in the acc_group table.
INTEGER
Group ID
For the value range of this field,
field in the acc_group table.
INTEGER
Group ID
For the value range of this field,
field in the acc_group table.
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.
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
Remarks
This field is a self-increasing field.
Page 12 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
mon
INTEGER
tue
INTEGER
wed
thu
fri
sat
sun
INTEGER
INTEGER
INTEGER
INTEGER
INTEGER
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
State_Name
field
in
the
SHORT_STATE table.
Page 13 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
statetimezonena
me
VARCHAR(64)
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
F1: key F1
F2
F2: key F2
F3
F3: key F3
F4
F4: key F4
F5
F5: key F5
F6
F6: key F6
F7
F7: key F7
F8
F8: key F8
up
up: up arrow key
down
down: down arrow key
right
right: right arrow key
left
left: left arrow key
ok
ok: key Enter
star
star: asterisk key (**)
funcname
Function
name
or
state
VARCHAR(64)
well
well: pound key (##)
backspace
backspace: key Backspace
For the value range of this field, see the
Func_Name field in the Func_List
table or State_Name field in the
SHORT_STATE table.
The Func_List table is fixed, and
cannot be configured or obtained.
Information of the funcname field is
stored in the Func_List table.
The funcname field has the following
value options:
adduser
adduser: Add a user.
Page 14 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
flag
INTEGER
userlist
userlist: user list
netset
netset: network setting
serialset
serialset: serial port setting
linkset
linkset: connection setting
mobilenet
mobilenet: mobile network
wifiset
wifiset: Wi-Fi setting
admsset
admsset: ADMS setting
wiegandset
wiegandset: wiegand setting
enrollnumcard
enrollnumcard: Enroll a number card.
enrollfpcard
enrollfpcard: Enroll a fingerprint card.
clearcard
clearcard: Clear card information.
copycard
copycard: Copy card information.
setcardparam
setcardparam: card parameters
timeset
timeset: date and time
attparam
attparam: attendance parameters
fpparam
fpparam: fingerprint parameters
restoreset
restoreset: Restore factory settings.
udiskupgrade
udiskupgrade: USB disk upgrade
displayset
displayset: display setting
voiceset
voiceset: voice setting
bellset
bellset: bell setting
shortcutsset
shortcutsset: shortcut key setting
cleardata
cleardata: Clear data.
backupdata
backupdata: Back up data.
restoredata
restoredata: Restore data.
udiskupload
udiskupload: USB disk-based upload
udiskdownload
udiskdownload: USB disk-based
download
attlog
attlog: attendance logs
attpic
attpic: attendance picture
blacklistpic
blacklistpic: blacklist picture
addsms
addsms: Add an SMS message.
smslist
smslist: SMS message list
addworkcode
addworkcode: Add a work code.
workcodelist
workcodelist: work code list
workcodesetting
workcodesetting: work code setting
datacapacity
datacapacity:
data
capacity
information
devinfo
devinfo: device information
firmwareinfo
firmwareinfo: firmware information
libworkcode
libworkcode: work code
libsms
libsms: public SMS message
librecord
librecord: query of personal records
libaccesscontrol
libaccesscontrol: asking for help
Note: Function settings must be based
on the actual functions of the time and
attendance application.
Value options are as follows:
0: state key
1: function key
100
100: undefined
Page 15 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
Format_Name
HID_FORMAT
This table stores information of HID card formats.
Description
Data Type
Constraint
(Length)
Card format ID
INTEGER
Primary key
Number of bits in the BYTE_T
card number
Format name
VARCHAR(24)
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
ID
Card_Bit
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
manufactureCode
code (manufactureCode
manufactureCode).
f or F: indicates the facility code
facilityCode
(facilityCode
facilityCode).
s or S: indicates the site code
siteCode
(siteCode
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
Page 16 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com
oplogs
This table stores operation log information.
Description
Data Type Constraint
(Length)
Operation log ID
INTEGER Primary key
Operation type
INTEGER
Operator
Operator
OpTime
Operation time
OpWho
Operated person
Value1
Additional data
Remarks
This field is a self-increasing field.
Value options are as follows:
4: Access a menu.
5: Modify settings.
6: Enroll a fingerprint.
7: Enroll a password.
8: Enroll a HID card.
9: Remove a user.
10
10: Remove a fingerprint.
11
11: Remove a password.
12
12: Remove an RF card.
13
13: Clear data.
14
14: Create an MF card.
15
15: Enroll an MF card.
16
16: Register an MF card.
17
17: Remove MF card registration.
18
18: Clear the contents of an MF card.
19
19: Move registration data to a card.
20
20: Copy data from a card to the time and
attendance application.
21
21: Set the time.
22
22: Restore factory settings.
23
23: Remove entry/exit records.
24
24: Clear administrator rights.
25
25: Modify settings of an access control
group.
26
26: Modify access control settings of a
user.
27
27: Modify the time zone for access
control.
28
28: Modify settings of unlocking
combinations.
29
29: Unlock the door.
30
30: Enroll a new user.
31
31: Modify fingerprint attributes.
32
32: Cause alarms forcibly.
34
34: Prevent unauthorized following.
35
35: Remove an attendance picture.
36
36: Modify other information of a user.
VARCHA
R(24)
VARCHA
R(24)
VARCHA
R(24)
INTEGER
Page 17 of 18
Value2
Value3
Additional data
Additional data
INTEGER
INTEGER
Page 18 of 18
ZKSoftwareZKAccess ZKiVision ZKBiolock ZKAFIS ZKTeco
1998-2012
www.zkteco.com