ACCESS CONTROL INTEGRATION

NCheck Bio Attendance Standard clients can be integrated with access controls such as door, gate, etc. NCheck Bio Attendance Standard client for Windows support either an external executable(.EXE) or web request provided by the third-party access controls. NCheck Bio Attendance Standard client for Android supports web request provided by the third-party access controls. NCheck Bio Attendance administrator allows to configure each client device to trigger access controls using provided APIs (.exe or REST API) in following client registration mode.

  1. Standard clients registered in Cloud/On-premises mode

    NCheck Bio Attendance administrator can configure peripherals adding peripheral configuration from the NCheck Bio Attendance web control panel as mentioned in manage peripheral configuration section.

  2. Standard clients registered in Standalone mode

    product administrator can configure peripherals adding peripheral configuration from the NCheck Bio Attendance Standard client control panel as mentioned in client control panel section.

Following diagram is showing how the NCheck Bio Attendance Standard clients should be connected with the access controls system.

_images/image60.PNG

Figure 30 Access controlling with NCheck

  1. NCheck Bio Attendance Standard client for Windows

    1. If the client registration mode is cloud, NCheck Bio Attendance server installation is not required

    2. If the client registration mode is standalone, NCheck Bio Attendance server is not required

  2. Android device installed with NCheck Bio Attendance Standard client for Android

    Device has connected to the network using WIFI.

  3. Camera

  4. Door magnet

  5. Door control unit

  6. Power source for the magnet and door control unit

  7. Network switch

  8. Wifi router

    To connect the android device to the network

In successful check-in or check-out provided external executable or API by the access control manufacturer will be executed by the clients. Administrator allows to select the required parameter in order to pass to the provided API to trigger the access control. Please refer Parameters section for more details about available parameters.

Parameters

Following parameter(s) can be passed in to the access control using the provided API.

Table 21 Parameters for access controls

Parameter name

parameter key

Parameter value

Event

EVENT

Event type as CHECKIN, CHECK-OUT or UNIDENTIFIED

Sequence id

SEQUENCE_ID

Id of the event

Time stamp

TIMESTAMP

Date and time of the event

User reference

USER_REF

Employee code of the user

User name

USER_NAME

First name and last name of the user event recorded

Shift code

SHIFT_CODE

Shift code of the NCheck Bio Attendance Standard clients. In the standalone mode shift code is DEFAULT

Location

LOCATION

Longitude and latitude of the event geo-location. Example: {Longitude, latitude}

User status

USER_STATUS

User is blocked or not. Pass 0 if the user has blocked otherwise 1

Address

ADDRESS

Address of the user

Peripheral code

PERIPHERAL_CODE

Unique identified number of the peripheral

Trigger access control

Selected parameters will be passed with the provided API as follows.

Table 22 Format of the parameters passed into the API

API type

Format

External executable

  1. Value of the parameters will be separated with empty space as {.exe path} {parameter value 1} {parameter value 2} {parameter value 3}

  2. Example: doorControl.exe CHECK_IN

REST API

  1. URL parameters as {url}?{Paramter1}={value}&{Paramter2}={value} & {Paramter3}={value}

  2. Example: https://192.168.2.12:3215/doorControl? EVENT=CHECK-IN