Difference between revisions of "Fingerprint Service Log"

From sbv.wiki
Jump to: navigation, search
(Admin Log)
 
(15 intermediate revisions by one user not shown)
Line 3: Line 3:
 
There are 2 logs maintained. Time Log records all punches made at the time clock while Admin Log records all other logs sent from the time clock.
 
There are 2 logs maintained. Time Log records all punches made at the time clock while Admin Log records all other logs sent from the time clock.
  
''' Admin Log '''
+
== Admin Log ==
  
 
The AdminLog will contain the following Message Types:
 
The AdminLog will contain the following Message Types:
Line 9: Line 9:
 
* Admin Log Received
 
* Admin Log Received
 
* Device Connection Changed
 
* Device Connection Changed
* New Finger print
+
* New Fingerprint
  
'' Admin Log Received ''
+
''' Admin Log Received '''
  
This message type represents multiple actions. The action can been seen in the JsonData column.
+
This message type represents multiple actions. The action can been seen in the JsonData column. Multiple messages (of the same message type) can be sent in the same payload and will create a single Admin Log record.
  
When the clock does not have an employee with the User ID sent then it will have the action of "Insert User"
+
* Insert User - when a time clock receives a user that is not in the time clock, the clock sends an "Insert User" message.
  
[{"access_control":false,"action":"Insert User","admin_id":"","log_id":29,"result":0,"time":"Jan 1, 2019 10:29:05 PM","timezone_offset":"GMT-05:00","user_id":"10000"}]
+
<nowiki>{"access_control":false,"action":"Insert User","admin_id":"","log_id":29,"result":0,"time":"Jan 1, 2019 10:29:05 PM","timezone_offset":"GMT-05:00","user_id":"10000"}</nowiki>
  
When the clock has an employee with the User ID sent then it will have the action of "Update User"
+
* Update User - when a time clock receives a user that is already in the time clock, the clock sends an "Update User" message. This log has been deprecated.
  
[{"access_control":false,"action":"Update User","admin_id":"","log_id":31,"result":0,"time":"Jan 1, 2019 10:32:50 PM","timezone_offset":"GMT-05:00","user_id":"10000"}]
+
<nowiki>{"access_control":false,"action":"Update User","admin_id":"","log_id":31,"result":0,"time":"Jan 1, 2019 10:32:50 PM","timezone_offset":"GMT-05:00","user_id":"10000"}</nowiki>
  
DeviceConnectionChanged - occurs when the clock connects or disconnects from the service. Also occurs when the service is restarted. JsonData will contain true or false.
+
* Enroll Backup Fp - sent when a fingerprint is enrolled. The actual fingerprint data will be sent in the message type New Fingerprint.
  
NewFingerprint - occurs when the user enrolls an employee at the time clock but also when a fingerprint
+
<nowiki>{"access_control":false,"action":"EnrollBackupFp","admin_id":"","log_id":30,"result":6,"time":"Jan 1, 2019 10:30:55 PM","timezone_offset":"GMT-05:00","user_id":"10000"}</nowiki>
  
[{"finger_number":6,"template":"(Fingerprint data)","user_id":"10000"}]
+
* App Version - sent after Clean DB is done at the clock, or a Reset Device is sent from the management software.
 +
 
 +
<nowiki>{"access_control":false,"action":"App Version","admin_id":"","data":"eyJWZXJzaW9uTmFtZSI6IlNla3VyZUlEIEFwcCAyLjguMTArIiwiRGJWZXJzaW9uIjoiMS4zOCIs\nIlBsdWdpbnMiOlsiVGltZWNvIDMuNDkrIl19\n","log_id":1,"result":1,"time":"Jan 1, 2019 11:20:23 PM","timezone_offset":"GMT-05:00","user_id":""}</nowiki>
 +
 
 +
* Turn On - sent when a time clock powers on
 +
 
 +
<nowiki>{"access_control":false,"action":"TurnOn","admin_id":"","log_id":32,"result":0,"time":"Jan 1, 2019 11:06:56 PM","timezone_offset":"GMT-05:00","user_id":""}</nowiki>
 +
 
 +
* BatchSet Wifi - sent when the clock powers on and the clock is using Wi-Fi.
 +
 
 +
<nowiki>{"access_control":false,"action":"BatchSet_Wifi","admin_id":"","log_id":33,"result":0,"time":"Jan 1, 2019 11:07:00 PM","timezone_offset":"GMT-05:00","user_id":"0"}</nowiki>
 +
 
 +
* BatchSet Wired Net - sent when the clock powers on and the clock is using an Ethernet cable.
 +
 
 +
<nowiki>{"access_control":false,"action":"BatchSet_WiredNet","admin_id":"","log_id":36,"result":0,"time":"Jan 1, 2019 11:14:58 PM","timezone_offset":"GMT-05:00","user_id":"0"}</nowiki>
 +
 
 +
