CLIENTS ======================== NCheck Clients are used as the client applications for NCheck server. It is mainly used to record attendance. NCheck client has two applications #. NCheck Attend client NCheck Attend client is a simple client application with minimal required functionality for Windows, Android and IOS. #. NCheck Admin client NCheck Admin 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 Admin client requires a NCheck license #. NCheck Surveillance client for Windows NCheck Surveillance client for Windows support all the features in NCheck Admin client for Windows with guard functionality in which an authorized person can manually identify the person and record the event in the attendance system System requirement ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: System requirements for clients applications :widths: 1206 2735 2414 2414 * - - Attend - Admin - Surveillance * - Windows - #. Microsoft Windows 8 or higher operating system #. 1GB of disk space #. 2GB of RAM #. Supported :ref:`Face` peripheral - #. Microsoft Windows 8 or higher operating system #. 1GB of disk space #. 4GB of RAM #. One supported peripheral as mentioned in the in Peripherals section - #. Microsoft Windows 8 or higher operating system #. 1GB of disk space #. 8GB of RAM #. Supported :ref:`Face` peripheral * - Android - #. Android phone or tablet running Android 5.0 OS or later version #. 1 GB Of RAM #. Integrated camera - #. Android phone or tablet running Android 5.1 OS or later version #. 2 GB of RAM #. USB OTG (USB On the Go) feature if using peripherals as mentioned in the Peripherals section - * - IOS Client - Apple device running IOS 10.2 OS or later - Not available - Not available Peripherals ------------------------------ NCheck client applications support the following biometrics and ID peripherals. #. Biometrics peripherals #. :ref:`Face` #. :ref:`Fingerprint` #. :ref:`Iris` #. :ref:`Id peripherals` Available for NCheck Admin clients only .. note:: NCheck installer for Windows is installing all necessary drivers to enable face, fingerprint and iris scanners. But 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`. `_ .. _Ref34215697: Face +++++++++++++++++++++++++++++++++++++++++++ NCheck Android and IOS clients are using cameras available with the device. NCheck Windows clients support the following camera types. #. USB cameras #. IP cameras USB cameras """""""""""""""""""" In general, USB cameras working in Windows OS are supported. IP cameras """"""""""""""""""" Refer `supported IP camera `_ section for all supported IP cameras. Refer :ref:`Add/edit network camera` section for add IP cameras for NCheck Admin for Windows. .. _Ref32910914: Fingerprint ++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck Admin clients support external or internal USB fingerprint scanners. Refer supported `fingerprint scanners `_ for Admin client. .. _Ref32910921: Iris +++++++++++++++++++++++++++++++++++++++++++ NCheck Admin clients support external or internal USB iris scanners. Refer supported `iris scanners `_ for admin client. .. note:: By default, iris scanners are disabled for Windows Admin client. To enable, unzip necessary iris scanners from the Iris scanners folder in NCheck installation folder (By default the installation folder is “C:\Program Files\Neurotechnology\ NCheck”) .. _Ref181694794: Id peripherals ++++++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck Admin client supports capturing other authentication data. Data capture is performed by using the following hardware. .. list-table:: Hardware requirements for non-biometric identification :widths: 1870 3741 2754 * - - Windows admin - Android admin * - RFID - #. External HID #. External Serial - NFC Support * - Barcode - External HID - Using a built-in camera * - License plate - No special hardware needed - No special hardware needed Access control --------------------------------- NCheck Admin clients can trigger external executables with given parameters as mentioned in :ref:`External executables` section. Supporting Locations --------------------------------------- NCheck can be configured record the attendance event location with the attendance event. The location can be either device GPS location provided by the device operating system or predefined location coordinate. If the client uses device GPS location, In Android, to get the accurate location of the attendance event, device should be supported `Google play location services `_. If the google play location service is unavailable, the native location manager will be used. But this may not be accurate. .. _Ref32500937: Install Client ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Download client ---------------------------------- NCheck clients application downloads from `download page `_. Following installers available to install NCheck Windows client applications. #. Installer for on premises server NCheck on-premises server and admin client will be installed #. Installer for Admin client for windows #. Installer for Attend client for Windows Install clients for Windows ---------------------------------------------- Refer :ref:`Install client For Windows` section for more details about installing windows clients. After successful installation you will be asked to activate license in NCheck Admin clients and Surveillance clients for Windows as mentioned in :ref:`License Manager` section. For NCheck Attend client does not require a license. Once the license is activated for Windows clients, you can open the client. .. _Ref182383294: Open clients ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once open the client, you will be asked to register the clients as mentioned in the :ref:`Register clients` section. .. _Ref37763181: Register clients ------------------------------------------------------- NCheck Clients can be used with the following modes. #. NCheck Cloud Register with NCheck Cloud server. Refer :ref:`Start web Control panel` section for more details about cloud server. #. NCheck server installed on-premises. Register with NCheck on-premises server installed on premises. Refer :ref:`Start web Control panel` section for more details about on premises server. The registration process configures the application to work with one of the above two modes. Accessing registration can be done in the following ways. #. The client application will prompt the registration dialogue in case it is not registered. #. The client application is unregistered as mentioned in :ref:`Unregister` section. Once the registration view opens, it will ask for the registration token as below. Refer :ref:`Register device` section for more details about generating registration token. .. figure:: Images/chapter_clients/image955.PNG :width: 540 :figclass: align-center Registration token view #. Scan QR button Scan registration token QR code. The client will start to register if the scanned registration token is valid. #. Token field Enter registration token. #. Continue button Once the registration token entered, select this button to continue registration. If the entered token is from cloud server, the registration will start. Otherwise, it will ask the on-premises server URL as follows. .. figure:: Images/chapter_clients/image957.PNG :width: 476 :figclass: align-center Registration URL view #. On-premises server URL field Client automatically discovers the on-premises server URL when opening the view if the device and the on-premises server is connected to the same local area network. If it is not, enter the URL manually. #. Search server URL button To discover the server URL, make sure that the device and the on-premises server is connected to the same local area network. #. Continue button Start to register the client. If the on-premises server has no valid SSL certificate (Self sign certificate), the client will prompt SSL certificate validation error. Otherwise, the registration will be completed, .. figure:: Images/chapter_clients/image959.PNG :width: 211 :figclass: align-center SSL validation error dialog for Android client Once the self-sign certificate accepted pressing continue button, The client will be registered with the server. The following table shows possible errors during the client registrations. .. list-table:: Error messages of device registration :widths: 1255 5040 * - Error code - Error message * - 2051 - Failed to register with the NCheck 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 server URL Once the registration is completed, clients will check the following in starting view before starting the capturing #. Device permissions for Android clients Device permissions require for attendance recording as mentioned in :ref:`Check permissions` section. #. Encryption check for Admin clients Android and Windows clients uses databases if the offline operation is enabled as mentioned in :ref:`Offline operation mode` setting. The database is encrypted and in any case the client failed to decrypt the database, it will request the database password as mentioned in this :ref:`Check database encryption password` section. #. Check internet connectivity according to the activated license in Admin apps. Refer :ref:`Check network` section for more information. #. Check license in admin client When the application starts first time, it will activate the Trial license (Refer :ref:`License types` section for more details about trial license). Once application starts, the license can be changed from the license manager as mentioned in :ref:`License Manager` section. #. Initializing matching in Admin clients Preparing all the biometric images of users to identification when recording attendance when :ref:`Offline operation mode` setting is enabled. The Clients’ starting view is shown below. .. figure:: Images/chapter_clients/image961.PNG :width: 274 :figclass: align-center #. Progress with status check text. Once the checks are completed, clients will be ready to capture attendance as shown below. .. list-table:: :widths: 2790 5781 * - Client - Main view * - :ref:`Attendance capturing` of Android Admin client - .. figure:: Images/chapter_clients/image962.PNG :width: 193 :figclass: align-center Attendance capturing view of Android Admin client * - :ref:`Attendance capturing` of Android/IOS Attend client registered to employee group - .. figure:: Images/chapter_clients/image964.PNG :width: 200 :figclass: align-center Attendance capturing view of Android Attend client * - :ref:`Attendance capturing` of Windows Admin client - .. figure:: Images/chapter_clients/image966.PNG :width: 407 :figclass: align-center Attendance capturing view of Windows Admin client The main view of the Attend client registered to an employee is shown below. .. figure:: Images/chapter_clients/image968.PNG :width: 265 :figclass: align-center Main view of the Attend client registered to an employee #. Main navigation view #. Reports menu This will open employee report as mentioned in :ref:`Employee report` section. #. Time clock menu This will open :ref:`Attendance capturing` view. #. Main menu This will open main menu as mentioned in :ref:`Main menu` section. #. Navigation menu content view .. _Ref108770373: Check permissions +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Permissions are required for Android clients only. In Android applications, permissions need to be granted to ensure privacy and security of the device data. NCheck Android clients require the following permissions. #. Google play licensing check Google Play offers a licensing service that lets you enforce licensing policies for applications that you publish on Google Play. With Google Play Licensing, your application can query Google Play at run time to obtain the licensing status for the current user, then allow or disallow further use as appropriate. Android permission “com.android.vending.CHECK_LICENSE: is using #. Access location NCheck Android client is using device location details such as GPS coordinates and address when recording attendance. This requires “android.permission.ACCESS_FINE_LOCATION” permission. #. Network information This requires “android.permission.ACCESS_NETWORK_STATE” permission. NCheck Android clients are using network information to check the network available in the device for communication. #. Access internet This requires “android.permission.INTERNET” permission. Android clients require Internet to #. Communicate with remote NCheck server. #. To either activate a license as mentioned in :ref:`License activation/deactivation` section or obtain License when application start based on the activated :ref:`License types` . #. To log application and device data in remote logging service(`Firebase `_) #. Access Wi-Fi information In mobile services Wi-Fi is frequently used to access internet. Android clients use device Wi-Fi information to check the network connectivity and indicate to user. “android.permission.ACCESS_WIFI_STATE” and “android.permission.CHANGE_WIFI_STATE” permissions are required #. Access camera “android.permission.CAMERA” permission is required. NCheck Android client is using camera for #. Face capture Record users capturing face biometrics, Enroll face(s) to users. #. Barcode capture Capture User ids, device token, #. Access storage “android.permission.WRITE_EXTERNAL_STORAGE” permission is required below Android 11 application specific external storage to keep following data. #. Diagnostic data App generated log files to check application working status. #. Downloaded files #. License files To browse the license files during activation for NCheck Admin and Guard Android clients. #. Capture RFID NCheck Android client is capturing RFID to record attendance and appointment creation. “android.permission.NFC” permission is required. This is used for NCheck Admin client only. #. Access device power management tools To wake up device when record attendance and create appointments. “android.permission.WAKE_LOCK” permission is required. #. Receive application boot completed Start the client automatically when device has restarted. This requires “ndroid.permission.RECEIVE_BOOT_COMPLETED” permission. .. _Ref137546588: Check database encryption password ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck Admin clients and Windows surveillance clients are storing database encryption passwords in the application context. If the client database cannot be decrypted from the encryption password, database encryption password dialog will be shown asking current password of the database as below. .. list-table:: Database encryption password dialogs :widths: 2070 6835 * - Client - Encryption dialog view * - Android client - .. figure:: Images/chapter_clients/image970.PNG :width: 307 :figclass: align-center Database encryption password dialog for Android Admin client #. Encryption key Database encryption key. #. Discard existing database and create new database option Check this option to discard existing database and create new client database. You will lose all the data in the existing database if you continue selecting this option. #. OK button #. Cancel button. .. _Ref108771518: Check network +++++++++++++++++++++++++++++++++++++++++++++++++++++ When the application starts the client application is checking for the valid license availability. This requires a network connection based on the activated :ref:`license types` . If the network is unavailable, the client will show network connectivity failure view and hold until the network available checking the network connectivity periodically as shown below. .. list-table:: NCheck Client network check view :widths: 2340 6141 * - Client - Network connectivity failure view * - Android client - .. figure:: Images/chapter_clients/image972.PNG :width: 187 :figclass: align-center Android client network check .. note:: NCheck Attend clients is not checking network while opening because it does not use licensing. .. _Ref181780240: Attendance capturing ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Attendance capturing views of the clients are shown below. .. list-table:: Attendance capturing view of Android and IOS clients :widths: 2515 6501 * - Client - Attendance capturing view * - Android Admin - .. figure:: Images/chapter_clients/image974.PNG :width: 267 :figclass: align-center Attendance capturing view of Android Admin client * - Android/IOS Attend client registered to an employee group - .. figure:: Images/chapter_clients/image976.PNG :width: 288 :figclass: align-center Attendance capturing view of Android/IOS Attend client registered to an employee group * - Android/IOS Attend client registered to an employee - .. figure:: Images/chapter_clients/image978.PNG :width: 369 :figclass: align-center Attendance capturing view of Android/ISO Attend client registered to an employee #. :ref:`Attendance view` #. Current date #. Location restrictions The location restrictions can be added restrict employee attendance events recording from outside of the allowed areas. The location restriction status is shown as mentioned :numref:`Ref181870098` . 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. Locations restrictions can be added from the web control panel in following ways #. Location restrictions for employee Location restrictions can be added for any employee as mentioned in :ref:`Locations` section of :ref:`User Management` . #. Location restriction for employee group Location restrictions can be added for any employee group as mentioned in :ref:`Locations` section of :ref:`Manage Employee Groups` . #. Work hour timer view The Attend client registered to an employee is showing total work hour timer, on employee check-in and check-out. This helps employees to check the total work hours of the current shift. Once an employee is checked-in, the timer starts and keeps counting the work hours until checked-out. Refer :numref:`Ref181879118` for more information. #. License status (Admin clients only) The status of the current license in admin clients. The available statuses are shown in :numref:`Ref181871040` . #. Camera switch button Switch device camera. #. :ref:`Attendance menu` Attendance capturing view of Windows clients is shown below. .. figure:: Images/chapter_clients/image980.PNG :width: 651 :figclass: align-center Attendance capturing view of Windows admin client .. figure:: Images/chapter_clients/image982.PNG :width: 595 :figclass: align-center Attendance capturing view of Windows Attend client #. :ref:`Attendance view` #. Admin/attend logo #. Current date and time #. License status (Admin clients only) The status of the current license in admin clients. The available statuses are shown in :numref:`Ref181871040` . #. Recent event list #. :ref:`Registration and connectivity status view` #. Language setting #. Main menu .. _Ref181870098: .. list-table:: Location restriction statuses :widths: 3150 5151 * - Status - View * - Location is restricted. But the user is inside the permitted radius. The view shows the distance between current location and the permitted area with precision. For example, as here, the correct location can be anywhere between 11+ 14 meters and 11 - 14 meters - .. figure:: Images/chapter_clients/image984.PNG :width: 288 :figclass: align-center User inside the permitted area * - Location is restricted. User is not inside the permitted radius. The view shows the distance between the current location and permitted area with precision. For an example as here, the correct location can be anywhere between 222+ 7 meters and 222 - 7 meters - .. figure:: Images/chapter_clients/image986.PNG :width: 280 :figclass: align-center User is not inside the permitted area * - The Location services are not available. Location services of the device have disabled or not available in the area. - .. figure:: Images/chapter_clients/image988.PNG :width: 238 :figclass: align-center Location coordinates are not available * - Location is not restricted. - .. figure:: Images/chapter_clients/image990.PNG :width: 180 :figclass: align-center Location has not restricted .. _Ref181871040: .. list-table:: License statuses of Admin clients :widths: 3793 4508 * - Status - View * - The activated license is obtained successfully. - License: Success * - The current license is failed to obtain. This may happen, #. The current license (trial/no trial) is expired. #. Currently trial/internet license cannot be used due to the no internet access to the device. The device should be connected to internet if the current license is trial or internet license. In any case the internet is unavailable for more than 30 minutes, license will be failed, and identification will stop until the device connected with Internet. - License: failed * - Trial license can be used for a month from the date its activated by the admin client. This status shows the available duration is the current license is trial. - Trial: {duration} left .. _Ref181879118: .. list-table:: Work hour timer views :widths: 3793 4508 * - Event status - Work hour timer view * - When employee record check-in, work hour timer is starting to count the work hours for the current shift - .. figure:: Images/chapter_clients/image992.PNG :width: 148 :figclass: align-center * - When employee record check-out, work hour timer is stopping and showing total work hours for current shift - .. figure:: Images/chapter_clients/image993.PNG :width: 152 :figclass: align-center Work hour timer view when record check-out .. _Ref181890017: Registration and connectivity status view --------------------------------------------------------------------------------- .. note:: This view is available for Windows clients only. .. figure:: Images/chapter_clients/image995.PNG :width: 608 :figclass: align-center Registration and connectivity stratus view of Windows clients #. Network availability #. License status indicator Shows the current license obtaining status as licensed, trial or expired. #. Registration mode indicator as cloud, on-premises mode .. list-table:: Registration mode indicators :widths: 2070 1980 * - Mode - Indicator * - Cloud - .. figure:: Images/chapter_clients/image997.PNG :width: 38 :figclass: align-center * - On-premises - .. figure:: Images/chapter_clients/image998.PNG :width: 27 :figclass: align-center * - Standalone - .. figure:: Images/chapter_clients/image999.PNG :width: 30 :figclass: align-center #. Server and port URL and port of the connected server in cloud, on-premises or standalone mode #. Registered user/user group name Registered user/user group name is showing in cloud or on-premises mode. #. Connectivity status with the server indicator in cloud and on-premises mode as shown below. .. list-table:: Online/Offline statuses of Admin clients :widths: 1139 1814 1919 2384 * - Status - Description - Android Admin client - Windows Admin client * - Online - Connected with the server - .. figure:: Images/chapter_clients/image1000.PNG :width: 39 :figclass: align-center - .. figure:: Images/chapter_clients/image1001.PNG :width: 74 :figclass: align-center * - Offline - Cannot connected with the server - .. figure:: Images/chapter_clients/image1002.PNG :width: 49 :figclass: align-center - .. figure:: Images/chapter_clients/image1003.PNG :width: 73 :figclass: align-center #. Synchronizing progress of the Admin and surveillance clients. .. _Ref181894386: Attendance menu ------------------------------------------------------- .. list-table:: Attendance menu of Attend and Admin Android/IOS clients :widths: 2065 2070 2520 2361 * - Menu - Admin client - Attend client (Employee group) - Attend client (Employee) * - :ref:`Synchronize` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Diagnostic data` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Select resolution` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`Turn on/off torch` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`Go to admin mode` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Show recent events` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`Login to control panel` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Enable/disable multi face` - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Buy now` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Upgrade now` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`About` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center .. _Ref45084575: Synchronize ++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck Admin clients synchronize server-and client data every 5-minute time interval if the :ref:`Offline data synchronize interval` setting is enabled. If instant synchronize is required, select the synchronize option in the :ref:`Attendance menu` . .. _Ref181896287: Diagnostic data +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Generate diagnostic data for NCheck clients to troubleshoot application issues. Diagnostic data contains the following details. #. Log folder Application logs. #. License folder License activation details #. Database folder SQL Attend database files for Android Admin, Windows Admin and Windows Surveillance clients. Generate diagnostic data dialog is shown below. .. figure:: Images/chapter_clients/image1004.PNG :width: 370 :figclass: align-center Generate diagnostic data dialog #. Include database checkbox Check to include database in the diagnostic data for admin and Surveillance client. #. OK button #. Cancel button Once select OK button, the diagnostic data will be downloaded to the downloads folder as a zip file and name of the file equivalent to the current timestamp. .. _Ref181896294: Login to control panel +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Login to control panel option allows login access NCheck Bio Attendance web control panel. .. _Ref182313329: Enable/disable multi face +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Multi face feature is available in Attend clients only Enable/disable multi face capture. Multi face capture is used to capture a group of employee faces from single capture. For more information refer :ref:`Muli face` section. .. _Ref137476119: Upgrade now +++++++++++++++++++++++++++++++++++++++++++++++++++ Show benefits of Admin clients over Attend client and option to download Admin client as shown below. .. figure:: Images/chapter_clients/image1006.PNG :width: 355 :figclass: align-center Upgrade now dialog .. _Ref181896311: Buy now +++++++++++++++++++++++++++++++++++++++++++++++ Buy now option is appearing in the :ref:`Attendance menu` of the admin clients if the client activated using Trial mode. This option will open the `pricing page `_ to purchase client license for admin app. .. _Ref181896328: Select resolution +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Select “select resolution” option in :ref:`Attendance menu` to select camera resolution form the available resolutions. .. _Ref207034168: Turn on/off torch +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Turn on/off torch is available for Android clients only. Turn on/off torch if the back camera of the Android Admin/Attend client is used. This feature is unavailable #. If the front camera is used #. No torch available with the device .. _Ref181896359: Go to admin mode ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Access admin dashboard of the Admin clients. Refer section for more information. .. _Ref181896320: Show recent events ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Show recently recorded events from the client. Refer section for more information. .. _Ref181897859: About +++++++++++++++++++++++++++++++++++++++++++++ The About option in the :ref:`Attendance menu` opens About dialog as shown application and attendance configuration information as below. .. figure:: Images/chapter_clients/image1008.PNG :width: 457 :figclass: align-center #. Application name #. Application version #. The URL and port of the server that the application is registered to #. User/user group that the client registered to #. Authentication type Authentication mode of the client. Refer :ref:`Authentication mode` section of the :ref:`Edit device` for more information about authentication mode of the client. #. Available peripherals The peripherals available to record attendance events in the current :ref:`Authentication mode` . #. Copyrights #. Check for updates This will open following pages to update pages based on where the client downloaded #. NCheck.Net website download page Open `NCheck.net download page `_, if the website version of the client is downloaded and installed #. Goole play store download page Open the Android Admin/attend client downloading page in Google play store, if the client downloaded and installed from Google play store. #. Appstore download page Open IOS Attend client download page from Appstore, if the IOS Attend client downloaded and installed from Appstore. #. Close button .. _Ref30759374: Main menu ------------------------------------------------ .. list-table:: Main menu of clients :widths: 1885 1353 2889 2889 * - Menu - Admin client - Attend client (Employee group) - Attend client (Employee) * - :ref:`Attendance` - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`Settings` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`License Manager` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - * - :ref:`About` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`Unregister device` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`Login to control panel` - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center * - :ref:`Compact DB` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Log out from admin mode` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - :ref:`Diagnostic data` - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center .. _Ref181947295: Attendance ++++++++++++++++++++++++++++++++++++++++++++++++++ Attendance option in the :ref:`Main menu` is showing attendance view of the employee that the Attend client is registered to. Attendance view is shown below. .. figure:: Images/chapter_clients/image1009.PNG :width: 301 :figclass: align-center Attendance view #. Employee thumbnail #. Employee name #. Employee email address #. Date field Select the date to retrieve the employee events #. Employee event list for selected date Each event record shows event time, time zone and event type. .. _Ref181904105: .. _Ref45084461: Log out from admin mode +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Log out from the admin dashboard. .. _Ref137218929: Compact DB ++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck admin Android client uses SQLite database to store application data. But one of the major problems in SQLite database is the database size is not decreasing even if the data has been deleted from the database. To clear the cache, you must run VACUUM SQLite query in the database. Compact DB option triggers VACUUM query. .. note:: Use Compact DB option at least once a month to release cache in the SQLite database for NCheck Admin Android client. .. _Ref137629424: .. _Ref181904014: Unregister device ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The unregister option is removing NCheck client registration details from the NCheck server as well as the NCheck client and allowing you to register the client application again. This requires network connectivity to connect with the server. If server connectivity fails, User can cancel the un registration or proceed un registration without removing registration details from the server. .. _Ref45084542: License manager ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Show the License activation window as mentioned in :ref:`Activation` section. .. _Ref137476127: Check for update ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Open NCheck Admin client from the Google play store to update to the newest version. .. _Ref45084693: About +++++++++++++++++++++++++++++++++++++++++++++ About option in the :ref:`Main menu` open About dialog to show application and contact information as below. .. figure:: Images/chapter_clients/image1011.PNG :width: 297 :figclass: align-center #. Application name #. Application version #. NCheck Website #. NCheck support email .. _Ref181904163: Settings ++++++++++++++++++++++++++++++++++++++++++++++++ .. list-table:: Clients settings :widths: 1236 2150 3108 2522 * - - Windows - Android - IOS * - Attend - #. :ref:`Configuration` #. :ref:`Network camera list` #. :ref:`Serial scanners` #. :ref:`External scanners` - #. :ref:`Capture sound` #. :ref:`Capture quality` :ref:`Checkout notification` - #. :ref:`Capture sound` :ref:`Checkout notification` * - Admin - #. :ref:`Configuration` #. :ref:`Encrypt the database` #. :ref:`Network camera list` #. :ref:`Serial scanners` #. :ref:`Serial scanners` - #. Device settings #. :ref:`Capture sound` #. :ref:`Extract on server` #. :ref:`Low CPU support` #. :ref:`Startup application` #. :ref:`External scanners` #. Display settings #. :ref:`Preview position` #. Camera settings #. :ref:`Mirror preview` #. :ref:`Enable app orientation` #. :ref:`Rotation settings` #. Power saving mode #. :ref:`Enable power saving mode` #. Security #. :ref:`Encrypt the database` #. :ref:`Enable MQTT authentication` #. Debug mode #. :ref:`Enhance logs` - Unavailable * - Surveillance - #. :ref:`Camera list` #. :ref:`Serial scanners` #. :ref:`Surveillance engine properties` #. :ref:`External scanners` - Unavailable - Unavailable .. _Ref183004010: Capture sound """"""""""""""""""""""""""""""""""""""""""" Enable to play the capturing sound when the image is capturing. .. _Ref76050282: Checkout notification """""""""""""""""""""""""""""""""""""""""""""""""" Check-out notifications are used to notify the check-out time to user before the check-out ends. Checkout notifications are available on Android and IOS Attend clients registered to an employee. .. _Ref30763884: Extract on server """""""""""""""""""""""""""""""""""""""""""""" In NCheck Admin clients, face details are extracted to identify the faces when capturing faces. Enable this setting to minimize the extraction delay on low performance devices by doing the extraction in the server. .. _Ref30763888: Low CPU support """""""""""""""""""""""""""""""""""""""""""" This setting has been 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. .. _Ref37693682: Startup application """""""""""""""""""""""""""""""""""""""""""""""" Enable this setting to start application on restart the device. .. _Ref137475267: Preview position """""""""""""""""""""""""""""""""""""""""""""" Align camera preview to the top, center, or bottom of the view port. .. _Ref30763899: .. _Ref183003986: External scanners """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" NCheck Admin clients can be used with third party peripheral devices such as biometric scanners, access controls etc. The peripheral devices can be integrated with NCheck Admin client using NCheck Peripheral API. Peripheral API can be used to develop peripheral integration packages (dll in windows and APK in Android) External scanner view can be open from “External scanners” option in the :ref:`Settings` . External scanner view of the Android admin client is shown below. .. figure:: Images/chapter_clients/image1012.PNG :width: 337 :figclass: align-center External scanner configuration view for Android Admin client #. Available external scanner devices #. Configure button This opens configuration view of the selected external scanner device to configure external parameters. These parameters depend on the selected external scanner device. #. Feedback for External scanner view for Windows Admin client is shown below. .. figure:: Images/chapter_clients/image1014.PNG :width: 668 :figclass: align-center External scanner configuration view for Windows Admin client #. Path for the selected external scanner package(dll) #. Browse button Browse external scanner package from the file system #. Configure button Configure parameters of the selected external scanner. .. _Ref37693728: Mirror preview """"""""""""""""""""""""""""""""""""""""""" Enable this to fix the mirror effect of the camera preview. .. _Ref30763981: 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. .. _Ref30763986: 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 Admin Android devices. This applicable for the devices, #. Designed for a specific orientation. #. 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. .. list-table:: Camera orientation :widths: 2659 5318 * - 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, .. list-table:: Custom device rotation :widths: 2411 1994 * - Device orientation - Device rotation * - .. figure:: Images/chapter_clients/image1016.PNG :width: 59 :figclass: align-center - 0 * - .. figure:: Images/chapter_clients/image1017.PNG :width: 96 :figclass: align-center - 1 * - .. figure:: Images/chapter_clients/image1018.PNG :width: 54 :figclass: align-center - 2 * - .. figure:: Images/chapter_clients/image1019.PNG :width: 94 :figclass: align-center - 3 Users can set matching value for device rotation in special devices depending on the device orientation as above table. .. _Ref30763991: 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 #. 10 minutes #. 20 minutes #. 30 minutes #. 1 hour .. _Ref37693782: Encrypt the database """"""""""""""""""""""""""""""""""""""""""""""""" This feature can be used to change the default encryption key or current encryption key of the Admin client. By default, the Admin client encrypts the database with default database password “123456”. To enhance the security, this password can be changed from database encryption password dialog open from “Encrypt the database” option in :ref:`Settings` . .. figure:: Images/chapter_clients/image1020.PNG :width: 423 :figclass: align-center Database encryption password dialog to change default password #. New password field The password must contains 6 characters with at least one uppercase, lowercase letter and number., #. Confirm password field #. Ok button #. Cancel button To change the current password, database encryption password dialog appears as follows. .. figure:: Images/chapter_clients/image1022.PNG :width: 417 :figclass: align-center Database encryption password dialog to change existing password #. Current password #. New password field The password must contain 6 characters with at least one uppercase, lowercase letter and number., #. Confirm password field #. Ok button #. Cancel button .. _Ref30763804: Enhance logs """"""""""""""""""""""""""""""""""""""""" Clients are logging application activities to troubleshooting problems in any case. Except the ordinary logs, there are additional logs which can be logged if the enhance logs setting is enabled. The reason for disabling these special logs by default, prevent consuming device memory and CPU. For example, to log application memory, for every minute. .. _Ref30763809: Capture quality """""""""""""""""""""""""""""""""""""""""""" Select face capture quality to reduce the time when recording events. #. Low #. Medium #. High #. very high .. _Ref181921502: Enable MQTT authentication """""""""""""""""""""""""""""""""""""""""""""""""""""""" NCheck Windows and Android admin clients can use to publish data to MQTT compatible device (Refer section for more details.) and receive data from MQTT compatible third-party peripheral device (Refer section for more details.). To perform such options a client can be connected with either a built-in MQTT broker or any third-party broker service. By default, built in MQTT broker has no security. To enable the authentication when connect with the broker, enable “Enable MQTT authentication” setting from :ref:`Settings` . Once enabled, you can set username and password which should be used when connect with the built in MQTT broker. .. _Ref137538617: Configuration """"""""""""""""""""""""""""""""""""""""""" Show camera guidance message when the of NCheck Windows client is idle. The configuration view is shown below. .. figure:: Images/chapter_clients/image1024.PNG :width: 451 :figclass: align-center Configuration view of Windows client #. Checkbox to enable/disable camera guidance message. #. Camera guidance message, if camera guidance message setting is enabled, Message should have less than 25 characters. .. _Ref37693895: Network camera list """""""""""""""""""""""""""""""""""""""""""""""" This option allows to configure IP cameras with NCheck Windows Admin and surveillance client applications. .. figure:: Images/chapter_clients/image1026.PNG :width: 487 :figclass: align-center Camera list preference of Windows Admin client #. Number of network cameras configured. #. Camera list table Camera name and URL are shown. #. Add button Refer :ref:`Add/edit network camera` section for more details about add network camera. #. Edit button Refer :ref:`Add/edit network camera` section for more details about edit network camera. #. Remove button Remove selected camera. .. _Ref137540174: Add/edit network camera ''''''''''''''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_clients/image1028.PNG :width: 433 :figclass: align-center Add/edit network camera #. Name Name of the camera #. URL URL of the network camera #. Key Camera identification key generated by the client. This cannot be changed .. _Ref108790673: Serial scanners """"""""""""""""""""""""""""""""""""""""""""" Serial scanner configuration in client preferences is used to configure barcode and RFID scanners which can be connected using physical serial port or Bluetooth serial port. The serial scanner view is shown below. .. figure:: Images/chapter_clients/image1030.PNG :width: 623 :figclass: align-center Serial scanners view #. Number of serial scanners available #. Serial scanners table #. Add button Refer :ref:`Add/edit serial scanner` section for more details about add serial scanner. #. Edit button Refer :ref:`Add/edit serial scanner` section for more details about edit serial scanner. #. Remove button Remove selected serial scanner. .. _Ref108795644: Add/edit serial scanner ''''''''''''''''''''''''''''''''''''''''''''''''''''' Add/edit serial scanner view has shown below. .. figure:: Images/chapter_clients/image1032.PNG :width: 359 :figclass: align-center Add/edit serial scanner dialog #. Back button #. Name #. Type Type of the serial scanner as RFID or Barcode #. COM port COM port is serial communication in the client device. COM port can be COM 1, COM 2, COM 3, COM 4 #. Baud rate Baud rate is, data rate used. Admin data rates supported are listed in selection. Baud rate can be: #. 4800 #. 9600 #. 19200 #. 38400 #. 57600 #. 115200 #. 230400 #. Parity The Parity is used to error correction (usually none) eld odd parity and even parity. The available values are: #. None #. Odd #. Even #. Mark #. Space #. Data bits Data bits are number of data bits in a communication character. Data bits can be #. 5 #. 6 #. 7 #. 8 #. Stop bite Serial port stop bits are number of bits sending after one letter/byte to mark finish. Select value from #. None #. 1 #. 1.5 #. 2 #. Key A unique ID that cannot be changed. #. Apply button. .. _Ref40781342: Surveillance engine properties """"""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_clients/image1034.PNG :width: 5 :figclass: align-center .. figure:: Images/chapter_clients/image1035.PNG :width: 420 :figclass: align-center Surveillance engine properties of Surveillance client #. Use NVDIA GPU Enable/disable running surveillance engine on GPU #. Determine Age This enable/disable showing the age on top of the face rectangle in the attendance view. #. Determine gender This enable/disable showing the gender on top of the face rectangle in the attendance view. #. 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. #. Apply button #. Cancel button .. _Ref37693445: Main view for non-biometrics capture --------------------------------------------------------------------------- .. note:: This feature is currently available with NCheck Attend for Android only. In NCheck Attend for Android, users are allowed to record events without presenting face biometrics. In order to enable this feature, Users must enabled the Allow without biometrics setting as mentioned in NCheck control panel :ref:`Client settings view` or :ref:`Device settings` sections. The view is changing according to the enable/disable status of the :ref:`Manual capture start` setting in the NCheck :ref:`Client settings view` or block/unblock device as mentioned in :ref:`Device detail view` as shown in :numref:`Ref32837720` . When the :ref:`Manual capture start` is enabled, user can select the event as check-in or check-out before recording. .. _Ref32837720: .. list-table:: Main views for non-biometric capture :widths: 1885 1875 5256 * - :ref:`Manual capture start` is disabled - Android/IOS Attend - .. figure:: Images/chapter_clients/image1037.PNG :width: 206 :figclass: align-center Capture without biometric view of Android Attend client * - :ref:`Manual capture start` is enabled - Android/IOS Attend - .. figure:: Images/chapter_clients/image1039.PNG :width: 275 :figclass: align-center Capture without biometric view of Android Attend client when manual capture start setting is enabled #. Record event button Record the events #. Check-in button Record the check-in events #. Check-out button Record the check-out events .. _Ref32838404: Attendance view ------------------------------------------------------ Attendance view is where capture employee and visitor events. It may consist of one or more peripherals based on the authentication mode. The authentication mode can be set for the device from the :ref:`Authentication mode` section in the :ref:`Manage devices` . The following table shows peripherals available in each authentication mode. .. list-table:: Relationship between authentication mode and peripherals :widths: 2785 6231 * - Authentication mode - Peripherals * - PASS - Only the ID peripherals such as QR code, RFID, number plate will capture the attendance using :ref:`Id peripherals` . * - Biometric - Unavailable for Attend client. :ref:`Face` , :ref:`Fingerprint` and :ref:`Iris` peripherals can be used to record attendance. * - Biometric and Pass - For Admin clients verify client using both biometric and id data. Once biometric data( :ref:`Face` , :ref:`Fingerprint` or :ref:`Iris` ) captured the ID data( :ref:`Id peripherals` ) can be given to verify. The sequence of the biometric and ID data capturing can be set from the :ref:`Verification order` section. * - Biometric or pass - Record user attendances using either biometric or ID peripheral. Attendance views of the clients are shown below. .. list-table:: :widths: 1221 1610 6276 * - OS - Client - Attendance view * - Android/IOS - Attend - .. figure:: Images/chapter_clients/image1041.PNG :width: 298 :figclass: align-center Attendance view of Android Attend client * - Android - Admin - .. figure:: Images/chapter_clients/image1043.PNG :width: 291 :figclass: align-center Attendance view of Android Admin client * - Windows - Attend - .. figure:: Images/chapter_clients/image1045.PNG :width: 386 :figclass: align-center Attendance view of Windows Attend client * - - Admin - .. figure:: Images/chapter_clients/image1047.PNG :width: 448 :figclass: align-center Attendance view of Windows Admin client Android clients are showing face and barcode peripherals previews. Windows Clients are showing all peripherals previews such as face, finger, iris, barcode etc. Face peripheral is an important peripheral because it uses cameras available with the device. Nowadays, most of the devices such as Android, IOS, laptops come with built-in cameras so that the user doesn’t require any additional hardware to capture employee/visitor faces. But if anyone is supposed to use Finger, iris, you may have to buy relevant hardware. Face peripheral view shows additional features and controls as shown below. .. list-table:: :widths: 1221 1196 6578 * - OS - Client - Face preview view * - Android/IOS - Attend - .. figure:: Images/chapter_clients/image1049.PNG :width: 333 :figclass: align-center Attendance view of Android attend client * - Android - Admin - .. figure:: Images/chapter_clients/image1051.PNG :width: 336 :figclass: align-center Attendance view of Android admin client * - Windows - Attend - .. figure:: Images/chapter_clients/image1053.PNG :width: 373 :figclass: align-center Attendance view of Windows Attend client * - - Admin - .. figure:: Images/chapter_clients/image1055.PNG :width: 447 :figclass: align-center * - - Surveillance - #. Face preview #. Face rectangle A rectangular boundary appears in the edge of the face preview. This does not appear in Attend clients. #. Extracting status #. Capture button Capture face when the ready to capture attendance. The capture button appears for Attend clients only. #. :ref:`Camera capture settings` #. Multi face setting Before capture attendance, depending on the authentication mode, employee must have at least one biometric data enrolled to the employee/visitor or pass data. Refer :ref:`Enroll biometrics` section more details about enrolling biometrics. Once an employee attendance event is recorded, the client will be shown the feedback view for successful event as follows. .. figure:: Images/chapter_clients/image1056.PNG :width: 296 :figclass: align-center Employee feedback view #. Employee name #. Event type #. Event time #. Workhour summery view Workhours summery view is showing employee workhours for the current date, current week and current month. To show the workhour details in the employee feedback view, enable :ref:`Show work time on clients` in either :ref:`Client settings view` of :ref:`Settings` or :ref:`Device settings` of the :ref:`Manage devices` . #. Cancel event Cancel the recorded event. To enable this feature the client should be in :ref:`Admin mode` and :ref:`Cancel event button in the feedback view` setting should be enabled in either :ref:`Client settings view` of :ref:`Settings` or :ref:`Device settings` of the :ref:`Manage devices` . #. Edit event Only the Admin clients have this feature. The recorded employee event can be edited either from the feedback view as shown above or as mentioned in :ref:`Recent events` section. To edit employee event the Admin client should be in :ref:`Admin mode` . For more details about editing employee event refer :ref:`Edit employee event` section. Once a visitor attendance event is recorded, the visitor feedback view will be shown below. .. figure:: Images/chapter_clients/image1058.PNG :width: 359 :figclass: align-center Default visitor feedback view #. Visitor schedule name #. Customer name #. Event type as welcome or goodbye. #. Visitor name #. Event time #. Appointment start time #. Appointment end time #. Cancel event Cancel the visitor event. To enable this feature the client should be in :ref:`Admin mode` and :ref:`Cancel event button in the feedback view` setting should be enabled in either :ref:`Client settings view` of :ref:`Settings` or :ref:`Device settings` of the :ref:`Manage devices` . #. Appointment Open the appointment details as mentioned in :ref:`Appointment detail view` section of :ref:`Manage appointments` . To enable this feature, the client should be in :ref:`Admin mode` . Above is explained the default feedback view of the visitor. This view can be configured for each :ref:`Scenario` using an extension as mentioned in :ref:`Use extension` section. Once custom feedback view template added, the template will be shown in :ref:`Custom visitor feedback view` setting in :ref:`Additional settings` of :ref:`Add/edit visitor schedules` . Once the employee/visitor feedback view appears, it will stop attendance capturing until the feedback view is closed. The employee/visitor feedback views can be closed automatically after number of seconds in :ref:`Result dialogue timeout` in either :ref:`Client settings view` of :ref:`Settings` or :ref:`Device settings` of the :ref:`Manage devices` . If the recorded event is unsuccessful, Appropriate error message will be shown in the following cases. .. list-table:: Reason for unsuccessful employee/visitor events. :widths: 4135 4881 * - Reason for unsuccessful event - Error message * - Peripheral is not available - Peripheral is not ready * - The biometric or ID data is not matching with any employee/visitor - User not found * - Failed to deliver event response before the timeout exceeds (socket timeout) - Cannot connect to the service. Please retry online. * - Try to record with biometrics not supported by the server. - Modality is not supported. * - The device is unregistered from the server. - Device not registered. Please check with the administrator. * - Client sending event time zone with the event time to record event. If there is a considerable difference between event and sever GMT time, this error message will be shown. This prevents recording events with incorrect time. - Time difference detected. Check device time setting. * - No biometrics are enrolled for the employee/visitor. - No template enrolled * - The :ref:`Shift` used to record events is unavailable in the server. - No shifts are available. Contact administrator. * - The :ref:`Shift` may have :ref:`Check-in restriction` , :ref:`Check-out restriction` or :ref:`Overtime restrictions` which caused to record event. - Attendance time is restricted. * - The device or user is blocked. - User not allowed to use this device. * - This message might appear in the client devices registered with cloud server when the cloud subscription is ended. Pay the total outstanding amount to unblock the customer account. - Customer blocked. * - Location restricted and device location service is disabled. Enable location service to resolve this error. - Location not available. Check your setting. * - The location is away from the restricted location from the shown distance. Record events in the restricted location or contact administrator prevent this error. - The current location is away from restricted location by {distance} (±precision) meters! * - The location accuracy of the location service is not enough to determine the device location to find restricted locations. - Current location accuracy is not enough to determine the location * - Single frame liveness failed. Refer :ref:`Server-side face liveness setting` section for more details. - Liveness failed * - This message appears when try to record events from face wearing a mask. Remove the mask or enable mask detection setting as mentioned in :ref:`Mask detection` section. - Identifying with a mask is not enabled. * - The captured image is not clear enough to identify employee/visitor. Capture again. - Failed to identify. Try again. * - The captured image does not have enough lighting. Avoid shadows and capture with more lighting. - Current location accuracy is not enough to determine the location. * - This error happens due to the licensing issue in the server. The server license may expire. Contact administrator. - Licensing issues in server! Please contact administrator. * - The error is shown the time between consecutive events of the same employee/visitor is less than the :ref:`Duplicate event timeout` . To prevent this error, prevent consecutive events or decrease the :ref:`Duplicate event timeout` . - #. Already checked-in, already checked-out (Od versions) #. Last event time %1$s. Next event is allowed after %2$s seconds * - The device is blocked. Unblock he device from :ref:`Device view` . - Device blocked! Please contact administrator. * - The employees who are on restricted leave cannot check-in on the leave day. Refer :ref:`Edit leave` section in :ref:`Manage Leaves and holidays` for more details about applying leaves with restricted/normal leaves. - User not allowed to Check-in while on Restricted Leave * - Event biometric data matches multiple employees/visitors. This might happen due to the quality of the enrolled biometric images of the employees not having enough quality (lighting issues, distance between camera and face, etc..). Contact NCheck support for more details with diagnostic data. - Matching with multiple users. Please contact the administrator * - The location is restricted without the bypass enabled. To prevent this issue, record attendance in the restricted location or bypass the location restriction as mentioned in :ref:`Edit location restriction` section. - Location is restricted. Bypass is not allowed. * - Uknown error. Contact NCheck support for more details with diagnostic data. - Failed .. note:: This section explains how NCheck clients can be used with basic attendance recording for employees and visitors. For additional features refer :ref:`Additional features of capturing` section for more information. .. _Ref182303915: .. _Ref32838516: .. _Ref32846078: .. _Ref32850949: Camera capture settings +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Capture settings are available in Windows clients only. The camera capture settings view for windows client is shown below. .. figure:: Images/chapter_clients/image1060.PNG :width: 448 :figclass: align-center Camera capture settings view #. Rotation angle setting Rotate camera preview anti clockwise direction by angle 0, 90, 180 or 270. By default, the camera preview might be rotated for some cameras connected. This setting can be used to rotate the camera preview at the correct angle. #. Mirror setting Mirror camera preview. For some connected cameras, the camera preview might be mirrored. Enable this setting to correct the camera preview in these cases. #. Resolution setting Change the camera resolution from available. .. _Ref182330089: Additional features of capturing ------------------------------------------------------------------------ The basic attendance capturing has explained under the :ref:`Attendance view` section. The following extended features can be used to record attendances as well. #. :ref:`Face liveness` #. :ref:`Muli face` #. :ref:`Manual capture start` #. :ref:`Safety helmet detection` #. :ref:`Mask detection` #. :ref:`Capture without peripheral` .. _Ref182329878: Face liveness +++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Face liveness is available in Admin clients only. The basic attendance capture is used to record employee and visitor attendances. But it is not preventing attendances recorded using someone else biometrics (Face image, iris image, etc.) or id data. This is called buddy punching. To prevent this face liveness can be used. When face liveness is enabled, client will show set of instructions in the face peripheral preview in the :ref:`Attendance view` and employee/visitor should follow these instructions to record attendance. Otherwise, the attempt will fail. Face liveness can be enabled from :ref:`Face liveness mode for client application` setting in either :ref:`Biometric setting` of :ref:`Settings` or :ref:`Device settings` of the :ref:`Manage devices` . The default value of the :ref:`Face liveness mode for client application` setting is None. That means basic attendance capturing. Refer :ref:`Face liveness mode for client application` for more information about face liveness modes and instructions. .. _Ref182312780: Multi face ++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Multi face is available for Attend clients registered to employee groups. The basic face capturing captures one employee at a time. If there is a group of employees to record attendance each employee should be captured individually. This is not convenient. Multi face feature available in Attend clients can be used to record all of employees capturing all faces in single capture. To enable multi face capture in android and IOS Attend clients, Select :ref:`Enable multi face` setting from the :ref:`Attendance menu` in :ref:`Attendance capturing` . Once captured employees in multi face mode multi face session will be started and multi face view will be available as follows. .. figure:: Images/chapter_clients/image1062.PNG :width: 291 :figclass: align-center Multi face view #. Name of the employee group device registered #. Unidentified face Unidentified faces in the captured image will be shown with red color rectangle #. Identified face Identified employees in the captured image will be shown with green color rectangle. #. Employee list #. :ref:`Identified employee list` #. :ref:`Unidentified employee list` To exit from multi face session. Select the back button. And it will show confirmation to exit from multi face session as below. .. figure:: Images/chapter_clients/image1064.PNG :width: 265 :figclass: align-center Exit multi face session dialog Select OK button to leave multi face session. .. _Ref182319348: Identified employee list """""""""""""""""""""""""""""""""""""""""""""""""""""" The employees identified in the capture’s images are shown in this list as follows. .. figure:: Images/chapter_clients/image1066.PNG :width: 307 :figclass: align-center Identified employee list view #. :ref:`Identified employee view` #. Capture more Capture the employee faces again. The identified and unidentified faces in the captured images are added to the current multi face session. This feature can be used in the following cases. #. Can not capture all faces from single capture #. If there are employees whose are not identified #. Record Record selected identified employees. Once employees recorded, the employee feedback view will be shown as mentioned in :ref:`Multi face events feedback view` section. .. _Ref182317164: Identified employee view '''''''''''''''''''''''''''''''''''''''''''''''''''''' Identified employee view shown below. .. figure:: Images/chapter_clients/image1068.PNG :width: 323 :figclass: align-center Identified employee view #. Identified employee face cropped from the captured image #. Identified employee name #. Identified employee email if exist #. Select this check box to record employee events. .. _Ref182319359: Unidentified employee list """""""""""""""""""""""""""""""""""""""""""""""""""""""" The employees who are not identified in the employee group is shown in this list is shown below. .. figure:: Images/chapter_clients/image1070.PNG :width: 249 :figclass: align-center Unidentified employee list view #. Unidentified employee view #. Capture more Capture the employee faces again. This can be used in the following cases. #. Can not capture all faces from single capture #. If there are employees whose are not identified Unidentified employee view ''''''''''''''''''''''''''''''''''' The employees who are not identified in the employee group is shown in this list is shown below. .. figure:: Images/chapter_clients/image1072.PNG :width: 309 :figclass: align-center #. Unidentified employee name #. Unidentified employee email if exist #. Edit button Select this to show assign a face dialog to assign undefined faces in captures images. Refer :ref:`Assign a face` section for more information. .. _Ref182318524: Assign a face ''''''''''''''''''''''''''''''''''''''''''' If there are unidentified faces in the captured images, these faces can be assigned to the unidentified employees and record employees as identified. To enable this feature, :ref:`Manual face selection` setting from :ref:`Biometric setting` of :ref:`Settings` . Assign a face dialog is shown below. .. figure:: Images/chapter_clients/image1073.PNG :width: 298 :figclass: align-center Assign a face dialog #. Unidentified faces list from captures images If the face is not assigned, the face is available to assign for unidentified employee. If the face is already assigned, the face can be assigned to an unidentified employee, and it will be removed from the previous unidentified employee. #. Cance button .. _Ref182318911: Multi face events feedback view """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Once recorded identified employees, event details are shown in multi face events feedback view as shown below. .. figure:: Images/chapter_clients/image1075.PNG :width: 255 :figclass: align-center #. List of employee’s events recorded Each employee event is showing captured image thumbnail, event type, employee name with employee code and event date and time. #. Done button .. _Ref182329893: Manual capture start ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ By default, client are capturing all peripherals and this consumes battery power and CPU. If the continuous capturing is not required, Manual capture start setting can be used to invoke all capturing views when attendance capturing requires. This is enabled by default for Attend client. This feature can be enabled from :ref:`Manual capture start` setting from either :ref:`Client settings view` of :ref:`Settings` or :ref:`Device settings` of the :ref:`Manage devices` . There are 2 manual capture options. #. Select start button This option is using in Attend clients by default because the Attend clients are capturing faces manually. Once this setting is enabled, Admin client will show start button. Once select start button it will start the :ref:`Attendance view` . #. Check-in/check-out selection Employee/visitor can select event type as check-in or check-out. Once select check-in or check-out button it will start the :ref:`Attendance view` . Once :ref:`Attendance view` started, it will show 10 second timeout. The :ref:`Attendance view` will be closed, #. If the user press back button #. Employee/visitor event captured #. 10 seconds timeout end .. _Ref182329902: Capture without peripheral ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: This feature is available in Attend clients for Android and IOS registered for an employee only If the :ref:`Authentication mode` of the Attend client is set to none, employees can record attendance without using any peripherals. Once the :ref:`Authentication mode` is set to none, the application will show start capture button and employee can record events just by clicking on the button. If the device has in-built identification scanners (fingerprint unlock, face unlock), NCheck Attend client can use these options to enhance the security of using Attend application when capture attendance without peripherals. Currently Android Attend clients can use fingerprint unlock available with the device. IOS Attend client can use face ID and finger ID options. To use in-built scanners, enable :ref:`Use in-built biometric verification on personal clients` setting in the :ref:`Client settings` section of the :ref:`Device settings` . Before using in-built scanners for Attend client, make sure that you have configured the scanners from system settings. .. _Ref182384406: Employee report ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. note:: Employee reports are available for Attend clients registered to an employee. NCheck Attend client registered to an employee can be used to record personal attendances. The employee can check his work hours statistics from report menu in bottom navigation bar as mentioned in :ref:`Open clients` section. Employee reports are shown below. .. figure:: Images/chapter_clients/image1076.PNG :width: 268 :figclass: align-center Employee report view #. Worked hours today This view is showing worked hours completed in the current shift out of shift hours. #. Worked hours this month This view is showing total work hours in current month out of total shift hours of the month. #. Average daily work hours total work hours of the current month divided by number of working days #. First and last check-out today First check-in time and last check-out time in the current shift. .. _Ref181951686: Admin mode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. note:: Admin mode is available for NCheck Admin clients only. Admin mode of the Admin clients allow to manage employees of the registered user group for Admin, visitor admin, employee ( :ref:`Offline operation mode` is disabled) and device admin( :ref:`Offline operation mode` is enabled). The available features are, #. :ref:`Admin dashboard` #. Edit visitor appointments #. :ref:`Edit employee event` Use :ref:`Go to admin mode` in the :ref:`Attendance menu` to login to the admin mode. If the :ref:`Offline operation mode` setting is disabled, user can login to the admin mode using web control panel credentials as follows. .. figure:: Images/chapter_clients/image1078.PNG :width: 396 :figclass: align-center login dialog when offline mode disabled #. Username field Username used to login to the web control panel. #. Password field Password used to login to the web control panel. #. Continue button #. Cancel button If the :ref:`Offline operation mode` setting is enabled, user can login to the admin mode using offline client password as shown below. .. figure:: Images/chapter_clients/image1080.PNG :width: 400 :figclass: align-center login dialog when offline mode enabled #. Password field The default password is “admin”. You can reset the offline client password from :ref:`Reset offline client password` setting in the :ref:`Device settings` . #. Continue button #. Cancel button Once logged in admin mode is shown below. .. figure:: Images/chapter_clients/image1082.PNG :width: 278 :figclass: align-center \ Admin mode view #. Admin navigation menu #. Admin mode Open :ref:`Admin dashboard` . #. Check-in mode Open :ref:`Attendance capturing` view. #. Menu Open :ref:`Main menu` . .. _Ref181953968: Admin dashboard ------------------------------------------------------- If the :ref:`Offline operation mode` is enabled, device admin role can log in to the admin dashboard using the offline client password. The default offline client password is “admin”. This can be reset from :ref:`Reset offline client password` setting in the :ref:`Device settings` . .. note:: In offline mode, the dashboard data will be sent to the server when synchronizing the client. If the :ref:`Offline operation mode` is disabled, either admin, visitor admin or employee role can log into the admin dashboard. The features are available based on the logged in role as shown below. .. list-table:: Admin dashboard features availability based on the user permission :widths: 2605 1264 1676 1839 1632 * - Feature - Admin - Device admin - Visitor admin - Employee * - Add user - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - Generate registration token - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - Add event - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center Admin dashboard is shown below. .. figure:: Images/chapter_clients/image1084.PNG :width: 382 :figclass: align-center Admin dashboard view #. Welcome note for the logged in user #. Default database password warning notification #. :ref:`Add user` #. :ref:`Register device` #. :ref:`Add event` #. Recent employee activity Showing number of recent check-in, checked-out employees. .. _Ref181956391: Default database password warning +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The database of the Admin client is encrypted using default password “123456”. The database warning appears in the :ref:`Admin dashboard` to change the encryption password as below. .. figure:: Images/chapter_clients/image1086.PNG :width: 440 :figclass: align-center Default database password warning notification #. Change database password button Change default database password as mentioned in :ref:`Default database password warning` section. #. Close button Continue with the default database password. If the password change required later, it can be done from :ref:`Encrypt the database` option in the :ref:`Settings` . Change default database password """"""""""""""""""""""""""""""""""""""""" The default database password can be changed from the database encryption dialog shown below. .. figure:: Images/chapter_clients/image1088.PNG :width: 395 :figclass: align-center Database encryption dialog #. New password The password must contain at least 6 characters with lowercase and uppercase letter and a number. #. Confirm password #. Save password button #. Cancel button .. _Ref181955267: .. _Ref181961502: Add user +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Add a new employee to the system. Adding new employees consists of the following steps as follows. #. :ref:`Add employee` #. :ref:`Enroll biometrics` #. :ref:`Generate registration token for employee` This step is unavailable if the :ref:`Offline operation mode` is enabled. .. note:: In offline mode, the dashboard data will be sent to the server when synchronizing the client. .. _Ref181960217: Add employee """""""""""""""""""""""""""""""""""""""""" Add new employee. Employee details dialog is shown below. .. figure:: Images/chapter_clients/image1090.PNG :width: 293 :figclass: align-center Add employee dialog #. Full name field Full name of the employee. This is a mandatory field. #. Email address field Email address if exist. #. Employee code field A unique identification for an employee. This is a mandatory field. #. Generate employee code button Generate employee code. #. Send invite email to new user option Check this option to send invitation email, if user enter email. To send invitation email, :ref:`Email notification settings` should be configured in the :ref:`Notifications` . #. Continue button Select this button to create the user from entered information and open enroll biometric dialog as mentioned in :ref:`Enroll biometrics` section. #. Cancel button .. _Ref181958561: Enroll biometrics """"""""""""""""""""""""""""""""""""""""""""""" Enroll biometrics for the created employee. The enroll biometric dialog is shown below. .. figure:: Images/chapter_clients/image1092.PNG :width: 386 :figclass: align-center #. Skip step button Skip enroll biometric and go to :ref:`Generate registration token for employee` . #. Biometric image upload options #. Capturing biometrics Capturing face, finger and iris from the Admin clients. This will open a capturing view for selected biometric type. If a peripheral is available, biometric can be captured and enrolled. Refer :ref:`Biometric capturing for enrollment` section for more details about capturing biometric image. #. Upload biometrics Upload biometric image from the local file system. Refer :ref:`Upload biometric images` section for more information. #. Continue button Continue to biometric upload according to the selected biometric image upload option #. Back button Open :ref:`Add employee` again. Once the biometric enroll complete, a registration token will be generated for the employee to register a device as mentioned in :ref:`Generate registration token for employee` section. .. _Ref181970904: Upload biometric images ''''''''''''''''''''''''''''''''''''''''''''''''''''' Biometric images in the device file system can be enrolled to a employee using this option. Upload biometric images dialog is shown below. .. figure:: Images/chapter_clients/image1093.PNG :width: 372 :figclass: align-center Upload face image dialog #. Selected biometric image Each selected image appears with the delete button. #. Add photos button Select biometric images from the local file system #. Use image Enroll images to the employee #. Close button. Once selected image enrolled, the enrolled success dialog is shown below. .. figure:: Images/chapter_clients/image1095.PNG :width: 385 :figclass: align-center Biometric images enrolled success dialog #. Uploaded images #. Add more Enroll biometrics again #. Continue button #. Close button If images fail to enroll, a notification will appear in the upload face images dialog as below. .. figure:: Images/chapter_clients/image1097.PNG :width: 354 :figclass: align-center Biometric image enroll fail #. Biometric image enrolls fail notification Showing number of images failed to enroll. #. Image failed to enroll Select on the image to get the failed reason. #. Add photos Add images from the local file system #. Use images Once fixed the failed to enroll images select this button to enroll. #. Close button .. _Ref181959785: Generate registration token for a employee """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. note:: This step is unavailable if the :ref:`Offline operation mode` is enabled Generate registration token for the employee to register an Attend client. The Register user device dialog is shown below. .. figure:: Images/chapter_clients/image1099.PNG :width: 290 :figclass: align-center Register user device dialog #. QR code view QR code which contains registration token and server URL. #. Registration token view Click this view to copy the token to clipboard. #. Send email Email registration token to the given email address. To send the email, :ref:`Email notification settings` should be configured in the :ref:`Notifications` . #. Registration token expiring date and time #. Close button .. _Ref183004663: Register device +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: This step is unavailable if the :ref:`Offline operation mode` is enabled Register NCheck client with the server. This feature will generate a registration token to register the device. There are 3 steps to generate registration tokens. #. Select registration mode #. Select registration type #. Registration token .. _Ref181972758: Select registration mode """""""""""""""""""""""""""""""""""""""""""""""""""""" Select registration mode either user or group as below. .. figure:: Images/chapter_clients/image1101.PNG :width: 179 :figclass: align-center Registration mode selection dialog Once selected, it will ask to select registration type as mentioned in section. .. _Ref181973455: Select registration type """""""""""""""""""""""""""""""""""""""""""""""""""""" If the user registration mode is selected, register user device dialog appears to select the employee as shown below. .. figure:: Images/chapter_clients/image1103.PNG :width: 340 :figclass: align-center Register user device dialog #. Select user field Type username to select the user from the available. #. Assign device Generate registration token for the selected employee. Refer :ref:`Generate registration token` section for more details. #. Back button Open :ref:`Select registration mode` again. #. Cancel button If the group registration mode is selected, register group device dialog appears to select either employee group or location as shown below. .. figure:: Images/chapter_clients/image1105.PNG :width: 332 :figclass: align-center #. Select group field Select the employee group from the list of employee groups. #. Select location field Select the location from the list of locations. #. Assign device Generate registration token for the selected employee. Refer :ref:`Generate registration token` section for more details. #. Back button Open :ref:`Select registration mode` again. #. Cancel button .. _Ref181973019: Generate registration token """"""""""""""""""""""""""""""""""""""""""""""""""""""""" Once select user/user group or location as mentioned in :ref:`Select registration type` section, register device dialog will show the generated registration token as below. .. figure:: Images/chapter_clients/image1106.PNG :width: 312 :figclass: align-center Register device dialog for group #. QR code view QR code which contains registration token and server URL. #. Registration token view Click this view to copy the token to clipboard. #. Send email Email registration token to the given email address. To send the email, :ref:`Email notification settings` should be configured in the :ref:`Notifications` . #. Registration token expiring date and time #. Close button .. _Ref181955275: Add event +++++++++++++++++++++++++++++++++++++++++++++++++ Add an event for an employee. Add event dialog is shown below. .. figure:: Images/chapter_clients/image1108.PNG :width: 322 :figclass: align-center Add event dialog #. Username Type to select employee. #. Event type Event type as check-in on check-out #. Date Event date. The default is the current date. #. Event time The default time is current time #. Time zone #. Shift Select the shift from the list of shifts. #. Cancel button #. Add button .. note:: In offline mode, the dashboard data will be sent to the server when synchronizing the client. .. _Ref182252888: Enroll biometrics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To identify employees/visitors at least one biometric should be enrolled to them self. This can be done either from the web control panel as mentioned in :ref:`Biometric authentication view` section of :ref:`User Management` or NCheck Admin/Attend client. NCheck Attend client can be used to capture/upload face and enroll to an employee/visitor. NCheck Admin client can be used capture/upload face, finger and iris images and enrolling to an employee/visitor. The following enrollment options are available based on the client. .. list-table:: Enrollment options for clients :widths: 4045 1530 1890 1551 * - Enrollment option - Admin client - Attend client (Employee group) - Attend client (Employee) * - Add user and enroll biometrics as mentioned in :ref:`Add user` section in :ref:`Admin dashboard` . - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - Capture web control panel when opening from client. When the web control panel is open from the clients as mentioned in :ref:`Login to control panel` section, the biometric images can be captured and enrolled for the selected employee/visitor using the capture button of the :ref:`Biometric authentication view` of the :ref:`User Management` . - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center * - Self-enroll image. If the employee/visitor tries to record events without enrolled images, client will ask to enroll employee/visitor. In Admin clients, to self-enroll employee/visitors, a valid pass is required. For more details refer :ref:`Attendance capturing` section for more details. - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_clients/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_clients/image48.PNG :width: 14 :figclass: align-center .. note:: To capture biometric images, a peripheral should be available with the client. Attend clients registered to an employe can be used to enroll face images using self-enroll feature. If the employee That the Attend client registered has no face images enroll, the Attend client will show below view before self-enroll templates. .. figure:: Images/chapter_clients/image1110.PNG :width: 405 :figclass: align-center #. Start capture button Start to capture face images. Refer :ref:`Biometric capturing for enrollment` section for more details. #. Cancel button For more details about biometric capturing for enrollment, refer :ref:`Biometric capturing for enrollment` section. .. _Ref181966001: Biometric capturing for enrollment -------------------------------------------------------------------------- Clients can capture biometric images for enrollment in the following ways if peripheral is available with the device. #. :ref:`Face capturing` #. :ref:`Iris capturing` #. :ref:`Finger capturing` Once capture is completed, image preview will show as below. .. figure:: Images/chapter_clients/image1111.PNG :width: 309 :figclass: align-center Capturing preview dialog #. Captured biometric image #. Use the image button Enroll image to the employee/visitor. #. Recapture button If the captured image is not good enough to enroll, recapture an image. #. Close button .. note:: Before enrolling the image, make sure that the captured image is clear and has enough lighting. Once the image is enrolled, the biometric image enrolled success dialog will show as before. .. figure:: Images/chapter_clients/image1113.PNG :width: 325 :figclass: align-center Biometric image enrolled success dialog #. Enrolled image #. Continue button #. Add more Enrolled another biometric image. #. Close button If the enrolled fails, an error dialog will appear with the reason as below. .. figure:: Images/chapter_clients/image1115.PNG :width: 239 :figclass: align-center Biometric image enrollment error dialog .. _Ref181964554: Face capturing ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Face capturing dialog for face enrollment is shown below. .. figure:: Images/chapter_clients/image1117.PNG :width: 310 :figclass: align-center Face capturing dialog for enrollment #. Face preview Admin client is identifying and capturing if a face detected. In Attend client capturing button will be shown to capture face manually. #. Switch camera button #. Camera resolution button #. Close button .. _Ref181964571: Finger capturing ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Finger capturing is available for Admin clients only. Finger capturing dialog for enrollment is shown below. .. figure:: Images/chapter_clients/image1119.PNG :width: 271 :figclass: align-center Finger capturing dialog for enrollment #. Fingerprint preview #. Fingerprint capturing status Available statuses are #. Fingerprint capturing Fingerprint capturing is in-progress. #. Fingerprint scanner not available Supportable fingerprint scanner is unavailable with the device. Refer :ref:`Fingerprint` section for more information about supportable fingerprint scanners. #. Close button .. _Ref181964561: Iris capturing ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Iris capturing available for Admin clients only. Iris capturing dialog for enrollment is shown below. .. figure:: Images/chapter_clients/image1121.PNG :width: 276 :figclass: align-center Iris capturing dialog for enrollment #. Iris preview #. Iris capturing status Available statuses are #. Iris capturing Iris capturing is in-progress. #. Iris scanner not available Supportable fingerprint scanner is unavailable with the device. Refer :ref:`Iris` section for more information about supportable fingerprint scanners. #. Close button .. _Ref183004732: Recent events ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The recent events view shows the following type of events recorded by clients. #. Whitelist Check-in, Check-out events are known as whitelist events. #. Close match The matching score calculated by matching algorithm for the captured image and the employee face image is greater than the :ref:`Recognition threshold` for multiple employees. #. Unidentified Events that the event image is failed to match with any employee are known as unidentified events. Recently recorded events are showing in this view. Recent event list shown below. .. figure:: Images/chapter_clients/image1123.PNG :width: 237 :figclass: align-center Recent events view #. :ref:`Recent event filter view` #. :ref:`Recent event list` .. _Ref182335063: Recent event filter view ---------------------------------------------------------------- Recent events filter view is shown below. .. figure:: Images/chapter_clients/image1125.PNG :width: 392 :figclass: align-center Recent evens filter view #. Event type #. Whitelist #. Close match #. Unidentified #. Any #. 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 #. Timeline of the event By default, this shows the current timeline, and timeline can be changed using the Timeline selector. .. _Ref182335068: Recent event list --------------------------------------------------------- The recent event list shows a list of recent event views as shown below. #. Event thumbnail of whitelist event #. Event type as #. Check-in #. Check-out #. Unidentified #. Close match #. Edit button Edit button is available for Admin and surveillance clients only. The edit button is showing :ref:`Admin mode` of the client is enabled. Refer :ref:`Edit employee event` section for more details. #. Name and employee code of the whitelist event #. Event date and time #. The number of templates closely match with the event image .. figure:: Images/chapter_clients/image1127.PNG :width: 350 :figclass: align-center Recent event view of whitelist event .. figure:: Images/chapter_clients/image1129.PNG :width: 300 :figclass: align-center Recent event view of close match event .. _Ref182335097: Edit employee event ----------------------------------------------------------- .. note:: Edit event feature is available for Admin and surveillance clients only. Once an event is recorded, the event can be edited if the device in :ref:`Admin mode` . Edit employee event dialog can be open from the employee event feedback view as mentioned in :ref:`Attendance view` or from the recent event list as mentioned in :ref:`Recent events` . Edit employee event dialog is shown below. .. figure:: Images/chapter_clients/image1131.PNG :width: 322 :figclass: align-center Edit employee event dialog #. Employee name #. If the event is a whitelist event, name of the matching employee #. If the event is an unidentified event, this will be empty. #. If the event is a close match event, name of the employee who has template with highest matching score. #. Event type Event type as check-in or check-out #. Employee search field Type employee name or employee code to search employee #. Captured event image #. Selected image The selected/matched face image #. Matching face images list Matching face images list. Refer :ref:`Matching face image view` section for more details. #. Record button Record edited event. #. Cancel button .. _Ref182340958: Matching face image view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Matching face image view is shown below. .. figure:: Images/chapter_clients/image1133.PNG :width: 231 :figclass: align-center Matching face image view #. Name of the employee #. Employee code #. Face image thumbnail #. Matching score with the captured image. The score calculated by matching algorithm with the captured image.