CLIENTS

NCheck Bio Attendance Client is used as a client application for NCheck Bio Attendance server. It is mainly used to record attendance. It also can be used as a standalone attendance device. NCheck Bio Attendance client has two applications

  1. NCheck Bio Attendance Lite client

    NCheck Bio Attendance Lite client is a simple client application with minimal required functionality for Windows, Android and IOS.

  2. NCheck Bio Attendance Standard client

    NCheck Bio Attendance Standard client for Windows and Android includes client-side biometric extraction and matching which provides advanced functions like automatic face recognition, face capturing and offline operation. The Standard client requires a NCheck Bio Attendance license

  3. NCheck Bio Attendance Surveillance client for Windows

    NCheck Bio Attendance Surveillance client for Windows support all the features in NCheck Bio Attendance Standard client for Windows with guard functionality in which an authorized person can manually identify the person and record the event in the attendance system

  4. NCheck Bio Attendance Guard client for Android

    NCheck Bio Attendance Guard for Android application provide functionality which an authorized person can manually identify person and record event in the attendance system.

System requirement

Table 63 System requirements for clients applications

Lite

Standard

Surveillance/Guard

Windows

  1. Microsoft Windows 8 or higher operating system

  2. 1GB of disk space

  3. 2GB of RAM

  4. Supported Face peripheral

  1. Microsoft Windows 8 or higher operating system

  2. 1GB of disk space

  3. 4GB of RAM

  4. One supported peripheral as mentioned in the in Peripherals section

  1. Microsoft Windows 8 or higher operating system

  2. 1GB of disk space

  3. 8GB of RAM

  4. Supported Face peripheral

Android

  1. Android phone or tablet running Android 4.4 OS or later version

  2. 1 GB Of RAM

  3. Integrated camera

  1. Android phone or tablet running Android 4.4 OS or later version

  2. 2 GB of RAM

  3. USB OTG (USB On the Go) feature if using peripherals as mentioned in the in Peripherals section

  1. Android phone or tablet running Android 4.4 OS or later version

  2. Integrated camera

IOS Client

Apple device running IOS 10.2 OS or later

Not available

Not available

Peripherals

NCheck Bio Attendance client applications supports following peripherals.

  1. Face

  2. Fingerprint

  3. Iris

  4. Other

Note

NCheck Bio Attendance installer for Windows is installing all necessary drivers in order to enable face, fingerprint and iris scanners. But in case if you need additional drivers, you may need to install compatible drivers in the computer. You can download drivers for supportable camera, fingerprint and iris scanners from scanner driver package <https://www.ncheck.net/scanner-drivers>`_. <https://www.ncheck.net/scanner-drivers/>`_

Face

NCheck Bio Attendance Android and IOS clients are using cameras available with the device. NCheck Bio Attendance Windows clients support following camera types.

  1. USB cameras

  2. IP cameras

USB cameras

In general, USB cameras working in Windows OS are supported.

IP cameras

Refer Neurotechnology guide for supported cameras section for all supported IP cameras. Refer Preferences section for add IP cameras for NCheck Bio Attendance Standard for Windows.

Fingerprint

NCheck Bio Attendance clients support external or internal USB fingerprint scanners. Refer Neurotechnology guide for supported fingerprint scanners and sensors for Windows standard client.

Iris

NCheck Bio Attendance clients support external or internal USB iris scanners. Refer Neurotechnology guide for supported iris scanners for Windows standard client`. <https://www.ncheck.net/supported-scanners-for-ncheck-standalone-version/iris-scanners>`_

Note

By default, iris scanners are disabled for Windows standard client. To enable, unzip necessary iris scanners from the IrisScanners folder in NCheck Bio Attendance installation folder (By default the installation folder is “C:Program FilesNeurotechnologyNCheck Bio Attendance”)

Other

NCheck Bio Attendance supports capturing other authentication data. Data capture is performed by using the following hardware.

Table 64 Hardware requirements for non-biometric identification

Lite

Standard

RFID

  1. External HID

  2. External Serial

NFC Support

Barcode

External HID

Using built-in camera

Access control

NCheck Bio Attendance Standard clients are able to trigger external executables with given parameters as mentioned in External executable section.

Supporting Locations

NCheck Bio Attendance uses operating system provided location services to capture the location of attendance events.

Note

For enabling location service from the operating system, please refer location service configuration for the relevant operating system.

Install Client

Download client

NCheck Bio Attendance clients application download from download page.

Install clients for Windows

Windows install includes all components of NCheck Bio Attendance. You need to select the required client (Lite or Standard) to install the client. Refer Install client For Windows section for more details

_images/image599.PNG

Figure 300 Select components of Windows installation

After successful installation you will be asked to activate license in NCheck Bio Attendance Standard clients, Surveillance client for Windows and Guard client for Android as mentioned in License Activation section. For NCheck Bio Attendance Lite client you will be asked to register the device as mentioned in Register clients section.

License Activation

NCheck Bio Attendance Client Standard needs to activate licenses. Please refer Activation section for more details.

Note

NCheck Bio Attendance Lite clients are free and not required to activate licenses.

After successful license activation, you will be asked to register the client application as mentioned in Register clients section.

Register clients

NCheck Bio Attendance Clients can be used with following modes

  1. NCheck Bio Attendance Cloud

  2. NCheck Bio Attendance server installed on-premises

  3. Standalone (Standard clients and Surveillance client only)

Registration process configures the application to work with one of the above three modes. Accessing registration can be done as the following ways

  1. Application will prompt you the registration dialogue in case it is not registered

  2. User registration option from the application menu.

Registration screen

Mode of registration

  1. Server URL

  2. Search server button

    Select this option to detect server URL. This option works if the server and client work in same network.

  3. Registration Token

  4. Scan barcode button

    Instead of entering registration token, users can scan barcode in Android client.

Cloud mode
Table 65 Registration views of cloud mode

Version

Cloud mode

Windows

Lite

_images/image600.PNG

Figure 301 Windows lite client registration view on cloud mode

Standard/Surveillance

_images/image601.PNG

Figure 302 Windows standard client registration view on cloud mode

Android

Lite/Guad

_images/image602.PNG

Figure 303 Android lite client registration view on cloud mode

Standard

_images/image603.PNG

Figure 304 Android standard client registration view on cloud mode

IOS

Lite

_images/image604.PNG

Figure 305 IOS lite client registration view on cloud mode

On-premises mode
Table 66 Registration views of on-premises mode

Version

On-premises mode

Windows

Lite

_images/image605.PNG

Figure 306 Windows lite client registration view on on-premises mode

Standard/ Surveillance

_images/image606.PNG

Figure 307 Windows standard client registration view on cloud mode

Android

Lite/Guard

_images/image607.PNG

Figure 308 Android lite client registration view on on-premises mode

Standard

_images/image608.PNG

Figure 309 Android standard client registration view on on-premises mode

IOS

Lite

_images/image609.PNG

Figure 310 IOS lite client registration view on on-premises mode

Standalone mode
Table 67 Registration views of standalone mode

Version

Standalone mode

Windows

Standard

_images/image610.PNG

Figure 311 Windows standard client registration view on standalone mode

Android

Standard

_images/image612.PNG

Figure 312 Android standard client registration view on standalone mode

Registration Token

To register the client application with cloud or on-premises server, a registration code is required. Registration code can be generated by an administrator. Depend on the registration code generation, the client application can be registered in the following two modes

  1. Group

    Please refer User group quick view section for more details about registering device for group of users. Once the device is registered, the selected group of people can use the attendance terminal to check-in and check-out.

  2. Personal

    Please refer User quick view section for more details about registering device for person. Once the device is registered as a personal device, the selected user only can perform check-in and check-out from the terminal.

Registration

Select the Connect button to proceed with registration. If the server has signed with the untrusted certificate, you will be asked to accept self-signed certificate as mentioned in SSL Certificate validation section. Successful registration will take you to Main view . Register button will be disabled if the mandatory fields are empty or Validation errors exist. Following error messages could be appeared in the registration screen.

Table 68 Error messages of device registration

Error code

Error message

2051

Failed to register with the NCheck Bio Attendance server {server URL}

2052

Failed to register with the registration code

2053

The registration token has already been used. Please generate new registration code or contact administrator

2054

Could not discover the NCheck Bio Attendance server URL

SSL Certificate validation

To start the NCheck Bio Attendance server, a valid SSL certificate must be added as mentioned in Server section. If any SSL certificate validation error occurred, you will be prompted the validation error as below.

Table 69 Certificate validation error dialogue

Client

Self-signed certificate prompt

Windows

_images/image613.PNG

Figure 313 Certificate validation error dialog for Windows client

Android

_images/image614.PNG

Figure 314 Certificate validation error dialog for Android client

  1. Title of the SSL certificate validation error dialogue

  2. Error message

  3. Actions

Main view

NCheck Bio Attendance client’s main views as follows,

  1. Main view for biometrics capture

  2. Main view for non-biometrics capture

Main view for biometrics capture

Table 70 Main view of clients

Version

Windows

Windows

Lite

_images/image617.PNG

Figure 315 Main view of Windows lite client

Standard

_images/image622.PNG

Figure 316 Main view of Windows standard client

Surveillence

_images/image623.PNG

Figure 317 Main view of Windows Surveillance client

