User Records

User records come to the device through a “new” or an “updated” database. This ability is controlled through the “deleteAll” tag. When the “deleteAll” tag value is set to “1”, the device gets a new user database. When this value is set to “0”, the device gets an update to the existing user database. For the reader-controller, a user database of up to 64,000 records is required. 

For the device to support 64,000 records, a mechanism for multiple transfers of up to 5000 records at a time is required. This is accomplished using the “partialDB” tag. The “partialDB” value starts at 1 and is incremented for each group of up to 5000 records. The final group of records is sent with a “partialDB” value of “255” denoting that this is the final transfer. NOTE: When the “partialDB” tag is used, it takes priority over the “deleteAll” tag (i.e., “deleteAll” is ignored if “multi” is non-zero”.)  A “partialDB” value of “0” indicates that there is not a multiple transfer database being sent. 

There are instances when a completely new database is sent to the device. This happens under two conditions: 

1. When the ENGAGE device is programmed for the very first time.

2. When the Host device determines that the differences between the device’s existing database and the new database are too numerous.

When the host sends user records to the device, the records are grouped in terms of user records that will be deleted, updated, or added to the device. The order in which these records are sent from the host must be in that same order: delete, update and add. All four of the tags (deleteAll, delete, update, add) must be included inside the db tag, even if there is no applicable user record changes to the respective tag. When user records need to be updated within the ENGAGE device, it is logical that the device has knowledge of which records need to be deleted before updating and adding new user records.

For the purposes of updating a user record, the entire user record is sent from the host. The record includes data that needs to be updated along with data that does not need to be updated.

When an individual user record needs to be deleted, only the primary credential ID and primary credential type is sent as the identifier for that record.

A user record describes the parameters associated with each user of the access control device. A complete user record is delimited with several different JSON tags. The individual tags within a User Record are described in the Individual tags Within User Records table.

The order defined in the usrRcrd tag defines the searching order for the lock. As user records are modified, these are appended to the devices database. 

The credential records must be encrypted as specified in the Schlage ENGAGE Sort & Encryption document. <Q1: where is this document?  is it 09_ENGAGE_Credential_Sort_and_Encryption?>  <R2: need to add link to document.>

Examples of User Records (JSON)

deleteAll Tag Set

The following JSON data structure excerpt represents how the user record data structure might look if a user list was being sent for the very first time or when the current user list needs to be erased and populated with a new user list. Note the value of “deleteAll” is set to 1, which signifies that the database should replace the existing database.

{
 "db": {
    "usrRcrd": {
    "deleteAll": 1,
    "delete": [],
    "update": [],
    "add": [
     {
      "usrID": 64,
      "adaEn": 0,
      "actDtTm": "20140101000000",
      "expDtTm": "20200101000000",
      "fnctn": "norm",
      "crSch": [1, 3],
      "primeCr": "01020304050607080910111213141516",
      "prCrTyp": "card"
     },
     {
      "usrID": 146,
      "adaEn": 1,
      "actDtTm": "20100101000000",
      "expDtTm": "20200101000000",
      "fnctn": "norm",
      "crSch": [1, 3],
      "primeCr": "16151413121110090807060504030201",
      "prCrTyp": "card"
    }]
  }

deleteAll Tag Cleared

The following JSON data structure excerpt represents how the user record data structure might look if an updated user list was being sent to the device. This list might contain a set of users to delete, update and add.

NOTE: The value of “deleteAll” is set to 0, which signifies that the existing database in the device should be updated.

{
 "db": {
   "usrRcrd": {
   "deleteAll": 0,
   "delete": [
    {
     "primeCr": "02030405060708091011121314151617",
     "prCrTyp": "card"
    },
    {
     "primeCr": "17161514131211100908070605040302",
     "prCrTyp": "card"
    },
    {
     "primeCr": "03040506070809101112131415161718",
     "prCrTyp": "card"
    }
  ],
  "update": [
    {
     "usrID": 149,
     "adaEn": 1,
     "actDtTm": "20100101000000",
     "expDtTm": "20200101000000",
     "fnctn": "toggle",
     "crSch": [1],
     "primeCr": "16151413121110090807060504030201",
     "prCrTyp": "card"
    }
  ],
   "add": [
    {
     "usrID": 148,
     "adaEn": 0,
     "actDtTm": "20100101000000",
     "expDtTm": "20200101000000",
     "fnctn": "norm",
     "crSch": [1],
     "primeCr": "01020304050607080910111213141516",
     "prCrTyp": "card"
    }
   ]
  },
 

deleteAll Tag Cleared, No User Records to Update

The following JSON data structure excerpt represents how the user record data structure might look if an updated database is sent that contains no updates to the user records. Note the delete, update, and add records are empty ( [] ), which signifies that there are no records to delete, add, or update.

{
 "db": {
  "usrRcrd": {
   "deleteAll": 0,
   "delete": [],
   "update": [],
   "add": []
 },

Last Modified: October 30, 2019