''' DeviceConnectionChanged '''
 +
 
 +
This occurs when the clock connects or disconnects from the service. Also occurs when the service is restarted. JsonData will contain true or false.
 +
 
 +
''' NewFingerprint'''
 +
 
 +
This occurs when the user enrolls an employee at the time clock. There is also a log when the service sends a fingerprint to the time clock but this log is created by the service and the serial number will be "server".  The Jsondata is similar but the serial number is "server" when the fingerprint is sent from the service to the time clock, and it is the serial number of the time clock when the clock sends the fingerprint.
 +
 
 +
<nowiki>{"finger_number":6,"template":"(Fingerprint data sent from clock)","user_id":"10000"}</nowiki>
 +
 
 +
<nowiki>{"user_id":"10000","finger_number":6,"template":"(Fingerprint data sent to clock)"}</nowiki>
 +
 
 +
== Time Log ==
 +
 
 +
One record per punch is created even if the time logs are sent together in one payload.

Latest revision as of 22:52, 13 April 2020

This topic is for advanced users

There are 2 logs maintained. Time Log records all punches made at the time clock while Admin Log records all other logs sent from the time clock.

Admin Log

The AdminLog will contain the following Message Types:

  • Admin Log Received
  • Device Connection Changed
  • New Fingerprint

Admin Log Received

This message type represents multiple actions. The action can been seen in the JsonData column. Multiple messages (of the same message type) can be sent in the same payload and will create a single Admin Log record.

  • Insert User - when a time clock receives a user that is not in the time clock, the clock sends an "Insert User" message.
{"access_control":false,"action":"Insert User","admin_id":"","log_id":29,"result":0,"time":"Jan 1, 2019 10:29:05 PM","timezone_offset":"GMT-05:00","user_id":"10000"}
  • Update User - when a time clock receives a user that is already in the time clock, the clock sends an "Update User" message. This log has been deprecated.
{"access_control":false,"action":"Update User","admin_id":"","log_id":31,"result":0,"time":"Jan 1, 2019 10:32:50 PM","timezone_offset":"GMT-05:00","user_id":"10000"}
  • Enroll Backup Fp - sent when a fingerprint is enrolled. The actual fingerprint data will be sent in the message type New Fingerprint.
{"access_control":false,"action":"EnrollBackupFp","admin_id":"","log_id":30,"result":6,"time":"Jan 1, 2019 10:30:55 PM","timezone_offset":"GMT-05:00","user_id":"10000"}
  • App Version - sent after Clean DB is done at the clock, or a Reset Device is sent from the management software.
{"access_control":false,"action":"App Version","admin_id":"","data":"eyJWZXJzaW9uTmFtZSI6IlNla3VyZUlEIEFwcCAyLjguMTArIiwiRGJWZXJzaW9uIjoiMS4zOCIs\nIlBsdWdpbnMiOlsiVGltZWNvIDMuNDkrIl19\n","log_id":1,"result":1,"time":"Jan 1, 2019 11:20:23 PM","timezone_offset":"GMT-05:00","user_id":""}
  • Turn On - sent when a time clock powers on
{"access_control":false,"action":"TurnOn","admin_id":"","log_id":32,"result":0,"time":"Jan 1, 2019 11:06:56 PM","timezone_offset":"GMT-05:00","user_id":""}
  • BatchSet Wifi - sent when the clock powers on and the clock is using Wi-Fi.
{"access_control":false,"action":"BatchSet_Wifi","admin_id":"","log_id":33,"result":0,"time":"Jan 1, 2019 11:07:00 PM","timezone_offset":"GMT-05:00","user_id":"0"}
  • BatchSet Wired Net - sent when the clock powers on and the clock is using an Ethernet cable.
{"access_control":false,"action":"BatchSet_WiredNet","admin_id":"","log_id":36,"result":0,"time":"Jan 1, 2019 11:14:58 PM","timezone_offset":"GMT-05:00","user_id":"0"}

DeviceConnectionChanged

This occurs when the clock connects or disconnects from the service. Also occurs when the service is restarted. JsonData will contain true or false.

NewFingerprint

This occurs when the user enrolls an employee at the time clock. There is also a log when the service sends a fingerprint to the time clock but this log is created by the service and the serial number will be "server". The Jsondata is similar but the serial number is "server" when the fingerprint is sent from the service to the time clock, and it is the serial number of the time clock when the clock sends the fingerprint.

{"finger_number":6,"template":"(Fingerprint data sent from clock)","user_id":"10000"}
{"user_id":"10000","finger_number":6,"template":"(Fingerprint data sent to clock)"}

Time Log

One record per punch is created even if the time logs are sent together in one payload.