Android

Lite

_images/image624.PNG

Figure 318 Main view of Android lite client

Standard

_images/image625.PNG

Figure 319 Main view of Android standard client

Guard

_images/image626.PNG

Figure 320 Main view of Android Guard client

IOS

Lite

_images/image627.PNG

Figure 321 Main view of IOS lite client

  1. Date and time

    Show the Time and date

  2. Menu button

    Refer Main menu section for more details.

  3. Status bar

    Refer connection status section for more details.

  4. Attendance view

  5. Single/multi face mode button

  6. Settings collapse button of Android clients

  7. Language menu of Windows clients

    Selected luggage will be applied to the application.

  8. Mask detection indicator

    Mask detection indicator is showing in the view according to the Mask detection setting and Mask detection threshold can be applied from either web control panel Client settings view or Client settings for device

Preferences

Table 73 Preferences of Android clients

Windows

Android

Lite

Not available

  1. Capture sound

  2. Crop face

  3. Capture quality

  4. Biometric authentication

  5. Enable logs

Standard

  1. Camera list

  1. Device settings

  2. Camera settings

  3. Power saving mode

  4. Security

  5. Debug mode

  6. Diagnostic report

Surveillance

  1. Camera list

  2. Surveillance engine properties

Not available

Guard

Not available

  1. Capture sound

  2. Crop face

  3. Enable auto capture

  4. Capture quality

  5. Enable logs

Capture sound

Enable to play the capturing sound when the image is capturing.

Crop face

Enable to crop face to increase the matching accuracy.

Biometric authentication

Note

Biometric authentication mode is available with NCheck Bio Attendance Lite clients for Android and IOS only.

Biometric authentication mode is available with NCheck Bio Attendance Lite clients for Android and IOS if following requirements are satisfied.

  1. Authentication utilities must be available with the Devices

    1. Android

      A Fingerprint scanner must be available with the device.

    2. IOS

      Finger ID or Touch ID features must be available with the device.

  2. Use in-built biometric verification on personal clients setting must be enabled.

NCheck Bio Attendance Lite clients support following authentication modes.

  1. Face

    This is the default biometric authentication mode. In this mode user must record the event, capturing face and NCheck Bio Attendance server authenticates the user in order to record the attendance.

  2. Finger ID

    This authentication mode available in NCheck Bio Attendance Android and IOS lit client if the device has a build in fingerprint scanner. Using this setting, Lite client is allowing to record attendance once the user verifies using the fingerprint scanner of the device. Before record the attendances, user must enroll finger templates from the device settings first.

  3. Face ID

    This authentication mode is available in NCheck Bio Attendance Lite client for IOS, if the device is supported for Face ID. Using this settings, Lite client will authenticate the captured face with IOS face id. Once the face verified, attendance will be record. Before use this mode, user must enroll face templates for the IOS device first.

Extract on server

Face details should be extracted to identify the faces in the captured image. Enable this setting to minimize the extraction delay on low performance devices.

Low CPU support

This setting has introduced for low CPU devices to lower the CPU usage when application in use. Enable this setting to preview captured face instead of showing the face rectangle (as mentioned in Face capture view section) with lower resolution preview.

Startup application

Enable this setting to start application on restart the device.

External scanner

NCheck Bio Attendance Standard can be used with external scanners in order to record attendances with extended user experiences. Currently NCheck Bio Attendance Standard supports below type of devices/scanners

_images/image633.PNG

Figure 328 External scanners view of Android standard client

  1. TPS980

    TPS980 is an Android Biometric Face recognition Terminal with infrared sensor and face recognition camera and fingerprint scanner. NCheck Bio Attendance Standard client can be installed to use with available sensors.

  2. HF-7000

    HF-7000 from HFSecurity is a fingerprint reader based on capacitive fingerprint sensor. The fingerprint scanner uses USB for communications with host PC or device. Refer this link for more information. To configure the NCheck Bio Attendance Standard

  3. Select External scanner from the scanner list

  4. Select configure button to configure the selected scanner.

  5. Select the feedback type from the list

    1. All events

      Select this option to apply scanner configuration across all scanners.

    2. External scanner events

      Select this option to apply scanner configuration to external scanner events. 3. Select the Configure button to customize the selected scanner configuration above.

      _images/image634.PNG

      Figure 329 TPS scanner configuration view

Mirror preview

Enable this to fix the mirror effect of the camera preview.

Enable app orientation

Enable this to fix the application ore as 0, 90, 180, 270 degrees.

Note

This setting may not be compatible with the devices, designed for a fix orientation Accelerometer and gyroscope sensors are not available

Rotation settings

Custom rotation settings need to be configured in case of camera orientation and device rotation settings return from the Android API are not same as standard Android devices. This applicable for the devices,

  1. Designed for a specific orientation

  2. Accelerometer and gyroscope sensors are not available

Camera orientation and device rotation can be set as follows, Camera orientation for a normal android device can be identified as follows.

Table 74 Camera orientation

Camera

Orientation

Front camera

270 degrees

Back camera

90 degrees

When the camera orientation has differences as mentioned above, this value can be set manually using these settings. Device rotation for a normal device can be identified as follows,

Table 75 Custom device rotation

Device orientation

Device rotation

_images/image636.PNG

0

_images/image638.PNG

1

_images/image639.PNG

2

_images/image640.PNG

3

User can set matching value for device rotation in special devices depending on the device orientation as above table.

Enable power saving mode

Reduce the CPU usage when application is idle.

Power saving mode timeout

The timeout can be select to set the device idle when no attendance recording. Available timeouts are

  1. 10 minutes

  2. 20 minutes

  3. 30 minutes

  4. 1 hour

Encrypt the database

Encrypt the database of NCheck Bio Attendance Standard client by giving a password.

Enable logs

Log all events to a file for debugging.

Diagnostic report

Generate Diagnostic report and send to developers for debugging.

Capture quality

Select face capture quality to reduce the time when recording events

  1. Low

  2. Medium

  3. High

  4. very high

Camera list

This option allows to configure IP cameras with NCheck Bio Attendance Windows Standard client application.

_images/image641.PNG

Figure 330 Camera list preference of Windows standard client

  1. Camera list table

    Camera list view as shown in Figure 331 .

    _images/image642.PNG

    Figure 331 Camera list view of camera list preference

    1. Name

    2. URL

      IP address of the camera

    3. Key

    4. Add button

      Add new camera.

    5. Remove button

      Remove selected camera.

  2. Apply button

    Update all camera in the camera list

  3. Cancel button

Surveillance engine properties
_images/image644.PNG
_images/image645.PNG

Figure 332 Surveillance engine properties of Surveillance client

  1. Use NVDIA GPU

    Enable/disable running surveillance engine on GPU

  2. Determine Age

    This enable/disable showing the age on top of the face rectangle in the attendance view.

  3. Determine gender

    This enable/disable showing the gender on top of the face rectangle in the attendance view.

  4. Determine Glasses

    This enable/disable showing the availability of glasses (whether the user is wearing spectacles) on top of the face rectangle in the attendance view.

  5. Apply button

  6. Cancel button

Enable auto capture

The capture mode of the Guard client can be changed as following.

  1. Manual capture

    The fault capture mode of the Guard client. When this mode has enabled, the Guard must capture the face manually pressing the capture button. To enable this mode, disable enable auto capture mode setting from the preference menu.

  2. Auto capture

    To enable this feature, enable “Enable auto capture mode” from the Preference menu. When the auto capture mode has enabled, the Guard client will be automatically detect the face and then extract once faced to the camera.

Connection status

Table 76 Connection status view of clients

Connection status view

Windows

Lite

_images/image646.PNG

Figure 333 Status bar view of Windows lite client

Standard/ Surveillance

_images/image647.PNG

Figure 334 Status bar view of Windows standard client

Android

Lite

_images/image648.PNG

Figure 335 Registration details of Android Lite client

Standard

_images/image649.PNG

Figure 336 Registration details of the Android standard client

Guard

_images/image650.PNG

Figure 337 tus bar of Guard client

  1. Network availability

  2. License status indicator

    Shows the current license obtaining status as licensed, trial or expired.

  3. Server and port

    URL and port of the connected server in cloud, on-premises or standalone mode

  4. Registered user/user group name

    Registered user/user group name is showing in cloud or on-premises mode. In standalone mode, “All users” will be shown.

  5. Organization name in the cloud or on-premises mode

  6. Connectivity status with the server indicator in cloud and on-premises mode as shown in below.

    Table 77 Online/Offline statuses of Standard clients

    Status

    Description

    Android standard client

    Windows standard client

    Online

    Connected with the server

    _images/image651.PNG
    _images/image652.PNG

    Offline

    Cannot connected with the server

    _images/image653.PNG
    _images/image654.PNG
  7. Synchronizing progress of the standard clients if the Offline operation mode is enabled.

  8. Email address if the Lite client registered to the user and Allow without biometrics setting has enabled.

  9. Server indicator for cloud, on-premises, and standalone mode.

Table 78 Server indicators for Clients

Mode

Indicator

Cloud

_images/image655.PNG

On-premises

_images/image656.PNG

Standalone

