WEB CONTROL PANEL ================================== NCheck Bio Attendance administration and configuration application is NCheck Bio Attendance control panel application. This is a web-based application can be accessed using popular web browsers using following URL. Start web Control panel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: Launch NCheck Bio Attendance control panel from Browser :widths: 1157 2709 5039 * - - URL - Remarks * - Cloud - https://cloud.ncheck.net/login - * - On Premises - https://server:port/login - #. Server – Sever name or IP address #. Port – Service port configured on the server. Default port is 8443. * - Standalone - - Simple administration functions are provided in build with NCheck Bio Attendance Standard client application. NCheck Bio Attendance control panel launcher application with extended data capture capabilities are available with the NCheck Bio Attendance Server and NCheck Bio Attendance Standard client installations. This application can be launched from .. list-table:: Launch NCheck Bio Attendance control panel from server and clients :widths: 2245 5670 * - Server - #. Right click on the NCheck Bio Attendance server tray application icon #. select Control panel menu item as :numref:`Ref37254907` * - Windows Standard client - #. Open the application menu #. select control panel as shown in :numref:`Ref37254975` . * - Android Standard Client - #. Open the side bar menu #. Select control panel as shown in :numref:`Ref37255043` .. _Ref37254975: .. figure:: Images/Control_panel/image117.PNG :width: 106 :figclass: align-center NCheck Bio Attendance Windows Standard client main menu .. _Ref37255043: .. figure:: Images/Control_panel/image119.PNG :width: 149 :figclass: align-center NCheck Bio Attendance Android Standard client main menu .. note:: NCheck Bio Attendance server interface will work with recent versions of Mozilla Firefox, Google Chrome, Microsoft Edge, Opera and most common web browsers. It does not work with Internet Explorer browser. .. _Ref32491676: Sign in to web Control Panel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once the NCheck Bio Attendance control panel sign in is triggered in on-premises mode, you may see browser warning as shown in :numref:`Ref34135025` because it fails to validate the SSL certificate with trusted certificate authority. To prevent this warning .. _Ref34135025: .. figure:: Images/Control_panel/image121.PNG :width: 307 :figclass: align-center Browser warning without SSL certificate #. You may use browser option to skip and proceed to the site. #. You may use valid SSL certificate as mentioned in the :ref:`On-premises server configuration` section. #. You may add your server to trusted server list. Once the warning has resolved as mentioned above, user will be asked to login to NCheck Bio Attendance control panel as shown in :numref:`Ref34135353` . .. _Ref34135353: .. figure:: Images/Control_panel/image123.PNG :width: 334 :figclass: align-center NCheck Bio Attendance control panel sign in #. Username #. Password. #. Login button After successful login in, you will be landed in the NCheck Bio Attendance Control Panel Dashboard. The possible error messages after select login button are shown in :numref:`Ref37255442` #. Sign up link This is available only on NCheck Bio Attendance Cloud. It loads the signup page for subscribing to NCheck Bio Attendance Cloud. #. Forget password link The forgot password view appears as shown in :numref:`Ref29390483` . #. Email address #. Security check for human #. Continuer button Password reset email will be sent to the email address if that is specified to a user in NCheck Bio Attendance. In on-premises mode Administrator allows to reset user password as mentioned in :ref:`Change password` section. The error message could be appeared as shown in :numref:`Ref37255455` .. note:: For NCheck Bio Attendance on-premises server, the default admin username and password are “admin”. .. _Ref37255442: .. list-table:: Error messages of web control panel sign-in :widths: 1795 5220 * - Error code - Error message * - 2018 - Invalid username or password. .. _Ref37255455: .. list-table:: Error messages when reset password :widths: 1435 6030 * - Error code - Error message * - 2019 - Could not find the user associated with {email address} email address. After signing in, those who have administrator privileges will be landed in the NCheck Bio Attendance Control Panel Dashboard. If the initial required data is not set up, it will be notified to perform the initial setting up. Once the initial setting up has done, users will be able to access the NCheck Bio Attendance control panel as assigned roles mentioned in :ref:`Web Control Panel Roles` section. .. _Ref29390483: .. figure:: Images/Control_panel/image125.PNG :width: 347 :figclass: align-center Request password reset .. _Ref29818266: WebControl Panel Roles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Current role of the control panel logged in user is shown in the login options. It can be #. Account administrator Account administrator is the owner of the account. He has full authority and can perform all administrative operations. #. Administrator System users can also be assigned administrative privileges. These administrators can do all the admin operations except subscription management and account detail editing. #. Admin Auditor Admin auditor can access all control panel data like administrator. But cannot change and save them. #. Group Administrator Group administrator is an Administrator who can manage an assigned group of users. #. Group admin auditor Group admin is also can access all the data which can accessed by a group administrator. But cannot change and save #. Standard user NCheck Bio Attendance Control Panel provides self service functions for standard users. Web Control Panel View ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NCheck Bio Attendance Control Panel has following components .. figure:: Images/Control_panel/image127.PNG :width: 413 :figclass: align-center NCheck Bio Attendance control panel #. Attendance system name and logo #. Sign in user account options control #. Notifications Launcher control #. NCheck Bio Attendance Help launcher control #. Menu #. Content area #. Neurotechnology company logo #. Product name and version #. Product copyright #. Support email #. Product Terms and conditions #. Product privacy policy Attendance system name and logo ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: Images/Control_panel/image129.PNG :width: 418 :figclass: align-center NCheck Bio Attendance control panel name and logo #. Company Logo Administrator can change this by changing account settings. #. Company name Sign in user account options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: Images/Control_panel/image131.PNG :width: 358 :figclass: align-center NCheck Bio Attendance sign in user account view #. Profile picture of the account #. Sign in username #. Current role One user can have different roles. Roles can be changed from the :ref:`Login options` . Depend on the current role, NCheck Bio Attendance Control panel operations can be changed. #. Signed in email #. My Account Button to view/edit your company details #. :ref:`Login options` #. Sign out .. _Ref33777223: My Account ------------------------------------------------- My Account button in sign in user account options can be used to edit your account details. Depend on the current role, this view is different. .. figure:: Images/Control_panel/image133.PNG :width: 413 :figclass: align-center Edit account details For normal users, it will show his/her details. If you are an account administrator, you will get the account details. For other administrators cannot access account details. #. Profile picture #. Browse button Select the profile picture from the local file system. #. Reset to default profile picture Rest the profile picture to the NCheck Bio Attendance default profile picture as shown in Figure 510 #. Owner Owner of the attendance system account #. Company name #. Comment If any #. Email The email address of the owner #. Address line 1 #. Address line 2 .. figure:: Images/Control_panel/image135.PNG :width: 122 :figclass: align-center Default profile picture #. City #. Country #. State #. Zip code #. Mobile #. Telephone #. Update button The update button will be disabled if the :ref:`Validation errors` exists. All error messages could be appeared are sown in :numref:`Ref37256436` #. Close button .. _Ref37256436: .. list-table:: Error messages of my account view :widths: 1345 5670 * - Error code - Error message * - 3001 - Mobile/telephone number is not valid for the selected country/region. * - 3002 - Invalid email address. .. _Ref30599326: Login options ---------------------------------------------------- Login options window allows doing the following operations. .. figure:: Images/Control_panel/image137.PNG :width: 342 :figclass: align-center Login options #. :ref:`Role management` #. :ref:`Change customer password` #. :ref:`Change customer profile picture` #. Close button .. _Ref34150197: Role management ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image139.PNG :width: 441 :figclass: align-center Role management view #. Available roles for the user #. Selected role #. :ref:`Role view` #. Hint for switch account #. Switch button Select the role and select switch button. The following error messages could be appeared when switch role. .. _Ref34150262: Role view """""""""""""""""""""""""""""""""""""" .. figure:: Images/Control_panel/image141.PNG :width: 346 :figclass: align-center Role view #. Role details #. Admin name #. Admin auditor name #. Group code and name of the group admin/admin auditor #. Username #. Organization name #. Role icon #. Icon to indicate whether the auditor or not .. _Ref34150210: Change customer password +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image143.PNG :width: 442 :figclass: align-center Change customer password view #. Customer account details #. Hint to change password #. Password The password must have at least 6 characters with one digit #. Confirm password #. Update button The update button will be disabled if data :ref:`Validation errors` exists. All error messages are shown in below table. .. list-table:: Error messages of changes password in login options view :widths: 1615 6480 * - Error code - Description * - 3003 - Password does not match. * - 3004 - Password must contain at least 6 characters with one number. .. _Ref38631656: Change customer profile picture ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image145.PNG :width: 330 :figclass: align-center Change customer profile picture view #. Selected profile picture #. Browse button Brose the picture from the file system #. Update button The error messages could be shown when updating profile picture are shown in below. .. list-table:: Error messages of updating customer profile picture in login options view :widths: 1615 6480 * - Error code - Description * - 2020 - Selected file is not a valid image file. Control panel notifications ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: Images/Control_panel/image147.PNG :width: 254 :figclass: align-center Notifications view #. New notifications #. Old Notification messages #. Delete notification #. Date and time of notification .. _Ref32216543: Web Control Panel Menu ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NCheck Bio Attendance web Control Panel Menu is used to access main functions of control panel. Control panel provides following functions through the menu. .. figure:: Images/Control_panel/image149.PNG :width: 202 :figclass: align-center Web control panel menu #. Date and time #. Dashboard #. User Management #. User Group management #. Shift and Rosters #. Leaves and holidays #. Device Management #. Event log #. Reports #. Settings #. Subscription #. Admin tasks Based on the current role, available menu items may be different. Also, the functionality inside the menu item are also different. .. list-table:: Web control panel menu availability for roles :widths: 2389 1114 1089 1104 1089 1104 1127 * - Menu Item - Role - - - - - * - - Account Admin - Admin - Admin Auditor - Group Admin - Group Admin Auditor - Standard User * - :ref:`Dashboard` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Manage Users` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Manage user Groups` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Manage Shifts and Rosters` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - Manage leaves and holidays - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Manage devices` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Manage Event logs` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Reports` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Admin Tasks` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Settings` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Subscription` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center .. _Ref31022752: .. _tooltip_control_panel_dashboard_title: Dashboard ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_dashboard_desc: The dashboard provides a graphical summary of the customer account activities of the NCheck Bio Attendance account. Customer account administrator and users marked as administrators can access the Dashboard. Summary includes .. figure:: Images/Control_panel/image151.PNG :width: 650 :figclass: align-center Web control panel dashboard #. :ref:`Quick access` #. :ref:`Employees Summary` #. :ref:`Devices summary` #. :ref:`Subscription summery` (NCheck Bio Attendance cloud only) #. :ref:`Recent Employee activity` #. :ref:`Leaves and holidays summary` .. _Ref51159572: Quick access --------------------------------------------------- .. figure:: Images/Control_panel/image153.PNG :width: 571 :figclass: align-center Quick access view of the Dashboard #. Welcome note for the logged in user #. Selected user group for the dashboard statics #. Add user Invoke Add new user function and open :ref:`Add/Edit users` user form #. Fix attendance Invoke event log function and apply error event filter to fix errors in attendance events. #. Register device Invoke user group function and open register device form to register a NCheck Bio Attendance client application for a user group. .. _Ref31022975: .. _tooltip_control_panel_dashboard_employee_title: Employees Summary -------------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_dashboard_employee_desc: This is a real time graph present number of checked-in and checked-out employees .. figure:: Images/Control_panel/image155.PNG :width: 307 :figclass: align-center Employee summery view of the Dashboard #. Total number of users #. No. of users Checked-in #. No. of users Checked-out #. No. of users on leave Check-in, check-out and on leave) users will be shown in a dialogue when clicking on each region. .. _Ref31023394: .. _tooltip_control_panel_dashboard_devices_title: Devices summary ---------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_dashboard_devices_desc: This graph presents number of devices registered with users and user group .. figure:: Images/Control_panel/image157.PNG :width: 234 :figclass: align-center Device summery view of the Dashboard #. No of connected client devices #. No of devices registered to users #. No of devices registered to user groups User will be redirected to the :ref:`Manage devices` when click on a devices chart. .. _Ref31023415: .. _tooltip_control_panel_dashboard_recent_users_title: Recent Employee activity ------------------------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_dashboard_recent_users_desc: Recent user event list is shown ordered with latest event first. This is limited to 20 users maximum and 24 hours. .. figure:: Images/Control_panel/image159.PNG :width: 433 :figclass: align-center Employee activity view of the Dashboard #. Overtime approval button The user will be redirect to the :ref:`Overtime view` #. Employee code #. Name #. Last event type #. Data and time #. Time zone #. :ref:`Table menu` #. :ref:`Table paging options` .. _Ref37614614: .. _tooltip_control_panel_dashboard_leaves_and_holiday_title: Leaves and holidays summary --------------------------------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_dashboard_leaves_and_holiday_desc: All employee leaves and holidays for the current month are shown. .. figure:: Images/Control_panel/image161.PNG :width: 401 :figclass: align-center Laves and holidays summary view of the Dashboard #. Current month #. Number of leaves for the day #. Current date #. Holiday #. Recurring holiday The holidays appears in recurring (weekly, monthly or annually) identified as recurring holiday Mouse hover on each date in the calendar will show a summary of available holidays and leaves as mentioned in :ref:`Leaves and holidays summery view` section. .. _Ref51154673: Leaves and holidays summery view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Leaves and holiday summery view is showing the available holidays and leaves for the day as follows. .. figure:: Images/Control_panel/image163.PNG :width: 232 :figclass: align-center Leaves and holidays summery view #. Holidays Name of all available holiday(s) #. No leaves User names and leave types #. Click for more actions Click on each date to more details about the events, leaves and holidays as mentioned in :ref:`Daily statistics view` section. .. _Ref51154763: Daily statistics view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ User will be shown a view to see events, leaves and holidays as follows when click on each day in th3e calendar view. .. figure:: Images/Control_panel/image165.PNG :width: 204 :figclass: align-center Daily statistics view #. Selected date #. Go to events User will be redirected the :ref:`Event logs management` section to monitor all the events in the selected date. #. Go to leaves and holidays User will be redirected to the :ref:`leaves and holidays management` section to monitor all leaves and holidays in the selected date. .. _Ref32220018: Subscription summery ----------------------------------------------------------- .. note:: This view is not available for NCheck Bio Attendance cloud control panel .. figure:: Images/Control_panel/image167.PNG :width: 469 :figclass: align-center Subscription summery view of the Dashboard #. Subscription details #. Plan code #. Plan name .. figure:: Images/Control_panel/image169.PNG :width: 152 :figclass: align-center Subscription details view of the subscription summery view #. Plan statistics #. Percentage of the added users with respect to number of all users available for the plan #. Number of current users #. Number of users available to add #. Progress bar showing the utilized users .. figure:: Images/Control_panel/image171.PNG :width: 255 :figclass: align-center Plan statistics view of the subscription summery view .. _Ref37614517: Manage Users ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following options are available in this view. .. figure:: Images/Control_panel/image173.PNG :width: 646 :figclass: align-center User management view of the web control panel #. Add button Refer :ref:`Add/Edit users` section for more details. #. Search users Filter user from the user table #. :ref:`Users list view` #. :ref:`User details view` #. Advanced button Refer :ref:`Advanced options` section for more details. .. _Ref29826541: .. _Ref32849011: .. _tooltip_server_user_add_users_title: Add/Edit users ----------------------------------------------------------------------------------------------------------------- .. _tooltip_server_user_add_users_desc: This view allows to add a new user to the NCheck Bio Attendance system or edit existing user .. figure:: Images/Control_panel/image175.PNG :width: 655 :figclass: align-center Add user view . #. :ref:`User profile picture` #. First name #. Last name #. :ref:`Employee code` #. Email #. Username The username to allow to login users to the NCheck Bio Attendance control panel. Select User email address as username option to use the email address as the username. #. :ref:`Capture barcode` #. :ref:`Capture RFID` #. Administrator right Admin right as Employee (Standard user), Admin or Admin auditor as mentioned in :ref:`Web Control Panel Roles` section. #. Address line 1 #. Address line 2 #. City #. Country #. State #. Zip code #. Telephone #. Primary user group Select the primary user group user belongs if the user is available in several user groups. Refer :ref:`Manage user Groups` section for more details. #. Add button The add button will be disabled if the mandatory data fields are empty or :ref:`Validation errors` exits. Refer :numref:`Ref38110774` for all error messages could be appeared. #. Close button .. _Ref38110774: .. list-table:: Error message of add/edit user :widths: 1435 6480 * - Error code - Description * - 3001 - Mobile/telephone number is not valid for the selected country/region. * - 3002 - Invalid email address. * - 2020 - Selected file is not a valid image file. * - 2021 - Employee code already exists. * - 2022 - Barcode ID is already available for different user * - 2023 - RFID is already available for different user .. _Ref37614833: Employee code ++++++++++++++++++++++++++++++++++++++++++++++++++++ Unique ID to identify employees. Administrator allows to specify an employee code or generate code as shown in below. .. figure:: Images/Control_panel/image177.PNG :width: 288 :figclass: align-center Employee code view #. Employee code field #. Generate button Select Generate button to generate code with 6 characters .. _Ref37614771: User profile picture +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image179.PNG :width: 328 :figclass: align-center Profile picture view #. :ref:`Profile picture from the local file system` #. :ref:`Profile image from unidentified image` .. _Ref32222059: Profile picture from the local file system +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Select the profile picture from the local file system. After select the image, crop view allows to crop the user image as shown in figure .. figure:: Images/Control_panel/image181.PNG :width: 329 :figclass: align-center Profile picture crop view #. Original image view #. Cropping rectangle User can change the margin of the rectangle to crop the image #. Result image view after cropping .. _Ref37615016: .. _tooltip_control_panel_user_add_profile_image_from_unidentified_image_title: Profile image from unidentified image +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_user_add_profile_image_from_unidentified_image_desc: Face images failed to identify user when recording the attendances are known as unidentified images. User can select the user profile image from these unidentified images. .. figure:: Images/Control_panel/image183.PNG :width: 408 :figclass: align-center Select profile picture form unidentified image view #. Date filter Retrieve unidentified images between selected date range #. Unidentified images list #. Close button #. Select button .. _Ref32228043: Capture barcode ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image185.PNG :width: 307 :figclass: align-center User barcode ID view #. Barcode text field #. Capture button Select Capture button to scan the barcode from the client application as mentioned in :numref:`Ref32225198` .. _Ref32225198: .. list-table:: Capturing barcode from Client applications :widths: 1525 7467 * - Android client - #. Main menu .. figure:: Images/Control_panel/image187.PNG :width: 250 :figclass: align-center Barcode capture view of the Android client #. Switch camera #. Change resolution #. Barcode scan area The :numref:`Ref38110931` is showing the error message could be appeared. * - Windows client - #. Select the barcode text field #. Scan the barcode from the connected barcode scanner The :numref:`Ref38110931` is showing the error message could be appeared. .. _Ref38110931: .. list-table:: Error message of capture barcode :widths: 1435 6210 * - .. _Ref32228061: Error code - Description * - 3005 - Barcode scanner could not be found. * - 2039 - Could not capture barcode. The device has been blocked .. _Ref37614894: Capture RFID +++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image189.PNG :width: 312 :figclass: align-center User RFID capture view #. RFID text field #. Capture button Select Capture button to scan the RFID from the client application as mentioned in :numref:`Ref32225232` . .. _Ref32225232: .. list-table:: Capturing RFID from Client applications :widths: 1885 7107 * - Android client - #. RFID scan view appear as Figure 537 .. figure:: Images/Control_panel/image191.PNG :width: 155 :figclass: align-center RFID capture view of the Android client #. Scan the RFID #. RFID id will appear in the RFID ID field. The :numref:`Ref32225232` is showing the error message could be appeared. * - Windows client - #. Select the RFID text field #. Scan the RFID from the connected RFID scanner #. RFIC id will appeared in the RFID field. The :numref:`Ref32225232` is showing the error message could be appeared. .. list-table:: Error message of capture RFID :widths: 1435 6210 * - Error code - Description * - 3006 - RFID scanner could not be found * - 2040 - Could not capture RFID. The device has been blocked .. _Ref37614702: .. _Ref38631995: Users list view ------------------------------------------------------------------------ .. figure:: Images/Control_panel/image193.PNG :width: 608 :figclass: align-center User table view of the user management #. :ref:`Table header` #. :ref:`Table paging options` #. Selected user The selected user details are shown in :ref:`User details view` .. _Ref32566770: User details view -------------------------------------------------------- #. :ref:`User quick view` .. figure:: Images/Control_panel/image195.PNG :width: 318 :figclass: align-center User details view of the user management #. :ref:`User specific settings` .. _Ref32238164: .. _tooltip_server_user_quick_view_title: User quick view ------------------------------------------------------------------------------------------------- .. _tooltip_server_user_quick_view_desc: This section allows to control all user specific functions when recording attend .. figure:: Images/Control_panel/image197.PNG :width: 486 :figclass: align-center User management quick view #. Username #. User details #. Address #. Email #. Phone #. User status #. User Added user groups. #. Devices Registered devices. Select Unregister button to unregister each device. #. Show events button Show all events of the user. #. Biometrics button Refer :ref:`Change biometrics` section for more details. #. Edit button Refer :ref:`Add/Edit users` section for more details. #. Change password button Refer :ref:`Change password` section for more details. #. Block/Unblock button Refer section :ref:`Block/unblock users` for more details. #. Export button Export following details for selected user. #. :ref:`User profile information` #. :ref:`User location restrictions information` #. Register button This option allows to generate registration token to register the device for the selected person. Once select the button, the :ref:`Client registering view` will be appeared. #. Remove button Refer :ref:`Remove users` section for more details. .. _Ref29827124: Change password ++++++++++++++++++++++++++++++++++++++++++++++++++++++ After assigning a username as mentioned in :ref:`Add/Edit users` section, the password can be changed. Password must be consisted with one digit and 6 characters. .. figure:: Images/Control_panel/image199.PNG :width: 492 :figclass: align-center Change user password view #. User name #. Email #. Password Password must have atleast 6 characters and one digit. #. Generate button Generate a password. #. Change button Change button will be disabled if the :ref:`Validation errors` exits. :numref:`Ref37310743` is showing the error messages could be appeared. #. Close button .. _Ref37310743: .. list-table:: Error messages of change password :widths: 1615 6480 * - Error code - Description * - 3003 - Password does not match. * - 3004 - Password must contain at least 6 characters with one number. .. _Ref29825069: .. _tooltip_server_user_biometrics_title: Change biometrics +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_user_biometrics_desc: In the Biometric data dialogue, new biometrics can be enrolled using the below options. .. figure:: Images/Control_panel/image201.PNG :width: 458 :figclass: align-center Add biometrics view #. Enrolled biometrics #. :ref:`Enroll from history` #. Menu for capture from client applications #. Menu for :ref:`Upload biometric image` #. Delete button #. Close button .. _Ref29825145: .. _tooltip_server_user_biometrics_history_title: Enroll from history """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_user_biometrics_history_desc: The face, fingerprint, and iris images, unable to identify the user while recording attendances, are kept in NCheck Bio Attendance server. These biometric images can be used to enroll users. In the Select from history window, .. figure:: Images/Control_panel/image203.PNG :width: 583 :figclass: align-center Select biometrics from history view #. Date range Biometrics will be retrieved within the selected date range. #. Closely matching biometrics NCheck Bio Attendance server will filter out the closely matching biometrics for the user from history. #. Filter by device Filter out the biometrics matching for the device. #. Filter by user group Biometrics used to enroll for the selected user group. #. Biometric quick view as shown in :numref:`Ref34213937` .. _Ref34213937: .. figure:: Images/Control_panel/image205.PNG :width: 179 :figclass: align-center Biometric image view of select biometric from history view #. Biometric thumbnail #. Delete button #. Date and time biometric captured #. View button To show the Biometric detail view. #. Paging details Functionalities to navigate through all face images in ach page. #. Time line show the latest updated image date and time of each page between date time of recently updated image and first updated image. #. Next button Current page number of available pages. #. Enroll button Enroll button will be disabled if no biometric image has selected. The table is showing all error message could be appeared. #. Close button .. list-table:: Error message of select biometric from history :widths: 1435 6210 * - Error code - Description * - 2024 - Could not enroll selected face/finger/iris image. Biometric detail view """""""""""""""""""""""""""""" .. figure:: Images/Control_panel/image207.PNG :width: 365 :figclass: align-center Biometric detail view #. Biometric event date and time #. Biometric details #. Modality Face, Fingerprint, or Iris #. Time The date and time of the event the biometric image had uploaded. #. Close button .. _Ref34394581: Capture from client applications """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Biometrics can be enrolled through the NCheck Bio Attendance client applications such as NCheck Bio Attendance Lite for Windows and Android and NCheck Bio Attendance Standard for Windows and Android. To capture .. figure:: Images/Control_panel/image209.PNG :width: 243 :figclass: align-center Menu for capture biometrics from client applications #. Select biometric capture type form the list #. Capture face #. Capture fingerprint #. Capture iris #. Capture the selected biometric when the capture view is appeared as mentioned in #. :ref:`Capture face from lite clients` #. :ref:`Capture face from standard clients` #. :ref:`Capture fingerprint from Standard clients` #. :ref:`Capture iris from Windows standard client` The error messages could be appeared when capture biometric from clients are showing below. .. list-table:: Error messages when capture biometrics :widths: 1435 6210 * - Error code - Description * - 3007 - Camera could not be found. * - 3008 - Fingerprint scanner could not be found * - 3009 - Iris scanner could not be found * - 2025 - Capture face with enough lighting * - 2026 - The biometric image has already enrolled for another user * - 2038 - Could not enroll biometrics. The device has been blocked .. _Ref32938704: .. _Ref32921296: Capture face from lite clients """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. list-table:: Face enroll views for lite client :widths: 1075 7560 * - Windows lite client - .. figure:: Images/Control_panel/image211.PNG :width: 407 :figclass: align-center Windows lite client face capture view * - Android lite client - .. figure:: Images/Control_panel/image213.PNG :width: 176 :figclass: align-center Android lite client face capture view #. Camera preview #. Face rectangle (Standard client only) #. Capture button Select capture button to capture face image in lite client. In Windows Standard, select capture button when the user has prepared to capture the face. #. Camera name #. Captured face list Windows clients allows to capture multiple face images before upload. Android clients allows to capture a single image before upload. #. Cancel button (Windows clients only) #. Continue button In windows clients, select continue button to upload captured face list to the server. In Android client captured image will automatically uploading to the server. #. Android lite client resolution menu #. Change front/back camera button .. _Ref32938722: Capture face from standard clients """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. list-table:: Face enroll views for standard clients :widths: 1075 7560 * - Windows Standard client - .. figure:: Images/Control_panel/image215.PNG :width: 386 :figclass: align-center Windows standard client face capture view * - Android Standard client - .. _Ref32938496: .. figure:: Images/Control_panel/image217.PNG :width: 141 :figclass: align-center Menu of Android standard client face capture view .. figure:: Images/Control_panel/image219.PNG :width: 167 :figclass: align-center Android standard client face capture view #. Camera preview #. Face rectangle (Standard client only) #. Capture button Select capture button to capture face image in lite client. In Windows Standard, select capture button when the user has prepared to capture the face. #. Camera name #. Captured face list Windows clients allows to capture multiple face images before upload. Android clients allows to capture a single image before upload. #. Cancel button (Windows clients only) #. Continue button In windows clients, select continue button to upload captured face list to the server. In Android client captured image will automatically uploading to the server. #. Menu of Android standard client face capture view as shown in :numref:`Ref32938496` #. Switch camera Change front/back camera #. Resolution Camera resolutions dialogue .. _Ref32921319: Capture fingerprint from Standard clients """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. list-table:: Fingerprint enroll views for standard clients :widths: 1075 7110 * - - Standard client * - Windows - .. _Ref32920410: .. figure:: Images/Control_panel/image221.PNG :width: 454 :figclass: align-center Windows standard client fingerprint capture view * - Android - .. figure:: Images/Control_panel/image223.PNG :width: 217 :figclass: align-center Android standard client fingerprint capture view #. Fingerprint scanner name (Windows standard client only) #. Fingerprint scanner status #. Android Standard client is Showing “Fingerprint capturing” message if the scanner is available. Otherwise “Fingerprint reader not available” #. Windows standard client is showing finger print icon as shown in :numref:`Ref32920410` if the fingerprint scanner is available. Otherwise “Unable to detect the fingerprint scanner. Please verify the finger scanner is connected and functioning correctly.”. #. Captured fingerprint images list Windows standard client allows to capture multiple fingerprint images. Android standard client allows to capture only single fingerprint image before upload. #. Cancel button (Windows client only) #. Continue button In Windows standard client, select continue button to upload captured fingerprint images. Android standard client will upload the fingerprint image automatically once it captured successfully. .. _Ref32921336: Capture iris from Windows standard client """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/Control_panel/image225.PNG :width: 503 :figclass: align-center Windows standard client iris capture view #. Iris preview #. Iris scanner name #. Captured iris image list #. Cancel button #. Continue button Upload captured iris images to the server. .. _Ref29825199: Upload biometric image """"""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/Control_panel/image227.PNG :width: 226 :figclass: align-center Menu for upload biometric images for user #. Select biometric upload type from #. Upload face image #. Upload fingerprint #. Upload iris image #. Select selection to upload the biometric image from your file system. The following errors could be occurred uploading selected biometrics .. list-table:: Error messages of upload biometric images :widths: 1435 6210 * - Error code - Description * - 2020 - Selected file is not a valid image file. .. _Ref37773600: Block/unblock users ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The selected user can be block/unblock using this option. Blocked users are not allowed to enroll biometrics or record attendances. .. _Ref34301540: Remove users +++++++++++++++++++++++++++++++++++++++++++++++++++ Remove selected user from the users list. .. _Ref29830223: User specific settings ------------------------------------------------------------- User specific settings allows to #. :ref:`Manage location restrictions for user` #. :ref:`Leave entitlement` .. _Ref48558609: Manage location restrictions for user ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Refer :ref:`Location restrictions` section for more details. .. _Ref33535172: .. _tooltip_server_leave_entitlement_title: Leave entitlement +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_leave_entitlement_desc: This view is showing the number of leaves user has taken and number of remaining leaves from each Leave type. Also, user leaved entitlement can be updated. .. figure:: Images/Control_panel/image229.PNG :width: 418 :figclass: align-center Leave entitlement view #. :ref:`Leave type summery` #. Edit button Refer :ref:`Edit leave entitlement` section for more details .. _Ref32238318: Leave type summery +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image231.PNG :width: 217 :figclass: align-center Leave type summery view #. Leave type Refer :ref:`Configure leave type` section for more details. #. Number of leaves taken by the user #. Number of available leaves .. _Ref32238325: Edit leave entitlement +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image233.PNG :width: 441 :figclass: align-center Edit leave entitlement view #. Username #. Number of leaves available for each user #. Number of leaves user has already taken #. Update button #. Close button .. _Ref29830142: Advanced options ------------------------------------------------------- .. figure:: Images/Control_panel/image235.PNG :width: 198 :figclass: align-center Advanced options of User management #. :ref:`Import data` #. :ref:`Export data` #. :ref:`Restore deleted users` .. _Ref29827258: Import data +++++++++++++++++++++++++++++++++++++++++++++++++++ This option allows to import all user data as mentioned in :ref:`Import and Export information` section. Tio import data, .. figure:: Images/Control_panel/image237.PNG :width: 364 :figclass: align-center Import users data view #. Select information to be imported from the list #. :ref:`User profile information` #. :ref:`User/user group location restrictions information` #. :ref:`User biometrics and template files` #. Select Import button to select the import location. Refer :ref:`Select import location` section for more details. .. _Ref29827276: Export data ++++++++++++++++++++++++++++++++++++++++++++++++++ This option allows export all user data as password protected zip file as follows .. figure:: Images/Control_panel/image239.PNG :width: 383 :figclass: align-center Export users data view #. Select information to be imported from the list #. :ref:`User profile information` #. :ref:`User/user group location restrictions information` #. Select Export button to select the export location. Refer :ref:`Select export location` for more details .. _Ref29827297: Restore deleted users ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image241.PNG :width: 485 :figclass: align-center Restore deleted users view #. Deleted user table #. Restore button #. Close button To Restore deleted user, #. Select the user from the table #. Select Restore button #. Change the user details in the Recover user dialogue if necessary #. Select Recover button .. _Ref38783216: .. _tooltip_control_panel_manage_user_groups_title: Manage user Groups ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_manage_user_groups_desc: Administrator and user group administrators allow managing users as user groups. All user group is the default user group including all users and it is accessible for administrator only. In the user group management dialogue. .. figure:: Images/Control_panel/image243.PNG :width: 591 :figclass: align-center User group management view of web control panel #. Add button Refer :ref:`Add/Edit user group` section for more details. #. Search Search user group by group name #. :ref:`User groups list view` #. :ref:`User group details view` #. Advanced button Refer :ref:`Advanced options` section for more details. .. _Ref29890740: .. _tooltip_server_user_group_edit_users_title: Add/Edit user group ----------------------------------------------------------------------------------------------------------- .. _tooltip_server_user_group_edit_users_desc: This view allows to add a new user group or edit existing user group. .. figure:: Images/Control_panel/image245.PNG :width: 412 :figclass: align-center Add/edit user group view #. Profile picture #. User group code Unique code to identify user group #. Description #. Add button Add button will be disabled If the mandatory fields are empty or :ref:`Validation errors` exists. Refer :numref:`Ref38111163` for more details of error massagers could be occurred. #. Cancel button .. note:: All user group could not be edited. .. _Ref38111163: .. list-table:: Error messages of add/edit user group :widths: 1615 5850 * - .. _Ref29895352: .. _Ref32567818: Error code - Description * - 2020 - Selected file is not a valid image file. * - 2027 - User group code has already existed. Error messages of add/edit user ++++++++++++++++++++++++++++++++++++++++++++++++++ .. list-table:: Error messages of add/edit user :widths: 4508 4508 * - Error message - Description * - User group code has already existed. Please try different group code. - User group could not be duplicated. .. _Ref37615259: User groups list view ------------------------------------------------------------ .. figure:: Images/Control_panel/image247.PNG :width: 599 :figclass: align-center User groups list view #. :ref:`Table header` #. All user group All user group is the default user group including all the users. #. Selected user group Selected user group details are shown in :ref:`User group details view` . #. :ref:`Table paging options` .. _Ref32245893: .. _Ref29895341: User group details view -------------------------------------------------------------------------------- .. figure:: Images/Control_panel/image249.PNG :width: 652 :figclass: align-center User group details view #. :ref:`User group quick view` #. :ref:`Attached users` #. :ref:`User group specific settings` .. _Ref29895368: .. _tooltip_server_user_group_quick_view_title: User group quick view ------------------------------------------------------------------------------------------------------------- .. _tooltip_server_user_group_quick_view_desc: This view is showing user group details and allow user to perform user group specific functions .. figure:: Images/Control_panel/image251.PNG :width: 394 :figclass: align-center User group quick view #. Group name and code #. Number of users #. Devices registered to the group Select Unregister button to un-register the device #. Group admins button Edit group admins of the user group. Refer Group admins section for more details #. Register device button Generate registration token to register a device for selected user group. Once select the button, the :ref:`Client registering view` will be appeared. #. Edit button Edit the user group. Refer :ref:`Add/Edit user group` section for more details. #. Delete button Delete the selected user group. All user group could not be deleted. #. Settings button User group specific settings. Refer :ref:`General settings` section for more details. Delete user group ++++++++++++++++++++++++++++++++++++ Delete selected user group from the user group list. .. _tooltip_control_panel_user_group_group_admin_title: Group admins ------------------------------------------------------------------------------------------ .. _tooltip_control_panel_user_group_group_admin_desc: User group admin allows to manage users in the user group according to the assign permission level. .. figure:: Images/Control_panel/image253.PNG :width: 497 :figclass: align-center User group admins view #. User group name and code #. :ref:`Table header` #. Check box to add/remove group admin #. Write permission Refer :ref:`Group admin permission` section for more details. #. :ref:`Table paging options` #. Close button .. note:: Group admins are not available for the All users group. .. _Ref32246023: Group admin permission +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Group admins can be created with following permissions. #. Read Write Group admins can manage users assigned to group. #. Read only Group admins can review users assigned to particular group. .. _Ref29895359: Attached users ++++++++++++++++++++++++++++++++++++++++++++++++++++++ All users attached to the selected user group are showing in this view as follows. .. figure:: Images/Control_panel/image255.PNG :width: 475 :figclass: align-center Attached users view #. Selected user group code #. :ref:`Table header` #. :ref:`Table paging options` #. Edit button Select edit button Refer :ref:`Edit attached users` section for more details. .. _Ref29889518: Edit attached users ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This view allows to add/remove users from the user group .. figure:: Images/Control_panel/image257.PNG :width: 475 :figclass: align-center Edit attached users view #. User group code #. :ref:`Table header` #. Checkbox to add/remove user #. :ref:`Table paging options` #. Update user group button #. Cancel button .. _Ref38034334: User group specific settings ------------------------------------------------------------------- .. _Ref43202110: General settings +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image259.PNG :width: 602 :figclass: align-center General settings of the user group #. :ref:`Maximum occupancy for group premises` .. _Ref43201989: Maximum occupancy for group premises """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Administrator/user group administrator allows to limit the number of employees/users of the user group in the premises. To limit users, enable this setting and add the number of allowed users. The users who are entitle to the user group as the primary user group will be count when check-in to the premises. If the check-in count is greater than the maximum occupancy for group premises, the check-ins will be restricted. Refer :ref:`Add/Edit users` section to change the primary user group of the users. Manage location restrictions for user group ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Refer :ref:`Location restrictions` section for more details. .. _Ref32245852: Advanced options of user group view -------------------------------------------------------------------------- .. figure:: Images/Control_panel/image261.PNG :width: 214 :figclass: align-center User group management advanced options #. :ref:`Import user group data` #. :ref:`Export user group data` .. _Ref38043224: Import user group data +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Import all user group data as mentioned in :ref:`Import and Export information` section, To import, .. figure:: Images/Control_panel/image263.PNG :width: 400 :figclass: align-center Import user groups data view #. Select data from the list to be imported #. :ref:`User group information` #. :ref:`User group memberships information` #. :ref:`User/user group location restrictions information` #. Select start import button Refer the :ref:`Select import location` section for more details .. _Ref38043309: Export user group data +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Export all user group data as a password protected zip file as follows, .. figure:: Images/Control_panel/image265.PNG :width: 406 :figclass: align-center Export user group data view #. Select data from the list to be exported #. :ref:`User group information` #. :ref:`User group memberships information` #. User group location restrictions information #. Select start export button Refer :ref:`Select export location` for more details .. _Ref31022807: .. _tooltip_manage_shifts_and_rosters_title: Manage Shifts and Rosters ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_manage_shifts_and_rosters_desc: Work schedule of the users/user groups in the organization can be managed in this section. .. figure:: Images/Control_panel/image267.PNG :width: 668 :figclass: align-center Shift and rosters management view #. :ref:`Shift management view` #. :ref:`Roster management view` #. :ref:`Roster item management view` .. _Ref29914289: .. _Ref33778733: .. _tooltip_control_panel_shift_title: Shift management view ---------------------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_shift_desc: Daily work schedule can be created with shifts. Shift can be created with specific start time and end time with restrictions such as work hours should be covered, check-in, check-out, and OT hours. Shift management view as follows .. figure:: Images/Control_panel/image269.PNG :width: 349 :figclass: align-center Shift management view #. Shift name #. Shift start time #. Shift end time #. Edit button Edit the shift. Refer :ref:`Add/Edit shifts` section for more details. #. Delete button Delete the shift. #. Add button Refer :ref:`Add/Edit shifts` section for more details. #. :ref:`Import/export shifts` .. _Ref29901626: .. _tooltip_control_panel_shift_add_title: Add/Edit shifts ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_shift_add_desc: This view allows to add new shift or edit existing shift details .. figure:: Images/Control_panel/image271.PNG :width: 408 :figclass: align-center Add/edit shifts view #. Shift name #. Description #. Shift start and end time #. Work hours #. Select checkbox to add time duration to restrict check-ins #. Select checkbox to add time duration to restrict check-outs #. Select checkbox to add time duration to restrict overtime hours #. Select checkbox to add maximum overtime hours allowed #. Add button Add button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exists. Refer :numref:`Ref34228245` for more details about error messages could be occurred. #. Close button .. _Ref34228245: .. list-table:: Error messages of add/edit shift :widths: 1795 6390 * - Error code - Error message * - 2028 - The shift name has already existed. .. _Ref29901641: Import/export shifts +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Import shifts """""""""""""""""""""" .. figure:: Images/Control_panel/image273.PNG :width: 423 :figclass: align-center Import shifts view Shift information can be imported as mentioned in :ref:`Import and Export information` section. To impot, #. Select the Shift to import :ref:`Shifts information` #. Start Import button to select the import location. Refer :ref:`Select import location` section for more details. Export shifts """""""""""""""""""""" .. figure:: Images/Control_panel/image275.PNG :width: 538 :figclass: align-center Export shift view Shift information can be exported as a password protected zip file as follows. #. Select Shifts to export :ref:`Shifts information` #. Start Export button to select export location. Refer :ref:`Select export location` for more details. .. _Ref29914296: .. _tooltip_control_panel_rosters_title: Roster management view ------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_rosters_desc: Rosters are specific duration in weeks to plan the organizational activities with shifts for certain time periods. .. figure:: Images/Control_panel/image277.PNG :width: 474 :figclass: align-center Roster management view Manage rosters view allows to, #. Current date #. Selected roster #. Roster name #. Roster range #. Ends on Roster end date if specified. Otherwise “no end date” will be shown #. Status Whether the roster is currently in user or not. #. Edit button Refer :ref:`Add roster` section for more details. #. Delete button Delete selected roster. #. New roster button Refer :ref:`Add roster` section for more details. #. :ref:`Import/export rosters` .. _Ref29904361: .. _tooltip_control_panel_rosters_add_title: Add roster +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_rosters_add_desc: This view allows to add new roster. .. figure:: Images/Control_panel/image279.PNG :width: 416 :figclass: align-center Add roster view #. Roster name #. Repetition How many weeks the roster should span - Default is 1 week. Maximum 4 weeks. #. Start date of the roster You may select any day, but the starting day will be Monday of the selected day’s week by default. #. End of repetition If no end date specified, the roster will iterate infinitely. If you specified the end date, the roster would end on the specified date and thereafter you will not be able to add roster items to it. #. Continue button Continue button will be disabled if the mandatory fields are disabled or :ref:`Validation errors` exists. Refer :numref:`Ref34228296` for more details about error messages could be occurred. #. Close button .. _Ref34228296: .. _Ref29910801: .. list-table:: Error messages for add roster :widths: 1435 6210 * - Error code - Error message * - 2029 - The roster name has already existed. .. _Ref29904378: Import/export rosters ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Import rosters """"""""""""""""""""""" .. figure:: Images/Control_panel/image281.PNG :width: 443 :figclass: align-center Import rosters view Roster information can be imported as mentioned in :ref:`Import and Export information` section. Tip import, #. Select data from the list to import #. :ref:`Rosters information` #. :ref:`Roster items information` #. Select Start Import button to select the import location Refer the :ref:`Select import location` section for more details. Export rosters """"""""""""""""""""""" .. figure:: Images/Control_panel/image283.PNG :width: 442 :figclass: align-center Export rosters view Roster information can be exported as password protected zip file as follows. #. Select data from the list to export #. :ref:`Rosters information` #. :ref:`Roster items information` #. Select Start Export button to select the export location Refer the :ref:`Import and Export information` section for more details .. _Ref29914308: .. _tooltip_control_panel_roster_items_title: Roster item management view ----------------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_roster_items_desc: After configuring rosters and shifts, roster items can be added for specific dates with user/user groups assigning shifts as follows. .. figure:: Images/Control_panel/image285.PNG :width: 649 :figclass: align-center Shift and roster management roster item management view #. Weeks #. Calendar view #. Roster item #. :ref:`Add menu` #. Filter by Shift Filter roster items by shift #. Filter by user/user group Filter roster items by user/user group #. New button Add roster item. Refer :ref:`Add roster item` section for more details Roster item view +++++++++++++++++++++++++++++++++++ Following details and operation are available in the roster item view. .. figure:: Images/Control_panel/image287.PNG :width: 285 :figclass: align-center Roster item view #. Shift name, start time and end time #. Assigned user/user group list #. Assigned user/user group Refer :ref:`Add additional staff` section for more details #. Delete user/user group .. _Ref32305827: Add menu +++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image289.PNG :width: 197 :figclass: align-center Add menu of roster items management view #. :ref:`Add roster item` #. :ref:`Add additional staff` .. _Ref29913944: .. _tooltip_control_panel_add_roster_items_title: Add roster item +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_add_roster_items_desc: This view allows to add new roster item to the roster. .. figure:: Images/Control_panel/image291.PNG :width: 460 :figclass: align-center Add roster item view #. Date #. Shift #. User/user group #. Add button Add button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exists. Refer :numref:`Ref34231205` for more details about error messages could be occurred. #. Close button .. _Ref34231205: .. _Ref29913865: .. list-table:: Error messaged of add roster item :widths: 1435 6030 * - Error code - Error message * - 2033 - A roster item already existed on {date} with {shift name} shift and {user group name} user group. .. _Ref37615828: .. _tooltip_control_panel_add_roster_items_additional_staff_title: Add additional staff +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_add_roster_items_additional_staff_desc: Additional staff view allows to add multiple user/user group for a roster item. .. figure:: Images/Control_panel/image293.PNG :width: 471 :figclass: align-center Add additional staff view #. Date #. Shift #. Select user/user group #. Assign button Assign button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exists. :numref:`Ref38111421` is showing error message could be appeared when add additional staffs. #. Close button .. _Ref38111421: .. list-table:: Error messages of add additional staff :widths: 1525 6210 * - Error code - Error message * - 2033 - A roster item already existed on {date} with {shift name} shift and {user group name} user group. .. _Ref46303647: .. _tooltip_control_panel_manage_leaves_and_holidays_title: Manage Leaves and holidays ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_manage_leaves_and_holidays_desc: Leaves and holiday management of NCheck Bio Attendance web control panel allows to manage all user leaves and holidays. The Leaves and holiday management view as follows. .. figure:: Images/Control_panel/image295.PNG :width: 585 :figclass: align-center Leaves and holidays management view #. :ref:`Add leave` #. :ref:`Add holiday` #. :ref:`Settings of leaves and holidays management` #. :ref:`Leaves table view` #. :ref:`Holiday table view` #. Table view of Leaves and holidays #. :ref:`Leave filters view` #. :ref:`Selected date view` #. :ref:`Summery view of the selected leave` #. :ref:`Calendar view` .. _Ref46225209: Add leave ------------------------------------------------ This allows to add new leave for the selected employee. .. figure:: Images/Control_panel/image297.PNG :width: 327 :figclass: align-center Add leave view #. Select user Select the username who need to apply the leave. #. Start date Start date of the leave. #. End date End date of the leave #. Leave type The default leave types are Casual, Medical and Annual. Administrator allows to add custom leave types as mentioned in :ref:`Configure leave type` section. #. Leave policy There are two available leave policies. #. Normal This is the default leave policy. No restriction will be applied for the leave. #. Restricted Once the leave is approved, user will not able to check-in or check-out while on leave. #. Request reason The reason for the leaves. #. Approve reason The reason for leave approval. #. Add button Add leave #. Cancel button Cancel the leave dialogue. .. _Ref46219643: Edit leave ------------------------------------------------- Edit leave is required in following cases. #. Edit leave details such as leave approved duration, leave type etc. #. Once a user submits a leave request, the approval status must be changed as approved or rejected. When user submit a leave request administrator will be get notified as below. .. figure:: Images/Control_panel/image299.PNG :width: 280 :figclass: align-center User leave request notification Requested leaves can be edited as follows. .. figure:: Images/Control_panel/image301.PNG :width: 413 :figclass: align-center Edit leave view #. Name Name of the user. This field is not editable #. Requested The leave requested period by user. #. Approved Approval period of the user leaves by the administrator. When administrator select update button only this period will be approved. #. Leave type The default leave types are Casual, Medical and Annual. Administrator allows to add custom leave types as mentioned in :ref:`Configure leave type` section. #. Leave policy There are two available leave policies. #. Normal This is the default leave policy. No restriction will be applied for the leave. #. Restricted Once the leave is approved, user will not able to check-in or check-out while on leave. #. Requested reason The reason for the leave #. Approve/reject reason Leave approval or rejection reason by the administrator. #. Approval status Leave approval reason as follows. #. Requested Once the user requested a leave, the approval status will be shown as requested. #. Approved To approve the leaves requested by users, set the approval status as approved. Once the leaves are approved, the user will be get notified. #. Rejected To reject the leaves requested by users, set the approval status as rejected. Once the leaves are rejected, the user will be get notified. #. Update button Update the changes. #. Cancel button Cancel the edit dialogue. .. _Ref46221215: Approve leave ---------------------------------------------------- The requested leaves by the user can be approved or rejected by the administrator as shown in below. .. figure:: Images/Control_panel/image303.PNG :width: 475 :figclass: align-center Approve leave view #. Name The name of the user #. Leave days The period leaves applied #. Leave type Leave type as Casual, Medical, Annual or custom leaves as mentioned in :ref:`Configure leave type` section. #. Policy The policy as #. Normal #. Restricted User are not allowed to check-in or check-out while on leave. #. Reason The reason for the leave. #. Approve/reject comment Comment for leave approval or rejection #. Calendar The calendar view shows periods the leaves are requested. #. Accept button Approved the leaves. #. Decline button Reject the leaves #. Edit leave Edit requested leave as mentioned in :ref:`Edit leave` section. #. Cancel button Cancel the approve leave dialogue. .. _Ref46231466: Add holiday -------------------------------------------------- This allows to add a holiday for the selected date as below. #. Normal holiday type #. Recurring holiday type Normal holiday type ++++++++++++++++++++++++++++++++++++++ The normal holiday type as follows. .. figure:: Images/Control_panel/image305.PNG :width: 310 :figclass: align-center Add normal holiday view #. Holiday type Holiday type as Normal #. Date Holiday date #. Description #. Add button Add holiday #. Cancel button Cancel add holiday dialogue Recurring holiday type +++++++++++++++++++++++++++++++++++++++++ The recurring holiday can be added as follows. .. figure:: Images/Control_panel/image307.PNG :width: 391 :figclass: align-center Add recurring holiday view #. Holiday type Holiday type as recurring #. Recurring type Recurring type as #. Weekly Add the holiday for once every week #. Monthly Add the holiday for once every month #. Yearly Add the holiday for once a specified month in every year. A field will be appeared to select the specified month. #. Day Select the date to apply the holiday #. Start The start date of the recurring holiday. Select start from option and specify the start date if required. #. End The end date of the recurring holiday. Select ends on option and specify the end date if required. #. Description #. Add button Add the recurring holiday. #. Cancel button Cancel the add holiday dialogue. .. _Ref46223171: Leaves table view -------------------------------------------------------- Leaves table shows all user leaves for the selected leave in calendar view. .. figure:: Images/Control_panel/image309.PNG :width: 668 :figclass: align-center Leaves table view #. Name #. Start date Leave start date #. End date Leave end date #. No of day No of days leave applied #. Leave type Leave type as Casual, Medical, Annual or custom leave type as mentioned in :ref:`Configure leave type` section. #. Leave policy Leave policy as #. Normal #. Restricted Users are not allowed to check-in or check-out while on leave. #. Approval status Approval status as Requested, Approved or Rejected. #. Operation #. Edit leave Approved or rejected leaves can be edit as mentioned in :ref:`Edit leave` section. The requested leave can be approved as mentioned in :ref:`Approve leave` section. #. Delete leave Delete the leaves #. :ref:`Table options` .. _Ref46223184: Holiday table view --------------------------------------------------------- Holiday table view shows holidays for selected date in :ref:`Calendar view` . .. figure:: Images/Control_panel/image311.PNG :width: 337 :figclass: align-center Holiday table view #. Date Date of the holiday #. Description #. Operation Delete the holiday #. :ref:`Table options` .. _Ref46225302: Leave filters view --------------------------------------------------------- This view allows to filter all leaves for selected date in the calendar view as follows. .. figure:: Images/Control_panel/image313.PNG :width: 316 :figclass: align-center Filter view of leaves #. Select user Display all leaves for the selected user group #. Select user Display all leaves for the selected user #. Show rejected leaves Check this option to display the rejected leaves of users. .. _Ref46225323: Selected date view --------------------------------------------------------- The details of the date are shown as selected leave from the :ref:`Leaves table view` or holiday from the :ref:`Holiday table view` . .. figure:: Images/Control_panel/image315.PNG :width: 318 :figclass: align-center Selected date view #. Date The date of the selected date from the :ref:`Calendar view` or date of the selected leave from the :ref:`Leaves table view` or date of the selected holiday form the :ref:`Holiday table view` . #. Day #. Select today button Select the current date form the :ref:`Calendar view` #. Holiday name This will appears if a holiday selected from the :ref:`Holiday table view` . .. _Ref46225345: Summery view of the selected leave ------------------------------------------------------------------------- This view is showing the leave summery of the selected leave from the :ref:`Leaves table view` as follows. .. figure:: Images/Control_panel/image317.PNG :width: 329 :figclass: align-center Summery view of the selected leave #. Username #. Leave period Start and end date of the leave with number of days #. Approval status of the leave Approval status as Requested, Approved or Rejected. #. Edit button Approved or rejected leaves can be edit as mentioned in :ref:`Edit leave` section. The requested leave can be approved as mentioned in :ref:`Approve leave` section. .. _Ref46225364: Calendar view ---------------------------------------------------- Calendar view allow user to select the specific date from the selected month and it also represents details of the leaves and holidays across the selected month as showing below. .. figure:: Images/Control_panel/image319.PNG :width: 254 :figclass: align-center Calendar view of the Leaves and holiday mangement #. Button to navigate to previous month #. Button to navigate the next month #. Selected month #. Selected date #. Number of leaves of the day #. Current date #. Holiday .. _Ref46231496: Settings of leaves and holidays management --------------------------------------------------------------------------------- #. :ref:`Configure leave type` #. :ref:`Import data` #. :ref:`Export data` .. _Ref46231525: Configure leave type +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Instead of the default leave types (casual, medical, and annual), Administrator allows to add custom leave types as follows. .. figure:: Images/Control_panel/image321.PNG :width: 652 :figclass: align-center Leave type view #. :ref:`Leave type table` #. Show deleted leave type Check this option to show deleted leave types #. Delete button Delete selected leave type form the table. #. :ref:`Add/edit leave type` #. New leave type button Add new leave type. Refer :ref:`Add/edit leave type` section for more details. #. Close button Close leave type dialogue .. _Ref46230438: Add/edit leave type """""""""""""""""""""""""""""""""""""""""""""""" Add a new leave type or edit existing leave types follows. .. figure:: Images/Control_panel/image323.PNG :width: 391 :figclass: align-center Add leave type dialogue view #. Type name Name of the leave type. This is not editable when editing the leave type. #. Type description #. Entitlement Number of leaves available for users. #. Add button Add leave. #. Close button Close Add leave type dialogue. .. _Ref46230425: Leave type table """"""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/Control_panel/image325.PNG :width: 668 :figclass: align-center Leave type table view #. Leave type #. Description #. Entitlement Number of available leaves for the leave type #. Created at Created date of the leave type #. Modified at Modified fate of the leave type #. Deleted Deleted date of the leave type if deleted. .. _Ref46231635: Import data ++++++++++++++++++++++++++++++++++++++++++++++++++ This option allows to import leaves and holidays as mentioned in :ref:`Import and Export information` section. Tio import data, .. figure:: Images/Control_panel/image327.PNG :width: 323 :figclass: align-center Import leaves and holiday data view #. Select information to be imported from the list #. :ref:`Leaves information` #. :ref:`Holidays information` #. Select Start Import button to select the import location. Refer :ref:`Select import location` section for more details. .. _Ref46231647: Export data ++++++++++++++++++++++++++++++++++++++++++++++++++ This option allows export all leaves and holidays as password protected zip file as follows .. figure:: Images/Control_panel/image329.PNG :width: 352 :figclass: align-center Export leaves and holidays data view #. Select information to be imported from the list #. :ref:`Leaves information` #. :ref:`Holidays information` #. Select Start export button to select the export location. Refer :ref:`Select export location` for more details .. _Ref38783246: .. _tooltip_control_panel_manage_devices _title: Manage devices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_manage_devices _desc: Device management page allows managing all NCheck Bio Attendance client devices and API registered with the NCheck Bio Attendance NCheck Bio Attendance server. .. figure:: Images/Control_panel/image331.PNG :width: 644 :figclass: align-center Device management view of web control panel #. :ref:`Devices/APIs list view` #. :ref:`Devices/APIs details view` #. Search device by name #. Generate API access Refer :ref:`Generate API access credentials` section ofr more details .. _Ref32586976: .. _Ref30079119: Devices/APIs list view ------------------------------------------------------------------------------- .. figure:: Images/Control_panel/image333.PNG :width: 517 :figclass: align-center Devices/APIs table view #. :ref:`Table header` #. Selected device/API Details of the selected device/API are shown in :ref:`Devices/APIs details view` . #. :ref:`Table paging options` .. _Ref33777511: Devices/APIs details view ---------------------------------------------------------------- This view represents the selected device/API details. .. figure:: Images/Control_panel/image335.PNG :width: 331 :figclass: align-center Device/API details view #. :ref:`Device/API quick view` #. :ref:`Peripherals view` .. _Ref38111510: .. _tooltip_control_panel_device_quick_view_title: Device/API quick view ---------------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_device_quick_view_desc: This view shows available details and operations for the selected device/API. .. figure:: Images/Control_panel/image337.PNG :width: 486 :figclass: align-center device quick view .. figure:: Images/Control_panel/image339.PNG :width: 293 :figclass: align-center API quick view #. Selected device/API description #. Device/API block/unblock state #. Last seen Last seen date of the client application #. Logo of the OS #. Operating system Operating system of the device, client application has installed. #. Edit button Refer :ref:`Edit device` section for more details. #. Re-register button Re-register device for user/user group. Refer :ref:`Re-register device` section for more details. #. Block/unblock button Refer :ref:`Block/unblock device/API` section for more details. #. Unregister device Refer :ref:`Unregister device` section for more details. #. Device settings button Refer :ref:`Device settings` section for more details. #. Edit button Refer :ref:`Edit API` section for more details #. API access permission #. Read-only Read-only permissions to execute the GET APIs #. Read-Write Read-writer permission to execute all available APIs #. Username for API access credential #. Change the password of API access credentials #. Link to open NCheck Bio Attendance API documentation. #. OS version version of the operating system #. Device configuration The device configuration as mentioned in section .. _Ref30068336: .. _tooltip_control_panel_device_settings_edit_device_title: Edit device ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_device_settings_edit_device_desc: This view allows the edit the device details. .. figure:: Images/Control_panel/image341.PNG :width: 368 :figclass: align-center Device management edit device view #. Device code #. Device code #. Device description #. Device configuration Refer :ref:`Device configuration` section for more details #. Save button Save button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exists. #. Cancel button .. _Ref65593718: Device configuration """"""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/Control_panel/image343.PNG :width: 414 :figclass: align-center Device configuration view Device configuration view as follows. #. :ref:`Authentication mode` #. :ref:`Verification order` #. :ref:`External executables` #. Events Event type as check-in, check-out, and any events. #. Reset configuration .. _Ref65575918: .. _tooltip_control_panel_device_authentication_mode_title: Authentication mode """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_device_authentication_mode_desc: Authentication mode can be applied to authenticate user to identify or verify user. Available authentication modes are, #. Identification The identification is the default authentication mode. Identification is performed on biometric and user id data as mentioned below. #. Biometric data User biometric data such as face, fingerprint and iris are comparing against the database with previously collected biometric samples depending on the :ref:`Recognition threshold` . If the matching score is greater than the :ref:`Recognition threshold` value, user is considered as identified. Therefore, this mode may demand large processing time. #. User id data User id data such as user id, barcode and QR code are comparing against the database and giving the matching users. #. Verification The verification mode can be applied with a user id peripheral and a biometric peripheral to verify the user against the previously collected biometric sample. To get verified, matching score should be greater than :ref:`Verification threshold` . .. figure:: Images/Control_panel/image345.PNG :width: 214 :figclass: align-center Device management verification mode combination #. None Attendances are not recording when the authentication mode is none. .. _Ref65576269: .. _tooltip_control_panel_device_verification_order_title: Verification order """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_device_verification_order_desc: As mentioned in :ref:`Authentication mode` section, if the verification mode is selected, the verification order can be set as either the “id first” to enter the user id(employee code, barcode, RFID) first or the “Biometric first” to capture the biometric first. .. _Ref65576276: .. _tooltip_control_panel_device_external_executables_title: External executables """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_device_external_executables_desc: System can be configured to run external programs (either from external executable or API) during user identification. For an example, an automatic door opening program can be executed upon successful user identification. This view allows to add new external executable or edit existing external executable. .. figure:: Images/Control_panel/image347.PNG :width: 412 :figclass: align-center Device management add/edit external executable #. Add new external executable #. Name Unique name for the external executable. #. Executable path API URL or absolute path for the external executable #. Trigger on Trigger the external executable on, #. Check-ins #. Check-outs #. Any events #. Unidentified events #. Parameters Following parameters with values can be passed to the URL or executable. #. Event (EVENT) Event type as CHECKIN, CHECKOUT or UNIDENTIFIED. #. Sequence id (SEQUENCE_ID) Id of the event. #. Time stamp (TIMESTAMP) Date and time of the event. #. User reference (USER_REF) Employee code of the user. #. Username (USER_NAME) First name and last name of the user event recorded. #. Shift code (SHIFT_CODE) Shift code of the NCheck Bio Attendance Standard clients. In the standalone mode shift code is DEFAULT. #. Location (LOCATION) Longitude and latitude of the event geo location. example: {Longitude, latitude} #. User status (USER STATUS) User is blocked or not. Pass 0 if the user has blocked otherwise 1. #. Address (ADDRESS) Address of the user. #. Peripheral code (PERIPHERAL_CODE) Unique identified number of the peripheral. #. Remove button Remove external executable. .. _Ref30068318: .. _tooltip_control_panel_device_settings_edit_api_title: Edit API ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_device_settings_edit_api_desc: This view allows to edit the API details. .. figure:: Images/Control_panel/image349.PNG :width: 502 :figclass: align-center Device management edit API view #. API code #. Description #. Password #. API access permission #. Save button Save button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exists. #. Close button .. _Ref30068329: .. _tooltip_control_panel_device_settings_reregister_device_title: Re-register device +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_device_settings_reregister_device_desc: This view allows to re-register the selected device. .. figure:: Images/Control_panel/image351.PNG :width: 416 :figclass: align-center Device management re-register device view #. Device code Employee/username or group name #. Generate button To generate registration code. Generate button will be disabled if the employee/group code has not selected. #. Registration code and QR code Use this code to register the NCheck Bio Attendance client device. #. Close button .. _Ref34299852: .. _Ref30069029: .. _Ref33777476: Block/unblock device/API +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Block/unblock selected device/API from the list. If the device/API has blocked #. User could not be able to enroll biometrics or record attendances from the blocked devices. #. User could not be able use APIs .. _Ref34299881: Unregister device ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Unregister the selected device/API from the list. Unregister devices should reregister to record attendances. .. _Ref37694096: .. _tooltip_control_panel_device_management_sevice_api_settings_title: Device settings ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_device_management_sevice_api_settings_desc: This view allows to add client or biometric settings to the selected device from the device lit. #. :ref:`Client settings` #. :ref:`Biometric settings` .. _Ref33697778: Client settings """""""""""""""""""""""""""""""""""""""""""" Client settings can be applied for the Lite/Standard client as below .. list-table:: Client settings for selected device :widths: 4500 2340 2001 * - Client setting - Lite client - Standard client * - :ref:`Result dialogue timeout` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Enable licensing` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Show work time on clients` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Allow automatic peripheral enabling of new clients` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Offline operation mode` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Manual capture start` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Automatically synchronize offline data` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Offline data synchronize interval` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Reset offline client password` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Allow predefined location` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Self-enroll templates` - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Hat detection feature` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Hat detection threshold` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Use in-built biometric verification on personal clients` - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Mask detection` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Mask detection threshold` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center .. _Ref33697786: .. _Ref30079146: Biometric settings """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Biometric settings for the selected device. .. list-table:: Biometric settings for Lite/Standard client :widths: 4500 2340 2001 * - Client setting - Lite client - Standard client * - :ref:`Face liveness mode` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Face liveness threshold` - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center * - :ref:`Allow without biometrics` - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center * - :ref:`Manual face selection` - .. figure:: Images/Control_panel/image55.PNG :width: 17 :figclass: align-center - .. figure:: Images/Control_panel/image54.PNG :width: 14 :figclass: align-center .. _Ref38111562: .. _tooltip_control_panel_device_peripherals_title: Peripherals view ------------------------------------------------------------------------------------------------------------ .. _tooltip_control_panel_device_peripherals_desc: Peripheral view shows all available peripheral of the selected device. .. figure:: Images/Control_panel/image353.PNG :width: 480 :figclass: align-center Device management manage peripheral view #. :ref:`Peripheral table` #. :ref:`Peripheral quick view` #. Edit button To Edit selected peripheral. Read :ref:`Edit peripheral` section for more details. #. Disable button Enable/disable selected peripheral. .. _Ref30072708: Peripheral table +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Peripheral table represents all detail of the available peripherals. .. figure:: Images/Control_panel/image355.PNG :width: 401 :figclass: align-center Peripheral table view #. :ref:`Table header` #. Name Peripheral name #. Type #. Face #. Fingerprint #. Iris #. User id #. Barcode #. RFID #. Status Enable/disable status of the peripheral. #. Connection status #. Connected When the peripheral is available with the device. #. Disconnected When the peripheral is not available with the device. #. :ref:`Table ` peripheral Selected peripheral details are shown in :ref:`Peripheral quick view` . .. _Ref30072720: Peripheral quick view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image357.PNG :width: 413 :figclass: align-center Peripheral quick view #. Peripheral name #. Peripheral configuration The peripheral configuration applied to the peripheral. .. _Ref30072736: .. _tooltip_control_panel_device_edit_peripheral_title: Edit peripheral +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_device_edit_peripheral_desc: Edit peripheral view allows to edit peripheral details. .. figure:: Images/Control_panel/image359.PNG :width: 448 :figclass: align-center Edit peripheral view #. Peripheral code #. Name. #. Save button Save button will be disabled if the mandatory fields are empty. #. Close button .. _Ref30059491: .. _tooltip_control_panel_device_settings_generate_api_access_title: Generate API access credinitals -------------------------------------------------------------------------------------------------------------------------------------------- NCheck Bio Attendance server has given the API access to access user, biometric, event data across given user group to use in third party applications. .. figure:: Images/Control_panel/image361.PNG :width: 431 :figclass: align-center .. figure:: Images/Control_panel/image361.PNG :width: 431 :figclass: align-center Device management API credentials view #. Selected user group The default is All user group #. Description #. API access Assign permission to use API #. Read only (Auditor) Assigned user group allows only to retrieve data from the API. #. Read-Writer (Admin) Assigned user group has permission to retrieve and alter data. #. Create button Create button will be enabled if the API description has added. After create API, user name and password which is required for API access will appear as shown in Figure 5127. For more details refer API Documentation section. .. figure:: Images/Control_panel/image363.PNG :width: 349 :figclass: align-center API access credentials view The error messages could be appeared when creating API are showing below. .. list-table:: Error messages of API credentials creation :widths: 1435 6030 * - Error code - Error message * - 2036 - Peripheral configuration name has already existed. .. _Ref38719008: .. _tooltip_control_panel_events_title: Manage Event logs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_events_desc: Event logs can administrator to add, edit, delete and review all event logs recorded. .. figure:: Images/Control_panel/image365.PNG :width: 717 :figclass: align-center Event log management view #. Refresh data #. Re-evaluate button Evaluate all the event logs to fix events with missing check-ins/check-outs. #. Add button Add new event log. Refer :ref:`Add event log` section for more details #. Add from unidentified button #. :ref:`Import/export event logs` #. :ref:`Event log detail view` .. _Ref30164395: Add event log ---------------------------------------------------- This view allows to add new event log. .. figure:: Images/Control_panel/image367.PNG :width: 390 :figclass: align-center Add event log view #. Username #. Status Check-in or Check-out #. Selected date #. Selected time #. Time zone #. Shift #. Shift date When an employee Check-in or Check-out not in the same date as the event date, (E.g. Working overtime or Shift spans for two days) shift date should be specified. Otherwise the event will belong to current day’s shift. #. Location The coordinates(Latitude and longitude)of the event location. #. Description #. Add event button Add event button will be disabled if the user of the event has not been selected. :numref:`Ref37347502` is showing the error messages could be appeared when add events. #. Close button .. _Ref37347502: .. list-table:: Error messages of add event logs :widths: 1525 6480 * - Error Code - Error message * - 2037 - Could not record events. The device has been blocked * - 2042 - Could not record events. The user has been blocked. * - 2043 - Could not record event. Check-in time has restricted. * - 2044 - Could not record event. Check-out time has restricted. Add from unidentified ---------------------------------------- The events failed to identify users are called unidentified events. This feature allows to add events from unidentified events. .. figure:: Images/Control_panel/image369.PNG :width: 551 :figclass: align-center Add event from unidentified event view #. Date filter #. Unidentified event list #. :ref:`Unidentified event quick view` #. Add button Add button will be disabled if no biometric image will be selected from the list. :ref:`Add event log` view will be shown to give details of user after select the add button. #. Close button .. _Ref32324312: Unidentified event quick view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Biometric thumbnail image with the event timestamp are showing as follows. .. figure:: Images/Control_panel/image371.PNG :width: 174 :figclass: align-center quick view of the unidentified event #. Modality thumbnail #. Delete unidentified event button #. Unidentified event details button Show :ref:`Unidentified event details view` #. Event date and time .. _Ref32324376: Unidentified event details view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The detail view of the unidentified events. .. figure:: Images/Control_panel/image373.PNG :width: 352 :figclass: align-center Unidentified event details view #. The date and time of the event #. Modality thumbnail #. Modality type #. Face #. Fingerprint #. iris #. Event date and time #. Close button .. _Ref32324260: Event log detail view ------------------------------------------------------------ #. :ref:`Event/map view` #. :ref:`Overtime view` #. :ref:`Event images view` .. _Ref38719091: .. _tooltip_control_panel_events_map_title: Event/map view -------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_events_map_desc: Event view show all user event for the selected date. .. figure:: Images/Control_panel/image375.PNG :width: 632 :figclass: align-center Events view .. figure:: Images/Control_panel/image377.PNG :width: 636 :figclass: align-center Map view #. :ref:`Event filters view` #. :ref:`Selected date view` #. :ref:`Selected event quick view` #. :ref:`Event calendar view` #. :ref:`Events table` #. :ref:`Map view` .. _Ref32324482: Event filters view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ All events can be filtered as follows, .. figure:: Images/Control_panel/image379.PNG :width: 374 :figclass: align-center Event filters view of event/map view #. Select shifts Filter events by shifts. Default shift is All shifts. #. Select user groups Filter events by user group. Default user group is All user group. #. Select user Filter events by selected user. #. Show only error events Filter check-ins without check-outs and check-outs without check-ins. #. Group events #. Event time: Events will be displayed according to the check-in/checkout time in the day. #. Shift time: Events will be displayed based on the shift start time and shift end time. .. _Ref30164423: Selected date view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image381.PNG :width: 357 :figclass: align-center Selected date view of event/map view #. Selected date #. :ref:`Day start time` #. Select today button Select this button to select the current date from the calendar view. .. _Ref32324501: .. _Ref30164446: Selected event quick view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image383.PNG :width: 375 :figclass: align-center Event log management selected event quick view #. Event type #. Username #. Event time #. Event location #. Edit button Refer :ref:`Edit event` section for more details. #. Delete button .. _Ref32324508: Event calendar view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Event calendar is representing following details. .. figure:: Images/Control_panel/image385.PNG :width: 354 :figclass: align-center Calendar view of event/map view #. Selected month #. No. of missing check-outs #. Events recorded with correct check-ins and check-outs sequence. #. No. of missing check-ins #. Current date #. Calendar month navigation buttons .. _Ref32324512: .. _Ref30164462: Events table ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image387.PNG :width: 643 :figclass: align-center Event table view #. :ref:`Table header` #. Name #. User ID #. Shift name #. Direction and status Event type as check-in or check-out #. Event time #. Event time zone #. Location Longitude and latitude coordinates of the event location. #. Address Address of the event location #. Selected event log To edit event, double click on event log row. Refer :ref:`Edit event` for more details. #. :ref:`Table paging options` .. _Ref32324627: .. _Ref32324698: Edit event +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image389.PNG :width: 573 :figclass: align-center Event log management edit event #. name #. Status #. Event date #. Event time #. Event time zone #. Shift #. Shift date #. Event location #. Show location button Show the event location on the google map. #. Description #. Authentication Authentication as face, fingerprint, iris, barcode, RFID, or user id #. Event record type #. Event recorded by admin Event added by admin #. Online recorded event Event recorded from NCheck Bio Attendance client application. #. Save changes button Following errors could be occurred when save changes of event logs. #. Close button .. list-table:: Error messages of edit device :widths: 1525 6480 * - Error Code - Error message * - 2037 - Could not record events. The device has been blocked * - 2042 - Could not record events. The user has been blocked. * - 2043 - Could not record event. Check-in time has restricted. * - 2044 - Could not record event. Check-out time has restricted. .. _Ref30164467: Map view +++++++++++++++++++++++++++++++++++++++++++++++ The event map is showing the location of user’s recent event for the selected date. All checkout events are shown in red color and check-in events are shown in green color. Selected event will be shown in yellow color. .. figure:: Images/Control_panel/image391.PNG :width: 437 :figclass: align-center Event log management Map view .. list-table:: :widths: 666 2209 * - .. figure:: Images/Control_panel/image393.PNG :width: 33 :figclass: align-center - Check-in events are showing in green color * - .. figure:: Images/Control_panel/image394.PNG :width: 33 :figclass: align-center - Checkout events are showing in red color * - .. figure:: Images/Control_panel/image395.PNG :width: 33 :figclass: align-center - Selected event is showing in yellow color The map view can be configured as follows #. The event log map can be configured using following map services #. :ref:`Google map` #. :ref:`Baidu map` #. After obtain a map key, go to Settings > Web and select map provide from :ref:`Event log location map provider` setting and set the obtained API key for :ref:`Map API key` setting. .. _Ref66715678: Google map """"""""""""""""""""""""""""""""""""""" To configure google maps obtain a google map API key as mentioned `here `_. If you can see “For development purposes only” water mark on the event log map once you have configured with Google map, you have to make sure that. #. Billing has not been enabled on your account. #. The provided billing method is invalid (for example an expired credit card). #. API access daily limit has been reached To remove the watermark, you need to log in to Google cloud services console (`https://console.cloud.google.com/project/_/billing/enable `_) and check the status of particular project created for Map API access. If the API key is correctly provided, you should see Google maps loaded properly. If it’s still showing some error on top as follows, you need to check whether the API key is correct. .. figure:: Images/Control_panel/image396.PNG :width: 577 :figclass: align-center Eventlog map view for invalid google map API key .. _Ref66715683: Baidu map """""""""""""""""""""""""""""""""""""" To configure Baidu map, obtain API key as follows, #. Create an account at `https://passport.baidu.com/v2/?login `_ #. Set up an developer account at `http://developer.baidu.com/user/reg `_. #. Go to `http://lbsyun.baidu.com/apiconsole/key `_ #. Click the “I agree button” #. Choose “Browser” as the application type .. _Ref32324420: Overtime view ---------------------------------------------------- .. figure:: Images/Control_panel/image398.PNG :width: 692 :figclass: align-center Overtime view #. :ref:`Overtime filter view` #. :ref:`User overtime quick view` #. :ref:`Overtime calendar view` #. :ref:`Overtime table` .. _Ref32324757: Overtime filter view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Overtime filter view shows following filters .. figure:: Images/Control_panel/image400.PNG :width: 367 :figclass: align-center Filter view of the Overtime view #. Select shifts Filter events by shifts. Default shift is All shifts. #. Select user groups Filter events by user group. Default user group is All user group. #. Select user Filter events by selected user. .. _Ref32324764: User overtime quick view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Overtime quick view shows following details. .. figure:: Images/Control_panel/image402.PNG :width: 391 :figclass: align-center User overtime quick view #. Username #. :ref:`Max overtime status` #. Overtime hours #. Edit button .. _Ref32324769: Overtime calendar view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Overtime calendar shows following information for each day. .. figure:: Images/Control_panel/image404.PNG :width: 324 :figclass: align-center Overtime calendar view #. Selected month #. Number of overtime entries submitted to approval or rejection #. Calendar month navigation .. _Ref32324776: Overtime table +++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image406.PNG :width: 668 :figclass: align-center Overtime table view #. Table header #. Username #. employee code #. First checked-in date and time #. Last checked-out date and time #. :ref:`Max overtime status` #. Number of overtime work hours user has worked #. Number of Max OT hours allowed for the shift #. Selected overtime Selected overtime details are shown in :ref:`User overtime quick view` #. :ref:`Table paging options` Edit overtime ++++++++++++++++++++++++++++++++ This view allows to edit overt time details. .. figure:: Images/Control_panel/image408.PNG :width: 318 :figclass: align-center Edit overtime view #. Username Username cannot be adapted. #. Check-in date Check-in date cannot be adapted. #. Overtime hours Number of overtime hours user has worked. This entry cannot be updated. #. Max OT Number of maximum overtime hours allocated for user. #. :ref:`Max overtime status` #. Shift Shift cannot be updated #. Save changes button Save changes button will be disabled if the :ref:`Validation errors` exists. :numref:`Ref37349791` shows all error messages. #. Cancel button .. _Ref37349791: .. list-table:: Error message of edit overtime :widths: 1345 6750 * - Error code - Error message * - 3010 - Could not record overtime. Overtime should not be greater than the max overtime hours. .. _Ref37619926: Max overtime status ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #. None Once user completed the events for the day, approval status will be none if the overtime hours exist. Administrator will mark the overtime as approved or rejected. #. Approved Accepted overtime by administrator. #. Rejected The rejected overtime by administrator. .. _Ref66719055: Event image view ------------------------------------------------------- Event image view is showing all event images for the selected date in :ref:`Event calendar view` . .. figure:: Images/Control_panel/image410.PNG :width: 591 :figclass: align-center Event image view #. Event image thumbnail Select the thumbnail to edit event as mentioned in :ref:`Edit event` section. #. Current page of available page #. Previous button to navigate previous page #. Next button to navigate next page .. _Ref37619862: Import/export event logs --------------------------------------------------------------- Import event logs ++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image412.PNG :width: 450 :figclass: align-center Import event logs view Import event logs information can be imported as mentioned in :ref:`Import and Export information` section. To import event logs, #. Select event logs #. Select Start import button Select Start import button to select event logs file. Refer :ref:`Select import location` for more details. Export event logs ++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image414.PNG :width: 445 :figclass: align-center Export event logs view Event log details can be exported as password protected zip file as below. #. Export event log information for selected date. #. Start export button #. Select start export button to select the event log export location. Refer :ref:`Select export location` for more details. .. _Ref31022864: .. _tooltip_control_panel_reports_title: Reports ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_reports_desc: Report page provides a set of standard reports on employee time attendance. Report view as follows, .. figure:: Images/Control_panel/image416.PNG :width: 588 :figclass: align-center Report view of Web control panel #. :ref:`Report types` #. :ref:`Report settings` #. Export menu Refer :ref:`Export report data` section for more details. #. Schedule menu Refer :ref:`Schedule reports` section for more details. #. :ref:`View schedules` #. :ref:`Report filters` #. Report area #. Reload page .. _Ref48731590: Report types --------------------------------------------------- The available reports are, #. :ref:`Total work hour report` #. :ref:`Work hour summary report` #. :ref:`Productivity report` #. :ref:`User detail report` #. :ref:`Event details` #. :ref:`Arrival and Departure report` .. _Ref30171190: Total work hour report +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The Total work hours report provides work hours details for a selected date range. That details can be calculated by daily, weekly, monthly basis. The important parameters are #. From Date range start #. To Date range end #. First name #. Last name #. Employee code #. :ref:`Productive work hours (HPS)` #. :ref:`Overtime hours` #. :ref:`First check-in` #. :ref:`Last check-out` #. :ref:`In-out hours` #. :ref:`Productive hours (HP)` #. :ref:`Shift work hours (HS)` #. :ref:`Work hours` .. _Ref30171201: Work hour summary report +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This report provides the details as follows for users/employees. #. Name #. Employee code #. :ref:`Work hours` #. :ref:`Overtime hours` #. Shift hours #. :ref:`Shift work hours (HS)` #. :ref:`Productive hours (HP)` #. :ref:`Productive work hours (HPS)` .. _Ref30171212: Productivity report ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Productivity report is generated for a selected time period with user/employee productivity parameters as follows. #. First name #. Last name #. Employee code #. From Date range start #. To Date range end #. :ref:`First check-in` #. :ref:`Last check-out` #. :ref:`Work hours` #. :ref:`Late arrival` #. :ref:`Late departure` #. :ref:`Early arrival` #. :ref:`Early departure` #. :ref:`Overtime hours` #. :ref:`Productive hours (HP)` #. :ref:`Unproductive hours` .. _Ref30171224: User detail report +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The user details report provides a list of user’s information. The available details are #. User code #. First name #. Last name #. Deleted Whether the user has deleted or not #. Active Whether the user is blocked or not #. Address #. City #. Email #. Country #. Zip/postal code #. State #. phone number .. _Ref30171234: Event details ++++++++++++++++++++++++++++++++++++++++++++++++++++ Event details represent all users/employees event details information as follows. #. Name #. ID #. Shift name #. Shift starts Start time of the shift. #. Direction and status Event type as check-in or check-out. #. Time Event time #. Time zone Time zone difference in hours with respective to UTC. #. Location Longitude and Latitude coordinates of the event location. .. _Ref30171295: Arrival and Departure report +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Arrival and departure report contain all arrival, departure, and absentee data. It also includes information about Roster items, Additional staff adding, Replacements, Holidays and Leaves for all employees. Using this report, you can track, • Shift details for the employee (Shift name, start and end time) #. Date #. First name #. Last name #. Employee code #. Availability Preset or absent #. Shift name #. Shift start #. Shift end #. First checked-in First checked-in time #. :ref:`Early arrival` #. :ref:`Late arrival` #. Last checked-out Last checked-out time #. :ref:`Early departure` #. :ref:`Late departure` #. :ref:`Event logs count` #. :ref:`Roster item count` #. Additional Additional staff #. :ref:`Replacements` #. :ref:`Number of holidays` #. :ref:`Number of Leaves` #. Leave policy Leave policy as normal or restricted. .. _Ref30171048: .. _Ref30171013: Report settings ------------------------------------------------------------------------ .. figure:: Images/Control_panel/image418.PNG :width: 636 :figclass: align-center Report settings #. Report calculation strategy Change the calculation based on Daily, Weekly and Monthly basis. #. Date range Date range can be changed daily, weekly, and monthly according to the report calculation strategy selected above. #. Show This setting allows to add following columns to the Workhour report #. :ref:`Work hours` #. :ref:`Overtime hours` #. Shift hours #. :ref:`Shift work hours (HS)` #. :ref:`Productive hours (HP)` #. :ref:`Productive work hours (HPS)` #. Show time Show report time wither in hours and reports or hours. .. _Ref32391257: Report filters ----------------------------------------------------- .. figure:: Images/Control_panel/image420.PNG :width: 655 :figclass: align-center Report filters view #. Shifts filter Filter report by shift. #. User groups filter Filter report by user group. #. Username filter Filter report by user. .. _Ref38710740: Export report data --------------------------------------------------------- .. _Ref30171038: Before export report, make sure to hide columns from the report view those are not needed in the exported report. This can be done using the table menu as mentioned in :ref:`Table menu` section. Report can be exported as follows #. :ref:`PDF format` #. :ref:`CSV format` .. _Ref48735117: PDF format +++++++++++++++++++++++++++++++++++++++++++++++++ Download the selected report in PDF format. When select PDF format, it will ask the font size of the pdf as follows. .. figure:: Images/Control_panel/image422.PNG :width: 285 :figclass: align-center Configure PDF font size in the report #. Report font size Set the font size of the PDF report between 9 and 15. #. Generate button Generate report #. Close button .. _Ref48735124: CSV format +++++++++++++++++++++++++++++++++++++++++++++++++ Download the selected report in CSV format. .. _Ref37620132: Schedule reports ------------------------------------------------------- .. note:: Schedule report feature is not available for work hour summery report. Schedule export option allows to #. Send reports in CSV format for the selected users daily weekly or monthly basis #. Backup CSV report in FTP daily, weekly, or monthly Schedule report configurations are showing below. .. figure:: Images/Control_panel/image424.PNG :width: 410 :figclass: align-center Schedule reports view #. Report configuration This view is showing the specific configurations applied from :ref:`Report settings` and :ref:`Report filters` to the selected report #. :ref:`Sending options` #. Send date Report sending date #. Send time from The time report must be sent #. Frequency #. Every day Send the report on every day at the schedule time #. Every week Send the report once a week in above scheduled date time #. Every month Send the report once per month based on the scheduled date and time Checking at advanced option allow to configure the period in days to send the report at once. #. Schedule end #. No end date Report will send continuously #. Have end date Specify the date to stop receiving the report #. Save changes button :numref:`Ref37355024` shows error messages after select save changes button. #. Close button .. _Ref37355024: .. list-table:: Error messages of schedule reports :widths: 1525 6030 * - Error code - Error message * - 1003 - Unable to connect with the FTP server {server name} * - 2045 - Could not email reports for the recipients. * - 2046 - Invalid FTP file path * - 2047 - Invalid FTP username or password .. _Ref34312411: Sending options ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Following sending option(s) can be selected #. :ref:`Email` #. :ref:`FTP configuration` #. :ref:`Local folder` .. _Ref48738855: Email """""""""""""""""""""""""""""""""" The report will be emailed to the selected recipients .. figure:: Images/Control_panel/image426.PNG :width: 402 :figclass: align-center Email configuration of the schedule report view #. Enter recipients’ email(s) separated by commas #. Find recipients from employee using the name #. Find recipients using the user group .. _Ref48738862: FTP configuration """""""""""""""""""""""""""""""""""""""""""""" The report will be saved in the FTP location. .. figure:: Images/Control_panel/image428.PNG :width: 403 :figclass: align-center FTP configuration of the schedule report view #. FTP URL #. Check this if the FTP access credentials is required #. FTP Username #. FTP password .. _Ref48738871: Local folder """"""""""""""""""""""""""""""""""""""""" The report will be downloaded into the given file path in the local file system. .. _Ref48739028: View schedules ----------------------------------------------------- This feature allows to view/edit all report schedules as follows. .. figure:: Images/Control_panel/image430.PNG :width: 499 :figclass: align-center View report schedules #. Report schedule table #. Edit button Edit report schedules as mentioned in :ref:`Schedule reports` section #. Delete selected report schedule #. Close button Report schedule ++++++++++++++++++++++++++++++++++ Report scheduled table is showing following information. #. Report type Type of the scheduled report #. Emails Email(s) of the recipients #. Users Username(s) of the recipients #. Groups Group names to send the reports for all users in the groups #. Sum by Report frequency daily, weekly, or monthly #. Next schedule date #. Next schedule time #. Ends on Report end date if specified #. Send time base #. FTP export #. Created time Created time of the report schedule .. _Ref38783312: .. _tooltip_control_panel_settings_title: Settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_settings_desc: NCheck Bio Attendance server control panel settings are #. :ref:`General settings view` #. :ref:`Client settings view` #. :ref:`Biometric settings view` #. :ref:`Web interface settings view` #. :ref:`Notifications` .. _Ref38044738: General settings view ------------------------------------------------------------ .. figure:: Images/Control_panel/image432.PNG :width: 668 :figclass: align-center General settings view of Settings #. :ref:`Default shift start time` #. :ref:`Default shift end time` #. :ref:`Day start time` #. :ref:`Week start date` #. :ref:`Month start date` #. :ref:`Date format` #. :ref:`Time format` #. :ref:`Default shift selection behavior` #. :ref:`Auto checkout at the end of the shift` #. :ref:`Notify check-in attempts on restricted leave` #. :ref:`Unidentified event log count to keep` #. :ref:`External resource URL` .. _Ref38044749: Client settings view ----------------------------------------------------------- .. figure:: Images/Control_panel/image434.PNG :width: 415 :figclass: align-center Client settings view of Settings #. :ref:`Result dialogue timeout` #. :ref:`Enable licensing` #. :ref:`Show work time on clients` #. :ref:`Offline operation mode` #. :ref:`Manual capture start` #. :ref:`Automatically synchronize offline data` #. :ref:`Offline data synchronize interval` #. :ref:`Allow automatic peripheral enabling of new clients` #. :ref:`Reset offline client password` #. :ref:`Duplicate event timeout` #. :ref:`Event log image size` #. :ref:`KIOSK mode operation (For Microsoft Windows clients)` #. :ref:`Allow predefined location` #. :ref:`Self-enroll templates` #. :ref:`Hat detection feature` #. :ref:`Hat detection threshold` #. :ref:`Use in-built biometric verification on personal clients` #. :ref:`Guard application support` #. :ref:`Hide user list on windows client` #. :ref:`Mask detection` #. :ref:`Mask detection threshold` .. _Ref38044763: Biometric settings view -------------------------------------------------------------- .. figure:: Images/Control_panel/image436.PNG :width: 462 :figclass: align-center Biometric settings view of settings #. :ref:`Allow without biometrics` #. :ref:`Manual face selection` #. :ref:`Face liveness mode for client application` s #. :ref:`Face liveness threshold for client application` #. :ref:`Server-side face liveness checking` #. :ref:`Server face liveness confidence threshold` #. :ref:`Recognition threshold` #. :ref:`Verification threshold` #. :ref:`Enrollment threshold` #. :ref:`Face confidence` #. :ref:`Face quality` #. :ref:`Detect faces with mask` #. :ref:`Fingerprint quality` #. Iris quality #. Enrollment .. figure:: Images/Control_panel/image438.PNG :width: 400 :figclass: align-center Enrollment thresholds #. :ref:`Face confidence for enrollment` #. :ref:`Face quality for Enrollment` #. :ref:`Finger quality for Enrollment` #. :ref:`Iris quality for Enrollment` #. :ref:`High-speed face detection` #. :ref:`Disable duplicate checking` .. _Ref65499755: Web interface settings view ------------------------------------------------------------------ .. figure:: Images/Control_panel/image440.PNG :width: 639 :figclass: align-center Web settings view of Settings #. :ref:`Dashboard refresh interval` #. :ref:`Show meridian in time` #. :ref:`Report export PDF font` #. :ref:`Event log location map provider` #. :ref:`Map API key` .. _Ref65499783: Notifications ---------------------------------------------------- .. figure:: Images/Control_panel/image442.PNG :width: 445 :figclass: align-center Notification settings view of settings #. :ref:`Email notification settings` #. :ref:`SMS notification settings` #. Save button Save email and SMS notification settings changes. .. _Ref48660004: .. _tooltip_server_control_panel_notification_settings_email_notification_title: Email notification settings ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_control_panel_notification_settings_email_notification_desc: Email server can be configured with NCheck Bio Attendance On-premises server to receive notifications such as change login details, share device registration token, schedule reports. The following settings need be added to enable emails. .. figure:: Images/Control_panel/image444.PNG :width: 412 :figclass: align-center Email notification settings #. Host name SMTP server to manage emails. #. Port SMTP Server port. The default port is 25. #. :ref:`Sender` #. SSL Enable SSL2 configuration to ensure the safety and security of the emails #. Authentication Enable disable authentication for email server #. Username The Username of the host server. This is also the sending email address for all email notifications. #. Password The password of the host server .. _Ref51678524: .. _tooltip_server_control_panel_notification_settings_email_notification_sender_title: Sender """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_notification_settings_email_notification_sender_desc: Sender should be configured in order to display the sender details of the receiving emails in the email client. There are two formats can be used for sender #. Name ex: Kathrine #. Email address Kathrine@abc.com < Kathrine@abc.com > .. _Ref48660014: .. _tooltip_server_control_panel_notification_settings_sms_notification_title: SMS notification settings ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_control_panel_notification_settings_sms_notification_desc: SMS notification settings allows to add SMS gateway to receive SMS notification send registration token, leave and holiday notifications. .. figure:: Images/Control_panel/image446.PNG :width: 541 :figclass: align-center SMS notification settings #. Host name Host name of the SMS gateway #. Username #. Password #. Port .. _Ref38783274: .. _tooltip_control_panel_admin_tasks_title: Admin Tasks ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_admin_tasks_desc: NCheck Bio Attendance admin tasks view as follows, .. figure:: Images/Control_panel/image448.PNG :width: 583 :figclass: align-center Bio Attendance admin tasks of Web control panel #. :ref:`Data backup and restore` #. :ref:`Re-extract template` #. :ref:`Delete old eventlogs` #. :ref:`Export data` #. :ref:`Import data` #. :ref:`Admin operation logs` .. _Ref30576502: Data backup and restore -------------------------------------------------------------- .. note:: This feature is not available for NCheck Bio Attendance Cloud server NCheck Bio Attendance server allows the administrator to backup/schedule backup all data in the specified location securely in JSON format. .. _Ref31893127: Backup information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The backup file must contain following details .. list-table:: Backup information :widths: 4315 4701 * - File name - details * - AuthentcationData.json - * - Customer.json - Organization details as given in :ref:`My Account` section * - CustomerLeaveTypes.Json - Leave types as configured in :ref:`Configure leave type` section. * - CustomerSettings.json - Customer settings as mentioned in :ref:`Settings` section * - Device.json - Device/API details as mentioned in :ref:`Devices/APIs details view` , * - FileData.json - * - Holiday.json - Holiday details as mentioned in :ref:`Manage Leaves and holidays` section. * - OAuth2User.json - * - Peripheral.json - All peripheral details of each device as mentioned in :ref:`Peripherals view` section * - PeripheralConfiguration.json - Peripheral configurations details * - Person.json - User details * - Roster.json - All roster details as mentioned in :ref:`Roster management view` section. * - RosterItem.json - All roster item details as mentioned in :ref:`Roster item management view` section. * - Task.json - All shift details as mention in :ref:`Shift management view` section. * - UserGroup.json - All user group details as mentioned in :ref:`Manage user Groups` section. * - UserGroupMembership.json - All users of user groups detail as mentioned in :ref:`Attached users` section. .. note:: It is strongly recommended to not alter backup files in order to restore data successfully. .. _tooltip_server_control_panel_admin_tasks_database_backup_title: Backup database +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_control_panel_admin_tasks_database_backup_desc: This view allows to backup NCheck Bio Attendance database. .. figure:: Images/Control_panel/image450.PNG :width: 370 :figclass: align-center Database backup view #. Start backup button Refer :ref:`Backup configuration` section for more details. #. Schedule backup button Refer :ref:`Schedule backup` section for more details. #. View schedules Refer :ref:`View schedules` section for more details. #. Show previous backup .. _Ref30427367: .. _Ref32821186: Backup configuration +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Database can be backed up in different locations as follows, #. Save backup in local folder #. Save backup in FTP location .. figure:: Images/Control_panel/image452.PNG :width: 583 :figclass: align-center Backup database view #. Save backup either in FTP or local folder. Refer #. :ref:`Local folder configuration` #. :ref:`FTP folder configuration` #. File password The Password must have at least 6 characters with one digit. #. Confirm password #. Backup event logs Check this option to backup all event logs #. Backup event logs from If the Backup event log option is checked, select the date from which date event logs must be included. #. Execute button to start Execute button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exist. :numref:`Ref37396931` Following errors could be occurred. #. Close button .. _Ref37396931: .. list-table:: Error messages of backup database :widths: 1525 6030 * - Error code - Error message * - 1003 - Unable to connect with the FTP server {server name} * - 3003 - Password does not match. * - 3004 - Password must contain at least 6 characters with one number. * - 2045 - Could not email reports for the recipients. * - 2046 - Invalid FTP file path * - 2047 - Invalid FTP username or password * - 4001 - Unidentified error occurred during data restore. Please contact administrator or NCheck Bio Attendance support for more details. .. _Ref30427372: .. _tooltip_server_control_panel_admin_tasks_schedule_backup_title: Schedule backup +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_control_panel_admin_tasks_schedule_backup_desc: This feature can be used to automate database backup as daily, weekly, and monthly in following locations. #. Schedule backup in local folder #. Schedule backup in FTP location #. Schedule backup in local folder #. Schedule backup in FTP location .. figure:: Images/Control_panel/image454.PNG :width: 638 :figclass: align-center Schedule backup in local folder view #. Saving backup in either local or FTP folder. Refer #. :ref:`Local folder configuration` #. :ref:`FTP folder configuration` #. File password Password must have at least 6 characters with one digit. #. Confirm password #. Backup event log Check this option to backup all event logs #. Backup event log from If the Backup event log option is checked, select the date from which date event logs must be included. #. Schdule date #. Backup frequency Backup fequency as daily, weekly or monthly. #. Schdule backup button Execute button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exist. :numref:`Ref37397174` is showing the errors could be occurred. #. Close button .. _Ref37397174: .. list-table:: Error messages of schedule database backup :widths: 1525 6030 * - Error code - Error message * - 1003 - Unable to connect with the FTP server {server name} * - 3003 - Password does not match. * - 3004 - Password must contain at least 6 characters with one number. * - 2045 - Could not email reports for the recipients. * - 2046 - Invalid FTP file path * - 2047 - Invalid FTP username or password .. _Ref37620429: View schdules ++++++++++++++++++++++++++++++++++++++++++++++++++++ This view shows the existing email schedules and operations as follows. .. figure:: Images/Control_panel/image456.PNG :width: 480 :figclass: align-center View schedules view #. Date Schdule date #. Frequency #. Directory Local or FTP directory path #. Remove button Remove schduled backup #. Close button .. _Ref32398341: Local folder configuration +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image458.PNG :width: 489 :figclass: align-center Local folder configuration view #. File path File path to the local folder .. _Ref32398352: FTP folder configuration +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Following details are required to enable FTP configuration. .. figure:: Images/Control_panel/image460.PNG :width: 513 :figclass: align-center FTP details view of the schedule report view #. FTP host address #. File path in the file system #. Check this if the FTP access credentials is required #. FTP Username #. FTP password Restore server databases +++++++++++++++++++++++++++++++++++++++++++ Refer :ref:`Restore database` section for more details. .. _Ref30576530: .. _tooltip_server_control_panel_admin_tasks_reextrqct_templated_title: Re-extract template ----------------------------------------------------------------------------------------------------------------------------------- .. note:: This feature is not available for NCheck Bio Attendance Cloud server Re-extract users biometric templates from biometric engine and re-enroll to improve recognition accuracy. .. figure:: Images/Control_panel/image462.PNG :width: 490 :figclass: align-center R-extract templates view #. Re-enroll button Refer :ref:`Re-enroll templates` section for more details. #. Show previos extraction jobs .. _Ref32399845: Re-enroll templates ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Re-enorll template is a long running task depending on the number of biometric templates templates to re-enroll. But your are allowed to work as it runs on the backround. You will be asked a confirmation dialog before proceed as shown in the Figure. .. figure:: Images/Control_panel/image464.PNG :width: 426 :figclass: align-center Re-extract template confirmation window .. list-table:: Error messages for enroll templates :widths: 1334 6221 * - Error code - Error message * - 2002 - License cannot be obtained * - 2048 - Biometric re-extraction has failed on following images. #. {images list} .. _Ref48751469: Delete old eventlogs ----------------------------------------------------------- NCheck Bio Attendance Server keeps daily eventlogs of each user in the database and its causes to increase the database size with the time. Delete event logs feature can be used to manage unwanted eventlogs details in the database as follows. .. figure:: Images/Control_panel/image466.PNG :width: 439 :figclass: align-center Delete old eventlogs view #. Months to keep Number of months to keep eventlogs in the database #. Delete Delete image log either with image or delete the eventlog image. #. Delete button .. _Ref38043614: Import data -------------------------------------------------- Following information can be imported as a zip with the file hircahy as mentioned in :ref:`Import and Export information` section. .. figure:: Images/Control_panel/image468.PNG :width: 456 :figclass: align-center Admin tasks import data view #. :ref:`User group information` #. :ref:`User/user group location restrictions information` #. :ref:`User biometrics and template files` #. :ref:`User group information` #. :ref:`User group memberships information` #. :ref:`User/user group location restrictions information` #. :ref:`Shifts information` #. :ref:`Roster items information` #. :ref:`Leaves information` #. :ref:`Holidays information` #. :ref:`Event logs information` To import, #. Select information need to import #. Select Start import button to select import location as mentioned in :ref:`Select import location` section. .. _Ref38043918: Export data -------------------------------------------------- You are allowed to export following information as password protected zip file. #. :ref:`User group information` #. :ref:`User/user group location restrictions information` #. :ref:`User group information` #. :ref:`User group memberships information` #. :ref:`User/user group location restrictions information` #. :ref:`Shifts information` #. :ref:`Roster items information` #. :ref:`Leaves information` #. :ref:`Holidays information` #. :ref:`Event logs information` Select the date to export event log form the date To export, #. Select information need to export #. Select the Start export button to select export location as mentioned in :ref:`Select export location` section .. _Ref30576640: .. _tooltip_server_control_panel_admin_tasks_admin_operation_title: Admin operation logs -------------------------------------------------------------------------------------------------------------------------------- .. _tooltip_server_control_panel_admin_tasks_admin_operation_desc: Administrator operation logs in the NCheck Bio Attendance On-premises server control panel such as login, logout, add event logs, modify event logs, delete event logs, add person, modify person, delete person can be seen from this feature. .. figure:: Images/Control_panel/image470.PNG :width: 441 :figclass: align-center Admin tasks admin operations logs #. View logs button Refer :ref:`View logs` section for more details. .. _Ref32399807: View logs +++++++++++++++++++++++++++++++++++++++++++++++++ #. Filters Select date range. #. :ref:`Admin logs table` #. Admin log quick view .. figure:: Images/Control_panel/image472.PNG :width: 487 :figclass: align-center Admin logs view logs view .. _Ref30576069: Admin logs table +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Admin logs table presents all available admin logs as follows. .. figure:: Images/Control_panel/image474.PNG :width: 503 :figclass: align-center Admin logs admin logs table view #. :ref:`Table header` #. Owner The role name who performed the admin operations. #. Username Name of the administrator. #. Action #. Login #. Logout #. Add event log #. Modify event log #. Delete event log #. Add user #. Edit user #. Delete user #. Date and time #. Selected admin log Selected admin log detail are shown in admin log quick view. #. :ref:`Table paging options` .. _Ref38783345: .. _tooltip_control_panel_subscription_title: Subscription ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. note:: Subscription is not available on NCheck Bio Attendance On-premises server. .. figure:: Images/Control_panel/image476.PNG :width: 635 :figclass: align-center Cloud subscription view of web control panel #. :ref:`Plan statistics` #. :ref:`License statistics` #. :ref:`Outstanding summery` #. :ref:`Payments` .. _Ref30593433: Plan statistics ------------------------------------------------------ .. figure:: Images/Control_panel/image478.PNG :width: 588 :figclass: align-center Subscription plan statistics #. Plan code #. Plan started date #. Rate Price per month in euros #. User limit Maximum number of user limits of the plan. #. Credit period Extension period to make the payment once the plan has expired. The account will be blocked automatically exceed the credit period. #. Paid to The plan has been purchased for this date. #. Remaining usage Remaining usage of the plan for the existing balance. #. Due date Expiration date of the plan after exceeding the Remaining usage and credit period. #. Balance Balance for the current date. #. :ref:`5.18.1.1 Change plan` #. :ref:`5.18.1.2 Plan details history` .. _Ref30593570: 5.18.1.1 Change plan +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This view allows to change the NCheck Bio Attendance plan as follows. .. figure:: Images/Control_panel/image480.PNG :width: 470 :figclass: align-center Change plan window #. Cloud plan list Refer :ref:`Cloud plans` section for more details about cloud plans. The available plans are #. Free plan #. Plan 20 #. Plan 50 #. Plan 100 #. Plan 200 #. Plan statistics #. Proceed button Proceed button will be disabled with the errors are shown in :numref:`Ref34376655` . #. Close button .. _Ref34376655: .. _Ref30593585: .. list-table:: Error messages of change plan :widths: 1435 6300 * - Error code - Error messages * - 2049 - Your current subscription has blocked. Please settle the outstanding amount and try again. * - 2050 - Customer has blocked. Please contact NCheck Bio Attendance support. .. _Ref38089061: 5.18.1.2 Plan details history ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Plan history window shows following information. .. figure:: Images/Control_panel/image482.PNG :width: 441 :figclass: align-center Plan history window #. :ref:`Plan history` #. :ref:`License history` #. :ref:`Blocked history` .. _Ref30593687: Plan history +++++++++++++++++++++++++++++++++++++++++++++++++++ Plan history is showing all the plans used previously and the currently using plan. .. figure:: Images/Control_panel/image484.PNG :width: 515 :figclass: align-center Plan history view #. :ref:`Table header` #. Stated at #. Expired at #. Plan code #. Description #. Plan rate #. :ref:`Table paging options` .. _Ref30593693: License history ++++++++++++++++++++++++++++++++++++++++++++++++++++++ License history shows all licenses currently in used and used before with following information. .. figure:: Images/Control_panel/image486.PNG :width: 492 :figclass: align-center License history view #. :ref:`Table header` #. Created at #. Expired at #. Plan code #. Modified date #. :ref:`Table paging options` .. _Ref30593698: Blocked history ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Plan block history shows plan block information as follows. .. figure:: Images/Control_panel/image488.PNG :width: 531 :figclass: align-center Blocked history view #. :ref:`Table header` #. Blocked date #. Blocked reason #. Unblocked date #. Unblocked reason #. Plan name #. :ref:`Table paging options` .. _Ref30593454: License statistics --------------------------------------------------------- NCheck Bio Attendance Internet license(s) ca be purchased in order to use with NCheck Bio Attendance standard clients devices. Administrator allows to change Maximum number of licenses. The amount will be calculated to the maximum License count. .. figure:: Images/Control_panel/image490.PNG :width: 378 :figclass: align-center Subscription license statistics view #. Number of used license(s) and available license(s) #. License rate in Euros. #. Maximum number of licenses #. Percentage of the used licensees out of maximum number of licenses .. _Ref37620657: Outstanding summery ----------------------------------------------------------- Outstanding summary is a detail view of all available payments up to current date. .. figure:: Images/Control_panel/image492.PNG :width: 606 :figclass: align-center Outstanding summery of the Subscription #. Summery table #. View and pay bill button Refer :ref:`View and pay bill` section for more details #. Schedule payments button Refer :ref:`Schedule payments` section for more details Summery table ++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image494.PNG :width: 639 :figclass: align-center Outstanding Summery table #. Outstanding plan amount #. Outstanding license amount #. Licenses/plans NCheck Bio Attendance Cloud server plans and clients license names with rate. #. Start at Start date of the Licenses/plans. #. Expire at Expiring date of the Licenses/plans. #. Paid to Until which date administrator made the payment Duration between plan start date and expired date/current date. #. Total Total amount for the usage. .. _Ref37620799: View and pay bill ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Draft bill of the NCheck Bio Attendance cloud subscription can be generated using this view. .. figure:: Images/Control_panel/image496.PNG :width: 619 :figclass: align-center View and pay bill view #. Reference number of the bill #. Export to PDF #. Neurotechnology company logo and contact information #. Draft view of the bill #. Proceed button Once you select procced button you will be directed to the detailed receipt. Refer :ref:`Proceed for payments` section for more details. Before proceeding make sure that you have not pay the bill before. Because it will take time to update billings after completed the payments. #. Close button #. Delete button Delete the generated bill. Bill view ++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image498.PNG :width: 636 :figclass: align-center Draft view of the bill #. Bill generated date #. Customer name #. Customer email address #. VAT number #. Customer address #. Item description Plan/licenses name #. From The bill start date, total amount of the plan/license calculated from #. To The end date, total amount for the plan/license calculated to #. Plan rate #. Total #. Total plan usage #. Vat #. Total amount for plan/license usage in Eur .. _Ref30593874: Proceed for payments +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Once select the proceed button, user will be directed to the detailed bill shown as :numref:`Ref30586579` . Once select the Pay bill button, user will be asked a confirmation message as shown :numref:`Ref30586587` before proceed to the PayPal payment gateway. .. _Ref30586587: .. figure:: Images/Control_panel/image500.PNG :width: 278 :figclass: align-center Payment confirmation window .. _Ref30586579: .. figure:: Images/Control_panel/image502.PNG :width: 376 :figclass: align-center Detailed bill view .. _Ref30593797: Schedule payments ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ All the payments can be scheduled on selected date to pay cloud plan outstanding amount automatically using PayPal. .. _Ref34378350: .. figure:: Images/Control_panel/image504.PNG :width: 493 :figclass: align-center Confirm PayPal subscription window #. Current subscription details #. Plan rate #. User limit #. Number of licenses #. Current plan #. Calendar view to select schedule payments #. Selected date #. subscribe and schedule button After select subscribe and schedule button, user will be asked a confirmation messages as shown in :numref:`Ref34378350` . Select OK button to procced PayPal to subscribe the monthly payments. #. Close button .. figure:: Images/Control_panel/image506.PNG :width: 482 :figclass: align-center create PayPal subscription view .. note:: NCheck Bio Attendance will not save your PayPal username and password. Do not close the browser tab until you redirecting to NCheck Bio Attendance after payment completed in PayPal. .. _Ref30593509: Payments ----------------------------------------------- All pending, completed, failed payments are showing in this view. .. figure:: Images/Control_panel/image508.PNG :width: 533 :figclass: align-center Payments view #. :ref:`Payments table` #. :ref:`Payment quick view` .. _Ref30593928: Payments table +++++++++++++++++++++++++++++++++++++++++++++++++++++ Payment table presents all failed, pending and completed payment details as follows. .. figure:: Images/Control_panel/image510.PNG :width: 494 :figclass: align-center Payments table #. :ref:`Table header` #. Payment date #. Billed date #. Total amount #. Status #. Completed #. Failed #. Pending #. Selected payment Selected payment details are shown in :ref:`Payment quick view` . #. :ref:`Table paging options` .. _Ref30593934: Payment quick view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image512.PNG :width: 397 :figclass: align-center Payment incomplete view .. figure:: Images/Control_panel/image514.PNG :width: 396 :figclass: align-center Payment completed view #. Payment status #. Completed paid date is appeared #. Failed #. Pending #. Billed date Bill created date #. Received date Payment received date #. Total #. Plan usage #. Item Plan name #. From #. To #. Rate #. Total #. Total plan usage #. Show invoice button #. Detailed receipt button #. Delete button Delete pending payment #. Complete payment button User will be directed to the detailed receipt to proceed with the payment as mentioned in :ref:`Proceed for payments` section. Users Service portal ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NCheck Bio Attendance Cloud/On-premises server control panel for user allows reviewing user specific data for each user. Following operations are available for users #. :ref:`Manage user account` #. :ref:`User event logs` #. :ref:`Roster and schedules` #. :ref:`Leaves and holidays` #. :ref:`User reports` #. :ref:`User settings` .. _Ref37620844: Manage user account ---------------------------------------------------------- Select the user icon in the navigation bar. .. figure:: Images/Control_panel/image516.PNG :width: 295 :figclass: align-center User management view #. Username #. User profile image #. User email address #. Account type #. My account button Refer :ref:`Manage user details` section for more details #. :ref:`Login options` #. Sign out .. _Ref30599368: Manage user details ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image518.PNG :width: 531 :figclass: align-center Manage user details #. Browse button Select the user image #. First name #. Last name #. Employee code #. Email #. Username #. Address line 1 #. Address line 2 #. City #. Country #. State #. Zip code #. Telephone #. Update button Update button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exist. :numref:`Ref37401245` is showing error messages could be occurred on updating user details. #. Close button .. _Ref37401245: .. list-table:: Error messages of manage user details :widths: 1615 5940 * - Error code - Error message * - 3001 - Mobile/telephone number is not valid for the selected country/region. * - 3002 - Invalid email address. .. _Ref37620923: .. _tooltip_user_control_panel_event_logs_title: User event logs -------------------------------------------------------------------------------------------------------- .. _tooltip_user_control_panel_event_logs_desc: Event logs allow monitoring user attendances. User event log view as follow. .. figure:: Images/Control_panel/image520.PNG :width: 662 :figclass: align-center User event logs view of web control panel #. Refresh data button #. :ref:`Event logs filters` #. :ref:`Calendar date quick view` #. :ref:`Calendar view` #. :ref:`Event logs view` #. :ref:`Event log quick view` .. _Ref30601996: Event logs filters +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Filter user event logs as follows. .. figure:: Images/Control_panel/image522.PNG :width: 381 :figclass: align-center User event log filters view #. Select shifts Filter events by shifts. Default shift is All shifts. #. Show only error events Filter check-ins without check-outs and check-outs without check-ins. #. Group events #. Event time: Events will be displayed according to the check-in/checkout time in the day. #. Shift time: Events will be displayed based on the shift start time and shift end time. .. _Ref30602007: Calendar view ++++++++++++++++++++++++++++++++++++++++++++++++++++ Calendar view shows following details. .. figure:: Images/Control_panel/image524.PNG :width: 255 :figclass: align-center User calendar view #. Selected month #. No. of missing check-outs #. Events recorded with correct check-ins and check-outs sequence. #. Number. of missing check-ins #. Current date .. _Ref30602003: Calendar date quick view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image526.PNG :width: 379 :figclass: align-center Calendar date quick view #. Calendar selected date #. Select today button Select current date from the calendar .. _Ref30602018: Event logs view ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image528.PNG :width: 649 :figclass: align-center User event logs list view #. :ref:`Table header` #. Name #. User ID #. Shift name #. Direction and status Event type as check-in or check-out #. Event time #. Event time zone #. Location Longitude and latitude coordinates of the event location. #. Address Address of the event location #. Selected event log Selected event log detail are shown in :ref:`Event log quick view` #. :ref:`Table paging options` .. _Ref30602022: Event log quick view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Quick view of the event detail. .. figure:: Images/Control_panel/image530.PNG :width: 369 :figclass: align-center User event log quick view #. Event type #. Check-in #. Check-out #. Event location #. Event time #. Review button View event log details. Refer :ref:`Event log review` section for more details. .. _Ref30602176: Event log review +++++++++++++++++++++++++++++++++++++++++++++++++++++++ This view present user event log detail view as follows. .. figure:: Images/Control_panel/image532.PNG :width: 477 :figclass: align-center User review event window #. Event biometric view #. Username #. Shift name #. Status #. Check-in #. Check-out #. Event date #. Event time #. Event time zone #. Event location #. Description #. Authentication mode #. Face #. Iris #. Fingerprint #. Event recorded type as by admin or online #. Show location button #. Close button .. _Ref37620953: .. _tooltip_user_control_panel_roster_and_schedules_title: Roster and schedules ----------------------------------------------------------------------------------------------------------------------- .. _tooltip_user_control_panel_roster_and_schedules_desc: The users able to monitor below details in the rosters and schedules. .. figure:: Images/Control_panel/image534.PNG :width: 668 :figclass: align-center Shift and roster management view of user web control panel #. :ref:`Shifts view` #. :ref:`Rosters view` #. :ref:`Roster items view` .. _Ref30662264: Shifts view ++++++++++++++++++++++++++++++++++++++++++++++++++ Shift view shows available shifts for user. .. figure:: Images/Control_panel/image536.PNG :width: 384 :figclass: align-center user Shift view #. Shift name #. Shift start time #. Shift end time .. _Ref30662268: .. _tooltip_user_control_panel_rosters_title: Rosters view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_user_control_panel_rosters_desc: All available rosters are showing in this view as follows. .. figure:: Images/Control_panel/image538.PNG :width: 470 :figclass: align-center User rosters view #. Roster name #. Roster duration #. End date #. Status #. Holidays button Refer :ref:`View holidays` section for more details. #. Leaves button Refer :ref:`View leaves` section for more details. .. _Ref30662152: View holidays ++++++++++++++++++++++++++++++++++++++++++++++++++++ All holidays applicable for organization can be viewed here. .. figure:: Images/Control_panel/image540.PNG :width: 470 :figclass: align-center User holidays view #. :ref:`Yearly view` #. :ref:`Report view` #. Close button .. _Ref30662103: Yearly view """""""""""""""""""""""""""""""""""""""" Yearly view of holidays as follows. .. figure:: Images/Control_panel/image542.PNG :width: 483 :figclass: align-center User holidays yearly view #. Calendar view #. :ref:`Holiday table of user service portal` .. _Ref38090364: .. _Ref30662108: Holiday table of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Holiday table presents all holiday details as follows. .. figure:: Images/Control_panel/image544.PNG :width: 428 :figclass: align-center Holiday table view #. :ref:`Table header` #. Date of holidays #. Description #. :ref:`Table paging options` .. _Ref38092116: Report view """""""""""""""""""""""""""""""""""""""" Report view of the holidays as follows .. figure:: Images/Control_panel/image546.PNG :width: 503 :figclass: align-center User holiday report view #. Date filter #. :ref:`Holiday table of user service portal` .. _Ref30662173: View leaves ++++++++++++++++++++++++++++++++++++++++++++++++++ All leaves applied by the user can be seen here. .. figure:: Images/Control_panel/image548.PNG :width: 464 :figclass: align-center User leaves view #. :ref:`Calendar view of user service portal` #. :ref:`Report view of user service portal` #. Apply for a leave button Refer section for more details. #. Close button .. _Ref38111740: Calendar view of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Calendar view of the user leaves as follows. .. figure:: Images/Control_panel/image550.PNG :width: 473 :figclass: align-center User holidays calendar view #. Calendar #. No. Of leaves applied by the user #. :ref:`Leaves table of user service portal` .. _Ref38111810: Leaves table of user service portal """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Leave table presents all user leaves details in a table as follows. .. figure:: Images/Control_panel/image552.PNG :width: 401 :figclass: align-center Leaves table view #. :ref:`Table header` #. Username #. Leave start date #. Leave end date #. Leave type Refer :ref:`Configure leave type` section for more details #. :ref:`Table paging options` .. _Ref38111762: Report view of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Report view of leaves as follows. .. figure:: Images/Control_panel/image554.PNG :width: 442 :figclass: align-center User holidays report view #. Date filter #. :ref:`Leaves table of user service portal` Request leaves """"""""""""""""""""""" User can apply a leave request to get the approval from NCheck Bio Attendance administrator. .. figure:: Images/Control_panel/image556.PNG :width: 418 :figclass: align-center Request leaves view #. Leave start date #. Leave end date #. No. of days Number of leaves should be applied between start date and end date deprecating holidays. #. Leave type Leave type from the configured leave types as mentioned in  :ref:`Configure leave type` section. #. Send request button :numref:`Ref37404387` is showing error messages could be appeared. #. Close button .. _Ref37404387: .. list-table:: Error messages of request leaves :widths: 1435 6930 * - Error code - Error message * - 2031 - You already have applied the leave(s) for start date – end date. * - 2032 - Could not exceed the available number of leaves for {leave type name} leave type. .. _Ref30662277: Roster items view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image558.PNG :width: 668 :figclass: align-center User roster items view #. Current month #. Weeks view Filter roster items by shift #. Week view #. :ref:`Roster item view of user service portal` .. _Ref38092760: Roster item view of user service portal """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Roster item view is showing following details. .. figure:: Images/Control_panel/image560.PNG :width: 272 :figclass: align-center Roster item user view #. Shift details #. Shift start time #. Shift end time #. Shift name #. User group name .. _Ref46240970: Leaves and holidays ---------------------------------------------------------- This view allows to view user leaves, holidays and apply leaves. .. figure:: Images/Control_panel/image562.PNG :width: 630 :figclass: align-center Leaves and holiday management view of user service portal #. :ref:`Apply/edit leave` #. :ref:`Leave table view` #. :ref:`Holiday table view` #. :ref:`Selected date view` #. :ref:`Summery view of selected leave` #. :ref:`Calendar view` .. _Ref46303813: Apply/edit leave +++++++++++++++++++++++++++++++++++++++++++++++++++++++ User allow to apply for a leave as below. .. figure:: Images/Control_panel/image564.PNG :width: 369 :figclass: align-center Request a leave dialogue view #. Start date Leave start date #. End date End date of the leave #. Request reason #. Leave type Leave type as Casual, Medical, Annual or custom leave type defined by the administrator. #. Send request button Send the leave request for Approval. Once the leave is approved or rejected, user will be get notified as shown in #. Cancel button Cancel the Request a leave dialogue. .. figure:: Images/Control_panel/image566.PNG :width: 244 :figclass: align-center Leave approval notification .. _Ref46238972: Leave table view +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Leave table shows leaves applied by the user for the selected date in the :ref:`Calendar view` . .. figure:: Images/Control_panel/image568.PNG :width: 668 :figclass: align-center Leaves table view of user service portal #. Start date Leave start date #. End date Leave end date #. No of day No of days leave applied #. Leave type Leave type as Casual, Medical, Annual, or custom leave type created by the administrator. #. Approval status Approval status as Requested, Approved or Rejected. #. Operation #. Edit leave Refer :ref:`Apply/edit leave` section for more details. #. Delete leave Delete the leaves #. :ref:`Table options` .. _Ref46238980: Holiday table view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Holiday table show holidays available for the selected date in the :ref:`Calendar view` . .. figure:: Images/Control_panel/image570.PNG :width: 298 :figclass: align-center Holiday table view of user service portal #. Date #. Description #. :ref:`Table options` .. _Ref46240718: Selected date view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The details of the date are shown as selected leave from the :ref:`Leave table view` or holiday from the :ref:`Holiday table view` . .. figure:: Images/Control_panel/image315.PNG :width: 318 :figclass: align-center Selected date view #. Date The date of the selected date from the :ref:`Calendar view` or date of the selected leave from the :ref:`Leave table view` or date of the selected holiday form the :ref:`Holiday table view` . #. Day #. Select today button Select the current date form the :ref:`Calendar view` #. Holiday name This will appears if a holiday selected from the :ref:`Holiday table view` . .. _Ref46240738: Summery view of selected leave +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Selected holiday view shows the details of the selected leave from the :ref:`Leave table view` as follows. .. figure:: Images/Control_panel/image572.PNG :width: 304 :figclass: align-center Summery view of selected leave #. Leave period Start and end date of the leave with number of days #. Approval status of the leave Approval status as Requested, Approved or Rejected. #. View button Refer section for more details. Leave details """""""""""""""""""""" Leve details view shows leave details as below. .. figure:: Images/Control_panel/image574.PNG :width: 522 :figclass: align-center Leave details view #. Status tatus as Approved or Rejected #. Requested days The period leaves requested. #. Approved days The period leaves approved. #. Leave type Leave type as Casual, Medical or Annual #. Policy Leave policy as #. Normal #. Restricted User is now allowed to check-in or check-out while on leave #. Requested reason #. Approve/reject comment Reason for the approval or rejection from the administrator #. Calendar view shows approved leave period #. Close button Close Leave details dialogue view .. _Ref46240763: Calendar view ++++++++++++++++++++++++++++++++++++++++++++++++++++ Calendar view shows leave and holidays for the user as below. .. figure:: Images/Control_panel/image576.PNG :width: 271 :figclass: align-center Calendar view #. Selected month #. Navigate button to previous month #. Navigate button to next month #. User leave #. Holiday #. Current date #. Selected date .. _Ref31027395: .. _tooltip_user_control_panel_reports_title: User reports -------------------------------------------------------------------------------------------------- .. figure:: Images/Control_panel/image578.PNG :width: 660 :figclass: align-center #. Report type #. :ref:`Total work hour report of user service portal` #. :ref:`Productivity report of user service portal` #. :ref:`Event detail report of user service portal` #. :ref:`Export user reports` #. :ref:`Report settings of user service portal` #. Filter by shift #. Report table #. Refresh button Refresh report after applying report settings. Report types of user service portal ++++++++++++++++++++++++++++++++++++++++++++++++++++++ #. :ref:`Total work hour report of user service portal` #. :ref:`Productivity report of user service portal` #. :ref:`Event detail report of user service portal` .. _Ref38111921: Total work hour report of user service portal """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" The Total work hours report provides work hours details for a selected date range. That details can be calculated by daily, weekly, monthly basis. The important parameters are #. Date #. Name #. Employee code #. :ref:`Productive work hours (HPS)` #. :ref:`Overtime hours` #. :ref:`First check-in` #. :ref:`Last check-out` #. :ref:`In-out hours` #. :ref:`Shift work hours (HS)` #. :ref:`Work hours` .. _Ref38111956: Productivity report of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Productivity report is generated for a selected time period with user/employee productivity parameters as follows. #. :ref:`First check-in` #. :ref:`Last check-out` #. :ref:`Work hours` #. :ref:`Break hours` #. :ref:`Late arrival` #. :ref:`Late departure` #. :ref:`Early arrival` #. :ref:`Early departure` #. :ref:`Overtime hours` #. :ref:`Productive hours (HP)` #. :ref:`Unproductive hours` #. :ref:`Efficiency` .. _Ref38111979: Event detail report of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Event details represent all users/employees event details information as follows. #. Name #. ID #. Shift name #. Shift start Start time of the shift. #. Direction and status Event type as check-in or check-out. #. Time #. Event time #. Time zone Time zone difference in hours with respective to UTC. #. Location Longitude and Latitude coordinates of the event location. .. _Ref46304541: Report settings of user service portal +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image580.PNG :width: 662 :figclass: align-center #. Report calculation strategy Change the calculation based on Daily, Weekly or Monthly basis. #. Time filter Show time ranges in Hours format or Hours and minutes format. #. Date range This filter is not available for user detail report. The date range is changing according to the Report calculate strategy filter. #. Report calculate strategy as daily The report can be generating in months. The custom range can be enabled in days selecting Custom date range setting. #. Report calculate strategy as weekly The report can be generated in weeks. The custom range can be in weeks enabled selecting Custom date range setting. #. Report calculate strategy as monthly The report can be generated in years. The custom range can be enabled in months selecting Custom date range setting. .. _Ref30663378: Export user reports ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Export data in PDF and CSV formats. Available options are, #. Export all data as PDF Export complete report as a PDF. #. Export all data as CSV Export complete report as a CSV. #. Export visible data as PDF Export currently visible data in the report as a PDF. #. Export visible data as CSV Export currently visible data in the report .. _Ref31027417: .. _tooltip_user_control_panel_user_settings_title: User settings --------------------------------------------------------------------------------------------------------- Select display language for web ++++++++++++++++++++++++++++++++++++++++++++++++++ Available languages are English and Chinese. Common functions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _Ref38103966: .. _tooltip_register_device_title: Client registering view -------------------------------------------------------------------------------------------------- .. _tooltip_register_device_desc: Before record attendances in NCheck Bio Attendance Clients for Windows, Android and IOS applications, applications should be registered with a user or user group in the NCheck Bio Attendance server using a registration code. The registration window as follow. .. figure:: Images/Control_panel/image582.PNG :width: 481 :figclass: align-center #. Device registration code #. Copy to clipboard Copy device registration code to clipboard #. Device registration code as a QR code Scan QR code from the client device. #. Remove button Remove current registration code to regenerate new code. #. Email button Email registration code to user/user group. :numref:`Ref34296842` is showing the possible error messages when email registration token. #. Link to download NCheck Bio Attendance clients for Android, IOS and Windows .. _Ref34296842: .. list-table:: Error messages of registration view :widths: 1705 6480 * - Error code - Error message * - 2035 - Failed to email registration token. .. _Ref37615197: .. _tooltip_server_location_restrictions_title: Location restrictions ------------------------------------------------------------------------------------------------------------- .. _tooltip_server_location_restrictions_desc: Location restrictions can be applied for selected user/user group in order to bound check-in/checkout events to area. Location restrictions view as follows, .. figure:: Images/Control_panel/image584.PNG :width: 457 :figclass: align-center #. Number of location restrictions applied for user/user group #. Location restrictions table #. Add new button Add location restriction. Refer section for more details. Location restriction table +++++++++++++++++++++++++++++++++++++++++++++ This view shows all location restrictions and operations as follows .. figure:: Images/Control_panel/image586.PNG :width: 354 :figclass: align-center #. Restriction name #. Address where the restriction applied #. Options #. :ref:`Edit location restriction` #. Delete location restriction .. _Ref32400768: Edit location restriction ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Edit existing location restriction as follows. .. figure:: Images/Control_panel/image588.PNG :width: 502 :figclass: align-center #. Restriction name #. Description #. Address where the restriction applies #. Latitude only 5 decimal places are allowed. #. Longitude only 5 decimal places are allowed. #. radius #. Allow bypass Check this option to allow user to bypass the location restriction as mentioned in section #. Update button Update button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exit. :numref:`Ref37405663` showing error messages could be appeared when updating location restrictions. #. Cancel button .. _Ref37405663: .. list-table:: Error messages of add new location restrictions :widths: 1435 6030 * - Error code - Error message * - 3011 - Only 5 decimal places are allowed in latitude and longitude values. .. _Ref34380085: Add location restriction +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ New location restriction can be added as follow .. figure:: Images/Control_panel/image590.PNG :width: 386 :figclass: align-center #. Add from previously added restrictions Deleted or applied location restrictions can be chosen in this view. Selected location restriction is allowed to edit in the location restriction form. #. Add from location history Users event locations can be selected as location restriction in this view. Selected location restriction is allowed to edit in the location restriction form. #. Add new location restriction Refer :ref:`Add location restriction` section for more details. Add new location restriction +++++++++++++++++++++++++++++++++++++++++++++++ This view allows to add new location restriction as follows. .. figure:: Images/Control_panel/image592.PNG :width: 273 :figclass: align-center Add new location restriction view #. Restriction name #. Description #. Address where the restriction applies #. Latitude #. Longitude #. radius #. Allow bypass Check this option to allow user to bypass the location restriction as mentioned in section #. Update button Update button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exit. :numref:`Ref37405922` shows error messages could be appeared when updating location restrictions #. Cancel button .. _Ref37405922: .. list-table:: Error messages of add new location restriction :widths: 1435 5940 * - Error code - Error message * - 3011 - Only 5 decimal places are allowed in latitude and longitude values. .. _Ref33715114: Import and Export information -------------------------------------------------------------------- NCheck Bio Attendance user information can be export as a zip file with selected information. The zip file hierarchy as showing in :numref:`Ref43362353` . User biometric data is not allowed to export NCheck Bio Attendance allows to import all user information as zip file in the hierarchy as shown in :numref:`Ref43362353` . In addition to that it can import user information in CSV files. .. note:: All exporting information is encrypting using AES 256 encryption method with given password to enhance the security of the exported information. Windows default zip extractor is not supporting to extract exported zip file. You must use third party tool which supported AES 256 encryption method to extract exported zip file. .. _Ref43362353: .. figure:: Images/Control_panel/image594.PNG :width: 410 :figclass: align-center Import/Export zip file folder hierarchy .. note:: Thumbnail and biometric cannot be exported. #. Modality #. Face #. Finger #. Iris #. Data-id Unique ID to add multiple biometric data in single modality #. emp0234_face_1.jpg, emp0213_face_2.jpg, emp0435_face_3.jpg #. emp0234_finger_1.jpg, emp0213_finger_2.jpg, emp0435_finger_3.jpg #. Information as CSV .. list-table:: Import/export csv files :widths: 3235 4129 * - Information - CSV file name * - :ref:`User profile information` - PersonData.csv * - :ref:`User/user group location restrictions information` - #. PersonLocationRestrictionData.csv #. GroupLocationRestrictionData.csv * - :ref:`User group information` - GroupData.csv * - :ref:`User group memberships information` - MembershipData.csv * - :ref:`Shifts information` - TaskData.csv * - :ref:`Rosters information` - RosterData.csv * - :ref:`Roster items information` - RosterItemData.csv * - :ref:`Holidays information` - HolidayData.csv * - :ref:`Leaves information` - LeaveData.csv * - :ref:`Event logs information` - EventLogData.csv Following restrictions/limitations have been applied to import export data #. Folders and images should follow the exact naming convention. #. There can be only one image for customer profile in path ‘Thumbnail/Customer/’. #. For each person, there can be only one profile image in path ‘Thumbnail/Person/’. #. For each user group, there can be only one profile image in path ‘Thumbnail/UserGroup/’. #. Customer profile image should contain the customer name and each person or group profile image should contain the relevant employee code or group code. #. Biometric images should be included in the path ‘Biometric/Image’ and templates should be included in the path ‘Biometric/Template’. #. Biometric image/template file name should be in ‘__’ format. #. Images can be in jpg or png format. Providing the extension is not mandatory. #. Other import data files (CSV files) can also be included in the same zip file. All date time should be MM/dd/yyyy h:mm: ss a format and date format should be MM/dd/yyyy format. #. The file naming conventions is mandatory when importing files. .. _Ref30676495: User thumbnails ++++++++++++++++++++++++++++++++++++++++++++++++++++++ User thumbnails can be imported as jpg, png format in a zip file according to the file structure as showen in Import and Export information section. Unlike other information administrator are feels free to import all user thumbnails with any other file import. .. note:: User thumbnails cannot be exported. .. _Ref30676510: User biometrics and template files +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ User biometrics and templates data can be imported as zip file as shown in Import and Export information section. .. note:: User biometrics cannot be exported. .. _Ref30676505: User profile information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image596.PNG :width: 640 :figclass: align-center #. First name This is mandatory information. #. Last name This is mandatory information. #. Employee code This is mandatory information. #. Email #. primary telephone #. Address1 Address line 1 #. Address2 Address line 2 #. City #. Country #. State province region #. Zip or postal code #. Created at MM/dd/yyyy h:mm: ss a format is required. .. _Ref30676516: User group information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #. Group code This is a mandatory field. Group code should be unique. .. figure:: Images/Control_panel/image598.PNG :width: 447 :figclass: align-center #. Description #. Created at MM/dd/yyyy h:mm:ss a format is required. .. _Ref30676570: User/user group location restrictions information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image600.PNG :width: 660 :figclass: align-center #. Name This is mandatory information #. Description #. Address #. Created at This is mandatory information. MM/dd/yyyy h:mm: ss a format should be applied. #. Allow bypass #. Employee code This is mandatory information when importing users. Otherwise, this field should be empty. #. Group code This is mandatory information when importing user groups. Otherwise, this field should be empty. #. Radius #. Latitude This is mandatory information. #. Longitude This is mandatory information. .. _Ref37615466: User group memberships information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #. Start date MM/dd/yyyy h:mm: ss a format is required. .. figure:: Images/Control_panel/image602.PNG :width: 464 :figclass: align-center #. End date MM/dd/yyyy h:mm: ss a format is required. #. Created at MM/dd/yyyy h:mm: ss a format is required. #. Group code #. Employee Code .. _Ref30676596: Shifts information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image604.PNG :width: 666 :figclass: align-center #. Name Shift name. #. description #. Start time second Shift start time #. Checkin start The timestamp for the check-in start time to prevent early check-ins. #. Checkin end The timestamp for the check-in end time to prevent late check-ins. #. End time second The timestamp for shift end time #. Checkout starts Tht timestamp for the checkout start time to prevent early checkouts. #. Checkout snd Tht timestamp for the checkout end time to prevent late checkouts. #. Work hours The number of work hours user should cover in the shift. #. OT star The timestamp for overtime start. #. OT end The timestamp for overtime end. #. Restrict checkin If this is true, checkin start and checkin end restrictions will be applied. #. Restrict checkouts If this is true, checkout start and checkout end restrictions will be applied. #. Restrict OT If this is true, OT start and OT end restrictions will be applied. #. Max OT Maximum overtime overs permitted. .. _Ref30676602: Rosters information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image606.PNG :width: 660 :figclass: align-center #. Roster name #. Start date Start date of the roster. #. End date End date of the roster. #. Deleted date This should be empty. #. Created date Specify the date for the roster create. #. Roster type #. Repetition .. _Ref30676610: Roster items information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image608.PNG :width: 636 :figclass: align-center #. Created at Created date for the roster item #. Deleted date #. Day number #. Employee code #. Group code #. Roster name #. Name Name of the shift .. _Ref30676614: Holidays information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image610.PNG :width: 641 :figclass: align-center #. Description Description of the holiday #. Date Date of the holiday #. Created at Created date in the server .. _Ref30676619: Leaves information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image612.PNG :width: 641 :figclass: align-center #. Start Date Leave start day #. End date Leave end day #. Created at Leave created date in the NCheck Bio Attendance server #. leave type #. Employee code .. _Ref30676624: Event logs information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image614.PNG :width: 668 :figclass: align-center #. Checkin latitude Latitude of the check-in location #. Checkin longitude Latitude of the check-in location #. Checkin address Address of the check-in location #. Checkin description Description of the checkin #. Checkout latitude Latitude of the checkout location #. Checkout longitude Latitude of the checkout location #. Checkout address Address of the checkout location #. Checkout description Description of the checkout #. Employee code #. Task name Shift name #. Checkin time Date and time of the check-in time #. Checkout time Date and time of the checkout time #. Shift start Date and time of the Shift start #. OT start #. Shift span second #. OT span second #. OT enabled #. Limit OT #. Checkin time zone Checkin time zone in seconds. #. Checkout time zone Checkout time zone in seconds. #. Work hours Work hours in seconds #. maxOT .. _Ref31024161: .. _Ref30676393: Select import location +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This view allows to browse files In the local file system for operations in NCheck Bio Attendance system. .. figure:: Images/Control_panel/image616.PNG :width: 529 :figclass: align-center #. Select the import location file #. :ref:`Import from local file system` #. :ref:`Import from FTP` #. Password protection Select this check box to enter the password if the file is encrypted. #. File password Enter the encrypted password #. Execute button Execute button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exist. :numref:`Ref37406769` is showing error message could appeared when import files. #. Close button .. _Ref37406769: .. list-table:: Error messages of data import :widths: 1255 7470 * - Error code - Error message * - 1003 - Unable to connect with the FTP server {server name} * - 2046 - Invalid FTP file path * - 2047 - Invalid FTP username or password * - 3013 - Data import failed. Invalid password. * - 4003 - Unidentified error occurred during data import. Please contact administrator or NCheck Bio Attendance support for more details. .. _Ref34383462: .. _Ref31024182: Import from local file system """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Choose the zip/csv file from the local file system .. _Ref34383475: Import from FTP """""""""""""""""""""""""""""""""""""""""""" This view allows to configure FTP location to import files for operations in NCheck Bio Attendance system. .. figure:: Images/Control_panel/image618.PNG :width: 500 :figclass: align-center FTP server location settings view #. FTP host address #. File path in the file system #. Check this if the FTP access credentials is required #. FTP Username #. FTP password .. _Ref38711557: Select export location +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Encrypted files cannot be open via Microsoft Windows default extractor. You may use any third-party software which support encrypted files extraction. .. figure:: Images/Control_panel/image620.PNG :width: 540 :figclass: align-center #. Export option #. :ref:`Download exported files` #. :ref:`Save to FTP location` #. File password The password must have at least 6 character and one digit/ #. Confirm password #. Execute button Execute button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exist. :numref:`Ref37407142` is showing the error message could appeared on import files. #. Close button .. _Ref37407142: .. list-table:: Error messages of export files :widths: 1255 5459 * - Error code - Error message * - 1003 - Unable to connect with the FTP server {server name} * - 3003 - Password does not match. * - 3004 - Password must contain at least 6 characters with one number. * - 2046 - Invalid FTP file path * - 2047 - Invalid FTP username or password * - 4004 - Unidentified error occurred during data export. Please contact administrator or NCheck Bio Attendance support for more details. .. _Ref30676334: Download exported files """""""""""""""""""""""""""""""""""""""""""""""""""" .. _Ref30676344: Download file to the local file system. .. _Ref34383429: Save to FTP location +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This view allows to set FTP location details for file save operations in NCheck Bio Attendance server .. figure:: Images/Control_panel/image622.PNG :width: 500 :figclass: align-center FTP server location configuration for save exported files #. FTP host address #. File path in the file system #. Check this if the FTP access credentials is required #. FTP Username #. FTP password Report parameters ------------------------------------ All report parameter can be explained using following figure. .. figure:: Images/Control_panel/image624.PNG :width: 693 :figclass: align-center .. _Ref30674942: .. _tooltip_report_parameter_first_checkin_title: First check-in ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_first_checkin_desc: First check-in time within the shift .. _Ref30674949: .. _tooltip_report_parameter_last_checkout_title: Last check-out ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_last_checkout_desc: Last check in time within the shift .. _Ref30674991: .. _tooltip_report_parameter_work_hours_title: Work hours +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_work_hours_desc: Total summation of time differences between consecutive check-ins and check-outs. .. _Ref30677065: .. _tooltip_report_parameter_in_out_time_title: In-out hours ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_in_out_time_desc: Time difference between :ref:`First check-in` and :ref:`Last check-out` . .. _Ref30675010: .. _tooltip_report_parameter_productive_hours_title: Productive hours (HP) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_productive_hours_desc: According to the figure, productive hours can be identified as .. figure:: Images/Control_panel/image628.PNG :width: 619 :figclass: align-center According to the Figure this can be defined .. figure:: Images/Control_panel/image629.PNG :width: 555 :figclass: align-center .. _Ref30675033: .. _tooltip_report_parameter_shift_work_hours_title: Shift work hours (HS) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_shift_work_hours_desc: Minimum from :ref:`Work hours` and Shift hours. .. figure:: Images/Control_panel/image630.PNG :width: 166 :figclass: align-center .. _Ref30677040: .. _tooltip_report_parameter_productive_work_hours_title: Productive work hours (HPS) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_productive_work_hours_desc: Minimum from :ref:`Productive hours (HP)` and :ref:`Shift work hours (HS)` .. _Ref30676875: .. _tooltip_report_parameter_non_productive_hours_title: Unproductive hours +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image632.PNG :width: 166 :figclass: align-center .. _Ref30676864: .. _tooltip_report_parameter_overtime_hours_title: Overtime hours +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_overtime_hours_desc: Overtime hours can be defined as .. figure:: Images/Control_panel/image633.PNG :width: 166 :figclass: align-center .. _Ref30676786: .. _tooltip_report_parameter_break_hours_title: Break hours +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_break_hours_desc: Total differences between check-in’s and check-outs of consecutive events in hours. .. figure:: Images/Control_panel/image634.PNG :width: 166 :figclass: align-center .. _Ref30676790: .. _tooltip_report_parameter_late_arrival_title: Late arrival +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_late_arrival_desc: Time difference between shift start and the first check-in when first check-in occurs after the shift start time. .. _Ref30676795: .. _tooltip_report_parameter_late_departure_title: Late departure +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_late_departure_desc: Time difference between shift end and the last check-out when last check-out occurs after the shift end time. .. _Ref30676854: .. _tooltip_report_parameter_early_arrivals_title: Early arrival ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_early_arrivals_desc: Time difference between shift start and the first check-in when first check-in occurs before the shift start time. .. _Ref30676857: .. _tooltip_report_parameter_early_departure_title: Early departure +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_early_departure_desc: Time difference between shift end and the last check-out when last check-out occurs before the shift end time. .. _Ref30676903: .. _tooltip_report_parameter_efficency_title: Efficiency ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_efficency_desc: The ratio between :ref:`Productive hours (HP)` and work time defined for the particular shift. .. _Ref31026193: .. _tooltip_report_parameter_event_log_count_title: Event logs count ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_event_log_count_desc: Number of events for the particular user/employee for the selected date range. .. _Ref31026200: .. _tooltip_report_parameter_roster_item_count_title: Roster item count +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_roster_item_count_desc: Number of roster items assigned for the particular user/employee for the selected date range. .. _Ref31026204: .. _tooltip_report_parameter_leaves_title: Number of Leaves +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_leaves_desc: Number of leaves approved for particular user for the selected date range. .. _Ref31026209: .. _tooltip_report_parameter_holidays_title: Number of holidays +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_holidays_desc: Number of holidays of the organization in the selected date range. .. _Ref31026213: .. _tooltip_report_parameter_replacements_title: Replacements +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_replacements_desc: Depending on the organization requirement such as handle the work load, manage absentees, additional employee(s) can be added to a specific roster item as mentioned in :ref:`Add additional staff` section. This parameter shows number of additional user(s)/employee(s) replaced for the user/employee in such cases. .. _Ref46221329: Table options ---------------------------------------------------- The following options are available in tables using over the NCheck Bio Attendance control panel. .. figure:: Images/Control_panel/image635.PNG :width: 455 :figclass: align-center Control panel table view #. :ref:`Table header` #. :ref:`Table paging options` .. _Ref32402432: .. _Ref32565608: Table header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/Control_panel/image637.PNG :width: 679 :figclass: align-center Figure . Table header column view #. Table column #. Column sorting order as mentioned in :numref:`Ref38112183` #. :ref:`Table menu` #. Column search This field is used to filter the column content. .. _Ref38112183: .. list-table:: Table column sorting options :widths: 1165 4590 * - Icon - Soring order * - None - No sorting will be applied for the particular column * - .. figure:: Images/Control_panel/image639.PNG :width: 27 :figclass: align-center - Columns will be sorted in ascending order * - .. figure:: Images/Control_panel/image640.PNG :width: 32 :figclass: align-center - Columns will be sorted in descending order .. _Ref32565818: Table menu +++++++++++++++++++++++++++++++++++++++++++++++++ Over the NCheck Bio Attendance control panel, list of data is representing using data tables. Following features are available in the data table. .. figure:: Images/Control_panel/image641.PNG :width: 148 :figclass: align-center . Table menu view #. Save state Save the applied filters and columns in the browser cache. #. Clear all filters Clear applied filters from the browser cache. #. Columns All table columns. #. Visible columns #. Hidden columns .. _Ref32402632: Table paging options +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Table paging options allowed to prevent retrieving and loading large number of data to the table at once. These options are important to handle large data within the system without affecting the performance of the system. .. figure:: Images/Control_panel/image643.PNG :width: 668 :figclass: align-center Figure . Table paging view #. Go to the first page #. Go to the previous page #. Current page number #. Number of pages #. Go to the next page #. Go to the last page #. Number of items for a page The available options are 20, 50 100. #. Index of the first row in the page #. Index of the last item in the page #. Number of items in the page Control panel settings ----------------------------------------- Administrator allows to configure below mentioned settings in the NCheck Bio Attendance Cloud/On-premises server. #. :ref:`General setting list` #. :ref:`Client settings list` #. :ref:`Biometric setting list` #. :ref:`Web interface setting list` .. _Ref38045110: General setting list +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _Ref31026487: .. _tooltip_server_control_panel_general_settings_default_shift_start_title: Default shift start time """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_default_shift_start_desc: The start time of the for the default shift. Default is 00.00.00. .. _Ref31026493: .. _tooltip_server_control_panel_general_settings_default_shift_end_title: Default shift end time """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_default_shift_end_desc: The end time of the default shift. Default is 23.59.59. .. _Ref31025619: .. _tooltip_server_control_panel_general_settings_day_start_time_title: Day start time """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_day_start_time_desc: Time to start working/office hours. Default is 00.00.00. .. _Ref31026502: .. _tooltip_server_control_panel_general_settings_week_start_date_title: Week start date """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_week_start_date_desc: Week start day of the organization. Default is Monday. .. _Ref31026507: .. _tooltip_server_control_panel_general_settings_month_start_date_title: Month start date """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_month_start_date_desc: Month start day of the organization. Default is 1st day of the month. .. _Ref31026511: .. _tooltip_server_control_panel_general_settings_date_format_title: Date format """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_date_format_desc: Date format for the control panel and reports. Default is yyyy-MM-dd. .. _Ref31026515: .. _tooltip_server_control_panel_general_settings_time_format_title: Time format """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_time_format_desc: The time format for the Control panel and reports. Default is HH:mm:ss. .. _Ref31026519: .. _tooltip_server_control_panel_general_settings_default_shift_selection_title: Default shift selection behavior """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_default_shift_selection_desc: This option control default shift selection. The default is Allow when other shifts available. Available options are #. Don’t allow Not allowed to select default shift. #. Allow when no shifts available Allow using default shift when custom shifts are not available. #. Allow when other shifts available Allow using default shift when custom shifts available. .. _Ref48743051: .. _tooltip_server_control_panel_general_settings_auto_checkin_checkout_enable_diseble_title: Auto checkout at the end of the shift """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_auto_checkin_checkout_enable_diseble_desc: Enable this option to auto checkout user at the end of the shift automatically. This setting has disabled by default. .. _Ref48743057: .. _tooltip_server_control_panel_general_settings_notify_checkin_attempts_title: Notify check-in attempts on restricted leave """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_notify_checkin_attempts_desc: When this setting is applied, administrator gets email or control panel notification if a user who are on restricted (leave policy) leave tries to check-in. .. _Ref48743062: .. _tooltip_server_control_panel_general_settings_unidentified_event_log_count_title: Unidentified event log count to keep """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_unidentified_event_log_count_desc: Number of maximum unidentified event logs to keep in the system. Older event logs will be deleted if the maximum event log count is exceeded. Set -1 to disable this setting. .. _Ref50548880: .. _tooltip_server_control_panel_general_settings_external_resource_url_title: External resource URL """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_external_resource_url_desc: In NCheck Bio Attendance on-premises server, If the email sent to your inbox does not show images properly. You can keep those images in a publicly accessible location and specify URL for those images here. To refer default resource as “https://:/resources/ncheck.image?resource_name”. .. _Ref38045122: Client settings list +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _Ref31025357: .. _tooltip_server_control_panel_device_settings_result_dialog_timeout_title: Result dialogue timeout """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_result_dialog_timeout_desc: Timeout for check-in/checkout result dialogue. The default value is 5 seconds. .. _Ref31025297: .. _tooltip_server_control_panel_device_settings_license_enabled_title: Enable licensing """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_license_enabled_desc: In NCheck Bio Attendance cloud, enable this setting to activate Standard clients with the cloud subscription if there are available licenses as mentioned in License statics section of the Subscription.. .. _Ref31025388: .. _tooltip_server_control_panel_device_settings_show_work_hour_dialog_title: Show work time on clients """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_show_work_hour_dialog_desc: The display worked time in result dialogue after check-in or check-out events. This setting has been enabled by default. .. _Ref30758573: .. _tooltip_server_control_panel_device_settings_offline_mode_title: Offline operation mode """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_offline_mode_desc: Enable to record attendance in NCheck Bio Attendance Standard clients when the internet service is not available. This setting has been disabled by default. .. _Ref76042785: .. _tooltip_server_control_panel_device_settings_enable_manuel_capture_start_title: Manual capture start """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_enable_manuel_capture_start_desc: Enabling this setting, user able to manually record the event (Standard clients) or record the event as either check-in or check-out. Following capture start modes can be select once the manual capture start enabled. #. Check-in check-out selection Once this setting has selected, user able to manually select the event type as check-in or check-out. #. Select start button Standard clients capture face automatically once the face is detected. Enable this setting to capture button to capture manually. .. _Ref31025411: .. _tooltip_server_control_panel_device_settings_synchronize_offline_data_title: Automatically synchronize offline data """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_synchronize_offline_data_desc: Synchronize the offline data automatically with the NCheck Bio Attendance server when Enable offline mode setting is enabled. This setting has been enabled by default. .. _Ref30758503: .. _tooltip_server_control_panel_device_settings_offline_data_synchronize_interval_title: Offline data synchronize interval """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_offline_data_synchronize_interval_desc: Data synchronize interval when the Offline data synchronize interval setting is enabled. The default synchronize interval is minutes. .. _Ref31026674: .. _tooltip_server_control_panel_device_settings_automatic_peripheral_enabeling_title: Allow automatic peripheral enabling of new clients """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_automatic_peripheral_enabeling_desc: If this setting is enabled, the peripherals in the registered devices will be enabled automatically. This setting has been enabled by default. .. _Ref31025401: .. _tooltip_server_control_panel_device_settings_show_reset_offline_pass_title: Reset offline client password """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_show_reset_offline_pass_desc: Reset password for the control panel login in NCheck Bio Attendance Standard clients when the offline mode is enabled. Client password is empty by default. .. _Ref31026685: .. _tooltip_server_control_panel_device_settings_duplicate_event_timeout_title: Duplicate event timeout """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_duplicate_event_timeout_desc: The time interval between consecutive attendances record to prevent duplicate record in seconds. Default is 3 seconds. .. _Ref31026691: .. _tooltip_server_control_panel_device_settings_eventlog_image_size_title: Event log image size """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_eventlog_image_size_desc: Size of the biometric image when recording attendance. The biometric image is sending to the NCheck Bio Attendance server for user identification. Time took to record attendance can be depended on the size of the image. According to the selected size, image will be compressed without changing the aspect ratio. Default image size is Medium. The available image sizes are #. Small The images will be compressed to 224*224. #. Medium The images will be compressed to 512*512. #. Original The original image will be uploaded. .. note:: The recommended event log image size is Medium. .. _Ref31026696: .. _tooltip_server_control_panel_device_settings_kiosk_mode_title: KIOSK mode operation (For Microsoft Windows clients) """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_kiosk_mode_desc: Enable this to open NCheck Bio Attendance clients for Windows in the full-screen mode. This setting has been disabled by default. .. _Ref33012769: .. _tooltip_server_control_panel_device_settings_kiosk_exit_code_title: KIOSK mode exit code """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_kiosk_exit_code_desc: Exit code from the KIOSK mode for NCheck Bio Attendance Lite for Android can be given here. Exit code is empty by default. .. _Ref33692905: .. _tooltip_server_control_panel_device_settings_allow_pre_defined_location_title: Allow predefined location """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_allow_pre_defined_location_desc: This setting is used to configure the location source for the Android and IOS Lite clients need to be used when recording attendance events. The available location options are. #. Always use GPS The location coordinate will be retrieved from the GPS facility available with the device. #. Prefer GPS over predefined If the GPS facility available, GPS coordinates will be used. Otherwise, predefined location will be used as :ref:`Predefined location` preference of Android and IOS Lite clients. #. Always use predefined The location coordinates will be taken from the predefined location as :ref:`Predefined location` preference of Android and IOS Lite clients. .. _Ref33692919: .. _tooltip_server_control_panel_device_settings_self_enroll_template_title: Self-enroll templates """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_self_enroll_template_desc: If this setting is enabled, NCheck Bio Attendance Lite for Android registered for a user allows to enroll face template during attendance recording if no template has enrolled for a user. Refer  :ref:`Face capturing in lite client`  section for more details. .. _Ref41476932: .. _tooltip_server_control_panel_device_settings_hat_detection_title: Hat detection feature """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_hat_detection_desc: This setting allows to record attendance events if the user wears a hat. If the hat detection feature is enabled, attendance events will be recorded when the hat detection score from the client is greater than the :ref:`Hat detection threshold` . Hat detection feature available for NCheck Bio Attendance Standard clients only. .. _Ref41477221: .. _tooltip_server_control_panel_device_settings_hat_detection_threshold_title: Hat detection threshold """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_hat_detection_threshold_desc: This setting is available in NCheck Bio Attendance Standard clients when the :ref:`Hat detection feature` setting has enabled. Administrator can set the hat detection threshold. Attendance event will be recorded if the hat detection score from the NCheck Bio Attendance Standard clients lager than hat detection threshold. .. _Ref48658293: .. _tooltip_server_control_panel_device_settings_client_side_verification_title: Use in-built biometric verification on personal clients """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_client_side_verification_desc: If this setting is enabled, attendance events can be recorded in Android and IOS Lite clients using the authentication utilities available with the device. Available verification features are as follows for the devices. #. Android Either Finger or face authentication must be available with the Android device. #. Finger ID or Touch ID features must be available with the IOS device. .. _Ref48658299: .. _tooltip_server_control_panel_device_settings_guard_app_support_title: Guard application support """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_guard_app_support_desc: To enable guard application support, this this setting must be enabled first. Otherwise, Guard application registration and other functionalities will be restricted. .. _Ref58409636: .. _tooltip_server_control_panel_device_settings_hide_user_list_on_windows_client_title: Hide user list on windows client """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_hide_user_list_on_windows_client_desc: Enable this setting to hide the Windows user result views from the Windows Standard and Lite clients. .. _Ref58409645: .. _tooltip_server_control_panel_device_setting_mask_detection_title: Mask detection """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_setting_mask_detection_desc: This setting can be used to detect user face with a mask. Before enable face mask detection, make sure that you have selected the “Detect face mask” setting under the “Face quality” setting in biometric setting. Once the mask detection is set, NCheck Bio Attendance clients will calculate the mask detection score to perform the operations based on “Mask detection threshold” according to the selected mask detection option as below. The following settings are available for mask detection #. Do not detect Select this option to identify face without face mask. #. Detect Select this option to identify face with face mask. The detection will be indicated in the clients as follows .. list-table:: Indicators for Detect mask detection option :widths: 2250 2610 2447 * - - Indicator of Windows Standard client - Indicator of Android Standard client * - Mask detection score >= Mask detection threshold - .. figure:: Images/Control_panel/image645.PNG :width: 68 :figclass: align-center - .. figure:: Images/Control_panel/image646.PNG :width: 76 :figclass: align-center * - Mask detection score < Mask detection threshold - .. figure:: Images/Control_panel/image647.PNG :width: 60 :figclass: align-center - .. figure:: Images/Control_panel/image648.PNG :width: 68 :figclass: align-center #. Required To record the event successfully, user must wear a mask. If the mask detection score is greater than the “Mask detection threshold”, attendance will be recorded successfully. The detection will be indicated in the clients as below .. list-table:: Indicators for Required mask detection option :widths: 2520 2610 2447 * - - Indicator of Windows Standard client - Indicator of Android Standard client * - Mask detection score >= Mask detection threshold - .. figure:: Images/Control_panel/image645.PNG :width: 68 :figclass: align-center - .. figure:: Images/Control_panel/image646.PNG :width: 76 :figclass: align-center * - Mask detection score < Mask detection threshold - .. figure:: Images/Control_panel/image649.PNG :width: 64 :figclass: align-center - .. figure:: Images/Control_panel/image650.PNG :width: 77 :figclass: align-center .. _Ref58409688: .. _tooltip_server_control_panel_device_setting_mask_detection_treshold_title: Mask detection threshold """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_setting_mask_detection_treshold_desc: Decrease the value, if a user face with a face mask is not identified as mentioned in “Mask detection” settings. Make sure that you have selected the “Detect face mask” setting under the “Face quality” setting in biometric setting .. _Ref38045136: Biometric setting list +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _Ref31025312: .. _tooltip_server_control_panel_device_settings_allow_without_biometrics_title: Allow without biometrics """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_allow_without_biometrics_desc: This feature allows to record user attendance from NCheck Bio Attendance Lite clients simply selecting a button as mentioned in Main view for non-biometrics capture section. This setting has been disabled by default. .. _Ref31025337: .. _tooltip_server_control_panel_device_settings_manuel_face_select_title: Manual face selection """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_manuel_face_select_desc: This allows to select users for check-in/checkout when the multi-face capturing mode (Refer Lite client section for more details about multi face mode) is enabled in the NCheck Bio Attendance Lite client devices. This setting has been enabled by default. .. _Ref31025321: .. _tooltip_server_control_panel_device_settings_face_liveness_title: Face liveness mode for client application """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_face_liveness_desc: Liveness can be used to differentiate live faces from non-live faces to prevents buddy punching. Face liveness mode is None by default. When this is enable, user will be asked to follow set of instructions. If user follows the instruction correctly, event will be recorded. Available options are #. Passive In this mode, the user should hold his head still for a few seconds. .. figure:: Images/Control_panel/image651.PNG :width: 184 :figclass: align-center Android Standard client in passive liveness mode #. Active In this mode, the user should follow the commands on the screen by moving his head or blinking eyes. .. figure:: Images/Control_panel/image653.PNG :width: 390 :figclass: align-center Windows Standard client in active liveness mode .. figure:: Images/Control_panel/image655.PNG :width: 173 :figclass: align-center Android Standard client in active liveness mode #. Passive and active Both passive and active mode above is combined for better face recognition result. #. Simple In this mode, the user should follow the commands on the screen and turn face time to time. It is simplified version of Active liveness recognition. .. figure:: Images/Control_panel/image657.PNG :width: 377 :figclass: align-center Windows Standard client in simple liveness mode .. figure:: Images/Control_panel/image659.PNG :width: 175 :figclass: align-center Android Standard client in simple liveness mode #. Custom In this mode, it is required to turn head to four directions (up, down, left, right) in a random order (follow up points are same as Active mode). .. figure:: Images/Control_panel/image661.PNG :width: 384 :figclass: align-center Windows Standard client in custom liveness mode .. figure:: Images/Control_panel/image663.PNG :width: 167 :figclass: align-center Android Standard client in custom liveness mode #. None In this mode, the face liveness check is not performed. Refer :ref:`Face capturing in Standard client` section for more details about record attendances using liveness settings in NCheck Bio Attendance Standard clients. .. _Ref31025328: .. _tooltip_server_control_panel_device_settings_face_liveness_treshold_title: Face liveness threshold for client application """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_face_liveness_treshold_desc: The value which controls the requirements for client-side face liveness. The greater this value is the stricter rules are applied when deciding if the face is live. Default face liveness threshold value is 50. .. _Ref65493887: .. _tooltip_server_control_panel_biometric_settings_server_face_liveness_title: Server-side face liveness checking """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_server_face_liveness_desc: Enable this setting to differentiate live faces from non-live faces. Unlike client-side face liveness, here the server will detect the liveness of the captured face. .. _Ref65493893: .. _tooltip_server_control_panel_biometric_settings_server_liveness_treshold_title: Server face liveness confidence threshold """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_server_liveness_treshold_desc: The value which controls the requirements for server-side face liveness. The greater this value is the stricter rules are applied when deciding if the face is live. Default face liveness threshold value is 50. .. _Ref31025179: .. _tooltip_server_control_panel_biometric_settings_rescognition_treshold_title: Recognition threshold """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_rescognition_treshold_desc: Increase the value if same user identified differently time to time during identification. Note that good image quality is required for a higher recognition accuracy during face identification. Default recognition threshold value is 48. .. _Ref31025213: .. _tooltip_server_control_panel_biometric_settings_verification_treshold_title: Verification threshold """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_verification_treshold_desc: Increase the value if higher verification accuracy is required. Note that good image quality is required for a higher accuracy during face verification. Default verification threshold value is 36. .. _Ref31026862: .. _tooltip_server_control_panel_biometric_settings_enrollment_treshold_title: Enrollment threshold """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_enrollment_treshold_desc: Start with a higher enrollment accuracy if the system is intended to be used with a larger crowd. Default enrollment threshold value is 48. .. _Ref31026867: .. _tooltip_server_control_panel_biometric_settings_face_confidence_title: Face confidence """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_face_confidence_desc: Use higher face confidence for event image if good image quality is available. Default face confidence value is 40. .. _Ref31026872: .. _tooltip_server_control_panel_biometric_settings_face_quality_title: Face quality """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_face_quality_desc: Increase the value if the same user identified differently from time to time. By increasing the value, the system is forced to ignore low quality face images. Default face quality value is 40. Detect faces with mask sub setting has been introduced with face quality setting to enables face capturing waring face masks. Refer :ref:`Detect faces with mask` setting for more details. .. _tooltip_server_control_panel_biometric_settings_maximum_face_yaw_title: Maximum face yaw """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_maximum_face_yaw_desc: The maximum angle of the face needs to be captured by the client. Maximum face yaw can be 0- 90 degrees. .. _Ref37857040: .. _tooltip_server_control_panel_detect_faces_with_masks_title: Detect faces with mask """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_detect_faces_with_masks_desc: Neurotechnology Biometric algorithms can recognize faces even the person wearing a mask. In an environment where most people wear face masks (e. g.: Hospitals) this setting will easily identify employees To enable this feature, check the checkbox “Detect faces with mask” under Face Quality setting. .. note:: By enabling this setting, face quality threshold is set to 0 and you cannot change it without disabling mask mode .. _Ref65499315: .. _tooltip_server_control_panel_biometric_settings_enrollment_face_confidence_title: Face confidence for enrollment """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_enrollment_face_confidence_desc: Use higher face confidence for enrolling image if good image quality is available. Default face confidence value is 30. .. _Ref65499320: .. _tooltip_server_control_panel_biometric_settings_enrollment_face_auality_title: Face quality for Enrollment """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_enrollment_face_auality_desc: Increase the value if the enrolling face image duplicates with enrolled face image of another user. By increasing this value, the system is forced to ignore low quality face images. Default value is 48. .. _Ref65499324: .. _tooltip_server_control_panel_biometric_settings_enrollment_finger_quality_title: Finger quality for Enrollment """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_enrollment_finger_quality_desc: Increase the value if the enrolling finger image duplicated with enrolled finger image of another user. By increasing the value, the system is forced to ignore low quality finger scans. Default fingerprint quality value is 40. .. _Ref65499327: .. _tooltip_server_control_panel_biometric_settings_enrollment_iris_quality_title: Iris quality for Enrollment """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_enrollment_iris_quality_desc: Increase the value if the enrolling itris image duplicates with the iris image of another user. By increasing the value, the system is forced to ignore low quality iris scans. Default fingerprint quality value is 50. .. _Ref31026878: .. _tooltip_server_control_panel_biometric_settings_finger_quality_title: Fingerprint quality """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_finger_quality_desc: Increase the value if the same user identified differently from time to time. By increasing the value, the system is forced to ignore low quality finger scans. Default fingerprint quality value is 40. .. _tooltip_server_control_panel_biometric_settings_iris_quality_title: Iris quality """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_iris_quality_desc: Increase the value if the same user identified differently from time to time. By increasing the value, the system is forced to ignore low quality iris scans. Default fingerprint quality value is 50. .. _Ref31026882: .. _tooltip_server_control_panel_biometric_settings_high_speed_detection_title: High-speed face detection """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_high_speed_detection_desc: High speed face detection when the face biometric is used. This setting has been disabled by default. .. _Ref65494139: .. _tooltip_server_control_panel_biometric_settings_disable_duplicate-checking_title: Disable duplicate checking """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_disable_duplicate-checking_desc: Enable this setting to enroll same biometric image for different users. .. _Ref38045156: Web interface setting list +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _Ref31026993: .. _tooltip_server_control_panel_web_settings_dashboard_referesh_interval_title: Dashboard refresh interval """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_web_settings_dashboard_referesh_interval_desc: Dashboard refresh interval can be set in minutes to refresh the Dashboard to display recent attendance overview. The default refreshing interval is 2 minutes. .. _Ref31026999: .. _tooltip_server_control_panel_web_settings_show_meridian_title: Show meridian in time """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_web_settings_show_meridian_desc: Enable the toggle button to show AM/PM with the time. This setting has been disabled by default. .. _Ref40458241: .. _tooltip_server_control_panel_web_settings_export_pdf_font_title: Report export PDF font """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_web_settings_export_pdf_font_desc: User must select appropriate font from this setting to export report successfully according the selected control panel language. The available fonts are #. Roboto (Latin) Default font to export pdf report. Select this language to export report in any western European language. #. Simsun (Chinese, Latin) Select this font to export report in Chinese language. #. Ek Mukta (Hindi, Latin Select this font to export report in Hindi language. .. _Ref40457836: .. _tooltip_server_control_panel_web_settings_event_log_location_map_provider_title: Event log location map provider """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_web_settings_event_log_location_map_provider_desc: Select map provider to check the map representation of users event logs as mentioned in :ref:`Map view` section. Available map providers are #. Google maps #. Baidu maps .. _Ref40458256: .. _tooltip_server_control_panel_web_settings_map_api_key_title: Map API key """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_web_settings_map_api_key_desc: Add map API key to enable map representation of users event logs according the selected map provider in :ref:`Event log location map provider` setting.