_images/image658.PNG
  1. Location restriction status

    Location restriction status indicates how far from the location coordinates where the location restriction applied as mentioned in Location restrictions section. Android Lite client uses Google location services to find the device location. Location restriction status indicated following details.

Status

View

Location is restricted. But user is inside the permitted radius

_images/image659.PNG

Figure 338 User inside the permitted area

Location is restricted. User is not inside the permitted radius.

_images/image660.PNG

Figure 339 User is not inside the permitted area

Location services are not available. Location services of the device has disabled or not available in the area.

_images/image661.PNG

Figure 340 Location coordinates are not available

Location has not restricted.

_images/image662.PNG

Figure 341 Location has not restricted

  1. Location restriction indicator

    Indicator will be turned to red if the user is not inside the permitted radius from the location coordinates where the location restriction applied. Otherwise it will be shown in green color.

  2. Distance

    Distance from location coordinates where the location restriction has been applied.

  3. Location accuracy

    This parameter indicates the accuracy of the distance. As shown in Figure 338 , the correct location can be anywhere between 11+ 14 meters and 11 - 14 meters.

The distance and location accuracy may not be accurate depending on the Google location service availability. Please refer this Google maps help for more details.

Main view for non-biometrics capture

Note

This feature is currently available with NCheck Bio Attendance Lite for Android only.

In NCheck Bio Attendance Lite for Android, users are allowed to record the events without presenting face biometrics. In order to enable this feature, Users must enabled the Allow without biometrics setting as mentioned in NCheck Bio Attendance control panel Client settings view or Device settings sections. The view is changing according to the enable/disable status of the  Manuel event selection setting in the NCheck Bio Attendance Client settings view or Block/unblock device/API as shown in Table 79 . When the Manuel event selection is enabled, user can select the event as check-in or check-out before record.

Table 79 Main views for non-biometric capture

Manuel event selection is disabled

Android Lite

_images/image663.PNG

Figure 342 Capture without biometric view of Android lite client

IOS Lite

_images/image664.PNG

Figure 343 Capture without biometric view for IOS Lite client

Manuel event selection is enabled

Android Lite

_images/image665.PNG

Figure 344 Capture without biometric view of Android lite client when manual event selection setting is enabled

IOS Lite

_images/image666.PNG

Figure 345 Capture without biometric view of IOS Lite

  1. Time

  2. Check-in/check-out icons

  3. Connection status

  4. User thumbnail

  5. Record event button

    Record the events

  6. Check-in button

    Record the check-in events

  7. Check-out button

    Record the check-out events

Attendance view

Attendance view shows attendance view screen. Attendance view Screen has the following components.

  1. Capture view

  2. Manuel event selection view

  3. Record event view

  4. Result view

  5. Recent events list

Following error could be occurred during capture.

Table 80 Error messages of record attendances

Error code

Error message

2002

License cannot be obtained

2055

Device has not registered. Please register the device first.

2056

The location is restricted. You are not allowed record attendance from this location

2042

Could not record events. The user has been blocked

2037

Could not record events. The device has been blocked

2043

Could not record event. Check-in time has restricted

2044

Could not record event. Check-out time has restricted

2057

You have already checked-in/checked-out. Please try again in {number of seconds} seconds.

2058

Attendances time has restricted. Please contact administrator for more details.

2059

No match found. Please make sure that face/fingerprint/iris templates have been enrolled before record attendance.

2060

Failed to identify the face/fingerprint/iris. Please try again.

2064

Could not record attendances. Invalid user id input.

2065

Could not record attendances. Peripherals are not ready. Please try again.

2067

User not allowed to Check-in while on Restricted Leave!

Capture view

The default capture view of the NCheck Bio Attendance Standard and Lite clients. Capture view can have a one or more capture device views. Those are

  1. Face capture view

  2. User ID input

  3. Fingerprint Capture view

  4. Iris Capture view

Capture view supportability in Lite and Standard can be identified as follows.

Table 81 Capture view supportability in clients

Lite

Standard

Surveillance

Guard

Face capture

_images/image35.PNG
_images/image35.PNG
_images/image35.PNG
_images/image35.PNG

User id input

_images/image36.PNG
_images/image35.PNG
_images/image36.PNG
_images/image36.PNG

Fingerprint capture view

_images/image35.PNG
_images/image35.PNG
_images/image36.PNG
_images/image36.PNG

Iris capture view

_images/image36.PNG
_images/image35.PNG
_images/image36.PNG
_images/image36.PNG

RFID capture view

_images/image36.PNG
_images/image35.PNG
_images/image36.PNG
_images/image36.PNG

Barcodecapture view

_images/image36.PNG
_images/image35.PNG
_images/image36.PNG
_images/image36.PNG
Table 82 Capture views of clients

Version

Lite

Windows

Lite

_images/image668.PNG

Figure 346 Capture view of Windows lite client

Standard

_images/image670.PNG

Figure 347 Capture view of Windows standard client

Surveillance

_images/image672.PNG

Figure 348 Capture view of Surveillance client

Android

Lite

_images/image674.PNG

Figure 349 Capture views of Android Lite client

Standard

_images/image676.PNG

Figure 350 Capture view of Android lite client

Guard

_images/image678.PNG

Figure 351 Capture view of Guard client

IOS

Lite

_images/image680.PNG

Figure 352 Capture view of IOS Lite client

  1. Face capture view

  2. Fingerprint Capture view

  3. Iris Capture view

  4. User ID input

  5. Face ID view

Face capture view

Table 83 : Face capture views of clients

Version

Windows

Lite

_images/image682.PNG

Figure 353 Face capture view of Window lite client

Standard

_images/image683.PNG

Figure 354 Face capture view of Window standard client

Surveillence

_images/image687.PNG

Android

Lite

_images/image688.PNG

Figure 355 Face capture view of Android lite client

Standard – Low CPU support is disabled.

_images/image690.PNG

Figure 356 Face capture view of Android standard client

Standard – Low CPU support is enabled

_images/image691.PNG

Figure 357 Face capture view when Low cpu mode enabled in Standard client

Guard

_images/image692.PNG

Figure 358 Face capture view of Guard client

IOS

Lite

_images/image693.PNG

Figure 359 Face capture views of IOS lite client

  1. Image preview

  2. Camera name

  3. Face rectangle

  4. Face liveness guidance

    Face liveness guidance in Standard clients if the Liveness setting has enabled.

  5. Capture button

    In Android Guard client, capture button will appear if Manual capture mode is turned on. Refer Capturing faces section for more details.

  6. Instruction for face capture

  7. Liveness Instruction

  8. Settings of the face capture view

  9. Resolution

  10. Flashlight

  11. Switch camera

  12. Multi face button

    Available in Lite clients. Refer Single/multi face mode face capturing for more details

  13. Turn on auto capture/manual capture modes

  14. Extracting image of the Android Standard client when Low CPU support has enabled

  15. Status text

    Status texts are available in NCheck Bio Attendance Standard client for Android when Low CPU support has enabled and Guard client

  16. Face ID view of IOS Lite client

    Table 84 Status texts of Android Standard and Guard clients

    Description

    Standard client - Low CPU support has enabled

    Guard client

    Face capturing in progress

    Detecting..

    Detecting..

    Face extraction in progress

    Extracting..

    Extracting..

    Face matching in progress in guard client

    Performing matching..

  17. Mask detection indicator

    Mask detection indicator is showing in the view according to the Mask detection setting and Mask detection threshold can be applied from either web control panel Client settings view or Client settings for device

Proceed to Capturing faces section for more detail about capturing face in client applications.

Capturing faces

  1. Face capturing in Standard client

  2. Face capturing in lite client

  3. Face capturing using Face ID in Lite client

  4. Multi face mode in Lite client

  5. Face capturing in Surveillance client of Windows and Guard client of Android

Face capturing in Standard client

Face capture for attendance recording is performed in the following steps.

  1. Face capture instruction “Stay facing camera” is shown

  2. The user faces to the camera

  3. If the face liveness setting is enabled, users can see the liveness guidance in the screen as mentioned in Face liveness mode section. Otherwise Standard client shows face rectangle and captures face automatically.

  4. The client performs attendance recording

  5. The Client will validate the user according the Authentication mode

Note

To enable face liveness, select face liveness mode from the Biometric settings view of NCheck Bio Attendance control panel.

Face capturing in lite client

o record attendance in the single face mode,

  1. Face capture instruction “Stay facing camera” is shown

  2. The user faces to the camera

  3. Select Capture button

  4. The client performs attendance recording

  5. If no template enrolled for the user, NCheck Bio Attendance lite client registered to a user will be asked to enroll face if the Self-enroll templates is enabled in the server as shown in Figure 360

    _images/image694.PNG

    Figure 360 Self enrollment in Android lite client

    1. Enroll button

      Enroll the captured image as face template.

  6. If templates exist, in successful event record, the Client will validate the user according the Authentication mode .

Face capturing using Face ID in Lite client

For NCheck Bio Attendance Lite client for IOS, face ID authentication mode can be selected form the Biometric authentication setting in the preferences. The Client will validate the user according the Authentication mode once the capture the face.

Multi face mode in Lite client

Multi face mode can be used to record attendances of the group of users from single capturing. This mode is available on NCheck Bio Attendance Lite clients registered with a user group and switched to the multi face mode. To record attendance in the multi face mode,

  1. Enable multi face mode in the Face capture view

  2. Capture the face image of the users the multi-face view will be shown as Table 85

Table 85 Face captured views of the multi face mode

Lite

Windows Client

_images/image695.PNG

Figure 361 Multi face captured view of Windows lite client

Android Client

_images/image696.PNG

Figure 362 Multi face captured view of Android lite client

IOS client

_images/image697.PNG

Figure 363 Multi face captured view of IOS lite client

  1. Unidentified users

    Unidentified users represent

    1. Users unable to identify when capturing (Ex: Not enough lighting condition, lower quality of the capturing images)

    2. Users are not available in the registered user group

  2. Identified users

  3. Record enable/disable button

    Select this button to record attendance of the identified/assigned user.

  4. Edit button

    This allows to assign unidentified face for selected user. To enable this settings, Manual face selection setting should enabled from the Device settings or Biometric settings view of NCheck Bio Attendance control panel. The face assign view is shown in Table 86 . In the face assign view select the user from the list to assign the face.

Table 86 Face assign view of the multi face mode

Lite client

Windows Client

_images/image698.PNG

Figure 364 face assign view of Windows lite client

Android Client

_images/image699.PNG

Figure 365 face assign view of Android lite client

IOS client

_images/image700.PNG

Figure 366 face assign view of IOS lite client

  1. Capture more button

    User can capture a new image to re-capture unidentified users.

  2. Record button

    The Client will validate the user according the Authentication mode

Face capturing in Surveillance client of Windows and Guard client of Android
  1. Follow the capturing mode

    1. Manual capture

      If the manual capturing is enabled, select the capture button

    2. Auto capture

      If the auto capture is enabled, stay facing to the camera until the client capture the image

  2. The client performs matching with the NCheck Bio Attendance server to select the matching event type as follows

    1. Surveillance client

      In Surveillance client, the event will be recorded and updated in the result view. Refer Result view for Surveillance client for Windows and Guard client for Android section for more details.

    2. Guard client

      In Guard client, once the face is captured, a record view will be prompted in order to compare the captured face and matching person face. Refer Record event view section for more details.

Fingerprint Capture view

For NCheck Bio Attendance standard clients, Capture view indicates finger print scanner is available. Once the fingerprint available, put the finger on fingerprint scanner to record the attendances. For NCheck Bio Attendance Lite clients for Android and IOS, fingerprint authentication mode can be selected form the Biometric authentication setting in the preferences.

Table 87 Fingerprint capture view of Android and IOS Lite clients

Android Lite

_images/image702.PNG

Figure 367 Fingerprint capture view of Android Lite client

IOS Lite

_images/image704.PNG

Figure 368 Fingerprint capture view of IOS Lite client

  1. Record Event button

    The Client will validate the user according the Authentication mode

Fingerprint authentication prompt for Android Lite

Fingerprint authentication prompt is shown in Figure 369

_images/image705.PNG

Figure 369 Fingerprint authentication prompt

  1. Fingerprint authentication prompt

    Once the fingerprint authentication prompt is appeared, Put the finger on the fingerprint scanner. After successful authentication, The Client will validate the user according the Authentication mode

  2. Cancel button

    Cancel the fingerprint authentication prompt.

Iris Capture view

Note

This view is available on NCheck Bio Attendance Standard clients for Windows only.

As shown in Capture view , NCheck Bio Attendance Standard client will indicates if the iris scanner is available.

_images/image706.PNG

Figure 370 Iris capture view

  1. Name of the iris scanner

  2. Left eye

  3. Right eye

Note

NCheck Bio Attendance Standard client support single and double side iris scanners.

After scan the iris, client will validate the user according the Authentication mode

User ID input

The following inputs are allowing in NCheck Bio Attendance Standard clients to record attendances

  1. Employee code input `

  2. RFID Input

  3. Barcode Input

Note

To record attendances, each user must have user Employee code, RFID and Barcode id as mentioned in Add/Edit users section

Employee code input

User ID input has the following controls

  1. ID Field

  2. Submit button

Table 88 User ID view of Standard clients

Standard client

Windows Client

_images/image708.PNG

Figure 371 User ID view of Windows standard client

Android Client

_images/image710.PNG

Figure 372 User ID view of Android client

Once the employee code is given, client will validate the user according the Authentication mode

RFID Input

User allows to use RFID scanner available with Android devices or external RFID scanners with the devices to scan RFID. Capturing RFID

  1. Put the RFID card/tab on the RFID scanner/Android device

  2. The Client will validate the user according the Authentication mode

Barcode Input

NCheck Bio Attendance Standard for Android client allows to scan the barcode using front or back camera or external barcode reader with your device. Capturing Barcode

  1. Scan barcode using the Barcode scanner

  2. The Client will validate the user according the Authentication mode .

Authentication mode

The authentication mode can be set to the selected peripheral from the NCheck Bio Attendance web control panel as mentioned in Manage peripheral configuration section or Client control panel (Standalone mode) as mentioned in Client peripheral configuration section. Following table shows authentication types availability for the NCheck Bio Attendance clients.

Table 89 Authentication modes availability for the clients

Authentication mode

Lite

Standard

Surveillance

Guard

Identification

_images/image35.PNG
_images/image35.PNG
_images/image35.PNG
_images/image35.PNG

Verification

_images/image36.PNG
_images/image35.PNG
_images/image36.PNG
_images/image36.PNG

None

_images/image36.PNG
_images/image35.PNG
_images/image36.PNG
_images/image36.PNG
Identification

The default authentication mode for NCheck Bio Attendance clients. Following table shows how the identification mode is working in clients.

Table 90 Identification in clients

Client

Identification

Lite and Standard client

Once the user identified using either form biometic or user id input, the client shows the Result view .

Surveillance and Guard client

Once the user is identifed using face biometric, the surveillance client will show the Result view for Surveillance client for Windows and Guard client for Android . The Guard client shows the Record event view appears.

Verification mode

In NCheck Bio Attendance standard clients, user can be verified using a biometric input and user id input. The verification UI flow can be changed from the NCheck Bio Attendance web control panel as mentioned in Manage peripheral configuration section or Client control panel (Standalone mode) as mentioned in Client peripheral configuration section as follows.

  1. User id first

    The client will be asked for a biometric input once a user id input is given first.

  2. Biometric first

    The client will be asked for a user id input once a biometric input is given first

When the user is verified, client show the Result view .

Manuel event selection view

Note

Manuel event selection is available for NCheck Bio Attendance Lite for Android and IOS and Standard client for Android only

Manuel event selection view allows to user to select the event type as check-in or check-out before record the attendance. To enable this feature, Manuel event selection setting from NCheck Bio Attendance Control panel Client settings view or Device settings should be enabled first. Manuel event selection is available for

  1. Manuel event selection of Lite clients

  2. Manuel event selection of Standard clients

Manuel event selection of Lite clients

Manuel event selection view for NCheck Bio Attendance Lite for Android and IOS appears according to the authentication mode selected from Biometric authentication setting in the Preferences.

Table 91 Manual event selection view of Lite clients

Lite client

Biometric authentication mode

View

Android

Face

_images/image712.PNG

Figure 373 Manuel event selection view of Android lite client

Finger ID

_images/image714.PNG

Figure 374 Manual event selection of finger ID view in Android Lite

IOS

Face

_images/image716.PNG

Figure 375 Manuel event selection view of IOS lite client

Finger ID

_images/image718.PNG

Figure 376 Manual event selection of face ID view in IOS Lite

_images/image720.PNG

Figure 377 Manual event selection of finger ID view in IOS Lite

Face ID

  1. Capture view

  2. Check-in button

    1. Face

      Attendance will be recorded as Check-in event once the user face is identified by the NCheck Bio Attendance server.

    2. Finger ID

      Attendance will be recorded as Check-in event once the finger is authenticated successfully as mentioned in Fingerprint authentication prompt for Android Lite section.

    3. Face ID

  3. Check-out button

    1. Face

      Attendance will be recorded as Check-in event once the user face is identified by the NCheck Bio Attendance server.

    2. Finger ID

      Attendance will be recorded as Check-out event once the finger is authenticated successfully as mentioned in Fingerprint authentication prompt for Android Lite section.

    3. Face ID

Manuel event selection of Standard clients

Manuel event selection views of the NCheck Bio Attendance Standard clients are shown in Table 92 .

Table 92 Manuel event selection in NCheck Bio Attendance standard clients

Android Lite

Android Standard

_images/image722.PNG

Figure 378 Manuel event selection view of Android standard client

  1. Organization logo

  2. Check-in button

    In Standard client, select check-in button to proceed to Capture view to record attendance as Check-in event.

  3. Check-out button

    In Standard client, select check-out button to proceed to  Capture view to record attendance as Check-out event.

Record event view

Note

This view available in NCheck Bio Attendance Guard client only

Once the face captured as mentioned in Face capturing in Surveillance client of Windows and Guard client of Android section, record view appears to side by side comparison of captured face image and matching face image of the user with the details such as user name and employee code as below.

_images/image723.PNG

Figure 379 Record event view

  1. Name of the view

  2. Application logo

  3. Side by side comparison view

  4. Matching list view

Side by side comparison view

Side by side comparison view represents both captured face image and matching user details to compare and proceed to record the event.

_images/image724.PNG

Figure 380 Side by side comparison view of Guard client

  1. Captured face image

    Captured face image of the user

  2. Selected person view

  3. Employee code selection

    If the person is not identified successfully by the server Guard can select the user manually by entering the employee code here

  4. Name and employee code of the selected person

  5. Event type as check-in or check-out

    Even type is not available for black list events

  6. Record button

    Record the event. The result will be appeared in the result view as mentioned in Result view for Guard client for Android section.

Selected person view

The person appeared in this view can be recorded by the Guard. The selected person can be,

  1. Whitelist person

  2. Blacklist person

  3. False match

Whitelist person

If the selected person is not blocked it is known as whitelist person

_images/image725.PNG

Figure 381 Whitelist event view of Guard client

  1. Matching score

    The score when matching user face biometric with the captured image.

  2. Matching face image

    Face image from the biometric face image of the matching users which has the highest matching score.

  3. Remove button

    Removed the selected person

The Guard allows to record the person as check-in or check-out.

Blacklist person

If the selected person is blocked, it is known as blacklist

_images/image726.PNG

Figure 382 Blacklist event view of Guard client

  1. Matching score

    The score when matching user face biometric with the captured image.

  2. Block indicator

    Block indicator appears if the user has blocked.

  3. Matching face image

    Face image from the biometric face image of the matching users which has the highest matching score.

  4. Remove button

    Removed the selected person

The Guard can record the event as blacklist.

False match

The captured person may not be existed in the database. In such cases, Guard can keep the selected person as empty (false match) and record the event.

Matching list view

This view is showing all identified person details. Once Guard selected a person from the list, selected user will be shown in Side by side comparison view either a Whitelist person or Blacklist person .

_images/image727.PNG

Figure 383 Close match list view of Guard client

  1. Selected user

  2. First name

  3. Employee code

  4. Matching score

    The score when matching user face biometric with the captured image.

  5. Biometric face image

    Face image from the biometric face image of the matching users which has the highest matching score

  6. Blocked indicator

Result view

Result view shows the recorded event details. Result view as follows,

  1. Result view for Standard and Lite clients

  2. Result view for Surveillance client for Windows and Guard client for Android

Result view for Standard and Lite clients

Result view for Single face mode

In the single face mode, the result view appears for the successful check-in or check-out events as follows.

Table 93 Result view of the single face mode

Lite

Standard

Windows

_images/image728.PNG

Figure 384 Result view of Windows lite client

_images/image728.PNG

Figure 385 Result view of Windows standard client

Android

_images/image730.PNG

Figure 386 Result view of Android lite client

_images/image732.PNG

Figure 387 Result view of Android standard client

IOS

_images/image733.PNG

Figure 388 Result view of IOS lite client

Not Available

  1. User profile image

  2. Username

  3. Event type

  4. Total work hours of the day

  5. Total work hours of the week

  6. Total work hours of the month

  7. Event recorded time

  8. Check-in limitation message

    If the number of check-in are lower than the maximum occupancy for group premises, check-in will be recorded successfully. Otherwise check-in will be restricted. Refer Maximum occupancy for group premises setting in the server for more details.

  9. Cancel button

    Cancel the event recorded. This button will disappear in few seconds after the event result view appeared.

Result view for multi face mode

Note

This view is available in NCheck Bio Attendance Lite clients only.

In multi face mode, result view appears with all users for all check-in check-out details as follows.

Table 94 Result view of the multi face mode

Lite

Windows Client

_images/image734.PNG

Figure 389 Result view of multi face mode in Windows lite client

Android Client

_images/image735.PNG

Figure 390 Result view of multi face mode in Android lite client

IOS client

_images/image737.PNG

Figure 391 Result view of multi face mode in IOS lite client

Result view for Surveillance client for Windows and Guard client for Android

As mentioned in Record event view section, NCheck Bio Attendance Guard client records following events.

  1. Whitelist event

    If the selected person by the Guard is not blocked and the event type as check-in or check-out

  2. Blacklist event

    If the selected person by the Guard is blocked, event will be recorded as blacklist

  3. False match event

    If the Guard select no person, the event will be recorded as false match.

As mentioned in Face capturing in Surveillance client of Windows and Guard client of Android section, following events can be recorded in NCheck Bio Attendance Surveillance client for Windows.

  1. Whitelist event

    Event type as check-in or check-out.

  2. Blacklist event

    If the user is blocked, event will be recorded as blacklist

  3. Unidentified event

    Unidentified event will be recorded if

    1. No match available for the captured face image

      In this case user can select any user from the registered user group and record the event as whitelist or blacklist event.

    2. Close matches available for the captures face image

      In this case user can select the user from the close match list and record the event as whitelist or blacklist event.

Following table is showing the views for all available events in Surveillance and Guard client.

Table 95 Result view of events in Guard and Surveillance clients

Matching event type

Surveillance client

Guard client

Whitelist event

_images/image739.PNG

Figure 392 whitelist event of Surveillance client

_images/image741.PNG

Figure 393 Whitelist event of Guard client

Blacklist event

_images/image743.PNG

Figure 394 Blacklisted event in Surveillance client

_images/image745.PNG

Figure 395 Blacklist event of Guard client

Unidentified event (No match found)

_images/image746.PNG

Figure 396 Unidentified event of Surveillance client

Not available

Unidentified event (Close match found)

_images/image747.PNG

Figure 397 Close match event of Surveillance client

Not available

  1. User profile image

  2. Username

  3. Event type

  4. Total work hours of the day

  5. Event time

  6. Edit button

    Edit the selected evet as mentioned in section

  7. Number of matches in the close match list

    This view appears for the unidentified events if multiple matched found.

Edit event

Note

This view is available NCheck Bio Attendance Surveillance client only.

The recorded event can be edited in following case

  1. The captured face has matched with the different person(s)

    In this case, the captured face is matched with different person and the event will be recorded as Check-in, Check-out or blacklist. If the person is matched with multiple persons, the event will be recorded as unidentified event.

  2. The captured face has no match

    The captured face has matched with no person and the event will be recorded as unidentified.

In such cases Guard allows to edit the event as follows.

Table 96 Edit event view of Surveillance client

Event

Edit event View

Person has matched with different person(s)

_images/image749.PNG

Figure 398 Edit event view when matching with different person(s)

Person has no match

_images/image750.PNG

Figure 399 Edit event view when person has no match

  1. Employee code

    Guard allows to select the correct person using the employee code. The selected person will be updated in the Side by side comparison view .

  2. Side by side comparison view

  3. Matching list view

  4. Close button

    Close Edit event dialogue.

Side by side comparison view

The side by side comparison view allows to compare the captured face of the person with matching parson(s) and record the event in following cases.

  1. The captured face has a match

    The captured face can be matched with either the server result or person selected by the Guard. In such cases event can be recorded as Check-in, Check-out or Blacklist if the person has been blocked.

  2. The face has not a match

    The Guard allows to record the event as false match if the captured person is not existing in the system.

Table 97 Side by side comparison view of Surveillance client

Case

View

Person has matched with person(s)

_images/image751.PNG

Figure 400 Side by side comparison view when captured face has a match

Person has no match

_images/image752.PNG

Figure 401 Side by side comparison view when captured face has no match

  1. Captured face image of the user

  2. Matched/selected person view

    _images/image754.PNG

    Figure 402 Matched/selected person view

    1. Image

      Wither the face biometric image of the matched person or thumbnail image of the selected person.

    2. Matching score

    3. Employee code of the matched/selected user

    4. Blocked status

      This status is shown if the matched/selected person is blocked.

    5. Delete button

      Removed the matched/selected person. If the captured face image has no match, Guard can remove the matched/selected person using this button and record as false match.

  3. Event date and time

  4. Name of the matched user

  5. Employee code selection view

    User able to find the user entering employee code if no match found for the captured face image. Otherwise this will be disabled.

  6. Check-in button

    Record the event as Check-in if the matched/selected user is not blocked.

  7. Check-out button

    Record the event as Check-out if the matched/selected user is not blocked.

  8. Blacklist button

    Record the event as blacklist if the matched/selected user is blocked.

  9. Unidentified button

  10. False match button

    Record the event as false match, if the captured face image has no match.

Matching list view
_images/image756.PNG

Figure 403 Close match list view of Surveillance client

  1. Selected user

  2. Face biometric image

  3. Matching score

  4. Employee code of the user

  5. Blocked indicator

    This indicator appears if the user is blocked.

Recent events list

Note

This view is available in NCheck Bio Attendance clients for Windows only.

Recently recorded attendances are showing in the recent events list. Recent event list view follows

Resent event list views of Windows client

Recent event list view

Standard and Lite clients

_images/image758.PNG

Figure 404 Recent event list view of clients for Windows

Surveillance client

_images/image760.PNG

Figure 405 Recent event list view of Surveillance client

  1. Event filter view

  2. Result view for Surveillance client for Windows and Guard client for Android

Event filter view

_images/image762.PNG
  1. Event type

    1. Whitelist

    2. Blacklist

    3. Unidentified

    4. Close match

  2. Timeline selector

    Using the timeline selector, the timeline can be changed, and it will support 24 hours of period to backward. It will filter the events according to the timeline selected

  3. Timeline of the event

    By default, this shows the current timeline and timeline can be changed using the Time line selector.

Client control panel

NCheck Bio Attendance Client Control panel available in clients if the Offline operation mode has enabled in Attendance Standard cloud/on-premises server as shown below.

Table 98 Standard clients control panel availability on offline mode

Offline mode enabled

Network available

Network disabled

Cloud

_images/image36.PNG
_images/image35.PNG

On-premises

_images/image36.PNG
_images/image35.PNG

Standalone

_images/image35.PNG
_images/image35.PNG

Following options are available in NCheck Bio Attendance Standard Client control panel for Android and Windows,

Table 99 Control panel options of Standard clients

Cloud

On-premises

Standalone

User management

_images/image35.PNG
_images/image35.PNG
_images/image35.PNG

Peripheral view of clients

_images/image36.PNG
_images/image36.PNG
_images/image35.PNG

Event logs

_images/image35.PNG
_images/image35.PNG
_images/image35.PNG

Reports view

_images/image36.PNG
_images/image36.PNG
_images/image35.PNG

Settings view

_images/image36.PNG
_images/image36.PNG
_images/image35.PNG

Admin tasks of Clients

_images/image35.PNG
_images/image35.PNG
_images/image35.PNG

Login view

Table 100 Login views of Clients control panel

Windows client

_images/image764.PNG

Figure 406 Login view of Windows standard client

Android client

_images/image766.PNG

Figure 407 Login view of Android standard client

  1. Username

  2. Password

    The default control panel login password of the Android client is Admin. Windows client does not have a default password. The password can be changed as mentioned in Standalone password view section.

  3. Login button

    Table 101 could be appeared when logging to the control panel.

  4. Cancel button

Table 101 Error messages of control panel logging

Error code

Error message

2066

Invalid password. Check the password again.

User management

Table 102 User management views

Windows Client

_images/image768.PNG

Figure 408 User management view of Windows standard client

Android Client

_images/image770.PNG

Figure 409 User management view of Android standard client

  1. Users list view

  2. User quick view

    In android Stannard client, select user quick view for User view of Android Standard client .

  3. Add button

    Refer Add user section for more details.

  4. Edit button

    Refer Edit user section for more details.

  5. Delete button

    Delete selected user. Refer Edit user section for more details of delete user.

  6. Refresh button

    Refer the user management view.

  7. Manage biometrics

  8. Search user

  9. Enroll from history button

    Refer Enroll from Windows client history section for more details.

User view of Android Standard client

User view of the Android Standard client preset all user details as follows.

_images/image772.PNG

Figure 410 User view of Android Standard client

  1. User first name and last name

  2. User menu

    1. Edit

      Edit user

    2. Remove

      Remove user

    3. Biometrics

      Manage biometrics as mentioned in Manage biometrics section

  3. User details view

Add user

Table 103 Add new users view

Windows Client

_images/image774.PNG

Figure 411 Add user view of Windows standard client

Android Client

_images/image776.PNG

Figure 412 Add user view of Android standard client

  1. User image thumbnail preview

    In Android standard client select the image thumbnail to browse the image file from the file system.

  2. Browse button

    Browse image from the file system

  3. First name

  4. Last name

  5. Employee code

  6. Barcode ID

Refer Capture barcode from client section for more details.

  1. RFID tag

    Refer Capture RFID from client section for more details.

  2. Email

  3. Address line 1

  4. Address line 2

  5. City

  6. Country

  7. State

  8. Zip code

  9. Telephone

  10. Apply button

    Apply button will be disabled if the mandatory fields are empty or Validation errors exist. Refer Table 104 for all error messages.

  11. Cancel button

Table 104 Error messages of add/edit user in client control panel

Error code

Description

3001

Mobile/telephone number is not valid for the selected country/region.

3002

Invalid email address.

3005

Barcode scanner could not be found.

3006

RFID scanner could not be found

2020

Selected file is not a valid image file.

2021

Employee code already exists.

2022

Barcode ID is already available for different user

2023

RFID is already available for different user

2039

Could not capture barcode. The device has been blocked

2040

Could not capture RFID. The device has been blocked

Capture barcode from client
Table 105 Barcode field view

Windows client

_images/image778.PNG

Figure 413 Barcode field view of Windows Standard client

Android client

_images/image780.PNG

Figure 414 Barcode field view of Android standard client

  1. Barcode text field

  2. Barcode capture button

    Select Capture button to scan the barcode from the client application as mentioned in Table 106 .

Table 106 Capturing barcode from Client applications

Android client

Scan the barcode after the barcode scan view appeared as shown in Figure 415 .

  1. Main menu

    1. Switch camera

    2. Change resolution

  2. Barcode scan area

After successful scan, barcode id will appear in the barcode field.

_images/image782.PNG

Figure 415 Barcode capture view of Android client

Windows client

  1. Select the barcode field

  2. Scan the barcode from the connected barcode scanner

  3. After successful scan, barcode id will appear in the barcode field.

Capture RFID from client
Table 107 RFID field view

Windows client

_images/image784.PNG

Figure 416 RFID field view of Windows Standard client

Android client

_images/image785.PNG

Figure 417 RFID field view of Android standard client

  1. RFID text field

  2. RFID capture button

    Select Capture button to scan the RFID from the client application as mentioned in Table 108 .

    Table 108 Capturing barcode from Client applications

    Android client

    1. Scan the RFID after the RFID scan view appeared as Figure 418

    2. After successful scan, RFID id will appear in the RFIDID field.

      _images/image142.PNG

      Figure 418 RFID capture view of Android client

    Windows client

    1. Select the RFID field

    2. Scan the RFID from the connected RFIC scanner

    3. After successful scan barcode id automatically

      appeared in the RFID field.

Edit user

Table 109 Edit user views

Windows client

_images/image787.PNG
_images/image788.PNG

Figure 419 Edit user view of Windows standard client

Android client

_images/image790.PNG

Figure 420 Edit user view of Android standard client

  1. User details view as mentioned in Add user section.

Manage biometrics

To proceed to manage biometric view for particular user in NCheck Bio Attendance Android standard client, Select Biometric button of the User view of Android Standard client section. In the edit user view, if no biometric has been enrolled for user, NCheck Bio Attendance Android standard will show a notification to enroll biometric as shown in Figure 421 .

  1. Enroll button

    Select enroll button to select the biometric type as shown in Figure 423 to capture biometric.

    _images/image792.PNG

    Figure 421 “No template enrolled” notification in Android standard client

Table 110 Manage biometrics view

Windows client

_images/image794.PNG

Figure 422 Manage biometrics view of Windows standard client

Android client

_images/image796.PNG

Figure 423 Biometric type selection view of Android standard client

_images/image798.PNG

Figure 424 Manage biometrics view of Android standard client

  1. Enrolled face images list

  2. Capture face button

    Refer Capture face from standard clients section for more details.

  3. Enrolled fingerprint images list

  4. Capture fingerprints button

    Refer Capture fingerprint from Standard clients section for more details.

  5. Enrolled iris images list

  6. Capture iris button

    Refer Capture iris from Windows standard client section for more details

Refer Capture from client applications section for the error message could be appeared while capturing biometrics.

Enroll from Windows client history

Note

This feature is not available for NCheck Bio Attendance Android client.

This option allows enroll biometrics from previous recorded events from users who are not enrolled with NCheck Bio Attendance server.

_images/image800.PNG

Figure 425 Enroll from history view

  1. Date filter

  2. Unidentified biometric lists

  3. Delete button

    Delete event from the list

  4. Event date and time

  5. Enroll button

    Enroll selected biometrics from the list. Table 111 is shown the error messages could be appeared when enroll biometrics from history

  6. Cancel button

Table 111 Error messages of Enroll from history

Error code

Error message

2024

Could not enroll selected face/finger/iris image.

Peripheral view of clients

All available peripherals are showing in this view. The peripheral view as follows,

Table 112 Peripherals list views

Windows Client

_images/image802.PNG

Figure 426 Peripherals view of Windows standard client

Android Client

_images/image804.PNG

Figure 427 Peripherals view of Android standard client

  1. Device details view of Windows standard client

  2. Edit button

    Refer Edit peripheral view section for more details. In Android client double click on peripheral quick view.

  3. Refresh button

  4. Peripheral list view of Windows standard client

  5. Peripheral quick view of Android standard client

Device details view of Windows standard client

This view is showing device details as follows.

_images/image806.PNG

Figure 428 Device details view of Windows standard client

  1. Device name

  2. Name of the operating system

  3. Version of the operating system

Peripheral list view of Windows standard client

This view shows all peripheral available with the device as follows.

_images/image807.PNG

Figure 429 Peripheral list view of Windows standard client

  1. Peripheral name

  2. Peripheral ID

  3. Status

    Peripheral is enabled or disabled.

  4. Selected peripheral

    Double click on the selected peripheral to get the Edit peripheral view .

Peripheral quick view of Android standard client

This view present details of the selected peripheral.

_images/image808.PNG

Figure 430 Peripheral quick view of Android standard client

  1. Peripheral type

  2. Peripheral ID

  3. Peripheral image

    This image become green when the peripheral is available with the device. Otherwise become grey color.

Select the peripheral quick view to get the Edit peripheral view .

Edit peripheral view

Table 113 Edit peripheral views

Windows client

_images/image809.PNG

Figure 431 Peripheral edit view of Windows standard client

Android client

_images/image810.PNG

Figure 432 Peripheral edit view of Android standard client

  1. Peripheral name

  2. Peripheral code

    A unique id for the peripheral. Peripheral code cannot be edited.

  3. Peripheral status

    Enable/disable the peripheral.

  4. Save button

  5. Cancel button

Event logs

Table 114 Event logs views

Windows Client

_images/image811.PNG

Figure 433 Event logs view of Windows standard client

Android Client

_images/image812.PNG

Figure 434 Event logs view of Android standard client

  1. Event logs filter view

  2. Date filter

    Select the date to retrieve event logs. Default date is current date.

  3. Username filter

    Select the username to retrieve event logs.

  4. Event logs list view of Windows standard client

  5. Add button

    Refer Add new event log section for more details

  6. Edit button

    In Android standard client select on event log quick view for edit event log. Refer Edit event log section for more details.

  7. Delete button

    Delete selected event log. In Android client refer Edit event menu of Android standard client section for delete event log.

  8. Refresh button

    Refresh event logs view

  9. Re-evaluate button

    Select this button to re-arrange events check-in/check-out sequence of users.

  10. Event log quick view of Android standard client

Event logs list view of Windows standard client

Event log list view of the Android standard client shows all event logs as follows.

_images/image814.PNG

Figure 435 Event logs list view of Windows standard client

  1. Username

  2. Employee code

  3. Event type as Check-in or Check-out

  4. Event date and time

  5. Selected event

    Double click on selected event to Edit event log .

Event log quick view of Android standard client

Event log quick view of Android standard client shows details of the selected event log as follows

_images/image816.PNG

Figure 436 Event log quick view of Android standard client

  1. User thumbnail

  2. Username

  3. Employee code

  4. Event type as Check-in or Check-out

  5. Event date and time

Select on event quick view to Edit event log .

Add new event log

Table 115 Add event logs view

Windows Client

_images/image818.PNG

Figure 437 Add event log view of Windows standard client

Android Client

_images/image820.PNG

Figure 438 Add event log view of Android standard client

  1. Event thumbnail

  2. Person name

  3. Date

  4. Event time

  5. Event type

    1. Checkout

    2. Unidentified

    3. Not known

  6. Add button

  7. Cancel button

Edit event log

Table 116 Edit event log views

Windows Client

_images/image822.PNG

Figure 439 Edit event log view of Windows standard client

Android Client

_images/image824.PNG

Figure 440 Add event log view of Android standard client

  1. Event details view as shown in

  2. Edit event menu of Android standard client

Edit event menu of Android standard client

This menu available in the Android standard client to delete the selected the selected event log

_images/image826.PNG

Figure 441 Edit event menu of Android standard client

  1. Delete

    The delete the selected event log

Reports view

Table 117 Report views

Windows client

_images/image828.PNG

Figure 442 Report view of Windows standard client

Android client

_images/image830.PNG

Figure 443 Report view of Android standard client

  1. Report type

  2. Filter report by username

  3. Select report start date and end date to generate report

  4. Report options of Windows standard client

  5. Report data view

  6. Summarize report by daily, weekly, or monthly

Report options of Windows standard client

Report options of the Windows standard clients available shown as below.

_images/image832.PNG

Figure 444 Report options view of Windows standard client

  1. Refresh button

    Refresh report view.

  2. Print button

    Print the report.

  3. Save CSV button

    Save report in CSV format.

  4. Save PDF button

    Save report in PDF format.

Workhour report

Table 118 Details in the workhour report

Windows client

Report columns as follows

  1. Date

    The date for the workhour entry.

  2. Name

    Name of the employee.

  3. Employee code

  4. Productive work hours

    Work hours without early arrival and late departure.

Android Client

Report columns as follows

  1. Workday

    Day for the entry.

  2. Full name

    First name and last name of the user.

  3. Employee code

  4. Work hours

    The number of work hours for the day.

6.7.5.3 Event log report

Table 119 Details in the Event log report

Windows Client

Report columns as follows

  1. Name

    Name of the employee

  2. Employee code

  3. Direction

    The event as check-in or checkout

  4. Time

    Event time

Android Client

Report columns as follows

  1. Workday

    Day for the entry.

  2. Full name

    First name and last name of the user.

  3. Employee code

  4. Event time Date and time the event is performed.

  5. Event type

    Event type as check-in or checkout.

Settings view

  1. General settings of clients

  2. Shift settings of clients

  3. Biometric settings of clients

  4. Client peripheral configuration

General settings of clients

Table 120 General setting views

Windows client

_images/image834.PNG

Figure 445 General setting view of Windows standard client

Android client

_images/image836.PNG

Figure 446 General setting view of Android standard client

  1. The interval between consecutive face scans

    Minimum time difference between two ancillary events to prevent event duplication for the user.

  2. KIOSK mode operation (For Microsoft Windows clients)

  3. KIOSK mode exit code

  4. Event log image size

  5. Standalone password view

  6. Enable/disable Manuel event selection

  7. Save button

Standalone password view
Table 121 Standalone password view of clients

Windows client

_images/image838.PNG

Figure 447 Standalone password view of Windows standard client

Android client

_images/image840.PNG

Figure 448 Standalone password view of Android standard client

  1. Empty password

    Select this option to login control panel with empty password.

  2. Current password

  3. Password

    New password.

  4. Confirm password

  5. Save button

    Save password details. Save button will be disabled if the mandatory fields are empty or Validation errors exist. Al errors message could be appeared as shown below.

Table 122 Error messages of password save

Error code

Error message

3003

Password does not match.

3004

Password must contain at least 6 characters with one number.

3012

Current password is incorrect

Shift settings of clients

Table 123 General settings

Windows Client

_images/image842.PNG

Figure 449 Shift settings view of Windows standard client

Android Client

_images/image844.PNG

Figure 450 Shift settings view of Android standard client

  1. Default shift start time

  2. Default shift end time

  3. Day start time

  4. Save button

Biometric settings of clients

Table 124 Biometric settings views

Windows Client

_images/image845.PNG

Figure 451 Biometric settings of Windows standard client

Android Client

_images/image846.PNG

Figure 452 Biometric settings of Android standard client

  1. Face liveness mode

  2. Face liveness threshold

  3. Face template size

    Size of each face enrolled template among medium or large. Large face template contains more details than medium.

  4. Recognition threshold

  5. Verification threshold

  6. Enrollment threshold

  7. Face confidence

  8. Face quality

  9. Fingerprint quality

  10. Iris quality threshold

    Increase the value if the same user identified differently from time to time. By increasing the value, the system is forced to ignore low quality iris scans.

  11. Hat detection threshold

  12. High-speed face detection

  13. Hat detection feature

  14. Hide user list on windows client

  15. Mask detection

  16. Mask detection threshold

  17. Save button

Client peripheral configuration

Table 125 Peripheral configuration views

Windows client

_images/image848.PNG

Figure 453 Peripheral configuration view of Windows standard client

Android client

_images/image850.PNG

Figure 454 Peripheral configuration view of Android standard client

  1. Authentication mode

    Available authentication modes are,

    1. Identification

      Identification is the default authentication mode. Identification is performed on biometric and user id data. User biometric data such as face, finger print and iris are comparing against the database with previously collected biometric samples depending on the Recognition threshold . If the matching score is greater than the Recognition threshold , user is considered as identified. Therefore, this mode may demand large processing time. User id data such as user id, barcode and QR code are comparing against the database and giving the matching users.

    2. Verification

      The verification mode can be applied with a user id peripheral and a biometric peripheral in order to verify the user against the previously collected biometric sample. To get verified, matching score should be greater than Verification threshold .

      _images/image301.PNG

      Figure 455 Combinations of user id peripheral with biometric peripheral in verification mode

    3. None

  2. Capture id first

    The verification sequence when the verification is selected as the authentication mode. If the capture Id first has enabled, id input should be input before the biometric. Otherwise biometric should be given at first.

  3. Events

    Attendances will be recorded in the specific event type as selected from this option.

    1. check-in

    2. checkout

    3. any

      Both Check-in and Check-out events

  4. Manage external executable

  5. Save button

Manage external executables

NCheck Bio Attendance Standard clients can be configured to run external programs (Either from external executable or API) during user identification. For an example, an automatic door opening program can be executed upon successful user identification. Following setting should be specified to configure external programs.

_images/image852.PNG

Figure 456 Manage external executables view

  1. External executable lists

  2. Add external executable

  3. Edit external executable

    Edit external executable in Windows standard client

  4. Delete external executable

    Delete selected external executable.

Note

NCheck Bio Attendance Android standard client doesn’t support on multiple external executable. It only allows to as single external executable to trigger APIs.

External executable lists

External executable list as follows.

_images/image854.PNG

Figure 457 External executables list of Windows standard client

  1. Name of the external executable

  2. Path to the EXE/URL of the API

Add external executable
Table 126 Add external executable view of Windows standard client

Windows client

_images/image855.PNG

Figure 458 Add external executable view of Windows client

Android client

_images/image856.PNG

Figure 459 Add external executable view of Android client

  1. Name

    Name of the external executable.

  2. Path of the external executable

    Path of the external executable or API URL to invoke.

  3. Trigger on

    1. Any

      Trigger the executable when record check-in or checkout events.

    2. Check-in

      Trigger executable when record check-in event.

    3. Check-out

      Trigger executable when record checkout event.

    4. Unidentified

      Trigger executable when the record is not identified as check-in or checkout.

  4. Parameter

    Following parameter(s) can be passed to the external executable when triggering the executable.

    1. Event (EVENT)

      Event type as CHECKIN, CHECKOUT or UNIDENTIFIED.

    2. Sequence id (SEQUENCE_ID )

      Id of the event.

    3. Time stamp (TIMESTAMP )

      Date and time of the event.

    4. User reference (USER_REF )

      Employee code of the user.

    5. User name (USER_NAME)

      First name and last name of the user event recorded.

    6. Shift code (SHIFT_CODE )

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

    7. Location (LOCATION )

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

    8. User status (USER_STATUS )

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

    9. Address (ADDRESS)

      Address of the user.

    10. Peripheral code (PERIPHERAL _CODE )

      Unique identified number of the peripheral.

The applied parameters will be passed to the external executable as below when recording events.

Table 127 Parameters with external executable path or URL

Type

Format

External executable

  1. Value of the parameters will be separated with empty space

  2. Example: {parameter value 1} {parameter value 2} {parameter value 3}

URL

  1. As URL parameters

  2. Example: {url}?{Paramter1}={value}&{Paramter2}={value}&{Paramter3}={value

Note

NCheck Bio Attendance Standard client for Android is supported for URLS’s only.

Admin tasks of Clients

Table 128 Admin tasks views

Windows client

_images/image858.PNG

Android client

_images/image860.PNG

Figure 460 Admin tasks view of Android standard client

  1. Data import

  2. Data export

  3. Database backup and restore

  4. Database encription

  5. Biometrics

  6. Audit logs

Data import/export

This allows to import/export below information.

  1. User profile information

    1. First name

    2. Last name

    3. Employee code

    4. Email

    5. Primary telephone number

    6. Address1

    7. Address2

    8. State

    9. Country

    10. State province region

    11. Zip or postal code

    12. Barcode

    13. RFID

    14. Created date and time

    15. System Id

  2. Event log information

    1. Check-in latitude

    2. Check-in longitude

    3. Check-in address

    4. Check-in description

    5. Check-out latitude

    6. Check-out longitude

    7. Check-out address

    8. Check-out description

    9. Employee code

    10. Check-in time

    11. Check-out time

    12. Shift start time

    13. OT start time

    14. Shift span seconds

    15. OT span seconds

    16. OT enabled or not

    17. OT limit in hours

    18. Check-in timezone

    19. Check-out timezone

    20. Work hours

    21. Maximum OT hours

Note

All date time should be MM/dd/yyyy h:mm:ss a format and date format should be MM/dd/yyyy format when export data.

To import/export data successfully following, following guidelines must be satisfied.

  1. The file names of csv files (user profile information and event logs ) should be

    User profile information : PersonData.csv event logs : EventLogData.csv

  2. All date format must be MM/dd/yyyy.

  3. All time format must be h:mm:ss.

  4. The column names should be equal as above.

  5. Country, state, provincial code, zip/postal code, email and telephone number should be in correct format.

Data import
Table 129 Date import views

Windows client

_images/image862.PNG

Figure 461 Data import view of Windows Standard client

Android client

_images/image864.PNG

Figure 462 Data import view of Android standard client

  1. Importing information

    1. User profile information

    2. Event logs information

  2. Import location

    Select the file path of the importing file.

  3. Encrypted password of the importing file

  4. Status

    Importing status in successful or fail attempts.

  5. Import button

    Import button will be disabled if the mandatory fields are empty or Validation errors exist. Table 130 is showing error messages could be appeared.

  6. Close button

Table 130 Error messages of import data from clients

Error code

Error message

2062

Data import failed. Invalid password.

2063

Data import failed. The selected file could not be imported.

4003

Unidentified error occurred during data import. Please contact administrator or NCheck Bio Attendance support for more details.

Data export
Table 131 Data export views

Windows client

_images/image866.PNG

Figure 463 Data export view of Windows standard client

Android client

_images/image868.PNG

Figure 464 Data export view of Windows standard client

  1. Exporting information

    1. User profile information

    2. Event log information

  2. Select path to export location

  3. Password to encrypt the exporting file

  4. Confirm password

  5. Status

    Exporting status in successful or fail attempts.

  6. Export button

    Export button will be disabled if the mandatory fields are empty or Validation errors exist. Table 132 is showing error messages could be appeared.

  7. Close button

Table 132 Error messages of export data from clients

Error code

Error message

3003

Password does not match.

3004

Password must contain at least 6 characters with one number.

4004

Unidentified error occurred during data export. Please contact administrator or NCheck Bio Attendance support for more details.

Database backup and restore

Database backups and restore allows to back up the database as JSON files in a zip file securely and restore back in the application. The backup file contains,

  1. Person.json

    All user information added as mentioned in Add user section.

  2. Authentication.json

    All authentication information of users such as biometrics, RFID and barcode.

  3. eventlogsPairViews.json

    All check-in and check-out pairs are backup in this file.

  4. settings.json

    All settings as mentioned in Settings view section are kept in this file.

Note

We are recommending to keep backup files safe without alter any information to prevent backup restore failures. Backup and restore feature are not available for NCheck Bio Attendance Android standard client.

Database backup

This view allows to backup the database as follows.

_images/image870.PNG

Figure 465 Backup database view of Windows standard client

  1. Database backup location

  2. The password to encrypt backup file

    Password must have at least 6 characters with on digit.

  3. Confirm password

  4. Status

    Database backup status in successful or fail attempts.

  5. Back up button

    Backup button will be disabled if the mandatory fields are empty or Validation errors exist. Table 133 Show all the error messages could be occurred.

  6. Close button

Table 133 Error messages of backup database in clients

Error code

Error message

3003

Password does not match.

4001

Unidentified error occurred during data backup. Please contact administrator or NCheck Bio Attendance support for more details.

Database restore

This view allows to restore backup databases as follows.

_images/image871.PNG

Figure 466 Restore database view of Windows client

  1. Database location

  2. Database encrypted password

  3. Status

    Database restore status in successful or fail attempts.

  4. Restore button

    Restore button will be disabled if the mandatory fields are empty or Validation errors exist. Table 134 Show all the error messages could be occurred.

  5. Close button

Table 134 Error messages of data backup and restore view

Error code

Description

2015

Data restore has been failed. Could not decrypt the file with the given password

2014

Data restore has been failed. Invalid backup file

4002

Unidentified error occurred during data restore. Please contact administrator or NCheck Bio Attendance support for more details.

Database encryption

Note

Database encryption feature is not available for NCheck Bio Attendance Android standard application.

Database encryption could be done as follows.

_images/image872.PNG

Figure 467 Encrypt database view of Windows standard client

  1. Password

    Password must have 8 characters with one uppercase character and one digit.

  2. Confirm password

    Save button will be disabled if the password and confirm password fields are empty or validation errors as shown in Table 135

  3. Save button

Table 135 Error messages of database encryption

Error code

Error message

3003

Password does not match.

Biometrics

Re-extract users’ biometric templates from biometric engine and re-enroll.

Table 136 Re-extraction views

Windows client

_images/image874.PNG

Figure 468 Re-extract template view of Windows standard client

Android client

_images/image876.PNG

Figure 469 Re-extract template view of Android standard client

  1. Status

    Status of the template extraction as in-progress, Finished or failed.

  2. Re-enroll button

    Select re-enroll button to begin extraction. The extraction time will be depended on number of templates to re-enroll. Table 137 is showing the error messages during re-extraction.

  3. Finish button

    Select finish button to finish re-enroll task while in-progress or finish.

  4. Cancel button

Table 137 Error messages of biometric re-extraction view

Error code

Error messages

2002

License cannot be obtained

2048

Biometric re-extraction has failed on following images.

  1. {images list}

6.7.7.5 Audit logs

This view shows date and time with the actions history performed by the user in the control panel. The following actions types are logged by the application.

Table 138 Admin logs views

Windows client

_images/image878.PNG

Figure 470 Manage audit log view of Windows standard client

Android client

_images/image880.PNG

Figure 471 Manage audit log view of Android standard client

  1. Action type

    Filter audit logs by action type

  2. Date filter with start and end date

  3. Audit logs list view

The available action types are

  1. LOGIN

    Date and time for the admin logins.

  2. LOGOUT

    Date and time for the admin logouts.

  3. ADDEVENTLOG

    Date and time when event logs added.

  4. MODIFYEVENTLOG

    Date and time when event logs modified.

  5. DELETEVENTLOG

    Date and time when event logs deleted.

  6. ADDPERSON

    Date and time when persons added.

  7. MODIFYPERSON

    Date and time when persons modified.

  8. DELETEPERSON

    Date and time when persons deleted.

Audit logs list view
Table 139 Audit log list views

Windows client

_images/image882.PNG

Figure 472 Audit logs list view of Windows standard client

Android client

_images/image884.PNG

Figure 473 Audit logs list view of Android standard client

  1. Username

  2. Action type

  3. Description

  4. Created date and time